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/>.
22 #include "storesession.hpp"
26 #include <pv/data/analog.hpp>
27 #include <pv/data/analogsegment.hpp>
28 #include <pv/data/logic.hpp>
29 #include <pv/data/logicsegment.hpp>
30 #include <pv/data/signalbase.hpp>
31 #include <pv/devicemanager.hpp>
32 #include <pv/devices/device.hpp>
33 #include <pv/globalsettings.hpp>
34 #include <pv/session.hpp>
36 #include <libsigrokcxx/libsigrokcxx.hpp>
40 using std::lock_guard;
46 using std::shared_ptr;
48 using std::unordered_set;
51 using Glib::VariantBase;
53 using sigrok::ConfigKey;
55 using sigrok::OutputFormat;
56 using sigrok::OutputFlag;
60 const size_t StoreSession::BlockSize = 10 * 1024 * 1024;
62 StoreSession::StoreSession(const string &file_name,
63 const shared_ptr<OutputFormat> &output_format,
64 const map<string, VariantBase> &options,
65 const pair<uint64_t, uint64_t> sample_range,
66 const Session &session) :
67 file_name_(file_name),
68 output_format_(output_format),
70 sample_range_(sample_range),
78 StoreSession::~StoreSession()
83 pair<int, int> StoreSession::progress() const
85 return make_pair(units_stored_.load(), unit_count_.load());
88 const QString& StoreSession::error() const
90 lock_guard<mutex> lock(mutex_);
94 bool StoreSession::start()
96 const unordered_set< shared_ptr<data::SignalBase> > sigs(session_.signalbases());
98 shared_ptr<data::Segment> any_segment;
99 shared_ptr<data::LogicSegment> lsegment;
100 vector< shared_ptr<data::SignalBase> > achannel_list;
101 vector< shared_ptr<data::AnalogSegment> > asegment_list;
103 for (const shared_ptr<data::SignalBase>& signal : sigs) {
104 if (!signal->enabled())
107 if (signal->type() == data::SignalBase::LogicChannel) {
108 // All logic channels share the same data segments
109 shared_ptr<data::Logic> ldata = signal->logic_data();
111 const deque< shared_ptr<data::LogicSegment> > &lsegments =
112 ldata->logic_segments();
114 if (lsegments.empty()) {
115 error_ = tr("Can't save logic channel without data.");
119 lsegment = lsegments.front();
120 any_segment = lsegment;
123 if (signal->type() == data::SignalBase::AnalogChannel) {
124 // Each analog channel has its own segments
125 shared_ptr<data::Analog> adata = signal->analog_data();
127 const deque< shared_ptr<data::AnalogSegment> > &asegments =
128 adata->analog_segments();
130 if (asegments.empty()) {
131 error_ = tr("Can't save analog channel without data.");
135 asegment_list.push_back(asegments.front());
136 any_segment = asegments.front();
138 achannel_list.push_back(signal);
143 error_ = tr("No channels enabled.");
147 // Check whether the user wants to export a certain sample range
150 if (sample_range_.first == sample_range_.second) {
151 // No sample range specified, save everything we have
153 sample_count_ = any_segment->get_sample_count();
155 if (sample_range_.first > sample_range_.second) {
156 start_sample_ = sample_range_.second;
157 end_sample = min(sample_range_.first, any_segment->get_sample_count());
158 sample_count_ = end_sample - start_sample_;
160 start_sample_ = sample_range_.first;
161 end_sample = min(sample_range_.second, any_segment->get_sample_count());
162 sample_count_ = end_sample - start_sample_;
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.");
174 const auto context = session_.device_manager().context();
175 auto device = session_.device()->device();
177 map<string, Glib::VariantBase> options = options_;
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);
183 output_ = output_format_->create_output(file_name_, device, options);
184 auto meta = context->create_meta_packet(
185 {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create(
186 any_segment->samplerate())}});
187 output_->receive(meta);
188 } catch (Error& error) {
189 error_ = tr("Error while saving: ") + error.what();
193 thread_ = std::thread(&StoreSession::store_proc, this,
194 achannel_list, asegment_list, lsegment);
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();
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");
205 QSettings settings_storage(setup_file_name, QSettings::IniFormat);
206 session_.save_setup(settings_storage);
212 void StoreSession::wait()
214 if (thread_.joinable())
218 void StoreSession::cancel()
223 void StoreSession::store_proc(vector< shared_ptr<data::SignalBase> > achannel_list,
224 vector< shared_ptr<data::AnalogSegment> > asegment_list,
225 shared_ptr<data::LogicSegment> lsegment)
227 unsigned progress_scale = 0;
231 unsigned int lsamples_per_block = INT_MAX;
232 unsigned int asamples_per_block = INT_MAX;
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;
240 lunit_size = lsegment->unit_size();
241 lsamples_per_block = BlockSize / lunit_size;
244 // Qt needs the progress values to fit inside an int. If they would
245 // not, scale the current and max values down until they do.
246 while ((sample_count_ >> progress_scale) > INT_MAX)
249 unit_count_ = sample_count_ >> progress_scale;
251 const unsigned int samples_per_block =
252 min(asamples_per_block, lsamples_per_block);
254 while (!interrupt_ && sample_count_) {
257 const uint64_t packet_len =
258 min((uint64_t)samples_per_block, sample_count_);
261 const auto context = session_.device_manager().context();
263 for (unsigned int i = 0; i < achannel_list.size(); i++) {
264 shared_ptr<sigrok::Channel> achannel = (achannel_list.at(i))->channel();
265 shared_ptr<data::AnalogSegment> asegment = asegment_list.at(i);
267 float *adata = new float[packet_len];
268 asegment->get_samples(start_sample_, start_sample_ + packet_len, adata);
270 auto analog = context->create_analog_packet(
271 vector<shared_ptr<sigrok::Channel> >{achannel},
272 (float *)adata, packet_len,
273 sigrok::Quantity::VOLTAGE, sigrok::Unit::VOLT,
274 vector<const sigrok::QuantityFlag *>());
275 const string adata_str = output_->receive(analog);
277 if (output_stream_.is_open())
278 output_stream_ << adata_str;
284 const size_t data_size = packet_len * lunit_size;
285 uint8_t* ldata = new uint8_t[data_size];
286 lsegment->get_samples(start_sample_, start_sample_ + packet_len, ldata);
288 auto logic = context->create_logic_packet((void*)ldata, data_size, lunit_size);
289 const string ldata_str = output_->receive(logic);
291 if (output_stream_.is_open())
292 output_stream_ << ldata_str;
296 } catch (Error& error) {
297 error_ = tr("Error while saving: ") + error.what();
301 sample_count_ -= packet_len;
302 start_sample_ += packet_len;
303 units_stored_ = unit_count_ - (sample_count_ >> progress_scale);
306 // Zeroing the progress variables indicates completion
307 units_stored_ = unit_count_ = 0;
313 output_stream_.close();