audenc.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2010, 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.
 * 
 */
/*
 *  ======== audenc.h ========
 */
#ifndef ti_sdo_ce_audio_AUDENC_
#define ti_sdo_ce_audio_AUDENC_

#ifdef __cplusplus
extern "C" {
#endif

/*
 * 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 <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/iaudenc.h>

#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>


typedef IAUDENC_Status AUDENC_Status;       
#define AUDENC_EOK      IAUDENC_EOK         
#define AUDENC_EFAIL    IAUDENC_EFAIL       
#define AUDENC_ERUNTIME IAUDENC_ERUNTIME    
#define AUDENC_ETIMEOUT VISA_ETIMEOUT       
#define AUDENC_FOREVER  VISA_FOREVER        
typedef VISA_Handle AUDENC_Handle;

typedef struct IAUDENC_Params AUDENC_Params;

typedef IAUDENC_InArgs          AUDENC_InArgs;

typedef IAUDENC_OutArgs         AUDENC_OutArgs;

typedef IAUDENC_Cmd             AUDENC_Cmd;

typedef IAUDENC_DynamicParams   AUDENC_DynamicParams;

extern SKEL_Fxns AUDENC_SKEL;

extern IAUDENC_Fxns AUDENC_STUBS;

/*
 *  ======== AUDENC_create ========
 */
extern AUDENC_Handle AUDENC_create(Engine_Handle e, String name,
        AUDENC_Params *params);


/*
 *  ======== AUDENC_process ========
 */
extern Int32 AUDENC_process(AUDENC_Handle handle,
        XDM_BufDesc *inBufs, XDM_BufDesc *outBufs,
        AUDENC_InArgs *inArgs, AUDENC_OutArgs *outArgs);


/*
 *  ======== AUDENC_control ========
 */
extern Int32 AUDENC_control(AUDENC_Handle handle, AUDENC_Cmd id,
        AUDENC_DynamicParams *params, AUDENC_Status *status);


/*
 *  ======== AUDENC_delete ========
 */
extern Void AUDENC_delete(AUDENC_Handle handle);


/*
 *  ======== AUDENC_processAsync ========
 */
extern XDAS_Int32 AUDENC_processAsync(AUDENC_Handle handle, XDM_BufDesc *inBufs,
    XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs);


/*
 *  ======== AUDENC_processWait ========
 */
extern XDAS_Int32 AUDENC_processWait(AUDENC_Handle handle, XDM_BufDesc *inBufs,
    XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs,
    UInt timeout);


#ifdef __cplusplus
}
#endif

#endif
/*
 *  @(#) ti.sdo.ce.audio; 1, 0, 2,409; 12-2-2010 21:18:54; /db/atree/library/trees/ce/ce-r11x/src/ xlibrary

 */