gowave

README

gowave

Wave file read support for Go language

Install

$ go get github.com/yut-kt/gowave

Usage

import (
    "fmt"
    "os"
    
    "github.com/yut-kt/gowave"
)

func main() {
    const WaveFile = "XXX.wav"
	
    // Open File
    file, err := os.Open(WaveFile)
    if err != nil {
        panic(err)
    }

    // Initialization
    wave, err := gowave.New(file)
    if err != nil {
        panic(err)
    }
    
    // Read 100000 Samples
    samples, err := wave.ReadNSamples(100000)
    if err != nil {
        panic(err)
    }
    switch v := samples.(type) {
    case []uint8:
    case []int16:
        fmt.Println(len(v)) // 100000lengthSamples
    }
}

See gowave_examples_test.go for detailed Usage

Supported format

Format

• PCM
• IEEE float (read-only)

Number of channels

• 1(mono)
• 2(stereo)

Bits per sample

• 32-bit
• 24-bit
• 16-bit
• 8-bit

Reference wave format

• en
  • http://soundfile.sapp.org/doc/WaveFormat/
• ja
  • http://www.graffiti.jp/pc/p030506a.htm

License

gowave is released under the MIT License.

Documentation

Overview

Package gowave provides support for reading WAV files.

Example

package main

import (
	"fmt"
	"os"

	"github.com/yut-kt/gowave"
)

const WaveFile = "internal/samples/waves/X.wav"

func main() {
	var a, b, c, d, e, x, y int

	file, err := os.Open(WaveFile)
	if err != nil {
		panic(err)
	}

	// Initialization
	wave, err := gowave.New(file)
	if err != nil {
		panic(err)
	}

	// Read 100000 Samples
	samples, err := wave.ReadNSamples(10000)
	if err != nil {
		panic(err)
	}
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		a = len(v)
		fmt.Println("a:", a)
	}

	// Read 1000 Samples
	samples, err = wave.ReadNSamples(5000)
	if err != nil {
		panic(err)
	}
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		b = len(v)
		fmt.Println("b:", b)
	}

	// Returns the stock of Samples read so far
	samples = wave.GetSamplesAlreadyRead()
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		x = len(v)
		fmt.Println("x:", x)
	}

	fmt.Println("a+b == x:", a+b == x)

	// If the number of readable samples is exceeded,
	// the Samples up to EOF are returned instead of the specified Samples
	samples, err = wave.ReadNSamples(1000000000)
	if err != nil {
		panic(err)
	}
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		c = len(v)
		fmt.Println("c:", c)
	}

	// Returns [] if there is no Readable sample
	samples, err = wave.ReadSamples()
	if err != nil {
		panic(err)
	}
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		d = len(v)
		fmt.Println("d:", d)
	}

	// Returns [] if there is no Readable sample
	samples, err = wave.ReadNSamples(1)
	if err != nil {
		panic(err)
	}
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		e = len(v)
		fmt.Println("e:", e)
	}

	samples = wave.GetSamplesAlreadyRead()
	switch v := samples.(type) {
	case []uint8:
	case []int16:
		y = len(v)
		fmt.Println("y:", y)
	}

	fmt.Println("a+b+c+d+e == y:", a+b+c+d+e == y)
}

Output:

a: 10000
b: 5000
x: 15000
a+b == x: true
c: 1000
d: 0
e: 0
y: 16000
a+b+c+d+e == y: true

Index

• type Wave
  • func New(file io.ReadSeeker) (*Wave, error)
  • func (wave *Wave) GetNumChannels() uint16
  • func (wave *Wave) GetSampleRate() uint32
  • func (wave *Wave) GetSamplesAlreadyRead() interface{}
  • func (wave *Wave) ReadNSamples(samplingNum int64) (interface{}, error)
  • func (wave *Wave) ReadSamples() (interface{}, error)

Examples

• Package
• Wave.GetSamplesAlreadyRead

Types

type Wave

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

Wave is a structure that handles wav files.

func New

func New(file io.ReadSeeker) (*Wave, error)

New is a function to construct Wave struct.

func (*Wave) GetNumChannels

func (wave *Wave) GetNumChannels() uint16

GetNumChannels is a function to get num channels.

func (*Wave) GetSampleRate

func (wave *Wave) GetSampleRate() uint32

GetSampleRate is a function to get sample rate.

func (*Wave) GetSamplesAlreadyRead

func (wave *Wave) GetSamplesAlreadyRead() interface{}

GetSamplesAlreadyRead is a function to get already read samples wave data.

Example

package main

import (
	"fmt"
	"os"
	"reflect"

	"github.com/yut-kt/gowave"
)

const WaveFile = "internal/samples/waves/X.wav"

func main() {
	file, err := os.Open(WaveFile)
	if err != nil {
		panic(err)
	}

	// Initialization
	wave, err := gowave.New(file)
	if err != nil {
		panic(err)
	}

	fmt.Println("a:", wave.GetSamplesAlreadyRead())

	samples, err := wave.ReadNSamples(5)
	if err != nil {
		panic(err)
	}
	fmt.Println("b:", reflect.DeepEqual(samples, wave.GetSamplesAlreadyRead()))

	_, err = wave.ReadNSamples(5)
	if err != nil {
		panic(err)
	}
	fmt.Println("c:", 10 == reflect.ValueOf(wave.GetSamplesAlreadyRead()).Len())

}

Output:

a: <nil>
b: true
c: true

func (*Wave) ReadNSamples

func (wave *Wave) ReadNSamples(samplingNum int64) (interface{}, error)

ReadNSamples is a function to read N samples wave data.

func (*Wave) ReadSamples

func (wave *Wave) ReadSamples() (interface{}, error)

ReadSamples is a function to read all samples wave data.