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