f3c637cb856e119b9d3d8b5d29efb7ade5bc392d
[pulseview.git] / logicdatasnapshot.h
1 /*
2  * This file is part of the sigrok 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 #include "datasnapshot.h"
22
23 #include <utility>
24 #include <vector>
25
26 namespace LogicDataSnapshotTest {
27         class Pow2;
28         class Basic;
29         class LargeData;
30         class Pulses;
31         class LongPulses;
32 }
33
34 class LogicDataSnapshot : public DataSnapshot
35 {
36 private:
37         struct MipMapLevel
38         {
39                 uint64_t length;
40                 uint64_t data_length;
41                 void *data;
42         };
43
44 private:
45         static const int ScaleStepCount = 10;
46         static const int MipMapScalePower;
47         static const int MipMapScaleFactor;
48         static const float LogMipMapScaleFactor;
49         static const uint64_t MipMapDataUnit;
50
51 public:
52         typedef std::pair<int64_t, bool> EdgePair;
53
54 public:
55         LogicDataSnapshot(const sr_datafeed_logic &logic);
56
57         virtual ~LogicDataSnapshot();
58
59         void append_payload(const sr_datafeed_logic &logic);
60
61 private:
62         void reallocate_mip_map(MipMapLevel &m);
63
64         void append_payload_to_mipmap();
65
66 public:
67         uint64_t get_sample(uint64_t index) const;
68
69         /**
70          * Parses a logic data snapshot to generate a list of transitions
71          * in a time interval to a given level of detail.
72          * @param[out] edges The vector to place the edges into.
73          * @param[in] start The start sample index.
74          * @param[in] end The end sample index.
75          * @param[in] min_length The minimum number of samples that
76          * can be resolved at this level of detail.
77          * @param[in] sig_index The index of the signal.
78          **/
79         void get_subsampled_edges(std::vector<EdgePair> &edges,
80                 int64_t start, int64_t end,
81                 float min_length, int sig_index);
82
83 private:
84         uint64_t get_subsample(int level, uint64_t offset) const;
85
86         static int64_t pow2_ceil(int64_t x, unsigned int power);
87
88 private:
89         struct MipMapLevel _mip_map[ScaleStepCount];
90         uint64_t _last_append_sample;
91
92         friend class LogicDataSnapshotTest::Pow2;
93         friend class LogicDataSnapshotTest::Basic;
94         friend class LogicDataSnapshotTest::LargeData;
95         friend class LogicDataSnapshotTest::Pulses;
96         friend class LogicDataSnapshotTest::LongPulses;
97 };