ODR-DabMod - Revision history

Hb9egm at 06:38, 7 April 2020

2020-04-07T06:38:10Z

Hb9egm at 08:26, 23 April 2019

2019-04-23T08:26:24Z

Andimik: /* Command line arguments */

2019-04-10T20:19:33Z

Command line arguments

Andimik: /* Prerequisites */ Boost version minimum according to https://github.com/Opendigitalradio/ODR-DabMod/blob/master/INSTALL

2018-07-23T18:42:28Z

Prerequisites: Boost version minimum according to https://github.com/Opendigitalradio/ODR-DabMod/blob/master/INSTALL

Andimik: /* Description */ wrong link

2018-07-23T18:26:20Z

Description: wrong link

Hb9egm: /* Building odr-dabmod */

2017-02-07T09:14:06Z

Building odr-dabmod

Hb9egm at 09:12, 7 February 2017

2017-02-07T09:12:54Z

Hb9egm: compilation bootstrap.sh

2014-08-20T11:32:06Z

compilation bootstrap.sh

Hb9egm at 18:29, 9 July 2014

2014-07-09T18:29:08Z

Coinchon: /* Additional information concerning the options */

2014-06-18T13:28:20Z

Additional information concerning the options

@@ Line 12: / Line 12: @@
 ==Description==
-ODR-DabMod takes an [[Ensemble Transport Interface]] (ETI) stream as input and outputs a complex baseband stream of interlaced I/Q samples with a default sampling frequency of 2.048MHz. It can also directly drive SDR devices through Ettus' UHD driver and [https://github.com/pothosware/SoapySDR/wiki SoapySDR].
+ODR-DabMod takes an [[Ensemble Transport Interface]] (ETI) stream as input and outputs a complex baseband stream of interlaced I/Q samples with a default sampling frequency of 2.048MHz. It can also directly drive SDR devices through Ettus' UHD driver, [https://github.com/pothosware/SoapySDR/wiki SoapySDR] and LimeSuite.
 Some devices require resampling to another sampling rate, which increases CPU requirements and can be done internally by ODR-DabMod.
@@ Line 36: / Line 36: @@
 Build and install according to the instructions in the README.
-test with:
 to update to latest upstream:
@@ Line 45: / Line 44: @@
 ==Usage==
