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