opus

package module

Go to main page

Versions in this module

v1

v1.2.0

Jun 25, 2026

Changes in this version

+ const ChannelsAuto

+ const ExtensionFrameAll

+ const ExtensionIDDRED

+ const ExtensionIDQEXT

+ const FrameSize100ms

+ const FrameSize120ms

+ const FrameSize80ms

+ const GainQ8Max

+ const GainQ8Min

+ const GetPhaseInversionDisabledRequest

+ const LSBDepthDefault

+ const LSBDepthMax

+ const LSBDepthMin

+ const MappingFamilyAmbisonics

+ const MappingFamilyDiscrete

+ const MappingFamilyMonoStereo

+ const MappingFamilyProjection

+ const MappingFamilyVorbis

+ const MaxFrameBytes

+ const MaxPacketFrames

+ const SetPhaseInversionDisabledRequest

+ func PacketExtensionsCount(packet []byte) (int, error)

+ func PacketExtensionsGenerate(packet []byte, extensions []PacketExtension, paddingBytes int) ([]byte, error)

+ func PacketGetBandwidth(data []byte) (int, error)

+ func PacketGetConfig(data []byte) (int, error)

+ func PacketGetMode(data []byte) (int, error)

+ func PacketGetNumChannels(data []byte) (int, error)

+ func PacketGetNumFrames(data []byte) (int, error)

+ func PacketGetNumSamples(data []byte, sampleRate int) (int, error)

+ func PacketGetSamplesPerFrame(data []byte, sampleRate int) (int, error)

+ func PacketPad(packet []byte, newLen int) ([]byte, error)

+ func PacketUnpad(packet []byte) ([]byte, error)

+ type AmbisonicsDecoder struct

+ func NewAmbisonicsDecoder(sampleRate, channels, mappingFamily, streams, coupledStreams int, ...) (*AmbisonicsDecoder, error)

+ func (d *AmbisonicsDecoder) Decode(data []byte, pcm []int16) (int, error)

+ func (d *AmbisonicsDecoder) Decode24(data []byte, pcm []int32) (int, error)

+ func (d *AmbisonicsDecoder) DecodeFloat(data []byte) ([]float64, error)

+ func (d *AmbisonicsDecoder) DecodeFloat32(data []byte) ([]float32, error)

+ func (d *AmbisonicsDecoder) FinalRange() uint32

+ func (d *AmbisonicsDecoder) MappingFamily() int

+ func (d *AmbisonicsDecoder) Reset() error

type Decoder

+ func (d *Decoder) Channels() int

+ func (d *Decoder) Decode24(data []byte, pcm []int32) (int, error)

+ func (d *Decoder) DecodeFloat32(data []byte) ([]float32, error)

+ func (d *Decoder) DecodePLC(pcm []int16, frameSize int) (int, error)

+ func (d *Decoder) FinalRange() uint32

+ func (d *Decoder) Gain() int

+ func (d *Decoder) PhaseInversionDisabled() bool

+ func (d *Decoder) Pitch() int

+ func (d *Decoder) SampleRate() int

+ func (d *Decoder) SetGain(gainQ8 int) error

+ func (d *Decoder) SetPhaseInversionDisabled(disabled bool)

type Encoder

+ func NewEncoderWithProfile(sampleRate, channels int, application Application, profile EncoderProfile) (*Encoder, error)

+ func (e *Encoder) Channels() int

+ func (e *Encoder) EffectiveBitrate() int

+ func (e *Encoder) Encode24(pcm []int32, frameSize int) ([]byte, error)

+ func (e *Encoder) EncodeFloat32(pcm []float32, frameSize int) ([]byte, error)

+ func (e *Encoder) FinalRange() uint32

+ func (e *Encoder) ForceChannels() int

+ func (e *Encoder) InDTX() bool

+ func (e *Encoder) InbandFEC() bool

+ func (e *Encoder) LSBDepth() int

+ func (e *Encoder) Lookahead() int

+ func (e *Encoder) MaxBandwidth() int

+ func (e *Encoder) PacketLossPerc() int

+ func (e *Encoder) PhaseInversionDisabled() bool

+ func (e *Encoder) PredictionDisabled() bool

+ func (e *Encoder) SampleRate() int

+ func (e *Encoder) SetForceChannels(channels int) error

+ func (e *Encoder) SetInbandFEC(enabled bool)

+ func (e *Encoder) SetLSBDepth(depth int) error

+ func (e *Encoder) SetPacketLossPerc(perc int)

