opus_multistream(3)

📦

version 1.6.1 · 8 versions

1.6.1 · ubuntu resolute, ubuntu stonking (latest)
1.3.1 · centos-stream 9
1.4 · centos-stream 10
1.5.2 · fedora 43
1.6 · fedora 44
1.4 · ubuntu noble
1.3.1 · debian bookworm
1.5.2 · debian trixie, ubuntu questing

💖 opus_multistream — the Opus Multistream API, bestie edition 💖

okay so this is opus_multistream(3), and it lives in the Opus manual, section 3 (that's the library-functions section, iykyk). grab a strawberry drink 🍓 and let's get into it, because this one is lowkey a whole vibe.

✨ NAME ✨

opus_multistream — the Opus Multistream API.

the multistream API lets individual Opus streams get combined into a single packet, which is how we get support for up to 255 channels. yes. two hundred and fifty-five. iconic.

🦋 SYNOPSIS 🦋

🌸 Typedefs 🌸

typedef struct OpusMSEncoder OpusMSEncoder — Opus multistream encoder state. bestie, this is the encoder's whole personality.
typedef struct OpusMSDecoder OpusMSDecoder — Opus multistream decoder state. and this one is the decoder's.

🎀 Multistream encoder functions 🎀

opus_int32 opus_multistream_encoder_get_size (int streams, int coupled_streams) — Gets the size of an OpusMSEncoder structure.
opus_int32 opus_multistream_surround_encoder_get_size (int channels, int mapping_family)
OpusMSEncoder * opus_multistream_encoder_create (opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char *mapping, int application, int *error) — Allocates and initializes a multistream encoder state. ✨
OpusMSEncoder * opus_multistream_surround_encoder_create (opus_int32 Fs, int channels, int mapping_family, int *streams, int *coupled_streams, unsigned char *mapping, int application, int *error)
int opus_multistream_encoder_init (OpusMSEncoder *st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char *mapping, int application) — Initialize a previously allocated multistream encoder state.
int opus_multistream_surround_encoder_init (OpusMSEncoder *st, opus_int32 Fs, int channels, int mapping_family, int *streams, int *coupled_streams, unsigned char *mapping, int application)
int opus_multistream_encode (OpusMSEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes) — Encodes a multistream Opus frame.
int opus_multistream_encode24 (OpusMSEncoder *st, const opus_int32 *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes) — Encodes a multistream Opus frame.
int opus_multistream_encode_float (OpusMSEncoder *st, const float *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes) — Encodes a multistream Opus frame from floating point input.
void opus_multistream_encoder_destroy (OpusMSEncoder *st) — Frees an OpusMSEncoder allocated by opus_multistream_encoder_create().
int opus_multistream_encoder_ctl (OpusMSEncoder *st, int request,...) — Perform a CTL function on a multistream Opus encoder.

💜 Multistream decoder functions 💜

opus_int32 opus_multistream_decoder_get_size (int streams, int coupled_streams) — Gets the size of an OpusMSDecoder structure.
OpusMSDecoder * opus_multistream_decoder_create (opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char *mapping, int *error) — Allocates and initializes a multistream decoder state.
int opus_multistream_decoder_init (OpusMSDecoder *st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char *mapping) — Initialize a previously allocated decoder state object.
int opus_multistream_decode (OpusMSDecoder *st, const unsigned char *data, opus_int32 len, opus_int16 *pcm, int frame_size, int decode_fec) — Decode a multistream Opus packet.
int opus_multistream_decode24 (OpusMSDecoder *st, const unsigned char *data, opus_int32 len, opus_int32 *pcm, int frame_size, int decode_fec) — Decode a multistream Opus packet.
int opus_multistream_decode_float (OpusMSDecoder *st, const unsigned char *data, opus_int32 len, float *pcm, int frame_size, int decode_fec) — Decode a multistream Opus packet with floating point output.
int opus_multistream_decoder_ctl (OpusMSDecoder *st, int request,...) — Perform a CTL function on a multistream Opus decoder.
void opus_multistream_decoder_destroy (OpusMSDecoder *st) — Frees an OpusMSDecoder allocated by opus_multistream_decoder_create().

🌈 Detailed Description 🌈

okay, real talk time. the multistream API allows individual Opus streams to be combined into a single packet, and that's what gives you support for up to 255 channels. periodt.

here's the tea tho: unlike an elementary Opus stream, the encoder and decoder must negotiate the channel configuration before the decoder can successfully interpret the data in the packets produced by the encoder. some basic info — like packet duration — can be computed without any special negotiation, so that part's chill.

the format for multistream Opus packets is defined in RFC 7845, and it's based on the self-delimited Opus framing described in Appendix B of RFC 6716. and bestie, plot twist: normal Opus packets are just a degenerate case of multistream Opus packets 💅, and you can encode or decode them with the multistream API by setting streams to 1 when initializing the encoder or decoder.

multistream Opus streams can contain up to 255 elementary Opus streams. these may be either "uncoupled" or "coupled", which basically means the decoder is configured to decode them to either 1 or 2 channels, respectively. and the streams are ordered so that all coupled streams appear at the beginning. no skipping the line, babes.

a mapping table defines which decoded channel i should be used for each input/output (I/O) channel j. this table is typically provided as an unsigned char array. let i = mapping[j] be the index for I/O channel j. so:

if i < 2*coupled_streams, then I/O channel j is encoded as the left channel of stream (i/2) if i is even, or as the right channel of stream (i/2) if i is odd.
otherwise, I/O channel j is encoded as mono in stream (i - coupled_streams) — unless it has the special value 255, in which case it is omitted from the encoding entirely (the decoder will reproduce it as silence 🔇).

each value i must either be the special value 255 or be less than streams + coupled_streams. that's the rule, don't fight it.

the output channels specified by the encoder should use the Vorbis channel ordering. a decoder may wish to apply an additional permutation to the mapping the encoder used to achieve a different output channel order (e.g. for outputting in WAV order).

each multistream packet contains an Opus packet for each stream, and all of the Opus packets in a single multistream packet must have the same duration. therefore the duration of a multistream packet can be extracted from the TOC sequence of the first stream, which is located at the beginning of the packet, just like an elementary Opus stream:

int nb_samples;
int nb_frames;
nb_frames = opus_packet_get_nb_frames(data, len);
if (nb_frames < 1)
  return nb_frames;
nb_samples = opus_packet_get_samples_per_frame(data, 48000) * nb_frames;

the general encoding and decoding process proceeds exactly the same as in the normal Opus Encoder and Opus Decoder APIs. go read their documentation for an overview of how to use the corresponding multistream functions. 🫶

🧚 Typedef Documentation 🧚

⭐ `typedef struct OpusMSDecoder OpusMSDecoder` ⭐

Opus multistream decoder state. this contains the complete state of a multistream Opus decoder. it is position independent and can be freely copied. no cap.

See also

opus_multistream_decoder_create
opus_multistream_decoder_init

👑 `typedef struct OpusMSEncoder OpusMSEncoder` 👑

Opus multistream encoder state. this contains the complete state of a multistream Opus encoder. it is position independent and can be freely copied. same energy, different direction.

See also

opus_multistream_encoder_create
opus_multistream_encoder_init

🔥 Function Documentation 🔥

💫 `int opus_multistream_decode (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int16 * pcm, int frame_size, int decode_fec)` 💫

Decode a multistream Opus packet.

Parameters

st OpusMSDecoder*: Multistream decoder state.
data const unsigned char*: Input payload. Use a NULL pointer to indicate packet loss.
len opus_int32: Number of bytes in payload.
pcm opus_int16*: Output signal, with interleaved samples. This must contain room for frame_size*channels samples.
frame_size int: The number of samples per channel of available space in pcm. If this is less than the maximum packet duration (120 ms; 5760 for 48kHz), this function will not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), then frame_size needs to be exactly the duration of audio that is missing, otherwise the decoder will not be in the optimal state to decode the next incoming packet. For the PLC and FEC cases, frame_size must be a multiple of 2.5 ms.
decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be decoded. If no such data is available, the frame is decoded as if it were lost.

