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.h"
  24
  25 #include <pv/sigsession.h>
  26 #include <pv/data/logic.h>
  27 #include <pv/data/logicsnapshot.h>
  28 #include <pv/view/signal.h>
  29
  30 #include <libsigrok/libsigrok.hpp>
  31
  32 using std::deque;
  33 using std::dynamic_pointer_cast;
  34 using std::lock_guard;
  35 using std::make_pair;
  36 using std::min;
  37 using std::mutex;
  38 using std::pair;
  39 using std::set;
  40 using std::shared_ptr;
  41 using std::string;
  42 using std::thread;
  43 using std::vector;
  44
  45 using sigrok::ConfigKey;
  46 using sigrok::Error;
  47
  48 namespace pv {
  49
  50 const size_t StoreSession::BlockSize = 1024 * 1024;
  51
  52 StoreSession::StoreSession(const std::string &file_name,
  53         const SigSession &session) :
  54         _file_name(file_name),
  55         _session(session),
  56         _interrupt(false),
  57         _units_stored(0),
  58         _unit_count(0)
  59 {
  60 }
  61
  62 StoreSession::~StoreSession()
  63 {
  64         wait();
  65 }
  66
  67 pair<int, int> StoreSession::progress() const
  68 {
  69         return make_pair(_units_stored.load(), _unit_count.load());
  70 }
  71
  72 const QString& StoreSession::error() const
  73 {
  74         lock_guard<mutex> lock(_mutex);
  75         return _error;
  76 }
  77
  78 bool StoreSession::start()
  79 {
  80         set< shared_ptr<data::SignalData> > data_set =
  81                 _session.get_data();
  82         const vector< shared_ptr<view::Signal> > sigs =
  83                 _session.get_signals();
  84
  85         // Check we have logic data
  86         if (data_set.empty() || sigs.empty()) {
  87                 _error = tr("No data to save.");
  88                 return false;
  89         }
  90
  91         if (data_set.size() > 1) {
  92                 _error = tr("PulseView currently only has support for "
  93                         "storing a single data stream.");
  94                 return false;
  95         }
  96
  97         // Get the logic data
  98         shared_ptr<data::Logic> data;
  99         if (!(data = dynamic_pointer_cast<data::Logic>(*data_set.begin()))) {
 100                 _error = tr("PulseView currently only has support for "
 101                         "storing a logic data.");
 102                 return false;
 103         }
 104
 105         // Get the snapshot
 106         const deque< shared_ptr<data::LogicSnapshot> > &snapshots =
 107                 data->get_snapshots();
 108
 109         if (snapshots.empty()) {
 110                 _error = tr("No snapshots to save.");
 111                 return false;
 112         }
 113
 114         const shared_ptr<data::LogicSnapshot> snapshot(snapshots.front());
 115         assert(snapshot);
 116
 117         // Begin storing
 118         try {
 119                 auto context = _session._sr_session->context();
 120                 auto output_format = context->output_formats()["srzip"];
 121                 auto device = _session.get_device();
 122                 _output = output_format->create_output(device,
 123                         {{"filename",
 124                                 Glib::Variant<Glib::ustring>::create(_file_name)}});
 125                 auto meta = context->create_meta_packet(
 126                         {{ConfigKey::SAMPLERATE,
 127                                 Glib::Variant<guint64>::create(data->samplerate())}});
 128                 _output->receive(meta);
 129         } catch (Error error) {
 130                 _error = tr("Error while saving.");
 131                 return false;
 132         }
 133
 134         _thread = std::thread(&StoreSession::store_proc, this, snapshot);
 135         return true;
 136 }
 137
 138 void StoreSession::wait()
 139 {
 140         if (_thread.joinable())
 141                 _thread.join();
 142 }
 143
 144 void StoreSession::cancel()
 145 {
 146         _interrupt = true;
 147 }
 148
 149 void StoreSession::store_proc(shared_ptr<data::LogicSnapshot> snapshot)
 150 {
 151         assert(snapshot);
 152
 153         uint64_t start_sample = 0, sample_count;
 154         unsigned progress_scale = 0;
 155
 156         /// TODO: Wrap this in a std::unique_ptr when we transition to C++11
 157         uint8_t *const data = new uint8_t[BlockSize];
 158         assert(data);
 159
 160         const int unit_size = snapshot->unit_size();
 161         assert(unit_size != 0);
 162
 163         sample_count = snapshot->get_sample_count();
 164
 165         // Qt needs the progress values to fit inside an int.  If they would
 166         // not, scale the current and max values down until they do.
 167         while ((sample_count >> progress_scale) > INT_MAX)
 168                 progress_scale ++;
 169
 170         _unit_count = sample_count >> progress_scale;
 171
 172         const unsigned int samples_per_block = BlockSize / unit_size;
 173
 174         while (!_interrupt && start_sample < sample_count)
 175         {
 176                 progress_updated();
 177
 178                 const uint64_t end_sample = min(
 179                         start_sample + samples_per_block, sample_count);
 180                 snapshot->get_samples(data, start_sample, end_sample);
 181
 182                 size_t length = end_sample - start_sample;
 183
 184                 try {
 185                         auto context = _session._sr_session->context();
 186                         auto logic = context->create_logic_packet(data, length, unit_size);
 187                         _output->receive(logic);
 188                 } catch (Error error) {
 189                         _error = tr("Error while saving.");
 190                         break;
 191                 }
 192
 193                 start_sample = end_sample;
 194                 _units_stored = start_sample >> progress_scale;
 195         }
 196
 197         progress_updated();
 198
 199         _output.reset();
 200
 201         delete[] data;
 202 }
 203
 204 } // pv