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