Difference between revisions of "ODR-DabMod"

From OpenDigitalRadio
Jump to navigationJump to search
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==About CRC-DabMod==
+
==About ODR-DabMod==
CRC-DabMod is the DAB OFDM modulator command developed by Communication Research Center (CRC) from Canada. It is now published in open source with a gnu GPLv3 license.
+
ODR-DabMod is the DAB OFDM modulator initially developed by Communication Research Center (CRC) from Canada, and subsequently forked
CRC have stopped releasing new versions, and the development now continues on [http://github.com/mpbraendli GitHub] with releases available on http://mpb.li
+
by Opendigitalradio.
  
Original version: [http://mmbtools.crc.ca/content/view/44/71/ CRC-DabMod description and source code] on MMBTools website
+
CRC have stopped releasing new versions.
 +
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
  
 
==Description==
 
==Description==
  
CRC-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, [https://github.com/pothosware/SoapySDR/wiki SoapySDR] and LimeSuite.
  
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==
 
==Build information==
===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.
+
If you run debian, have a look at the [[Installer scripts]]
  
If you want to use the zeromq inputs or outputs, you need a recent (4.0.3 is best) version of [http://zeromq.org/ ZeroMQ]. It is probably preferred to install it from source:
+
===Prerequisites===
 
 
wget http://download.zeromq.org/zeromq-4.0.3.tar.gz
 
cd zeromq-4.0.3
 
./configure
 
make
 
sudo make install
 
  
This will install it into /usr/local
+
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.
  
===Building crc-dabmod===
+
You need uhd and/or soapy (including drivers for your SDR device), don't forget to also install the -dev package from your distribution.
  
When building from the source code, be careful to disable debugging, otherwise there will be lot of wasted CPU usage:
+
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.
./configure --with-debug-malloc=no --disable-debug --enable-fft-simd --enable-input-zeromq
 
  
If you don't have zeromq, remove the --enable-input-zeromq flag.
+
===Building odr-dabmod===
  
  make
+
First get it via the package or git repository:
  sudo make install
+
  git clone https://github.com/Opendigitalradio/ODR-DabMod
 +
  cd ODR-DabMod
  
to test:
+
Build and install according to the instructions in the README.
crc-dabmod -h
 
  
==Usage==
 
There are two ways of using CRC-DabMod: through command line arguments or with a configuration file:
 
===Command line arguments===
 
  
Example with command-line interface:
 
crc-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]]).
+
to update to latest upstream:
 +
git pull
  
When using a USRP, the integrated UHD output can be used. This requires the definition and usage of a configuration file.
+
and do the bootstrap configure make again.
  
===Configuration file===
+
==Usage==
 +
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:
  
Take the example configuration from GitHub: [https://github.com/mpbraendli/CRC-mmbtools-dabmod/blob/master/doc/example.ini example.ini]
+
odr-dabmod -h
  
The '''input''' section defines if you want to read a file or ETI over ZeroMQ. The ZeroMQ must point to a crc-dabmux ZeroMQ output.
+
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]
The '''modulator''' section sets parameters for the modulator which are described below.
 
  
'''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
+
This example file describes and explains all supported settings.
  
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.
+
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.
  
The parameter
+
Once you have defined a configuration file (let's call it modulator.ini), you can call:
device=master_clock_rate=32768000,type=b100
 
is valid for USRP B100, and the master_clock_rate allows us to avoid resampling the 2048000sps signal. It is used as UHD device parameter without modification.
 
  
The txgain can be modified while the modulator runs by enabling the '''remotecontrol'''
+
  odr-dabmod modulator.ini
 
 
Once you have defined a configuration file (let's call it modulator.ini), you can call:
 
  crc-dabmod -C modulator.ini
 
  
 +
See also [[DAB hardware]]
  
 
==Additional information concerning the options==
 
==Additional information concerning the options==
  
-c, or dac_clk_rate: Pre-correction for the CIC filter in the USRP:
+
-c, or '''dac_clk_rate''': Pre-correction for the CIC filter in the USRP:
  
 
This filter is used on the FPGA for up-sampling to 128MHz.
 
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.
 
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
+
-g, or '''gainmode''': Gain computation mode
  
The gainmode option controls how CRC-Dabmod computes the OFDM symbol gain.
+
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
 
useful on an academic perspective for people trying to understand the
 
DAB modulation.  
 
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
 
No overshoot, no truncating, but varying output power (around
 
3dB) which might not be the best for some power amplifier.  
 
3dB) 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
 
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
 
of the RMS power. So around 6/100000 samples will be truncated and will
 
introduce some really minor distortion. But this mode also maximizes the
 
introduce some really minor distortion. But this mode also maximizes the
 
output power. This is the gain mode recommended for real world operation
 
output power. This is the gain mode recommended for real world operation
as it is based on a DAB standard; the only difference is that CRC-Dabmod
+
as it is based on a DAB standard; the only difference is that ODR-Dabmod
 
uses a better resolution with 16 bits in place of 8 bits.  
 
uses a better resolution with 16 bits in place of 8 bits.  
  

Latest revision as of 07:38, 7 April 2020

About ODR-DabMod

ODR-DabMod is the DAB OFDM modulator initially developed by Communication Research Center (CRC) from Canada, and subsequently forked by Opendigitalradio.

CRC have stopped releasing new versions. The development is now pursued by opendigitalradio on 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 CRC-mmbTools Google Group mailing list

Original CRC version 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 I/Q samples with a default sampling frequency of 2.048MHz. It can also directly drive SDR devices through Ettus' UHD driver, SoapySDR and LimeSuite.

Some devices require resampling to another sampling rate, which increases CPU requirements and can be done internally by ODR-DabMod.

Build information

If you run debian, have a look at the Installer scripts

Prerequisites

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 and/or soapy (including drivers for your SDR device), don't forget to also install the -dev package from your distribution.

You need a recent (4.0.4 or later) version of ZeroMQ, preferably installed from your distribution's repository. Also don't forget the -dev package.

Building odr-dabmod

First get it via the package or git repository:

git clone https://github.com/Opendigitalradio/ODR-DabMod
cd ODR-DabMod

Build and install according to the instructions in the README.


to update to latest upstream:

git pull

and do the bootstrap configure make again.

Usage

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:

odr-dabmod -h

For the configuration file, start with the example configuration inside the doc folder: doc/example.ini

This example file describes and explains all supported settings.

Several settings can be modified while the modulator is running by enabling the remotecontrol, see doc/README-RC.md for more details.

Once you have defined a configuration file (let's call it modulator.ini), you can call:

odr-dabmod modulator.ini

See also DAB hardware

Additional information concerning the options

-c, or dac_clk_rate: Pre-correction for the CIC filter in the USRP:

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 the old USRP1 device only.

-g, or gainmode: Gain computation mode

The gainmode option controls how ODR-Dabmod computes the OFDM symbol gain.

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 (MAX) is the normalization of every OFDM symbol. No overshoot, no truncating, but varying output power (around 3dB) which might not be the best for some power amplifier.

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 introduce some really minor distortion. But this mode also maximizes the output power. This is the gain mode recommended for real world operation as it is based on a DAB standard; the only difference is that ODR-Dabmod uses a better resolution with 16 bits in place of 8 bits.

(Additional info taken from google groups discussion, originally written by Pascal Charest, CRC)