Skip to content

Latest commit

 

History

History
142 lines (100 loc) · 3.79 KB

README.rst

File metadata and controls

142 lines (100 loc) · 3.79 KB
Raw

wave

gh-actions

The wave is a tiny WAV sound module. It does not support compression/decompression, but it does support mono/stereo. The wave is inspired by Python wave.

Note: The wave is not supported some sub-chunks yet. I will support sub-chunks (fact, cue, plst, list, labl, note, ltxt, smpl, inst) in the future.

Table of contents

Installation

nimble install wave

Usage

Reading example

import wave

var wav = openWaveReadFile("tests/testdata/sample1.wav")
doAssert wav.riffChunkDescriptorSize == 116
doAssert wav.numChannels == numChannelsMono
doAssert wav.sampleRate == 8000'u32
doAssert wav.byteRate == 8000'u32
doAssert wav.blockAlign == 1'u16
doAssert wav.bitsPerSample == 8'u16
doAssert wav.numFrames == 80
doAssert wav.dataSubChunkSize == 80'u16
echo wav
## Output:
## (riffChunkDescriptor: (id: "RIFF", size: 116, format: "WAVE"), formatSubChunk: (id: "fmt ", size: 16, format: 1, numChannels: 1, sampleRate: 8000, byteRate: 8000, blockAlign: 1, bitsPerSample: 8, extendedSize: 0, extended: @[]), dataSubChunk: (id: "data", size: 80, data: ...), audioStartPos: 44)

wav.close()

Writing example

Square wave

import wave

var wav = openWaveWriteFile("tests/testdata/example_square.wav")

wav.numChannels = numChannelsMono
wav.sampleRate = 8000'u16

wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])
wav.writeFrames([0xFF'u8, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00])

wav.close()

Sine wave

import wave
import math

let
  width = 127'f
  sampleRate = 44100'f
  hz = 440'f
  seconds = 3

var wav = openWaveWriteFile("tests/testdata/example_sine.wav")

wav.numChannels = numChannelsMono
wav.sampleRate = sampleRate.uint16

for _ in 0 ..< seconds:
  var buf: seq[byte]
  for i in 0 ..< sampleRate.int:
    let f = float(i)
    let b = byte(width * sin(2*PI*hz*f/sampleRate) + width)
    buf.add(b)
  wav.writeFrames(buf)

wav.close()

API document

Pull request

Welcome ❤️

LICENSE

MIT

See also

English

Japanese