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