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