pv/data/segment.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_DATA_SEGMENT_HPP
  21 #define PULSEVIEW_PV_DATA_SEGMENT_HPP
  22
  23 #include "pv/util.hpp"
  24
  25 #include <thread>
  26 #include <mutex>
  27 #include <vector>
  28
  29 namespace pv {
  30 namespace data {
  31
  32 class Segment
  33 {
  34 public:
  35         Segment(uint64_t samplerate, unsigned int unit_size);
  36
  37         virtual ~Segment();
  38
  39         uint64_t get_sample_count() const;
  40
  41         const pv::util::Timestamp& start_time() const;
  42
  43         double samplerate() const;
  44         void set_samplerate(double samplerate);
  45
  46         unsigned int unit_size() const;
  47
  48         /**
  49          * @brief Increase the capacity of the segment.
  50          *
  51          * Increasing the capacity allows samples to be appended without needing
  52          * to reallocate memory.
  53          *
  54          * For the best efficiency @c set_capacity() should be called once before
  55          * @c append_data() is called to set up the segment with the expected number
  56          * of samples that will be appended in total.
  57          *
  58          * @note The capacity will automatically be increased when @c append_data()
  59          * is called if there is not enough capacity in the buffer to store the samples.
  60          *
  61          * @param[in] new_capacity The new capacity of the segment. If this value is
  62          *      smaller or equal than the current capacity then the method has no effect.
  63          */
  64         void set_capacity(uint64_t new_capacity);
  65
  66         /**
  67          * @brief Get the current capacity of the segment.
  68          *
  69          * The capacity can be increased by calling @c set_capacity().
  70          *
  71          * @return The current capacity of the segment.
  72          */
  73         uint64_t capacity() const;
  74
  75 protected:
  76         void append_data(void *data, uint64_t samples);
  77
  78 protected:
  79         mutable std::recursive_mutex mutex_;
  80         std::vector<uint8_t> data_;
  81         uint64_t sample_count_;
  82         pv::util::Timestamp start_time_;
  83         double samplerate_;
  84         uint64_t capacity_;
  85         unsigned int unit_size_;
  86 };
  87
  88 } // namespace data
  89 } // namespace pv
  90
  91 #endif // PULSEVIEW_PV_DATA_SEGMENT_HPP