Returns

Number of samples decoded on success or a negative error code (see Error codes) on failure.

bestie pls do not skip the frame_size rules, the decoder will be in its flop era if you get it wrong 😭

💫 `int opus_multistream_decode24 (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int32 * pcm, int frame_size, int decode_fec)` 💫

Decode a multistream Opus packet.

Parameters

st OpusMSDecoder*: Multistream decoder state.
data const unsigned char*: Input payload. Use a NULL pointer to indicate packet loss.
len opus_int32: Number of bytes in payload.
pcm opus_int32*: Output signal, with interleaved samples representing (or slightly exceeding) 24-bit values. This must contain room for frame_size*channels samples.
frame_size int: The number of samples per channel of available space in pcm. If this is less than the maximum packet duration (120 ms; 5760 for 48kHz), this function will not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), then frame_size needs to be exactly the duration of audio that is missing, otherwise the decoder will not be in the optimal state to decode the next incoming packet. For the PLC and FEC cases, frame_size must be a multiple of 2.5 ms.
decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be decoded. If no such data is available, the frame is decoded as if it were lost.

Returns

Number of samples decoded on success or a negative error code (see Error codes) on failure.

💫 `int opus_multistream_decode_float (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, float * pcm, int frame_size, int decode_fec)` 💫

Decode a multistream Opus packet with floating point output.

