beep

package module
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 21, 2023 License: BSD-2-Clause Imports: 21 Imported by: 8

README

beep

Beep is a sound utility initially developed for alerting the end of a long running command execution. Now beep can also play a MIDI file/URL or text music score with natural voices. To play demo music, run:

$ go install github.com/dbatbold/beep/cmd/beep@latest
$ ~/go/bin/beep           # play beep sound
$ ~/go/bin/beep -vd       # download natural voice files
$ ~/go/bin/beep -m demo1  # play demo music by Mozart
$ ~/go/bin/beep -m demo2  # play Passacaglia - Handel Halvorsen

Play demo #1 with piano voice  ▶
Play demo #2 with piano voice  ▶

Library Usage

package main

import (
    "bufio"
    "strings"
    "log"
    "github.com/dbatbold/beep"
)

func main() {
    music := beep.NewMusic("") // output can be a file "music.wav"
    volume := 100

    if err := beep.OpenSoundDevice("default"); err != nil {
        log.Fatal(err)
    }
    if err := beep.InitSoundDevice(); err != nil {
        log.Fatal(err)
    }
    beep.PrintSheet = true
    defer beep.CloseSoundDevice()

    musicScore := `
        VP SA8 SR9
        A9HRDE cc DScszs|DEc DQzDE[|cc DScszs|DEc DQz DE[|vv DSvcsc|DEvs ]v|cc DScszs|VN
        A3HLDE [n z,    |cHRq HLz, |[n z,    |cHRq HLz,  |sl z,    |]m   pb|z, ]m    |
        
        A9HRDE cz [c|ss DSsz]z|DEs] ps|DSsz][ z][p|DEpDQ[ [|VN
        A3HLDE [n ov|]m [n    |  pb ic|  n,   lHRq|HLnc DQ[|
    `

    reader := bufio.NewReader(strings.NewReader(musicScore))
    go music.Play(reader, volume)
    music.Wait()
    beep.FlushSoundBuffer()
}

Building from Source

On Linux:
 $ apt-get install golang libasound2-dev  # for Debian and Ubuntu
 $ apk add alsa-lib-dev                   # for Alpine linux
 $ go build ./cmd/beep
 $ cp beep /usr/local/bin/  # as root

On Windows: Requires git (git-scm.com), MinGW and Go compiler (golang.org)
 Run Git Bash,
 $ export GOPATH=$PWD/beep
 $ go get -u -v -d github.com/dbatbold/beep/cmd/beep
 $ cd beep
 $ ./build.bat
 $ cp bin/beep.exe /c/Windows/System32

Build Status

Usage

beep [options]
  -c=1: beep count
  -d="default": audio device, Linux example: hw:0,0
  -f=523.25: frequency in Hertz (1-22050)
  -h: print help
  -l: beep per line from stdin
  -m: play music from sheet file, reads stdin if no arguments given (see beep notation)
  -p=0: print demo music sheet by number (1-2)
  -t=250: beep time duration in millisecond (1-60000)
  -v=100: volume (1-100)
  -b: send bell to PC speaker
  -q: quiet stdout while playing music
  -n: print notes while playing music
  -o=file: output music waveform to a WAV file. Use '-' for stdout
  -w: start beep web server
  -a ip:port: web server address (default 127.0.0.1:4444)
  -vd [name ..]: download voice files, if no names given, downloads all voices
  -mp=file: play a MIDI file
  -mu=URL: play a MIDI file from URL
  -mn=file: parses MIDI file and print notes
  -play=notes: play notes from command argument
  -battery: monitor battery and alert low charge level

Beep notation

To play music with beep, music score needs to be converted into text. Beep uses its own music notation called beep notation. All music octaves are divided into computer keyboard keys similar to piano key layout. All 88 piano notes can be played as following.

$ beep -play 'H0,l.HLq2w3er5t6y7ui9o0p[=]azsxcfvgbnjmk,l.HRq2w3er5t6y7ui9o0p[=]azsxcfvgbnjmk,l.H7q2w3er5t6y7ui'

Play all piano notes   ▶

Uppercase "H" letter is a control key that changes the current octave. Lowercase letters are notes. Using all control keys shown below are used to convert musical notation.

