source: svn/newcon3bcm2_21bu/dst/app/src/Function/App_Fnc_Audio.h

/****************************************************************************
* NAME: App_Fnc_Audio.h
*----------------------------------------------------------------------------
* Copyright (c) DIGITAL STREAM Technology Inc.
*----------------------------------------------------------------------------
* CREATED_BY: Chan Hun Jeon 
* CREATION_DATE: 2009/09/08
* $Author: chjeon $
* $Revision: 1.1 $
* $Date: 2009/07/08 15:08:26 $
*----------------------------------------------------------------------------
* PURPOSE:
* - implement all audio related functions.
*****************************************************************************/

#ifndef __APP_FNC_AUDIO_H__
#define __APP_FNC_AUDIO_H__

/*_____ I N C L U D E __________________________________________*/





#if COMMENT
____Overview____(){}
#endif

/*
        audio module 
        - volume up/down
        - preferred language 
        - audio lang
        - mute on/off

        dependency 
        - Channel MW
        - DHL_AVCAP
        - App_Fnc_ChTune, App_Fnc_NvRam
*/





/*_____ D E F I N I T I O N ____________________________________*/

#if COMMENT
____Config____(){}
#endif

#define USE_LANG_ID_FOR_AUDIO_SELECTION 1
#define SUPPORT_SPDIF_OUTPUT 1
#define SUPPORT_HDMI_OUTPUT 1
#define SUPPORT_AUDIO_VOLUME_FIXED_MODE 0

#define APP_AUDIO_VOLUME_MAX 20
#define APP_AUDIO_VOLUME_MIN 0


#define APP_AUDIO_MUTE_TYPE_STR(t) ( \
                (t)==APP_AUDIO_MUTE_USER ? "User" : \
                (t)==APP_AUDIO_MUTE_RBLOCK ? "RBlock" : \
                (t)==APP_AUDIO_MUTE_CBLOCK ? "CBlock" : \
                (t)==APP_AUDIO_MUTE_TEMP ? "Temp" : \
                (t)==APP_AUDIO_MUTE_VOLUME_0 ? "Volume 0" : \
                (t)==APP_AUDIO_MUTE_OFF_READY ? "Off ready" : \
                (t)==APP_AUDIO_MUTE_EXTSRC ? "Extsrc" : \
                (t)==APP_AUDIO_MUTE_SIGMON ? "Sigmon" : \
                (t)==APP_AUDIO_MUTE_HOST ? "Host" : \
                (t)==APP_AUDIO_MUTE_SAPCHG ? "Sapchg" : \
                (t)==APP_AUDIO_MUTE_ADTOGGLE ? "ADToggle" : \
                "??" )



#if COMMENT
____Types____(){}
#endif

/*
        Audio Mute types
        
        All possible audio mute reason.
        Any of this mute condition is TRUE, entire audio is muted.
*/

typedef enum
{
        APP_AUDIO_MUTE_USER = 0, // user remocon mute button
        APP_AUDIO_MUTE_RBLOCK = 1, // mute by rating block
        APP_AUDIO_MUTE_CBLOCK = 2, // mute by channel block
        APP_AUDIO_MUTE_TEMP = 3,  // usage not defined yet.
        APP_AUDIO_MUTE_VOLUME_0 = 4, // volume 0 mute
        APP_AUDIO_MUTE_OFF_READY = 5, // cafrii 060810 add, Power off ready,
        APP_AUDIO_MUTE_EXTSRC = 6,
        APP_AUDIO_MUTE_SIGMON = 7,  // mute from signal monitor
        APP_AUDIO_MUTE_HOST = 8,  // audio mute request from Host
        APP_AUDIO_MUTE_SAPCHG = 9,  // temp mute during analog audio (stereo/sap/mono, etc) is changed
        APP_AUDIO_MUTE_ADTOGGLE = 10, // temp mute while Analog/Digital toggle

} APP_AUDIO_MUTE_TYPE;


#if SUPPORT_SPDIF_OUTPUT
typedef enum
{
        APP_SPDIF_AUDIO_MUTE_RBLOCK,
        APP_SPDIF_AUDIO_MUTE_OFF_READY,
        APP_SPDIF_AUDIO_MUTE_EXTSRC,
        APP_SPDIF_AUDIO_MUTE_SIGMON,
        APP_SPDIF_AUDIO_MUTE_HOST,  // audio mute request from Host
        APP_SPDIF_AUDIO_MUTE_SAPCHG, 
} APP_SPDIF_AUDIO_MUTE_TYPE;
#endif /* #if SUPPORT_SPDIF_OUTPUT */


#if SUPPORT_HDMI_OUTPUT
typedef enum
{
        APP_HDMI_AUDIO_MUTE_RBLOCK,
        APP_HDMI_AUDIO_MUTE_OFF_READY,
        APP_HDMI_AUDIO_MUTE_EXTSRC,
        APP_HDMI_AUDIO_MUTE_SIGMON,
        APP_HDMI_AUDIO_MUTE_HOST,  // audio mute request from Host
        APP_HDMI_AUDIO_MUTE_SAPCHG, 
} APP_HDMI_AUDIO_MUTE_TYPE;
#endif /* #if SUPPORT_HDMI_OUTPUT */


typedef enum
{
        APP_AUDIO_SPDIF_AC3 = 0,
        APP_AUDIO_SPDIF_PCM = 1,

} APP_AUDIO_SPDIF_MODE;

