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