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>
41 #include <QElapsedTimer>
44 #include <gstreamermm.h>
45 #include <libsigrokflow/libsigrokflow.hpp>
48 #include "metadata_obj.hpp"
50 #include "views/viewbase.hpp"
56 using std::recursive_mutex;
57 using std::shared_ptr;
59 using std::unordered_set;
113 using pv::views::ViewType;
115 class Session : public QObject
126 static shared_ptr<sigrok::Context> sr_context;
129 Session(DeviceManager &device_manager, QString name);
133 DeviceManager& device_manager();
135 const DeviceManager& device_manager() const;
137 shared_ptr<sigrok::Session> session() const;
139 shared_ptr<devices::Device> device() const;
141 QString name() const;
142 void set_name(QString name);
144 QString save_path() const;
145 void set_save_path(QString path);
147 const vector< shared_ptr<views::ViewBase> > views() const;
149 shared_ptr<views::ViewBase> main_view() const;
150 shared_ptr<pv::toolbars::MainBar> main_bar() const;
151 void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
154 * Indicates whether the captured data was saved to disk already or not
156 bool data_saved() const;
158 void save_setup(QSettings &settings) const;
159 void save_settings(QSettings &settings) const;
160 void restore_setup(QSettings &settings);
161 void restore_settings(QSettings &settings);
164 * Attempts to set device instance, may fall back to demo if needed
166 void select_device(shared_ptr<devices::Device> device);
169 * Sets device instance that will be used in the next capture session.
171 void set_device(shared_ptr<devices::Device> device);
172 void set_default_device();
173 bool using_file_device() const;
175 void load_init_file(const string &file_name, const string &format,
176 const string &setup_file_name);
178 void load_file(QString file_name, QString setup_file_name = QString(),
179 shared_ptr<sigrok::InputFormat> format = nullptr,
180 const map<string, Glib::VariantBase> &options =
181 map<string, Glib::VariantBase>());
183 capture_state get_capture_state() const;
184 void start_capture(function<void (const QString)> error_handler);
187 double get_samplerate() const;
189 uint32_t get_highest_segment_id() const;
190 uint64_t get_segment_sample_count(uint32_t segment_id) const;
192 vector<util::Timestamp> get_triggers(uint32_t segment_id) const;
194 void register_view(shared_ptr<views::ViewBase> view);
195 void deregister_view(shared_ptr<views::ViewBase> view);
196 bool has_view(shared_ptr<views::ViewBase> view);
198 const vector< shared_ptr<data::SignalBase> > signalbases() const;
199 uint32_t get_signal_count(data::SignalBase::ChannelType type) const;
200 uint32_t get_next_signal_index(data::SignalBase::ChannelType type);
202 void add_generated_signal(shared_ptr<data::SignalBase> signal);
203 void remove_generated_signal(shared_ptr<data::SignalBase> signal);
206 shared_ptr<data::DecodeSignal> add_decode_signal();
208 void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
211 bool all_segments_complete(uint32_t segment_id) const;
213 MetadataObjManager* metadata_obj_manager();
216 void set_capture_state(capture_state state);
218 void update_signals();
220 shared_ptr<data::SignalBase> signalbase_from_channel(
221 shared_ptr<sigrok::Channel> channel) const;
223 static map<string, Glib::VariantBase> input_format_options(
224 vector<string> user_spec,
225 map<string, shared_ptr<Option>> fmt_opts);
227 void sample_thread_proc(function<void (const QString)> error_handler);
229 void free_unused_memory();
231 void signal_new_segment();
232 void signal_segment_completed();
235 bool on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message);
237 Gst::FlowReturn on_gst_new_sample();
240 void feed_in_header();
241 void feed_in_meta(shared_ptr<sigrok::Meta> meta);
242 void feed_in_trigger();
243 void feed_in_frame_begin();
244 void feed_in_frame_end();
245 void feed_in_logic(shared_ptr<sigrok::Logic> logic);
246 void feed_in_analog(shared_ptr<sigrok::Analog> analog);
248 void data_feed_in(shared_ptr<sigrok::Device> device,
249 shared_ptr<sigrok::Packet> packet);
252 void capture_state_changed(int state);
253 void device_changed();
255 void signals_changed();
259 void trigger_event(int segment_id, util::Timestamp location);
261 void new_segment(int new_segment_id);
262 void segment_completed(int segment_id);
264 void data_received();
266 void add_view(ViewType type, Session *session);
267 void session_error_raised(const QString text, const QString info_text);
270 void on_data_saved();
273 void on_new_decoders_selected(vector<const srd_decoder*> decoders);
279 DeviceManager &device_manager_;
280 shared_ptr<devices::Device> device_;
281 QString default_name_, name_, save_path_;
283 vector< shared_ptr<views::ViewBase> > views_;
284 shared_ptr<pv::views::ViewBase> main_view_;
286 shared_ptr<pv::toolbars::MainBar> main_bar_;
288 mutable mutex sampling_mutex_; //!< Protects access to capture_state_
289 capture_state capture_state_;
291 vector< shared_ptr<data::SignalBase> > signalbases_;
292 unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
293 deque<data::SignalGroup*> signal_groups_;
294 map<uint8_t, uint32_t> next_index_list_; // signal type -> index counter
296 /// trigger_list_ contains pairs of <segment_id, timestamp> values
297 vector< std::pair<uint32_t, util::Timestamp> > trigger_list_;
299 mutable recursive_mutex data_mutex_;
300 shared_ptr<data::Logic> logic_data_;
301 uint64_t cur_samplerate_;
302 shared_ptr<data::LogicSegment> cur_logic_segment_;
303 map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
304 cur_analog_segments_;
305 int32_t highest_segment_id_;
306 vector<uint64_t> segment_sample_count_;
308 std::thread sampling_thread_;
314 QElapsedTimer acq_time_;
316 MetadataObjManager metadata_obj_manager_;
319 RefPtr<Pipeline> pipeline_;
320 RefPtr<Element> source_;
321 RefPtr<AppSink> sink_;
323 mutable mutex pipeline_done_mutex_;
324 mutable condition_variable pipeline_done_cond_;
325 atomic<bool> pipeline_done_interrupt_;
331 #endif // PULSEVIEW_PV_SESSION_HPP