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, shared_ptr<sigrok::Logic> data, uint64_t samplerate);
  81
  82         virtual ~LogicSegment();
  83
  84         void append_payload(shared_ptr<sigrok::Logic> logic);
  85
  86         const uint8_t* get_samples(int64_t start_sample, int64_t end_sample) const;
  87
  88         SegmentLogicDataIterator* begin_sample_iteration(uint64_t start);
  89         void continue_sample_iteration(SegmentLogicDataIterator* it, uint64_t increase);
  90         void end_sample_iteration(SegmentLogicDataIterator* it);
  91
  92 private:
  93         uint64_t unpack_sample(const uint8_t *ptr) const;
  94         void pack_sample(uint8_t *ptr, uint64_t value);
  95
  96         void reallocate_mipmap_level(MipMapLevel &m);
  97
  98         void append_payload_to_mipmap();
  99
 100         uint64_t get_unpacked_sample(uint64_t index) const;
 101
 102 public:
 103         /**
 104          * Parses a logic data segment to generate a list of transitions
 105          * in a time interval to a given level of detail.
 106          * @param[out] edges The vector to place the edges into.
 107          * @param[in] start The start sample index.
 108          * @param[in] end The end sample index.
 109          * @param[in] min_length The minimum number of samples that
 110          * can be resolved at this level of detail.
 111          * @param[in] sig_index The index of the signal.
 112          */
 113         void get_subsampled_edges(vector<EdgePair> &edges,
 114                 uint64_t start, uint64_t end,
 115                 float min_length, int sig_index);
 116
 117 private:
 118         uint64_t get_subsample(int level, uint64_t offset) const;
 119
 120         static uint64_t pow2_ceil(uint64_t x, unsigned int power);
 121
 122 private:
 123         Logic& owner_;
 124
 125         struct MipMapLevel mip_map_[ScaleStepCount];
 126         uint64_t last_append_sample_;
 127
 128         friend struct LogicSegmentTest::Pow2;
 129         friend struct LogicSegmentTest::Basic;
 130         friend struct LogicSegmentTest::LargeData;
 131         friend struct LogicSegmentTest::Pulses;
 132         friend struct LogicSegmentTest::LongPulses;
 133 };
 134
 135 } // namespace data
 136 } // namespace pv
 137
 138 #endif // PULSEVIEW_PV_DATA_LOGICSEGMENT_HPP