gr-osmosdr/lib/miri/miri_source_c.cc

/* -*- c++ -*- */
/*
 * Copyright 2012 Dimitri Stolnikov <horiz0n@gmx.net>
 * Copyright 2012 Steve Markgraf <steve@steve-m.de>
 *
 * GNU Radio 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.
 *
 * GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

/*
 * config.h is generated by configure.  It contains the results
 * of probing for features, options etc.  It should be the first
 * file included in your .cc file.
 */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "miri_source_c.h"
#include <gr_io_signature.h>

#include <boost/assign.hpp>
#include <boost/format.hpp>

#include <stdexcept>
#include <iostream>
#include <stdio.h>

#include <mirisdr.h>

#include <osmosdr_arg_helpers.h>

using namespace boost::assign;

#define BUF_SIZE  2304 * 8 * 2
#define BUF_NUM   32
#define BUF_SKIP  1 // buffers to skip due to garbage

#define BYTES_PER_SAMPLE  4 // mirisdr device delivers 16 bit signed IQ data
                            // containing 12 bits of information

/*
 * Create a new instance of miri_source_c and return
 * a boost shared_ptr.  This is effectively the public constructor.
 */
miri_source_c_sptr
make_miri_source_c (const std::string &args)
{
  return gnuradio::get_initial_sptr(new miri_source_c (args));
}

/*
 * Specify constraints on number of input and output streams.
 * This info is used to construct the input and output signatures
 * (2nd & 3rd args to gr_block's constructor).  The input and
 * output signatures are used by the runtime system to
 * check that a valid number and type of inputs and outputs
 * are connected to this block.  In this case, we accept
 * only 0 input and 1 output.
 */
static const int MIN_IN = 0;	// mininum number of input streams
static const int MAX_IN = 0;	// maximum number of input streams
static const int MIN_OUT = 1;	// minimum number of output streams
static const int MAX_OUT = 1;	// maximum number of output streams

/*
 * The private constructor
 */
miri_source_c::miri_source_c (const std::string &args)
  : gr_sync_block ("miri_source_c",
        gr_make_io_signature (MIN_IN, MAX_IN, sizeof (gr_complex)),
        gr_make_io_signature (MIN_OUT, MAX_OUT, sizeof (gr_complex))),
    _running(true),
    _auto_gain(false),
    _skipped(0)
{
  int ret;
  unsigned int dev_index = 0;

  dict_t dict = params_to_dict(args);

  if (dict.count("miri"))
    dev_index = boost::lexical_cast< unsigned int >( dict["miri"] );

  _buf_num = _buf_head = _buf_used = _buf_offset = 0;
  _samp_avail = BUF_SIZE / BYTES_PER_SAMPLE;

  if (dict.count("buffers"))
    _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] );

  if (0 == _buf_num)
    _buf_num = BUF_NUM;

  if ( BUF_NUM != _buf_num ) {
    std::cerr << "Using " << _buf_num << " buffers of size " << BUF_SIZE << "."
              << std::endl;
  }

  if ( dev_index >= mirisdr_get_device_count() )
    throw std::runtime_error("Wrong mirisdr device index given.");

  std::cerr << "Using device #" << dev_index << ": "
            << mirisdr_get_device_name(dev_index)
            << std::endl;

  _dev = NULL;
  ret = mirisdr_open( &_dev, dev_index );
  if (ret < 0)
    throw std::runtime_error("Failed to open mirisdr device.");
#if 0
  ret = mirisdr_set_sample_rate( _dev, 500000 );
  if (ret < 0)
    throw std::runtime_error("Failed to set default samplerate.");

  ret = mirisdr_set_tuner_gain_mode(_dev, int(!_auto_gain));
  if (ret < 0)
    throw std::runtime_error("Failed to enable manual gain mode.");
#endif
  ret = mirisdr_reset_buffer( _dev );
  if (ret < 0)
    throw std::runtime_error("Failed to reset usb buffers.");

  _buf = (unsigned short **) malloc(_buf_num * sizeof(unsigned short *));
  _buf_lens = (unsigned int *) malloc(_buf_num * sizeof(unsigned int));

  if (_buf && _buf_lens) {
    for(unsigned int i = 0; i < _buf_num; ++i)
      _buf[i] = (unsigned short *) malloc(BUF_SIZE);
  }

  _thread = gruel::thread(_mirisdr_wait, this);
}

/*
 * Our virtual destructor.
 */
miri_source_c::~miri_source_c ()
{
  if (_dev) {
    _running = false;
    mirisdr_cancel_async( _dev );
    _thread.join();
    mirisdr_close( _dev );
    _dev = NULL;
  }

  if (_buf) {
    for(unsigned int i = 0; i < _buf_num; ++i) {
      if (_buf[i])
        free(_buf[i]);
    }

    free(_buf);
    _buf = NULL;
    free(_buf_lens);
    _buf_lens = NULL;
  }
}

void miri_source_c::_mirisdr_callback(unsigned char *buf, uint32_t len, void *ctx)
{
  miri_source_c *obj = (miri_source_c *)ctx;
  obj->mirisdr_callback(buf, len);
}

void miri_source_c::mirisdr_callback(unsigned char *buf, uint32_t len)
{
  if (_skipped < BUF_SKIP) {
    _skipped++;
    return;
  }

  {
    boost::mutex::scoped_lock lock( _buf_mutex );

    if (len > BUF_SIZE)
      throw std::runtime_error("Buffer too small.");

    int buf_tail = (_buf_head + _buf_used) % _buf_num;
    memcpy(_buf[buf_tail], buf, len);
    _buf_lens[buf_tail] = len;

    if (_buf_used == _buf_num) {
      std::cerr << "O" << std::flush;
      _buf_head = (_buf_head + 1) % _buf_num;
    } else {
      _buf_used++;
    }
  }

  _buf_cond.notify_one();
}

void miri_source_c::_mirisdr_wait(miri_source_c *obj)
{
  obj->mirisdr_wait();
}

void miri_source_c::mirisdr_wait()
{
  int ret = mirisdr_read_async( _dev, _mirisdr_callback, (void *)this, 0, BUF_SIZE );

  _running = false;

  if ( ret != 0 )
    std::cerr << "mirisdr_read_async returned with " << ret << std::endl;

  _buf_cond.notify_one();
}

int miri_source_c::work( int noutput_items,
                        gr_vector_const_void_star &input_items,
                        gr_vector_void_star &output_items )
{
  gr_complex *out = (gr_complex *)output_items[0];

  {
    boost::mutex::scoped_lock lock( _buf_mutex );

    while (_buf_used < 3 && _running) // collect at least 3 buffers
      _buf_cond.wait( lock );
  }

  if (!_running)
    return WORK_DONE;

  short *buf = (short *)_buf[_buf_head] + _buf_offset;

  if (noutput_items <= _samp_avail) {
    for (int i = 0; i < noutput_items; i++)
      *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f),
                           float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) );

    _buf_offset += noutput_items * 2;
    _samp_avail -= noutput_items;
  } else {
    for (int i = 0; i < _samp_avail; i++)
      *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f),
                           float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) );

    {
      boost::mutex::scoped_lock lock( _buf_mutex );

      _buf_head = (_buf_head + 1) % _buf_num;
      _buf_used--;
    }

    buf = (short *)_buf[_buf_head];

    int remaining = noutput_items - _samp_avail;

    for (int i = 0; i < remaining; i++)
      *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f),
                           float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) );

    _buf_offset = remaining * 2;
    _samp_avail = (_buf_lens[_buf_head] / BYTES_PER_SAMPLE) - remaining;
  }

  return noutput_items;
}

std::vector<std::string> miri_source_c::get_devices()
{
  std::vector<std::string> devices;

  for (unsigned int i = 0; i < mirisdr_get_device_count(); i++) {
    std::string args = "miri=" + boost::lexical_cast< std::string >( i );
    args += ",label='" + std::string(mirisdr_get_device_name( i )) + "'";
    devices.push_back( args );
  }

  return devices;
}

size_t miri_source_c::get_num_channels()
{
  return 1;
}

