Blob


1 # amused
3 amused is a music player. It doesn't have any amazing features
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 though.
8 The main feature is that audio decoding runs in a sandboxed process
9 under `pledge("stdio recvfd audio")` (on OpenBSD at least.)
11 It's available on the OpenBSD port tree starting with 7.1
14 ## Building
16 The dependencies are:
18 - flac
19 - libmpg123
20 - libvorbis
21 - opusfile
22 - libsndio
24 Then, to build:
26 $ ./configure
27 $ make
28 # make install # eventually
30 The build can be customized by passing arguments to the configure
31 script or by using a `configure.local` file; see `./configure -h`
32 and [`configure.local.example`](configure.local.example) for more
33 information.
35 For each library the `configure` script first tries to see if they're
36 available without any extra flags, then tries again with some
37 hard-coded flags (e.g. `-lflac` for flac) and finally resorts to
38 pkg-config if available. pkg-config auto-detection can be disable by
39 passing `PKG_CONFIG=false` (or the empty string)
41 For Linux users with libbsd installed, the configure script can be
42 instructed to use libbsd exclusively as follows:
44 CFLAGS="$(pkg-config --cflags libbsd-overlay)" \
45 ./configure LDFLAGS="$(pkg-config --libs libbsd-overlay)"
48 ## Usage
50 The fine man page has all nitty gritty details, but the TL;DR is
52 - enqueue music with `amused add files...` or `amused load`
53 - control the playback with `amused play|pause|toggle|stop`
54 - check the status with `amused status` and the playlist with
55 `amused show`
57 amused tries to be usable in composition with other more familiar tools
58 instead of providing everything itself. For instance, there isn't a
59 command to remove an item from the playlist, or shuffle it; instead,
60 standard UNIX tools can be used:
62 $ amused show | grep -vi kobayashi | amused load
63 $ amused show | sort -R | amused load
64 $ amused show | sort | uniq | amused load
66 It also doesn't provide any means to manage a music collection. It
67 plays nice with find(1) however:
69 find . | amused load
71 I wrote a bit more about the background of amused [in a blog
72 post](https://www.omarpolo.com/post/amused.html).