Parameters

st (OpusMSDecoder*) — the multistream decoder state. That's the whole vibe container 💜
data (const unsigned char*) — the input payload. Pass a NULL pointer here to say "bestie this packet is GONE" (i.e. packet loss 💀).
len (opus_int32) — how many bytes are chilling in that payload.
pcm (opus_int16*) — the output signal, samples interleaved. It must have room for frame_size*channels samples, no skimping, fr fr.
frame_size (int) — the number of samples per channel of available space in pcm. If this is less than the maximum packet duration (120 ms, which is 5760 at 48kHz), then this function will not be capable of decoding some packets, and that's just the rules 😤. In the case of PLC (data==NULL) or FEC (decode_fec=1), then frame_size needs to be exactly the duration of audio that is missing, otherwise the decoder will not be in the optimal state to decode the next incoming packet. And for the PLC and FEC cases specifically, frame_size must be a multiple of 2.5 ms. Slay, but precisely.
decode_fec (int) — a flag (0 or 1) requesting that any in-band forward error correction data be decoded. If no such data is available, the frame is decoded as if it were lost. Ngl that's just how it goes.

Returns

Number of samples decoded on success, or a negative error code (see Error codes) on failure. ✨

✨ `opus_multistream_decoder_create()` ✨

OpusMSDecoder * opus_multistream_decoder_create (opus_int32 Fs, int
    channels, int streams, int coupled_streams, const unsigned char *
    mapping, int * error)

Allocates and initializes a multistream decoder state. Call opus_multistream_decoder_destroy() to release this object when you're done with it — don't just ghost it, bestie 🫶.

Parameters

Fs (opus_int32) — sampling rate to decode at (in Hz). Must be one of 8000, 12000, 16000, 24000, or 48000. That's the whole menu, no substitutions.
channels (int) — number of channels to output. Must be at most 255. It may be different from the number of coded channels (streams + coupled_streams). Flexible, iconic 💅
streams (int) — the total number of streams coded in the input. Must be no more than 255.
coupled_streams (int) — number of streams to decode as coupled (2 channel) streams. Must be no larger than the total number of streams. Additionally, the total number of coded channels (streams + coupled_streams) must be no more than 255.
mapping (const unsigned char[channels]) — mapping from coded channels to output channels, as described in Opus Multistream API.
error (int *) — returns OPUS_OK on success, or an error code (see Error codes) on failure.

