2 * This file is part of the PulseView project.
4 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_SESSION_HPP
21 #define PULSEVIEW_PV_SESSION_HPP
25 #include <condition_variable>
35 #include <unordered_set>
41 #include <QElapsedTimer>
44 #include <gstreamermm.h>
45 #include <libsigrokflow/libsigrokflow.hpp>
48 #include "metadata_obj.hpp"
50 #include "views/viewbase.hpp"
55 using std::recursive_mutex;
56 using std::shared_ptr;
58 using std::unordered_set;
112 class Session : public QObject
123 static shared_ptr<sigrok::Context> sr_context;
126 Session(DeviceManager &device_manager, QString name);
130 DeviceManager& device_manager();
132 const DeviceManager& device_manager() const;
134 shared_ptr<sigrok::Session> session() const;
136 shared_ptr<devices::Device> device() const;
138 QString name() const;
139 void set_name(QString name);
141 const vector< shared_ptr<views::ViewBase> > views() const;
143 shared_ptr<views::ViewBase> main_view() const;
144 shared_ptr<pv::toolbars::MainBar> main_bar() const;
145 void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
148 * Indicates whether the captured data was saved to disk already or not
150 bool data_saved() const;
152 void save_setup(QSettings &settings) const;
153 void save_settings(QSettings &settings) const;
154 void restore_setup(QSettings &settings);
155 void restore_settings(QSettings &settings);
158 * Attempts to set device instance, may fall back to demo if needed
160 void select_device(shared_ptr<devices::Device> device);
163 * Sets device instance that will be used in the next capture session.
165 void set_device(shared_ptr<devices::Device> device);
166 void set_default_device();
167 bool using_file_device() const;
169 void load_init_file(const string &file_name, const string &format,
170 const string &setup_file_name);
172 void load_file(QString file_name, QString setup_file_name = QString(),
173 shared_ptr<sigrok::InputFormat> format = nullptr,
174 const map<string, Glib::VariantBase> &options =
175 map<string, Glib::VariantBase>());
177 capture_state get_capture_state() const;
178 void start_capture(function<void (const QString)> error_handler);
181 double get_samplerate() const;
183 uint32_t get_segment_count() const;
185 vector<util::Timestamp> get_triggers(uint32_t segment_id) const;
187 void register_view(shared_ptr<views::ViewBase> view);
188 void deregister_view(shared_ptr<views::ViewBase> view);
189 bool has_view(shared_ptr<views::ViewBase> view);
191 const vector< shared_ptr<data::SignalBase> > signalbases() const;
193 bool all_segments_complete(uint32_t segment_id) const;
196 shared_ptr<data::DecodeSignal> add_decode_signal();
198 void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
201 MetadataObjManager* metadata_obj_manager();
204 void set_capture_state(capture_state state);
206 void update_signals();
208 shared_ptr<data::SignalBase> signalbase_from_channel(
209 shared_ptr<sigrok::Channel> channel) const;
211 static map<string, Glib::VariantBase> input_format_options(
212 vector<string> user_spec,
213 map<string, shared_ptr<Option>> fmt_opts);
215 void sample_thread_proc(function<void (const QString)> error_handler);
217 void free_unused_memory();
219 void signal_new_segment();
220 void signal_segment_completed();
223 bool on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message);
225 Gst::FlowReturn on_gst_new_sample();
228 void feed_in_header();
229 void feed_in_meta(shared_ptr<sigrok::Meta> meta);
230 void feed_in_trigger();
231 void feed_in_frame_begin();
232 void feed_in_frame_end();
233 void feed_in_logic(shared_ptr<sigrok::Logic> logic);
234 void feed_in_analog(shared_ptr<sigrok::Analog> analog);
236 void data_feed_in(shared_ptr<sigrok::Device> device,
237 shared_ptr<sigrok::Packet> packet);
240 void capture_state_changed(int state);
241 void device_changed();
243 void signals_changed();
247 void trigger_event(int segment_id, util::Timestamp location);
249 void new_segment(int new_segment_id);
250 void segment_completed(int segment_id);
252 void data_received();
254 void add_view(views::ViewType type, Session *session);
257 void on_data_saved();
260 void on_new_decoders_selected(vector<const srd_decoder*> decoders);
264 DeviceManager &device_manager_;
265 shared_ptr<devices::Device> device_;
266 QString default_name_, name_;
268 vector< shared_ptr<views::ViewBase> > views_;
269 shared_ptr<pv::views::ViewBase> main_view_;
271 shared_ptr<pv::toolbars::MainBar> main_bar_;
273 mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
274 capture_state capture_state_;
276 vector< shared_ptr<data::SignalBase> > signalbases_;
277 unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
279 /// trigger_list_ contains pairs of <segment_id, timestamp> values.
280 vector< std::pair<uint32_t, util::Timestamp> > trigger_list_;
282 mutable recursive_mutex data_mutex_;
283 shared_ptr<data::Logic> logic_data_;
284 uint64_t cur_samplerate_;
285 shared_ptr<data::LogicSegment> cur_logic_segment_;
286 map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
287 cur_analog_segments_;
288 int32_t highest_segment_id_;
290 std::thread sampling_thread_;
296 QElapsedTimer acq_time_;
298 MetadataObjManager metadata_obj_manager_;
301 RefPtr<Pipeline> pipeline_;
302 RefPtr<Element> source_;
303 RefPtr<AppSink> sink_;
305 mutable mutex pipeline_done_mutex_;
306 mutable condition_variable pipeline_done_cond_;
307 atomic<bool> pipeline_done_interrupt_;
313 #endif // PULSEVIEW_PV_SESSION_HPP