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