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