Implement showing only the selected segment
[pulseview.git] / pv / data / analogsegment.cpp
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 #include <extdef.h>
21
22 #include <cassert>
23 #include <cmath>
24 #include <cstdlib>
25 #include <cstring>
26 #include <memory>
27
28 #include <algorithm>
29
30 #include "analog.hpp"
31 #include "analogsegment.hpp"
32
33 using std::lock_guard;
34 using std::recursive_mutex;
35 using std::make_pair;
36 using std::max;
37 using std::max_element;
38 using std::min;
39 using std::min_element;
40 using std::pair;
41 using std::unique_ptr;
42
43 namespace pv {
44 namespace data {
45
46 const int AnalogSegment::EnvelopeScalePower = 4;
47 const int AnalogSegment::EnvelopeScaleFactor = 1 << EnvelopeScalePower;
48 const float AnalogSegment::LogEnvelopeScaleFactor = logf(EnvelopeScaleFactor);
49 const uint64_t AnalogSegment::EnvelopeDataUnit = 64 * 1024;     // bytes
50
51 AnalogSegment::AnalogSegment(Analog& owner, uint64_t samplerate) :
52         Segment(samplerate, sizeof(float)),
53         owner_(owner),
54         min_value_(0),
55         max_value_(0)
56 {
57         lock_guard<recursive_mutex> lock(mutex_);
58         memset(envelope_levels_, 0, sizeof(envelope_levels_));
59 }
60
61 AnalogSegment::~AnalogSegment()
62 {
63         lock_guard<recursive_mutex> lock(mutex_);
64         for (Envelope &e : envelope_levels_)
65                 free(e.samples);
66 }
67
68 void AnalogSegment::append_interleaved_samples(const float *data,
69         size_t sample_count, size_t stride)
70 {
71         assert(unit_size_ == sizeof(float));
72
73         lock_guard<recursive_mutex> lock(mutex_);
74
75         uint64_t prev_sample_count = sample_count_;
76
77         // Deinterleave the samples and add them
78         unique_ptr<float> deint_data(new float[sample_count]);
79         float *deint_data_ptr = deint_data.get();
80         for (uint32_t i = 0; i < sample_count; i++) {
81                 *deint_data_ptr = (float)(*data);
82                 deint_data_ptr++;
83                 data += stride;
84         }
85
86         append_samples(deint_data.get(), sample_count);
87
88         // Generate the first mip-map from the data
89         append_payload_to_envelope_levels();
90
91         if (sample_count > 1)
92                 owner_.notify_samples_added(this, prev_sample_count + 1,
93                         prev_sample_count + 1 + sample_count);
94         else
95                 owner_.notify_samples_added(this, prev_sample_count + 1,
96                         prev_sample_count + 1);
97 }
98
99 void AnalogSegment::get_samples(int64_t start_sample, int64_t end_sample,
100         float* dest) const
101 {
102         assert(start_sample >= 0);
103         assert(start_sample < (int64_t)sample_count_);
104         assert(end_sample >= 0);
105         assert(end_sample <= (int64_t)sample_count_);
106         assert(start_sample <= end_sample);
107         assert(dest != nullptr);
108
109         lock_guard<recursive_mutex> lock(mutex_);
110
111         get_raw_samples(start_sample, (end_sample - start_sample), (uint8_t*)dest);
112 }
113
114 const pair<float, float> AnalogSegment::get_min_max() const
115 {
116         return make_pair(min_value_, max_value_);
117 }
118
119 SegmentAnalogDataIterator* AnalogSegment::begin_sample_iteration(uint64_t start)
120 {
121         return (SegmentAnalogDataIterator*)begin_raw_sample_iteration(start);
122 }
123
124 void AnalogSegment::continue_sample_iteration(SegmentAnalogDataIterator* it, uint64_t increase)
125 {
126         Segment::continue_raw_sample_iteration((SegmentRawDataIterator*)it, increase);
127 }
128
129 void AnalogSegment::end_sample_iteration(SegmentAnalogDataIterator* it)
130 {
131         Segment::end_raw_sample_iteration((SegmentRawDataIterator*)it);
132 }
133
134 void AnalogSegment::get_envelope_section(EnvelopeSection &s,
135         uint64_t start, uint64_t end, float min_length) const
136 {
137         assert(end <= get_sample_count());
138         assert(start <= end);
139         assert(min_length > 0);
140
141         lock_guard<recursive_mutex> lock(mutex_);
142
143         const unsigned int min_level = max((int)floorf(logf(min_length) /
144                 LogEnvelopeScaleFactor) - 1, 0);
145         const unsigned int scale_power = (min_level + 1) *
146                 EnvelopeScalePower;
147         start >>= scale_power;
148         end >>= scale_power;
149
150         s.start = start << scale_power;
151         s.scale = 1 << scale_power;
152         s.length = end - start;
153         s.samples = new EnvelopeSample[s.length];
154         memcpy(s.samples, envelope_levels_[min_level].samples + start,
155                 s.length * sizeof(EnvelopeSample));
156 }
157
158 void AnalogSegment::reallocate_envelope(Envelope &e)
159 {
160         const uint64_t new_data_length = ((e.length + EnvelopeDataUnit - 1) /
161                 EnvelopeDataUnit) * EnvelopeDataUnit;
162         if (new_data_length > e.data_length) {
163                 e.data_length = new_data_length;
164                 e.samples = (EnvelopeSample*)realloc(e.samples,
165                         new_data_length * sizeof(EnvelopeSample));
166         }
167 }
168
169 void AnalogSegment::append_payload_to_envelope_levels()
170 {
171         Envelope &e0 = envelope_levels_[0];
172         uint64_t prev_length;
173         EnvelopeSample *dest_ptr;
174         SegmentRawDataIterator* it;
175
176         // Expand the data buffer to fit the new samples
177         prev_length = e0.length;
178         e0.length = sample_count_ / EnvelopeScaleFactor;
179
180         // Calculate min/max values in case we have too few samples for an envelope
181         const float old_min_value = min_value_, old_max_value = max_value_;
182         if (sample_count_ < EnvelopeScaleFactor) {
183                 it = begin_raw_sample_iteration(0);
184                 for (uint64_t i = 0; i < sample_count_; i++) {
185                         const float sample = *((float*)it->value);
186                         if (sample < min_value_)
187                                 min_value_ = sample;
188                         if (sample > max_value_)
189                                 max_value_ = sample;
190                         continue_raw_sample_iteration(it, 1);
191                 }
192                 end_raw_sample_iteration(it);
193         }
194
195         // Break off if there are no new samples to compute
196         if (e0.length == prev_length)
197                 return;
198
199         reallocate_envelope(e0);
200
201         dest_ptr = e0.samples + prev_length;
202
203         // Iterate through the samples to populate the first level mipmap
204         uint64_t start_sample = prev_length * EnvelopeScaleFactor;
205         uint64_t end_sample = e0.length * EnvelopeScaleFactor;
206
207         it = begin_raw_sample_iteration(start_sample);
208         for (uint64_t i = start_sample; i < end_sample; i += EnvelopeScaleFactor) {
209                 const float* samples = (float*)it->value;
210
211                 const EnvelopeSample sub_sample = {
212                         *min_element(samples, samples + EnvelopeScaleFactor),
213                         *max_element(samples, samples + EnvelopeScaleFactor),
214                 };
215
216                 if (sub_sample.min < min_value_)
217                         min_value_ = sub_sample.min;
218                 if (sub_sample.max > max_value_)
219                         max_value_ = sub_sample.max;
220
221                 continue_raw_sample_iteration(it, EnvelopeScaleFactor);
222                 *dest_ptr++ = sub_sample;
223         }
224         end_raw_sample_iteration(it);
225
226         // Compute higher level mipmaps
227         for (unsigned int level = 1; level < ScaleStepCount; level++) {
228                 Envelope &e = envelope_levels_[level];
229                 const Envelope &el = envelope_levels_[level - 1];
230
231                 // Expand the data buffer to fit the new samples
232                 prev_length = e.length;
233                 e.length = el.length / EnvelopeScaleFactor;
234
235                 // Break off if there are no more samples to be computed
236                 if (e.length == prev_length)
237                         break;
238
239                 reallocate_envelope(e);
240
241                 // Subsample the lower level
242                 const EnvelopeSample *src_ptr =
243                         el.samples + prev_length * EnvelopeScaleFactor;
244                 const EnvelopeSample *const end_dest_ptr = e.samples + e.length;
245
246                 for (dest_ptr = e.samples + prev_length;
247                                 dest_ptr < end_dest_ptr; dest_ptr++) {
248                         const EnvelopeSample *const end_src_ptr =
249                                 src_ptr + EnvelopeScaleFactor;
250
251                         EnvelopeSample sub_sample = *src_ptr++;
252                         while (src_ptr < end_src_ptr) {
253                                 sub_sample.min = min(sub_sample.min, src_ptr->min);;
254                                 sub_sample.max = max(sub_sample.max, src_ptr->max);
255                                 src_ptr++;
256                         }
257
258                         *dest_ptr = sub_sample;
259                 }
260         }
261
262         // Notify if the min or max value changed
263         if ((old_min_value != min_value_) || (old_max_value != max_value_))
264                 owner_.min_max_changed(min_value_, max_value_);
265 }
266
267 } // namespace data
268 } // namespace pv