]>
Commit | Line | Data |
---|---|---|
28a4c9c5 | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
28a4c9c5 JH |
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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
a38268f0 SA |
21 | #ifndef PULSEVIEW_PV_DATA_SEGMENT_HPP |
22 | #define PULSEVIEW_PV_DATA_SEGMENT_HPP | |
640d091b | 23 | |
60d9b99a JS |
24 | #include "pv/util.hpp" |
25 | ||
3b68d03d JH |
26 | #include <thread> |
27 | #include <mutex> | |
c82c7e4e | 28 | #include <vector> |
7d29656f | 29 | |
51e77110 | 30 | namespace pv { |
1b1ec774 | 31 | namespace data { |
51e77110 | 32 | |
f3d66e52 | 33 | class Segment |
28a4c9c5 JH |
34 | { |
35 | public: | |
f3d66e52 | 36 | Segment(uint64_t samplerate, unsigned int unit_size); |
f556bc6a | 37 | |
f3d66e52 | 38 | virtual ~Segment(); |
28a4c9c5 | 39 | |
e7c6e898 | 40 | uint64_t get_sample_count() const; |
28a4c9c5 | 41 | |
60d9b99a | 42 | const pv::util::Timestamp& start_time() const; |
7f4038d6 | 43 | |
ff008de6 JH |
44 | double samplerate() const; |
45 | void set_samplerate(double samplerate); | |
46 | ||
5ad3b48b | 47 | unsigned int unit_size() const; |
6fd14a32 | 48 | |
27d7c96b | 49 | /** |
f3d66e52 | 50 | * @brief Increase the capacity of the segment. |
27d7c96b DK |
51 | * |
52 | * Increasing the capacity allows samples to be appended without needing | |
53 | * to reallocate memory. | |
54 | * | |
55 | * For the best efficiency @c set_capacity() should be called once before | |
f3d66e52 | 56 | * @c append_data() is called to set up the segment with the expected number |
27d7c96b DK |
57 | * of samples that will be appended in total. |
58 | * | |
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. | |
61 | * | |
f3d66e52 | 62 | * @param[in] new_capacity The new capacity of the segment. If this value is |
27d7c96b DK |
63 | * smaller or equal than the current capacity then the method has no effect. |
64 | */ | |
65 | void set_capacity(uint64_t new_capacity); | |
66 | ||
67 | /** | |
f3d66e52 | 68 | * @brief Get the current capacity of the segment. |
27d7c96b DK |
69 | * |
70 | * The capacity can be increased by calling @c set_capacity(). | |
71 | * | |
f3d66e52 | 72 | * @return The current capacity of the segment. |
27d7c96b DK |
73 | */ |
74 | uint64_t capacity() const; | |
75 | ||
28a4c9c5 | 76 | protected: |
77bff0b1 | 77 | void append_data(void *data, uint64_t samples); |
f556bc6a JH |
78 | |
79 | protected: | |
8dbbc7f0 JH |
80 | mutable std::recursive_mutex mutex_; |
81 | std::vector<uint8_t> data_; | |
82 | uint64_t sample_count_; | |
60d9b99a | 83 | pv::util::Timestamp start_time_; |
ff008de6 | 84 | double samplerate_; |
8dbbc7f0 JH |
85 | uint64_t capacity_; |
86 | unsigned int unit_size_; | |
28a4c9c5 | 87 | }; |
51e77110 | 88 | |
1b1ec774 | 89 | } // namespace data |
51e77110 | 90 | } // namespace pv |
640d091b | 91 | |
a38268f0 | 92 | #endif // PULSEVIEW_PV_DATA_SEGMENT_HPP |