pv/data/decodesignal.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
   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_DECODESIGNAL_HPP
  21 #define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
  22
  23 #include <unordered_set>
  24 #include <vector>
  25
  26 #include <QString>
  27
  28 #include <libsigrokdecode/libsigrokdecode.h>
  29
  30 #include <pv/data/signalbase.hpp>
  31 #include <pv/util.hpp>
  32
  33 using std::list;
  34 using std::unordered_set;
  35 using std::vector;
  36 using std::shared_ptr;
  37
  38 namespace pv {
  39 namespace data {
  40
  41 namespace decode {
  42 class Annotation;
  43 class Decoder;
  44 class Row;
  45 }
  46
  47 class DecoderStack;
  48 class Logic;
  49 class SignalBase;
  50 class SignalData;
  51
  52 struct DecodeChannel
  53 {
  54         uint16_t id;  // Also tells which bit within a sample represents this channel
  55         const bool is_optional;
  56         const pv::data::SignalBase *assigned_signal;
  57         const QString name, desc;
  58         int initial_pin_state;
  59         const shared_ptr<pv::data::decode::Decoder> decoder_;
  60         const srd_channel *pdch_;
  61 };
  62
  63 class DecodeSignal : public SignalBase
  64 {
  65         Q_OBJECT
  66
  67 public:
  68         DecodeSignal(shared_ptr<pv::data::DecoderStack> decoder_stack,
  69                 const unordered_set< shared_ptr<data::SignalBase> > &all_signals);
  70         virtual ~DecodeSignal();
  71
  72         bool is_decode_signal() const;
  73         shared_ptr<data::DecoderStack> decoder_stack() const;
  74         const list< shared_ptr<data::decode::Decoder> >& decoder_stack_list() const;
  75
  76         void stack_decoder(srd_decoder *decoder);
  77         void remove_decoder(int index);
  78         bool toggle_decoder_visibility(int index);
  79
  80         void begin_decode();
  81         QString error_message() const;
  82
  83         const list<data::DecodeChannel> get_channels() const;
  84         void auto_assign_signals();
  85         void assign_signal(const uint16_t channel_id, const SignalBase *signal);
  86
  87         void set_initial_pin_state(const uint16_t channel_id, const int init_state);
  88
  89         double samplerate() const;
  90         const pv::util::Timestamp& start_time() const;
  91
  92         /**
  93          * Returns the number of samples that can be worked on,
  94          * i.e. the number of samples where samples are available
  95          * for all connected channels.
  96          */
  97         int64_t get_working_sample_count() const;
  98
  99         int64_t get_decoded_sample_count() const;
 100
 101         vector<decode::Row> visible_rows() const;
 102
 103         /**
 104          * Extracts sorted annotations between two period into a vector.
 105          */
 106         void get_annotation_subset(
 107                 vector<pv::data::decode::Annotation> &dest,
 108                 const decode::Row &row, uint64_t start_sample,
 109                 uint64_t end_sample) const;
 110
 111 private:
 112         void update_channel_list();
 113
 114 Q_SIGNALS:
 115         void new_annotations();
 116         void channels_updated();
 117
 118 private Q_SLOTS:
 119         void on_new_annotations();
 120
 121 private:
 122         shared_ptr<pv::data::DecoderStack> decoder_stack_;
 123         const unordered_set< shared_ptr<data::SignalBase> > &all_signals_;
 124         list<data::DecodeChannel> channels_;
 125 };
 126
 127 } // namespace data
 128 } // namespace pv
 129
 130 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP