README.md 3.95 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
25
26
27
28
29
30
- Play audio from multiple sources
- Dynamic switching of sources
- Record output to filesystem
- Stream output to an Icecast Server
- Multichannel Line-out
- Blank Detenction / Silence Detecter
- Auto Pilot a.k.a. Fallback Handling
David Trattnig's avatar
David Trattnig committed
31
32
33
- 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 displaying the Track-Service (see [AURA Player](https://gitlab.servus.at/aura/player))
- Web Application for displaying the Studio Clock (see [Engine Clock](https://gitlab.servus.at/aura/engine-clock))
34

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

David Trattnig's avatar
David Trattnig committed
37
## Architecture
38
39
40
41

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
42
43
To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or visit
 the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository.
44

45
## Installation
46

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

## Read more

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

58

David Trattnig's avatar
David Trattnig committed
59
## About
David Trattnig's avatar
David Trattnig committed
60

61
62
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
63

64
[<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
65

66
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.
67

68
69
70
| [<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)  |
71

David Trattnig's avatar
David Trattnig committed
72
## Resources
73
74

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