🦋 `opus_multistream_decoder_ctl()` 🦋

int opus_multistream_decoder_ctl (OpusMSDecoder * st, int request,  ...)

Performs a CTL function on a multistream Opus decoder. Generally the request and subsequent arguments are generated by a convenience macro — let the macro cook 👑

Parameters

st (OpusMSDecoder*) — multistream decoder state.
request — this and all remaining parameters should be replaced by one of the convenience macros in Generic CTLs, Decoder related CTLs, or Multistream specific encoder and decoder CTLs.

🌸 `opus_multistream_decoder_destroy()` 🌸

void opus_multistream_decoder_destroy (OpusMSDecoder * st)

Frees an OpusMSDecoder allocated by opus_multistream_decoder_create(). Cleanup era, we love a responsible main character 🧹✨

Parameters

st (OpusMSDecoder) — multistream decoder state to be freed.

⭐ `opus_multistream_decoder_get_size()` ⭐

opus_int32 opus_multistream_decoder_get_size (int streams, int
    coupled_streams)

Gets the size of an OpusMSDecoder structure. Size check first, always 🔍

Parameters

streams (int) — the total number of streams coded in the input. Must be no more than 255.
coupled_streams (int) — number streams to decode as coupled (2 channel) streams. Must be no larger than the total number of streams. Additionally, the total number of coded channels (streams + coupled_streams) must be no more than 255.

Returns

The size in bytes on success, or a negative error code (see Error codes) on error.

💜 `opus_multistream_decoder_init()` 💜

int opus_multistream_decoder_init (OpusMSDecoder * st, opus_int32 Fs, int
    channels, int streams, int coupled_streams, const unsigned char *
    mapping)

Initializes a previously allocated decoder state object. The memory pointed to by st must be at least the size returned by opus_multistream_encoder_get_size(). This is intended for applications which use their own allocator instead of malloc — DIY energy, respect 🫡. To reset a previously initialized state, use the OPUS_RESET_STATE CTL.

Parameters

st (OpusMSEncoder*) — multistream encoder state to initialize.
Fs (opus_int32) — sampling rate to decode at (in Hz). Must be one of 8000, 12000, 16000, 24000, or 48000.
channels (int) — number of channels to output. Must be at most 255. It may be different from the number of coded channels (streams + coupled_streams).
streams (int) — the total number of streams coded in the input. Must be no more than 255.
coupled_streams (int) — number of streams to decode as coupled (2 channel) streams. Must be no larger than the total number of streams. Additionally, the total number of coded channels (streams + coupled_streams) must be no more than 255.
mapping (const unsigned char[channels]) — mapping from coded channels to output channels, as described in Opus Multistream API.

Returns

OPUS_OK on success, or an error code (see Error codes) on failure. ✨

🔥 `opus_multistream_encode()` 🔥

int opus_multistream_encode (OpusMSEncoder * st, const opus_int16 * pcm, int
    frame_size, unsigned char * data, opus_int32 max_data_bytes)

Encodes a multistream Opus frame. Let's get it encoded, bestie 💅

Parameters

st (OpusMSEncoder*) — multistream encoder state.
pcm (const opus_int16*) — the input signal as interleaved samples. This must contain frame_size*channels samples.
frame_size (int) — number of samples per channel in the input signal. This must be an Opus frame size for the encoder's sampling rate. For example, at 48 kHz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10 ms (480 samples at 48 kHz) will prevent the encoder from using the LPC or hybrid modes — so like, short frames = limited mode options, noted 📝
data (unsigned char*) — output payload. This must contain storage for at least max_data_bytes.
max_data_bytes (opus_int32) — size of the allocated memory for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control. Use OPUS_SET_BITRATE to control the bitrate. (Real ones use OPUS_SET_BITRATE, no cap.)

Returns

