2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef PULSEVIEW_PV_DATA_DECODERSTACK_H
22 #define PULSEVIEW_PV_DATA_DECODERSTACK_H
24 #include "signaldata.h"
28 #include <boost/optional.hpp>
29 #include <boost/shared_ptr.hpp>
30 #include <boost/thread.hpp>
35 #include <pv/data/decode/row.h>
36 #include <pv/data/decode/rowdata.h>
39 struct srd_decoder_annotation_row;
41 struct srd_proto_data;
44 namespace DecoderStackTest {
45 class TwoDecoderStack;
67 class DecoderStack : public QObject, public SignalData
72 static const double DecodeMargin;
73 static const double DecodeThreshold;
74 static const int64_t DecodeChunkLength;
75 static const unsigned int DecodeNotifyPeriod;
78 DecoderStack(pv::SigSession &_session,
79 const srd_decoder *const decoder);
81 virtual ~DecoderStack();
83 const std::list< boost::shared_ptr<decode::Decoder> >& stack() const;
84 void push(boost::shared_ptr<decode::Decoder> decoder);
85 void remove(int index);
87 int64_t samples_decoded() const;
89 std::vector<decode::Row> get_visible_rows() const;
92 * Extracts sorted annotations between two period into a vector.
94 void get_annotation_subset(
95 std::vector<pv::data::decode::Annotation> &dest,
96 const decode::Row &row, uint64_t start_sample,
97 uint64_t end_sample) const;
99 QString error_message();
103 uint64_t get_max_sample_count() const;
108 boost::optional<int64_t> wait_for_data() const;
110 void decode_data(const int64_t sample_count,
111 const unsigned int unit_size, srd_session *const session);
115 static void annotation_callback(srd_proto_data *pdata,
121 void on_data_received();
123 void on_frame_ended();
126 void new_decode_data();
129 pv::SigSession &_session;
132 * This mutex prevents more than one decode operation occuring
134 * @todo A proper solution should be implemented to allow multiple
137 static boost::mutex _global_decode_mutex;
139 std::list< boost::shared_ptr<decode::Decoder> > _stack;
141 boost::shared_ptr<pv::data::LogicSnapshot> _snapshot;
143 mutable boost::mutex _input_mutex;
144 mutable boost::condition_variable _input_cond;
145 int64_t _sample_count;
146 bool _frame_complete;
148 mutable boost::mutex _output_mutex;
149 int64_t _samples_decoded;
151 std::map<const decode::Row, decode::RowData> _rows;
153 std::map<std::pair<const srd_decoder*, int>, decode::Row> _class_rows;
155 QString _error_message;
157 boost::thread _decode_thread;
159 friend class DecoderStackTest::TwoDecoderStack;
165 #endif // PULSEVIEW_PV_DATA_DECODERSTACK_H