ViewItemPaintParams: Added vertical layout information
[pulseview.git] / pv / storesession.cpp
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
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
19  */
20
21 #include <cassert>
22
23 #include "storesession.hpp"
24
25 #include <pv/session.hpp>
26 #include <pv/data/logic.hpp>
27 #include <pv/data/logicsegment.hpp>
28 #include <pv/view/signal.hpp>
29
30 #include <libsigrok/libsigrok.hpp>
31
32 using boost::shared_lock;
33 using boost::shared_mutex;
34
35 using std::deque;
36 using std::dynamic_pointer_cast;
37 using std::lock_guard;
38 using std::make_pair;
39 using std::min;
40 using std::mutex;
41 using std::pair;
42 using std::set;
43 using std::shared_ptr;
44 using std::string;
45 using std::thread;
46 using std::vector;
47
48 using sigrok::ConfigKey;
49 using sigrok::Error;
50
51 namespace pv {
52
53 const size_t StoreSession::BlockSize = 1024 * 1024;
54
55 StoreSession::StoreSession(const std::string &file_name,
56         const Session &session) :
57         file_name_(file_name),
58         session_(session),
59         interrupt_(false),
60         units_stored_(0),
61         unit_count_(0)
62 {
63 }
64
65 StoreSession::~StoreSession()
66 {
67         wait();
68 }
69
70 pair<int, int> StoreSession::progress() const
71 {
72         return make_pair(units_stored_.load(), unit_count_.load());
73 }
74
75 const QString& StoreSession::error() const
76 {
77         lock_guard<mutex> lock(mutex_);
78         return error_;
79 }
80
81 bool StoreSession::start()
82 {
83         set< shared_ptr<data::SignalData> > data_set =
84                 session_.get_data();
85
86         shared_lock<shared_mutex> lock(session_.signals_mutex());
87         const vector< shared_ptr<view::Signal> > &sigs(session_.signals());
88
89         // Check we have logic data
90         if (data_set.empty() || sigs.empty()) {
91                 error_ = tr("No data to save.");
92                 return false;
93         }
94
95         if (data_set.size() > 1) {
96                 error_ = tr("PulseView currently only has support for "
97                         "storing a single data stream.");
98                 return false;
99         }
100
101         // Get the logic data
102         shared_ptr<data::Logic> data;
103         if (!(data = dynamic_pointer_cast<data::Logic>(*data_set.begin()))) {
104                 error_ = tr("PulseView currently only has support for "
105                         "storing a logic data.");
106                 return false;
107         }
108
109         // Get the segment
110         const deque< shared_ptr<data::LogicSegment> > &segments =
111                 data->logic_segments();
112
113         if (segments.empty()) {
114                 error_ = tr("No segments to save.");
115                 return false;
116         }
117
118         const shared_ptr<data::LogicSegment> segment(segments.front());
119         assert(segment);
120
121         // Begin storing
122         try {
123                 auto context = session_.session()->context();
124                 auto output_format = context->output_formats()["srzip"];
125                 auto device = session_.device();
126                 output_ = output_format->create_output(device,
127                         {{"filename",
128                                 Glib::Variant<Glib::ustring>::create(file_name_)}});
129                 auto meta = context->create_meta_packet(
130                         {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create(
131                                 segment->samplerate())}});
132                 output_->receive(meta);
133         } catch (Error error) {
134                 error_ = tr("Error while saving.");
135                 return false;
136         }
137
138         thread_ = std::thread(&StoreSession::store_proc, this, segment);
139         return true;
140 }
141
142 void StoreSession::wait()
143 {
144         if (thread_.joinable())
145                 thread_.join();
146 }
147
148 void StoreSession::cancel()
149 {
150         interrupt_ = true;
151 }
152
153 void StoreSession::store_proc(shared_ptr<data::LogicSegment> segment)
154 {
155         assert(segment);
156
157         uint64_t start_sample = 0, sample_count;
158         unsigned progress_scale = 0;
159
160         /// TODO: Wrap this in a std::unique_ptr when we transition to C++11
161         uint8_t *const data = new uint8_t[BlockSize];
162         assert(data);
163
164         const int unit_size = segment->unit_size();
165         assert(unit_size != 0);
166
167         sample_count = segment->get_sample_count();
168
169         // Qt needs the progress values to fit inside an int.  If they would
170         // not, scale the current and max values down until they do.
171         while ((sample_count >> progress_scale) > INT_MAX)
172                 progress_scale ++;
173
174         unit_count_ = sample_count >> progress_scale;
175
176         const unsigned int samples_per_block = BlockSize / unit_size;
177
178         while (!interrupt_ && start_sample < sample_count)
179         {
180                 progress_updated();
181
182                 const uint64_t end_sample = min(
183                         start_sample + samples_per_block, sample_count);
184                 segment->get_samples(data, start_sample, end_sample);
185
186                 size_t length = end_sample - start_sample;
187
188                 try {
189                         auto context = session_.session()->context();
190                         auto logic = context->create_logic_packet(data, length, unit_size);
191                         output_->receive(logic);
192                 } catch (Error error) {
193                         error_ = tr("Error while saving.");
194                         break;
195                 }
196
197                 start_sample = end_sample;
198                 units_stored_ = start_sample >> progress_scale;
199         }
200
201         // Zeroing the progress variables indicates completion
202         units_stored_ = unit_count_ = 0;
203
204         progress_updated();
205
206         output_.reset();
207
208         delete[] data;
209 }
210
211 } // pv