# Copyright 2012-2014 Clayton Smith
#
# This file is part of gr-dsd
#
# gr-dsd is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# gr-dsd is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with gr-dsd; see the file COPYING.  If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.

gr-dsd
======

Author: Clayton Smith
Email: <argilo@gmail.com>

The goal of this project is to package Digital Speech Decoder (DSD) as
a GNU Radio block, so that it can be easily used with software radio
peripherals such as the Ettus Research USRP or RTL2832U-based USB TV
tuners.

Dependencies:

  * GNU Radio 3.7
  * libsndfile (libsndfile1-dev package in Ubuntu)
  * BOOST C++ source libraries (libboost-all-dev in Ubuntu)
  * libcppunit-dev
  * liblog4cpp5-dev
  * swig

Build instructions:

    cmake .
    make
    sudo make install
    sudo ldconfig

If your GNU Radio is installed in /usr (rather than /usr/local), then
replace the first line above with:

    cmake -DCMAKE_INSTALL_PREFIX=/usr .

After running the above commands, "DSD Block" should appear under the
"DSD" category in GNU Radio Companion, and "block_ff" will be available
in the "dsd" Python package.

The block expects 48000 samples per second input, and outputs sound at
8000 samples per second.  The input should be FM-demodulated (for
example, with GNU Radio's Quadrature Demod block) and should be between
-1 and 1 while receiving digital signals.  (A quadrature demod gain of
1.6 works well for me for EDACS Provoice.)  The input signal should
also be free of DC bias, so make sure you are tuned accurately, or
filter out DC.

To save CPU cycles, the block detects when the input is zero and avoids
sending it through DSD.  Thus it helps to put a squelch block before
gr-dsd, especially if you're using many copies of gr-dsd in parallel.

The underlying DSD and mbelib were taken from:

    https://github.com/szechyjs/dsd
    https://github.com/szechyjs/mbelib

No modifications to mbelib were required, but DSD has been modified to
bypass the sound card.  The GNU Radio block itself was adapted from the
gr-howto-write-a-block sample included with GNU Radio.

Contributions are welcome!

Build on OS X
=============

mkdir build
cd build
CC=/usr/bin/llvm-gcc CXX=/usr/bin/llvm-g++ cmake -DPYTHON_EXECUTABLE=/opt/local/bin/python2.7 -DPYTHON_INCLUDE_DIR=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Headers -DPYTHON_LIBRARY=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Python ..
make