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