]> sigrok.org Git - pulseview.git/blame - pv/session.hpp
Prepare for generated signals
[pulseview.git] / pv / session.hpp
CommitLineData
2953961c 1/*
b3f22de0 2 * This file is part of the PulseView project.
2953961c 3 *
1bc6525b 4 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
2953961c
JH
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/>.
2953961c
JH
18 */
19
8e99ef96
JH
20#ifndef PULSEVIEW_PV_SESSION_HPP
21#define PULSEVIEW_PV_SESSION_HPP
2953961c 22
5f9a5209
SA
23#ifdef ENABLE_FLOW
24#include <atomic>
25#include <condition_variable>
26#endif
27
7671200b 28#include <functional>
708c5523 29#include <map>
f9abf97e 30#include <memory>
3b68d03d 31#include <mutex>
bfc9f61e 32#include <set>
28a4c9c5 33#include <string>
3b68d03d 34#include <thread>
e3f65ace 35#include <vector>
28a4c9c5 36
009e1503 37#include <QObject>
101e7a9b 38#include <QSettings>
f2edb557 39#include <QString>
5322d2d0 40#include <QElapsedTimer>
009e1503 41
5f9a5209
SA
42#ifdef ENABLE_FLOW
43#include <gstreamermm.h>
44#include <libsigrokflow/libsigrokflow.hpp>
45#endif
46
f2739bae 47#include "metadata_obj.hpp"
48257a69 48#include "util.hpp"
f4e57597 49#include "views/viewbase.hpp"
48257a69 50
6f925ba9 51using std::function;
6f925ba9
UH
52using std::map;
53using std::mutex;
54using std::recursive_mutex;
55using std::shared_ptr;
56using std::string;
57using std::unordered_set;
58
5f9a5209
SA
59#ifdef ENABLE_FLOW
60using Glib::RefPtr;
61using Gst::AppSink;
62using Gst::Element;
63using Gst::Pipeline;
64#endif
65
82c7f640 66struct srd_decoder;
8bd26d8b 67struct srd_channel;
82c7f640 68
e8d00928 69namespace sigrok {
7d80a651
JH
70class Analog;
71class Channel;
72class Device;
fd22c71c 73class InputFormat;
7d80a651
JH
74class Logic;
75class Meta;
724f29f3 76class Option;
fd22c71c 77class OutputFormat;
7d80a651
JH
78class Packet;
79class Session;
870ea3db 80} // namespace sigrok
e8d00928 81
724f29f3
GS
82using sigrok::Option;
83
51e77110
JH
84namespace pv {
85
dc0867ff
JH
86class DeviceManager;
87
1b1ec774
JH
88namespace data {
89class Analog;
f3d66e52 90class AnalogSegment;
ad908057 91class DecodeSignal;
1b1ec774 92class Logic;
f3d66e52 93class LogicSegment;
bf0edd2b 94class SignalBase;
02412f0b 95class SignalData;
1b1ec774 96}
8d634081 97
da30ecb7
JH
98namespace devices {
99class Device;
100}
101
0f8f8c18
SA
102namespace toolbars {
103class MainBar;
104}
105
f4e57597
SA
106namespace views {
107class ViewBase;
8d634081 108}
2953961c 109
f2739bae 110
2b81ae46 111class Session : public QObject
2953961c 112{
009e1503
JH
113 Q_OBJECT
114
5b7cf66c
JH
115public:
116 enum capture_state {
117 Stopped,
2b49eeb0 118 AwaitingTrigger,
5b7cf66c
JH
119 Running
120 };
121
419ec4e1
SA
122 static shared_ptr<sigrok::Context> sr_context;
123
2953961c 124public:
101e7a9b 125 Session(DeviceManager &device_manager, QString name);
2953961c 126
2b81ae46 127 ~Session();
2953961c 128
4cb0b033
JH
129 DeviceManager& device_manager();
130
131 const DeviceManager& device_manager() const;
132
6f925ba9 133 shared_ptr<sigrok::Session> session() const;
1f4caa77 134
6f925ba9 135 shared_ptr<devices::Device> device() const;
dc0867ff 136
101e7a9b 137 QString name() const;
101e7a9b
SA
138 void set_name(QString name);
139
2db6e874 140 const vector< shared_ptr<views::ViewBase> > views() const;
36a8185e 141
6f925ba9 142 shared_ptr<views::ViewBase> main_view() const;
6f925ba9 143 shared_ptr<pv::toolbars::MainBar> main_bar() const;
6f925ba9 144 void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
fd22c71c 145
5ccfc97e
SA
146 /**
147 * Indicates whether the captured data was saved to disk already or not
148 */
149 bool data_saved() const;
150
323715c4 151 void save_setup(QSettings &settings) const;
101e7a9b 152 void save_settings(QSettings &settings) const;
323715c4 153 void restore_setup(QSettings &settings);
101e7a9b
SA
154 void restore_settings(QSettings &settings);
155
fd22c71c
SA
156 /**
157 * Attempts to set device instance, may fall back to demo if needed
158 */
6f925ba9 159 void select_device(shared_ptr<devices::Device> device);
fd22c71c 160
d64d1596
JH
161 /**
162 * Sets device instance that will be used in the next capture session.
163 */
6f925ba9 164 void set_device(shared_ptr<devices::Device> device);
6fd0b639 165 void set_default_device();
31d1aca6
SA
166 bool using_file_device() const;
167
96dbf014 168 void load_init_file(const string &file_name, const string &format,
611c8625 169 const string &setup_file_name);
fd22c71c 170
96dbf014 171 void load_file(QString file_name, QString setup_file_name = QString(),
6f925ba9
UH
172 shared_ptr<sigrok::InputFormat> format = nullptr,
173 const map<string, Glib::VariantBase> &options =
174 map<string, Glib::VariantBase>());
fd22c71c 175
5b7cf66c 176 capture_state get_capture_state() const;
6f925ba9 177 void start_capture(function<void (const QString)> error_handler);
5b7cf66c
JH
178 void stop_capture();
179
2220e942
SA
180 double get_samplerate() const;
181
9009d9b5 182 uint32_t get_segment_count() const;
7f965464 183
7ea2a4ff
SA
184 vector<util::Timestamp> get_triggers(uint32_t segment_id) const;
185
6f925ba9 186 void register_view(shared_ptr<views::ViewBase> view);
6f925ba9 187 void deregister_view(shared_ptr<views::ViewBase> view);
6f925ba9 188 bool has_view(shared_ptr<views::ViewBase> view);
101e7a9b 189
56c4de9a 190 const vector< shared_ptr<data::SignalBase> > signalbases() const;
999869aa
SA
191 void add_generated_signal(shared_ptr<data::SignalBase> signal);
192 void remove_generated_signal(shared_ptr<data::SignalBase> signal);
e3f65ace 193
89914a86
SA
194 bool all_segments_complete(uint32_t segment_id) const;
195
269528f5 196#ifdef ENABLE_DECODE
e771b42d 197 shared_ptr<data::DecodeSignal> add_decode_signal();
82c7f640 198
ad908057 199 void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
269528f5 200#endif
c51482b3 201
f2739bae
SA
202 MetadataObjManager* metadata_obj_manager();
203
6ac96c2e
JH
204private:
205 void set_capture_state(capture_state state);
206
ffe00119 207 void update_signals();
b087ba7f 208
6f925ba9
UH
209 shared_ptr<data::SignalBase> signalbase_from_channel(
210 shared_ptr<sigrok::Channel> channel) const;
3ddcc083 211
724f29f3
GS
212 static map<string, Glib::VariantBase> input_format_options(
213 vector<string> user_spec,
214 map<string, shared_ptr<Option>> fmt_opts);
215
6f925ba9 216 void sample_thread_proc(function<void (const QString)> error_handler);
2e2946fe 217
5e6967cb
SA
218 void free_unused_memory();
219
4e86ec70 220 void signal_new_segment();
558ad6ce 221 void signal_segment_completed();
4e86ec70 222
5f9a5209
SA
223#ifdef ENABLE_FLOW
224 bool on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message);
225
226 Gst::FlowReturn on_gst_new_sample();
227#endif
228
da30ecb7 229 void feed_in_header();
6f925ba9 230 void feed_in_meta(shared_ptr<sigrok::Meta> meta);
48257a69 231 void feed_in_trigger();
82f50b10 232 void feed_in_frame_begin();
837bb15a 233 void feed_in_frame_end();
6f925ba9 234 void feed_in_logic(shared_ptr<sigrok::Logic> logic);
6f925ba9 235 void feed_in_analog(shared_ptr<sigrok::Analog> analog);
2953961c 236
6f925ba9
UH
237 void data_feed_in(shared_ptr<sigrok::Device> device,
238 shared_ptr<sigrok::Packet> packet);
2953961c 239
056f443e
SA
240Q_SIGNALS:
241 void capture_state_changed(int state);
242 void device_changed();
243
244 void signals_changed();
245
246 void name_changed();
247
7ea2a4ff 248 void trigger_event(int segment_id, util::Timestamp location);
056f443e
SA
249
250 void new_segment(int new_segment_id);
251 void segment_completed(int segment_id);
252
253 void data_received();
254
baf867ed 255 void add_view(views::ViewType type, Session *session);
056f443e
SA
256
257public Q_SLOTS:
258 void on_data_saved();
259
97378470
SA
260#ifdef ENABLE_DECODE
261 void on_new_decoders_selected(vector<const srd_decoder*> decoders);
262#endif
263
2953961c 264private:
8dbbc7f0 265 DeviceManager &device_manager_;
6f925ba9 266 shared_ptr<devices::Device> device_;
101e7a9b 267 QString default_name_, name_;
d64d1596 268
2db6e874 269 vector< shared_ptr<views::ViewBase> > views_;
6f925ba9 270 shared_ptr<pv::views::ViewBase> main_view_;
0f8f8c18 271
6f925ba9 272 shared_ptr<pv::toolbars::MainBar> main_bar_;
47e9e7bb 273
578d0735 274 mutable mutex sampling_mutex_; //!< Protects access to capture_state_
8dbbc7f0 275 capture_state capture_state_;
5b7cf66c 276
56c4de9a 277 vector< shared_ptr<data::SignalBase> > signalbases_;
6f925ba9 278 unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
3868e5fa 279
578d0735 280 /// trigger_list_ contains pairs of <segment_id, timestamp> values
7ea2a4ff
SA
281 vector< std::pair<uint32_t, util::Timestamp> > trigger_list_;
282
6f925ba9
UH
283 mutable recursive_mutex data_mutex_;
284 shared_ptr<data::Logic> logic_data_;
ff008de6 285 uint64_t cur_samplerate_;
6f925ba9
UH
286 shared_ptr<data::LogicSegment> cur_logic_segment_;
287 map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
f3d66e52 288 cur_analog_segments_;
4e86ec70 289 int32_t highest_segment_id_;
009e1503 290
8dbbc7f0 291 std::thread sampling_thread_;
2e2946fe 292
e7216ae0 293 bool out_of_memory_;
5ccfc97e 294 bool data_saved_;
837bb15a 295 bool frame_began_;
5f9a5209 296
5322d2d0 297 QElapsedTimer acq_time_;
268fd2b8 298
f2739bae
SA
299 MetadataObjManager metadata_obj_manager_;
300
5f9a5209
SA
301#ifdef ENABLE_FLOW
302 RefPtr<Pipeline> pipeline_;
303 RefPtr<Element> source_;
304 RefPtr<AppSink> sink_;
305
306 mutable mutex pipeline_done_mutex_;
307 mutable condition_variable pipeline_done_cond_;
308 atomic<bool> pipeline_done_interrupt_;
309#endif
2953961c
JH
310};
311
51e77110
JH
312} // namespace pv
313
8e99ef96 314#endif // PULSEVIEW_PV_SESSION_HPP