aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md43
-rw-r--r--doc/example.mux3
-rw-r--r--doc/remote_control.txt4
3 files changed, 46 insertions, 4 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..b35d77d
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,43 @@
+Description
+===========
+ODR-DabMux is a software multiplexer that generates an ETI stream from audio
+and data streams. Because of its software based architecture, many typical DAB
+services can be generated and multiplexed on a single PC platform with live or
+pre-recorded sources.
+
+A DAB multiplex configuration is composed of one ensemble. An ensemble is the
+entity that receivers tune to and process. An ensemble contains several
+services. A service is the listener-selectable output. Each service contains
+one mandatory service component which is called primary component. An audio
+primary component define a program service while a data primary component
+define a data service. Service can contain additional components which are
+called secondary components. Maximum total number of components is 12 for
+program services and 11 for data services. A service component is a link to one
+subchannel (or Fast Information Data Channel). A subchannel is the physical
+space used within the common interleaved frame.
+
+ __________________________________________________
+ ENSEMBLE | ODR-Ensemble |
+ |__________________________________________________|
+ | | |
+ | | |
+ _______V______ _______V______ _______V______
+ SERVICES | ODR-Service1 | | ODR-Service2 | | ODR-Service3 |
+ |______________| |______________| |______________|
+ | | | | |______ |
+ | | | | | |
+ __V__ __V__ __V__ __V__ __V__ __V__
+ SERVICE | SC1 | | SC2 | | SC3 | | SC4 | | SC5 | | SC6 |
+ COMPONENTS |_____| |_____| |_____| |_____| |_____| |_____|
+ | | _____| | | ____|
+ | | | | | |
+ _________________ __V________V__V______________V________V___V_______
+ | MCI | SI | FIDC | | SubCh1 | SubCh9 | ... | SubCh3 | SubCh60 | ... |
+ |_____|____|______| |________|________|_______|________|_________|_____|
+ Fast Information Ch. Main Service Channel
+ COMMON INTERLEAVED FRAME
+
+Configuration
+=============
+The configuration is given in a file, please see the example in doc/example.mux
+
diff --git a/doc/example.mux b/doc/example.mux
index 1141006..4f4a2bc 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -9,9 +9,6 @@
; It consists of six mandatory sections, whose relative order in this
; file are of no importance.
-; In case of questions or ambiguities, the documentation for the
-; command-line configuration interface still mostly applies.
-
; The general section defines global multiplex parameters.
general {
; the DAB Transmission mode (values 1-4 accepted)
diff --git a/doc/remote_control.txt b/doc/remote_control.txt
index 35d0e1d..ff2fed9 100644
--- a/doc/remote_control.txt
+++ b/doc/remote_control.txt
@@ -2,7 +2,9 @@ Telnet Remote Control
=====================
ODR-DabMux can be configured to set up a simple telnet remote control that can
-be used to modify some parameters without restarting the multiplexer.
+be used to modify some parameters without restarting the multiplexer. The same
+functionality available through telnet is also available over a ZeroMQ REQ/REP
+socket, to make automation easier.
The server only listens on localhost for security reasons. Remote access should
be done using a VPN or SSH port forwarding.