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