dmicsend(3dm)

NAME
     dmICSend, - transfer input to the image converter context

SYNOPSIS
     #include <dmedia/dm_imageconvert.h>

     DMstatus dmICSend(DMimageconverter converter, DMbuffer srcBuffer,
     int numRefBuffers, DMbuffer *refBuffers);

PARAMETERS
     This function sends a source buffer together with its reference buffers
     to the image converter.

     converter    the converter instance

     srcBuffer    the source buffer

     numRefBuffers
                  the number of reference buffers pointed to by refBuffers

     refBuffers   an array of reference buffers

DESCRIPTION
     The converter will perform the conversion on the srcBuffer, based on the
     conversion context.  Prior to calling dmICSend, dmICSetSrcParams and
     dmICSetDstParams should be called to provide the necessary parameters
     needed to set up the conversion context accordingly.

     The buffer, srcBuffer, must be allocated by the caller (see
     dmBufferAllocate(3dm)).  When the buffer is sent to the converter, the
     converter will do the necessary attachment to the buffer.  The buffer can
     be freed (see dmBufferFree(3dm)) after dmICSend returns, if it is no
     longer referenced or needed.

     The contents of srcBuffer should not be modified after calling dmICSend.

     dmICSend is an asynchronous operation.  When dmICSend returns, conversion
     may or may not have been performed. dmICGetDstFilled can be used to
     determine if any output is available.

     Two types of error can occur in dmICSend.  Either the input queue is full
     or any of the parameters passed to the function is invalid. In software
     codecs the queues grow until you run out of memory. However in case of
     hardware codecs it is not so.  In these cases, DM_FAILURE is returned and
     an error is set (errors can be retrieved using dmGetError(3dm)).

     If an error occurs during the conversion after dmICSend has returned, an
     error will be returned in a subsequent dmICReceive call.  For example, if
     invalid bytes are passed to an image converter, dmICReceive on the
     corresponding expected output buffer will return DM_FAILURE (see
     dmICReceive(3dm)).
NOTES
     In the current release, numRefBuffers and refBuffers are ignored.

SEE ALSO
     dmBufferAllocate(3dm), dmICSetSrcParams(3dm), dmICSetDstParams(3dm),
     dmICSetConvParams(3dm), dmICReceive(3dm), dmICWork(3dm).