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