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