README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# Beeps

A program for generating soundtracks of recurrent beeps.

## Beeps

The following beeps can be heard:

* Pairs of recurring beeps every 15 seconds. A high pitch beep immediately
  followed by a low pitch beep marks the transition to a 15 second period filled
  with 3 second interval beeps. A low pitch beep immediately followed by a high
  pitch beep marks the transition to a 15 second period of silence.
* Beeps at 3 second intervals only heard during every other 15 second interval
  starting with the first interval.
* Double chirps at 5 minute intervals overlapping with the period transition
  beeps.
* A final set of wind-down beeps at the end of the specified duration.

This is useful if you have a task you need to repeatedly do for the duration of
15 seconds at a rate of one every 3 seconds with breaks of 15 seconds to do a
different task. For example some kind of physical exercise.

The 5 minute chirps indicate progress through the track.

The final wind-down beeps let you know when you should stop.

## Usage

Use `cargo build` or `cargo build --release` to build the program. Optionally it
can be installed system-wide using `cargo install --path .`.

Run `beeps 300` for a roughly 5 minute track (additional time required for
initial beep and wind-down beeps). The program will output an 8 bit unsigned
8kHz PCM track. This can be piped directly into a program like `aplay` or
converted into other formats.

The provided `GNUMakefile` (which depends on GNU Make and makes use of the
oggenc and lame programs) can be used to produce Ogg Vorbis or MP3 files
containing tracks of 5, 10 and 15 minute duration.

## Samples

* 5 minutes  
  [Download 5m.ogg (60KiB)][5m.ogg]  
  [Download 5m.mp3 (375KiB)][5m.mp3]
* 10 minutes  
  [Download 10m.ogg (114KiB)][10m.ogg]  
  [Download 10m.mp3 (744KiB)][10m.mp3]
* 15 minutes  
  [Download 15m.ogg (168KiB)][15m.ogg]  
  [Download 15m.mp3 (1.1MiB)][15m.mp3]

[5m.ogg]: https://the-tk.com/files/beeps/5m.ogg
[5m.mp3]: https://the-tk.com/files/beeps/5m.mp3
[10m.ogg]: https://the-tk.com/files/beeps/10m.ogg
[10m.mp3]: https://the-tk.com/files/beeps/10m.mp3
[15m.ogg]: https://the-tk.com/files/beeps/15m.ogg
[15m.mp3]: https://the-tk.com/files/beeps/15m.mp3