pv/sigsession.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef PULSEVIEW_PV_SIGSESSION_H
  22 #define PULSEVIEW_PV_SIGSESSION_H
  23
  24 #include <boost/function.hpp>
  25 #include <boost/shared_ptr.hpp>
  26 #include <boost/thread.hpp>
  27
  28 #include <string>
  29 #include <utility>
  30 #include <vector>
  31
  32 #include <QObject>
  33 #include <QString>
  34
  35 #include <libsigrok/libsigrok.h>
  36
  37 namespace pv {
  38
  39 class DeviceManager;
  40
  41 namespace data {
  42 class Analog;
  43 class AnalogSnapshot;
  44 class Logic;
  45 class LogicSnapshot;
  46 }
  47
  48 namespace view {
  49 class Signal;
  50 }
  51
  52 class SigSession : public QObject
  53 {
  54         Q_OBJECT
  55
  56 public:
  57         enum capture_state {
  58                 Stopped,
  59                 AwaitingTrigger,
  60                 Running
  61         };
  62
  63 public:
  64         SigSession(DeviceManager &device_manager);
  65
  66         ~SigSession();
  67
  68         struct sr_dev_inst* get_device() const;
  69
  70         /**
  71          * Sets device instance that will be used in the next capture session.
  72          */
  73         void set_device(struct sr_dev_inst *sdi);
  74
  75         void release_device(struct sr_dev_inst *sdi);
  76
  77         void load_file(const std::string &name,
  78                 boost::function<void (const QString)> error_handler);
  79
  80         capture_state get_capture_state() const;
  81
  82         void start_capture(uint64_t record_length,
  83                 boost::function<void (const QString)> error_handler);
  84
  85         void stop_capture();
  86
  87         std::vector< boost::shared_ptr<view::Signal> >
  88                 get_signals();
  89
  90         boost::shared_ptr<data::Logic> get_data();
  91
  92 private:
  93         void set_capture_state(capture_state state);
  94
  95         void update_signals(const sr_dev_inst *const sdi);
  96
  97         bool is_trigger_enabled() const;
  98
  99         void read_sample_rate(const sr_dev_inst *const sdi);
 100
 101 private:
 102         /**
 103          * Attempts to autodetect the format. Failing that
 104          * @param filename The filename of the input file.
 105          * @return A pointer to the 'struct sr_input_format' that should be
 106          *      used, or NULL if no input format was selected or
 107          *      auto-detected.
 108          */
 109         static sr_input_format* determine_input_file_format(
 110                 const std::string &filename);
 111
 112         static sr_input* load_input_file_format(
 113                 const std::string &filename,
 114                 boost::function<void (const QString)> error_handler,
 115                 sr_input_format *format = NULL);
 116
 117         void load_session_thread_proc(
 118                 boost::function<void (const QString)> error_handler);
 119
 120         void load_input_thread_proc(const std::string name, sr_input *in,
 121                 boost::function<void (const QString)> error_handler);
 122
 123         void sample_thread_proc(struct sr_dev_inst *sdi,
 124                 uint64_t record_length,
 125                 boost::function<void (const QString)> error_handler);
 126
 127         void feed_in_header(const sr_dev_inst *sdi);
 128
 129         void feed_in_meta(const sr_dev_inst *sdi,
 130                 const sr_datafeed_meta &meta);
 131
 132         void feed_in_logic(const sr_datafeed_logic &logic);
 133
 134         void feed_in_analog(const sr_datafeed_analog &analog);
 135
 136         void data_feed_in(const struct sr_dev_inst *sdi,
 137                 const struct sr_datafeed_packet *packet);
 138
 139         static void data_feed_in_proc(const struct sr_dev_inst *sdi,
 140                 const struct sr_datafeed_packet *packet, void *cb_data);
 141
 142 private:
 143         DeviceManager &_device_manager;
 144
 145         /**
 146          * The device instance that will be used in the next capture session.
 147          */
 148         struct sr_dev_inst *_sdi;
 149
 150         mutable boost::mutex _sampling_mutex;
 151         capture_state _capture_state;
 152
 153         mutable boost::mutex _signals_mutex;
 154         std::vector< boost::shared_ptr<view::Signal> > _signals;
 155
 156         mutable boost::mutex _data_mutex;
 157         boost::shared_ptr<data::Logic> _logic_data;
 158         boost::shared_ptr<data::LogicSnapshot> _cur_logic_snapshot;
 159         boost::shared_ptr<data::Analog> _analog_data;
 160         boost::shared_ptr<data::AnalogSnapshot> _cur_analog_snapshot;
 161
 162         std::auto_ptr<boost::thread> _sampling_thread;
 163
 164 signals:
 165         void capture_state_changed(int state);
 166
 167         void signals_changed();
 168
 169         void data_updated();
 170
 171 private:
 172         // TODO: This should not be necessary. Multiple concurrent
 173         // sessions should should be supported and it should be
 174         // possible to associate a pointer with a sr_session.
 175         static SigSession *_session;
 176 };
 177
 178 } // namespace pv
 179
 180 #endif // PULSEVIEW_PV_SIGSESSION_H