gopus

README

gopus

gopus is a Go binding for the Opus audio codec.

Documentation

• API Reference

Requirements

• cgo
• opus development library (only on platforms where the shared library is used)

License

Public domain

Author

Tim Cooper (tim.cooper@layeh.com)

Documentation

Index

• Constants
• Variables
• func CountFrames(data []byte) (int, error)
• type Application
• type Decoder
  • func NewDecoder(sampleRate, channels int) (*Decoder, error)
  • func (d *Decoder) Decode(data []byte, frameSize int, fec bool) ([]int16, error)
  • func (d *Decoder) ResetState()
• type Encoder
  • func NewEncoder(sampleRate, channels int, application Application) (*Encoder, error)
  • func (e *Encoder) Application() Application
  • func (e *Encoder) Bitrate() int
  • func (e *Encoder) Encode(pcm []int16, frameSize, maxDataBytes int) ([]byte, error)
  • func (e *Encoder) ResetState()
  • func (e *Encoder) SetApplication(application Application)
  • func (e *Encoder) SetBitrate(bitrate int)
  • func (e *Encoder) SetVbr(vbr bool)

Constants

const (
	BitrateMaximum = C.gopus_bitrate_max
)

Variables

var (
	ErrBadArgument   = errors.New("bad argument")
	ErrSmallBuffer   = errors.New("buffer is too small")
	ErrInternal      = errors.New("internal error")
	ErrInvalidPacket = errors.New("invalid packet")
	ErrUnimplemented = errors.New("unimplemented")
	ErrInvalidState  = errors.New("invalid state")
	ErrAllocFail     = errors.New("allocation failed")
	ErrUnknown       = errors.New("unknown error")
)

Functions

func CountFrames

func CountFrames(data []byte) (int, error)

Types

type Application

type Application int

const (
	Voip               Application = C.gopus_application_voip
	Audio              Application = C.gopus_application_audio
	RestrictedLowDelay Application = C.gopus_restricted_lowdelay
)

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

func NewDecoder

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

func (*Decoder) Decode

func (d *Decoder) Decode(data []byte, frameSize int, fec bool) ([]int16, error)

func (*Decoder) ResetState

func (d *Decoder) ResetState()

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

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

func (*Encoder) Application

func (e *Encoder) Application() Application

func (*Encoder) Bitrate

func (e *Encoder) Bitrate() int

func (*Encoder) Encode

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

func (*Encoder) ResetState

func (e *Encoder) ResetState()

func (*Encoder) SetApplication

func (e *Encoder) SetApplication(application Application)

func (*Encoder) SetBitrate

func (e *Encoder) SetBitrate(bitrate int)

func (*Encoder) SetVbr

func (e *Encoder) SetVbr(vbr bool)