• Stars
    star
    399
  • Rank 108,092 (Top 3 %)
  • Language
    Zig
  • License
    MIT License
  • Created almost 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Generate music from the entropy of Linux 🐧🎡

linuxwave 🐧🎡

demo GitHub Release Coverage Continuous Integration Continuous Deployment Docker Builds Documentation

Click here to watch the demo!
Listen to "linuxwave" on Spotify!

Table of Contents

Motivation ✨

Installation πŸ€–

Build from source

Prerequisites

Instructions

  1. Clone the repository.
git clone https://github.com/orhun/linuxwave && cd linuxwave/
  1. Update git submodules.
git submodule update --init --recursive
  1. Build.
zig build -Drelease-safe

Binary will be located at zig-out/bin/linuxwave. You can also run the binary directly via zig build run.

If you want to use linuxwave in your Zig project as a package, the API documentation is available here.

Binary releases

See the available binaries for different targets from the releases page. They are automated via Continuous Deployment workflow.

Release tarballs are signed with the following PGP key: 0xC0701E98290D90B8

Arch Linux

linuxwave can be installed from the community repository using pacman:

pacman -S linuxwave

Void Linux

linuxwave can be installed from official Void Linux package repository:

xbps-install linuxwave

Docker

Images

Docker builds are automated and images are available in the following registries:

Usage

The following command can be used to generate output.wav in the current working directory:

docker run --rm -v "$(pwd)":/app "orhunp/linuxwave:${TAG:-latest}"

Building

Custom Docker images can be built from the Dockerfile:

docker build -t linuxwave .

Examples 🎡

Default: Read random data from /dev/urandom to generate a 20-second music composition in the A4 scale and save it to output.wav:

linuxwave

Or play it directly with mpv without saving:

linuxwave -o - | mpv -

To use the A minor blues scale:

linuxwave -s 0,3,5,6,7,10 -n 220 -o blues.wav

Read from an arbitrary file and turn it into a 10-second music composition in the C major scale:

linuxwave -i build.zig -n 261.63 -d 10 -o music.wav

Read from stdin via giving - as input:

cat README.md | linuxwave -i -

Write to stdout via giving - as output:

linuxwave -o - > output.wav

Presets 🎹

Generate a calming music with a sample rate of 2000 Hz and a 32-bit little-endian signed integer format:

linuxwave -r 2000 -f S32_LE -o calm.wav

Generate a chiptune music with a sample rate of 44100 Hz, stereo (2-channel) output and 8-bit unsigned integer format:

linuxwave -r 44100 -f U8 -c 2 -o chiptune.wav

Generate a boss stage music with the volume of 65:

linuxwave -s 0,7,1 -n 60 -v 65 -o boss.wav

Generate a spooky low-fidelity music with a sample rate of 1000 Hz, 4-channel output:

linuxwave -s 0,1,5,3 -n 100 -r 1000 -v 55 -c 4 -o spooky_manor.wav

Feel free to submit a pull request to show off your preset here!

Also, see this discussion for browsing the music generated by our community.

Usage πŸ“š

Options:
  -s, --scale <SCALE>            Sets the musical scale [default: 0,2,3,5,7,8,10,12]
  -n, --note <HZ>                Sets the frequency of the note [default: 440 (A4)]
  -r, --rate <HZ>                Sets the sample rate [default: 24000]
  -c, --channels <NUM>           Sets the number of channels [default: 1]
  -f, --format <FORMAT>          Sets the sample format [default: S16_LE]
  -v, --volume <VOL>             Sets the volume (0-100) [default: 50]
  -d, --duration <SECS>          Sets the duration [default: 20]
  -i, --input <FILE>             Sets the input file [default: /dev/urandom]
  -o, --output <FILE>            Sets the output file [default: output.wav]
  -V, --version                  Display version information.
  -h, --help                     Display this help and exit.

scale

Sets the musical scale for the output. It takes a list of semitones separated by commas as its argument.

The default value is 0,2,3,5,7,8,10,12, which represents a major scale starting from C.

Here are other examples:

  • A natural minor scale: 0,2,3,5,7,8,10
  • A pentatonic scale starting from G: 7,9,10,12,14
  • A blues scale starting from D: 2,3,4,6,7,10
  • An octatonic scale starting from F#: 6,7,9,10,12,13,15,16
  • Ryukyuan (Okinawa) Japanese scale: 4,5,7,11

note

The note option sets the frequency of the note played. It takes a frequency in Hz as its argument.

The default value is 440, which represents A4. You can see the frequencies of musical notes here.

Other examples would be:

  • A3 (220 Hz)
  • C4 (261.63 Hz)
  • G4 (392 Hz)
  • A4 (440 Hz) (default)
  • E5 (659.26 Hz)

rate

Sets the sample rate for the output in Hertz (Hz).

The default value is 24000.

channels

Sets the number of audio channels in the output file. It takes an integer as its argument, representing the number of audio channels to generate. The default value is 1, indicating mono audio.

For stereo audio, set the value to 2. For multi-channel audio, specify the desired number of channels.

Note that the more audio channels you use, the larger the resulting file size will be.

format

Sets the sample format for the output file. It takes a string representation of the format as its argument.

The default value is S16_LE, which represents 16-bit little-endian signed integer.

Possible values are:

  • U8: Unsigned 8-bit.
  • S16_LE: Signed 16-bit little-endian.
  • S24_LE: Signed 24-bit little-endian.
  • S32_LE: Signed 32-bit little-endian.

volume

Sets the volume of the output file as a percentage from 0 to 100.

The default value is 50.

duration

Sets the duration of the output file in seconds. It takes a float as its argument.

