Use nullptr in a few places.
[pulseview.git] / pv / data / logicsegment.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_LOGICSEGMENT_HPP
21 #define PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP
22
23 #include "segment.hpp"
24
25 #include <utility>
26 #include <vector>
27
28 #include <QObject>
29
30 namespace sigrok {
31         class Logic;
32 }
33
34 namespace LogicSegmentTest {
35 struct Pow2;
36 struct Basic;
37 struct LargeData;
38 struct Pulses;
39 struct LongPulses;
40 }
41
42 namespace pv {
43 namespace data {
44
45 class Logic;
46
47 typedef struct {
48         uint64_t sample_index, chunk_num, chunk_offs;
49         uint8_t* chunk;
50         uint8_t* value;
51 } SegmentLogicDataIterator;
52
53 class LogicSegment : public QObject, public Segment
54 {
55         Q_OBJECT
56
57 private:
58         struct MipMapLevel
59         {
60                 uint64_t length;
61                 uint64_t data_length;
62                 void *data;
63         };
64
65 private:
66         static const unsigned int ScaleStepCount = 10;
67         static const int MipMapScalePower;
68         static const int MipMapScaleFactor;
69         static const float LogMipMapScaleFactor;
70         static const uint64_t MipMapDataUnit;
71
72 public:
73         typedef std::pair<int64_t, bool> EdgePair;
74
75 public:
76         LogicSegment(pv::data::Logic& owner, std::shared_ptr<sigrok::Logic> data, uint64_t samplerate);
77
78         virtual ~LogicSegment();
79
80         void append_payload(std::shared_ptr<sigrok::Logic> logic);
81
82         const uint8_t* get_samples(int64_t start_sample, int64_t end_sample) const;
83
84         SegmentLogicDataIterator* begin_sample_iteration(uint64_t start);
85         void continue_sample_iteration(SegmentLogicDataIterator* it, uint64_t increase);
86         void end_sample_iteration(SegmentLogicDataIterator* it);
87
88 private:
89         uint64_t unpack_sample(const uint8_t *ptr) const;
90         void pack_sample(uint8_t *ptr, uint64_t value);
91         
92         void reallocate_mipmap_level(MipMapLevel &m);
93
94         void append_payload_to_mipmap();
95
96         uint64_t get_unpacked_sample(uint64_t index) const;
97
98 public:
99         /**
100          * Parses a logic data segment to generate a list of transitions
101          * in a time interval to a given level of detail.
102          * @param[out] edges The vector to place the edges into.
103          * @param[in] start The start sample index.
104          * @param[in] end The end sample index.
105          * @param[in] min_length The minimum number of samples that
106          * can be resolved at this level of detail.
107          * @param[in] sig_index The index of the signal.
108          */
109         void get_subsampled_edges(std::vector<EdgePair> &edges,
110                 uint64_t start, uint64_t end,
111                 float min_length, int sig_index);
112
113 private:
114         uint64_t get_subsample(int level, uint64_t offset) const;
115
116         static uint64_t pow2_ceil(uint64_t x, unsigned int power);
117
118 private:
119         Logic& owner_;
120
121         struct MipMapLevel mip_map_[ScaleStepCount];
122         uint64_t last_append_sample_;
123
124         friend struct LogicSegmentTest::Pow2;
125         friend struct LogicSegmentTest::Basic;
126         friend struct LogicSegmentTest::LargeData;
127         friend struct LogicSegmentTest::Pulses;
128         friend struct LogicSegmentTest::LongPulses;
129 };
130
131 } // namespace data
132 } // namespace pv
133
134 #endif // PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP