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