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