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