Fix build
[pulseview.git] / pv / session.hpp
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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_SESSION_HPP
21 #define PULSEVIEW_PV_SESSION_HPP
22
23 #ifdef ENABLE_FLOW
24 #include <atomic>
25 #include <condition_variable>
26 #endif
27
28 #include <functional>
29 #include <map>
30 #include <memory>
31 #include <mutex>
32 #include <set>
33 #include <string>
34 #include <thread>
35 #include <unordered_set>
36 #include <vector>
37
38 #include <QObject>
39 #include <QSettings>
40 #include <QString>
41 #include <QElapsedTimer>
42
43 #ifdef ENABLE_FLOW
44 #include <gstreamermm.h>
45 #include <libsigrokflow/libsigrokflow.hpp>
46 #endif
47
48 #include "util.hpp"
49 #include "views/viewbase.hpp"
50
51
52 using std::function;
53 using std::list;
54 using std::map;
55 using std::mutex;
56 using std::recursive_mutex;
57 using std::shared_ptr;
58 using std::string;
59 using std::unordered_set;
60
61 #ifdef ENABLE_FLOW
62 using Glib::RefPtr;
63 using Gst::AppSink;
64 using Gst::Element;
65 using Gst::Pipeline;
66 #endif
67
68 struct srd_decoder;
69 struct srd_channel;
70
71 namespace sigrok {
72 class Analog;
73 class Channel;
74 class Device;
75 class InputFormat;
76 class Logic;
77 class Meta;
78 class Option;
79 class OutputFormat;
80 class Packet;
81 class Session;
82 }  // namespace sigrok
83
84 using sigrok::Option;
85
86 namespace pv {
87
88 class DeviceManager;
89
90 namespace data {
91 class Analog;
92 class AnalogSegment;
93 class DecodeSignal;
94 class Logic;
95 class LogicSegment;
96 class SignalBase;
97 class SignalData;
98 }
99
100 namespace devices {
101 class Device;
102 }
103
104 namespace toolbars {
105 class MainBar;
106 }
107
108 namespace views {
109 class ViewBase;
110 }
111
112 class Session : public QObject
113 {
114         Q_OBJECT
115
116 public:
117         enum capture_state {
118                 Stopped,
119                 AwaitingTrigger,
120                 Running
121         };
122
123         static shared_ptr<sigrok::Context> sr_context;
124
125 public:
126         Session(DeviceManager &device_manager, QString name);
127
128         ~Session();
129
130         DeviceManager& device_manager();
131
132         const DeviceManager& device_manager() const;
133
134         shared_ptr<sigrok::Session> session() const;
135
136         shared_ptr<devices::Device> device() const;
137
138         QString name() const;
139
140         void set_name(QString name);
141
142         const list< shared_ptr<views::ViewBase> > views() const;
143
144         shared_ptr<views::ViewBase> main_view() const;
145
146         shared_ptr<pv::toolbars::MainBar> main_bar() const;
147
148         void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
149
150         /**
151          * Indicates whether the captured data was saved to disk already or not
152          */
153         bool data_saved() const;
154
155         void save_setup(QSettings &settings) const;
156
157         void save_settings(QSettings &settings) const;
158
159         void restore_setup(QSettings &settings);
160
161         void restore_settings(QSettings &settings);
162
163         /**
164          * Attempts to set device instance, may fall back to demo if needed
165          */
166         void select_device(shared_ptr<devices::Device> device);
167
168         /**
169          * Sets device instance that will be used in the next capture session.
170          */
171         void set_device(shared_ptr<devices::Device> device);
172
173         void set_default_device();
174
175         bool using_file_device() const;
176
177         void load_init_file(const string &file_name, const string &format,
178                 const string &setup_file_name);
179
180         void load_file(QString file_name, QString setup_file_name = QString(),
181                 shared_ptr<sigrok::InputFormat> format = nullptr,
182                 const map<string, Glib::VariantBase> &options =
183                         map<string, Glib::VariantBase>());
184
185         capture_state get_capture_state() const;
186
187         void start_capture(function<void (const QString)> error_handler);
188
189         void stop_capture();
190
191         double get_samplerate() const;
192
193         uint32_t get_segment_count() const;
194
195         vector<util::Timestamp> get_triggers(uint32_t segment_id) const;
196
197         void register_view(shared_ptr<views::ViewBase> view);
198
199         void deregister_view(shared_ptr<views::ViewBase> view);
200
201         bool has_view(shared_ptr<views::ViewBase> view);
202
203         const unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
204
205         bool all_segments_complete(uint32_t segment_id) const;
206
207 #ifdef ENABLE_DECODE
208         shared_ptr<data::DecodeSignal> add_decode_signal();
209
210         void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
211 #endif
212
213 private:
214         void set_capture_state(capture_state state);
215
216         void update_signals();
217
218         shared_ptr<data::SignalBase> signalbase_from_channel(
219                 shared_ptr<sigrok::Channel> channel) const;
220
221         static map<string, Glib::VariantBase> input_format_options(
222                 vector<string> user_spec,
223                 map<string, shared_ptr<Option>> fmt_opts);
224
225         void sample_thread_proc(function<void (const QString)> error_handler);
226
227         void free_unused_memory();
228
229         void signal_new_segment();
230         void signal_segment_completed();
231
232 #ifdef ENABLE_FLOW
233         bool on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message);
234
235         Gst::FlowReturn on_gst_new_sample();
236 #endif
237
238         void feed_in_header();
239
240         void feed_in_meta(shared_ptr<sigrok::Meta> meta);
241
242         void feed_in_trigger();
243
244         void feed_in_frame_begin();
245         void feed_in_frame_end();
246
247         void feed_in_logic(shared_ptr<sigrok::Logic> logic);
248
249         void feed_in_analog(shared_ptr<sigrok::Analog> analog);
250
251         void data_feed_in(shared_ptr<sigrok::Device> device,
252                 shared_ptr<sigrok::Packet> packet);
253
254 Q_SIGNALS:
255         void capture_state_changed(int state);
256         void device_changed();
257
258         void signals_changed();
259
260         void name_changed();
261
262         void trigger_event(int segment_id, util::Timestamp location);
263
264         void new_segment(int new_segment_id);
265         void segment_completed(int segment_id);
266
267         void data_received();
268
269         void add_view(views::ViewType type, Session *session);
270
271 public Q_SLOTS:
272         void on_data_saved();
273
274 #ifdef ENABLE_DECODE
275         void on_new_decoders_selected(vector<const srd_decoder*> decoders);
276 #endif
277
278 private:
279         DeviceManager &device_manager_;
280         shared_ptr<devices::Device> device_;
281         QString default_name_, name_;
282
283         list< shared_ptr<views::ViewBase> > views_;
284         shared_ptr<pv::views::ViewBase> main_view_;
285
286         shared_ptr<pv::toolbars::MainBar> main_bar_;
287
288         mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
289         capture_state capture_state_;
290
291         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
292         unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
293
294         /// trigger_list_ contains pairs of <segment_id, timestamp> values.
295         vector< std::pair<uint32_t, util::Timestamp> > trigger_list_;
296
297         mutable recursive_mutex data_mutex_;
298         shared_ptr<data::Logic> logic_data_;
299         uint64_t cur_samplerate_;
300         shared_ptr<data::LogicSegment> cur_logic_segment_;
301         map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
302                 cur_analog_segments_;
303         int32_t highest_segment_id_;
304
305         std::thread sampling_thread_;
306
307         bool out_of_memory_;
308         bool data_saved_;
309         bool frame_began_;
310
311         QElapsedTimer acq_time_;
312
313 #ifdef ENABLE_FLOW
314         RefPtr<Pipeline> pipeline_;
315         RefPtr<Element> source_;
316         RefPtr<AppSink> sink_;
317
318         mutable mutex pipeline_done_mutex_;
319         mutable condition_variable pipeline_done_cond_;
320         atomic<bool> pipeline_done_interrupt_;
321 #endif
322 };
323
324 } // namespace pv
325
326 #endif // PULSEVIEW_PV_SESSION_HPP