typedef enum
{
        APP_AUDIO_HDMI_AC3 = 0,
        APP_AUDIO_HDMI_PCM = 1,

} APP_AUDIO_HDMI_MODE;

typedef enum
{
        APP_AUDIO_LANG_AUTO = 0,
        APP_AUDIO_LANG_ENG = 1,
        APP_AUDIO_LANG_SPA = 2,
        APP_AUDIO_LANG_FRE = 3,
        APP_AUDIO_LANG_KOR = 4,

} APP_AUDIO_LANG_ID;

typedef enum
{
        APP_AUDIO_DOWNMIX_LTRT=0,
        APP_AUDIO_DOWNMIX_LORO
} APP_AUDIO_DOWNMIX_TYPE;





#if COMMENT
____Variables____(){}
#endif

// cafrii 060609 add, user default audio language value & variable
//
//extern UINT8 DST_AudioUserLanguage; 
        // APP_AUDIO_LANG type


#if SUPPORT_AUDIO_VOLUME_FIXED_MODE
        extern BOOL g_App_bAudioFixedVolumeMode;
                // depending on Dolby certification type, it may have to be 1.
                // can be changed in factory menu..
#endif


#if USE_LANG_ID_FOR_AUDIO_SELECTION
        extern APP_AUDIO_LANG_ID g_App_AudioUserLanguageId;
#else
        extern UINT32 g_App_AudioUserLanguageCode;
#endif





#if COMMENT
____NvParam____(){}
#endif

typedef struct
{
        UINT8 volume: 5;         // 0~20
        UINT8 preferedlang: 2;   // auto, english, spanish, french
        UINT8 AudioDownMix: 1;    // o:LTRT 1:LORO
        UINT8 AudioModeSPDIF: 1; // 0:AC3, 1:PCM
        UINT8 AudioModeHdmi: 1;  // 0:AC3, 1:PCM
}nvparam_audio;





/*_____ F U N C T I O N ________________________________________*/

#if COMMENT
____Function____(){}
#endif

/* Util */
char *AudioLangCode2Name(UINT32 code);
UINT32 AudioLangID2Code(APP_AUDIO_LANG_ID id);

const char *App_AudioLangCodeStr(UINT32 langCode, char *buf);


/* Mute */
void App_AudioMute(BOOL bMute, APP_AUDIO_MUTE_TYPE eMuteType);

UINT32 App_GetAudioMuteStatus(void);
BOOL App_AudioIsUserMute(void);

//BOOL App_AudioOutputExist(void);
BOOL App_AudioToggleUserMute(void);


/* SPDIF */
#if SUPPORT_SPDIF_OUTPUT
void App_AudioSetDigitalAudio(APP_AUDIO_SPDIF_MODE mode, BOOL bSaveNvRam);
APP_AUDIO_SPDIF_MODE App_AudioGetDigitalAudio(void);
void App_AudioMuteDigitalAudio(BOOL bMute, APP_SPDIF_AUDIO_MUTE_TYPE eMuteType);
#endif


/* HDMI */
#if SUPPORT_HDMI_OUTPUT
void App_AudioSetHdmiAudio(APP_AUDIO_HDMI_MODE mode, BOOL bSaveNvRam);
APP_AUDIO_HDMI_MODE App_AudioGetHdmiAudio(void);
void App_AudioMuteHdmiAudio(BOOL bMute, APP_HDMI_AUDIO_MUTE_TYPE eMuteType);
#endif


/* ML Info */
STATUS App_AudioGetMLInfo(DMW_AudioElement **ppMLInfo, int *numCount, int *pCurrentIndex);


/* MTS Callback */
void App_AudioSelectAudioStream(AudioPidSelectParam *apsp);
char *App_AudioShowOrChangeMTS(BOOL bChangeToNext);

#if USE_LANG_ID_FOR_AUDIO_SELECTION
BOOL App_AudioSetPreferredLanguageId(APP_AUDIO_LANG_ID id, BOOL bSaveNvRam);
APP_AUDIO_LANG_ID App_AudioGetPreferredLanguageId(void);
#else
BOOL App_AudioSetPreferredLanguageCode(UINT32 langcode, int index, BOOL bSaveNvRam);
#endif

void App_AudioNotifyStop(AudioDecodeStopParam *param);
void App_AudioNotifyStart(AudioDecodeStartParam *param);


/* Volume API */
#if SUPPORT_AUDIO_VOLUME_FIXED_MODE
void App_AudioSetFixedVolumeMode(BOOL bFixedMode);
#endif

void App_AudioChangeVolume(int volume, BOOL bSaveNvRam);

void App_AudioVolumeUp(void);
void App_AudioVolumeDown(void);

UINT8 App_AudioGetVolume(void);

void App_AudioSetDownMix(APP_AUDIO_DOWNMIX_TYPE downmix, BOOL bSaveNvRam);
APP_AUDIO_DOWNMIX_TYPE App_AudioGetDownMix(void);


/* Delay API */
void App_AudioSetDelay(int delay);


/* NvRam */
void App_Audio_GetDefaultParamValue(nvparam_audio* param);


/* Init */
void App_AudioInit(void);
void App_AudioParamInit(void);




#endif /* __APP_FNC_AUDIO_H__ */