Piano key map:
  | | | | | | | | | | | | | | | | | | | | | | 
  |2|3| |5|6|7| |9|0| |=|a|s| |f|g| |j|k|l| |
 | | | | | | | | | | | | | | | | | | | | | | 
 |q|w|e|r|t|y|u|i|o|p|[|]|z|x|c|v|b|n|m|,|.|

 q - middle C (261.6 hertz)

 Left and right hand keys are same. Uppercase 
 letters are control keys. Lowercase letters
 are music notes. Space bar is current duration
 rest. Spaces after first space are ignored.
 Lines start with '#' are ignored.

Control keys:

 Rest:
 RW     - whole rest
 RH     - half rest
 RQ     - quarter rest
 RE     - eighth rest
 RS     - sixteenth rest
 RT     - thirty-second rest
 RI     - sixty-fourth rest

 Durations:
 DW     - whole note
 DH     - half note
 DQ     - quarter note
 DE     - eighth note
 DS     - sixteenth note
 DT     - thirty-second note
 DI     - sixty-fourth note
 DD     - dotted note (adds half duration)

 Octave:
 H0     - octave 0 keys
 HL     - octave 1, 2, 3 (left hand keys)
 HR     - octave 4, 5, 6 (right hand keys)
 H7     - octave 7, 8 keys

 Tempo:
 T#     - where # is 0-9, default is 4 (1 unit speeds up/down by 4%)

 Sustain:
 SA#    - attack level, where # is 0-9, default is 8
 SD#    - decay level, 0-9, default 4
 SS#    - sustain level, 0-9, default 4
 SR#    - release level, 0-9, default 9

 Voice:
 VD     - Computer generated default voice
 VP     - Piano voice
 VV     - Violin voice (WIP)
 VN     - If a line ends with 'VN', the next line will be played 
          harmony with the line.

 Chord:
 C#     - Play next # notes as a chord, where # is 2-9. 
          For example C major chord is "C3qet"

 Amplitude:
 A#     - Changes current amplitude, where # is 1-9, default is 9

 Measures:
 |      - bar, ignored
 ' '    - space, ignored
 Tab    - tab, ignored

 Comments:
 #      - a line comment
 ##     - start or end of a block comment

Demo music #1