The length of the encoded packet (in bytes) on success or a negative error code (see Error codes) on failure.

🍓 `opus_multistream_encode24()` 🍓

int opus_multistream_encode24 (OpusMSEncoder * st, const opus_int32 * pcm,
    int frame_size, unsigned char * data, opus_int32 max_data_bytes)

Encodes a multistream Opus frame. (24-bit flavor, extra fancy ✨)

Parameters

st (OpusMSEncoder*) — multistream encoder state.
pcm (const opus_int32*) — the input signal as interleaved samples representing (or slightly exceeding) 24-bit values. This must contain frame_size*channels samples.
frame_size (int) — number of samples per channel in the input signal. This must be an Opus frame size for the encoder's sampling rate. For example, at 48 kHz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10 ms (480 samples at 48 kHz) will prevent the encoder from using the LPC or hybrid modes.
data (unsigned char*) — output payload. This must contain storage for at least max_data_bytes.
max_data_bytes (opus_int32) — size of the allocated memory for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control. Use OPUS_SET_BITRATE to control the bitrate.

Returns

The length of the encoded packet (in bytes) on success or a negative error code (see Error codes) on failure.

🌈 `opus_multistream_encode_float()` 🌈

int opus_multistream_encode_float (OpusMSEncoder * st, const float * pcm,
    int frame_size, unsigned char * data, opus_int32 max_data_bytes)

Encodes a multistream Opus frame from floating point input. Floats, the glamorous option 🫧

Parameters

st (OpusMSEncoder*) — multistream encoder state.
pcm (const float*) — the input signal as interleaved samples with a normal range of +/-1.0. Samples with a range beyond +/-1.0 are supported but will be clipped by decoders using the integer API and should only be used if it is known that the far end supports extended dynamic range. This must contain frame_size*channels samples. > So yeah, going past +/-1.0 is giving risky, only do it if the other side can handle it 😭
frame_size (int) — number of samples per channel in the input signal. This must be an Opus frame size for the encoder's sampling rate. For example, at 48 kHz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10 ms (480 samples at 48 kHz) will prevent the encoder from using the LPC or hybrid modes.
data (unsigned char*) — output payload. This must contain storage for at least max_data_bytes.
max_data_bytes (opus_int32) — size of the allocated memory for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control. Use OPUS_SET_BITRATE to control the bitrate.

Returns

The length of the encoded packet (in bytes) on success or a negative error code (see Error codes) on failure.

👑 `opus_multistream_encoder_create()` 👑

OpusMSEncoder * opus_multistream_encoder_create (opus_int32 Fs, int
    channels, int streams, int coupled_streams, const unsigned char *
    mapping, int application, int * error)

Allocates and initializes a multistream encoder state. Call opus_multistream_encoder_destroy() to release this object when finished — again, cleanup is self care 🧚

Parameters

Fs (opus_int32) — sampling rate of the input signal (in Hz). Must be one of 8000, 12000, 16000, 24000, or 48000.
channels (int) — number of channels in the input signal. Must be at most 255. It may be greater than the number of coded channels (streams + coupled_streams).
streams (int) — the total number of streams to encode from the input. Must be no more than the number of channels.
coupled_streams (int) — number of coupled (2 channel) streams to encode. Must be no larger than the total number of streams. Additionally, the total number of encoded channels (streams + coupled_streams) must be no more than the number of input channels.
mapping (const unsigned char[channels]) — mapping from encoded channels to input channels, as described in Opus Multistream API. As an extra constraint, the multistream encoder does not allow encoding coupled streams for which one channel is unused, since this is never a good idea. Periodt.
application (int) — the target encoder application. Must be one of the following:
- OPUS_APPLICATION_VOIP — Process signal for improved speech intelligibility.
- OPUS_APPLICATION_AUDIO
OPUS_APPLICATION_AUDIO — favor faithfulness to the original input. bestie this is the "don't mess with my music" setting, it keeps the vibe of the input intact 💖
OPUS_APPLICATION_RESTRICTED_LOWDELAY — configure the minimum possible coding delay by disabling certain modes of operation. lowkey it trades options away for speed ✨
error *int **: returns OPUS_OK on success, or an error code (see Error codes) on failure. 🫶

