Home
Base module

basic::Decoder

Abstract interface for stream decoders.

Decoder

#include <icy/interface.h>
class Decoder

Defined in src/base/include/icy/interface.h:33

Subclassed by: Decoder, Decoder

Abstract interface for stream decoders.

List of all members

NameKindOwner
DecoderfunctionDeclared here
~DecoderfunctionDeclared here
decodefunctionDeclared here
finalizefunctionDeclared here

Public Methods

ReturnNameDescription
DecoderDefaulted constructor.
ssize_tdecode virtualDecodes 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

Defined in src/base/include/icy/interface.h:36

Defaulted constructor.


decode

virtual

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

Defined in src/base/include/icy/interface.h:44

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.

Reimplemented by

finalize

virtual inline

virtual inline ssize_t finalize(char * outbuf)

Defined in src/base/include/icy/interface.h:49

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.

Reimplemented by