| @@ -1,10 +1,20 @@ |
| 1 | | −# scream-pulse |
| 1 | +# scream |
| 2 | 2 | |
| 3 | | −scream-pulse is a scream receiver using pulseaudio as audio output. |
| 3 | +scream is a Scream audio receiver using Pulseaudio, ALSA or stdout as audio output. |
| 4 | 4 | |
| 5 | 5 | ## Compile |
| 6 | 6 | |
| 7 | | −You need pulseaudio headers in advance. |
| 7 | +Compilation is done using CMake. |
| 8 | + |
| 9 | +If Pulseaudio or ALSA headers are found, support for those will be compiled in (see below for distro packages to install). If Pulseaudio is compiled in, it will be the default output, otherwise ALSA will be the default. If both Pulseaudio and ALSA are not compiled in, raw/stdout will be the default. |
| 10 | + |
| 11 | +```shell |
| 12 | +$ mkdir build && cd build |
| 13 | +$ cmake .. |
| 14 | +$ make |
| 15 | +``` |
| 16 | + |
| 17 | +### Pulseaudio |
| 8 | 18 | |
| 9 | 19 | ```shell |
| 10 | 20 | $ sudo yum install pulseaudio-libs-devel # Redhat, CentOS, etc. |
| @@ -12,20 +22,33 @@ or · 1 unmodified line |
| 12 | 22 | $ sudo apt-get install libpulse-dev # Debian, Ubuntu, etc. |
| 13 | 23 | ``` |
| 14 | 24 | |
| 15 | | −Run `make` command. |
| 25 | +### ALSA |
| 26 | + |
| 27 | +```shell |
| 28 | +$ sudo yum install alsa-lib-devel # Redhat, CentOS, etc. |
| 29 | +or |
| 30 | +$ sudo apt-get install libasound2-dev # Debian, Ubuntu, etc. |
| 31 | +``` |
| 16 | 32 | |
| 17 | 33 | ## Usage |
| 18 | 34 | |
| 35 | +You can see the accepted options by using the -h (help) option. |
| 36 | + |
| 37 | +```shell |
| 38 | +$ scream -h |
| 39 | +``` |
| 40 | + |
| 41 | +### Network mode |
| 42 | + |
| 19 | 43 | ```shell |
| 20 | | −$ scream-pulse |
| 44 | +$ scream |
| 21 | 45 | ``` |
| 22 | 46 | |
| 23 | | −This starts the Scream client in multicast mode. |
| 24 | | −If your machine has more than one network interface, you may need to |
| 25 | | −set the interface name which receives scream packets. |
| 47 | +This starts the Scream client in multicast mode, using the default audio output. |
| 48 | +Unicast mode is also supported, and can be used by passing the -u option. If your machine has more than one network interface, you may need to set the interface name which receives scream packets. |
| 26 | 49 | |
| 27 | 50 | ```shell |
| 28 | | −$ scream-pulse -i eth0 |
| 51 | +$ scream -i eth0 |
| 29 | 52 | ``` |
| 30 | 53 | |
| 31 | 54 | ### IVSHMEM (Shared memory) mode |
| @@ -33,5 +56,5 @@ $ scream-pulse -i eth0 · 1 unmodified line |
| 33 | 56 | Make sure to have read permission for the shared memory device and execute |
| 34 | 57 | |
| 35 | 58 | ```shell |
| 36 | | −$ scream-pulse -m /dev/shm/scream-ivshmem |
| 59 | +$ scream -m /dev/shm/scream-ivshmem |
| 37 | 60 | ``` |