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