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