Codec Engine Application Programming Interface (API)  ce-w08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
auddec.h
Go to the documentation of this file.
1 /*
2  * Copyright 2013 by Texas Instruments Incorporated.
3  *
4  */
5 
6 /*
7  * Copyright (c) 2013, Texas Instruments Incorporated
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * * Redistributions of source code must retain the above copyright
15  * notice, this list of conditions and the following disclaimer.
16  *
17  * * Redistributions in binary form must reproduce the above copyright
18  * notice, this list of conditions and the following disclaimer in the
19  * documentation and/or other materials provided with the distribution.
20  *
21  * * Neither the name of Texas Instruments Incorporated nor the names of
22  * its contributors may be used to endorse or promote products derived
23  * from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
32  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
35  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  *
37  */
38 /*
39  * ======== auddec.h ========
40  */
56 #ifndef ti_sdo_ce_audio_AUDDEC_
57 #define ti_sdo_ce_audio_AUDDEC_
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 /*
64  * By definition, this interface is 0.9 XDM. Before including xdm.h,
65  * define XDM_INCLUDE_DOT9_SUPPORT
66  */
67 #ifndef XDM_INCLUDE_DOT9_SUPPORT
68 #define XDM_INCLUDE_DOT9_SUPPORT
69 #endif
70 #include <ti/xdais/dm/xdm.h>
71 #include <ti/xdais/dm/iauddec.h>
72 
73 #include <ti/sdo/ce/Engine.h>
74 #include <ti/sdo/ce/visa.h>
75 #include <ti/sdo/ce/skel.h>
76 
79 
80 #define AUDDEC_EOK IAUDDEC_EOK
81 #define AUDDEC_EFAIL IAUDDEC_EFAIL
82 #define AUDDEC_ERUNTIME IAUDDEC_ERUNTIME
83 #define AUDDEC_ETIMEOUT VISA_ETIMEOUT
84 #define AUDDEC_FOREVER VISA_FOREVER
89 #define AUDDEC_VISATYPE "ti.sdo.ce.audio.IAUDDEC"
90 
97 #define AUDDEC_STUBSNAME "AUDDEC_STUBS"
98 
99 
104 
114 
115 
122 extern SKEL_Fxns AUDDEC_SKEL;
123 
127 extern IAUDDEC_Fxns AUDDEC_STUBS;
128 
132 /*
133  * ======== AUDDEC_control ========
134  */
158 extern Int32 AUDDEC_control(AUDDEC_Handle handle, AUDDEC_Cmd id,
159  AUDDEC_DynamicParams *params, AUDDEC_Status *status);
160 
161 
162 /*
163  * ======== AUDDEC_create ========
164  */
193 extern AUDDEC_Handle AUDDEC_create(Engine_Handle e, String name,
194  AUDDEC_Params *params);
195 
196 
197 /*
198  * ======== AUDDEC_delete ========
199  */
217 extern Void AUDDEC_delete(AUDDEC_Handle handle);
218 
219 
220 /*
221  * ======== AUDDEC_process ========
222  */
267 extern Int32 AUDDEC_process(AUDDEC_Handle handle,
268  XDM_BufDesc *inBufs, XDM_BufDesc *outBufs,
269  AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs);
270 
271 
272 /*
273  * ======== AUDDEC_processAsync ========
274  */
314 extern Int32 AUDDEC_processAsync(AUDDEC_Handle handle, XDM_BufDesc *inBufs,
315  XDM_BufDesc *outBufs, AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs);
316 
317 
318 /*
319  * ======== AUDDEC_processWait ========
320  */
363 extern Int32 AUDDEC_processWait(AUDDEC_Handle handle, XDM_BufDesc *inBufs,
364  XDM_BufDesc *outBufs, AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs,
365  UInt timeout);
366 
367 
370 #ifdef __cplusplus
371 }
372 #endif
373 
374 #endif
375 /*
376  * @(#) ti.sdo.ce.audio; 1, 0, 2,3; 6-13-2013 00:10:21; /db/atree/library/trees/ce/ce-w08/src/ xlibrary
377 
378  */
379 
Copyright 2013, Texas Instruments Incorporated