-There are two ways of using ODR-DabMod: through command line arguments or with a configuration file:
+There are two ways of using ODR-DabMod: with a configuration file, and a smaller set of features is available through command line arguments. Use the -h option to see all options:
-===Command line arguments===
+ odr-dabmod -h
-Example with command-line interface:
+For the configuration file, start with the example configuration inside the doc folder: [https://github.com/Opendigitalradio/ODR-DabMod/blob/master/doc/example.ini doc/example.ini]
-This modulates the racor.eti file, performs OFDM modulation on baseband at a sampling frequency of 3.2Msamples/sec. Output is sent to the standard output. It can be redirected into a file, or piped into a baseband player ([[CRC-Dwap.py]]).
+This example file describes and explains all supported settings.
-When using a USRP, the integrated UHD output can be used. This requires the definition and usage of a configuration file.
+Several settings can be modified while the modulator is running by enabling the '''remotecontrol''', see [https://github.com/Opendigitalradio/ODR-DabMod/blob/master/doc/README-RC.md doc/README-RC.md] for more details.
-===Configuration file===
+Once you have defined a configuration file (let's call it modulator.ini), you can call:
-'''firfilter''' enables the filter that was previously done in the baseband player. It reduces out of band energy, and will increase signal quality, and reduce energy waste in the mask filter. The filter taps can be generated with the helper script in doc/fir-filter
+ odr-dabmod modulator.ini
-For each possible output, there is a section: '''outputuhd''' and '''outputfile'''. '''outputfile''' only defines the filename. '''outputuhd''' is more interesting: it defines the device flags, the TX frequency, the PGA gain, and what clocking source you want to use. In case of refclk loss, it is possible to make the modulator crash so as to avoid transmitting a corrupt signal, maybe even on the wrong frequency.
+See also [[DAB hardware]]
 ==Additional information concerning the options==
@@ Line 82: / Line 66: @@
 This filter is used on the FPGA for up-sampling to 128MHz.
 This pre-correction filter is only enabled when the -c option is used.
-You should use -c128000000 for regular USRP1 only.
+You should use -c128000000 for the old USRP1 device only.
 -g, or '''gainmode''': Gain computation mode

@@ Line 1: / Line 1: @@
 ==About ODR-DabMod==
 ODR-DabMod is the DAB OFDM modulator initially developed by Communication Research Center (CRC) from Canada, and subsequently forked
-by opendigitalradio.
+by Opendigitalradio.
 CRC have stopped releasing new versions.
-The development is now pursued by opendigitalradio on [http://github.com/Opendigitalradio GitHub] with releases available ad interim on http://mpb.li
+The development is now pursued by opendigitalradio on [http://github.com/Opendigitalradio GitHub] with releases available as git tags. The git master branch always points to the latest release, the next branch is where development happens.
 The main communication channel is the [https://groups.google.com/forum/#!forum/crc-mmbtools CRC-mmbTools Google Group mailing list]
-Original CRC version [[http://web.archive.org/web/20131031110313/http://mmbtools.crc.ca/content/view/44/71/ CRC-DabMod description and source code] archived on the MMBTools website
+Original CRC version [http://web.archive.org/web/20131031110313/http://mmbtools.crc.ca/content/view/44/71/ CRC-DabMod description and source code] archived on the MMBTools website
 ==Description==
-ODR-DabMod takes an [[Ensemble Transport Interface]] (ETI) stream as input and outputs a complex baseband stream of interlaced 16 bits I/Q samples with a default sampling frequency of 2.048MHz. It can also directly communicate to the Ettus USRPs using the UHD driver.
+ODR-DabMod takes an [[Ensemble Transport Interface]] (ETI) stream as input and outputs a complex baseband stream of interlaced I/Q samples with a default sampling frequency of 2.048MHz. It can also directly drive SDR devices through Ettus' UHD driver and [https://github.com/pothosware/SoapySDR/wiki SoapySDR].
-The USRP1 will require resampling to 3.2Msps, which will requires high CPU usage but cannot be avoided. Newer USRPs have a more flexible clocking system.
+Some devices require resampling to another sampling rate, which increases CPU requirements and can be done internally by ODR-DabMod.
 ==Build information==
@@ Line 24: / Line 24: @@
 You will need boost at least version 1.54. The one from your distribution is probably fine, and if you have installed GNURadio or UHD, you will already have it.
-You need uhd, don't forget to also install the -dev package from your distribution.
+You need uhd and/or soapy (including drivers for your SDR device), don't forget to also install the -dev package from your distribution.
-If you want to use the zeromq inputs or outputs, you need a recent (4.0.4 or later) version of [http://zeromq.org/ ZeroMQ], preferably installed from your distribution's repository.
+You need a recent (4.0.4 or later) version of [http://zeromq.org/ ZeroMQ], preferably installed from your distribution's repository. Also don't forget the -dev package.
 ===Building odr-dabmod===

@@ Line 50: / Line 50: @@
 Example with command-line interface:
-  ord-dabmod ./racor.eti -l -g1 -r3200000
+  odr-dabmod ./racor.eti -l -g1 -r3200000
 This modulates the racor.eti file, performs OFDM modulation on baseband at a sampling frequency of 3.2Msamples/sec. Output is sent to the standard output. It can be redirected into a file, or piped into a baseband player ([[CRC-Dwap.py]]).

@@ Line 22: / Line 22: @@
 ===Prerequisites===
-You will need boost at least version 1.42. The one from your distribution is probably fine, and if you have installed GNURadio or UHD, you will already have it.
+You will need boost at least version 1.54. The one from your distribution is probably fine, and if you have installed GNURadio or UHD, you will already have it.
 You need uhd, don't forget to also install the -dev package from your distribution.

@@ Line 12: / Line 12: @@
 ==Description==
-ODR-DabMod takes an [[Ensemble Transport Interface ETI]] stream as input and outputs a complex baseband stream of interlaced 16 bits I/Q samples with a default sampling frequency of 2.048MHz. It can also directly communicate to the Ettus USRPs using the UHD driver.
+ODR-DabMod takes an [[Ensemble Transport Interface]] (ETI) stream as input and outputs a complex baseband stream of interlaced 16 bits I/Q samples with a default sampling frequency of 2.048MHz. It can also directly communicate to the Ettus USRPs using the UHD driver.
 The USRP1 will require resampling to 3.2Msps, which will requires high CPU usage but cannot be avoided. Newer USRPs have a more flexible clocking system.

@@ Line 33: / Line 33: @@
   git clone https://github.com/Opendigitalradio/ODR-DabMod
   cd ODR-DabMod
-When building from the source code, be careful to disable debugging, otherwise there will be lot of wasted CPU usage:
+test with:
   odr-dabmod -h
 to update to latest upstream:
   git pull
- ./bootstrap.sh
 ==Usage==

@@ Line 95: / Line 95: @@
 The gainmode option controls how ODR-Dabmod computes the OFDM symbol gain.
-mode 0 uses a fixed factor and is really not recommended. It is more
+mode 0 (FIX) uses a fixed factor and is really not recommended. It is more
 useful on an academic perspective for people trying to understand the
 DAB modulation.
-mode 1 is the normalization of every OFDM symbol.
+mode 1 (MAX) is the normalization of every OFDM symbol.
 No overshoot, no truncating, but varying output power (around
 dB) which might not be the best for some power amplifier.
-mode 2 uses the method specified in ETSI 300 798. This
+mode 2 (VAR) uses the method specified in ETSI 300 798. This
 method normalizes to 4 times the standard deviation for an approximation
 of the RMS power. So around 6/100000 samples will be truncated and will