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