1 # amused
2 
3 amused is a music player.  It doesn't have any amazing functionalities
4 built-in, on the contrary: it's quite minimal (a fancy word to say
5 that does very little.)  It composes well, or aims to do so, with
6 other tools, find(1) in particular.
7 
8 The main feature is that audio decoding runs in a sandboxed process
9 under `pledge("stdio recvfd audio")`.  Oh, by the way, amused targets
10 OpenBSD only: it relies its make infrastructure to build, uses
11 various cool stuff from its libc and can output only to sndio.
12 
13 (I *think* it's possible to compile it on other UNIX-like systems
14 too by providing shims for some non-portable functions -- hello
15 libbsd -- and assuming that sndio is available.  Oh, and that you
16 bundle a copy of imsg.c too)
17 
18 
19 ## building
20 
21 	$ make
22 
23 it needs the following packages from ports:
24 
25  - flac
26  - libmad
27  - libvorbis
28  - opusfile
29 
30 Release tarballs installs into `/usr/local/`, git checkouts installs
31 into `~/bin` (idea and implementation stolen from got, thanks stsp!)
32 
33 
34 ## usage
35 
36 The fine man page has all nitty gritty details, but the TL;DR is
37 
38  - enqueue music with `amused add files...`
39  - control the playback with `amused play|pause|toggle|stop` etc
40 
41 Pro tip: amused plays well with find:
42 
43 	find . -type f -iname \*.opus -exec amused add {} +
44 
45 Well, for these kinds of things I wrote a wrapper around find called
46 walk that's very handy in combo with amused too!
47 
48 	walk \*.opus ! amused add
49 
50 (walk lives in my [dotfiles](//git.omarpolo.com/dotsnew))