Merge DecoderStack into DecodeSignal

[pulseview.git] / pv / data / decodesignal.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
#define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP

#include <atomic>
#include <condition_variable>
#include <unordered_set>
#include <vector>

#include <boost/optional.hpp>

#include <QSettings>
#include <QString>

#include <libsigrokdecode/libsigrokdecode.h>

#include <pv/data/decode/row.hpp>
#include <pv/data/decode/rowdata.hpp>
#include <pv/data/signalbase.hpp>
#include <pv/util.hpp>

using std::atomic;
using std::condition_variable;
using std::map;
using std::mutex;
using std::pair;
using std::unordered_set;
using std::vector;
using std::shared_ptr;

namespace pv {
class Session;

namespace data {

namespace decode {
class Annotation;
class Decoder;
class Row;
}

class Logic;
class LogicSegment;
class SignalBase;
class SignalData;

struct DecodeChannel
{
	uint16_t id;  // Also tells which bit within a sample represents this channel
	const bool is_optional;
	const pv::data::SignalBase *assigned_signal;
	const QString name, desc;
	int initial_pin_state;
	const shared_ptr<pv::data::decode::Decoder> decoder_;
	const srd_channel *pdch_;
};

class DecodeSignal : public SignalBase
{
	Q_OBJECT

private:
	static const double DecodeMargin;
	static const double DecodeThreshold;
	static const int64_t DecodeChunkLength;
	static const unsigned int DecodeNotifyPeriod;

public:
	DecodeSignal(pv::Session &session);
	virtual ~DecodeSignal();

	bool is_decode_signal() const;
	const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;

	void stack_decoder(srd_decoder *decoder);
	void remove_decoder(int index);
	bool toggle_decoder_visibility(int index);

	void reset_decode();
	void begin_decode();
	QString error_message() const;

	const vector<data::DecodeChannel> get_channels() const;
	void auto_assign_signals();
	void assign_signal(const uint16_t channel_id, const SignalBase *signal);

	void set_initial_pin_state(const uint16_t channel_id, const int init_state);

	double samplerate() const;
	const pv::util::Timestamp& start_time() const;

	/**
	 * Returns the number of samples that can be worked on,
	 * i.e. the number of samples where samples are available
	 * for all connected channels.
	 */
	int64_t get_working_sample_count() const;

	int64_t get_decoded_sample_count() const;

	vector<decode::Row> visible_rows() const;

	/**
	 * Extracts sorted annotations between two period into a vector.
	 */
	void get_annotation_subset(
		vector<pv::data::decode::Annotation> &dest,
		const decode::Row &row, uint64_t start_sample,
		uint64_t end_sample) const;

	virtual void save_settings(QSettings &settings) const;

	virtual void restore_settings(QSettings &settings);

	/**
	 * Helper function for static annotation_callback(),
	 * must be public so the function can access it.
	 * Don't use from outside this class.
	 */
	uint64_t inc_annotation_count();

private:
	void update_channel_list();

	void logic_mux_proc();

	boost::optional<int64_t> wait_for_data() const;

	void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count,
		srd_session *const session);

	void decode_proc();

	static void annotation_callback(srd_proto_data *pdata, void *decode_signal);

Q_SIGNALS:
	void new_annotations();
	void channels_updated();

private Q_SLOTS:
	void on_capture_state_changed(int state);
	void on_data_received();
	void on_frame_ended();

private:
	pv::Session &session_;

	vector<data::DecodeChannel> channels_;

	shared_ptr<Logic> logic_mux_data_;
	shared_ptr<LogicSegment> segment_;
	bool logic_mux_data_invalid_;

	pv::util::Timestamp start_time_;
	double samplerate_;

	int64_t sample_count_, annotation_count_, samples_decoded_;

	vector< shared_ptr<decode::Decoder> > stack_;
	map<const decode::Row, decode::RowData> rows_;
	map<pair<const srd_decoder*, int>, decode::Row> class_rows_;

	/**
	 * This mutex prevents more than one thread from accessing
	 * libsigrokdecode concurrently.
	 * @todo A proper solution should be implemented to allow multiple
	 * decode operations in parallel.
	 */
	static mutex global_srd_mutex_;

	mutable mutex input_mutex_, output_mutex_;
	mutable condition_variable decode_input_cond_, logic_mux_cond_;
	bool frame_complete_;

	std::thread decode_thread_, logic_mux_thread_;
	atomic<bool> decode_interrupt_, logic_mux_interrupt_;

	QString error_message_;
};

} // namespace data
} // namespace pv

#endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP