volume

Documentation

Index

• Variables
• type Int24
• type Matrix
  • func (m *Matrix) Accumulate(in Matrix)
  • func (m Matrix) Apply(vol Volume) Matrix
  • func (m Matrix) ApplyToMatrix(mtx Matrix) Matrix
  • func (m Matrix) AsMono() Matrix
  • func (m Matrix) AsQuad() Matrix
  • func (m Matrix) AsStereo() Matrix
  • func (m *Matrix) Assign(channels int, data []Volume)
  • func (m Matrix) Get(ch int) Volume
  • func (m Matrix) Lerp(other Matrix, t float32) Matrix
  • func (m *Matrix) Set(ch int, vol Volume)
  • func (m Matrix) Sum() Volume
  • func (m Matrix) ToChannels(channels int) Matrix
• type StaticMatrix
• type Volume
  • func (v Volume) ApplyMultiple(samp []Volume) []Volume
  • func (v Volume) ApplySingle(samp Volume) Volume
  • func (v Volume) String() string
  • func (v Volume) ToIntSample(bitsPerSample int) int32
  • func (v Volume) ToSample(bitsPerSample int) interface{}
  • func (v Volume) ToUintSample(bitsPerSample int) uint32
  • func (v Volume) WithOverflowProtection() float64

Variables

var (
	// VolumeUseInstVol tells the system to use the volume stored on the instrument
	// This is useful for trackers and other musical applications
	VolumeUseInstVol = Volume(math.Inf(-1))
)

Types

type Int24

type Int24 struct {
	Hi int8
	Lo uint16
}

Int24 is an approximation of a 24-bit integer

type Matrix

type Matrix struct {
	StaticMatrix
	Channels int
}

Matrix is an array of Volumes

func (*Matrix) Accumulate

func (m *Matrix) Accumulate(in Matrix)

func (Matrix) Apply

func (m Matrix) Apply(vol Volume) Matrix

func (Matrix) ApplyToMatrix

func (m Matrix) ApplyToMatrix(mtx Matrix) Matrix

Apply takes a volume matrix and multiplies it by incoming volumes

func (Matrix) AsMono

func (m Matrix) AsMono() Matrix

func (Matrix) AsQuad

func (m Matrix) AsQuad() Matrix

func (Matrix) AsStereo

func (m Matrix) AsStereo() Matrix

func (*Matrix) Assign

func (m *Matrix) Assign(channels int, data []Volume)

func (Matrix) Get

func (m Matrix) Get(ch int) Volume

func (Matrix) Lerp

func (m Matrix) Lerp(other Matrix, t float32) Matrix

func (*Matrix) Set

func (m *Matrix) Set(ch int, vol Volume)

func (Matrix) Sum

func (m Matrix) Sum() Volume

Sum sums all the elements of the Matrix and returns the resulting Volume

func (Matrix) ToChannels

func (m Matrix) ToChannels(channels int) Matrix

type StaticMatrix

type StaticMatrix [4]Volume

StaticMatrix is an array of Volumes

type Volume

type Volume float32

Volume is a mixable volume

func (Volume) ApplyMultiple

func (v Volume) ApplyMultiple(samp []Volume) []Volume

Apply multiplies the volume to 1 sample, then returns the results

func (Volume) ApplySingle

func (v Volume) ApplySingle(samp Volume) Volume

Apply multiplies the volume to 1 sample, then returns the results

func (Volume) String

func (v Volume) String() string

func (Volume) ToIntSample

func (v Volume) ToIntSample(bitsPerSample int) int32

ToIntSample returns a volume as an int32 value ranged to the bits per sample provided

func (Volume) ToSample

func (v Volume) ToSample(bitsPerSample int) interface{}

ToSample returns a volume as a typed value supporting the bits per sample provided

func (Volume) ToUintSample

func (v Volume) ToUintSample(bitsPerSample int) uint32

ToUintSample returns a volume as a uint32 value ranged to the bits per sample provided

func (Volume) WithOverflowProtection

func (v Volume) WithOverflowProtection() float64