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