-[Which Audio Interface / Soundcard is compatible with Aura?](#which-audio-interface--soundcard-is-compatible-with-aura)
-[ALSA Settings](#alsa-settings)
-[ALSA Settings](#alsa-settings)
-[In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?](#in-the-liquidsoap-logs-i-get-error-when-starting-output-output_lineout_0-failureerror-while-setting-open_pcm-device-or-resource-busy-what-does-it-mean)
-[In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?](#in-the-liquidsoap-logs-i-get-error-when-starting-output-output_lineout_0-failureerror-while-setting-open_pcm-device-or-resource-busy-what-does-it-mean)
-[How can I find the audio device IDs, required for settings in engine.ini?](#how-can-i-find-the-audio-device-ids-required-for-settings-in-engineini)
-[How can I find the audio device IDs, required for settings in engine.ini?](#how-can-i-find-the-audio-device-ids-required-for-settings-in-engineini)
...
@@ -47,111 +29,41 @@ specifically build for the requirements of community radios.
...
@@ -47,111 +29,41 @@ specifically build for the requirements of community radios.
## Features
## Features
### Play tracks from multiple sources
- Play audio from multiple sources
- Dynamic switching of sources
It's possible to air playlists with music or recordings stored on the **filessystem**,
- Record output to filesystem
via external **streams** or live from a **studio**.
- Stream output to an Icecast Server
- Multichannel Line-out
### Blank Detenction / Silence Detecter
- Blank Detenction / Silence Detecter
- Auto Pilot a.k.a. Fallback Handling
The engine offers a simple way to detect scenarios where no music is on air.
It possible to configure the sensitivity of the Silence Detector and automatically
transition play-out to a Fallback Playlist (see Auto Pilot).
### Auto Pilot
In case there is no schedule delivered by Steering, engine provides multiple
fallback handling scenarios. The available fallbacks are evaluated in following order:
1.**Timeslot Fallback**: //TODO explain
2.**Show Fallback**: //TODO explain
3.**Station Fallback**: //TODO explain
### Dynamically switching of source channels
TODO extend: * switch the soundserver at the correct time to a given source for a specific show
### Multiple Recorders
TODO extend: * record what is broadcasted
### Stream to an Icecast Server
TODO extend: * stream to an icecast server
### Multichannel Line-out
TODO extend: * play to line-out
Read more on the [Engine Features](docs/engine-features.md) page.
## Architecture
## Architecture
AURA Engine as part of the AURA Radio Suite uses an modulear architecture
AURA Engine as part of the AURA Radio Suite uses an modulear architecture
based on a REST API. All external information is retrieved using JSON data-structures.
based on a REST API. All external information is retrieved using JSON data-structures.
#### Required Data Sources
To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or visit
the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository.
The AURA Project "**Dashboard**" provides the GUI to organize shows, schedules/timelsots
and organize uploads in form of playlists. Those playlists can be organized in timeslots
using a fancy calendar interface.
These data-sources need to be configurated in the "engine.ini" configuration file:
@@ -203,7 +115,7 @@ CREATE USER 'aura'@'localhost' IDENTIFIED BY 'secure-password';
...
@@ -203,7 +115,7 @@ CREATE USER 'aura'@'localhost' IDENTIFIED BY 'secure-password';
GRANT ALL PRIVILEGES ON aura_engine.* TO 'aura'@'localhost';
GRANT ALL PRIVILEGES ON aura_engine.* TO 'aura'@'localhost';
```
```
#### Alternative Sound Servers
### Alternative Sound Servers
Beside ALSA the sound servers **Jack Audio** and **Pulse Audio** are supported.
Beside ALSA the sound servers **Jack Audio** and **Pulse Audio** are supported.
...
@@ -229,7 +141,7 @@ sudo apt install \
...
@@ -229,7 +141,7 @@ sudo apt install \
```
```
#### Configuration
### Configuration
Run
Run
...
@@ -244,31 +156,7 @@ After that, you have to edit the settings in */etc/aura/engine.ini*. Ensure to t
...
@@ -244,31 +156,7 @@ After that, you have to edit the settings in */etc/aura/engine.ini*. Ensure to t
## Running the Engine ###
### Hardware
#### Soundcard
#### Hard/Soft
When you use ALSA, you will have to play around with ALSA settings. In the folder ./modules/liquidsoap is a scipt called alsa_settings_tester.liq. You can start it with 'liquidsoap -v --debug alsa_settings_tester.liq'. Changing and playing with settings may help you to find correct ALSA settings.
#### Line In
You can configure up to **five** line ins. Your hardware should support that. When you use JACK, you will see the additional elements popping up when viewing your connections (with e.g. Patchage).
#### Recordings
You can configure up to **five** recorders. You find the settings in the main config file engine.ini. You can choose between different output formats.
#### Streams
You can configure up to **five** streams. You find the settings in the engine.ini. You can choose between different streaming formats.
### Running the Engine ###
To start the AuRa Engine execute:
To start the AuRa Engine execute:
...
@@ -282,7 +170,7 @@ and on system boot run following:
...
@@ -282,7 +170,7 @@ and on system boot run following:
The first service starts the LiquidSoap Engine, while the latter boots the actual AuRa Engine.
The first service starts the LiquidSoap Engine, while the latter boots the actual AuRa Engine.
### Logging
## Logging
You can access the service logs using:
You can access the service logs using:
...
@@ -294,29 +182,18 @@ and
...
@@ -294,29 +182,18 @@ and
respectively.
respectively.
## Frequently Asked Questions
### Which Audio Interface / Soundcard is compatible with Aura?
## Development
Basically any audio device which is supported by Linux Debian/Ubuntu and has ALSA drivers.
Engine has been tested with following audio interfaces:
To run the LiquidSoap code during develpment execute:
./run.sh
### Components ###
**aura.py**: It is the server which is connected to the external programme source (e.g. aura steering and tank), to liquidsoap and is listening for redis pubsub messages. This precious little server is telling liquidsoap what to play and when.
**Guru**: The commandline tool for interacting with the server. Also provides the communication from Liquidsoap to the Python (Command-)Server.
**Liquidsoap**: The heart of AuRa Engine. It uses the built in mixer, to switch between different sources. It records everything and streams everything depending on your settings in aura.ini.
More information you can find here: <https://gitlab.servus.at/autoradio/meta/blob/master/api-definition.md>
## Provided API Endpoints
**Soundserverstate:** Returns true and false values of the internal In- and Outputs
/api/v1/soundserver_state
**Trackservice:**
/api/v1/trackservice/<selected_date>
/api/v1/trackservice/
## Components
**aura.py**: It is the server which is connected to the external programme source (e.g. aura steering and tank), to liquidsoap and is listening for redis pubsub messages. This precious little server is telling liquidsoap what to play and when.
**Guru**: The commandline tool for interacting with the server. Also provides the communication from Liquidsoap to the Python (Command-)Server.
**Liquidsoap**: The heart of AuRa Engine. It uses the built in mixer, to switch between different sources. It records everything and streams everything depending on your settings in aura.ini.
## Running the Engine
Aura Engine is consisting of two components: The Python Engine and Liquidsoap Core.
It's important to start both components in the correct order:
