]>
Commit | Line | Data |
---|---|---|
7491a29f JH |
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
7491a29f JH |
18 | */ |
19 | ||
7a01bd36 JH |
20 | #ifndef PULSEVIEW_PV_DATA_DECODE_DECODER_HPP |
21 | #define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP | |
7491a29f | 22 | |
02078aa1 | 23 | #include <deque> |
7491a29f | 24 | #include <map> |
f9abf97e | 25 | #include <memory> |
ddee4cf8 | 26 | #include <set> |
27a3f09b | 27 | #include <vector> |
7491a29f | 28 | |
7491a29f JH |
29 | #include <glib.h> |
30 | ||
02078aa1 SA |
31 | #include <QObject> |
32 | ||
6a26fc44 | 33 | #include <pv/data/decode/row.hpp> |
a82325d1 | 34 | |
02078aa1 | 35 | using std::deque; |
6f925ba9 | 36 | using std::map; |
1e948182 | 37 | using std::shared_ptr; |
6f925ba9 | 38 | using std::string; |
27a3f09b | 39 | using std::vector; |
6f925ba9 | 40 | |
7491a29f JH |
41 | struct srd_decoder; |
42 | struct srd_decoder_inst; | |
8bd26d8b | 43 | struct srd_channel; |
7491a29f JH |
44 | struct srd_session; |
45 | ||
46 | namespace pv { | |
47 | ||
7491a29f | 48 | namespace data { |
ddee4cf8 JH |
49 | |
50 | class Logic; | |
04394ded | 51 | class SignalBase; |
ddee4cf8 | 52 | |
7491a29f JH |
53 | namespace decode { |
54 | ||
a82325d1 SA |
55 | class Decoder; |
56 | ||
02078aa1 | 57 | class AnnotationClass: public QObject |
6a26fc44 | 58 | { |
02078aa1 SA |
59 | Q_OBJECT |
60 | ||
61 | public: | |
62 | AnnotationClass(size_t _id, char* _name, char* _description, Row* _row); | |
63 | ||
64 | bool visible() const; | |
65 | void set_visible(bool visible); | |
66 | ||
67 | Q_SIGNALS: | |
68 | void visibility_changed(); | |
69 | ||
70 | public: | |
6a26fc44 SA |
71 | size_t id; |
72 | char* name; | |
73 | char* description; | |
74 | Row* row; | |
02078aa1 SA |
75 | |
76 | private: | |
77 | bool visible_; | |
6a26fc44 SA |
78 | }; |
79 | ||
a82325d1 SA |
80 | struct DecodeChannel |
81 | { | |
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; | |
cf1541a1 | 85 | shared_ptr<const pv::data::SignalBase> assigned_signal; |
a82325d1 SA |
86 | const QString name, desc; |
87 | int initial_pin_state; | |
88 | const shared_ptr<Decoder> decoder_; | |
89 | const srd_channel *pdch_; | |
90 | }; | |
91 | ||
04b04675 | 92 | struct DecoderLogicOutputChannel { |
88304160 SA |
93 | DecoderLogicOutputChannel (QString id, QString desc) : |
94 | id(id), desc(desc) {}; | |
04b04675 | 95 | QString id, desc; |
04b04675 SA |
96 | }; |
97 | ||
e77de61f SA |
98 | struct DecodeBinaryClassInfo |
99 | { | |
ac9494ef | 100 | uint32_t bin_class_id; |
e77de61f SA |
101 | char* name; |
102 | char* description; | |
103 | }; | |
104 | ||
a82325d1 | 105 | |
02078aa1 | 106 | class Decoder : public QObject |
7491a29f | 107 | { |
02078aa1 SA |
108 | Q_OBJECT |
109 | ||
7491a29f | 110 | public: |
f54e68b0 | 111 | Decoder(const srd_decoder *const dec, uint8_t stack_level); |
7491a29f JH |
112 | |
113 | virtual ~Decoder(); | |
114 | ||
6a26fc44 | 115 | const srd_decoder* get_srd_decoder() const; |
7491a29f | 116 | |
f54e68b0 SA |
117 | uint8_t get_stack_level() const; |
118 | ||
e77de61f SA |
119 | const char* name() const; |
120 | ||
5d3ca591 SA |
121 | bool visible() const; |
122 | void set_visible(bool visible); | |
dd048a7e | 123 | |
a82325d1 SA |
124 | const vector<DecodeChannel*>& channels() const; |
125 | void set_channels(vector<DecodeChannel*> channels); | |
7491a29f | 126 | |
6f925ba9 | 127 | const map<string, GVariant*>& options() const; |
7491a29f JH |
128 | void set_option(const char *id, GVariant *value); |
129 | ||
72486b78 SA |
130 | void apply_all_options(); |
131 | ||
6ac6242b | 132 | bool have_required_channels() const; |
a2d4b551 | 133 | |
8ce0e732 SA |
134 | srd_decoder_inst* create_decoder_inst(srd_session *session); |
135 | void invalidate_decoder_inst(); | |
7491a29f | 136 | |
6a26fc44 SA |
137 | vector<Row*> get_rows(); |
138 | Row* get_row_by_id(size_t id); | |
139 | ||
140 | vector<const AnnotationClass*> ann_classes() const; | |
41293691 | 141 | vector<AnnotationClass*> ann_classes(); |
6a26fc44 | 142 | AnnotationClass* get_ann_class_by_id(size_t id); |
761f8302 | 143 | const AnnotationClass* get_ann_class_by_id(size_t id) const; |
6a26fc44 | 144 | |
ac9494ef SA |
145 | uint32_t get_binary_class_count() const; |
146 | const DecodeBinaryClassInfo* get_binary_class(uint32_t id) const; | |
a82325d1 | 147 | |
04b04675 SA |
148 | bool has_logic_output() const; |
149 | const vector<DecoderLogicOutputChannel> logic_output_channels() const; | |
150 | ||
02078aa1 SA |
151 | Q_SIGNALS: |
152 | void annotation_visibility_changed(); | |
153 | ||
154 | private Q_SLOTS: | |
155 | void on_row_visibility_changed(); | |
156 | void on_class_visibility_changed(); | |
157 | ||
7491a29f | 158 | private: |
cbb2e4da | 159 | const srd_decoder* const srd_decoder_; |
f54e68b0 | 160 | uint8_t stack_level_; |
dd048a7e | 161 | |
5d3ca591 | 162 | bool visible_; |
dd048a7e | 163 | |
a82325d1 | 164 | vector<DecodeChannel*> channels_; |
02078aa1 SA |
165 | deque<Row> rows_; |
166 | deque<AnnotationClass> ann_classes_; | |
e77de61f | 167 | vector<DecodeBinaryClassInfo> bin_classes_; |
6f925ba9 | 168 | map<string, GVariant*> options_; |
8ce0e732 | 169 | srd_decoder_inst *decoder_inst_; |
7491a29f JH |
170 | }; |
171 | ||
172 | } // namespace decode | |
173 | } // namespace data | |
174 | } // namespace pv | |
175 | ||
7a01bd36 | 176 | #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP |