pv/data/decoder.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <libsigrokdecode/libsigrokdecode.h>
  22
  23 #include <boost/thread/thread.hpp>
  24
  25 #include "decoder.h"
  26
  27 #include <pv/data/logic.h>
  28 #include <pv/data/logicsnapshot.h>
  29 #include <pv/view/logicsignal.h>
  30 #include <pv/view/decode/annotation.h>
  31
  32 using namespace boost;
  33 using namespace std;
  34
  35 namespace pv {
  36 namespace data {
  37
  38 const double Decoder::DecodeMargin = 1.0;
  39 const double Decoder::DecodeThreshold = 0.2;
  40 const int64_t Decoder::DecodeChunkLength = 4096;
  41
  42 Decoder::Decoder(const srd_decoder *const dec,
  43         std::map<const srd_probe*,
  44                 boost::shared_ptr<pv::view::Signal> > probes,
  45         GHashTable *options) :
  46         _decoder(dec),
  47         _probes(probes),
  48         _options(options),
  49         _decoder_inst(NULL)
  50 {
  51         init_decoder();
  52         begin_decode();
  53 }
  54
  55 Decoder::~Decoder()
  56 {
  57         _decode_thread.interrupt();
  58         _decode_thread.join();
  59
  60         g_hash_table_destroy(_options);
  61 }
  62
  63 const srd_decoder* Decoder::get_decoder() const
  64 {
  65         return _decoder;
  66 }
  67
  68 const vector< shared_ptr<view::decode::Annotation> >
  69         Decoder::annotations() const
  70 {
  71         lock_guard<mutex> lock(_annotations_mutex);
  72         return _annotations;
  73 }
  74
  75 void Decoder::begin_decode()
  76 {
  77         _decode_thread.interrupt();
  78         _decode_thread.join();
  79
  80         if (_probes.empty())
  81                 return;
  82
  83         // We get the logic data of the first probe in the list.
  84         // This works because we are currently assuming all
  85         // LogicSignals have the same data/snapshot
  86         shared_ptr<pv::view::Signal> sig = (*_probes.begin()).second;
  87         assert(sig);
  88         const pv::view::LogicSignal *const l =
  89                 dynamic_cast<pv::view::LogicSignal*>(sig.get());
  90         assert(l);
  91         shared_ptr<data::Logic> data = l->data();
  92
  93         _decode_thread = boost::thread(&Decoder::decode_proc, this,
  94                 data);
  95 }
  96
  97 void Decoder::clear_snapshots()
  98 {
  99 }
 100
 101 void Decoder::init_decoder()
 102 {
 103         if (!_probes.empty())
 104         {
 105                 shared_ptr<pv::view::LogicSignal> logic_signal =
 106                         dynamic_pointer_cast<pv::view::LogicSignal>(
 107                                 (*_probes.begin()).second);
 108                 if (logic_signal) {
 109                         shared_ptr<pv::data::Logic> data(
 110                                 logic_signal->data());
 111                         if (data) {
 112                                 _samplerate = data->get_samplerate();
 113                                 _start_time = data->get_start_time();
 114                         }
 115                 }
 116         }
 117
 118         _decoder_inst = srd_inst_new(_decoder->id, _options);
 119         if(!_decoder_inst) {
 120                 qDebug() << "Failed to initialise decoder";
 121                 return;
 122         }
 123
 124         _decoder_inst->data_samplerate = _samplerate;
 125
 126         GHashTable *probes = g_hash_table_new_full(g_str_hash,
 127                 g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
 128
 129         for(map<const srd_probe*, shared_ptr<view::Signal> >::
 130                 const_iterator i = _probes.begin();
 131                 i != _probes.end(); i++)
 132         {
 133                 shared_ptr<view::Signal> signal((*i).second);
 134                 GVariant *const gvar = g_variant_new_int32(
 135                         signal->probe()->index);
 136                 g_variant_ref_sink(gvar);
 137                 g_hash_table_insert(probes, (*i).first->id, gvar);
 138         }
 139
 140         srd_inst_probe_set_all(_decoder_inst, probes);
 141 }
 142
 143 void Decoder::decode_proc(shared_ptr<data::Logic> data)
 144 {
 145         uint8_t chunk[DecodeChunkLength];
 146
 147         assert(data);
 148
 149         _annotations.clear();
 150
 151         const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
 152                 data->get_snapshots();
 153         if (snapshots.empty())
 154                 return;
 155
 156         const shared_ptr<pv::data::LogicSnapshot> &snapshot =
 157                 snapshots.front();
 158         const int64_t sample_count = snapshot->get_sample_count() - 1;
 159         double samplerate = data->get_samplerate();
 160
 161         // Show sample rate as 1Hz when it is unknown
 162         if (samplerate == 0.0)
 163                 samplerate = 1.0;
 164
 165         srd_session_start(_probes.size(), snapshot->unit_size(), samplerate);
 166
 167         srd_pd_output_callback_add(SRD_OUTPUT_ANN,
 168                 Decoder::annotation_callback, this);
 169
 170         for (int64_t i = 0;
 171                 !this_thread::interruption_requested() && i < sample_count;
 172                 i += DecodeChunkLength)
 173         {
 174                 const int64_t chunk_end = min(
 175                         i + DecodeChunkLength, sample_count);
 176                 snapshot->get_samples(chunk, i, chunk_end);
 177
 178                 if (srd_session_send(i, chunk, chunk_end - i) != SRD_OK)
 179                         break;
 180         }
 181 }
 182
 183 void Decoder::annotation_callback(srd_proto_data *pdata, void *decoder)
 184 {
 185         using namespace pv::view::decode;
 186
 187         assert(pdata);
 188         assert(decoder);
 189
 190         Decoder *const d = (Decoder*)decoder;
 191
 192         shared_ptr<Annotation> a(new Annotation(pdata));
 193         lock_guard<mutex> lock(d->_annotations_mutex);
 194         d->_annotations.push_back(a);
 195
 196         d->new_decode_data();
 197 }
 198
 199 } // namespace data
 200 } // namespace pv