# Mozart K33b
VP SA8 SR9
A9HRDE cc DScszs|DEc DQzDE[|cc DScszs|DEc DQz DE[|vv DSvcsc|DEvs ]v|cc DScszs|VN
A3HLDE [n z,    |cHRq HLz, |[n z,    |cHRq HLz,  |sl z,    |]m   pb|z, ]m    |

A9HRDE cz [c|ss DSsz]z|DEs] ps|DSsz][ z][p|DEpDQ[ [|VN
A3HLDE [n ov|]m [n    |  pb ic|  n,   lHRq|HLnc DQ[|

A9HRDE cc DScszs|DEc DQzDE[|cc DScszs|DEc DQz DE[|vv DSvcsc|DEvs ]v|cc DScszs|VN
A3HLDE [n z,    |cHRq HLz, |[n z,    |cHRq HLz,  |sl z,    |]m   pb|z, ]m    |

A9HRDE cz [c|ss DSsz]z|DEs] ps|DSsz][ z][p|DEpDQ[ [|VN
A3HLDE [n ov|]m [n    |  pb ic|  n,   lHRq|HLnc DQ[|

A9HRDS DERE] DS][p[ |][p[ ][p[  |DE] DQp DEi|REc DScszs|cszs |cszs|DEcDQzDE[|REv DSvcsc|DEvs ]v|VN
A3HLDE DEcHRq HLvHRw|HLbHRe HLvw|cHRq   HLic|[n  ]m    |z,   |]m  |zn   z,  |sl  [,    |z. DQp |

A9HRDE REc DScszs|DEcz [c|REs DSsz]z|DEs] ps|DSsz][ z][p|DE[DSitDQr|VN
A3HLDE z,  ]m    |[n   ov|]m  [n    |pb   ic|nz     sc  |DQn      [|

A9HRDS DERE] DS][p[ |][p[ ][p[  |DE] DQp DEi|REc DScszs|cszs |cszs|DEcDQzDE[|REv DSvcsc|DEvs ]v|VN
A3HLDE DEcHRq HLvHRw|HLbHRe HLvw|cHRq   HLic|[n  ]m    |z,   |]m  |zn   z,  |sl  [,    |z. DQp |

A9HRDE REc DScszs|DEcz [c|REs DSsz]z|DEs] ps|DSsz][ z][p|DE[DSitDQrRQ|VN
A3HLDE z,  ]m    |[n   ov|]m  [n    |pb   ic|nz     sc  |DQn      [RQ|

Play with default voice  ▶
Play with natural piano voice  ▶
View music score

Demo music #2

# Passacaglia - Handel Halvorsen
VP T5 SA9 SD9 SS9 SR9
# DQ - 130
A6HRDE RERERERE RERERERE|RERERERE RERERERE|icxc   zc]c  |[cpc   ocic    |VN
A4HLDE z,HReq   yqeq    |HLz,HReq yqeq    |HLz,HReq yqeq|HLov,n HRwHLn,n|
# 5
A6HRDE uxzx     ]x[x        |pxox ixux    |yz]z      [zpz        |oziz uzyz    |DQz DEa= DQDDa DEz|VN
A4HLDE pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|[nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|pb  .k   HReHLk .k|
# 10
A6HRDW z          |DEcioi   pi[i|]izi   xici    |xuiu     oupu        |[u]u zuxu    |VN
A4HLDE z,HReq yqeq|HLz,HReq yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|
# 15
A6HRDE zyuy     iyoy        |py[y ]yzy    |DQz DEa= DQDDa DEz|DWz        |DEcH7qHR.H7q  HR,H7qHRmH7q|VN
A4HLDE pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|z,HReq yqeq               |
# 20   8
A6HRDE nH7qHRbH7q HRvH7qHRcH7q|HRx.,.   m.n.        |b.v. c.x.    |z,m,      n,b,        |v,c, x,z,    |VN
A4HLDE ov,n       HRwHLn,n    |pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|[nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|
# 25   8
A6HRDQ , DEkj DQDDk DE,|DW,        |DEH7qHRcvc bcnc|mc,c   .cH7qHRc|.xcx     vxbx        |VN
A4HLDE pb.k   HReHLk .k|z,HReq yqeq|HLz,HReq   yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|
# 30   8
A6HRDE nxmx ,x.x    |.zxz     czvz        |bznz mz,z    |DQ, DEkj DQDDk DE,|DW,        |VN
A4HLDE icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|
# 35
A6HRDE iici   xizi|]i[i   pioi    |uuxu     zu]u        |[upu ouiu    |yyzy     ]y[y        |VN
A4HLDE z,HReq yqeq|HLov,n HRwHLn,n|pbHRqHL, HRrHL,HRqHL,|icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|
# 40                                               # 8va---------------------------
A6HRDE pyoy iyuy    |DQy DE65 DQDD6 DEy|DWy        |DEcH7qHRx. z,]m|[npb   ovic    |VN
A4HLDE ov,n HRwHLn,n|pb.k     HReHLk .k|z,HReq yqeq|HLz,HReq   yqeq|HLov,n HRwHLn,n|
# 45   8
A6HRDE x.z,   ]m[n|pbov   icux    |yzt]     r[ep        |woqi uHL.HRyHL,|HRDQy DE65 DQDD6 DEy|VN
A4HLDE z,HReq yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|ob,n ,n,n      |pb.k       HReHLk .k|
# 50
A6HRDW y          |DEicxc   zc]c|[cpc   ocic    |uxzx     ]x[x        |pxox ixux    |VN
A4HLDE z,HReq yqeq|HLz,HReq yqeq|HLov,n HRwHLn,n|pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|
# 55
A6HRDE yz]z      [zpz        |oziz uzyz    |DQz DEa= DQDDa DEz|DWz        |DEcioi   pi[i|VN
A4HLDE [nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|HLz,HReq yqeq|
# 60
A6HRDE ]izi xici    |xuiu     oupu        |[u]u zuxu    |zyuy     iyoy        |py[y ]yzy    |VN
A4HLDE ov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|
# 65
A6HRDQ z DEa= DQDDa DEz  |DWz        |DEicxc zc]c|[cpc ocic|uxzx  ]x[x|VN
A4HLDE pb  .k   HReHLk .k|z,HReq yqeq|HLDWC2,z   |C2vo     |C2m]      |
# 70
T3
A6HRDE pxox ixux|yz]z [zpz|oziz uzyz|DQz DEa= DQDDa DEz|DWz |VN
A4HLDW C2ci     |C2n[     |C2vo     |C2bp              |C2,z|

Play with default voice  ▶
Play with natural piano voice  ▶
View music score

Natural Voices

Beep uses computer generated voices if no voice files exist. A voice file is a ZIP file that contains sound samples of all notes that the music instrument can play. By downloading and placing voice files in specific locations can improve music sound quality.

To download voice files, run:

$ beep -vd  # downloads all voice files
$ beep -vd piano # piano only
$ beep -vd piano violin # piano and voice files

Voice files can also be downloaded manually. Move the files to location below after downloading:

Voice files:
Piano voice: piano.zip (13MB)
Violin voice: violin.zip (6.9MB)

Voice file location:
Windows: C:\Users\{username}\_beep\voices\
Linux: /home/{username}/.beep/voices/

Web Interface

Playing a music sheet from command line can be slow to start, because voice files are loaded at startup for every time running beep. Beep has a built-in web server for playing and storing music sheets. The web server loads voice files only once and uses them for all playback. To start the web interface, run:

Linux:

$ beep -w

Windows:

C:\>beep -w

then open your browser and navigate to http://localhost:4444. If the web interface needs to be accessible from other computers, run:

$ beep -w :4444
or
$ beep -w -a 0.0.0.0:4444  # for public access

Screenshot:
alt tag

Usage Examples

 $ cp -vr directory target; beep
 $ ffmpeg -i video.mp4 -vn -acodec libmp3lame sound.mp3; beep -t 3000
 
 # use '&' symbol instead of ';' on Windows
 C:\>dir /s \windows\*.cpl & beep
 
 # alarm for download completion
 $ curl -O http://host.com/bigfile.tgz; beep -c 4 -f 1000
 
 # monitor battery and alarm low level
 $ beep -battery
 
 # beep for every text file found under home
 $ find ~ -name '*.txt' | beep -l
 
 # set an alarm for 1 hour from now
 $ sh -c 'sleep 3600; beep -t 300 -c 6' &
 
 # play all piano notes
 $ echo "DEH0,l.\
         HLq2w3er5t6y7ui9o0p[=]azsxcfvgbnjmk,l.\
         HRq2w3er5t6y7ui9o0p[=]azsxcfvgbnjmk,l.\
         H7q2w3er5t6y7ui" | beep -m
 
 # play demo music by Mozart
 $ beep -m demo
 C:\>beep -m demo

 # start beep web server and serve pages locally
 $ beep -w
 C:\>beep -w  (or click Start then Run and type: beep -w)
 
 # start beep web server with open access
 $ beep -w :4444
 
 # dump music waveform to a WAV file
 $ beep -m -o music.wav demo 
 
 # pipe to MP3 encoder
 $ beep -m -o - demo | lame - music.mp3
 
 # play misic sheet from files
 $ beep -m sheet.txt
 $ beep -m sheet1.txt sheet2.txt demo
 C:\>beep -m sheet.txt

 # play music sheet from URL
 $ beep -url 'http://bmrust.com/dl/beep/k333-1.txt'
 $ beep -url 'http://bmrust.com/dl/beep/passacaglia-handel-halvorsen.txt'

 # generate 528Hz sine wave for 60 seconds (wine glass frequency)
 $ beep -f 528 -t 60000
 
 # middle C note
 $ beep -f 261.625565 -t 1500
 
 # play a MIDI file
 $ beep -mp music.mid
 
 # play a MIDI file from URL
 $ beep -mu 'https://www.guitarist.com/media/midi/classical/bach/jesu.mid'
 
 # print notes with keyboard from MIDI file
 $ beep -mn music.mid

Documentation

Overview

Example (RestNote_tempo_0) 
buf := restNote('Q', false, 0)
fmt.Println("Temp 0:", len(buf))

Output:

Temp 0: 26132
Example (RestNote_tempo_6) 
buf := restNote('W', false, 6)
fmt.Println("Temp 6:", len(buf))

Output:

Temp 6: 82904

Index

Examples

Constants

View Source 
const (
	// MIDI events
	MidiEventTrack            = 0x00
	MidiEventMeta             = 0xFF
	MidiEventSystemExclusive1 = 0xF0
	MidiEventSystemExclusive2 = 0xF7

	// MIDI event types
	MidiEventTypeSeqNum         = 0x00
	MidiEventTypeText           = 0x01
	MidiEventTypeCopyright      = 0x02
	MidiEventTypeSeqOrTrackName = 0x03
	MidiEventTypeInstName       = 0x04
	MidiEventTypeLyricText      = 0x05
	MidiEventTypeMarkerText     = 0x06
	MidiEventTypeCuePoint       = 0x07
	MidiEventTypeChanPrefix     = 0x20
	MidiEventTypeEndOfTrack     = 0x2F
	MidiEventTypeTempo          = 0x51
	MidiEventTypeSMPTEOffset    = 0x54
	MidiEventTypeTimeSig        = 0x58
	MidiEventTypeKeySig         = 0x59
	MidiEventTypeSeqSpecEvent   = 0x7F
)
View Source 
const (
	// SampleAmp16bit - 16-bit sample amplitude
	SampleAmp16bit = 32767.0

	// SampleRate - sample rate
	SampleRate = 44100

	// SampleRate64 - float64 sample rate
	SampleRate64 = float64(SampleRate)
)
View Source 
const BeepNotation = `` /* 1846-byte string literal not displayed */

BeepNotation description

Variables

View Source 
var (
	// DemoMusic notation
	DemoMusic = BuiltinMusic[0].Notation

	// PrintSheet enables printing beep notation while playing music
	PrintSheet bool

	// PrintNotes enables printing each notes while playing music
	PrintNotes bool
)
View Source 
var BuiltinMusic = []*Sheet{
	{
		ID:   1,
		Name: "mozart-k33b-klavierstuck-in-f.txt",
		Dir:  "beep",
		URL:  "http://imslp.org/images/1/15/TN-Mozart%2C_Wofgang_Amadeus-NMA_09_27_Band_02_I_01_KV_33b.jpg",
		Notation: `# Mozart K33b
VP SA8 SR9
A9HRDE cc DScszs|DEc DQzDE[|cc DScszs|DEc DQz DE[|vv DSvcsc|DEvs ]v|cc DScszs|VN
A3HLDE [n z,    |cHRq HLz, |[n z,    |cHRq HLz,  |sl z,    |]m   pb|z, ]m    |

A9HRDE cz [c|ss DSsz]z|DEs] ps|DSsz][ z][p|DEpDQ[ [|VN
A3HLDE [n ov|]m [n    |  pb ic|  n,   lHRq|HLnc DQ[|

A9HRDE cc DScszs|DEc DQzDE[|cc DScszs|DEc DQz DE[|vv DSvcsc|DEvs ]v|cc DScszs|VN
A3HLDE [n z,    |cHRq HLz, |[n z,    |cHRq HLz,  |sl z,    |]m   pb|z, ]m    |

A9HRDE cz [c|ss DSsz]z|DEs] ps|DSsz][ z][p|DEpDQ[ [|VN
A3HLDE [n ov|]m [n    |  pb ic|  n,   lHRq|HLnc DQ[|

A9HRDS DERE] DS][p[ |][p[ ][p[  |DE] DQp DEi|REc DScszs|cszs |cszs|DEcDQzDE[|REv DSvcsc|DEvs ]v|VN
A3HLDE DEcHRq HLvHRw|HLbHRe HLvw|cHRq   HLic|[n  ]m    |z,   |]m  |zn   z,  |sl  [,    |z. DQp |

A9HRDE REc DScszs|DEcz [c|REs DSsz]z|DEs] ps|DSsz][ z][p|DE[DSitDQr|VN
A3HLDE z,  ]m    |[n   ov|]m  [n    |pb   ic|nz     sc  |DQn      [|

A9HRDS DERE] DS][p[ |][p[ ][p[  |DE] DQp DEi|REc DScszs|cszs |cszs|DEcDQzDE[|REv DSvcsc|DEvs ]v|VN
A3HLDE DEcHRq HLvHRw|HLbHRe HLvw|cHRq   HLic|[n  ]m    |z,   |]m  |zn   z,  |sl  [,    |z. DQp |

A9HRDE REc DScszs|DEcz [c|REs DSsz]z|DEs] ps|DSsz][ z][p|DE[DSitDQrRQ|VN
A3HLDE z,  ]m    |[n   ov|]m  [n    |pb   ic|nz     sc  |DQn      [RQ|
`,
	},
	{
		ID:   2,
		Name: "passacaglia-handel-halvorsen.txt",
		Dir:  "beep",
		URL:  "https://azmusicfest.org/app/uploads/Passacaglia-Handel-Halvorsen-Pianistos-2.pdf",
		Notation: `# Passacaglia - Handel Halvorsen
VP T5 SA9 SD9 SS9 SR9
# DQ - 130
A6HRDE RERERERE RERERERE|RERERERE RERERERE|icxc   zc]c  |[cpc   ocic    |VN
A4HLDE z,HReq   yqeq    |HLz,HReq yqeq    |HLz,HReq yqeq|HLov,n HRwHLn,n|
# 5
A6HRDE uxzx     ]x[x        |pxox ixux    |yz]z      [zpz        |oziz uzyz    |DQz DEa= DQDDa DEz|VN
A4HLDE pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|[nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|pb  .k   HReHLk .k|
# 10
A6HRDW z          |DEcioi   pi[i|]izi   xici    |xuiu     oupu        |[u]u zuxu    |VN
A4HLDE z,HReq yqeq|HLz,HReq yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|
# 15
A6HRDE zyuy     iyoy        |py[y ]yzy    |DQz DEa= DQDDa DEz|DWz        |DEcH7qHR.H7q  HR,H7qHRmH7q|VN
A4HLDE pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|z,HReq yqeq               |
# 20   8
A6HRDE nH7qHRbH7q HRvH7qHRcH7q|HRx.,.   m.n.        |b.v. c.x.    |z,m,      n,b,        |v,c, x,z,    |VN
A4HLDE ov,n       HRwHLn,n    |pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|[nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|
# 25   8
A6HRDQ , DEkj DQDDk DE,|DW,        |DEH7qHRcvc bcnc|mc,c   .cH7qHRc|.xcx     vxbx        |VN
A4HLDE pb.k   HReHLk .k|z,HReq yqeq|HLz,HReq   yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|
# 30   8
A6HRDE nxmx ,x.x    |.zxz     czvz        |bznz mz,z    |DQ, DEkj DQDDk DE,|DW,        |VN
A4HLDE icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|
# 35
A6HRDE iici   xizi|]i[i   pioi    |uuxu     zu]u        |[upu ouiu    |yyzy     ]y[y        |VN
A4HLDE z,HReq yqeq|HLov,n HRwHLn,n|pbHRqHL, HRrHL,HRqHL,|icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|
# 40                                               # 8va---------------------------
A6HRDE pyoy iyuy    |DQy DE65 DQDD6 DEy|DWy        |DEcH7qHRx. z,]m|[npb   ovic    |VN
A4HLDE ov,n HRwHLn,n|pb.k     HReHLk .k|z,HReq yqeq|HLz,HReq   yqeq|HLov,n HRwHLn,n|
# 45   8
A6HRDE x.z,   ]m[n|pbov   icux    |yzt]     r[ep        |woqi uHL.HRyHL,|HRDQy DE65 DQDD6 DEy|VN
A4HLDE z,HReq yqeq|HLov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|ob,n ,n,n      |pb.k       HReHLk .k|
# 50
A6HRDW y          |DEicxc   zc]c|[cpc   ocic    |uxzx     ]x[x        |pxox ixux    |VN
A4HLDE z,HReq yqeq|HLz,HReq yqeq|HLov,n HRwHLn,n|pmHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|
# 55
A6HRDE yz]z      [zpz        |oziz uzyz    |DQz DEa= DQDDa DEz|DWz        |DEcioi   pi[i|VN
A4HLDE [nmHRqHL, HRrHL,HRqHL,|ov,[ HRwHLn,n|pb  .k   HReHLk .k|z,HReq yqeq|HLz,HReq yqeq|
# 60
A6HRDE ]izi xici    |xuiu     oupu        |[u]u zuxu    |zyuy     iyoy        |py[y ]yzy    |VN
A4HLDE ov,n HRwHLn,n|]mHRwHL. HRtHL.HRwHL.|icmb HRqHLbmb|pbHRqHL, HRrHL,HRqHL,|ov,n HRwHLn,n|
# 65
A6HRDQ z DEa= DQDDa DEz  |DWz        |DEicxc zc]c|[cpc ocic|uxzx  ]x[x|VN
A4HLDE pb  .k   HReHLk .k|z,HReq yqeq|HLDWC2,z   |C2vo     |C2m]      |
# 70
T3
A6HRDE pxox ixux|yz]z [zpz|oziz uzyz|DQz DEa= DQDDa DEz|DWz |VN
A4HLDW C2ci     |C2n[     |C2vo     |C2bp              |C2,z|
`,
	},
}

BuiltinMusic stores built-in music scores

Functions

func BatteryLevel added in v1.0.2 

func BatteryLevel() (int, error)

BatteryLevel return battery charge level.

func CloseSoundDevice 

func CloseSoundDevice()

CloseSoundDevice closes sound device

func DownloadVoiceFiles 

func DownloadVoiceFiles(music *Music, writer io.Writer, names []string)

DownloadVoiceFiles downloads natural voice files

func FlushSoundBuffer 

func FlushSoundBuffer()

FlushSoundBuffer flushes sound buffer

func HertzToFreq 

func HertzToFreq(hertz float64) float64

HertzToFreq converts Hertz to frequency unit

func HomeDir 

func HomeDir() string

HomeDir returns user's home directory

func InitSoundDevice 

func InitSoundDevice() error

InitSoundDevice initialize sound device

func OpenSoundDevice 

func OpenSoundDevice(device string) error

OpenSoundDevice opens hardware sound device

func SendBell 

func SendBell()

SendBell send bell sound to console

func StartWebServer 

func StartWebServer(music *Music, address string)

StartWebServer starts beep web server

func StopPlayBack 

func StopPlayBack()

StopPlayBack stops play back

func VariableLengthValue added in v1.0.2 

func VariableLengthValue(data []byte) (value int32, byteSize int)

VariableLengthValue parses variable length value used in MIDI

Types

type Chord 

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

Chord params

func (*Chord) Reset 

func (c *Chord) Reset()

Reset chord

type Midi 

type Midi struct {
	Chunks     []*MidiChunk
	Tracks     []*MidiChunk // voice tracks
	Format     int
	Ntracks    int // number of tracks
	TickDiv    int // if 15th bit is 0 - (h.m.s.frames) resolution of a quarter note, 1 - metric (bar.beat)
	Playing    bool
	OutputFile *os.File
	OutputBuf  []int16
	// contains filtered or unexported fields
}

Midi - MIDI file

func ParseMidi 

func ParseMidi(music *Music, file io.Reader, printKeyboard bool) (*Midi, error)

ParseMidi parses MIDI file

func (*Midi) Play 

func (midi *Midi) Play()

Play all MIDI tracks at same time

type MidiChunk 

type MidiChunk struct {
	Type string
	Size int
	Data []byte
}

MidiChunk - MIDI chunk

type MidiEvent 

type MidiEvent struct {
	Type       int
	Delta      int
	Start      int
	Note       *Note // beep note
	NoteNumber byte  // MIDI note number
}

MidiEvent - MIDI event

func (*MidiEvent) CalcDuration 

func (m *MidiEvent) CalcDuration(duration int, tickDiv int)

CalcDuration calculates duration for ticks

type Music 

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

Music player

func NewMusic 

func NewMusic(output string) *Music

NewMusic returns new music for output file name, or stdout if output is empty

func (*Music) Play 

func (m *Music) Play(reader *bufio.Reader, volume100 int)

Play music score from reader

func (*Music) Playback 

func (m *Music) Playback(buf1, buf2 []int16)

Playback sends stereo wave buffer to sound device

func (*Music) Wait 

func (m *Music) Wait()

Wait until sheet is played

func (*Music) WaitLine 

func (m *Music) WaitLine()

WaitLine waits until line is played

type Note 

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

Note data

Example (Measure_tempo_3) 
note := &Note{
	key:       3000 + 'q',
	volume:    100,
	amplitude: 9,
	duration:  'W',
	dotted:    false,
	tempo:     3,
	samples:   0,
}
note.measure()
fmt.Println("Temp 3:", note.samples)

// samples in a whole note: 90112
// samples in tempo level 3: 90112 + 4% = 93716

Output:

Temp 3: 93716
Example (Measure_tempo_9) 
note := &Note{
	key:       3000 + 'q',
	volume:    100,
	amplitude: 9,
	duration:  'Q',
	dotted:    false,
	tempo:     9,
	samples:   0,
}
note.measure()
fmt.Println("Temp 9:", note.samples)

// samples in quarter note: 22528
// samples in tempo level 9: 22528 - 20% = 18023

Output:

Temp 9: 18023

type Piano 

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

Piano voice

func NewPiano 

func NewPiano() *Piano

NewPiano returns new piano voice

func (*Piano) ComputerVoice 

func (p *Piano) ComputerVoice(enable bool)

ComputerVoice enables or disables computer voice

func (*Piano) GetNote 

func (p *Piano) GetNote(note *Note, sustain *Sustain) (found bool)

GetNote prepares piano note wave buffer

func (*Piano) NaturalVoice 

func (p *Piano) NaturalVoice() bool

NaturalVoice flag

func (*Piano) NaturalVoiceFound 

func (p *Piano) NaturalVoiceFound() bool

NaturalVoiceFound flag

func (*Piano) Sustain 

func (p *Piano) Sustain() bool

Sustain flag

func (*Piano) SustainNote 

func (p *Piano) SustainNote(note *Note, sustain *Sustain)

SustainNote applies sustain settings to note

type Sheet 

type Sheet struct {
	ID       int
	Name     string
	Dir      string
	Notation string
	URL      string
	// contains filtered or unexported fields
}

Sheet - music sheet

func NewSheet 

func NewSheet(name, dir, notation, url string) *Sheet

NewSheet returns new music sheet

func (*Sheet) Delete 

func (s *Sheet) Delete() error

Delete removes music sheet file

func (*Sheet) Exists 

func (s *Sheet) Exists() bool

Exists checks existing music sheet file

func (*Sheet) Load 

func (s *Sheet) Load() error

Load reads music sheet from file

func (*Sheet) Path 

func (s *Sheet) Path() string

Path returns music sheet path

func (*Sheet) Save 

func (s *Sheet) Save() error

Save persists music sheet

type Sustain 

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

Sustain params

func (*Sustain) Ratio 

func (s *Sustain) Ratio() float64

Ratio returns sustain ratio

type Violin 

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

Violin voice

func NewViolin 

func NewViolin() *Violin

NewViolin return new violin voice

func (*Violin) ComputerVoice 

func (v *Violin) ComputerVoice(enable bool)

ComputerVoice flag

func (*Violin) GetNote 

func (v *Violin) GetNote(note *Note, sustain *Sustain) (found bool)

GetNote prepares note wave form

func (*Violin) NaturalVoice 

func (v *Violin) NaturalVoice() bool

NaturalVoice flag

func (*Violin) NaturalVoiceFound 

func (v *Violin) NaturalVoiceFound() bool

NaturalVoiceFound flag

func (*Violin) Sustain 

func (v *Violin) Sustain() bool

Sustain flag

func (*Violin) SustainNote 

func (v *Violin) SustainNote(note *Note, sustain *Sustain)

SustainNote applies sustain settings to a note

type Voice 

type Voice interface {
	GetNote(note *Note, sustain *Sustain) bool
	SustainNote(note *Note, sustain *Sustain)
	Sustain() bool
	NaturalVoice() bool
	NaturalVoiceFound() bool
	ComputerVoice(enable bool)
}

Voice interface GetNote: Gets a whole note for the key SustainNote: Used for sustaining computer generated voice Sustain: Indicates whether the instrument sustain note NaturalVoice: Indicates whether natural voice file is loaded ComputerVoice: Enable or disable computer voice

type WaveHeader 

type WaveHeader struct {
	ChunkID       string
	ChunkSize     int
	Format        string
	Subchunk1ID   string
	Subchunk1Size int
	AudioFormat   int
	NumChannels   int
	SampleRate    int
	ByteRate      int
	BlockAlign    int
	BitsPerSample int
	Subchunk2ID   string
	Subchunk2Size int
	// contains filtered or unexported fields
}

WaveHeader - WAV file header

func NewWaveHeader 

func NewWaveHeader(channels, sampleRate, bitsPerSample, dataSize int) *WaveHeader

NewWaveHeader returns new WAV header

func (*WaveHeader) ReadHeader 

func (w *WaveHeader) ReadHeader(reader io.Reader) (int, error)

ReadHeader reads WAV header

func (*WaveHeader) String 

func (w *WaveHeader) String() string

func (*WaveHeader) WriteHeader 

func (w *WaveHeader) WriteHeader(writer io.Writer) (int, error)

WriteHeader writer WAV header

type Web 

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

Web params

func NewWeb 

func NewWeb(music *Music) *Web

NewWeb returns new handler

func (*Web) ServeHTTP 

func (w *Web) ServeHTTP(res http.ResponseWriter, req *http.Request)

Source Files

View all Source files

Directories

Path Synopsis
cmd
beep
example

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.