`int opus_multistream_encoder_ctl (OpusMSEncoder * st, int request, ...)`

Perform a CTL function on a multistream Opus encoder. Generally the request and subsequent arguments are generated by a convenience macro — so like, you don't hand-write these, the macro does it for you, iykyk 💅

Parameters 🌸

st *OpusMSEncoder**: multistream encoder state.
request — this and all remaining parameters should be replaced by one of the convenience macros in Generic CTLs, Encoder related CTLs, or Multistream specific encoder and decoder CTLs.

`void opus_multistream_encoder_destroy (OpusMSEncoder * st)`

Frees an OpusMSEncoder allocated by opus_multistream_encoder_create(). it's giving cleanup era, we love a tidy queen 🧚

Parameters 🎀

st *OpusMSEncoder**: multistream encoder state to be freed.

`opus_int32 opus_multistream_encoder_get_size (int streams, int coupled_streams)`

Gets the size of an OpusMSEncoder structure. size check, slay 💅

Parameters ✨

streams int: the total number of streams to encode from the input. this must be no more than 255.
coupled_streams int: number of coupled (2 channel) streams to encode. this must be no larger than the total number of streams. additionally, the total number of encoded channels (streams + coupled_streams) must be no more than 255.

Returns 💖

The size in bytes on success, or a negative error code (see Error codes) on error.

`int opus_multistream_encoder_init (OpusMSEncoder * st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char * mapping, int application)`

Initialize a previously allocated multistream encoder state. the memory pointed to by st must be at least the size returned by opus_multistream_encoder_get_size(). this is intended for applications which use their own allocator instead of malloc. to reset a previously initialized state, use the OPUS_RESET_STATE CTL. ✨

Parameters 🌈

st *OpusMSEncoder**: multistream encoder state to initialize.
Fs opus_int32: sampling rate of the input signal (in Hz). this must be one of 8000, 12000, 16000, 24000, or 48000.
channels int: number of channels in the input signal. this must be at most 255. it may be greater than the number of coded channels (streams + coupled_streams).
streams int: the total number of streams to encode from the input. this must be no more than the number of channels.
coupled_streams int: number of coupled (2 channel) streams to encode. this must be no larger than the total number of streams. additionally, the total number of encoded channels (streams + coupled_streams) must be no more than the number of input channels.
mapping const unsigned char[channels]: mapping from encoded channels to input channels, as described in Opus Multistream API. as an extra constraint, the multistream encoder does not allow encoding coupled streams for which one channel is unused since this is never a good idea. bestie, don't do it. periodt 💀
application int: the target encoder application. this must be one of the following:
- OPUS_APPLICATION_VOIP — process signal for improved speech intelligibility.
- OPUS_APPLICATION_AUDIO — favor faithfulness to the original input.
- OPUS_APPLICATION_RESTRICTED_LOWDELAY — configure the minimum possible coding delay by disabling certain modes of operation.

Returns ⭐

OPUS_OK on success, or an error code (see Error codes) on failure.

and then these three just vibe here, signatures and all, no extra lore attached:

OpusMSEncoder * opus_multistream_surround_encoder_create (opus_int32 Fs, int
    channels, int mapping_family, int * streams, int * coupled_streams,
    unsigned char * mapping, int application, int * error)
opus_int32 opus_multistream_surround_encoder_get_size (int channels, int
    mapping_family)
int opus_multistream_surround_encoder_init (OpusMSEncoder * st, opus_int32
    Fs, int channels, int mapping_family, int * streams, int *
    coupled_streams, unsigned char * mapping, int application)

👑 Author 👑

Generated automatically by Doxygen for Opus from the source code. (the bots ate, fr fr 🤖💅)

