1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
/* Copyright (c) 2007 NVIDIA Corporation. All rights reserved.
*
* NVIDIA Corporation and its licensors retain all intellectual property
* and proprietary rights in and to this software, related documentation
* and any modifications thereto. Any use, reproduction, disclosure or
* distribution of this software and related documentation without an
* express license agreement from NVIDIA Corporation is strictly prohibited.
*/
/**
* @defgroup nv_omx_il_comp_base NVIDIA OMX Component Base Interface
*
* This is the NVIDIA OMX component base interface. See also \link samp_impl Sample
* Implementations\endlink in this document.
*
* @ingroup nv_omx_il_core
* @{
*/
#ifndef _NVOMX_ComponentBase_h_
#define _NVOMX_ComponentBase_h_
#include <OMX_Core.h>
#include <OMX_Component.h>
#define NVOMX_COMPONENT_MAX_PORTS 8 /** Max number of ports NVOMX_Component may have. */
/**
Defines a simple port abstraction used in NVOMX_Component.
*/
typedef struct NVOMX_Port
{
OMX_PARAM_PORTDEFINITIONTYPE *pPortDef; /**< Holds a pointer to the OMX port definition
for this port */
OMX_AUDIO_PARAM_PCMMODETYPE *pPCMMode; /**< Holds a pointer to the PCM description of this component, if pertinent. */
OMX_BUFFERHEADERTYPE *pCurrentBufferHdr; /**< Holds a pointer to the current
buffer on this port, if any. */
} NVOMX_Port;
/**
Defines a simple OMX component template that abstracts most of the
complexity away from the user.
To use:
-# Call NVOMX_CreateComponent() from the OMX component's init functions to create this
structure.
-# Call NVOMX_AddRole() to set what OMX roles this component will fill.
-# Call NVOMX_InitPort() once for each port on this component to setup the ports.
-# Fill in the function pointers in the NVOMX_Component structure as
appropriate -- at a minimum _NVOMX_Component::WorkerFunction and
_NVOMX_Component::DeInit must point to valid functions.
*/
typedef struct _NVOMX_Component NVOMX_Component;
/**
Defines a simple OMX component.
*/
struct _NVOMX_Component
{
OMX_PTR pBase; /**< Internal pointer, do not touch. */
OMX_U32 nPorts; /**< Holds the number of valid ports for this component. */
NVOMX_Port pPorts[NVOMX_COMPONENT_MAX_PORTS]; /**< Holds an array of port structures
for this component. */
OMX_PTR pComponentData; /**< An opaque pointer to any data this component desires
to keep track of. */
/**
Frees any remaining memory/resources
allocated by the component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@retval OMX_ERRORTYPE
This generally should not have an error, but should return as appropriate.
*/
OMX_ERRORTYPE (*DeInit)(NVOMX_Component *pComp);
/**
Called whenever an OMX_GetParameter has been done on the
component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nIndex
Specifies what type of configuration this is.
@param [inout] pComponentParameterStructure
Any data associated with this parameter call.
@param [out] bHandled
OMX_TRUE if this call was processed, otherwise OMX_FALSE.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_ERRORTYPE (*GetParameter)(NVOMX_Component *pComp,
OMX_INDEXTYPE nParamIndex,
OMX_PTR pComponentParameterStructure,
OMX_BOOL *bHandled);
/**
Called whenever an OMX_SetParameter has been done on the
component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nIndex
Specifies what type of configuration this is.
@param [in] pComponentParameterStructure
Any data associated with this parameter call.
@param [out] bHandled
OMX_TRUE if this call was processed, otherwise OMX_FALSE.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_ERRORTYPE (*SetParameter)(NVOMX_Component *pComp,
OMX_INDEXTYPE nIndex,
OMX_PTR pComponentParameterStructure,
OMX_BOOL *bHandled);
/**
Called whenever an OMX_GetConfig has been done on the component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nIndex
Specifies what type of configuration this is.
@param [inout] pComponentConfigStructure
Any data associated with this config call.
@param [out] bHandled
OMX_TRUE if this call was processed, otherwise OMX_FALSE.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_ERRORTYPE (*GetConfig)(NVOMX_Component *pComp,
OMX_INDEXTYPE nIndex,
OMX_PTR pComponentConfigStructure,
OMX_BOOL *bHandled);
/**
Called whenever an OMX_SetConfig has been done on the component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nIndex
Specifies what type of configuration this is.
@param [in] pComponentConfigStructure
Any data associated with this config call.
@param [out] bHandled
OMX_TRUE if this call was processed, otherwise OMX_FALSE.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_ERRORTYPE (*SetConfig)(NVOMX_Component *pComp,
OMX_INDEXTYPE nIndex,
OMX_PTR pComponentConfigStructure,
OMX_BOOL *bHandled);
/**
Called whenever all ports of this component have a
valid buffer and there needs to be work done to process them.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [out] pbMoreWork
OMX_TRUE if there is still more work to be done on a given
input buffer.
@retval OMX_ERRORTYPE
This generally should not fail, but returns an appropriate error type.
*/
OMX_ERRORTYPE (*WorkerFunction)(NVOMX_Component *pComp,
OMX_BOOL *pbMoreWork);
/**
Called on the transition to OMX_StateIdle (from Loaded).
Allocates/acquires any resources in this function.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@retval OMX_ERRORTYPE
This generally should not fail, but returns an appropriate error type.
@retval OMX_ErrorNotReady
If OMX_ErrorNotReady is returned, the component core will retry the
transtion periodically until it succeeds. If any other error than
OMX_ErrorNone is returned, the error will be sent back to the component.
*/
OMX_ERRORTYPE (*AcquireResources)(NVOMX_Component *pComp);
/**
Called when this component needs to release its hold
on any resources acquired by _NVOMX_Component::AcquireResources.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@retval OMX_ERRORTYPE
This generally should not fail, but returns an appropriate error type.
*/
OMX_ERRORTYPE (*ReleaseResources)(NVOMX_Component *pComp);
};
/**
Creates an NVOMX_Component.
@param [in] hComponent
A pointer to the OMX handle passed into the component's init function.
@param [in] nPorts
Specifies how many ports this component will have.
@param [in] name
The name of this component, must be unique
@param [out] ppComp
A pointer to the created NVOMX_Component; use this for calling any other
NVOMX_Component functions.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_CreateComponent(
OMX_HANDLETYPE hComponent,
OMX_U32 nPorts,
OMX_STRING name,
NVOMX_Component **ppComp);
/**
Adds a role name to this component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] roleName
A pointer to a static char string with the role name.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_AddRole(
NVOMX_Component *pComp,
OMX_STRING roleName);
/**
Registers an index extension with this component.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] indexName
A pointer to a static char string with the role name.
@param [in] indexType
The index to register
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_AddExtensionIndex(
NVOMX_Component *pComp,
OMX_STRING indexName,
OMX_INDEXTYPE indexType);
/**
Creates a port structure.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nPort
Specifies the port number to create.
@param [in] eDir
Specifies the direction (input/output) of the port.
@param [in] nBufferCount
Specifies the minimum number of buffers to create on this port.
@param [in] nBufferSize
Specifies the minimum buffer size to create.
@param [in] eDomain
Specifies what port type (other, image, video, audio) this port will be.
@param [in] pFormat
A pointer to the format type of the port. May be one of type
OMX_OTHER_FORMATTYPE, OMX_AUDIO_CODINGTYPE, OMX_VIDEO_CODINGTYPE, or
OMX_IMAGE_CODINGTYPE.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_InitPort(
NVOMX_Component *pComp,
OMX_U32 nPort,
OMX_DIRTYPE eDir,
OMX_U32 nBufferCount,
OMX_U32 nBufferSize,
OMX_PORTDOMAINTYPE eDomain,
OMX_PTR pFormat);
/**
Copies any buffer metadata (flags, marks, etc.) from one port to another.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nSourcePort
Specifies the source port from which to copy metadata.
@param [in] nDestPort
Specifies the port to which to copy metadata.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_CopyBufferMetadata(
NVOMX_Component *pComp,
OMX_U32 nSourcePort,
OMX_U32 nDestPort);
/**
Gets an empty buffer to an input port.
The buffer will be queued for delivery either to the tunneled component
associated with the given port, or back to the IL client via the
EmptyBufferDone callback.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nPort
Specifies the input port in which to return the buffer.
@param [in] pBuffer
Specifies the buffer to return to the input port.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_ReleaseEmptyBuffer(
NVOMX_Component *pComp,
OMX_U32 nPort,
OMX_BUFFERHEADERTYPE *pBuffer);
/**
Delivers a full buffer to an output port.
The buffer will be queued for delivery either to the tunneled component
associated with the given port, or back to the IL client via the
FillBufferDone callback.
@param [in] pComp
A pointer to the NVOMX_Component structure.
@param [in] nPort
Specifies the output port in which to deliver the buffer.
@param [in] pBuffer
Specifies the buffer to deliver to the output port.
@retval OMX_ERRORTYPE
Returns an appropriate error.
*/
OMX_API OMX_ERRORTYPE OMX_APIENTRY NVOMX_DeliverFullBuffer(
NVOMX_Component *pComp,
OMX_U32 nPort,
OMX_BUFFERHEADERTYPE *pBuffer);
#endif
/** @} */
|
