decode: Fix mixup of bytes vs samples
[pulseview.git] / pv / sigsession.h
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012-14 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_SIGSESSION_H
22 #define PULSEVIEW_PV_SIGSESSION_H
23
24 #include <boost/function.hpp>
25 #include <boost/shared_ptr.hpp>
26 #include <boost/thread.hpp>
27
28 #include <map>
29 #include <set>
30 #include <string>
31 #include <vector>
32
33 #include <QObject>
34 #include <QString>
35
36 #include <libsigrok/libsigrok.h>
37
38 struct srd_decoder;
39 struct srd_probe;
40
41 namespace pv {
42
43 class DeviceManager;
44 class DevInst;
45
46 namespace data {
47 class Analog;
48 class AnalogSnapshot;
49 class Logic;
50 class LogicSnapshot;
51 class SignalData;
52 }
53
54 namespace view {
55 class DecodeTrace;
56 class LogicSignal;
57 class Signal;
58 }
59
60 class SigSession : public QObject
61 {
62         Q_OBJECT
63
64 public:
65         enum capture_state {
66                 Stopped,
67                 AwaitingTrigger,
68                 Running
69         };
70
71 public:
72         SigSession(DeviceManager &device_manager);
73
74         ~SigSession();
75
76         boost::shared_ptr<DevInst> get_device() const;
77
78         /**
79          * Sets device instance that will be used in the next capture session.
80          */
81         void set_device(boost::shared_ptr<DevInst> dev_inst);
82
83         void release_device(boost::shared_ptr<DevInst> dev_inst);
84
85         void load_file(const std::string &name,
86                 boost::function<void (const QString)> error_handler);
87
88         capture_state get_capture_state() const;
89
90         void start_capture(boost::function<void (const QString)> error_handler);
91
92         void stop_capture();
93
94         std::set< boost::shared_ptr<data::SignalData> > get_data() const;
95
96         std::vector< boost::shared_ptr<view::Signal> >
97                 get_signals() const;
98
99 #ifdef ENABLE_DECODE
100         bool add_decoder(srd_decoder *const dec);
101
102         std::vector< boost::shared_ptr<view::DecodeTrace> >
103                 get_decode_signals() const;
104
105         void remove_decode_signal(view::DecodeTrace *signal);
106 #endif
107
108 private:
109         void set_capture_state(capture_state state);
110
111         void update_signals(boost::shared_ptr<DevInst> dev_inst);
112
113         bool is_trigger_enabled() const;
114
115         boost::shared_ptr<view::Signal> signal_from_probe(
116                 const sr_probe *probe) const;
117
118         void read_sample_rate(const sr_dev_inst *const sdi);
119
120 private:
121         /**
122          * Attempts to autodetect the format. Failing that
123          * @param filename The filename of the input file.
124          * @return A pointer to the 'struct sr_input_format' that should be
125          *      used, or NULL if no input format was selected or
126          *      auto-detected.
127          */
128         static sr_input_format* determine_input_file_format(
129                 const std::string &filename);
130
131         static sr_input* load_input_file_format(
132                 const std::string &filename,
133                 boost::function<void (const QString)> error_handler,
134                 sr_input_format *format = NULL);
135
136         void load_session_thread_proc(
137                 boost::function<void (const QString)> error_handler);
138
139         void load_input_thread_proc(const std::string name, sr_input *in,
140                 boost::function<void (const QString)> error_handler);
141
142         void sample_thread_proc(boost::shared_ptr<DevInst> dev_inst,
143                 boost::function<void (const QString)> error_handler);
144
145         void feed_in_header(const sr_dev_inst *sdi);
146
147         void feed_in_meta(const sr_dev_inst *sdi,
148                 const sr_datafeed_meta &meta);
149
150         void feed_in_logic(const sr_datafeed_logic &logic);
151
152         void feed_in_analog(const sr_datafeed_analog &analog);
153
154         void data_feed_in(const struct sr_dev_inst *sdi,
155                 const struct sr_datafeed_packet *packet);
156
157         static void data_feed_in_proc(const struct sr_dev_inst *sdi,
158                 const struct sr_datafeed_packet *packet, void *cb_data);
159
160 private:
161         DeviceManager &_device_manager;
162
163         /**
164          * The device instance that will be used in the next capture session.
165          */
166         boost::shared_ptr<DevInst> _dev_inst;
167
168         std::vector< boost::shared_ptr<view::DecodeTrace> > _decode_traces;
169
170         mutable boost::mutex _sampling_mutex;
171         capture_state _capture_state;
172
173         mutable boost::mutex _signals_mutex;
174         std::vector< boost::shared_ptr<view::Signal> > _signals;
175
176         mutable boost::mutex _data_mutex;
177         boost::shared_ptr<data::Logic> _logic_data;
178         boost::shared_ptr<data::LogicSnapshot> _cur_logic_snapshot;
179         std::map< const sr_probe*, boost::shared_ptr<data::AnalogSnapshot> >
180                 _cur_analog_snapshots;
181
182         boost::thread _sampling_thread;
183
184 signals:
185         void capture_state_changed(int state);
186
187         void signals_changed();
188
189         void data_updated();
190
191 private:
192         // TODO: This should not be necessary. Multiple concurrent
193         // sessions should should be supported and it should be
194         // possible to associate a pointer with a sr_session.
195         static SigSession *_session;
196 };
197
198 } // namespace pv
199
200 #endif // PULSEVIEW_PV_SIGSESSION_H