+ func (e *Encoder) SetPhaseInversionDisabled(disabled bool)

+ func (e *Encoder) SetPredictionDisabled(disabled bool)

+ func (e *Encoder) VBRConstraint() bool

+ type EncoderProfile int

+ const EncoderProfileLegacy

+ const EncoderProfileLibopus

+ type MappingMatrix struct

+ func NewMappingMatrix(rows, cols, gain int, data []int16) (*MappingMatrix, error)

+ func NewMappingMatrixFromBytes(rows, cols, gain int, data []byte) (*MappingMatrix, error)

+ func (m *MappingMatrix) At(row, col int) (int16, error)

+ func (m *MappingMatrix) Bytes() []byte

+ func (m *MappingMatrix) Coefficients() []int16

+ func (m *MappingMatrix) Cols() int

+ func (m *MappingMatrix) Gain() int

+ func (m *MappingMatrix) Rows() int

+ type MultistreamDecoder struct

+ func NewMultistreamDecoder(sampleRate, channels, streams, coupledStreams int, mapping []byte) (*MultistreamDecoder, error)

+ func (d *MultistreamDecoder) Channels() int

+ func (d *MultistreamDecoder) CoupledStreams() int

+ func (d *MultistreamDecoder) Decode(data []byte, pcm []int16) (int, error)

+ func (d *MultistreamDecoder) Decode24(data []byte, pcm []int32) (int, error)

+ func (d *MultistreamDecoder) DecodeFloat(data []byte) ([]float64, error)

+ func (d *MultistreamDecoder) DecodeFloat32(data []byte) ([]float32, error)

+ func (d *MultistreamDecoder) FinalRange() uint32

+ func (d *MultistreamDecoder) Mapping() []byte

+ func (d *MultistreamDecoder) Reset() error

+ func (d *MultistreamDecoder) SampleRate() int

+ func (d *MultistreamDecoder) StreamDecoder(stream int) (*Decoder, error)

+ func (d *MultistreamDecoder) Streams() int

+ type MultistreamEncoder struct

+ func NewMultistreamEncoder(sampleRate, channels, streams, coupledStreams int, mapping []byte, ...) (*MultistreamEncoder, error)

+ func (e *MultistreamEncoder) Bitrate() int

+ func (e *MultistreamEncoder) Channels() int

+ func (e *MultistreamEncoder) CoupledStreams() int

+ func (e *MultistreamEncoder) Encode(pcm []int16, frameSize int) ([]byte, error)

+ func (e *MultistreamEncoder) Encode24(pcm []int32, frameSize int) ([]byte, error)

+ func (e *MultistreamEncoder) EncodeFloat(pcm []float64, frameSize int) ([]byte, error)

+ func (e *MultistreamEncoder) EncodeFloat32(pcm []float32, frameSize int) ([]byte, error)

+ func (e *MultistreamEncoder) FinalRange() uint32

+ func (e *MultistreamEncoder) Mapping() []byte

+ func (e *MultistreamEncoder) Reset() error

+ func (e *MultistreamEncoder) SampleRate() int

+ func (e *MultistreamEncoder) SetBitrate(bitrate int) error

+ func (e *MultistreamEncoder) SetComplexity(complexity int) error

+ func (e *MultistreamEncoder) SetVBR(enabled bool)

+ func (e *MultistreamEncoder) SetVBRConstraint(enabled bool)

+ func (e *MultistreamEncoder) StreamEncoder(stream int) (*Encoder, error)

+ func (e *MultistreamEncoder) Streams() int

+ type PacketExtension struct

+ Data []byte

+ Frame int

+ ID int

+ func PacketExtensionsParse(packet []byte) ([]PacketExtension, error)

+ type ProjectionDecoder struct

+ func NewProjectionDecoder(sampleRate, channels, streams, coupledStreams int, demixingMatrix []byte) (*ProjectionDecoder, error)

+ func (d *ProjectionDecoder) Channels() int

+ func (d *ProjectionDecoder) CoupledStreams() int

+ func (d *ProjectionDecoder) Decode(data []byte, pcm []int16) (int, error)

+ func (d *ProjectionDecoder) Decode24(data []byte, pcm []int32) (int, error)

+ func (d *ProjectionDecoder) DecodeFloat(data []byte) ([]float64, error)

+ func (d *ProjectionDecoder) DecodeFloat32(data []byte) ([]float32, error)

+ func (d *ProjectionDecoder) FinalRange() uint32

