BaseBandRX.hxx

Go to the documentation of this file.

/*
Copyright (c) 2012,2013,2014 Matthew H. Reilly (kb1vc)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef BASEBANDRX_HDR
#define BASEBANDRX_HDR
#include "SoDaBase.hxx"
#include "Params.hxx"
#include "MultiMBox.hxx"
#include "Command.hxx"
#include "OSFilter.hxx"
#include "HilbertTransformer.hxx"
#include "ReSamplers625x48.hxx"
#include "AudioIfc.hxx"
#include "MedianFilter.hxx"

#include <queue>
#include <boost/thread.hpp>
#include <boost/thread/thread.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>
#include <fstream>
#include <string>

namespace SoDa {
  class BaseBandRX : public SoDaThread {
  public:
    BaseBandRX(Params * params,
        DatMBox * rx_stream, 
        CmdMBox * cmd_stream,
        AudioIfc * audio_ifc);

    void run();

  private:
    void execGetCommand(Command * cmd); 
    void execSetCommand(Command * cmd); 
    void execRepCommand(Command * cmd); 

    void demodulateSSB(std::complex<float> * drxbuf,
               SoDa::Command::ModulationType mod); 

    void demodulateAM(std::complex<float> * drxbuf);

    void demodulateNBFM(std::complex<float> * drxbuf,
            SoDa::Command::ModulationType mod,
            float af_gain); 

    void demodulateWBFM(SoDaBuf * rxbuf,
            SoDa::Command::ModulationType mod,
            float af_gain);

    
    void demodulate(SoDaBuf * rxbuf);

    void repAFFilterShape();

    // parameters
    unsigned int audio_buffer_size; 
    unsigned int rf_buffer_size; 
    double audio_sample_rate; 
    double rf_sample_rate; 
    bool audio_rx_stream_enabled; 
    bool audio_rx_stream_needs_start; 
    bool sidetone_stream_enabled;  

    SoDa::Command::ModulationType rx_modulation; 
    
    DatMBox * rx_stream; 
    CmdMBox * cmd_stream; 
    unsigned int rx_subs; 
    unsigned int cmd_subs; 

    AudioIfc * audio_ifc; 
    
    // buffer pool management

    void pendAudioBuffer(float * b); 
    
    float * getNextAudioBuffer();
    void flushAudioBuffers();
    void freeAudioBuffer(float * b);
    float * getFreeAudioBuffer();

    int readyAudioBuffers(); 


    // flow timing management
    bool in_catchup;  
    bool in_fallback;  
    unsigned int catchup_rand_mask; 

    std::queue<float *> free_buffers; 
    std::queue<float *> ready_buffers; 

    boost::mutex free_lock; 
    boost::mutex ready_lock; 

    float * sidetone_silence;  

    // resampler -- downsample from 625K samples / sec to 48K samples/sec
    SoDa::ReSample625to48 * rf_resampler; 
    // a second resampler for wideband fm
    SoDa::ReSample625to48 * wbfm_resampler; 

    void buildFilterMap();
    
    SoDa::Command::AudioFilterBW af_filter_selection; 
    SoDa::OSFilter * cur_audio_filter; 
    SoDa::OSFilter * fm_audio_filter; 
    SoDa::OSFilter * am_pre_filter; 
    SoDa::OSFilter * nbfm_pre_filter; 
    SoDa::OSFilter * am_audio_filter; 

    
    
    std::map<SoDa::Command::AudioFilterBW, SoDa::OSFilter *> filter_map; 

    // hilbert transformer
    SoDa::HilbertTransformer * hilbert; 
    
    // audio gain
    float af_gain;   
    float af_sidetone_gain; 
    float *cur_af_gain; 

    // support for NBFM/WBFM demodulator
    float last_phase_samp; 

    // median filter for FM demods
    MedianFilter3<float> fmMedianFilter; 
    
    // debug helper
    unsigned int dbg_ctr; 
    std::ofstream dbg_out;

    // audio output file
    bool audio_save_enable; 
    std::ofstream audio_file;
    std::ofstream audio_file2;     
    
  };
}


#endif