Base module

basic::Encoder

Abstract interface for stream encoders.

Encoder

#include <icy/interface.h>

Subclassed by: Encoder, Encoder

Abstract interface for stream encoders.

Public Methods

ReturnNameDescription
EncoderDefaulted constructor.
ssize_tencodeEncodes nread bytes from inbuf and writes encoded output to outbuf.
ssize_tfinalize virtual inlineFlushes any buffered state and writes final output to outbuf.

Encoder

Encoder() = default

Defaulted constructor.


encode

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

Encodes nread bytes from inbuf and writes encoded output to outbuf.

Parameters

  • inbuf Raw input buffer to encode.

  • nread Number of bytes to encode from inbuf.

  • outbuf Destination buffer for encoded 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.