ogg

Documentation

Index

• Variables
• type Reader
  • func (o *Reader) Close() error
  • func (o *Reader) EndOfPacket() bool
  • func (o *Reader) Init(r io.Reader) (err error)
  • func (o *Reader) NextPacket() (err error)
  • func (o *Reader) ReadBits(bits uint32) uint32
  • func (o *Reader) ReadBytes(p []byte)
  • func (o *Reader) ReadString() string

Variables

var (
	// ErrEndOfPacket indicates reach packet edge
	ErrEndOfPacket = errors.New("ogg: end of packet")

	// ErrCorrupted indicates bad ogg format or data corrupted
	ErrCorrupted = errors.New("ogg: corrupted")
)

Types

type Reader

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

Reader for ogg stream see: https://xiph.org/vorbis/doc/framing.html

basic structure of ogg is like this: --------------page-------------|-----page------|----page------- segment|segment.segment.segment.segment|segment.segment.segment =======|============ packet ===========|======== packet =======

for vorbis decode, we read the ogg file, decode into packets, pass the packet to vorbis decoder bit by bit.

func (*Reader) Close

func (o *Reader) Close() error

Close the underlying file

func (*Reader) EndOfPacket

func (o *Reader) EndOfPacket() bool

func (*Reader) Init

func (o *Reader) Init(r io.Reader) (err error)

func (*Reader) NextPacket

func (o *Reader) NextPacket() (err error)

func (*Reader) ReadBits

func (o *Reader) ReadBits(bits uint32) uint32

func (*Reader) ReadBytes

func (o *Reader) ReadBytes(p []byte)

func (*Reader) ReadString

func (o *Reader) ReadString() string