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 <stdexcept>
  26
  27 #include <QDebug>
  28
  29 #include "decoder.h"
  30
  31 #include <pv/data/logic.h>
  32 #include <pv/data/logicsnapshot.h>
  33 #include <pv/view/logicsignal.h>
  34 #include <pv/view/decode/annotation.h>
  35
  36 using namespace boost;
  37 using namespace std;
  38
  39 namespace pv {
  40 namespace data {
  41
  42 const double Decoder::DecodeMargin = 1.0;
  43 const double Decoder::DecodeThreshold = 0.2;
  44 const int64_t Decoder::DecodeChunkLength = 4096;
  45
  46 mutex Decoder::_global_decode_mutex;
  47
  48 Decoder::Decoder(const srd_decoder *const dec,
  49         std::map<const srd_probe*,
  50                 boost::shared_ptr<pv::view::LogicSignal> > probes,
  51         GHashTable *options) :
  52         _decoder(dec),
  53         _probes(probes),
  54         _options(options)
  55 {
  56         init_decoder();
  57
  58         begin_decode();
  59 }
  60
  61 Decoder::~Decoder()
  62 {
  63         _decode_thread.interrupt();
  64         _decode_thread.join();
  65
  66         g_hash_table_destroy(_options);
  67 }
  68
  69 const srd_decoder* Decoder::get_decoder() const
  70 {
  71         return _decoder;
  72 }
  73
  74 const vector< shared_ptr<view::decode::Annotation> >
  75         Decoder::annotations() const
  76 {
  77         lock_guard<mutex> lock(_mutex);
  78         return _annotations;
  79 }
  80
  81 QString Decoder::error_message()
  82 {
  83         lock_guard<mutex> lock(_mutex);
  84         return _error_message;
  85 }
  86
  87 void Decoder::begin_decode()
  88 {
  89         _decode_thread.interrupt();
  90         _decode_thread.join();
  91
  92         if (_probes.empty())
  93                 return;
  94
  95         // We get the logic data of the first probe in the list.
  96         // This works because we are currently assuming all
  97         // LogicSignals have the same data/snapshot
  98         shared_ptr<pv::view::LogicSignal> sig = (*_probes.begin()).second;
  99         assert(sig);
 100         shared_ptr<data::Logic> data = sig->data();
 101
 102         _decode_thread = boost::thread(&Decoder::decode_proc, this,
 103                 data);
 104 }
 105
 106 void Decoder::clear_snapshots()
 107 {
 108 }
 109
 110 void Decoder::init_decoder()
 111 {
 112         if (!_probes.empty())
 113         {
 114                 shared_ptr<pv::view::LogicSignal> logic_signal =
 115                         dynamic_pointer_cast<pv::view::LogicSignal>(
 116                                 (*_probes.begin()).second);
 117                 if (logic_signal) {
 118                         shared_ptr<pv::data::Logic> data(
 119                                 logic_signal->data());
 120                         if (data) {
 121                                 _start_time = data->get_start_time();
 122                                 _samplerate = data->get_samplerate();
 123                                 if (_samplerate == 0.0)
 124                                         _samplerate = 1.0;
 125                         }
 126                 }
 127         }
 128 }
 129
 130 void Decoder::decode_proc(shared_ptr<data::Logic> data)
 131 {
 132         srd_session *session;
 133         uint8_t chunk[DecodeChunkLength];
 134
 135         assert(data);
 136
 137         _annotations.clear();
 138
 139         const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
 140                 data->get_snapshots();
 141         if (snapshots.empty())
 142                 return;
 143
 144         const shared_ptr<pv::data::LogicSnapshot> &snapshot =
 145                 snapshots.front();
 146         const int64_t sample_count = snapshot->get_sample_count() - 1;
 147
 148         // Create the session
 149         srd_session_new(&session);
 150         assert(session);
 151
 152         srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
 153                 g_variant_new_uint64((uint64_t)_samplerate));
 154
 155         srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
 156                 Decoder::annotation_callback, this);
 157
 158         // Create the decoder instance
 159         srd_decoder_inst *const decoder_inst = srd_inst_new(
 160                 session, _decoder->id, _options);
 161         if(!decoder_inst) {
 162                 _error_message = tr("Failed to initialise decoder");
 163                 return;
 164         }
 165
 166         // Setup the probes
 167         GHashTable *const probes = g_hash_table_new_full(g_str_hash,
 168                 g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
 169
 170         for(map<const srd_probe*, shared_ptr<view::LogicSignal> >::
 171                 const_iterator i = _probes.begin();
 172                 i != _probes.end(); i++)
 173         {
 174                 shared_ptr<view::Signal> signal((*i).second);
 175                 GVariant *const gvar = g_variant_new_int32(
 176                         signal->probe()->index);
 177                 g_variant_ref_sink(gvar);
 178                 g_hash_table_insert(probes, (*i).first->id, gvar);
 179         }
 180
 181         srd_inst_probe_set_all(decoder_inst, probes);
 182
 183         // Start the session
 184         srd_session_start(session);
 185
 186         for (int64_t i = 0;
 187                 !this_thread::interruption_requested() && i < sample_count;
 188                 i += DecodeChunkLength)
 189         {
 190                 lock_guard<mutex> decode_lock(_global_decode_mutex);
 191
 192                 const int64_t chunk_end = min(
 193                         i + DecodeChunkLength, sample_count);
 194                 snapshot->get_samples(chunk, i, chunk_end);
 195
 196                 if (srd_session_send(session, i, i + sample_count,
 197                                 chunk, chunk_end - i) != SRD_OK) {
 198                         _error_message = tr("Failed to initialise decoder");
 199                         break;
 200                 }
 201         }
 202
 203         // Destroy the session
 204         srd_session_destroy(session);
 205 }
 206
 207 void Decoder::annotation_callback(srd_proto_data *pdata, void *decoder)
 208 {
 209         using namespace pv::view::decode;
 210
 211         assert(pdata);
 212         assert(decoder);
 213
 214         Decoder *const d = (Decoder*)decoder;
 215
 216         shared_ptr<Annotation> a(new Annotation(pdata));
 217         lock_guard<mutex> lock(d->_mutex);
 218         d->_annotations.push_back(a);
 219
 220         d->new_decode_data();
 221 }
 222
 223 } // namespace data
 224 } // namespace pv