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 #include <boost/thread/shared_mutex.hpp>
  38
  39 #include <QObject>
  40 #include <QSettings>
  41 #include <QString>
  42
  43 #include "util.hpp"
  44 #include "views/viewbase.hpp"
  45
  46 struct srd_decoder;
  47 struct srd_channel;
  48
  49 namespace sigrok {
  50 class Analog;
  51 class Channel;
  52 class Device;
  53 class InputFormat;
  54 class Logic;
  55 class Meta;
  56 class OutputFormat;
  57 class Packet;
  58 class Session;
  59 }
  60
  61 namespace pv {
  62
  63 class DeviceManager;
  64
  65 namespace data {
  66 class Analog;
  67 class AnalogSegment;
  68 class Logic;
  69 class LogicSegment;
  70 class SignalBase;
  71 class SignalData;
  72 }
  73
  74 namespace devices {
  75 class Device;
  76 }
  77
  78 namespace toolbars {
  79 class MainBar;
  80 }
  81
  82 namespace views {
  83 class ViewBase;
  84 }
  85
  86 class Session : public QObject
  87 {
  88         Q_OBJECT
  89
  90 public:
  91         enum capture_state {
  92                 Stopped,
  93                 AwaitingTrigger,
  94                 Running
  95         };
  96
  97 public:
  98         Session(DeviceManager &device_manager, QString name);
  99
 100         ~Session();
 101
 102         DeviceManager& device_manager();
 103
 104         const DeviceManager& device_manager() const;
 105
 106         std::shared_ptr<sigrok::Session> session() const;
 107
 108         std::shared_ptr<devices::Device> device() const;
 109
 110         QString name() const;
 111
 112         void set_name(QString name);
 113
 114         const std::list< std::shared_ptr<views::ViewBase> > views() const;
 115
 116         std::shared_ptr<views::ViewBase> main_view() const;
 117
 118         std::shared_ptr<pv::toolbars::MainBar> main_bar() const;
 119
 120         void set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar);
 121
 122         /**
 123          * Indicates whether the captured data was saved to disk already or not
 124          */
 125         bool data_saved() const;
 126
 127         void save_settings(QSettings &settings) const;
 128
 129         void restore_settings(QSettings &settings);
 130
 131         /**
 132          * Attempts to set device instance, may fall back to demo if needed
 133          */
 134         void select_device(std::shared_ptr<devices::Device> device);
 135
 136         /**
 137          * Sets device instance that will be used in the next capture session.
 138          */
 139         void set_device(std::shared_ptr<devices::Device> device);
 140
 141         void set_default_device();
 142
 143         void load_init_file(const std::string &file_name,
 144                 const std::string &format);
 145
 146         void load_file(QString file_name,
 147                 std::shared_ptr<sigrok::InputFormat> format = nullptr,
 148                 const std::map<std::string, Glib::VariantBase> &options =
 149                         std::map<std::string, Glib::VariantBase>());
 150
 151         capture_state get_capture_state() const;
 152
 153         void start_capture(std::function<void (const QString)> error_handler);
 154
 155         void stop_capture();
 156
 157         double get_samplerate() const;
 158
 159         void register_view(std::shared_ptr<views::ViewBase> view);
 160
 161         void deregister_view(std::shared_ptr<views::ViewBase> view);
 162
 163         bool has_view(std::shared_ptr<views::ViewBase> view);
 164
 165         const std::unordered_set< std::shared_ptr<data::SignalBase> >
 166                 signalbases() const;
 167
 168 #ifdef ENABLE_DECODE
 169         bool add_decoder(srd_decoder *const dec);
 170
 171         void remove_decode_signal(std::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         std::shared_ptr<data::SignalBase> signalbase_from_channel(
 180                 std::shared_ptr<sigrok::Channel> channel) const;
 181
 182 private:
 183         void sample_thread_proc(std::function<void (const QString)> error_handler);
 184
 185         void free_unused_memory();
 186
 187         void feed_in_header();
 188
 189         void feed_in_meta(std::shared_ptr<sigrok::Meta> meta);
 190
 191         void feed_in_trigger();
 192
 193         void feed_in_frame_begin();
 194
 195         void feed_in_logic(std::shared_ptr<sigrok::Logic> logic);
 196
 197         void feed_in_analog(std::shared_ptr<sigrok::Analog> analog);
 198
 199         void data_feed_in(std::shared_ptr<sigrok::Device> device,
 200                 std::shared_ptr<sigrok::Packet> packet);
 201
 202 private:
 203         DeviceManager &device_manager_;
 204         std::shared_ptr<devices::Device> device_;
 205         QString default_name_, name_;
 206
 207         std::list< std::shared_ptr<views::ViewBase> > views_;
 208         std::shared_ptr<pv::views::ViewBase> main_view_;
 209
 210         std::shared_ptr<pv::toolbars::MainBar> main_bar_;
 211
 212         mutable std::mutex sampling_mutex_; //!< Protects access to capture_state_.
 213         capture_state capture_state_;
 214
 215         std::unordered_set< std::shared_ptr<data::SignalBase> > signalbases_;
 216         std::unordered_set< std::shared_ptr<data::SignalData> > all_signal_data_;
 217
 218         mutable std::recursive_mutex data_mutex_;
 219         std::shared_ptr<data::Logic> logic_data_;
 220         uint64_t cur_samplerate_;
 221         std::shared_ptr<data::LogicSegment> cur_logic_segment_;
 222         std::map< std::shared_ptr<sigrok::Channel>, std::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