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 Logic;
  74 class LogicSegment;
  75 class SignalBase;
  76 class SignalData;
  77 }
  78
  79 namespace devices {
  80 class Device;
  81 }
  82
  83 namespace toolbars {
  84 class MainBar;
  85 }
  86
  87 namespace views {
  88 class ViewBase;
  89 }
  90
  91 class Session : public QObject
  92 {
  93         Q_OBJECT
  94
  95 public:
  96         enum capture_state {
  97                 Stopped,
  98                 AwaitingTrigger,
  99                 Running
 100         };
 101
 102 public:
 103         Session(DeviceManager &device_manager, QString name);
 104
 105         ~Session();
 106
 107         DeviceManager& device_manager();
 108
 109         const DeviceManager& device_manager() const;
 110
 111         shared_ptr<sigrok::Session> session() const;
 112
 113         shared_ptr<devices::Device> device() const;
 114
 115         QString name() const;
 116
 117         void set_name(QString name);
 118
 119         const list< shared_ptr<views::ViewBase> > views() const;
 120
 121         shared_ptr<views::ViewBase> main_view() const;
 122
 123         shared_ptr<pv::toolbars::MainBar> main_bar() const;
 124
 125         void set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar);
 126
 127         /**
 128          * Indicates whether the captured data was saved to disk already or not
 129          */
 130         bool data_saved() const;
 131
 132         void save_settings(QSettings &settings) const;
 133
 134         void restore_settings(QSettings &settings);
 135
 136         /**
 137          * Attempts to set device instance, may fall back to demo if needed
 138          */
 139         void select_device(shared_ptr<devices::Device> device);
 140
 141         /**
 142          * Sets device instance that will be used in the next capture session.
 143          */
 144         void set_device(shared_ptr<devices::Device> device);
 145
 146         void set_default_device();
 147
 148         void load_init_file(const string &file_name, const string &format);
 149
 150         void load_file(QString file_name,
 151                 shared_ptr<sigrok::InputFormat> format = nullptr,
 152                 const map<string, Glib::VariantBase> &options =
 153                         map<string, Glib::VariantBase>());
 154
 155         capture_state get_capture_state() const;
 156
 157         void start_capture(function<void (const QString)> error_handler);
 158
 159         void stop_capture();
 160
 161         double get_samplerate() const;
 162
 163         void register_view(shared_ptr<views::ViewBase> view);
 164
 165         void deregister_view(shared_ptr<views::ViewBase> view);
 166
 167         bool has_view(shared_ptr<views::ViewBase> view);
 168
 169         const unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
 170
 171 #ifdef ENABLE_DECODE
 172         bool add_decoder(srd_decoder *const dec);
 173
 174         void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
 175 #endif
 176
 177 private:
 178         void set_capture_state(capture_state state);
 179
 180         void update_signals();
 181
 182         shared_ptr<data::SignalBase> signalbase_from_channel(
 183                 shared_ptr<sigrok::Channel> channel) const;
 184
 185         static map<string, Glib::VariantBase> input_format_options(
 186                 vector<string> user_spec,
 187                 map<string, shared_ptr<Option>> fmt_opts);
 188
 189 private:
 190         void sample_thread_proc(function<void (const QString)> error_handler);
 191
 192         void free_unused_memory();
 193
 194         void feed_in_header();
 195
 196         void feed_in_meta(shared_ptr<sigrok::Meta> meta);
 197
 198         void feed_in_trigger();
 199
 200         void feed_in_frame_begin();
 201
 202         void feed_in_logic(shared_ptr<sigrok::Logic> logic);
 203
 204         void feed_in_analog(shared_ptr<sigrok::Analog> analog);
 205
 206         void data_feed_in(shared_ptr<sigrok::Device> device,
 207                 shared_ptr<sigrok::Packet> packet);
 208
 209 private:
 210         DeviceManager &device_manager_;
 211         shared_ptr<devices::Device> device_;
 212         QString default_name_, name_;
 213
 214         list< shared_ptr<views::ViewBase> > views_;
 215         shared_ptr<pv::views::ViewBase> main_view_;
 216
 217         shared_ptr<pv::toolbars::MainBar> main_bar_;
 218
 219         mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
 220         capture_state capture_state_;
 221
 222         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
 223         unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
 224
 225         mutable recursive_mutex data_mutex_;
 226         shared_ptr<data::Logic> logic_data_;
 227         uint64_t cur_samplerate_;
 228         shared_ptr<data::LogicSegment> cur_logic_segment_;
 229         map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
 230                 cur_analog_segments_;
 231
 232         std::thread sampling_thread_;
 233
 234         bool out_of_memory_;
 235         bool data_saved_;
 236
 237 Q_SIGNALS:
 238         void capture_state_changed(int state);
 239         void device_changed();
 240
 241         void signals_changed();
 242
 243         void name_changed();
 244
 245         void trigger_event(util::Timestamp location);
 246
 247         void frame_began();
 248
 249         void data_received();
 250
 251         void frame_ended();
 252
 253         void add_view(const QString &title, views::ViewType type,
 254                 Session *session);
 255
 256 public Q_SLOTS:
 257         void on_data_saved();
 258 };
 259
 260 } // namespace pv
 261
 262 #endif // PULSEVIEW_PV_SESSION_HPP