oggreader

type HeaderType ¶ added in v4.2.0

type HeaderType string

const (
	HeaderOpusID   HeaderType = "OpusHead"
	HeaderOpusTags HeaderType = "OpusTags"
)

type OggHeader ¶

type OggHeader struct {
	ChannelMap   uint8
	Channels     uint8
	OutputGain   uint16
	PreSkip      uint16
	SampleRate   uint32
	Version      uint8
	StreamCount  uint8
	CoupledCount uint8
	// ChannelMapping we store it as a string to be comparable (maps/struct equality)
	// while still holding raw bytes.
	ChannelMapping string
}

OggHeader contains Opus codec metadata parsed from an Opus ID page. This header is extracted from an Ogg page payload that starts with the OpusHead signature (the first page of an Opus stream in an Ogg container).

Use OggPageHeader.OpusPacketType() to classify a page payload as OpusHead, and OggPageHeader.ParseOpusHeader() to parse the OpusHead payload.

https://tools.ietf.org/html/rfc7845.html#section-3

func ParseOpusHead(payload []byte) (*OggHeader, error)

type OggPageHeader ¶

type OggPageHeader struct {
	GranulePosition uint64

	Serial uint32
	// contains filtered or unexported fields
}

OggPageHeader is the metadata for a Page Pages are the fundamental unit of multiplexing in an Ogg stream

https://tools.ietf.org/html/rfc7845.html#section-1

func (p *OggPageHeader) HeaderType(payload []byte) (HeaderType, bool)

type OggReader ¶

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

OggReader is used to read Ogg files and return page payloads.

func NewWithOptions(in io.Reader, options ...Option) (*OggReader, error)

func (o *OggReader) ParseNextPage() ([]byte, *OggPageHeader, error)

func (o *OggReader) ResetReader(reset func(bytesRead int64) io.Reader)

type Option ¶ added in v4.2.0

type Option func(*OggReader) error

func WithDoChecksum(doChecksum bool) Option

type OpusTags ¶ added in v4.2.0

type OpusTags struct {
	Vendor       string
	UserComments []UserComment
}

OpusTags is the metadata for an OpusTags page. https://www.xiph.org/vorbis/doc/v-comment.html

func ParseOpusTags(payload []byte) (*OpusTags, error)

type UserComment ¶ added in v4.2.0

type UserComment struct {
	Comment string
	Value   string
}

UserComment is a key-value pair of a vorbis comment.