kdu_codestream::create

Constructs the internal code-stream management machinery, to be accessed via the kdu_codestream interface and its close relatives, kdu_tile, kdu_tile_comp, kdu_resolution, kdu_subband, kdu_precinct and kdu_block.

We refer to the machinery created by this particular version of the overloaded create function as an output codestream, for want of more appropriate terminology. The function prepares the internal machinery for generation of a new JPEG2000 code-stream. This is required by applications which need to compress an image, or applications which need to transcode an existing compressed image into a new one. In any event, the distinguishing features of this version of the create function are that it requires a compressed data target object and that it requires a siz_params object, identifying the dimensional properties (image component dimensions and related info) which establish the structural configuration of a JPEG2000 code-stream.

The function is deliberately not implemented as a constructor, since robust exception handlers might not always be able to clean up partially constructed objects if an error condition is thrown from within a constructor (as a general rule, constructors are the least robust place to do significant work). For safety, this function should never be invoked on a non-empty kdu_codestream interface (one whose exists function returns true).

siz [siz_params *]

target [kdu_compressed_target *]