Standardize on 'event' as name for all Qt events.
[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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP
22 #define PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP
23
24 #include "segment.hpp"
25
26 #include <utility>
27 #include <vector>
28
29 namespace sigrok {
30         class Logic;
31 }
32
33 namespace LogicSegmentTest {
34 struct Pow2;
35 struct Basic;
36 struct LargeData;
37 struct Pulses;
38 struct LongPulses;
39 }
40
41 namespace pv {
42 namespace data {
43
44 class LogicSegment : public Segment
45 {
46 private:
47         struct MipMapLevel
48         {
49                 uint64_t length;
50                 uint64_t data_length;
51                 void *data;
52         };
53
54 private:
55         static const unsigned int ScaleStepCount = 10;
56         static const int MipMapScalePower;
57         static const int MipMapScaleFactor;
58         static const float LogMipMapScaleFactor;
59         static const uint64_t MipMapDataUnit;
60
61 public:
62         typedef std::pair<int64_t, bool> EdgePair;
63
64 public:
65         LogicSegment(std::shared_ptr<sigrok::Logic> logic,
66                 uint64_t samplerate, uint64_t expected_num_samples = 0);
67
68         virtual ~LogicSegment();
69
70         void append_payload(std::shared_ptr<sigrok::Logic> logic);
71
72         void get_samples(uint8_t *const data,
73                 int64_t start_sample, int64_t end_sample) const;
74
75 private:
76         uint64_t unpack_sample(const uint8_t *ptr) const;
77         void pack_sample(uint8_t *ptr, uint64_t value);
78         
79         void reallocate_mipmap_level(MipMapLevel &m);
80
81         void append_payload_to_mipmap();
82
83         uint64_t get_sample(uint64_t index) const;
84
85 public:
86         /**
87          * Parses a logic data segment to generate a list of transitions
88          * in a time interval to a given level of detail.
89          * @param[out] edges The vector to place the edges into.
90          * @param[in] start The start sample index.
91          * @param[in] end The end sample index.
92          * @param[in] min_length The minimum number of samples that
93          * can be resolved at this level of detail.
94          * @param[in] sig_index The index of the signal.
95          */
96         void get_subsampled_edges(std::vector<EdgePair> &edges,
97                 uint64_t start, uint64_t end,
98                 float min_length, int sig_index);
99
100 private:
101         uint64_t get_subsample(int level, uint64_t offset) const;
102
103         static uint64_t pow2_ceil(uint64_t x, unsigned int power);
104
105 private:
106         struct MipMapLevel mip_map_[ScaleStepCount];
107         uint64_t last_append_sample_;
108
109         friend struct LogicSegmentTest::Pow2;
110         friend struct LogicSegmentTest::Basic;
111         friend struct LogicSegmentTest::LargeData;
112         friend struct LogicSegmentTest::Pulses;
113         friend struct LogicSegmentTest::LongPulses;
114 };
115
116 } // namespace data
117 } // namespace pv
118
119 #endif // PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP