2 * This file is part of the PulseView project.
4 * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
21 #define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
33 #include <pv/data/decode/row.hpp>
37 using std::shared_ptr;
42 struct srd_decoder_inst;
57 class AnnotationClass: public QObject
62 AnnotationClass(size_t _id, char* _name, char* _description, Row* _row);
65 void set_visible(bool visible);
68 void visibility_changed();
82 uint16_t id; ///< Global numerical ID for the decode channels in the stack
83 uint16_t bit_id; ///< Tells which bit within a sample represents this channel
84 const bool is_optional;
85 shared_ptr<const pv::data::SignalBase> assigned_signal;
86 const QString name, desc;
87 int initial_pin_state;
88 const shared_ptr<Decoder> decoder_;
89 const srd_channel *pdch_;
92 struct DecoderLogicOutputChannel {
93 DecoderLogicOutputChannel (QString id, QString desc) :
94 id(id), desc(desc) {};
98 struct DecodeBinaryClassInfo
100 uint32_t bin_class_id;
106 class Decoder : public QObject
111 Decoder(const srd_decoder *const dec, uint8_t stack_level);
115 const srd_decoder* get_srd_decoder() const;
117 uint8_t get_stack_level() const;
119 const char* name() const;
121 bool visible() const;
122 void set_visible(bool visible);
124 const vector<DecodeChannel*>& channels() const;
125 void set_channels(vector<DecodeChannel*> channels);
127 const map<string, GVariant*>& options() const;
128 void set_option(const char *id, GVariant *value);
130 void apply_all_options();
132 bool have_required_channels() const;
134 srd_decoder_inst* create_decoder_inst(srd_session *session);
135 void invalidate_decoder_inst();
137 vector<Row*> get_rows();
138 Row* get_row_by_id(size_t id);
140 vector<const AnnotationClass*> ann_classes() const;
141 vector<AnnotationClass*> ann_classes();
142 AnnotationClass* get_ann_class_by_id(size_t id);
143 const AnnotationClass* get_ann_class_by_id(size_t id) const;
145 uint32_t get_binary_class_count() const;
146 const DecodeBinaryClassInfo* get_binary_class(uint32_t id) const;
148 bool has_logic_output() const;
149 const vector<DecoderLogicOutputChannel> logic_output_channels() const;
152 void annotation_visibility_changed();
155 void on_row_visibility_changed();
156 void on_class_visibility_changed();
159 const srd_decoder* const srd_decoder_;
160 uint8_t stack_level_;
164 vector<DecodeChannel*> channels_;
166 deque<AnnotationClass> ann_classes_;
167 vector<DecodeBinaryClassInfo> bin_classes_;
168 map<string, GVariant*> options_;
169 srd_decoder_inst *decoder_inst_;
172 } // namespace decode
176 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP