From df26d1ef3104371c8b66e0ba652547d1ae9cbe94 Mon Sep 17 00:00:00 2001 From: "Matthias P. Braendli (think)" Date: Sun, 10 Nov 2013 22:24:36 +0100 Subject: update READMEs and such, and ChangeLog for r8 --- AUTHORS | 9 +++++++++ INSTALL | 7 +++++++ README | 18 +++++++++++++++++- doc/README-Fileinput | 26 ++++++++++++++++++++++++++ src/InputFileReader.cpp | 6 +++--- 5 files changed, 62 insertions(+), 4 deletions(-) create mode 100644 doc/README-Fileinput diff --git a/AUTHORS b/AUTHORS index 5887ebc..dfefa5a 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,3 +1,12 @@ Pascal Charest for the Communications Research Centre, Ottawa, Canada, 2003-2010: All files. + +Matthias P. Braendli + - Configuration file support + - UHD output integration + - Timestamping support required for SFN + - FIR filter + - Improvements in logging (log to file, to syslog) + - ZeroMQ ETI input + - Telnet remote-control diff --git a/INSTALL b/INSTALL index 3845e91..60e8b3d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,3 +1,10 @@ +Required dependencies: +====================== + + * Boost 1.41 or later + * Optional ZeroMQ http://www.zeromq.org + Use --disable-output-zeromq if you don't have it + Simple install procedure: ========================= diff --git a/README b/README index a7e2500..95ae987 100644 --- a/README +++ b/README @@ -4,6 +4,9 @@ Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011 2012 Her Majesty the Queen in Right of Canada (Communications Research Center Canada) +Copyright (C) 2013 +Matthias P. Braendli, http://mpb.li + This file is part of CRC-DABMOD. CRC-DABMOD is free software: you can redistribute it and/or modify it @@ -21,11 +24,22 @@ with CRC-DABMOD. If not, see . OVERVIEW ======== -This is CRC-DABMOD 0.3.2 +This is CRC-DABMOD 0.3.3-mpb CRC-DABMOD is a DAB (Digital Audio Broadcasting) multiplexer compliant to ETSI EN 300 401. +This version has been modified, and contains additional features compared +to the official one: +- Configuration file support, see doc/example.ini +- Integrated UHD output for USRP devices, bypassing gnuradio +- Timestamping support required for SFN +- A FIR filter (usually done in GNURadio) +- Improvements in logging (log to file, to syslog) +- ETI sources: file (Raw, Framed and Streamed) and ZeroMQ (one frame per message) +- A Telnet remote-control that can be used to change some parameters during + runtime + The src/ directory contains the source code of CRC-DABMOD. The doc/ directory contains the CRC-DABMOD documentation. @@ -40,7 +54,9 @@ See the INSTALL file for installation instructions. CONTACT ======= Pascal Charest +Matthias P. Braendli http://mmbtools.crc.ca/ http://www.crc.ca/mmb http://openmokast.org/ +http://mpb.li/ diff --git a/doc/README-Fileinput b/doc/README-Fileinput new file mode 100644 index 0000000..f8e9ab2 --- /dev/null +++ b/doc/README-Fileinput @@ -0,0 +1,26 @@ +The file input support three file formats: + + Framed format is used for file recording. It is the default format. The + padding can be removed from data. Format: + uint32_t nbFrames + for each frame + uint16_t frameSize + uint8_t data[frameSize] + + Streamed format is used for streamed applications. As the total number of + frames is unknown before end of transmission, the corresponding field is + removed. The padding can be removed from data. Format: + for each frame + uint16_t frameSize + uint8_t data[frameSize] + + Raw format is a bit-by-bit (but byte aligned on sync) recording of a G.703 + data stream. The padding is always present. Format: + for each frame + uint8_t data[6144] + + Please note that our raw format can also be referred to as ETI(NI, G.703) or ETI(NI). + + +All numbers are little-endian. +This description has been taken from the CRC mmbTools forum. diff --git a/src/InputFileReader.cpp b/src/InputFileReader.cpp index 2514af8..2061b02 100644 --- a/src/InputFileReader.cpp +++ b/src/InputFileReader.cpp @@ -7,10 +7,10 @@ Matthias P. Braendli, matthias.braendli@mpb.li - Input module for reading the ETI data from file or pipe. + Input module for reading the ETI data from file or pipe, or ZeroMQ. - Supported formats: RAW, FRAMED, STREAMED - Supports re-sync to RAW ETI + Supported file formats: RAW, FRAMED, STREAMED + Supports re-sync to RAW ETI file */ /* This file is part of CRC-DADMOD. -- cgit v1.2.3