source: svn/newcon3bcm2_21bu/nexus/modules/audio/7552/include/nexus_audyssey_adv.h

/***************************************************************************
*     (c)2004-2011 Broadcom Corporation
*  
*  This program is the proprietary software of Broadcom Corporation and/or its licensors,
*  and may only be used, duplicated, modified or distributed pursuant to the terms and
*  conditions of a separate, written license agreement executed between you and Broadcom
*  (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
*  no license (express or implied), right to use, or waiver of any kind with respect to the
*  Software, and Broadcom expressly reserves all rights in and to the Software and all
*  intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
*  HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
*  NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.  
*   
*  Except as expressly set forth in the Authorized License,
*   
*  1.     This program, including its structure, sequence and organization, constitutes the valuable trade
*  secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
*  and to use this information only in connection with your use of Broadcom integrated circuit products.
*   
*  2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 
*  AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR 
*  WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 
*  THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES 
*  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, 
*  LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION 
*  OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF 
*  USE OR PERFORMANCE OF THE SOFTWARE.
*  
*  3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS 
*  LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR 
*  EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR 
*  USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF 
*  THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT 
*  ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE 
*  LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF 
*  ANY LIMITED REMEDY.
* 
* $brcm_Workfile: nexus_audyssey_adv.h $
* $brcm_Revision: 2 $
* $brcm_Date: 8/24/11 5:31p $
*
* API Description:
*   API name: AudysseyAdv
*    Specific APIs related to Audyssey ADV (Dynamic Volume) audio processing
*
* Revision History:
*
* $brcm_Log: /nexus/modules/audio/7422/include/nexus_audyssey_adv.h $
* 
* 2   8/24/11 5:31p jgarrett
* SW7344-176: Adding null_allowed attribute for kernelmode
* 
* 1   5/16/11 5:19p jgarrett
* SWDTV-6762: Adding Audyssey ADV/ABX
* 
***************************************************************************/

#ifndef NEXUS_AUDYSSEY_ADV_H__
#define NEXUS_AUDYSSEY_ADV_H__

#include "nexus_types.h"
#include "nexus_audio_types.h"

