]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
3 | * | |
4 | * Copyright (C) 2014 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, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <cassert> | |
21 | ||
22 | #ifdef _WIN32 | |
23 | // Windows: Avoid boost/thread namespace pollution (which includes windows.h). | |
24 | #define NOGDI | |
25 | #define NORESOURCE | |
26 | #endif | |
27 | #include <boost/thread/locks.hpp> | |
28 | #include <boost/thread/shared_mutex.hpp> | |
29 | ||
30 | #include "storesession.hpp" | |
31 | ||
32 | #include <pv/devicemanager.hpp> | |
33 | #include <pv/session.hpp> | |
34 | #include <pv/data/analog.hpp> | |
35 | #include <pv/data/analogsegment.hpp> | |
36 | #include <pv/data/logic.hpp> | |
37 | #include <pv/data/logicsegment.hpp> | |
38 | #include <pv/data/signalbase.hpp> | |
39 | #include <pv/devices/device.hpp> | |
40 | ||
41 | #include <libsigrokcxx/libsigrokcxx.hpp> | |
42 | ||
43 | using boost::shared_lock; | |
44 | using boost::shared_mutex; | |
45 | ||
46 | using std::deque; | |
47 | using std::dynamic_pointer_cast; | |
48 | using std::ios_base; | |
49 | using std::lock_guard; | |
50 | using std::make_pair; | |
51 | using std::map; | |
52 | using std::min; | |
53 | using std::mutex; | |
54 | using std::pair; | |
55 | using std::set; | |
56 | using std::shared_ptr; | |
57 | using std::string; | |
58 | using std::thread; | |
59 | using std::unordered_set; | |
60 | using std::vector; | |
61 | ||
62 | using Glib::VariantBase; | |
63 | ||
64 | using sigrok::ChannelType; | |
65 | using sigrok::ConfigKey; | |
66 | using sigrok::Error; | |
67 | using sigrok::OutputFormat; | |
68 | using sigrok::OutputFlag; | |
69 | ||
70 | namespace pv { | |
71 | ||
72 | const size_t StoreSession::BlockSize = 1024 * 1024; | |
73 | ||
74 | StoreSession::StoreSession(const std::string &file_name, | |
75 | const shared_ptr<OutputFormat> &output_format, | |
76 | const map<string, VariantBase> &options, | |
77 | const std::pair<uint64_t, uint64_t> sample_range, | |
78 | const Session &session) : | |
79 | file_name_(file_name), | |
80 | output_format_(output_format), | |
81 | options_(options), | |
82 | sample_range_(sample_range), | |
83 | session_(session), | |
84 | interrupt_(false), | |
85 | units_stored_(0), | |
86 | unit_count_(0) | |
87 | { | |
88 | } | |
89 | ||
90 | StoreSession::~StoreSession() | |
91 | { | |
92 | wait(); | |
93 | } | |
94 | ||
95 | pair<int, int> StoreSession::progress() const | |
96 | { | |
97 | return make_pair(units_stored_.load(), unit_count_.load()); | |
98 | } | |
99 | ||
100 | const QString& StoreSession::error() const | |
101 | { | |
102 | lock_guard<mutex> lock(mutex_); | |
103 | return error_; | |
104 | } | |
105 | ||
106 | bool StoreSession::start() | |
107 | { | |
108 | const unordered_set< shared_ptr<data::SignalBase> > sigs(session_.signalbases()); | |
109 | ||
110 | shared_ptr<data::Segment> any_segment; | |
111 | shared_ptr<data::LogicSegment> lsegment; | |
112 | vector< shared_ptr<data::SignalBase> > achannel_list; | |
113 | vector< shared_ptr<data::AnalogSegment> > asegment_list; | |
114 | ||
115 | for (shared_ptr<data::SignalBase> signal : sigs) { | |
116 | if (!signal->enabled()) | |
117 | continue; | |
118 | ||
119 | if (signal->type() == ChannelType::LOGIC) { | |
120 | // All logic channels share the same data segments | |
121 | shared_ptr<data::Logic> ldata = signal->logic_data(); | |
122 | ||
123 | const deque< shared_ptr<data::LogicSegment> > &lsegments = | |
124 | ldata->logic_segments(); | |
125 | ||
126 | if (lsegments.empty()) { | |
127 | error_ = tr("Can't save logic channel without data."); | |
128 | return false; | |
129 | } | |
130 | ||
131 | lsegment = lsegments.front(); | |
132 | any_segment = lsegment; | |
133 | } | |
134 | ||
135 | if (signal->type() == ChannelType::ANALOG) { | |
136 | // Each analog channel has its own segments | |
137 | shared_ptr<data::Analog> adata = signal->analog_data(); | |
138 | ||
139 | const deque< shared_ptr<data::AnalogSegment> > &asegments = | |
140 | adata->analog_segments(); | |
141 | ||
142 | if (asegments.empty()) { | |
143 | error_ = tr("Can't save analog channel without data."); | |
144 | return false; | |
145 | } | |
146 | ||
147 | asegment_list.push_back(asegments.front()); | |
148 | any_segment = asegments.front(); | |
149 | ||
150 | achannel_list.push_back(signal); | |
151 | } | |
152 | } | |
153 | ||
154 | if (!any_segment) { | |
155 | error_ = tr("No channels enabled."); | |
156 | return false; | |
157 | } | |
158 | ||
159 | // Check whether the user wants to export a certain sample range | |
160 | uint64_t end_sample; | |
161 | ||
162 | if (sample_range_.first == sample_range_.second) { | |
163 | start_sample_ = 0; | |
164 | sample_count_ = any_segment->get_sample_count(); | |
165 | } else { | |
166 | if (sample_range_.first > sample_range_.second) { | |
167 | start_sample_ = sample_range_.second; | |
168 | end_sample = min(sample_range_.first, any_segment->get_sample_count()); | |
169 | sample_count_ = end_sample - start_sample_; | |
170 | } else { | |
171 | start_sample_ = sample_range_.first; | |
172 | end_sample = min(sample_range_.second, any_segment->get_sample_count()); | |
173 | sample_count_ = end_sample - start_sample_; | |
174 | } | |
175 | } | |
176 | ||
177 | // Begin storing | |
178 | try { | |
179 | const auto context = session_.device_manager().context(); | |
180 | auto device = session_.device()->device(); | |
181 | ||
182 | map<string, Glib::VariantBase> options = options_; | |
183 | ||
184 | if (!output_format_->test_flag(OutputFlag::INTERNAL_IO_HANDLING)) | |
185 | output_stream_.open(file_name_, ios_base::binary | | |
186 | ios_base::trunc | ios_base::out); | |
187 | ||
188 | output_ = output_format_->create_output(file_name_, device, options); | |
189 | auto meta = context->create_meta_packet( | |
190 | {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create( | |
191 | any_segment->samplerate())}}); | |
192 | output_->receive(meta); | |
193 | } catch (Error error) { | |
194 | error_ = tr("Error while saving: ") + error.what(); | |
195 | return false; | |
196 | } | |
197 | ||
198 | thread_ = std::thread(&StoreSession::store_proc, this, | |
199 | achannel_list, asegment_list, lsegment); | |
200 | return true; | |
201 | } | |
202 | ||
203 | void StoreSession::wait() | |
204 | { | |
205 | if (thread_.joinable()) | |
206 | thread_.join(); | |
207 | } | |
208 | ||
209 | void StoreSession::cancel() | |
210 | { | |
211 | interrupt_ = true; | |
212 | } | |
213 | ||
214 | void StoreSession::store_proc(vector< shared_ptr<data::SignalBase> > achannel_list, | |
215 | vector< shared_ptr<data::AnalogSegment> > asegment_list, | |
216 | shared_ptr<data::LogicSegment> lsegment) | |
217 | { | |
218 | unsigned progress_scale = 0; | |
219 | ||
220 | /// TODO: Wrap this in a std::unique_ptr when we transition to C++11 | |
221 | uint8_t *const ldata = new uint8_t[BlockSize]; | |
222 | assert(ldata); | |
223 | ||
224 | int aunit_size = 0; | |
225 | int lunit_size = 0; | |
226 | unsigned int lsamples_per_block = INT_MAX; | |
227 | unsigned int asamples_per_block = INT_MAX; | |
228 | ||
229 | if (!asegment_list.empty()) { | |
230 | // We assume all analog channels use the sample unit size | |
231 | aunit_size = asegment_list.front()->unit_size(); | |
232 | asamples_per_block = BlockSize / aunit_size; | |
233 | } | |
234 | if (lsegment) { | |
235 | lunit_size = lsegment->unit_size(); | |
236 | lsamples_per_block = BlockSize / lunit_size; | |
237 | } | |
238 | ||
239 | // Qt needs the progress values to fit inside an int. If they would | |
240 | // not, scale the current and max values down until they do. | |
241 | while ((sample_count_ >> progress_scale) > INT_MAX) | |
242 | progress_scale ++; | |
243 | ||
244 | unit_count_ = sample_count_ >> progress_scale; | |
245 | ||
246 | const unsigned int samples_per_block = | |
247 | std::min(asamples_per_block, lsamples_per_block); | |
248 | ||
249 | while (!interrupt_ && sample_count_) { | |
250 | progress_updated(); | |
251 | ||
252 | const uint64_t packet_len = | |
253 | std::min((uint64_t)samples_per_block, sample_count_); | |
254 | ||
255 | try { | |
256 | const auto context = session_.device_manager().context(); | |
257 | ||
258 | for (unsigned int i = 0; i < achannel_list.size(); i++) { | |
259 | shared_ptr<sigrok::Channel> achannel = (achannel_list.at(i))->channel(); | |
260 | shared_ptr<data::AnalogSegment> asegment = asegment_list.at(i); | |
261 | ||
262 | const float *adata = | |
263 | asegment->get_samples(start_sample_, start_sample_ + packet_len); | |
264 | ||
265 | // The srzip format currently only supports packets with one | |
266 | // analog channel. See zip_append_analog() in srzip.c | |
267 | auto analog = context->create_analog_packet( | |
268 | vector<shared_ptr<sigrok::Channel> >{achannel}, | |
269 | (float *)adata, packet_len, | |
270 | sigrok::Quantity::VOLTAGE, sigrok::Unit::VOLT, | |
271 | vector<const sigrok::QuantityFlag *>()); | |
272 | const string adata_str = output_->receive(analog); | |
273 | ||
274 | if (output_stream_.is_open()) | |
275 | output_stream_ << adata_str; | |
276 | ||
277 | delete[] adata; | |
278 | } | |
279 | ||
280 | if (lsegment) { | |
281 | lsegment->get_samples(ldata, start_sample_, start_sample_ + packet_len); | |
282 | ||
283 | const size_t length = packet_len * lunit_size; | |
284 | auto logic = context->create_logic_packet(ldata, length, lunit_size); | |
285 | const string ldata_str = output_->receive(logic); | |
286 | ||
287 | if (output_stream_.is_open()) | |
288 | output_stream_ << ldata_str; | |
289 | } | |
290 | } catch (Error error) { | |
291 | error_ = tr("Error while saving: ") + error.what(); | |
292 | break; | |
293 | } | |
294 | ||
295 | sample_count_ -= packet_len; | |
296 | start_sample_ += packet_len; | |
297 | units_stored_ = unit_count_ - (sample_count_ >> progress_scale); | |
298 | } | |
299 | ||
300 | // Zeroing the progress variables indicates completion | |
301 | units_stored_ = unit_count_ = 0; | |
302 | ||
303 | store_successful(); | |
304 | progress_updated(); | |
305 | ||
306 | output_.reset(); | |
307 | output_stream_.close(); | |
308 | ||
309 | delete[] ldata; | |
310 | } | |
311 | ||
312 | } // pv |