+ func (d *ProjectionDecoder) Reset() error

+ func (d *ProjectionDecoder) SampleRate() int

+ func (d *ProjectionDecoder) StreamDecoder(stream int) (*Decoder, error)

+ func (d *ProjectionDecoder) Streams() int

+ type ProjectionEncoder struct

+ func NewAmbisonicsEncoder(sampleRate, channels, mappingFamily int, application Application) (*ProjectionEncoder, error)

+ func NewProjectionEncoder(sampleRate, channels, mappingFamily int, application Application) (*ProjectionEncoder, error)

+ func (e *ProjectionEncoder) Bitrate() int

+ func (e *ProjectionEncoder) Channels() int

+ func (e *ProjectionEncoder) CoupledStreams() int

+ func (e *ProjectionEncoder) DemixingMatrix() *MappingMatrix

+ func (e *ProjectionEncoder) DemixingMatrixBytes() []byte

+ func (e *ProjectionEncoder) DemixingMatrixGain() int

+ func (e *ProjectionEncoder) Encode(pcm []int16, frameSize int) ([]byte, error)

+ func (e *ProjectionEncoder) Encode24(pcm []int32, frameSize int) ([]byte, error)

+ func (e *ProjectionEncoder) EncodeFloat(pcm []float64, frameSize int) ([]byte, error)

+ func (e *ProjectionEncoder) EncodeFloat32(pcm []float32, frameSize int) ([]byte, error)

+ func (e *ProjectionEncoder) FinalRange() uint32

+ func (e *ProjectionEncoder) Mapping() []byte

+ func (e *ProjectionEncoder) MappingFamily() int

+ func (e *ProjectionEncoder) Reset() error

+ func (e *ProjectionEncoder) SampleRate() int

+ func (e *ProjectionEncoder) SetBitrate(bitrate int) error

+ func (e *ProjectionEncoder) SetComplexity(complexity int) error

+ func (e *ProjectionEncoder) SetVBR(enabled bool)

+ func (e *ProjectionEncoder) SetVBRConstraint(enabled bool)

+ func (e *ProjectionEncoder) StreamEncoder(stream int) (*Encoder, error)

+ func (e *ProjectionEncoder) Streams() int

+ type Repacketizer struct

+ func NewRepacketizer() *Repacketizer

+ func (r *Repacketizer) Cat(packet []byte) error

+ func (r *Repacketizer) NumFrames() int

+ func (r *Repacketizer) Out() ([]byte, error)

+ func (r *Repacketizer) OutRange(begin, end int) ([]byte, error)

+ func (r *Repacketizer) Reset()

+ type SurroundDecoder struct

+ func NewSurroundDecoder(sampleRate, channels, mappingFamily int) (*SurroundDecoder, error)

+ func (d *SurroundDecoder) LFEStream() int

+ func (d *SurroundDecoder) MappingFamily() int

+ type SurroundEncoder struct

+ func NewSurroundEncoder(sampleRate, channels, mappingFamily int, application Application) (*SurroundEncoder, error)

+ func (e *SurroundEncoder) Bitrate() int

+ func (e *SurroundEncoder) Encode(pcm []int16, frameSize int) ([]byte, error)

+ func (e *SurroundEncoder) Encode24(pcm []int32, frameSize int) ([]byte, error)

+ func (e *SurroundEncoder) EncodeFloat(pcm []float64, frameSize int) ([]byte, error)

+ func (e *SurroundEncoder) EncodeFloat32(pcm []float32, frameSize int) ([]byte, error)

+ func (e *SurroundEncoder) LFEStream() int

+ func (e *SurroundEncoder) MappingFamily() int

+ func (e *SurroundEncoder) SetBitrate(bitrate int) error

v1.1.1

Jun 15, 2026

Changes in this version

type Encoder

+ func (e *Encoder) Application() Application

+ func (e *Encoder) Bitrate() int

+ func (e *Encoder) Complexity() int

+ func (e *Encoder) SetSignalType(s SignalType)

+ func (e *Encoder) SignalType() SignalType

+ func (e *Encoder) VBR() bool

+ type SignalType = celt.SignalType

v1.1.0

Jun 15, 2026

Changes in this version

+ const BandwidthAuto

type Encoder

+ func (e *Encoder) Bandwidth() int

+ func (e *Encoder) DTX() bool

+ func (e *Encoder) SetBandwidth(bw int) error

+ func (e *Encoder) SetDTX(enabled bool)

+ func (e *Encoder) SetMaxBandwidth(bw int) error

