pv/data/logicsnapshot.h

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