Base module
basic::Decoder
Abstract interface for stream decoders.
Decoder
#include <icy/interface.h>
class DecoderDefined in src/base/include/icy/interface.h:33
Public Methods
| Return | Name | Description |
|---|---|---|
Decoder | Defaulted constructor. | |
~Decoder virtual | Defaulted destructor. | |
ssize_t | decode virtual | Decodes nread bytes from inbuf and writes decoded output to outbuf. |
ssize_t | finalize virtual inline | Flushes any buffered state and writes final output to outbuf. |
Decoder
Decoder() = defaultDefined in src/base/include/icy/interface.h:36
Defaulted constructor.
~Decoder
virtual
virtual ~Decoder() = defaultDefined in src/base/include/icy/interface.h:37
Reimplemented by
Defaulted destructor.
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.
Returns
Number of bytes written to outbuf, or -1 on error.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
inbuf | const char * | Encoded input buffer. |
nread | size_t | Number of bytes to decode from inbuf. |
outbuf | char * | Destination buffer for decoded output. |
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.
Returns
Number of bytes written, or 0 if nothing to flush.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
outbuf | char * | Destination buffer for any remaining output. |
