params

Documentation

Overview

Package params defines the codec-parameter payload used by the WAV format plugin for Microsoft and IMA ADPCM streams.

Index

• func SamplesPerBlock(codec media.CodecID, channels int, blockAlign uint16) (uint16, error)
• type ADPCM
  • func Default(codec media.CodecID, channels int) (ADPCM, error)
  • func Parse(codec media.CodecID, channels int, data []byte) (ADPCM, error)
  • func (p ADPCM) MarshalBinary() []byte
  • func (p ADPCM) Validate(codec media.CodecID, channels int) error
• type Coefficient

Functions

func SamplesPerBlock

func SamplesPerBlock(codec media.CodecID, channels int, blockAlign uint16) (uint16, error)

SamplesPerBlock derives the WAV ADPCM samples-per-block value from block alignment.

Types

type ADPCM

type ADPCM struct {
	BlockAlign      uint16
	SamplesPerBlock uint16
	Coefficients    []Coefficient
}

ADPCM contains the framing parameters shared by a WAV ADPCM stream and its codec. Coefficients is used only by Microsoft ADPCM.

func Default

func Default(codec media.CodecID, channels int) (ADPCM, error)

Default returns the compatibility default used for newly encoded ADPCM streams.

func Parse

func Parse(codec media.CodecID, channels int, data []byte) (ADPCM, error)

Parse decodes and validates a SchemaADPCMV1 payload.

func (ADPCM) MarshalBinary

func (p ADPCM) MarshalBinary() []byte

MarshalBinary encodes an ADPCM parameter payload for SchemaADPCMV1.

func (ADPCM) Validate

func (p ADPCM) Validate(codec media.CodecID, channels int) error

Validate verifies parameters against the selected ADPCM codec and channel count.

type Coefficient

type Coefficient struct {
	Coeff1 int16
	Coeff2 int16
}

Coefficient is one Microsoft ADPCM predictor coefficient pair.