osmosdr::meta_range_t miri_source_c::get_sample_rates()
{
  osmosdr::meta_range_t range;

  range += osmosdr::range_t( 8000000 ); // known to work

  return range;
}

double miri_source_c::set_sample_rate(double rate)
{
  if (_dev) {
    mirisdr_set_sample_rate( _dev, (uint32_t)rate );
  }

  return get_sample_rate();
}

double miri_source_c::get_sample_rate()
{
  if (_dev)
    return (double)mirisdr_get_sample_rate( _dev );

  return 0;
}

osmosdr::freq_range_t miri_source_c::get_freq_range( size_t chan )
{
  osmosdr::freq_range_t range;

  range += osmosdr::range_t( 150e3, 30e6 ); /* LW/MW/SW (150 kHz - 30 MHz) */
  range += osmosdr::range_t( 64e6, 108e6 ); /* VHF Band II (64 - 108 MHz) */
  range += osmosdr::range_t( 162e6, 240e6 ); /* Band III (162 - 240 MHz) */
  range += osmosdr::range_t( 470e6, 960e6 ); /* Band IV/V (470 - 960 MHz) */
  range += osmosdr::range_t( 1450e6, 1675e6 ); /* L-Band (1450 - 1675 MHz) */

  return range;
}

double miri_source_c::set_center_freq( double freq, size_t chan )
{
  if (_dev)
    mirisdr_set_center_freq( _dev, (uint32_t)freq );

  return get_center_freq( chan );
}

double miri_source_c::get_center_freq( size_t chan )
{
  if (_dev)
    return (double)mirisdr_get_center_freq( _dev );

  return 0;
}

double miri_source_c::set_freq_corr( double ppm, size_t chan )
{
  return get_freq_corr( chan );
}

double miri_source_c::get_freq_corr( size_t chan )
{
  return 0;
}

std::vector<std::string> miri_source_c::get_gain_names( size_t chan )
{
  std::vector< std::string > gains;

  gains += "LNA";

  return gains;
}

osmosdr::gain_range_t miri_source_c::get_gain_range( size_t chan )
{
  osmosdr::gain_range_t range;

  if (_dev) {
    int count = mirisdr_get_tuner_gains(_dev, NULL);
    if (count > 0) {
      int* gains = new int[ count ];
      count = mirisdr_get_tuner_gains(_dev, gains);
      for (int i = 0; i < count; i++)
        range += osmosdr::range_t( gains[i] / 10.0 );
      delete[] gains;
    }
  }

  return range;
}

osmosdr::gain_range_t miri_source_c::get_gain_range( const std::string & name, size_t chan )
{
  return get_gain_range( chan );
}

bool miri_source_c::set_gain_mode( bool automatic, size_t chan )
{
  if (_dev) {
    if (!mirisdr_set_tuner_gain_mode(_dev, int(!automatic))) {
      _auto_gain = automatic;
    }
  }

  return get_gain_mode(chan);
}

bool miri_source_c::get_gain_mode( size_t chan )
{
  return _auto_gain;
}

double miri_source_c::set_gain( double gain, size_t chan )
{
  osmosdr::gain_range_t rf_gains = miri_source_c::get_gain_range( chan );

  if (_dev) {
    mirisdr_set_tuner_gain( _dev, int(rf_gains.clip(gain) * 10.0) );
  }

  return get_gain( chan );
}

double miri_source_c::set_gain( double gain, const std::string & name, size_t chan)
{
  return set_gain( gain, chan );
}

double miri_source_c::get_gain( size_t chan )
{
  if ( _dev )
    return ((double)mirisdr_get_tuner_gain( _dev )) / 10.0;

  return 0;
}

double miri_source_c::get_gain( const std::string & name, size_t chan )
{
  return get_gain( chan );
}

std::vector< std::string > miri_source_c::get_antennas( size_t chan )
{
  std::vector< std::string > antennas;

  antennas += get_antenna( chan );

  return antennas;
}

std::string miri_source_c::set_antenna( const std::string & antenna, size_t chan )
{
  return get_antenna( chan );
}

std::string miri_source_c::get_antenna( size_t chan )
{
  return "RX";
}