Codec Engine Application Programming Interface (API)
ce-w08
Main Page
Modules
Data Structures
Files
Related Pages
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
packages
ti
sdo
ce
audio
audenc.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
* ======== audenc.h ========
40
*/
56
#ifndef ti_sdo_ce_audio_AUDENC_
57
#define ti_sdo_ce_audio_AUDENC_
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/iaudenc.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 AUDENC_EOK IAUDENC_EOK
81
#define AUDENC_EFAIL IAUDENC_EFAIL
82
#define AUDENC_ERUNTIME IAUDENC_ERUNTIME
83
#define AUDENC_ETIMEOUT VISA_ETIMEOUT
84
#define AUDENC_FOREVER VISA_FOREVER
89
#define AUDENC_VISATYPE "ti.sdo.ce.audio.IAUDENC"
90
97
#define AUDENC_STUBSNAME "AUDENC_STUBS"
98
102
typedef
VISA_Handle
AUDENC_Handle
;
103
104
typedef
IAUDENC_Params
AUDENC_Params
;
106
typedef
IAUDENC_InArgs
AUDENC_InArgs
;
107
typedef
IAUDENC_OutArgs
AUDENC_OutArgs
;
108
typedef
IAUDENC_Cmd
AUDENC_Cmd
;
109
typedef
IAUDENC_Status
AUDENC_Status
;
112
typedef
IAUDENC_DynamicParams
AUDENC_DynamicParams
;
113
114
121
extern
SKEL_Fxns AUDENC_SKEL;
122
126
extern
IAUDENC_Fxns
AUDENC_STUBS;
127
131
/*
132
* ======== AUDENC_control ========
133
*/
163
extern
Int32
AUDENC_control
(AUDENC_Handle handle, AUDENC_Cmd
id
,
164
AUDENC_DynamicParams *params, AUDENC_Status *status);
165
166
167
/*
168
* ======== AUDENC_create ========
169
*/
198
extern
AUDENC_Handle
AUDENC_create
(
Engine_Handle
e, String name,
199
AUDENC_Params *params);
200
201
202
/*
203
* ======== AUDENC_delete ========
204
*/
222
extern
Void
AUDENC_delete
(AUDENC_Handle handle);
223
224
225
/*
226
* ======== AUDENC_process ========
227
*/
272
extern
Int32
AUDENC_process
(AUDENC_Handle handle,
273
XDM_BufDesc
*inBufs,
XDM_BufDesc
*outBufs,
274
AUDENC_InArgs *inArgs, AUDENC_OutArgs *outArgs);
275
276
277
/*
278
* ======== AUDENC_processAsync ========
279
*/
319
extern
XDAS_Int32
AUDENC_processAsync
(AUDENC_Handle handle,
XDM_BufDesc
*inBufs,
320
XDM_BufDesc
*outBufs,
IAUDENC_InArgs
*inArgs,
IAUDENC_OutArgs
*outArgs);
321
322
323
/*
324
* ======== AUDENC_processWait ========
325
*/
368
extern
XDAS_Int32
AUDENC_processWait
(AUDENC_Handle handle,
XDM_BufDesc
*inBufs,
369
XDM_BufDesc
*outBufs,
IAUDENC_InArgs
*inArgs,
IAUDENC_OutArgs
*outArgs,
370
UInt timeout);
371
372
375
#ifdef __cplusplus
376
}
377
#endif
378
379
#endif
380
/*
381
* @(#) ti.sdo.ce.audio; 1, 0, 2,3; 6-13-2013 00:10:22; /db/atree/library/trees/ce/ce-w08/src/ xlibrary
382
383
*/
384
Copyright 2013, Texas Instruments Incorporated