]>
Commit | Line | Data |
---|---|---|
0fbda3c2 JH |
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
0fbda3c2 JH |
18 | */ |
19 | ||
d2344534 JH |
20 | #include <cassert> |
21 | ||
2acdb232 | 22 | #include "storesession.hpp" |
0fbda3c2 | 23 | |
8962d7b3 SA |
24 | #include <QSettings> |
25 | ||
c51ae0b4 SA |
26 | #include <pv/data/analog.hpp> |
27 | #include <pv/data/analogsegment.hpp> | |
2acdb232 | 28 | #include <pv/data/logic.hpp> |
f3d66e52 | 29 | #include <pv/data/logicsegment.hpp> |
bf0edd2b | 30 | #include <pv/data/signalbase.hpp> |
aca9aa83 | 31 | #include <pv/devicemanager.hpp> |
da30ecb7 | 32 | #include <pv/devices/device.hpp> |
8962d7b3 | 33 | #include <pv/globalsettings.hpp> |
aca9aa83 | 34 | #include <pv/session.hpp> |
0fbda3c2 | 35 | |
fe3a1c21 | 36 | #include <libsigrokcxx/libsigrokcxx.hpp> |
e8d00928 | 37 | |
0fbda3c2 | 38 | using std::deque; |
c1035a14 | 39 | using std::ios_base; |
3b68d03d | 40 | using std::lock_guard; |
0fbda3c2 | 41 | using std::make_pair; |
c1035a14 | 42 | using std::map; |
0fbda3c2 | 43 | using std::min; |
3b68d03d | 44 | using std::mutex; |
0fbda3c2 | 45 | using std::pair; |
f9abf97e | 46 | using std::shared_ptr; |
0fbda3c2 | 47 | using std::string; |
78b0af3e | 48 | using std::unordered_set; |
0fbda3c2 JH |
49 | using std::vector; |
50 | ||
e93f5538 JH |
51 | using Glib::VariantBase; |
52 | ||
7223eb62 | 53 | using sigrok::ConfigKey; |
e8d00928 | 54 | using sigrok::Error; |
4764bc4d | 55 | using sigrok::OutputFormat; |
542f1e6c | 56 | using sigrok::OutputFlag; |
e8d00928 | 57 | |
0fbda3c2 JH |
58 | namespace pv { |
59 | ||
9cc264b4 | 60 | const size_t StoreSession::BlockSize = 10 * 1024 * 1024; |
0fbda3c2 | 61 | |
6f925ba9 | 62 | StoreSession::StoreSession(const string &file_name, |
e93f5538 | 63 | const shared_ptr<OutputFormat> &output_format, |
d2fc6be9 | 64 | const map<string, VariantBase> &options, |
6f925ba9 | 65 | const pair<uint64_t, uint64_t> sample_range, |
d2fc6be9 | 66 | const Session &session) : |
8dbbc7f0 | 67 | file_name_(file_name), |
4764bc4d | 68 | output_format_(output_format), |
e93f5538 | 69 | options_(options), |
d2fc6be9 | 70 | sample_range_(sample_range), |
8dbbc7f0 JH |
71 | session_(session), |
72 | interrupt_(false), | |
73 | units_stored_(0), | |
74 | unit_count_(0) | |
0fbda3c2 JH |
75 | { |
76 | } | |
77 | ||
78 | StoreSession::~StoreSession() | |
79 | { | |
80 | wait(); | |
81 | } | |
82 | ||
e40b2f29 | 83 | pair<int, int> StoreSession::progress() const |
0fbda3c2 | 84 | { |
8dbbc7f0 | 85 | return make_pair(units_stored_.load(), unit_count_.load()); |
0fbda3c2 JH |
86 | } |
87 | ||
88 | const QString& StoreSession::error() const | |
89 | { | |
8dbbc7f0 JH |
90 | lock_guard<mutex> lock(mutex_); |
91 | return error_; | |
0fbda3c2 JH |
92 | } |
93 | ||
94 | bool StoreSession::start() | |
95 | { | |
56c4de9a | 96 | const vector< shared_ptr<data::SignalBase> > sigs(session_.signalbases()); |
de6e819c | 97 | |
c51ae0b4 SA |
98 | shared_ptr<data::Segment> any_segment; |
99 | shared_ptr<data::LogicSegment> lsegment; | |
bf0edd2b | 100 | vector< shared_ptr<data::SignalBase> > achannel_list; |
c51ae0b4 | 101 | vector< shared_ptr<data::AnalogSegment> > asegment_list; |
de6e819c | 102 | |
f4ab4b5c | 103 | for (const shared_ptr<data::SignalBase>& signal : sigs) { |
c51ae0b4 SA |
104 | if (!signal->enabled()) |
105 | continue; | |
0fbda3c2 | 106 | |
472a80c5 | 107 | if (signal->type() == data::SignalBase::LogicChannel) { |
c51ae0b4 | 108 | // All logic channels share the same data segments |
47e9e7bb | 109 | shared_ptr<data::Logic> ldata = signal->logic_data(); |
0fbda3c2 | 110 | |
c51ae0b4 SA |
111 | const deque< shared_ptr<data::LogicSegment> > &lsegments = |
112 | ldata->logic_segments(); | |
0fbda3c2 | 113 | |
c51ae0b4 SA |
114 | if (lsegments.empty()) { |
115 | error_ = tr("Can't save logic channel without data."); | |
116 | return false; | |
117 | } | |
0fbda3c2 | 118 | |
c51ae0b4 SA |
119 | lsegment = lsegments.front(); |
120 | any_segment = lsegment; | |
121 | } | |
122 | ||
472a80c5 | 123 | if (signal->type() == data::SignalBase::AnalogChannel) { |
c51ae0b4 | 124 | // Each analog channel has its own segments |
47e9e7bb | 125 | shared_ptr<data::Analog> adata = signal->analog_data(); |
c51ae0b4 SA |
126 | |
127 | const deque< shared_ptr<data::AnalogSegment> > &asegments = | |
128 | adata->analog_segments(); | |
129 | ||
130 | if (asegments.empty()) { | |
131 | error_ = tr("Can't save analog channel without data."); | |
132 | return false; | |
133 | } | |
134 | ||
135 | asegment_list.push_back(asegments.front()); | |
136 | any_segment = asegments.front(); | |
137 | ||
47e9e7bb | 138 | achannel_list.push_back(signal); |
c51ae0b4 | 139 | } |
0fbda3c2 JH |
140 | } |
141 | ||
c51ae0b4 SA |
142 | if (!any_segment) { |
143 | error_ = tr("No channels enabled."); | |
144 | return false; | |
145 | } | |
0fbda3c2 | 146 | |
d2fc6be9 | 147 | // Check whether the user wants to export a certain sample range |
40ec0302 SA |
148 | uint64_t end_sample; |
149 | ||
d2fc6be9 | 150 | if (sample_range_.first == sample_range_.second) { |
7b7ab1f5 | 151 | // No sample range specified, save everything we have |
d2fc6be9 | 152 | start_sample_ = 0; |
c51ae0b4 | 153 | sample_count_ = any_segment->get_sample_count(); |
d2fc6be9 | 154 | } else { |
3e8a7cc6 SA |
155 | if (sample_range_.first > sample_range_.second) { |
156 | start_sample_ = sample_range_.second; | |
40ec0302 SA |
157 | end_sample = min(sample_range_.first, any_segment->get_sample_count()); |
158 | sample_count_ = end_sample - start_sample_; | |
3e8a7cc6 SA |
159 | } else { |
160 | start_sample_ = sample_range_.first; | |
40ec0302 SA |
161 | end_sample = min(sample_range_.second, any_segment->get_sample_count()); |
162 | sample_count_ = end_sample - start_sample_; | |
3e8a7cc6 | 163 | } |
d2fc6be9 SA |
164 | } |
165 | ||
7b7ab1f5 SA |
166 | // Make sure the sample range is valid |
167 | if (start_sample_ > any_segment->get_sample_count()) { | |
168 | error_ = tr("Can't save range without sample data."); | |
169 | return false; | |
170 | } | |
171 | ||
0fbda3c2 | 172 | // Begin storing |
e8d00928 | 173 | try { |
adb240c0 | 174 | const auto context = session_.device_manager().context(); |
da30ecb7 | 175 | auto device = session_.device()->device(); |
c1035a14 | 176 | |
e93f5538 | 177 | map<string, Glib::VariantBase> options = options_; |
c1035a14 | 178 | |
542f1e6c SA |
179 | if (!output_format_->test_flag(OutputFlag::INTERNAL_IO_HANDLING)) |
180 | output_stream_.open(file_name_, ios_base::binary | | |
181 | ios_base::trunc | ios_base::out); | |
ad83f8fa SA |
182 | |
183 | output_ = output_format_->create_output(file_name_, device, options); | |
7223eb62 | 184 | auto meta = context->create_meta_packet( |
ff008de6 | 185 | {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create( |
c51ae0b4 | 186 | any_segment->samplerate())}}); |
8dbbc7f0 | 187 | output_->receive(meta); |
30677c13 | 188 | } catch (Error& error) { |
c51ae0b4 | 189 | error_ = tr("Error while saving: ") + error.what(); |
0fbda3c2 JH |
190 | return false; |
191 | } | |
192 | ||
c51ae0b4 SA |
193 | thread_ = std::thread(&StoreSession::store_proc, this, |
194 | achannel_list, asegment_list, lsegment); | |
8962d7b3 SA |
195 | |
196 | // Save session setup if we're saving to srzip and the user wants it | |
197 | GlobalSettings settings; | |
198 | bool save_with_setup = settings.value(GlobalSettings::Key_General_SaveWithSetup).toBool(); | |
199 | ||
200 | if ((output_format_->name() == "srzip") && (save_with_setup)) { | |
201 | QString setup_file_name = QString::fromStdString(file_name_); | |
202 | setup_file_name.truncate(setup_file_name.lastIndexOf('.')); | |
203 | setup_file_name.append(".pvs"); | |
204 | ||
205 | QSettings settings_storage(setup_file_name, QSettings::IniFormat); | |
206 | session_.save_setup(settings_storage); | |
207 | } | |
208 | ||
0fbda3c2 JH |
209 | return true; |
210 | } | |
211 | ||
212 | void StoreSession::wait() | |
213 | { | |
8dbbc7f0 JH |
214 | if (thread_.joinable()) |
215 | thread_.join(); | |
0fbda3c2 JH |
216 | } |
217 | ||
218 | void StoreSession::cancel() | |
219 | { | |
8dbbc7f0 | 220 | interrupt_ = true; |
0fbda3c2 JH |
221 | } |
222 | ||
bf0edd2b | 223 | void StoreSession::store_proc(vector< shared_ptr<data::SignalBase> > achannel_list, |
c51ae0b4 SA |
224 | vector< shared_ptr<data::AnalogSegment> > asegment_list, |
225 | shared_ptr<data::LogicSegment> lsegment) | |
0fbda3c2 | 226 | { |
e40b2f29 | 227 | unsigned progress_scale = 0; |
0fbda3c2 | 228 | |
c51ae0b4 SA |
229 | int aunit_size = 0; |
230 | int lunit_size = 0; | |
231 | unsigned int lsamples_per_block = INT_MAX; | |
232 | unsigned int asamples_per_block = INT_MAX; | |
233 | ||
234 | if (!asegment_list.empty()) { | |
235 | // We assume all analog channels use the sample unit size | |
236 | aunit_size = asegment_list.front()->unit_size(); | |
237 | asamples_per_block = BlockSize / aunit_size; | |
238 | } | |
239 | if (lsegment) { | |
240 | lunit_size = lsegment->unit_size(); | |
241 | lsamples_per_block = BlockSize / lunit_size; | |
242 | } | |
0fbda3c2 | 243 | |
3d79f521 | 244 | // Qt needs the progress values to fit inside an int. If they would |
e40b2f29 | 245 | // not, scale the current and max values down until they do. |
d2fc6be9 | 246 | while ((sample_count_ >> progress_scale) > INT_MAX) |
c063290a | 247 | progress_scale++; |
e40b2f29 | 248 | |
d2fc6be9 | 249 | unit_count_ = sample_count_ >> progress_scale; |
0fbda3c2 | 250 | |
c51ae0b4 | 251 | const unsigned int samples_per_block = |
6f925ba9 | 252 | min(asamples_per_block, lsamples_per_block); |
0fbda3c2 | 253 | |
dd86facc | 254 | const auto context = session_.device_manager().context(); |
2ad82c2e | 255 | while (!interrupt_ && sample_count_) { |
0fbda3c2 JH |
256 | progress_updated(); |
257 | ||
d2fc6be9 | 258 | const uint64_t packet_len = |
6f925ba9 | 259 | min((uint64_t)samples_per_block, sample_count_); |
d2fc6be9 | 260 | |
e8d00928 | 261 | try { |
c51ae0b4 | 262 | for (unsigned int i = 0; i < achannel_list.size(); i++) { |
bf0edd2b | 263 | shared_ptr<sigrok::Channel> achannel = (achannel_list.at(i))->channel(); |
c51ae0b4 SA |
264 | shared_ptr<data::AnalogSegment> asegment = asegment_list.at(i); |
265 | ||
b82243f7 SA |
266 | float *adata = new float[packet_len]; |
267 | asegment->get_samples(start_sample_, start_sample_ + packet_len, adata); | |
c51ae0b4 | 268 | |
c51ae0b4 SA |
269 | auto analog = context->create_analog_packet( |
270 | vector<shared_ptr<sigrok::Channel> >{achannel}, | |
271 | (float *)adata, packet_len, | |
272 | sigrok::Quantity::VOLTAGE, sigrok::Unit::VOLT, | |
273 | vector<const sigrok::QuantityFlag *>()); | |
274 | const string adata_str = output_->receive(analog); | |
275 | ||
276 | if (output_stream_.is_open()) | |
277 | output_stream_ << adata_str; | |
278 | ||
279 | delete[] adata; | |
280 | } | |
281 | ||
282 | if (lsegment) { | |
b82243f7 SA |
283 | const size_t data_size = packet_len * lunit_size; |
284 | uint8_t* ldata = new uint8_t[data_size]; | |
285 | lsegment->get_samples(start_sample_, start_sample_ + packet_len, ldata); | |
c51ae0b4 | 286 | |
b82243f7 | 287 | auto logic = context->create_logic_packet((void*)ldata, data_size, lunit_size); |
c51ae0b4 SA |
288 | const string ldata_str = output_->receive(logic); |
289 | ||
290 | if (output_stream_.is_open()) | |
291 | output_stream_ << ldata_str; | |
038a1427 SA |
292 | |
293 | delete[] ldata; | |
c51ae0b4 | 294 | } |
30677c13 | 295 | } catch (Error& error) { |
c51ae0b4 | 296 | error_ = tr("Error while saving: ") + error.what(); |
0fbda3c2 JH |
297 | break; |
298 | } | |
299 | ||
d2fc6be9 SA |
300 | sample_count_ -= packet_len; |
301 | start_sample_ += packet_len; | |
302 | units_stored_ = unit_count_ - (sample_count_ >> progress_scale); | |
0fbda3c2 JH |
303 | } |
304 | ||
dd86facc GS |
305 | auto dfend = context->create_end_packet(); |
306 | const string ldata_str = output_->receive(dfend); | |
307 | if (output_stream_.is_open()) | |
308 | output_stream_ << ldata_str; | |
309 | ||
e0e560a5 JH |
310 | // Zeroing the progress variables indicates completion |
311 | units_stored_ = unit_count_ = 0; | |
312 | ||
5ccfc97e | 313 | store_successful(); |
0fbda3c2 JH |
314 | progress_updated(); |
315 | ||
8dbbc7f0 | 316 | output_.reset(); |
c1035a14 | 317 | output_stream_.close(); |
0fbda3c2 JH |
318 | } |
319 | ||
870ea3db | 320 | } // namespace pv |