Session: Query the device's sample rate when needed, not sooner
[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 #include <map>
24 #include <memory>
25 #include <mutex>
26 #include <set>
27 #include <string>
28 #include <thread>
29 #include <unordered_set>
30 #include <vector>
31
32 #include <QObject>
33 #include <QSettings>
34 #include <QString>
35
36 #include "util.hpp"
37 #include "views/viewbase.hpp"
38
39 using std::function;
40 using std::list;
41 using std::map;
42 using std::mutex;
43 using std::recursive_mutex;
44 using std::shared_ptr;
45 using std::string;
46 using std::unordered_set;
47
48 struct srd_decoder;
49 struct srd_channel;
50
51 namespace sigrok {
52 class Analog;
53 class Channel;
54 class Device;
55 class InputFormat;
56 class Logic;
57 class Meta;
58 class Option;
59 class OutputFormat;
60 class Packet;
61 class Session;
62 }  // namespace sigrok
63
64 using sigrok::Option;
65
66 namespace pv {
67
68 class DeviceManager;
69
70 namespace data {
71 class Analog;
72 class AnalogSegment;
73 class DecodeSignal;
74 class Logic;
75 class LogicSegment;
76 class SignalBase;
77 class SignalData;
78 }
79
80 namespace devices {
81 class Device;
82 }
83
84 namespace toolbars {
85 class MainBar;
86 }
87
88 namespace views {
89 class ViewBase;
90 }
91
92 class Session : public QObject
93 {
94         Q_OBJECT
95
96 public:
97         enum capture_state {
98                 Stopped,
99                 AwaitingTrigger,
100                 Running
101         };
102
103         static shared_ptr<sigrok::Context> sr_context;
104
105 public:
106         Session(DeviceManager &device_manager, QString name);
107
108         ~Session();
109
110         DeviceManager& device_manager();
111
112         const DeviceManager& device_manager() const;
113
114         shared_ptr<sigrok::Session> session() const;
115
116         shared_ptr<devices::Device> device() const;
117
118         QString name() const;
119
120         void set_name(QString name);
121
122         const list< shared_ptr<views::ViewBase> > views() const;
123
124         shared_ptr<views::ViewBase> main_view() const;
125
126         shared_ptr<pv::toolbars::MainBar> main_bar() const;
127
128         void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
129
130         /**
131          * Indicates whether the captured data was saved to disk already or not
132          */
133         bool data_saved() const;
134
135         void save_settings(QSettings &settings) const;
136
137         void restore_settings(QSettings &settings);
138
139         /**
140          * Attempts to set device instance, may fall back to demo if needed
141          */
142         void select_device(shared_ptr<devices::Device> device);
143
144         /**
145          * Sets device instance that will be used in the next capture session.
146          */
147         void set_device(shared_ptr<devices::Device> device);
148
149         void set_default_device();
150
151         void load_init_file(const string &file_name, const string &format);
152
153         void load_file(QString file_name,
154                 shared_ptr<sigrok::InputFormat> format = nullptr,
155                 const map<string, Glib::VariantBase> &options =
156                         map<string, Glib::VariantBase>());
157
158         capture_state get_capture_state() const;
159
160         void start_capture(function<void (const QString)> error_handler);
161
162         void stop_capture();
163
164         double get_samplerate() const;
165
166         int get_segment_count() const;
167
168         void register_view(shared_ptr<views::ViewBase> view);
169
170         void deregister_view(shared_ptr<views::ViewBase> view);
171
172         bool has_view(shared_ptr<views::ViewBase> view);
173
174         const unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
175
176 #ifdef ENABLE_DECODE
177         shared_ptr<data::DecodeSignal> add_decode_signal();
178
179         void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
180 #endif
181
182 private:
183         void set_capture_state(capture_state state);
184
185         void update_signals();
186
187         shared_ptr<data::SignalBase> signalbase_from_channel(
188                 shared_ptr<sigrok::Channel> channel) const;
189
190         static map<string, Glib::VariantBase> input_format_options(
191                 vector<string> user_spec,
192                 map<string, shared_ptr<Option>> fmt_opts);
193
194 private:
195         void sample_thread_proc(function<void (const QString)> error_handler);
196
197         void free_unused_memory();
198
199         void feed_in_header();
200
201         void feed_in_meta(shared_ptr<sigrok::Meta> meta);
202
203         void feed_in_trigger();
204
205         void feed_in_frame_begin();
206         void feed_in_frame_end();
207
208         void feed_in_logic(shared_ptr<sigrok::Logic> logic);
209
210         void feed_in_analog(shared_ptr<sigrok::Analog> analog);
211
212         void data_feed_in(shared_ptr<sigrok::Device> device,
213                 shared_ptr<sigrok::Packet> packet);
214
215 private:
216         DeviceManager &device_manager_;
217         shared_ptr<devices::Device> device_;
218         QString default_name_, name_;
219
220         list< shared_ptr<views::ViewBase> > views_;
221         shared_ptr<pv::views::ViewBase> main_view_;
222
223         shared_ptr<pv::toolbars::MainBar> main_bar_;
224
225         mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
226         capture_state capture_state_;
227
228         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
229         unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
230
231         mutable recursive_mutex data_mutex_;
232         shared_ptr<data::Logic> logic_data_;
233         uint64_t cur_samplerate_;
234         shared_ptr<data::LogicSegment> cur_logic_segment_;
235         map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
236                 cur_analog_segments_;
237
238         std::thread sampling_thread_;
239
240         bool out_of_memory_;
241         bool data_saved_;
242         bool frame_began_;
243
244 Q_SIGNALS:
245         void capture_state_changed(int state);
246         void device_changed();
247
248         void signals_changed();
249
250         void name_changed();
251
252         void trigger_event(util::Timestamp location);
253
254         void frame_began();
255
256         void data_received();
257
258         void frame_ended();
259
260         void add_view(const QString &title, views::ViewType type,
261                 Session *session);
262
263 public Q_SLOTS:
264         void on_data_saved();
265 };
266
267 } // namespace pv
268
269 #endif // PULSEVIEW_PV_SESSION_HPP