pv/data/decode/decoder.hpp

   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 #ifndef PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
  21 #define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
  22
  23 #include <map>
  24 #include <memory>
  25 #include <set>
  26 #include <vector>
  27
  28 #include <glib.h>
  29
  30 #include <pv/data/signalbase.hpp>
  31 #include <pv/data/decode/row.hpp>
  32
  33 using std::map;
  34 using std::string;
  35 using std::vector;
  36
  37 struct srd_decoder;
  38 struct srd_decoder_inst;
  39 struct srd_channel;
  40 struct srd_session;
  41
  42 namespace pv {
  43
  44 namespace data {
  45
  46 class Logic;
  47 class SignalBase;
  48
  49 namespace decode {
  50
  51 class Decoder;
  52
  53 struct AnnotationClass
  54 {
  55         size_t id;
  56         char* name;
  57         char* description;
  58         Row* row;
  59         bool visible;
  60 };
  61
  62 struct DecodeChannel
  63 {
  64         uint16_t id;     ///< Global numerical ID for the decode channels in the stack
  65         uint16_t bit_id; ///< Tells which bit within a sample represents this channel
  66         const bool is_optional;
  67         const pv::data::SignalBase *assigned_signal;
  68         const QString name, desc;
  69         int initial_pin_state;
  70         const shared_ptr<Decoder> decoder_;
  71         const srd_channel *pdch_;
  72 };
  73
  74 struct DecodeBinaryClassInfo
  75 {
  76         uint32_t bin_class_id;
  77         char* name;
  78         char* description;
  79 };
  80
  81
  82 class Decoder
  83 {
  84 public:
  85         Decoder(const srd_decoder *const dec, uint8_t stack_level);
  86
  87         virtual ~Decoder();
  88
  89         const srd_decoder* get_srd_decoder() const;
  90
  91         uint8_t get_stack_level() const;
  92
  93         const char* name() const;
  94
  95         bool visible() const;
  96         void set_visible(bool visible);
  97
  98         const vector<DecodeChannel*>& channels() const;
  99         void set_channels(vector<DecodeChannel*> channels);
 100
 101         const map<string, GVariant*>& options() const;
 102         void set_option(const char *id, GVariant *value);
 103
 104         void apply_all_options();
 105
 106         bool have_required_channels() const;
 107
 108         srd_decoder_inst* create_decoder_inst(srd_session *session);
 109         void invalidate_decoder_inst();
 110
 111         vector<Row*> get_rows();
 112         Row* get_row_by_id(size_t id);
 113
 114         vector<const AnnotationClass*> ann_classes() const;
 115         vector<AnnotationClass*> ann_classes();
 116         AnnotationClass* get_ann_class_by_id(size_t id);
 117         const AnnotationClass* get_ann_class_by_id(size_t id) const;
 118
 119         uint32_t get_binary_class_count() const;
 120         const DecodeBinaryClassInfo* get_binary_class(uint32_t id) const;
 121
 122 private:
 123         const srd_decoder* const srd_decoder_;
 124         uint8_t stack_level_;
 125
 126         bool visible_;
 127
 128         vector<DecodeChannel*> channels_;
 129         vector<Row> rows_;
 130         vector<AnnotationClass> ann_classes_;
 131         vector<DecodeBinaryClassInfo> bin_classes_;
 132         map<string, GVariant*> options_;
 133         srd_decoder_inst *decoder_inst_;
 134 };
 135
 136 } // namespace decode
 137 } // namespace data
 138 } // namespace pv
 139
 140 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP