Texas Instruments DM6467, User Manual

Page: 68 / 78

API Reference
4-32
║
Name
algAlloc()
– determine the attributes of all buffers that an algorithm
requires
║ Synopsis
XDAS_Int32 algAlloc(const IALG_Params *params, IALG_Fxns
**parentFxns, IALG_MemRec memTab[]);
║ Arguments
IALG_Params *params; /* algorithm specific attributes */
IALG_Fxns **parentFxns;/* output parent algorithm
functions */
IALG_MemRec memTab[]; /* output array of memory records */
║ Return Value
XDAS_Int32 /* number of buffers required */
║ Description
algAlloc()
returns a table of memory records that describe the size,
alignment, type, and memory space of all buffers required by an algorithm.
If successful, this function returns a positive non-zero value indicating the
number of records initialized.
The first argument to
algAlloc()
is a pointer to a structure that defines
the creation parameters. This pointer may be
NULL;
however, in this case,
algAlloc()
must assume default creation parameters and must not fail.
The second argument to
algAlloc()
is an output parameter.
algAlloc()
may return a pointer to its parent’s IALG functions. If an
algorithm does not require a parent object to be created, this pointer must
be set to
NULL.
The third argument is a pointer to a memory space of size
nbufs * sizeof(IALG_MemRec)
where,
nbufs
is the number of buffers
returned by
algNumAlloc()
and
IALG_MemRec
is the buffer-descriptor
structure defined in ialg.h.
After calling this function,
memTab[]
is filled up with the memory
requirements of an algorithm.
For more details, see TMS320 DSP Algorithm Standard API Reference
(literature number SPRU360).
║ See Also
algNumAlloc(), algFree()
4.3.2 Initialization API
Initialization API is used to initialize an instance of the algorithm. The
initialization parameters are defined in the
IVIDENC1_Params
structure
(see Data Structures section for details).