dvb_audio.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2012 Ocean Blue Software Ltd
 *
 * 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
 *******************************************************************************/
#ifndef _DVB_AUDIO_H
#define _DVB_AUDIO_H

#include "techtype.h"
#include "dvblocator.h"
#include "mherrors.h"

/*---Constant and macro definitions for public use-----------------------------*/

/*---Enumerations for public use-----------------------------------------------*/

/* Control of the audio decoder's speed. As trick modes are not implemented,
 * there are only two possibilities
 */
typedef enum
{
   /* Pause the audio decoding */
   AUDIO_SPEED_PAUSE,

   /* Resume audio playback after pause */
   AUDIO_SPEED_PLAY
} E_AudioSpeed;


typedef enum
{
   AUDIO_ENC_MPEG2,
   AUDIO_ENC_HEAAC,
   AUDIO_ENC_E_AC3,
   AUDIO_ENC_MP3
} E_AudioEncoding;

/*---Global type defs for public use-------------------------------------------*/

/*---Global Function prototypes for public use---------------------------------*/

E_MhegErr DVB_MhegAudioPlayDefault(void);

E_MhegErr DVB_MhegAudioStopStream(void);

E_MhegErr DVB_MhegAudioPlayStream(S_DvbComponent *pDvbComponent);

E_MhegErr DVB_MhegAudioPlayClip( U8BIT *pAudioData,
   U32BIT dataLength,
   U32BIT repeatCount,
   E_AudioEncoding encoding );

E_MhegErr DVB_MhegAudioStopClip(void);

E_MhegErr DVB_MhegAudioSetSpeed(E_AudioSpeed speed);

E_MhegErr DVB_MhegAudioSetVolume(S32BIT volumeAdjust);

BOOLEAN DVB_MhegAudioDescriptionPref(void);

#endif /* _PM_AUDIO_H */