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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
28 #include <boost/thread/locks.hpp>
29 #include <boost/thread/shared_mutex.hpp>
31 #include "storesession.hpp"
33 #include <pv/devicemanager.hpp>
34 #include <pv/session.hpp>
35 #include <pv/data/analog.hpp>
36 #include <pv/data/analogsegment.hpp>
37 #include <pv/data/logic.hpp>
38 #include <pv/data/logicsegment.hpp>
39 #include <pv/devices/device.hpp>
40 #include <pv/view/signal.hpp>
42 #include <libsigrokcxx/libsigrokcxx.hpp>
44 using boost::shared_lock;
45 using boost::shared_mutex;
48 using std::dynamic_pointer_cast;
50 using std::lock_guard;
57 using std::shared_ptr;
60 using std::unordered_set;
63 using Glib::VariantBase;
65 using sigrok::ConfigKey;
67 using sigrok::OutputFormat;
68 using sigrok::OutputFlag;
72 const size_t StoreSession::BlockSize = 1024 * 1024;
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),
82 sample_range_(sample_range),
90 StoreSession::~StoreSession()
95 pair<int, int> StoreSession::progress() const
97 return make_pair(units_stored_.load(), unit_count_.load());
100 const QString& StoreSession::error() const
102 lock_guard<mutex> lock(mutex_);
106 bool StoreSession::start()
108 const unordered_set< shared_ptr<view::Signal> > sigs(session_.signals());
110 shared_ptr<data::Segment> any_segment;
111 shared_ptr<data::LogicSegment> lsegment;
112 vector< shared_ptr<sigrok::Channel> > achannel_list;
113 vector< shared_ptr<data::AnalogSegment> > asegment_list;
115 for (shared_ptr<view::Signal> signal : sigs) {
116 if (!signal->enabled())
119 shared_ptr<data::SignalData> data = signal->data();
121 if (dynamic_pointer_cast<data::Logic>(data)) {
122 // All logic channels share the same data segments
123 shared_ptr<data::Logic> ldata = dynamic_pointer_cast<data::Logic>(data);
125 const deque< shared_ptr<data::LogicSegment> > &lsegments =
126 ldata->logic_segments();
128 if (lsegments.empty()) {
129 error_ = tr("Can't save logic channel without data.");
133 lsegment = lsegments.front();
134 any_segment = lsegment;
137 if (dynamic_pointer_cast<data::Analog>(data)) {
138 // Each analog channel has its own segments
139 shared_ptr<data::Analog> adata =
140 dynamic_pointer_cast<data::Analog>(data);
142 const deque< shared_ptr<data::AnalogSegment> > &asegments =
143 adata->analog_segments();
145 if (asegments.empty()) {
146 error_ = tr("Can't save analog channel without data.");
150 asegment_list.push_back(asegments.front());
151 any_segment = asegments.front();
153 achannel_list.push_back(signal->channel());
158 error_ = tr("No channels enabled.");
162 // Check whether the user wants to export a certain sample range
165 if (sample_range_.first == sample_range_.second) {
167 sample_count_ = any_segment->get_sample_count();
169 if (sample_range_.first > sample_range_.second) {
170 start_sample_ = sample_range_.second;
171 end_sample = min(sample_range_.first, any_segment->get_sample_count());
172 sample_count_ = end_sample - start_sample_;
174 start_sample_ = sample_range_.first;
175 end_sample = min(sample_range_.second, any_segment->get_sample_count());
176 sample_count_ = end_sample - start_sample_;
182 const auto context = session_.device_manager().context();
183 auto device = session_.device()->device();
185 map<string, Glib::VariantBase> options = options_;
187 if (!output_format_->test_flag(OutputFlag::INTERNAL_IO_HANDLING))
188 output_stream_.open(file_name_, ios_base::binary |
189 ios_base::trunc | ios_base::out);
191 output_ = output_format_->create_output(file_name_, device, options);
192 auto meta = context->create_meta_packet(
193 {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create(
194 any_segment->samplerate())}});
195 output_->receive(meta);
196 } catch (Error error) {
197 error_ = tr("Error while saving: ") + error.what();
201 thread_ = std::thread(&StoreSession::store_proc, this,
202 achannel_list, asegment_list, lsegment);
206 void StoreSession::wait()
208 if (thread_.joinable())
212 void StoreSession::cancel()
217 void StoreSession::store_proc(vector< shared_ptr<sigrok::Channel> > achannel_list,
218 vector< shared_ptr<data::AnalogSegment> > asegment_list,
219 shared_ptr<data::LogicSegment> lsegment)
221 unsigned progress_scale = 0;
223 /// TODO: Wrap this in a std::unique_ptr when we transition to C++11
224 uint8_t *const ldata = new uint8_t[BlockSize];
229 unsigned int lsamples_per_block = INT_MAX;
230 unsigned int asamples_per_block = INT_MAX;
232 if (!asegment_list.empty()) {
233 // We assume all analog channels use the sample unit size
234 aunit_size = asegment_list.front()->unit_size();
235 asamples_per_block = BlockSize / aunit_size;
238 lunit_size = lsegment->unit_size();
239 lsamples_per_block = BlockSize / lunit_size;
242 // Qt needs the progress values to fit inside an int. If they would
243 // not, scale the current and max values down until they do.
244 while ((sample_count_ >> progress_scale) > INT_MAX)
247 unit_count_ = sample_count_ >> progress_scale;
249 const unsigned int samples_per_block =
250 std::min(asamples_per_block, lsamples_per_block);
252 while (!interrupt_ && sample_count_) {
255 const uint64_t packet_len =
256 std::min((uint64_t)samples_per_block, sample_count_);
259 const auto context = session_.device_manager().context();
261 for (unsigned int i = 0; i < achannel_list.size(); i++) {
262 shared_ptr<sigrok::Channel> achannel = achannel_list.at(i);
263 shared_ptr<data::AnalogSegment> asegment = asegment_list.at(i);
266 asegment->get_samples(start_sample_, start_sample_ + packet_len);
268 // The srzip format currently only supports packets with one
269 // analog channel. See zip_append_analog() in srzip.c
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 lsegment->get_samples(ldata, start_sample_, start_sample_ + packet_len);
286 const size_t length = packet_len * lunit_size;
287 auto logic = context->create_logic_packet(ldata, length, lunit_size);
288 const string ldata_str = output_->receive(logic);
290 if (output_stream_.is_open())
291 output_stream_ << ldata_str;
293 } catch (Error error) {
294 error_ = tr("Error while saving: ") + error.what();
298 sample_count_ -= packet_len;
299 start_sample_ += packet_len;
300 units_stored_ = unit_count_ - (sample_count_ >> progress_scale);
303 // Zeroing the progress variables indicates completion
304 units_stored_ = unit_count_ = 0;
309 output_stream_.close();