MainWindow: Fix crash on closing last session
[pulseview.git] / pv / session.hpp
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_SESSION_HPP
22 #define PULSEVIEW_PV_SESSION_HPP
23
24 #include <map>
25 #include <memory>
26 #include <mutex>
27 #include <set>
28 #include <string>
29 #include <thread>
30 #include <unordered_set>
31 #include <vector>
32
33 #ifdef _WIN32
34 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
35 #define NOGDI
36 #define NORESOURCE
37 #endif
38 #include <boost/thread/shared_mutex.hpp>
39
40 #include <QObject>
41 #include <QSettings>
42 #include <QString>
43
44 #include "util.hpp"
45 #include "view/viewwidget.hpp"
46
47 struct srd_decoder;
48 struct srd_channel;
49
50 namespace sigrok {
51 class Analog;
52 class Channel;
53 class Device;
54 class Logic;
55 class Meta;
56 class Packet;
57 class Session;
58 }
59
60 namespace pv {
61
62 class DeviceManager;
63
64 namespace data {
65 class Analog;
66 class AnalogSegment;
67 class Logic;
68 class LogicSegment;
69 class SignalBase;
70 class SignalData;
71 }
72
73 namespace devices {
74 class Device;
75 }
76
77 namespace toolbars {
78 class MainBar;
79 }
80
81 namespace view {
82 class View;
83 }
84
85 class Session : public QObject
86 {
87         Q_OBJECT
88
89 public:
90         enum capture_state {
91                 Stopped,
92                 AwaitingTrigger,
93                 Running
94         };
95
96 public:
97         Session(DeviceManager &device_manager, QString name);
98
99         ~Session();
100
101         DeviceManager& device_manager();
102
103         const DeviceManager& device_manager() const;
104
105         std::shared_ptr<sigrok::Session> session() const;
106
107         std::shared_ptr<devices::Device> device() const;
108
109         QString name() const;
110
111         void set_name(QString name);
112
113         const std::list< std::shared_ptr<pv::view::View> > views() const;
114
115         std::shared_ptr<pv::view::View> main_view() const;
116
117         void set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar);
118
119         std::shared_ptr<pv::toolbars::MainBar> main_bar() const;
120
121         void save_settings(QSettings &settings) const;
122
123         void restore_settings(QSettings &settings);
124
125         /**
126          * Sets device instance that will be used in the next capture session.
127          */
128         void set_device(std::shared_ptr<devices::Device> device);
129
130         void set_default_device();
131
132         capture_state get_capture_state() const;
133
134         void start_capture(std::function<void (const QString)> error_handler);
135
136         void stop_capture();
137
138         double get_samplerate() const;
139
140         void register_view(std::shared_ptr<pv::view::View> view);
141
142         void deregister_view(std::shared_ptr<pv::view::View> view);
143
144         bool has_view(std::shared_ptr<pv::view::View> view);
145
146         const std::unordered_set< std::shared_ptr<data::SignalBase> >
147                 signalbases() const;
148
149 #ifdef ENABLE_DECODE
150         bool add_decoder(srd_decoder *const dec);
151
152         void remove_decode_signal(std::shared_ptr<data::SignalBase> signalbase);
153 #endif
154
155 private:
156         void set_capture_state(capture_state state);
157
158         void update_signals();
159
160         std::shared_ptr<data::SignalBase> signalbase_from_channel(
161                 std::shared_ptr<sigrok::Channel> channel) const;
162
163 private:
164         void sample_thread_proc(std::function<void (const QString)> error_handler);
165
166         void feed_in_header();
167
168         void feed_in_meta(std::shared_ptr<sigrok::Meta> meta);
169
170         void feed_in_trigger();
171
172         void feed_in_frame_begin();
173
174         void feed_in_logic(std::shared_ptr<sigrok::Logic> logic);
175
176         void feed_in_analog(std::shared_ptr<sigrok::Analog> analog);
177
178         void data_feed_in(std::shared_ptr<sigrok::Device> device,
179                 std::shared_ptr<sigrok::Packet> packet);
180
181 private:
182         DeviceManager &device_manager_;
183         std::shared_ptr<devices::Device> device_;
184         QString default_name_, name_;
185
186         std::list< std::shared_ptr<pv::view::View> > views_;
187         std::shared_ptr<pv::view::View> main_view_;
188
189         std::shared_ptr<pv::toolbars::MainBar> main_bar_;
190
191         mutable std::mutex sampling_mutex_; //!< Protects access to capture_state_.
192         capture_state capture_state_;
193
194         std::unordered_set< std::shared_ptr<data::SignalBase> > signalbases_;
195         std::unordered_set< std::shared_ptr<data::SignalData> > all_signal_data_;
196
197         mutable std::recursive_mutex data_mutex_;
198         std::shared_ptr<data::Logic> logic_data_;
199         uint64_t cur_samplerate_;
200         std::shared_ptr<data::LogicSegment> cur_logic_segment_;
201         std::map< std::shared_ptr<sigrok::Channel>, std::shared_ptr<data::AnalogSegment> >
202                 cur_analog_segments_;
203
204         std::thread sampling_thread_;
205
206         bool out_of_memory_;
207
208 Q_SIGNALS:
209         void capture_state_changed(int state);
210         void device_changed();
211
212         void signals_changed();
213
214         void name_changed();
215
216         void trigger_event(util::Timestamp location);
217
218         void frame_began();
219
220         void data_received();
221
222         void frame_ended();
223
224         void add_view(const QString &title, view::ViewType type,
225                 Session *session);
226 };
227
228 } // namespace pv
229
230 #endif // PULSEVIEW_PV_SESSION_HPP