iaudenc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006-2012, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef ti_xdais_dm_IAUDENC_
#define ti_xdais_dm_IAUDENC_

#include <ti/xdais/ialg.h>
#include <ti/xdais/xdas.h>

/*
 * By definition, this interface is 0.9 XDM.  Before including xdm.h,
 * define XDM_INCLUDE_DOT9_SUPPORT
 */
#ifndef XDM_INCLUDE_DOT9_SUPPORT
#define XDM_INCLUDE_DOT9_SUPPORT
#endif
#include "xdm.h"
#include "iaudio.h"

#ifdef __cplusplus
extern "C" {
#endif


#define IAUDENC_CID      "ti.xdais.dm.IAUDENC"  
#define IAUDENC_ERUNTIME  XDM_ERUNTIME          
#define IAUDENC_EOK       XDM_EOK               
#define IAUDENC_EFAIL     XDM_EFAIL             
typedef struct IAUDENC_Obj {
    struct IAUDENC_Fxns *fxns;
} IAUDENC_Obj;


typedef struct IAUDENC_Obj  *IAUDENC_Handle;


typedef struct IAUDENC_Params {
    XDAS_Int32 size;            
    XDAS_Int32 encodingPreset;  
    XDAS_Int32 maxSampleRate;   
    XDAS_Int32 maxBitrate;      
    XDAS_Int32 maxNoOfCh;       
    XDAS_Int32 dataEndianness;  
} IAUDENC_Params;


typedef struct IAUDENC_DynamicParams {
    XDAS_Int32 size;            
    XDAS_Int32 inputFormat;     
    XDAS_Int32 bitRate;         
    XDAS_Int32 sampleRate;      
    XDAS_Int32 numChannels;     
    XDAS_Int32 numLFEChannels;  
    XDAS_Int32 inputBitsPerSample;
} IAUDENC_DynamicParams;


typedef struct IAUDENC_InArgs {
    XDAS_Int32 size;            
} IAUDENC_InArgs;


typedef struct IAUDENC_Status {
    XDAS_Int32 size;            
    XDAS_Int32 extendedError;   
    XDAS_Int32 frameLen;        
    XDM_AlgBufInfo bufInfo;     
} IAUDENC_Status;


typedef struct IAUDENC_OutArgs {
    XDAS_Int32 size;            
    XDAS_Int32 extendedError;   
    XDAS_Int32 bytesGenerated;  
} IAUDENC_OutArgs;


typedef  IALG_Cmd IAUDENC_Cmd;


typedef struct IAUDENC_Fxns {
    IALG_Fxns   ialg;             
    XDAS_Int32 (*process)(IAUDENC_Handle handle, XDM_BufDesc *inBufs,
        XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs,
        IAUDENC_OutArgs *outArgs);

    XDAS_Int32 (*control)(IAUDENC_Handle handle, IAUDENC_Cmd id,
        IAUDENC_DynamicParams *params, IAUDENC_Status *status);

} IAUDENC_Fxns;


#ifdef __cplusplus
}
#endif

#endif