Use nullptr in a few places.
[pulseview.git] / pv / data / analogsegment.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_ANALOGSEGMENT_HPP
21 #define PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP
22
23 #include "segment.hpp"
24
25 #include <utility>
26 #include <vector>
27
28 #include <QObject>
29
30 namespace AnalogSegmentTest {
31 struct Basic;
32 }
33
34 namespace pv {
35 namespace data {
36
37 class Analog;
38
39 typedef struct {
40         uint64_t sample_index, chunk_num, chunk_offs;
41         uint8_t* chunk;
42         float* value;
43 } SegmentAnalogDataIterator;
44
45 class AnalogSegment : public QObject, public Segment
46 {
47         Q_OBJECT
48
49 public:
50         struct EnvelopeSample
51         {
52                 float min;
53                 float max;
54         };
55
56         struct EnvelopeSection
57         {
58                 uint64_t start;
59                 unsigned int scale;
60                 uint64_t length;
61                 EnvelopeSample *samples;
62         };
63
64 private:
65         struct Envelope
66         {
67                 uint64_t length;
68                 uint64_t data_length;
69                 EnvelopeSample *samples;
70         };
71
72 private:
73         static const unsigned int ScaleStepCount = 10;
74         static const int EnvelopeScalePower;
75         static const int EnvelopeScaleFactor;
76         static const float LogEnvelopeScaleFactor;
77         static const uint64_t EnvelopeDataUnit;
78
79 public:
80         AnalogSegment(Analog& owner, uint64_t samplerate);
81
82         virtual ~AnalogSegment();
83
84         void append_interleaved_samples(const float *data,
85                 size_t sample_count, size_t stride);
86
87         const float* get_samples(int64_t start_sample,
88                 int64_t end_sample) const;
89
90         const std::pair<float, float> get_min_max() const;
91
92         SegmentAnalogDataIterator* begin_sample_iteration(uint64_t start);
93         void continue_sample_iteration(SegmentAnalogDataIterator* it, uint64_t increase);
94         void end_sample_iteration(SegmentAnalogDataIterator* it);
95
96         void get_envelope_section(EnvelopeSection &s,
97                 uint64_t start, uint64_t end, float min_length) const;
98
99 private:
100         void reallocate_envelope(Envelope &e);
101
102         void append_payload_to_envelope_levels();
103
104 private:
105         Analog& owner_;
106
107         struct Envelope envelope_levels_[ScaleStepCount];
108
109         float min_value_, max_value_;
110
111         friend struct AnalogSegmentTest::Basic;
112 };
113
114 } // namespace data
115 } // namespace pv
116
117 #endif // PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP