pv/data/decode/decoder.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <cassert>
  21
  22 #include <QDebug>
  23
  24 #include <libsigrokcxx/libsigrokcxx.hpp>
  25 #include <libsigrokdecode/libsigrokdecode.h>
  26
  27 #include "decoder.hpp"
  28
  29 #include <pv/data/signalbase.hpp>
  30 #include <pv/data/decodesignal.hpp>
  31
  32 using std::map;
  33 using std::string;
  34
  35 namespace pv {
  36 namespace data {
  37 namespace decode {
  38
  39 Decoder::Decoder(const srd_decoder *const dec) :
  40         decoder_(dec),
  41         shown_(true),
  42         decoder_inst_(nullptr)
  43 {
  44 }
  45
  46 Decoder::~Decoder()
  47 {
  48         for (auto& option : options_)
  49                 g_variant_unref(option.second);
  50 }
  51
  52 const srd_decoder* Decoder::decoder() const
  53 {
  54         return decoder_;
  55 }
  56
  57 bool Decoder::shown() const
  58 {
  59         return shown_;
  60 }
  61
  62 void Decoder::show(bool show)
  63 {
  64         shown_ = show;
  65 }
  66
  67 const vector<DecodeChannel*>& Decoder::channels() const
  68 {
  69         return channels_;
  70 }
  71
  72 void Decoder::set_channels(vector<DecodeChannel*> channels)
  73 {
  74         channels_ = channels;
  75 }
  76
  77 const map<string, GVariant*>& Decoder::options() const
  78 {
  79         return options_;
  80 }
  81
  82 void Decoder::set_option(const char *id, GVariant *value)
  83 {
  84         assert(value);
  85         g_variant_ref(value);
  86         options_[id] = value;
  87
  88         // If we have a decoder instance, apply option value immediately
  89         apply_all_options();
  90 }
  91
  92 void Decoder::apply_all_options()
  93 {
  94         if (decoder_inst_) {
  95                 GHashTable *const opt_hash = g_hash_table_new_full(g_str_hash,
  96                         g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
  97
  98                 for (const auto& option : options_) {
  99                         GVariant *const value = option.second;
 100                         g_variant_ref(value);
 101                         g_hash_table_replace(opt_hash, (void*)g_strdup(
 102                                 option.first.c_str()), value);
 103                 }
 104
 105                 srd_inst_option_set(decoder_inst_, opt_hash);
 106                 g_hash_table_destroy(opt_hash);
 107         }
 108 }
 109
 110 bool Decoder::have_required_channels() const
 111 {
 112         for (DecodeChannel *ch : channels_)
 113                 if (!ch->assigned_signal && !ch->is_optional)
 114                         return false;
 115
 116         return true;
 117 }
 118
 119 srd_decoder_inst* Decoder::create_decoder_inst(srd_session *session)
 120 {
 121         GHashTable *const opt_hash = g_hash_table_new_full(g_str_hash,
 122                 g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
 123
 124         for (const auto& option : options_) {
 125                 GVariant *const value = option.second;
 126                 g_variant_ref(value);
 127                 g_hash_table_replace(opt_hash, (void*)g_strdup(
 128                         option.first.c_str()), value);
 129         }
 130
 131         if (decoder_inst_)
 132                 qDebug() << "WARNING: previous decoder instance" << decoder_inst_ << "exists";
 133
 134         decoder_inst_ = srd_inst_new(session, decoder_->id, opt_hash);
 135         g_hash_table_destroy(opt_hash);
 136
 137         if (!decoder_inst_)
 138                 return nullptr;
 139
 140         // Setup the channels
 141         GArray *const init_pin_states = g_array_sized_new(false, true,
 142                 sizeof(uint8_t), channels_.size());
 143
 144         g_array_set_size(init_pin_states, channels_.size());
 145
 146         GHashTable *const channels = g_hash_table_new_full(g_str_hash,
 147                 g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
 148
 149         for (DecodeChannel *ch : channels_) {
 150                 if (!ch->assigned_signal)
 151                         continue;
 152
 153                 init_pin_states->data[ch->id] = ch->initial_pin_state;
 154
 155                 GVariant *const gvar = g_variant_new_int32(ch->bit_id);  // bit_id = bit position
 156                 g_variant_ref_sink(gvar);
 157                 // key is channel name (pdch->id), value is bit position in each sample (gvar)
 158                 g_hash_table_insert(channels, ch->pdch_->id, gvar);
 159         }
 160
 161         srd_inst_channel_set_all(decoder_inst_, channels);
 162
 163         srd_inst_initial_pins_set_all(decoder_inst_, init_pin_states);
 164         g_array_free(init_pin_states, true);
 165
 166         return decoder_inst_;
 167 }
 168
 169 void Decoder::invalidate_decoder_inst()
 170 {
 171         decoder_inst_ = nullptr;
 172 }
 173
 174 }  // namespace decode
 175 }  // namespace data
 176 }  // namespace pv