README.md 4.44 KB
Newer Older
1

David Trattnig's avatar
David Trattnig committed
2

David Trattnig's avatar
David Trattnig committed
3
# Aura Engine
David Trattnig's avatar
David Trattnig committed
4

David Trattnig's avatar
David Trattnig committed
5
<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-engine.png" width="250" align="right" />
David Trattnig's avatar
David Trattnig committed
6

7
8
Aura Engine is a scheduling and play-out engine as part of [Aura Radio Software Suite](#About), specifically build for
the requirements of community radios.
David Trattnig's avatar
David Trattnig committed
9

David Trattnig's avatar
David Trattnig committed
10
11
<!-- TOC -->

David Trattnig's avatar
David Trattnig committed
12
13
14
15
- [Aura Engine](#aura-engine)
    - [Features](#features)
    - [Architecture](#architecture)
    - [Installation](#installation)
16
    - [Read more](#read-more)
David Trattnig's avatar
David Trattnig committed
17
18
    - [About](#about)
    - [Resources](#resources)
David Trattnig's avatar
David Trattnig committed
19
20

<!-- /TOC -->
David Trattnig's avatar
David Trattnig committed
21

David Trattnig's avatar
David Trattnig committed
22
## Features
23

David Trattnig's avatar
David Trattnig committed
24
- **Scheduler** to automatically broadcast your radio programme (see [AURA Dashboard](https://gitlab.servus.at/aura/dashboard) for an schedule user interface)
25
26
27
28
- **Play audio from multiple sources** including files, streams and analog live audio
- **Dynamic switching of sources** organized as playlists
- **Stream output** to an Icecast Server
- **Multichannel Line-out**
David Trattnig's avatar
David Trattnig committed
29
- **Silence Detector** to avoid [Dead Air](https://en.wikipedia.org/wiki/Dead_air)
30
- **Auto DJ** which plays random music when silence is detected
David Trattnig's avatar
David Trattnig committed
31
- **ReplayGain** normalization done using passed [ReplayGain](https://en.wikipedia.org/wiki/ReplayGain) meta data
32
33
34
35
- **API** to query Track-Service, monthly reports and information for displaying the Studio Clock (see [Engine API](https://gitlab.servus.at/aura/engine-api))
- **Web Application for a Track Service** (see [AURA Player](https://gitlab.servus.at/aura/player))
- **Web Application providing a Studio Clock** (see [Engine Clock](https://gitlab.servus.at/aura/engine-clock))
- **Bulk and Timeslot Recorder** (This will be provided after v1.1 by a planned `engine-recorder` component)
36

David Trattnig's avatar
David Trattnig committed
37
Read more on the [Engine Features](docs/engine-features.md) page.
38

David Trattnig's avatar
David Trattnig committed
39
## Architecture
40
41
42
43

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.

David Trattnig's avatar
David Trattnig committed
44
45
To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or visit
 the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository.
46

47
## Installation
48

49
50
- [Installation for Development](docs/installation-development.md)
- [Installation for Production](docs/installation-production.md)
51
- [Running with Docker](docs/running-docker.md)
52
- [Setup the Audio Store](docs/setup-audio-store.md)
53
54
55
56
57

## Read more

- [Developer Guide](docs/developer-guide.md)
- [Engine Features](docs/engine-features.md)
David Trattnig's avatar
David Trattnig committed
58
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
David Trattnig's avatar
David Trattnig committed
59

60

David Trattnig's avatar
David Trattnig committed
61
## About
David Trattnig's avatar
David Trattnig committed
62

63
64
Aura Engine is a scheduling and play-out engine as part of [Aura Radio Software Suite](#About), specifically build for
the requirements of community radios.
David Trattnig's avatar
David Trattnig committed
65

66
[<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-logo.png" width="150" />](https://gitlab.servus.at/aura/meta)
David Trattnig's avatar
David Trattnig committed
67

68
AURA stands for Automated Radio and is a swiss army knife for community radio stations. Beside the Engine it provides Steering (Admin Interface for the radio station), Dashboard (Collaborative scheduling and programme coordination), Tank (Audio uploading, pre-processing and delivery). Read more in the [Aura Meta](https://gitlab.servus.at/aura/meta) repository or on the specific project pages.
69

70
71
72
| [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-steering.png" width="150" align="left" />](https://gitlab.servus.at/aura/steering)  |  [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-dashboard.png" width="150" align="left" />](https://gitlab.servus.at/aura/dashboard)  |  [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-tank.png" width="150" align="left" />](https://gitlab.servus.at/aura/tank) | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-engine.png" width="150" align="left" />](https://gitlab.servus.at/aura/engine)  |
|---|---|---|---|
| [Steering](https://gitlab.servus.at/aura/steering)  | [Dashboard](https://gitlab.servus.at/aura/dashboard)  | [Tank](https://gitlab.servus.at/aura/tank)  | [Engine](https://gitlab.servus.at/aura/engine)<br/>[Engine API](https://gitlab.servus.at/aura/engine-api)<br/>[Engine Clock](https://gitlab.servus.at/aura/engine-clock)  |
73

David Trattnig's avatar
David Trattnig committed
74
## Resources
75
76

* **Python**: https://docs.python.org/
David Trattnig's avatar
David Trattnig committed
77
* **OPAM (OCaml Package Manager)**: https://opam.ocaml.org/
78
79
* **Liquidsoap**: https://www.liquidsoap.info/doc-1.4.0/
* **Jack Audio**: https://jackaudio.org/
80
* **Flask**: https://palletsprojects.com/p/flask/
81
* **Systemd**: https://systemd.io/
82
83
* **Supervisor**: http://supervisord.org/
* **Gunicorn**: https://gunicorn.org/