iaudio.h

TI Algorithm Soft Kit 5.10 仅包括实例及其原代码

/* 
 *  Copyright 2006
 *  Texas Instruments Incorporated
 *
 *  All rights reserved.  Property of Texas Instruments Incorporated
 *  Restricted rights to use, duplicate or disclose this code are
 *  granted through contract.
 * 
 */

/**
 *  @file       ti/xdais/dm/iaudio.h
 *
 *  @brief      This header defines all types, constants, enums, and functions
 *              that are common across the various audio codecs.
 */
/**
 *  @defgroup   ti_xdais_dm_IAUDIO    xDM 0.9 Audio Interface
 *
 *  This is the xDM 0.9 audio interface shared between the various codecs.
 */

#ifndef IAUDIO_
#define IAUDIO_

#ifdef __cplusplus
extern "C" {
#endif

/** @ingroup    ti_xdais_dm_IAUDIO */
/*@{*/

/**
 *  @brief      xDM supported audio channel configurations.
 *
 *  @remarks    This enumeration will be depricated when the xDM 1.0
 *              specification is finalized.  This is applicable only to
 *              algorithms implementing the 0.9 xDM audio interfaces.
 */
typedef enum {
    IAUDIO_MONO = 0,        /**< Single channel. */
    IAUDIO_STEREO = 1,      /**< Two channel. */
    IAUDIO_THREE_ZERO = 2,  /**< Three channel. */
    IAUDIO_FIVE_ZERO = 3,   /**< Five channel. */
    IAUDIO_FIVE_ONE = 4,    /**< 5.1 channel. */
    IAUDIO_SEVEN_ONE = 5    /**< 7.1 channel. */
} IAUDIO_ChannelId;


/**
 *  @brief      Channel modes for audio streams.
 *
 *  The channel modes not only indicate the number of channels, but also
 *  indicate the order in which the channels are placed in the input or
 *  output buffer.  The placement of channels is indicated next to each
 *  channel mode.
 */
typedef enum
{
    IAUDIO_1_0 = 0,         /**< Mono. */
    IAUDIO_2_0 = 1,         /**< Stereo. */
    IAUDIO_11_0 = 2,        /**< Dual Mono.
                             *
                             *   @sa    IAUDIO_DualMonoMode
                             */
    IAUDIO_3_0 = 3,         /**< Left, Right, Center. */
    IAUDIO_2_1 = 4,         /**< Left, Right, Sur. */
    IAUDIO_3_1 = 5,         /**< Left, Right, Center, Sur. */
    IAUDIO_2_2 = 6,         /**< Left, Right, SurL, SurR. */
    IAUDIO_3_2 = 7,         /**< Left, Right, Center, SurL, SurR. */
    IAUDIO_2_3 = 8,         /**< Left, Right, SurL, SurR, surC. */
    IAUDIO_3_3 = 9,         /**< Left, Right, Center, SurL, SurR, surC. */
    IAUDIO_3_4 =10          /**< Left, Right, Center, SurL, SurR, sideL, sideR.
                             */
} IAUDIO_ChannelMode;


/**
 *  @brief      Dual Mono Channel modes for audio streams.
 *
 *  @remarks    In case of Dual Mono the application can play both channels;
 *              Left Only, Right Only or Mix and Play both.  The
 *              default case in most of the applications is the first
 *              case of IAUDIO_DUALMONO_LR. That is to play both Left
 *              and Right Channel.
 */
typedef enum
{
    IAUDIO_DUALMONO_LR = 0,  /**< Play/encode both left and right channel */
    IAUDIO_DUALMONO_LEFT = 1,/**< Play/encode only left channel. */
    IAUDIO_DUALMONO_RIGHT = 2,/**< Play/encode only right channel. */
    IAUDIO_DUALMONO_LR_MIX = 3/**< Mix and play. */
} IAUDIO_DualMonoMode;


/**
 *  @brief      xDM supported audio PCM formats
 */
typedef enum {
    /**
     *  Left channel data followed by right channel data.
     *  Note, for single channel (mono), right channel data will be the same
     *  as the left channel data.
     */
    IAUDIO_BLOCK = 0,

    /**
     *  Left and right channel data interleaved.
     *  Note, for single channel (mono), right channel data will be the same
     *  as the left channel data.
     */
    IAUDIO_INTERLEAVED = 1
} IAUDIO_PcmFormat;


/**
 *  @brief      Audio encoding modes.
 */
typedef enum
{
    IAUDIO_CBR = 0,     /**< Constant bit rate. */
    IAUDIO_VBR = 1      /**< Variable bit rate. */
} IAUDIO_EncMode;


/*@}*/

#ifdef __cplusplus
}
#endif

#endif  /* IAUDIO_ */
/*
 *  @(#) ti.xdais.dm; 1, 0, 1, 0,46; 10-18-2006 19:11:35; /db/wtree/library/trees/dais-g07x/src/
 */