SamplingBar: Show total sampling time in a tooltip.
[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_channel;
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                 throw(QString);
86
87         void set_file(const std::string &name)
88                 throw(QString);
89
90         void set_default_device();
91
92         void release_device(device::DevInst *dev_inst);
93
94         capture_state get_capture_state() const;
95
96         void start_capture(boost::function<void (const QString)> error_handler);
97
98         void stop_capture();
99
100         std::set< boost::shared_ptr<data::SignalData> > get_data() const;
101
102         std::vector< boost::shared_ptr<view::Signal> >
103                 get_signals() const;
104
105 #ifdef ENABLE_DECODE
106         bool add_decoder(srd_decoder *const dec);
107
108         std::vector< boost::shared_ptr<view::DecodeTrace> >
109                 get_decode_signals() const;
110
111         void remove_decode_signal(view::DecodeTrace *signal);
112 #endif
113
114 private:
115         void set_capture_state(capture_state state);
116
117         void update_signals(boost::shared_ptr<device::DevInst> dev_inst);
118
119         boost::shared_ptr<view::Signal> signal_from_probe(
120                 const sr_channel *probe) const;
121
122         void read_sample_rate(const sr_dev_inst *const sdi);
123
124 private:
125         /**
126          * Attempts to autodetect the format. Failing that
127          * @param filename The filename of the input file.
128          * @return A pointer to the 'struct sr_input_format' that should be
129          *      used, or NULL if no input format was selected or
130          *      auto-detected.
131          */
132         static sr_input_format* determine_input_file_format(
133                 const std::string &filename);
134
135         static sr_input* load_input_file_format(
136                 const std::string &filename,
137                 boost::function<void (const QString)> error_handler,
138                 sr_input_format *format = NULL);
139
140         void sample_thread_proc(boost::shared_ptr<device::DevInst> dev_inst,
141                 boost::function<void (const QString)> error_handler);
142
143         void feed_in_header(const sr_dev_inst *sdi);
144
145         void feed_in_meta(const sr_dev_inst *sdi,
146                 const sr_datafeed_meta &meta);
147
148         void feed_in_frame_begin();
149
150         void feed_in_logic(const sr_datafeed_logic &logic);
151
152         void feed_in_analog(const sr_datafeed_analog &analog);
153
154         void data_feed_in(const struct sr_dev_inst *sdi,
155                 const struct sr_datafeed_packet *packet);
156
157         static void data_feed_in_proc(const struct sr_dev_inst *sdi,
158                 const struct sr_datafeed_packet *packet, void *cb_data);
159
160 private:
161         DeviceManager &_device_manager;
162
163         /**
164          * The device instance that will be used in the next capture session.
165          */
166         boost::shared_ptr<device::DevInst> _dev_inst;
167
168         std::vector< boost::shared_ptr<view::DecodeTrace> > _decode_traces;
169
170         mutable boost::mutex _sampling_mutex;
171         capture_state _capture_state;
172
173         mutable boost::mutex _signals_mutex;
174         std::vector< boost::shared_ptr<view::Signal> > _signals;
175
176         mutable boost::mutex _data_mutex;
177         boost::shared_ptr<data::Logic> _logic_data;
178         boost::shared_ptr<data::LogicSnapshot> _cur_logic_snapshot;
179         std::map< const sr_channel*, boost::shared_ptr<data::AnalogSnapshot> >
180                 _cur_analog_snapshots;
181
182         boost::thread _sampling_thread;
183
184 signals:
185         void capture_state_changed(int state);
186
187         void signals_changed();
188
189         void frame_began();
190
191         void data_received();
192
193         void frame_ended();
194
195 private:
196         // TODO: This should not be necessary. Multiple concurrent
197         // sessions should should be supported and it should be
198         // possible to associate a pointer with a sr_session.
199         static SigSession *_session;
200 };
201
202 } // namespace pv
203
204 #endif // PULSEVIEW_PV_SIGSESSION_H