+ func (e *Encoder) SetPacketPadding(n int)

+ func (e *Encoder) SetVBRConstraint(constrained bool)

v1.0.0

Jun 14, 2026

Changes in this version

+ const ApplicationAudio

+ const ApplicationRestrictedLowDelay

+ const ApplicationVOIP

+ const BandwidthFullband

+ const BandwidthMediumband

+ const BandwidthNarrowband

+ const BandwidthSuperWideband

+ const BandwidthWideband

+ const BitrateAuto

+ const BitrateMax

+ const BitrateMaxVal

+ const BitrateMin

+ const ChannelsMono

+ const ChannelsStereo

+ const ComplexityDefault

+ const ComplexityMax

+ const ComplexityMin

+ const FrameSize10ms

+ const FrameSize20ms

+ const FrameSize2_5ms

+ const FrameSize40ms

+ const FrameSize5ms

+ const FrameSize60ms

+ const GetApplicationRequest

+ const GetBandwidthRequest

+ const GetBitrateRequest

+ const GetComplexityRequest

+ const GetDTXRequest

+ const GetExpertFrameDurationRequest

+ const GetForceChannelsRequest

+ const GetInbandFECRequest

+ const GetLookaheadRequest

+ const GetMaxBandwidthRequest

+ const GetPacketLossPercRequest

+ const GetPredictionDisabledRequest

+ const GetSignalRequest

+ const GetVBRConstraintRequest

+ const GetVBRRequest

+ const MaxFrameSize

+ const MaxPacketSize

+ const ModeCELTOnly

+ const ModeHybrid

+ const ModeSILKOnly

+ const PacketLossPercMax

+ const PacketLossPercMin

+ const ResetStateRequest

+ const SampleRate12kHz

+ const SampleRate16kHz

+ const SampleRate24kHz

+ const SampleRate48kHz

+ const SampleRate8kHz

+ const SetApplicationRequest

+ const SetBandwidthRequest

+ const SetBitrateRequest

+ const SetComplexityRequest

+ const SetDTXRequest

+ const SetExpertFrameDurationRequest

+ const SetForceChannelsRequest

+ const SetInbandFECRequest

+ const SetMaxBandwidthRequest

+ const SetPacketLossPercRequest

+ const SetPredictionDisabledRequest

+ const SetSignalRequest

+ const SetVBRConstraintRequest

+ const SetVBRRequest

+ const SignalAuto

+ const SignalMusic

+ const SignalVoice

+ const Version

+ const VersionMajor

+ const VersionMinor

+ const VersionPatch

+ var ErrAllocFail = errors.New("opus: allocation failed")

+ var ErrBadArg = errors.New("opus: bad argument")

+ var ErrBufferTooSmall = errors.New("opus: buffer too small")

+ var ErrInternalError = errors.New("opus: internal error")

+ var ErrInvalidPacket = errors.New("opus: invalid packet")

+ var ErrInvalidState = errors.New("opus: invalid state")

+ var ErrUnimplemented = errors.New("opus: unimplemented")

+ var ErrUnsupportedBandwidth = errors.New("opus: unsupported bandwidth")

+ var ErrUnsupportedChannels = errors.New("opus: unsupported number of channels")

+ var ErrUnsupportedFrameSize = errors.New("opus: unsupported frame size")

+ var ErrUnsupportedSampleRate = errors.New("opus: unsupported sample rate")

+ type Application = int

+ type Decoder struct

+ func NewDecoder(sampleRate, channels int) (*Decoder, error)

+ func (d *Decoder) Decode(data []byte, pcm []int16) (int, error)

+ func (d *Decoder) DecodeFEC(data []byte, pcm []int16) (int, error)

+ func (d *Decoder) DecodeFloat(data []byte) ([]float64, error)

+ func (d *Decoder) GetLastPacketDuration() int

+ func (d *Decoder) Reset() error

+ type Encoder struct

+ func NewEncoder(sampleRate, channels int, application Application) (*Encoder, error)

+ func (e *Encoder) Encode(pcm []int16, frameSize int) ([]byte, error)

+ func (e *Encoder) EncodeFloat(pcm []float64, frameSize int) ([]byte, error)

+ func (e *Encoder) Reset() error

+ func (e *Encoder) SetApplication(application Application)

+ func (e *Encoder) SetBitrate(bitrate int) error

+ func (e *Encoder) SetComplexity(complexity int) error

+ func (e *Encoder) SetVBR(vbr bool)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL