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
  42 #ifdef ENABLE_FLOW
  43 #include <gstreamermm.h>
  44 #include <libsigrokflow/libsigrokflow.hpp>
  45 #endif
  46
  47 #include "util.hpp"
  48 #include "views/viewbase.hpp"
  49
  50
  51 using std::function;
  52 using std::list;
  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 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
 139         void set_name(QString name);
 140
 141         const list< shared_ptr<views::ViewBase> > views() const;
 142
 143         shared_ptr<views::ViewBase> main_view() const;
 144
 145         shared_ptr<pv::toolbars::MainBar> main_bar() const;
 146
 147         void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
 148
 149         /**
 150          * Indicates whether the captured data was saved to disk already or not
 151          */
 152         bool data_saved() const;
 153
 154         void save_setup(QSettings &settings) const;
 155
 156         void save_settings(QSettings &settings) const;
 157
 158         void restore_setup(QSettings &settings);
 159
 160         void restore_settings(QSettings &settings);
 161
 162         /**
 163          * Attempts to set device instance, may fall back to demo if needed
 164          */
 165         void select_device(shared_ptr<devices::Device> device);
 166
 167         /**
 168          * Sets device instance that will be used in the next capture session.
 169          */
 170         void set_device(shared_ptr<devices::Device> device);
 171
 172         void set_default_device();
 173
 174         void load_init_file(const string &file_name, const string &format);
 175
 176         void load_file(QString file_name,
 177                 shared_ptr<sigrok::InputFormat> format = nullptr,
 178                 const map<string, Glib::VariantBase> &options =
 179                         map<string, Glib::VariantBase>());
 180
 181         capture_state get_capture_state() const;
 182
 183         void start_capture(function<void (const QString)> error_handler);
 184
 185         void stop_capture();
 186
 187         double get_samplerate() const;
 188
 189         uint32_t get_segment_count() const;
 190
 191         vector<util::Timestamp> get_triggers(uint32_t segment_id) const;
 192
 193         void register_view(shared_ptr<views::ViewBase> view);
 194
 195         void deregister_view(shared_ptr<views::ViewBase> view);
 196
 197         bool has_view(shared_ptr<views::ViewBase> view);
 198
 199         const unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
 200
 201         bool all_segments_complete(uint32_t segment_id) const;
 202
 203 #ifdef ENABLE_DECODE
 204         shared_ptr<data::DecodeSignal> add_decode_signal();
 205
 206         void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
 207 #endif
 208
 209 private:
 210         void set_capture_state(capture_state state);
 211
 212         void update_signals();
 213
 214         shared_ptr<data::SignalBase> signalbase_from_channel(
 215                 shared_ptr<sigrok::Channel> channel) const;
 216
 217         static map<string, Glib::VariantBase> input_format_options(
 218                 vector<string> user_spec,
 219                 map<string, shared_ptr<Option>> fmt_opts);
 220
 221         void sample_thread_proc(function<void (const QString)> error_handler);
 222
 223         void free_unused_memory();
 224
 225         void signal_new_segment();
 226         void signal_segment_completed();
 227
 228 #ifdef ENABLE_FLOW
 229         bool on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message);
 230
 231         Gst::FlowReturn on_gst_new_sample();
 232 #endif
 233
 234         void feed_in_header();
 235
 236         void feed_in_meta(shared_ptr<sigrok::Meta> meta);
 237
 238         void feed_in_trigger();
 239
 240         void feed_in_frame_begin();
 241         void feed_in_frame_end();
 242
 243         void feed_in_logic(shared_ptr<sigrok::Logic> logic);
 244
 245         void feed_in_analog(shared_ptr<sigrok::Analog> analog);
 246
 247         void data_feed_in(shared_ptr<sigrok::Device> device,
 248                 shared_ptr<sigrok::Packet> packet);
 249
 250 Q_SIGNALS:
 251         void capture_state_changed(int state);
 252         void device_changed();
 253
 254         void signals_changed();
 255
 256         void name_changed();
 257
 258         void trigger_event(int segment_id, util::Timestamp location);
 259
 260         void new_segment(int new_segment_id);
 261         void segment_completed(int segment_id);
 262
 263         void data_received();
 264
 265         void add_view(const QString &title, views::ViewType type,
 266                 Session *session);
 267
 268 public Q_SLOTS:
 269         void on_data_saved();
 270
 271 private:
 272         DeviceManager &device_manager_;
 273         shared_ptr<devices::Device> device_;
 274         QString default_name_, name_;
 275
 276         list< shared_ptr<views::ViewBase> > views_;
 277         shared_ptr<pv::views::ViewBase> main_view_;
 278
 279         shared_ptr<pv::toolbars::MainBar> main_bar_;
 280
 281         mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
 282         capture_state capture_state_;
 283
 284         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
 285         unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
 286
 287         /// trigger_list_ contains pairs of <segment_id, timestamp> values.
 288         vector< std::pair<uint32_t, util::Timestamp> > trigger_list_;
 289
 290         mutable recursive_mutex data_mutex_;
 291         shared_ptr<data::Logic> logic_data_;
 292         uint64_t cur_samplerate_;
 293         shared_ptr<data::LogicSegment> cur_logic_segment_;
 294         map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
 295                 cur_analog_segments_;
 296         int32_t highest_segment_id_;
 297
 298         std::thread sampling_thread_;
 299
 300         bool out_of_memory_;
 301         bool data_saved_;
 302         bool frame_began_;
 303
 304 #ifdef ENABLE_FLOW
 305         RefPtr<Pipeline> pipeline_;
 306         RefPtr<Element> source_;
 307         RefPtr<AppSink> sink_;
 308
 309         mutable mutex pipeline_done_mutex_;
 310         mutable condition_variable pipeline_done_cond_;
 311         atomic<bool> pipeline_done_interrupt_;
 312 #endif
 313 };
 314
 315 } // namespace pv
 316
 317 #endif // PULSEVIEW_PV_SESSION_HPP