2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 #ifndef PULSEVIEW_PV_DATA_SEGMENT_HPP
22 #define PULSEVIEW_PV_DATA_SEGMENT_HPP
24 #include "pv/util.hpp"
36 Segment(uint64_t samplerate, unsigned int unit_size);
40 uint64_t get_sample_count() const;
42 const pv::util::Timestamp& start_time() const;
44 double samplerate() const;
45 void set_samplerate(double samplerate);
47 unsigned int unit_size() const;
50 * @brief Increase the capacity of the segment.
52 * Increasing the capacity allows samples to be appended without needing
53 * to reallocate memory.
55 * For the best efficiency @c set_capacity() should be called once before
56 * @c append_data() is called to set up the segment with the expected number
57 * of samples that will be appended in total.
59 * @note The capacity will automatically be increased when @c append_data()
60 * is called if there is not enough capacity in the buffer to store the samples.
62 * @param[in] new_capacity The new capacity of the segment. If this value is
63 * smaller or equal than the current capacity then the method has no effect.
65 void set_capacity(uint64_t new_capacity);
68 * @brief Get the current capacity of the segment.
70 * The capacity can be increased by calling @c set_capacity().
72 * @return The current capacity of the segment.
74 uint64_t capacity() const;
77 void append_data(void *data, uint64_t samples);
80 mutable std::recursive_mutex mutex_;
81 std::vector<uint8_t> data_;
82 uint64_t sample_count_;
83 pv::util::Timestamp start_time_;
86 unsigned int unit_size_;
92 #endif // PULSEVIEW_PV_DATA_SEGMENT_HPP