The default value is 20 seconds.

input

Sets the input file for the music generation. It takes a filename as its argument.

The default value is /dev/urandom, which generates random data.

You can provide any type of file for this argument and it will generate music based on the contents of that file.

output

Sets the output file. It takes a filename as its argument.

The default value is output.wav.

Funding πŸ’–

If you find linuxwave and/or other projects on my GitHub profile useful, consider supporting me on GitHub Sponsors or becoming a patron!

Support me on GitHub Sponsors Support me on Patreon Support me on Patreon

Contributing 🌱

See our Contribution Guide and please follow the Code of Conduct in all your interactions with the project.

License βš–οΈ

Licensed under The MIT License.

Copyright ⛓️

Copyright Β© 2023, Orhun ParmaksΔ±z

More Repositories

1

git-cliff

A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
Rust
5,800
star
2

kmon

Linux Kernel Manager and Activity Monitor πŸ§πŸ’»
Rust
1,911
star
3

systeroid

A more powerful alternative to sysctl(8) with a terminal user interface 🐧
Rust
997
star
4

gpg-tui

Manage your GnuPG keys with ease! πŸ”
Rust
991
star
5

rustypaste

A minimal file upload/pastebin service.
Rust
757
star
6

halp

A CLI tool to get help with CLI tools πŸ™
Rust
597
star
7

menyoki

Screen{shot,cast} and perform ImageOps on the command line 🌱 🏞️
Rust
489
star
8

pkgtop

Interactive package manager and resource monitor designed for the GNU/Linux.
Go
268
star
9

runst

A dead simple notification daemon 🦑
Rust
234
star
10

zps

A small utility for listing and reaping zombie processes on GNU/Linux.
C
153
star
11

CoolModFiles

A web player that plays some cool MOD files randomly 🎢
JavaScript
132
star
12

kermit

A VTE-based, simple and froggy terminal emulator 🐸
C
114
star
13

rust-tui-template

A template for bootstrapping a Rust TUI application with tui-rs & crossterm
Rust
77
star
14

dotfiles

Orhun's Arch Linux configuration files and scripts 🏠
Shell
70
star
15

godsays

Rust port of the Terry Davis' (RIP) "god says" program
Rust
69
star
16

rtl_map

FFT-based visualizer for RTL-SDR devices. (RTL2832/DVB-T)
C
67
star
17

battleship-rs

Battleship game implemented in Rust
Rust
65
star
18

git-cliff-action

GitHub action to generate a changelog based on the Git history
Shell
65
star
19

rustypaste-cli

A CLI tool for rustypaste
Rust
56
star
20

k3pler

Android network connection blocker and packet analyzer built on top of local HTTP proxy.
Java
48
star
21

orhun

My GitHub profile README.md ⭐:octocat:
41
star
22

ApkServInject

Tool for injecting (smali) services to APK files
Java
30
star
23

cargo-nocode

Cargo subcommand to easily bootstrap nocode applications. Write nothing; deploy nowhere.
Rust
29
star
24

god

Linux utility for simplifying the Git usage.
Go
25
star
25

dnsleaktest-tui

A proof-of-concept TUI for testing DNS leaks & running traceroute
Rust
20
star
26

PSAUX

Android task manager and automated background service killer.
Java
20
star
27

alpkg

Set up Alpine Linux packaging environment with a breeze! πŸ”
Shell
18
star
28

packaging-rust-for-npm

https://blog.orhun.dev/packaging-rust-for-npm/
JavaScript
17
star
29

Picasso

PIC16F877A based 5V/20MHz development board and PIC programmer
C
15
star
30

PKGBUILDs

Arch Linux packages that I maintain πŸ”§
Shell
13
star
31

personal-blog

The source of my blog ✍🏼
SCSS
13
star
32

dialogflowbot

Google's Dialogflow implementation on Android with additional features.
Java
11
star
33

i3-workspace-brightness

Utility to auto-adjust the brightness of i3wm workspaces
Rust
11
star
34

Black-Waves

A wavy dark theme for VSCode
10
star
35

HydropotX

Automated and Self-contained Hydroponics System 🌱
Kotlin
9
star
36

advent-of-code

My Advent of Code solutions 🐒
Rust
8
star
37

Last-Commit

A VSCode extension that focuses on the last git commit
JavaScript
7
star
38

zig-http-benchmarks

Benchmarking Zig HTTP client against Rust, Go, Python and curl
Zig
6
star
39

binsider

Analyze ELF binaries like a boss (WIP)
Rust
4
star
40

orhun.github.io

Personal website
HTML
4
star
41

theattyr

A terminal theatre for playing VT100 art and animations
Rust
4
star
42

godsings

https://melody.godsays.xyz
Python
3
star
43

base16-kermit

Base16 for kermit
Mustache
3
star
44

parseit

A simple text file parsing library powered by regex and glob patterns
Rust
3
star
45

typewriter

Turn your keyboard into a typewriter (WIP)
Rust
2
star
46

firebox-auth-cracker

A CLI tool to brute force the authentication signature of WatchGuard's Firebox
Rust
2
star
47

playfair-rs

Playfair cipher implemented in Rust
Rust
2
star
48

rust-arch-lto

Rust + ABS + LTO = 🀯 (PoC)
Shell
1
star
49

abstractapi-rs

Rust API bindings for the Abstract HTTP API
Rust
1
star
50

rust-tui-example

A very simple TUI program to demonstrate on Rust Munich Meetup #8
Rust
1
star
51

ytpls

[experimental] YouTube Playlist Synchronizer backed by yt-dl & git
Rust
1
star