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 #ifdef _WIN32
  33 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
  34 #define NOGDI
  35 #define NORESOURCE
  36 #endif
  37
  38 #include <QObject>
  39 #include <QSettings>
  40 #include <QString>
  41
  42 #include "util.hpp"
  43 #include "views/viewbase.hpp"
  44
  45 using std::function;
  46 using std::list;
  47 using std::map;
  48 using std::mutex;
  49 using std::recursive_mutex;
  50 using std::shared_ptr;
  51 using std::string;
  52 using std::unordered_set;
  53
  54 struct srd_decoder;
  55 struct srd_channel;
  56
  57 namespace sigrok {
  58 class Analog;
  59 class Channel;
  60 class Device;
  61 class InputFormat;
  62 class Logic;
  63 class Meta;
  64 class OutputFormat;
  65 class Packet;
  66 class Session;
  67 }  // namespace sigrok
  68
  69 namespace pv {
  70
  71 class DeviceManager;
  72
  73 namespace data {
  74 class Analog;
  75 class AnalogSegment;
  76 class Logic;
  77 class LogicSegment;
  78 class SignalBase;
  79 class SignalData;
  80 }
  81
  82 namespace devices {
  83 class Device;
  84 }
  85
  86 namespace toolbars {
  87 class MainBar;
  88 }
  89
  90 namespace views {
  91 class ViewBase;
  92 }
  93
  94 class Session : public QObject
  95 {
  96         Q_OBJECT
  97
  98 public:
  99         enum capture_state {
 100                 Stopped,
 101                 AwaitingTrigger,
 102                 Running
 103         };
 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         void register_view(shared_ptr<views::ViewBase> view);
 167
 168         void deregister_view(shared_ptr<views::ViewBase> view);
 169
 170         bool has_view(shared_ptr<views::ViewBase> view);
 171
 172         const unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
 173
 174 #ifdef ENABLE_DECODE
 175         bool add_decoder(srd_decoder *const dec);
 176
 177         void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
 178 #endif
 179
 180 private:
 181         void set_capture_state(capture_state state);
 182
 183         void update_signals();
 184
 185         shared_ptr<data::SignalBase> signalbase_from_channel(
 186                 shared_ptr<sigrok::Channel> channel) const;
 187
 188 private:
 189         void sample_thread_proc(function<void (const QString)> error_handler);
 190
 191         void free_unused_memory();
 192
 193         void feed_in_header();
 194
 195         void feed_in_meta(shared_ptr<sigrok::Meta> meta);
 196
 197         void feed_in_trigger();
 198
 199         void feed_in_frame_begin();
 200
 201         void feed_in_logic(shared_ptr<sigrok::Logic> logic);
 202
 203         void feed_in_analog(shared_ptr<sigrok::Analog> analog);
 204
 205         void data_feed_in(shared_ptr<sigrok::Device> device,
 206                 shared_ptr<sigrok::Packet> packet);
 207
 208 private:
 209         DeviceManager &device_manager_;
 210         shared_ptr<devices::Device> device_;
 211         QString default_name_, name_;
 212
 213         list< shared_ptr<views::ViewBase> > views_;
 214         shared_ptr<pv::views::ViewBase> main_view_;
 215
 216         shared_ptr<pv::toolbars::MainBar> main_bar_;
 217
 218         mutable mutex sampling_mutex_; //!< Protects access to capture_state_.
 219         capture_state capture_state_;
 220
 221         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
 222         unordered_set< shared_ptr<data::SignalData> > all_signal_data_;
 223
 224         mutable recursive_mutex data_mutex_;
 225         shared_ptr<data::Logic> logic_data_;
 226         uint64_t cur_samplerate_;
 227         shared_ptr<data::LogicSegment> cur_logic_segment_;
 228         map< shared_ptr<sigrok::Channel>, shared_ptr<data::AnalogSegment> >
 229                 cur_analog_segments_;
 230
 231         std::thread sampling_thread_;
 232
 233         bool out_of_memory_;
 234         bool data_saved_;
 235
 236 Q_SIGNALS:
 237         void capture_state_changed(int state);
 238         void device_changed();
 239
 240         void signals_changed();
 241
 242         void name_changed();
 243
 244         void trigger_event(util::Timestamp location);
 245
 246         void frame_began();
 247
 248         void data_received();
 249
 250         void frame_ended();
 251
 252         void add_view(const QString &title, views::ViewType type,
 253                 Session *session);
 254
 255 public Q_SLOTS:
 256         void on_data_saved();
 257 };
 258
 259 } // namespace pv
 260
 261 #endif // PULSEVIEW_PV_SESSION_HPP