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         set< shared_ptr<data::SignalData> > data_set =
  95                 session_.get_data();
  96
  97         shared_lock<shared_mutex> lock(session_.signals_mutex());
  98         const unordered_set< shared_ptr<view::Signal> > &sigs(
  99                 session_.signals());
 100
 101         // Check we have logic data
 102         if (data_set.empty() || sigs.empty()) {
 103                 error_ = tr("No data to save.");
 104                 return false;
 105         }
 106
 107         if (data_set.size() > 1) {
 108                 error_ = tr("PulseView currently only has support for "
 109                         "storing a single data stream.");
 110                 return false;
 111         }
 112
 113         // Get the logic data
 114         shared_ptr<data::Logic> data;
 115         if (!(data = dynamic_pointer_cast<data::Logic>(*data_set.begin()))) {
 116                 error_ = tr("PulseView currently only has support for "
 117                         "storing a logic data.");
 118                 return false;
 119         }
 120
 121         // Get the segment
 122         const deque< shared_ptr<data::LogicSegment> > &segments =
 123                 data->logic_segments();
 124
 125         if (segments.empty()) {
 126                 error_ = tr("No segments to save.");
 127                 return false;
 128         }
 129
 130         const shared_ptr<data::LogicSegment> segment(segments.front());
 131         assert(segment);
 132
 133         // Begin storing
 134         try {
 135                 const auto context = session_.device_manager().context();
 136                 auto device = session_.device()->device();
 137
 138                 map<string, Glib::VariantBase> options = options_;
 139
 140                 // If the output has the capability to write files, use it.
 141                 // Otherwise, open the output stream.
 142                 const auto opt_list = output_format_->options();
 143                 if (opt_list.find("filename") != opt_list.end())
 144                         options["filename"] =
 145                                 Glib::Variant<Glib::ustring>::create(file_name_);
 146                 else
 147                         output_stream_.open(file_name_, ios_base::binary |
 148                                 ios_base::trunc | ios_base::out);
 149
 150                 output_ = output_format_->create_output(device, options);
 151                 auto meta = context->create_meta_packet(
 152                         {{ConfigKey::SAMPLERATE, Glib::Variant<guint64>::create(
 153                                 segment->samplerate())}});
 154                 output_->receive(meta);
 155         } catch (Error error) {
 156                 error_ = tr("Error while saving.");
 157                 return false;
 158         }
 159
 160         thread_ = std::thread(&StoreSession::store_proc, this, segment);
 161         return true;
 162 }
 163
 164 void StoreSession::wait()
 165 {
 166         if (thread_.joinable())
 167                 thread_.join();
 168 }
 169
 170 void StoreSession::cancel()
 171 {
 172         interrupt_ = true;
 173 }
 174
 175 void StoreSession::store_proc(shared_ptr<data::LogicSegment> segment)
 176 {
 177         assert(segment);
 178
 179         uint64_t start_sample = 0, sample_count;
 180         unsigned progress_scale = 0;
 181
 182         /// TODO: Wrap this in a std::unique_ptr when we transition to C++11
 183         uint8_t *const data = new uint8_t[BlockSize];
 184         assert(data);
 185
 186         const int unit_size = segment->unit_size();
 187         assert(unit_size != 0);
 188
 189         sample_count = segment->get_sample_count();
 190
 191         // Qt needs the progress values to fit inside an int.  If they would
 192         // not, scale the current and max values down until they do.
 193         while ((sample_count >> progress_scale) > INT_MAX)
 194                 progress_scale ++;
 195
 196         unit_count_ = sample_count >> progress_scale;
 197
 198         const unsigned int samples_per_block = BlockSize / unit_size;
 199
 200         while (!interrupt_ && start_sample < sample_count)
 201         {
 202                 progress_updated();
 203
 204                 const uint64_t end_sample = min(
 205                         start_sample + samples_per_block, sample_count);
 206                 segment->get_samples(data, start_sample, end_sample);
 207
 208                 size_t length = end_sample - start_sample;
 209
 210                 try {
 211                         const auto context = session_.device_manager().context();
 212                         auto logic = context->create_logic_packet(data, length, unit_size);
 213                         const string data = output_->receive(logic);
 214                         if (output_stream_.is_open())
 215                                 output_stream_ << data;
 216                 } catch (Error error) {
 217                         error_ = tr("Error while saving.");
 218                         break;
 219                 }
 220
 221                 start_sample = end_sample;
 222                 units_stored_ = start_sample >> progress_scale;
 223         }
 224
 225         // Zeroing the progress variables indicates completion
 226         units_stored_ = unit_count_ = 0;
 227
 228         progress_updated();
 229
 230         output_.reset();
 231         output_stream_.close();
 232
 233         delete[] data;
 234 }
 235
 236 } // pv