pv/sigsession.h

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