#ifdef __cplusplus
extern "C" {
#endif

/*=************************************
Interface: AudysseyAdv

Header file: nexus_audyssey_adv.h

Module: Audio

Description:

**************************************/

/**
Summary:
Handle for Audyssey ADV stage
**/
typedef struct NEXUS_AudysseyAdv *NEXUS_AudysseyAdvHandle;

/***************************************************************************
Summary:
Audyssey ADV Dynamic EQ Mode
***************************************************************************/
typedef enum NEXUS_AudysseyAdvDynamicEqMode
{
    NEXUS_AudysseyAdvDynamicEqMode_eOff,
    NEXUS_AudysseyAdvDynamicEqMode_eOn,
    NEXUS_AudysseyAdvDynamicEqMode_eRampOff,
    NEXUS_AudysseyAdvDynamicEqMode_eMax
} NEXUS_AudysseyAdvDynamicEqMode;

/***************************************************************************
Summary:
Audyssey ADV Settings
***************************************************************************/
typedef struct NEXUS_AudysseyAdvSettings
{
    bool enabled;                       /* If true, processing is enabled.  Otherwise this stage is bypassed */

    uint8_t channelMask;                /* Specifies the channels that will have gain applied.  
                                           Default: 0xFF        All channels
                                           Meaning of bits
                                            0 -> L, 1 -> R, 2 -> C, 3 -> LFE
                                            4 -> Ls, 5-> Rs, 6 -> Lb, 7 -> Rb */

    bool reInitialize;                  /* If true, processing will be reset/re-initialized. */

    bool volumeScalingEnabled;          /* If true, dynamic volume scaling is enabled */

    bool dynamicSurroundGainEnabled;    /* If true (default), surround channel gain is enabled.  */

    bool hiLoCompress;                  /* If true, there will be boost in calc cntr gain. */

    NEXUS_AudysseyAdvDynamicEqMode dynamicEqMode; /* Dynamic Equalizer Mode */

    int volume;                             /* Volume setting for Gain function and Dynamic EQ.  Default : 0. Ranges from -10..10 */
    int gainCompression;                /* Gain Compression Factor.  Default: 180, Range [1, 180, 240] */
    int headroomOffset;                     /* Headroom offset.  Default: 0, Ranges from -100..100 */

    int chCalbGain[8];                      /* Calibrated Channel Gain. Default: 0, Ranges from -100..100 */
} NEXUS_AudysseyAdvSettings;

/***************************************************************************
Summary:
Get default settings for an Audyssey ADV processing stage
***************************************************************************/
void NEXUS_AudysseyAdv_GetDefaultSettings(
    NEXUS_AudysseyAdvSettings *pSettings   /* [out] default settings */
    );

/***************************************************************************
Summary:
Open an Audyssey ADV processing stage
***************************************************************************/
NEXUS_AudysseyAdvHandle NEXUS_AudysseyAdv_Open( /* attr{destructor=NEXUS_AudysseyAdv_Close}  */
    const NEXUS_AudysseyAdvSettings *pSettings     /* attr{null_allowed=y} */
    );

/***************************************************************************
Summary:
Close an Audyssey ADV processing stage

Description:
Input to the stage must be removed prior to closing.
***************************************************************************/
void NEXUS_AudysseyAdv_Close(
    NEXUS_AudysseyAdvHandle handle
    );

/***************************************************************************
Summary:
Get Settings for an Audyssey ADV processing stage
***************************************************************************/
void NEXUS_AudysseyAdv_GetSettings(
    NEXUS_AudysseyAdvHandle handle,
    NEXUS_AudysseyAdvSettings *pSettings    /* [out] Settings */
    );

/***************************************************************************
Summary:
Set Settings for an Audyssey ADV processing stage
***************************************************************************/
NEXUS_Error NEXUS_AudysseyAdv_SetSettings(
    NEXUS_AudysseyAdvHandle handle,
    const NEXUS_AudysseyAdvSettings *pSettings
    );

/***************************************************************************
Summary:
Audyssey ADV Status
***************************************************************************/
typedef struct NEXUS_AudysseyAdvStatus
{
    int volumeApplied;      /* Dynamic EQ Volume applied in dB*/
    int chCalcLevel[8];     /* chCalcLevel in dB in Q10.22 floating format. */
    unsigned numChannels;   /* Number of channels */
    NEXUS_AudysseyAdvDynamicEqMode dynamicEqMode; /* Dynamic Equalizer Mode */
} NEXUS_AudysseyAdvStatus;

/***************************************************************************
Summary:
    Get the Audyssey ADV processing status
***************************************************************************/
NEXUS_Error NEXUS_AudysseyAdv_GetStatus(
    NEXUS_AudysseyAdvHandle handle,
    NEXUS_AudysseyAdvStatus *pStatus   /* [out] current status */
    );

/***************************************************************************
Summary:
Get the audio connector for an Audyssey ADV processing stage
***************************************************************************/
NEXUS_AudioInput NEXUS_AudysseyAdv_GetConnector(
    NEXUS_AudysseyAdvHandle handle
    );

/***************************************************************************
Summary:
Add an input to this processing stage
***************************************************************************/
NEXUS_Error NEXUS_AudysseyAdv_AddInput(
    NEXUS_AudysseyAdvHandle handle,
    NEXUS_AudioInput input
    );

/***************************************************************************
Summary:
Remove an input from this processing stage
***************************************************************************/
NEXUS_Error NEXUS_AudysseyAdv_RemoveInput(
    NEXUS_AudysseyAdvHandle handle,
    NEXUS_AudioInput input
    );

/***************************************************************************
Summary:
Remove all inputs from this processing stage
***************************************************************************/
NEXUS_Error NEXUS_AudysseyAdv_RemoveAllInputs(
    NEXUS_AudysseyAdvHandle handle
    );

#ifdef __cplusplus
}
#endif

#endif /* #ifndef NEXUS_AUDYSSEY_ADV_H__ */