diff options
| -rw-r--r-- | INSTALL.md | 64 | ||||
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | TODO.md | 25 |
3 files changed, 57 insertions, 50 deletions
@@ -1,25 +1,32 @@ +# Installation + You have 3 ways to install odr-dabmux on your host: -# Using your linux distribution packaging system -`odr-dabmux` is available on the official repositories of several debian-based distributions, such as Debian +## Using your linux distribution packaging system + +`odr-dabmux` is available on the official repositories of several debian-based distributions, such as Debian (from Debian 12), Ubuntu (from 24.10), Opensuse and Arch. -If you are using Debian 12 (Bookworm), you will need to +If you are using Debian 12 (Bookworm), you will need to [add the backports repository](https://backports.debian.org/Instructions/) **Notice**: this debian package does not include the Mux Web Management GUI -# Using installation scripts +## Using installation scripts + If your linux distribution is debian-based, you can install odr-dabmux -as well as the other main components of the mmbTools set with the +as well as the other main components of the mmbTools set with the [Opendigitalradio dab-scripts](https://github.com/opendigitalradio/dab-scripts.git) -# Compiling manually +## Compiling manually + Unlike the 2 previous options, this one allows you to compile odr-dabmux with the features you really need. -## Dependencies -### Debian Bullseye-based OS: -``` +### Dependencies + +#### Debian Bullseye-based OS + +```sh # Required packages ## C++11 compiler sudo apt-get install --yes build-essential automake libtool @@ -35,7 +42,8 @@ sudo apt-get install --yes libboost-system-dev sudo apt-get install --yes libcurl4-openssl-dev ``` -### Dependencies on other linux distributions +#### Other linux distributions + For CentOS, in addition to the packages needed to install a compiler, install the packages: boost-devel libcurl-devel zeromq-devel @@ -47,49 +55,59 @@ the [radio RaBe repository](https://github.com/radiorabe/). For openSUSE, mnhauke is maintaining packages, also built using [OBS](https://build.opensuse.org/project/show/home:mnhauke:ODR-mmbTools). -## Compilation +### Compilation + The *master* branch in the repository always points to the latest release. If you are looking for a new feature or bug-fix that did not yet make its way into a release, you can clone the *next* branch from the repository. 1. Clone this repository: - ``` + + ```sh # stable version: git clone https://github.com/Opendigitalradio/ODR-DabMux.git # or development version (at your own risk): git clone https://github.com/Opendigitalradio/ODR-DabMux.git -b next ``` + 1. Configure the project - ``` + + ```sh cd ODR-DabMux ./bootstrap ./configure ``` + 1. Compile and install: - ``` + + ```sh make sudo make install ``` Notes: + - It is advised to run the bootstrap and configure steps again every time you pull updates from the repository. - The configure script can be launched with a variety of options. Run `./configure --help` to display a complete list -# Develop on OSX and FreeBSD -If you want to develop on OSX platform install the necessary build tools -and dependencies with brew +## Develop on OSX and FreeBSD - brew install boost zeromq automake curl +If you want to develop on OSX platform install the necessary build tools and dependencies with brew + +```sh +brew install boost zeromq automake curl +``` On FreeBSD, pkg installs all dependencies to /usr/local, but the build tools will not search there by default. Set the following environment variables before calling ./configure - LDFLAGS="-L/usr/local/lib" - CFLAGS="-I/usr/local/include" - CXXFLAGS="-I/usr/local/include" +```sh +LDFLAGS="-L/usr/local/lib" +CFLAGS="-I/usr/local/include" +CXXFLAGS="-I/usr/local/include" +``` -On both systems, RAW output is not available. Note that these systems -are not tested regularly. +On both systems, RAW output is not available. Note that these systems are not tested regularly. @@ -1,5 +1,4 @@ -Overview -======== +# Overview ODR-DabMux is a *DAB (Digital Audio Broadcasting) multiplexer* compliant to ETSI EN 300 401. It is the continuation of the work started by the @@ -44,20 +43,17 @@ Up to v4.5, this repository also contained This was superseded by `digris-zmq-converter` in the [digris-edi-zmq-bridge](https://github.com/digris/digris-edi-zmq-bridge) repository. -Install -======= +## Install -See `INSTALL.md` file for installation instructions. +[Check the installation instructions.](INSTALL.md) You may find [ODR-DabMux-GUI](https://github.com/Opendigitalradio/ODR-DabMux-GUI/) for configuring a DAB Ensemble. -Licence -======= +## Licence See the files `LICENCE` and `COPYING` -Contributions and Contact -========================= +## Contributions and Contact Contributions to this tool are welcome, you can reach users and developers through the @@ -73,12 +69,10 @@ Matthias P. Braendli *matthias [at] mpb [dot] li* Pascal Charest *pascal [dot] charest [at] crc [dot] ca* -Acknowledgements -================ +## Acknowledgements David Lutton, Yoann Queret, Stefan Pöschel and Maik for bug-fix patches, Wim Nelis for the Xymon monitoring scripts, and many more for feedback and bug reports. - [http://opendigitalradio.org/](http://opendigitalradio.org/) - @@ -1,48 +1,43 @@ +# To do + This TODO file lists ideas and features for future developments. They are more or less ordered according to their benefit, but that is subjective to some degree. Unless written, no activity has been started on the topics. +## Explicit Service Linking -Explicit Service Linking ------------------------- It is impossible to activate/deactive linkage sets. Commit 5c3c6d7 added some code to transmit a FIG0/6 CEI, but this was subsequently reverted because it was not tested enough. +## Inputs for packet data -Inputs for packet data ----------------------- It is currently unclear what input formats and sources work for packet data, and which ones would make sense to add. Also, there is no documentation on the possibilites of packet data. +## Improvements for inputs -Improvements for inputs ------------------------ Add statistics to UDP input, in a similar way that ZeroMQ offers statistics. This would mean we have to move the packet buffer from the operating system into our own buffer, so that we can actually get the statistics. +## Fix DMB input -Fix DMB input -------------- The code that does interleaving and reed-solomon encoding for DMB is not used -anymore, and is untested. The relevant parts are `src/dabInputDmb*` and -`src/Dmb.cpp` +anymore, and is untested. The relevant parts are `src/dabInputDmb*` and `src/Dmb.cpp` +## Communicate Leap Seconds -Communicate Leap Seconds ------------------------- Actually, we're supposed to say in FIG0/10 when there is a UTC leap second upcoming, but since that's not trivial to find out because the POSIX time concept is totally unaware of that, this is not done. We need to know for EDI TIST, and the ClockTAI class can get the information from the Internet, but it is not used in FIG0/10. +## Implement FIG0/20 Service List -Implement FIG0/20 Service List ------------------------------- -See ETSI TS 103 176 +See [ETSI TS 103 176](https://www.etsi.org/deliver/etsi_ts/103100_103199/103176/02.01.01_60/ts_103176v020101p.pdf) |