okay bestie that's a wrap on the whole page 🎀 this was Version 1.6.1, dated Thu Jan 29 2026 14:35:32, and you just read opus_multistream(3). go forth and multistream, you absolute icon 💖✨🦋

📦 where this page comes from

ubuntu resolute: libopus-doc 1.6.1-1 · BSD-3-Clause
ubuntu stonking: libopus-doc 1.6.1-1 · BSD-3-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

opus_multistream(3)

💖 opus_multistream — the Opus Multistream API, bestie edition 💖

✨ NAME ✨

🦋 SYNOPSIS 🦋

🌸 Typedefs 🌸

🎀 Multistream encoder functions 🎀

💜 Multistream decoder functions 💜

🌈 Detailed Description 🌈

🧚 Typedef Documentation 🧚

⭐ typedef struct OpusMSDecoder OpusMSDecoder ⭐

👑 typedef struct OpusMSEncoder OpusMSEncoder 👑

🔥 Function Documentation 🔥

💫 int opus_multistream_decode (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int16 * pcm, int frame_size, int decode_fec) 💫

💫 int opus_multistream_decode24 (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int32 * pcm, int frame_size, int decode_fec) 💫

💫 int opus_multistream_decode_float (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, float * pcm, int frame_size, int decode_fec) 💫

Parameters

Returns

✨ opus_multistream_decoder_create() ✨

Parameters

🦋 opus_multistream_decoder_ctl() 🦋

Parameters

See also

🌸 opus_multistream_decoder_destroy() 🌸

Parameters

⭐ opus_multistream_decoder_get_size() ⭐

Parameters

Returns

💜 opus_multistream_decoder_init() 💜

See also

Parameters

Returns

🔥 opus_multistream_encode() 🔥

Parameters

Returns

🍓 opus_multistream_encode24() 🍓

Parameters

Returns

🌈 opus_multistream_encode_float() 🌈

Parameters

Returns

👑 opus_multistream_encoder_create() 👑

Parameters

int opus_multistream_encoder_ctl (OpusMSEncoder * st, int request, ...)

Parameters 🌸

See also 🦋

void opus_multistream_encoder_destroy (OpusMSEncoder * st)

Parameters 🎀

opus_int32 opus_multistream_encoder_get_size (int streams, int coupled_streams)

Parameters ✨

Returns 💖

int opus_multistream_encoder_init (OpusMSEncoder * st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char * mapping, int application)

See also 🫶

Parameters 🌈

Returns ⭐

👑 Author 👑

⭐ `typedef struct OpusMSDecoder OpusMSDecoder` ⭐

👑 `typedef struct OpusMSEncoder OpusMSEncoder` 👑

💫 `int opus_multistream_decode (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int16 * pcm, int frame_size, int decode_fec)` 💫

💫 `int opus_multistream_decode24 (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, opus_int32 * pcm, int frame_size, int decode_fec)` 💫

💫 `int opus_multistream_decode_float (OpusMSDecoder * st, const unsigned char * data, opus_int32 len, float * pcm, int frame_size, int decode_fec)` 💫

✨ `opus_multistream_decoder_create()` ✨

🦋 `opus_multistream_decoder_ctl()` 🦋

🌸 `opus_multistream_decoder_destroy()` 🌸

⭐ `opus_multistream_decoder_get_size()` ⭐

💜 `opus_multistream_decoder_init()` 💜

🔥 `opus_multistream_encode()` 🔥

🍓 `opus_multistream_encode24()` 🍓

🌈 `opus_multistream_encode_float()` 🌈

👑 `opus_multistream_encoder_create()` 👑

`int opus_multistream_encoder_ctl (OpusMSEncoder * st, int request, ...)`

`void opus_multistream_encoder_destroy (OpusMSEncoder * st)`

`opus_int32 opus_multistream_encoder_get_size (int streams, int coupled_streams)`

`int opus_multistream_encoder_init (OpusMSEncoder * st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char * mapping, int application)`