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