2 * This file is part of the PulseView project.
4 * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
23 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
27 #include <boost/thread/locks.hpp>
28 #include <boost/thread/shared_mutex.hpp>
30 #include "storesession.hpp"
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>
41 #include <libsigrokcxx/libsigrokcxx.hpp>
43 using boost::shared_lock;
44 using boost::shared_mutex;
47 using std::dynamic_pointer_cast;
49 using std::lock_guard;
56 using std::shared_ptr;
58 using std::unordered_set;
61 using Glib::VariantBase;
63 using sigrok::ChannelType;
64 using sigrok::ConfigKey;
66 using sigrok::OutputFormat;
67 using sigrok::OutputFlag;
71 const size_t StoreSession::BlockSize = 10 * 1024 * 1024;
73 StoreSession::StoreSession(const string &file_name,
74 const shared_ptr<OutputFormat> &output_format,
75 const map<string, VariantBase> &options,
76 const pair<uint64_t, uint64_t> sample_range,
77 const Session &session) :
78 file_name_(file_name),
79 output_format_(output_format),
81 sample_range_(sample_range),
89 StoreSession::~StoreSession()
94 pair<int, int> StoreSession::progress() const
96 return make_pair(units_stored_.load(), unit_count_.load());
99 const QString& StoreSession::error() const
101 lock_guard<mutex> lock(mutex_);
105 bool StoreSession::start()
107 const unordered_set< shared_ptr<data::SignalBase> > sigs(session_.signalbases());
109 shared_ptr<data::Segment> any_segment;
110 shared_ptr<data::LogicSegment> lsegment;
111 vector< shared_ptr<data::SignalBase> > achannel_list;
112 vector< shared_ptr<data::AnalogSegment> > asegment_list;
114 for (shared_ptr<data::SignalBase> signal : sigs) {
115 if (!signal->enabled())
118 if (signal->type() == ChannelType::LOGIC) {
119 // All logic channels share the same data segments
120 shared_ptr<data::Logic> ldata = signal->logic_data();
122 const deque< shared_ptr<data::LogicSegment> > &lsegments =
123 ldata->logic_segments();
125 if (lsegments.empty()) {
126 error_ = tr("Can't save logic channel without data.");
130 lsegment = lsegments.front();
131 any_segment = lsegment;
134 if (signal->type() == ChannelType::ANALOG) {
135 // Each analog channel has its own segments
136 shared_ptr<data::Analog> adata = signal->analog_data();
138 const deque< shared_ptr<data::AnalogSegment> > &asegments =
139 adata->analog_segments();
141 if (asegments.empty()) {
142 error_ = tr("Can't save analog channel without data.");
146 asegment_list.push_back(asegments.front());
147 any_segment = asegments.front();
149 achannel_list.push_back(signal);
154 error_ = tr("No channels enabled.");
158 // Check whether the user wants to export a certain sample range
161 if (sample_range_.first == sample_range_.second) {
163 sample_count_ = any_segment->get_sample_count();
165 if (sample_range_.first > sample_range_.second) {
166 start_sample_ = sample_range_.second;
167 end_sample = min(sample_range_.first, any_segment->get_sample_count());
168 sample_count_ = end_sample - start_sample_;
170 start_sample_ = sample_range_.first;
171 end_sample = min(sample_range_.second, any_segment->get_sample_count());
172 sample_count_ = end_sample - start_sample_;
178 const auto context = session_.device_manager().context();
179 auto device = session_.device()->device();
181 map<string, Glib::VariantBase> options = options_;
183 if (!output_format_->test_flag(OutputFlag::INTERNAL_IO_HANDLING))
184 output_stream_.open(file_name_, ios_base::binary |
185 ios_base::trunc | ios_base::out);
187 output_ = output_format_->create_output(file_name_, device, options);
188 auto meta = context->create_meta_packet(
189 {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create(
190 any_segment->samplerate())}});
191 output_->receive(meta);
192 } catch (Error error) {
193 error_ = tr("Error while saving: ") + error.what();
197 thread_ = std::thread(&StoreSession::store_proc, this,
198 achannel_list, asegment_list, lsegment);
202 void StoreSession::wait()
204 if (thread_.joinable())
208 void StoreSession::cancel()
213 void StoreSession::store_proc(vector< shared_ptr<data::SignalBase> > achannel_list,
214 vector< shared_ptr<data::AnalogSegment> > asegment_list,
215 shared_ptr<data::LogicSegment> lsegment)
217 unsigned progress_scale = 0;
221 unsigned int lsamples_per_block = INT_MAX;
222 unsigned int asamples_per_block = INT_MAX;
224 if (!asegment_list.empty()) {
225 // We assume all analog channels use the sample unit size
226 aunit_size = asegment_list.front()->unit_size();
227 asamples_per_block = BlockSize / aunit_size;
230 lunit_size = lsegment->unit_size();
231 lsamples_per_block = BlockSize / lunit_size;
234 // Qt needs the progress values to fit inside an int. If they would
235 // not, scale the current and max values down until they do.
236 while ((sample_count_ >> progress_scale) > INT_MAX)
239 unit_count_ = sample_count_ >> progress_scale;
241 const unsigned int samples_per_block =
242 min(asamples_per_block, lsamples_per_block);
244 while (!interrupt_ && sample_count_) {
247 const uint64_t packet_len =
248 min((uint64_t)samples_per_block, sample_count_);
251 const auto context = session_.device_manager().context();
253 for (unsigned int i = 0; i < achannel_list.size(); i++) {
254 shared_ptr<sigrok::Channel> achannel = (achannel_list.at(i))->channel();
255 shared_ptr<data::AnalogSegment> asegment = asegment_list.at(i);
258 asegment->get_samples(start_sample_, start_sample_ + packet_len);
260 auto analog = context->create_analog_packet(
261 vector<shared_ptr<sigrok::Channel> >{achannel},
262 (float *)adata, packet_len,
263 sigrok::Quantity::VOLTAGE, sigrok::Unit::VOLT,
264 vector<const sigrok::QuantityFlag *>());
265 const string adata_str = output_->receive(analog);
267 if (output_stream_.is_open())
268 output_stream_ << adata_str;
274 const uint8_t* ldata =
275 lsegment->get_samples(start_sample_, start_sample_ + packet_len);
277 const size_t length = packet_len * lunit_size;
278 auto logic = context->create_logic_packet((void*)ldata, length, lunit_size);
279 const string ldata_str = output_->receive(logic);
281 if (output_stream_.is_open())
282 output_stream_ << ldata_str;
286 } catch (Error error) {
287 error_ = tr("Error while saving: ") + error.what();
291 sample_count_ -= packet_len;
292 start_sample_ += packet_len;
293 units_stored_ = unit_count_ - (sample_count_ >> progress_scale);
296 // Zeroing the progress variables indicates completion
297 units_stored_ = unit_count_ = 0;
303 output_stream_.close();