vorbis

Documentation

Overview

Package vorbis provides Ogg/Vorbis decoder.

Index

• type Stream
  • func Decode(context *audio.Context, src io.Reader) (*Stream, error)
  • func DecodeF32(src io.Reader) (*Stream, error)
  • func DecodeWithSampleRate(sampleRate int, src io.Reader) (*Stream, error)
  • func DecodeWithoutResampling(src io.Reader) (*Stream, error)
  • func (s *Stream) Length() int64
  • func (s *Stream) Read(p []byte) (int, error)
  • func (s *Stream) SampleRate() int
  • func (s *Stream) Seek(offset int64, whence int) (int64, error)

Types

type Stream

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

Stream is a decoded audio stream.

func Decode

func Decode(context *audio.Context, src io.Reader) (*Stream, error)

Decode decodes Ogg/Vorbis data to playable stream in signed 16bit integer, little endian, 2 channels (stereo) format.

Decode returns error when decoding fails or IO error happens.

Decode automatically resamples the stream to fit with the audio context if necessary.

The returned Stream's Seek is available only when src is an io.Seeker.

A Stream doesn't close src even if src implements io.Closer. Closing the source is src owner's responsibility.

Deprecated: as of v2.1. Use DecodeWithSampleRate instead.

func DecodeF32

func DecodeF32(src io.Reader) (*Stream, error)

DecodeF32 decodes Ogg/Vorbis data to playable stream in 32bit float, little endian, 2 channels (stereo) format.

DecodeF32 returns error when decoding fails or IO error happens.

The returned Stream's Seek is available only when src is an io.Seeker.

A Stream doesn't close src even if src implements io.Closer. Closing the source is src owner's responsibility.

func DecodeWithSampleRate

func DecodeWithSampleRate(sampleRate int, src io.Reader) (*Stream, error)

DecodeWithSampleRate decodes Ogg/Vorbis data to playable stream in signed 16bit integer, little endian, 2 channels (stereo) format.

DecodeWithSampleRate returns error when decoding fails or IO error happens.

DecodeWithSampleRate automatically resamples the stream to fit with sampleRate if necessary.

The returned Stream's Seek is available only when src is an io.Seeker.

A Stream doesn't close src even if src implements io.Closer. Closing the source is src owner's responsibility.

Resampling can be a very heavy task. Stream has a cache for resampling, but the size is limited. Do not expect that Stream has a resampling cache even after whole data is played.

func DecodeWithoutResampling

func DecodeWithoutResampling(src io.Reader) (*Stream, error)

DecodeWithoutResampling decodes Ogg/Vorbis data to playable stream in signed 16bit integer, little endian, 2 channels (stereo) format.

DecodeWithoutResampling returns error when decoding fails or IO error happens.

The returned Stream's Seek is available only when src is an io.Seeker.

A Stream doesn't close src even if src implements io.Closer. Closing the source is src owner's responsibility.

func (*Stream) Length

func (s *Stream) Length() int64

Length returns the size of decoded stream in bytes.

If the source is not io.Seeker, Length returns 0.

func (*Stream) Read

func (s *Stream) Read(p []byte) (int, error)

Read is implementation of io.Reader's Read.

func (*Stream) SampleRate

func (s *Stream) SampleRate() int

SampleRate returns the sample rate of the decoded stream.

func (*Stream) Seek

func (s *Stream) Seek(offset int64, whence int) (int64, error)

Seek is implementation of io.Seeker's Seek.

Note that Seek can take long since decoding is a relatively heavy task.