Base module

basic::Decoder

Abstract interface for stream decoders.

Decoder

#include <icy/interface.h>

Subclassed by: Decoder, Decoder

Abstract interface for stream decoders.

Public Methods

ReturnNameDescription
DecoderDefaulted constructor.
ssize_tdecodeDecodes nread bytes from inbuf and writes decoded output to outbuf.
ssize_tfinalize virtual inlineFlushes any buffered state and writes final output to outbuf.

Decoder

Decoder() = default

Defaulted constructor.


decode

ssize_t decode(const char * inbuf, size_t nread, char * outbuf)

Decodes nread bytes from inbuf and writes decoded output to outbuf.

Parameters

  • inbuf Encoded input buffer.

  • nread Number of bytes to decode from inbuf.

  • outbuf Destination buffer for decoded output.

Returns

Number of bytes written to outbuf, or -1 on error.


finalize

virtual inline

virtual inline ssize_t finalize(char * outbuf)

Flushes any buffered state and writes final output to outbuf.

Parameters

  • outbuf Destination buffer for any remaining output.

Returns

Number of bytes written, or 0 if nothing to flush.