(v13) InterleaveDecode filter
This page applies to Harlequin v13.1r0 and later; both Harlequin Core and Harlequin MultiRIP.
The InterleaveDecode
filter is used to extract and transform packed samples from a bitstream. The filter expects a parameter dictionary and a source file object on the stack. The InterleaveDecode
filter operates upon “windows” of data. Each window contains an initial number of bits to skip, a number of samples of the input depth, and a trailing number of bits to skip. The samples may be passed unchanged to the output, without the initial and trailing bits, or may be transformed to some other range of output values. The input may be aligned to a specified number of bits after processing a specified number of input windows, and the output may be aligned to a specified number of bits after processing a specified number of windows. (These options are typically used for aligning input and output for a scanline worth of image samples.) The parameter dictionary may contain the following entries:
Samples | positive integer (required) | The number of input samples in each window. Input samples are transformed to output values and are sent to the filter output. |
InputBits | positive integer (optional) | This value is between |
BitsBefore | non-negative integer (optional) | This value indicates the number of bits to skip at the start of each input data window, before reading the data samples (default |
BitsAfter | non-negative integer (optional) | This value indicates the number of bits to skip at the end of each input data window, after reading the data samples (default |
InputAlignRepeat | non-negative integer (optional) | This value indicates the number of input “windows” to process before aligning the input sources. If zero, the input source will never be aligned (default |
InputAlignBits | positive integer (optional) | If |
OutputBits | positive integer (optional) | This value is between |
OutputAlignRepeat | non-negative integer (optional) | This value indicates the number of input “windows” to process before aligning the filter output. If zero, the output is never aligned.(default |
OutputAlignBits | positive integer (optional) | If |
Repeat | non-negative integer (optional) | This value indicates the number of windows to process. If zero, the filter keeps requesting data from its source until EOF is indicated by the source. If non-zero, this is the number of whole windows of data that is processed before the filter returns EOF. It may be useful to set this parameter to prevent the filter from reading more data than is applicable from an image source (default 0). |
SeekSource | boolean (optional) | This value indicates if the filter source should have a |
Mapping | array (optional) | If specified, this parameter should be an array of length |