aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobin ALEXANDER <colisee@hotmail.com>2022-06-09 15:26:02 +0200
committerRobin ALEXANDER <colisee@hotmail.com>2022-06-09 15:26:02 +0200
commit4a9f4671d90c7c2892e59b28c0c2be8f74312edd (patch)
treef4178c3eb59cae1e8f707fa670be038dec18f82e
parent0bb718095c271006887315ac4ee52deb8cc0b14c (diff)
downloadODR-PadEnc-4a9f4671d90c7c2892e59b28c0c2be8f74312edd.tar.gz
ODR-PadEnc-4a9f4671d90c7c2892e59b28c0c2be8f74312edd.tar.bz2
ODR-PadEnc-4a9f4671d90c7c2892e59b28c0c2be8f74312edd.zip
Add 2 additional installation options
-rw-r--r--README.md117
1 files changed, 76 insertions, 41 deletions
diff --git a/README.md b/README.md
index 35a192d..6623076 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,9 @@
-ODR-PadEnc
-==========
+# ODR-PadEnc
ODR-PadEnc is an encoder for Programme Associated Data (PAD) and includes
support for:
-* MOT Slideshow (including catSLS), according to ETSI EN 301 234 and TS 101 499
-* DLS (including DL Plus), according to ETSI EN 300 401 and TS 102 980
+- MOT Slideshow (including catSLS), according to ETSI EN 301 234 and TS 101 499
+- DLS (including DL Plus), according to ETSI EN 300 401 and TS 102 980
To encode DLS and Slideshow data, the `odr-padenc` tool reads images
from a folder and DLS text from a file, and generates the PAD data
@@ -15,27 +14,71 @@ For detailed usage, see the usage screen of the tool with the `-h` option.
More information is available on the
[Opendigitalradio wiki](http://wiki.opendigitalradio.org/ODR-PadEnc)
-How to build
-=============
-Requirements:
-
-* a C++11 compiler
-* ImageMagick MagickWand (optional, for MOT Slideshow),
- version 6 (legacy) or 7
-
-To install MagickWand on Debian or Ubuntu:
-
- sudo apt-get install libmagickwand-dev
-
-To compile and install ODR-PadEnc:
-
- ./bootstrap
- ./configure
- make
- sudo make install
-
-ImageMagick and Debian Jessie/Ubuntu 16.04
-------------------------------------------
+# Installation
+You have 3 ways to install odr-padenc on your host:
+
+## Using binary debian packages
+If your host is running a debian-based OS and its cpu is one of amd64, arm64 or arm/v7, then you can install odr-audioenc using the standard debian packaging system:
+1. Update the debian apt repository list:
+ ```
+ curl -fsSL http://debian.opendigitalradio.org/odr.asc | sudo tee /etc/apt/trusted.gpg.d/odr.asc 1>/dev/null
+
+ curl -fsSL http://debian.opendigitalradio.org/odr.list | sudo tee /etc/apt/sources.list.d/odr.list 1>/dev/null
+ ```
+1. Refresh the debian packages list:
+ ```
+ apt update
+ ```
+1. Install odr-audioenc:
+ ```
+ sudo apt install --yes odr-padenc
+ ```
+
+## Using the dab-scripts
+You can compile odr-padenc as well as the other main components of the mmbTools set with an installation script:
+1. Clone the dab-scripts repository:
+ ```
+ git clone https://github.com/opendigitalradio/dab-scripts.git
+ ```
+1. Follow the [instructions](https://github.com/Opendigitalradio/dab-scripts/tree/master/install)
+
+## Compiling manually
+Unlike the 2 previous options, this one allows you to compile odr-padenc with the features you really need.
+
+### Requirements
+For Debian Bullseye-based OS, run the following commands:
+```
+# Required packages
+## C++11 compiler
+sudo apt-get install --yes build-essential automake libtool
+
+# optional package
+## ImageMagick MagickWand (optional, for MOT Slideshow), version 6 (legacy) or 7
+sudo apt-get install libmagickwand-dev
+```
+
+### Compilation
+1. Clone this repository:
+ ```
+ # stable version:
+ git clone https://github.com/Opendigitalradio/ODR-PadEnc.git
+
+ # or development version (at your own risk):
+ git clone https://github.com/Opendigitalradio/ODR-PadEnc.git -b next
+ ```
+1. Configure the project
+ ```
+ cd ODR-PadEnc
+ ./bootstrap
+ ./configure
+ ```
+1. Compile and install:
+ ```
+ make
+ sudo make install
+ ```
+
+### ImageMagick and Debian Jessie/Ubuntu 16.04
Please note that Debian Jessie and Ubuntu 16.04 shipped a version of
ImageMagick that was affected by two memory leaks (see #2, and also
Ubuntu's [#1671630](https://bugs.launchpad.net/ubuntu/+source/imagemagick/+bug/1671630) and [#1680543](https://bugs.launchpad.net/debian/+source/imagemagick/+bug/1680543)). Hence ODR-PadEnc increasingly consumed
@@ -45,10 +88,8 @@ This has been fixed with the following package versions:
- Debian Jessie: 8:6.8.9.9-5+deb8u9
- Ubuntu 16.04: 8:6.8.9.9-7ubuntu5.7
-Usage of MOT Slideshow and DLS
-==============================
-Basic example
--------------
+# Usage of MOT Slideshow and DLS
+## Basic example
`odr-padenc` reads images from the specified folder, and generates the PAD
data for the encoder. This is communicated through a socket to the encoder. It
also reads DLS from a file, and includes this information in the PAD.
@@ -64,16 +105,14 @@ variable.
If you generate slides on-the-fly (e.g. content-related slides with album covers), set the `--erase` flag to ensure a
slide is only transmitted once, and set `--sleep=0` to start slide transmission as soon as the file is created.
-If ImageMagick is available
----------------------------
+## If ImageMagick is available
It can read all file formats supported by ImageMagick, and by default resizes
them to 320x240 pixels, and compresses them as JPEG. If the input file is already
a JPEG file of the correct size, and smaller than 50kB, it is sent without further
compression. If the input file is a PNG that satisfies the same criteria, it is
transmitted as PNG without any recompression.
-RAW Format
-----------
+## RAW Format
If ImageMagick is not compiled in, or when enabled with the `-R` option, the images
are not modified, and are transmitted as-is. Use this if you can guarantee that
the generated files are smaller than 50kB and not larger than 320x240 pixels.
@@ -81,8 +120,7 @@ Files whose name end in `_PadEncRawMode.png` or `_PadEncRawMode.jpg` will always
be transmitted in RAW mode.
It may be useful to apply [`optipng`](http://optipng.sourceforge.net) to any PNG file prior to transmission.
-Supported Encoders
-------------------
+## Supported Encoders
`odr-audioenc` and `odr-sourcecompanion` can insert the PAD data from `odr-padenc` into the bitstream.
This is an ongoing development. Only some PAD lengths are supported, please see `odr-padenc`'s help.
@@ -92,8 +130,7 @@ the tools.
ODR-PadEnc v3 replaced the fifo with a socket and is compatible with ODR-AudioEnc v3 and ODR-SourceCompanion v1.
-Character Sets
---------------
+## Character Sets
When `odr-padenc` is launched with the default character set options, it assumes
that the DLS text in the file is encoded in UTF-8, and will convert it according to
the DAB standard to the *Complete EBU Latin based repertoire* character set encoding.
@@ -108,12 +145,10 @@ case, it is your responsibility to ensure the encoding is valid. For instance,
if your data is already encoded in *Complete EBU Latin based repertoire*, you
must specify both `--charset=0` and `--raw-dls`.
-Known Limitations
-=================
+# Known Limitations
Some receivers are unable to decode slides larger than some size, even within the allowed
size limit given in the specification.
-Thanks
-======
+# Thanks
This encoder was initially called `mot-encoder` and has been contributed by
[CSP](http://rd.csp.it).