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