2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP
21 #define PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP
23 #include "segment.hpp"
29 using std::enable_shared_from_this;
31 using std::shared_ptr;
38 namespace LogicSegmentTest {
51 class LogicSegment : public Segment, public enable_shared_from_this<Segment>
56 typedef pair<int64_t, bool> EdgePair;
58 static const unsigned int ScaleStepCount = 10;
59 static const int MipMapScalePower;
60 static const int MipMapScaleFactor;
61 static const float LogMipMapScaleFactor;
62 static const uint64_t MipMapDataUnit;
73 LogicSegment(pv::data::Logic& owner, uint32_t segment_id,
74 unsigned int unit_size, uint64_t samplerate);
76 virtual ~LogicSegment();
79 * Using enable_shared_from_this prevents the normal use of shared_ptr
80 * instances by users of LogicSegment instances. Instead, shared_ptrs may
81 * only be created by the instance itself.
82 * See https://en.cppreference.com/w/cpp/memory/enable_shared_from_this
84 shared_ptr<const LogicSegment> get_shared_ptr() const;
86 void append_payload(shared_ptr<sigrok::Logic> logic);
87 void append_payload(void *data, uint64_t data_size);
90 * Appends sample data for a single channel where each byte
91 * represents one sample - if it's 0 the state is low, if 1 high.
92 * Other values are not permitted.
93 * Assumes that all channels are having samples added and in the
94 * order of 0..n, not n..0.
95 * Also assumes the the number of samples added for each channel
96 * is constant for every invokation for 0..n. The number of samples
97 * hence may only change when index is 0.
99 void append_subsignal_payload(unsigned int index, void *data,
100 uint64_t data_size, vector<uint8_t>& destination);
102 void get_samples(int64_t start_sample, int64_t end_sample, uint8_t* dest) const;
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.
114 void get_subsampled_edges(vector<EdgePair> &edges,
115 uint64_t start, uint64_t end,
116 float min_length, int sig_index, bool first_change_only = false);
118 void get_surrounding_edges(vector<EdgePair> &dest,
119 uint64_t origin_sample, float min_length, int sig_index);
122 uint64_t unpack_sample(const uint8_t *ptr) const;
123 void pack_sample(uint8_t *ptr, uint64_t value);
125 void reallocate_mipmap_level(MipMapLevel &m);
127 void append_payload_to_mipmap();
129 uint64_t get_unpacked_sample(uint64_t index) const;
131 template <class T> void downsampleTmain(const T*&in, T &acc, T &prev);
132 template <class T> void downsampleT(const uint8_t *in, uint8_t *&out, uint64_t len);
133 void downsampleGeneric(const uint8_t *in, uint8_t *&out, uint64_t len);
136 uint64_t get_subsample(int level, uint64_t offset) const;
138 static uint64_t pow2_ceil(uint64_t x, unsigned int power);
143 struct MipMapLevel mip_map_[ScaleStepCount];
144 uint64_t last_append_sample_;
145 uint64_t last_append_accumulator_;
146 uint64_t last_append_extra_;
148 friend struct LogicSegmentTest::Pow2;
149 friend struct LogicSegmentTest::Basic;
150 friend struct LogicSegmentTest::LargeData;
151 friend struct LogicSegmentTest::Pulses;
152 friend struct LogicSegmentTest::LongPulses;
158 #endif // PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP