ruopus

User Guide

  • Installation
    • Requirements
    • Install from PyPI
    • Build from Source
    • Verifying the Install
  • Quickstart
    • Basic Encode → Decode
    • Choosing a Bitrate
    • Mono Audio
    • Decoding to int16
    • Streaming Pipeline
    • Adjusting Encoder Settings at Runtime
    • Next Steps
  • Codec Modes
    • The Three Modes
      • SILK-Only
      • CELT-Only
      • Hybrid
    • Automatic Mode Selection
    • Checking the Mode of a Decoded Packet
    • Application Profiles
    • Signal Hints
    • Bandwidth Control
  • Frame Sizes
    • Valid Frame Sizes
    • Choosing a Frame Size
    • Per-Method Valid Frame Sizes
    • Samples vs Duration
    • Encoder Lookahead
  • Ogg Opus Files
    • Encoding to Ogg Opus
    • Decoding from Ogg Opus
    • Reading the OpusHead
    • Round-Trip Fidelity
    • Saving Decoded Audio
  • Packet Loss Handling
    • Packet Loss Concealment
    • In-Band FEC (LBRR)
      • Enable FEC on the Encoder
      • Recover a Lost Packet Using FEC
    • Realistic Loss Handling Loop
    • Tuning for Loss-Prone Networks
  • Packet Inspection
    • The TOC Byte
      • Reading TOC Fields
      • Building a TOC from Parts
      • Hashing and Equality
    • Parsing a Full Packet
      • Self-Delimited Parsing
    • Inspecting a Live Stream
    • Bit-Exactness Check
  • Multistream Decoding
    • Understanding Multistream Layout
    • Creating a MultistreamDecoder
    • Decoding Multistream Packets
    • Stereo-Only (Family 0)
    • Surround Layouts from RFC 7845
    • Silent Channels
    • Output Sample Rates
  • Low-Level API
    • CELT Encoder and Decoder
    • SILK Encoder and Decoder
      • SILK Stereo Encoding
    • LPC Arithmetic
      • Autocorrelation
      • Levinson-Durbin
      • Full LPC Analysis
      • Residual and Synthesis
      • Long-Term Prediction (LTP)
    • DecControl

API Reference

  • API Reference
    • Encoder
      • OpusEncoder
        • OpusEncoder.application
        • OpusEncoder.bandwidth
        • OpusEncoder.bandwidth_forced
        • OpusEncoder.bitrate
        • OpusEncoder.channels
        • OpusEncoder.complexity
        • OpusEncoder.dtx
        • OpusEncoder.encode()
        • OpusEncoder.encode_auto()
        • OpusEncoder.encode_hybrid()
        • OpusEncoder.encode_silk()
        • OpusEncoder.final_range
        • OpusEncoder.force_channels
        • OpusEncoder.inband_fec
        • OpusEncoder.lookahead
        • OpusEncoder.max_bandwidth
        • OpusEncoder.packet_loss_perc
        • OpusEncoder.reset()
        • OpusEncoder.set_auto_bandwidth()
        • OpusEncoder.signal
        • OpusEncoder.vbr
    • Decoder
      • OpusDecoder
        • OpusDecoder.channels
        • OpusDecoder.decode_fec()
        • OpusDecoder.decode_lost()
        • OpusDecoder.decode_packet()
        • OpusDecoder.decode_packet_i16()
        • OpusDecoder.final_range
        • OpusDecoder.sample_rate
    • Multistream Decoder
      • MultistreamDecoder
        • MultistreamDecoder.channels
        • MultistreamDecoder.decode_packet()
        • MultistreamDecoder.sample_rate
    • Ogg Opus
      • encode_ogg_opus()
      • decode_ogg_opus()
      • OpusHead
        • OpusHead.channel_count
        • OpusHead.channel_mapping
        • OpusHead.coupled_count
        • OpusHead.input_sample_rate
        • OpusHead.mapping_family
        • OpusHead.output_gain_q8
        • OpusHead.pre_skip
        • OpusHead.stream_count
        • OpusHead.to_bytes()
        • OpusHead.version
    • Packet Introspection
      • Packet
        • Packet.duration
        • Packet.frames
        • Packet.padding
        • Packet.parse_self_delimited()
        • Packet.toc
      • Toc
        • Toc.bandwidth
        • Toc.byte
        • Toc.channels
        • Toc.config
        • Toc.frame_count_code
        • Toc.frame_size
        • Toc.from_parts()
        • Toc.mode
        • Toc.stereo
    • Enumerations
      • Mode
        • Mode.CeltOnly
        • Mode.Hybrid
        • Mode.SilkOnly
      • Bandwidth
        • Bandwidth.FullBand
        • Bandwidth.MediumBand
        • Bandwidth.NarrowBand
        • Bandwidth.SuperWideBand
        • Bandwidth.WideBand
        • Bandwidth.audio_bandwidth_hz
        • Bandwidth.sample_rate_hz
      • FrameSize
        • FrameSize.Ms10
        • FrameSize.Ms20
        • FrameSize.Ms2_5
        • FrameSize.Ms40
        • FrameSize.Ms5
        • FrameSize.Ms60
        • FrameSize.duration
        • FrameSize.samples_per_channel_48k
        • FrameSize.tenth_ms
      • Signal
        • Signal.Auto
        • Signal.Music
        • Signal.Voice
      • Application
        • Application.Audio
        • Application.RestrictedLowDelay
        • Application.Voip
    • Exceptions
      • OpusError
      • EncodeError
      • PacketError
      • OggError
    • Low-Level Module
      • CeltDecoder
        • CeltDecoder.channels
        • CeltDecoder.decode_lost()
        • CeltDecoder.final_range
        • CeltDecoder.sample_rate
      • CeltEncoder
        • CeltEncoder.bitrate
        • CeltEncoder.channels
        • CeltEncoder.complexity
        • CeltEncoder.encode_frame()
        • CeltEncoder.encode_frame_bw()
        • CeltEncoder.final_range
      • LpcCoefficients
        • LpcCoefficients.coeffs
        • LpcCoefficients.order
      • compute_autocorrelation()
      • estimate_pitch()
      • levinson_durbin()
      • lpc_analysis()
      • lpc_residual()
      • lpc_residual_stateful()
      • lpc_synthesis()
      • lpc_synthesis_stateful()
      • ltp_residual()
      • ltp_synthesis()
      • DecControl
        • DecControl.api_sample_rate
        • DecControl.channels_api
        • DecControl.channels_internal
        • DecControl.internal_sample_rate
        • DecControl.payload_size_ms
      • SilkDecoder
        • SilkDecoder.decode()
        • SilkDecoder.decode_fec()
        • SilkDecoder.decode_lost()
      • SilkEncoder
        • SilkEncoder.bitrate
        • SilkEncoder.complexity
        • SilkEncoder.encode()
        • SilkEncoder.encode_capped()
        • SilkEncoder.final_range
      • SilkStereoEncoder
        • SilkStereoEncoder.bitrate
        • SilkStereoEncoder.complexity
        • SilkStereoEncoder.encode()
ruopus
  • Search

© Copyright 2026, Jack Geraghty.

Built with Sphinx using a theme provided by Read the Docs.