mh5audio.c

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include "mh5audio.h"
#include "mh5application.h"
#include "mh5object.h"          /* for actions */
#include "mh5variable.h"        /* for actions */
#include "mh5memory.h"          /* for constructor/destructor */
#include "mh5display.h"         /* for actions */
#include "mh5queue.h"
#include "mh5debug.h"

#ifdef MH5PRINTOUT
#include <string.h>
#endif  /* #ifdef MH5PRINTOUT */

/*---constant definitions for this file--------------------------------------*/


/*---local typedef structs for this file-------------------------------------*/

/*---local (static) variable declarations for this file----------------------*/

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5audioPrint(MHEG5Audio *audio, char *out)
{
   MHEG5ingredientPrint(&audio->ingredient, out);
   MHEG5indent(out);
   MHEG_PRINT(out, ":ComponentTag ");
   MHEG5intPrint(audio->componentTag, out);
   MHEG5newLine(out);
   if (audio->originalVolume != 0)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":Volume ");
      MHEG5intPrint(audio->originalVolume, out);
      MHEG5newLine(out);
   }
/*
   MHEG5indent(out);
   MHEG_PRINT(out,"// Volume:\t");
   MHEG5intPrint(audio->volume,out);
   MHEG5newLine(out);
 */
}

#endif

void MHEG5audioInit(MHEG5Audio *audio)
{
   assert(audio);

   MHEG5ingredientInit(&audio->ingredient);
}

void MHEG5audioFree(MHEG5Audio *audio)
{
   assert(audio);

   MHEG5ingredientFree(&audio->ingredient);
}

void MHEG5audioPrepare(MHEG5Audio *audio)
{
   assert(audio);

   audio->volume = audio->originalVolume;

   MHEG5ingredientPrepare(&audio->ingredient);
}

void MHEG5audioActivate(MHEG5Audio *audio)
{
   assert(audio);

   if (!audio->ingredient.root.runningStatus)
   {
      if (!audio->ingredient.root.availabilityStatus)
      {
         MHEG5audioPrepare( audio );
      }

      /* If the parent stream is running, start presenting the audio object */
      if (audio->parent->ingredient.root.runningStatus)
      {
         MHEG5displayAudioPlay(audio);
      }

      /* Could call the base class activation behaviour, but */
      MHEG5ingredientActivate(&audio->ingredient);   /*<- does nothing, so don't bother */

      audio->ingredient.root.runningStatus = MHEG5TRUE;
      MHEG5sendSync((MHEG5Root *) audio, MHEG5ISRUNNING, 0);
   }
}

void MHEG5audioDeactivate(MHEG5Audio *audio)
{
   assert(audio);

   if (audio->ingredient.root.runningStatus)
   {
      /* Call the base class deactivation behaviour */
      MHEG5ingredientDeactivate(&audio->ingredient);

      if ((MHEG5getCurrentApplication() == 0) ||
          (MHEG5getCurrentApplication()->streamContinuanceFlag == MHEG5FALSE))
      {
         /* Stop the audio decoder */
         if (audio->parent->ingredient.root.runningStatus)
         {
            MHEG5displayAudioStop();
         }
      }
      audio->ingredient.root.runningStatus = MHEG5FALSE;
   }
}

void MHEG5audioDestruct(MHEG5Audio *audio)
{
   assert(audio);
   MHEG5ingredientDestruct(&audio->ingredient);
   MHEG5displayAudioDestroy( audio );
}

MHEG5ErrorCode MHEG5setVolume(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int volume = 0;

   assert(target);

   if (target->clazz != MHEG5AUDIO)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &volume);

   ((MHEG5Audio *) target)->volume = volume;
   MHEG5displaySetVolume(volume);

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5getVolume(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *vVar = 0;

   assert(target);

   if (target->clazz != MHEG5AUDIO)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(params, &vVar);
   if (!vVar)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (vVar->clazz != MHEG5INTEGERVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }
   if (!vVar->runningStatus)
   {
      return MHEG5ERR_PARAMNOTACTIVE;
   }

   ((MHEG5IntegerVariable *) vVar)->value = ((MHEG5Audio *) target)->volume;

   return MHEG5ERR_NOERROR;
}