X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fdecoderstack.cpp;h=c7504f58ab5af94c90b762b9316e544918131152;hp=d56422a9a4f38090069c469d2e2006b13bf29643;hb=ad908057e13224eee9f983685e0ccc7db1ded0e9;hpb=6e89374a6796f8d5d9cc61b0a2f7e98562a034ae

diff --git a/pv/data/decoderstack.cpp b/pv/data/decoderstack.cpp
index d56422a9..c7504f58 100644
--- a/pv/data/decoderstack.cpp
+++ b/pv/data/decoderstack.cpp
@@ -14,224 +14,454 @@
  * 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, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <libsigrokdecode/libsigrokdecode.h>
 
-#include <boost/thread/thread.hpp>
-
 #include <stdexcept>
 
 #include <QDebug>
 
-#include "decoderstack.h"
+#include "decoderstack.hpp"
+
+#include <pv/data/decode/annotation.hpp>
+#include <pv/data/decode/decoder.hpp>
+#include <pv/data/logic.hpp>
+#include <pv/data/logicsegment.hpp>
+#include <pv/session.hpp>
+#include <pv/views/trace/logicsignal.hpp>
 
-#include <pv/data/logic.h>
-#include <pv/data/logicsnapshot.h>
-#include <pv/view/logicsignal.h>
-#include <pv/view/decode/annotation.h>
+using std::lock_guard;
+using std::mutex;
+using std::unique_lock;
+using std::deque;
+using std::make_pair;
+using std::max;
+using std::min;
+using std::list;
+using std::shared_ptr;
+using std::make_shared;
+using std::vector;
 
-using namespace boost;
-using namespace std;
+using boost::optional;
+
+using namespace pv::data::decode;
 
 namespace pv {
 namespace data {
 
 const double DecoderStack::DecodeMargin = 1.0;
 const double DecoderStack::DecodeThreshold = 0.2;
-const int64_t DecoderStack::DecodeChunkLength = 4096;
+const int64_t DecoderStack::DecodeChunkLength = 10 * 1024 * 1024;
+const unsigned int DecoderStack::DecodeNotifyPeriod = 1024;
+
+mutex DecoderStack::global_srd_mutex_;
+
+DecoderStack::DecoderStack(pv::Session &session,
+	const srd_decoder *const dec) :
+	session_(session),
+	start_time_(0),
+	samplerate_(0),
+	sample_count_(0),
+	frame_complete_(false),
+	samples_decoded_(0)
+{
+	connect(&session_, SIGNAL(frame_began()),
+		this, SLOT(on_new_frame()));
+	connect(&session_, SIGNAL(data_received()),
+		this, SLOT(on_data_received()));
+	connect(&session_, SIGNAL(frame_ended()),
+		this, SLOT(on_frame_ended()));
+
+	stack_.push_back(make_shared<decode::Decoder>(dec));
+}
+
+DecoderStack::~DecoderStack()
+{
+	if (decode_thread_.joinable()) {
+		interrupt_ = true;
+		input_cond_.notify_one();
+		decode_thread_.join();
+	}
+}
 
-mutex DecoderStack::_global_decode_mutex;
+const list< shared_ptr<decode::Decoder> >& DecoderStack::stack() const
+{
+	return stack_;
+}
 
-DecoderStack::DecoderStack(const srd_decoder *const dec) :
-	_decoder(dec),
-	_options(g_hash_table_new_full(g_str_hash,
-		g_str_equal, g_free, (GDestroyNotify)g_variant_unref))
+void DecoderStack::push(shared_ptr<decode::Decoder> decoder)
 {
+	assert(decoder);
+	stack_.push_back(decoder);
 }
 
-DecoderStack::~DecoderStack()
+void DecoderStack::remove(int index)
 {
-	_decode_thread.interrupt();
-	_decode_thread.join();
+	assert(index >= 0);
+	assert(index < (int)stack_.size());
 
-	g_hash_table_destroy(_options);
+	// Find the decoder in the stack
+	auto iter = stack_.begin();
+	for (int i = 0; i < index; i++, iter++)
+		assert(iter != stack_.end());
+
+	// Delete the element
+	stack_.erase(iter);
 }
 
-const srd_decoder* DecoderStack::decoder() const
+double DecoderStack::samplerate() const
 {
-	return _decoder;
+	return samplerate_;
 }
 
-const map<const srd_probe*, shared_ptr<view::LogicSignal> >&
-DecoderStack::probes() const
+const pv::util::Timestamp& DecoderStack::start_time() const
 {
-	return _probes;
+	return start_time_;
 }
 
-void DecoderStack::set_probes(std::map<const srd_probe*,
-	boost::shared_ptr<view::LogicSignal> > probes)
+int64_t DecoderStack::samples_decoded() const
 {
-	_probes = probes;
-	begin_decode();
+	lock_guard<mutex> decode_lock(output_mutex_);
+	return samples_decoded_;
 }
 
-const GHashTable* DecoderStack::options() const
+vector<Row> DecoderStack::get_visible_rows() const
 {
-	return _options;
+	lock_guard<mutex> lock(output_mutex_);
+
+	vector<Row> rows;
+
+	for (const shared_ptr<decode::Decoder> &dec : stack_) {
+		assert(dec);
+		if (!dec->shown())
+			continue;
+
+		const srd_decoder *const decc = dec->decoder();
+		assert(dec->decoder());
+
+		// Add a row for the decoder if it doesn't have a row list
+		if (!decc->annotation_rows)
+			rows.emplace_back(decc);
+
+		// Add the decoder rows
+		for (const GSList *l = decc->annotation_rows; l; l = l->next) {
+			const srd_decoder_annotation_row *const ann_row =
+				(srd_decoder_annotation_row *)l->data;
+			assert(ann_row);
+			rows.emplace_back(decc, ann_row);
+		}
+	}
+
+	return rows;
 }
 
-void DecoderStack::set_option(const char *id, GVariant *value)
+uint64_t DecoderStack::inc_annotation_count()
 {
-	g_variant_ref(value);
-	g_hash_table_replace(_options, (void*)g_strdup(id), value);
-	begin_decode();
+	return (annotation_count_++);
 }
 
-const vector< shared_ptr<view::decode::Annotation> >
-	DecoderStack::annotations() const
+void DecoderStack::get_annotation_subset(
+	vector<pv::data::decode::Annotation> &dest,
+	const Row &row, uint64_t start_sample,
+	uint64_t end_sample) const
 {
-	lock_guard<mutex> lock(_mutex);
-	return _annotations;
+	lock_guard<mutex> lock(output_mutex_);
+
+	const auto iter = rows_.find(row);
+	if (iter != rows_.end())
+		(*iter).second.get_annotation_subset(dest,
+			start_sample, end_sample);
 }
 
 QString DecoderStack::error_message()
 {
-	lock_guard<mutex> lock(_mutex);
-	return _error_message;
+	lock_guard<mutex> lock(output_mutex_);
+	return error_message_;
+}
+
+void DecoderStack::clear()
+{
+	sample_count_ = 0;
+	annotation_count_ = 0;
+	frame_complete_ = false;
+	samples_decoded_ = 0;
+	error_message_ = QString();
+	rows_.clear();
+	class_rows_.clear();
 }
 
 void DecoderStack::begin_decode()
 {
-	_decode_thread.interrupt();
-	_decode_thread.join();
+	if (decode_thread_.joinable()) {
+		interrupt_ = true;
+		input_cond_.notify_one();
+		decode_thread_.join();
+	}
 
-	_annotations.clear();
+	clear();
 
-	if (_probes.empty())
-		return;
+	// Check that all decoders have the required channels
+	for (const shared_ptr<decode::Decoder> &dec : stack_)
+		if (!dec->have_required_channels()) {
+			error_message_ = tr("One or more required channels "
+				"have not been specified");
+			return;
+		}
 
-	// Get the samplerate and start time
-	shared_ptr<pv::view::LogicSignal> logic_signal =
-		dynamic_pointer_cast<pv::view::LogicSignal>(
-			(*_probes.begin()).second);
-	if (logic_signal) {
-		shared_ptr<pv::data::Logic> data(
-			logic_signal->data());
-		if (data) {
-			_start_time = data->get_start_time();
-			_samplerate = data->get_samplerate();
-			if (_samplerate == 0.0)
-				_samplerate = 1.0;
+	// Add classes
+	for (const shared_ptr<decode::Decoder> &dec : stack_) {
+		assert(dec);
+		const srd_decoder *const decc = dec->decoder();
+		assert(dec->decoder());
+
+		// Add a row for the decoder if it doesn't have a row list
+		if (!decc->annotation_rows)
+			rows_[Row(decc)] = decode::RowData();
+
+		// Add the decoder rows
+		for (const GSList *l = decc->annotation_rows; l; l = l->next) {
+			const srd_decoder_annotation_row *const ann_row =
+				(srd_decoder_annotation_row *)l->data;
+			assert(ann_row);
+
+			const Row row(decc, ann_row);
+
+			// Add a new empty row data object
+			rows_[row] = decode::RowData();
+
+			// Map out all the classes
+			for (const GSList *ll = ann_row->ann_classes;
+				ll; ll = ll->next)
+				class_rows_[make_pair(decc,
+					GPOINTER_TO_INT(ll->data))] = row;
 		}
 	}
 
-	// We get the logic data of the first probe in the list.
+	// We get the logic data of the first channel in the list.
 	// This works because we are currently assuming all
-	// LogicSignals have the same data/snapshot
-	shared_ptr<pv::view::LogicSignal> sig = (*_probes.begin()).second;
-	assert(sig);
-	shared_ptr<data::Logic> data = sig->data();
+	// logic signals have the same data/segment
+	pv::data::SignalBase *signalbase;
+	pv::data::Logic *data = nullptr;
+
+	for (const shared_ptr<decode::Decoder> &dec : stack_)
+		if (dec && !dec->channels().empty() &&
+			((signalbase = (*dec->channels().begin()).second.get())) &&
+			((data = signalbase->logic_data().get())))
+			break;
+
+	if (!data)
+		return;
+
+	// Check we have a segment of data
+	const deque< shared_ptr<pv::data::LogicSegment> > &segments =
+		data->logic_segments();
+	if (segments.empty())
+		return;
+	segment_ = segments.front();
+
+	// Get the samplerate and start time
+	start_time_ = segment_->start_time();
+	samplerate_ = segment_->samplerate();
+	if (samplerate_ == 0.0)
+		samplerate_ = 1.0;
 
-	_decode_thread = boost::thread(&DecoderStack::decode_proc, this,
-		data);
+	interrupt_ = false;
+	decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
 }
 
-void DecoderStack::clear_snapshots()
+uint64_t DecoderStack::max_sample_count() const
 {
+	uint64_t max_sample_count = 0;
+
+	for (const auto& row : rows_)
+		max_sample_count = max(max_sample_count,
+			row.second.get_max_sample());
+
+	return max_sample_count;
 }
 
-void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
+optional<int64_t> DecoderStack::wait_for_data() const
 {
-	srd_session *session;
-	uint8_t chunk[DecodeChunkLength];
+	unique_lock<mutex> input_lock(input_mutex_);
 
-	assert(data);
+	// Do wait if we decoded all samples but we're still capturing
+	// Do not wait if we're done capturing
+	while (!interrupt_ && !frame_complete_ &&
+		(samples_decoded_ >= sample_count_) &&
+		(session_.get_capture_state() != Session::Stopped)) {
 
-	const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
-		data->get_snapshots();
-	if (snapshots.empty())
-		return;
+		input_cond_.wait(input_lock);
+	}
+
+	// Return value is valid if we're not aborting the decode,
+	return boost::make_optional(!interrupt_ &&
+		// and there's more work to do...
+		(samples_decoded_ < sample_count_ || !frame_complete_) &&
+		// and if the end of the data hasn't been reached yet
+		(!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
+		sample_count_);
+}
+
+void DecoderStack::decode_data(
+	const int64_t abs_start_samplenum, const int64_t sample_count, const unsigned int unit_size,
+	srd_session *const session)
+{
+	const unsigned int chunk_sample_count =
+		DecodeChunkLength / segment_->unit_size();
+
+	for (int64_t i = abs_start_samplenum; !interrupt_ && i < sample_count;
+			i += chunk_sample_count) {
+
+		const int64_t chunk_end = min(
+			i + chunk_sample_count, sample_count);
+		const uint8_t* chunk = segment_->get_samples(i, chunk_end);
+
+		if (srd_session_send(session, i, chunk_end, chunk,
+				(chunk_end - i) * unit_size, unit_size) != SRD_OK) {
+			error_message_ = tr("Decoder reported an error");
+			delete[] chunk;
+			break;
+		}
+		delete[] chunk;
+
+		{
+			lock_guard<mutex> lock(output_mutex_);
+			samples_decoded_ = chunk_end;
+		}
+	}
+}
+
+void DecoderStack::decode_proc()
+{
+	optional<int64_t> sample_count;
+	srd_session *session;
+	srd_decoder_inst *prev_di = nullptr;
 
-	const shared_ptr<pv::data::LogicSnapshot> &snapshot =
-		snapshots.front();
-	const int64_t sample_count = snapshot->get_sample_count() - 1;
+	assert(segment_);
+
+	// Prevent any other decode threads from accessing libsigrokdecode
+	lock_guard<mutex> srd_lock(global_srd_mutex_);
 
 	// Create the session
 	srd_session_new(&session);
 	assert(session);
 
-	srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
-		g_variant_new_uint64((uint64_t)_samplerate));
+	// Create the decoders
+	const unsigned int unit_size = segment_->unit_size();
 
-	srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
-		DecoderStack::annotation_callback, this);
+	for (const shared_ptr<decode::Decoder> &dec : stack_) {
+		srd_decoder_inst *const di = dec->create_decoder_inst(session);
 
-	// Create the decoder instance
-	srd_decoder_inst *const decoder_inst = srd_inst_new(
-		session, _decoder->id, _options);
-	if(!decoder_inst) {
-		_error_message = tr("Failed to initialise decoder");
-		return;
-	}
+		if (!di) {
+			error_message_ = tr("Failed to create decoder instance");
+			srd_session_destroy(session);
+			return;
+		}
 
-	// Setup the probes
-	GHashTable *const probes = g_hash_table_new_full(g_str_hash,
-		g_str_equal, g_free, (GDestroyNotify)g_variant_unref);
+		if (prev_di)
+			srd_inst_stack (session, prev_di, di);
 
-	for(map<const srd_probe*, shared_ptr<view::LogicSignal> >::
-		const_iterator i = _probes.begin();
-		i != _probes.end(); i++)
-	{
-		shared_ptr<view::Signal> signal((*i).second);
-		GVariant *const gvar = g_variant_new_int32(
-			signal->probe()->index);
-		g_variant_ref_sink(gvar);
-		g_hash_table_insert(probes, (*i).first->id, gvar);
+		prev_di = di;
 	}
 
-	srd_inst_probe_set_all(decoder_inst, probes);
+	// Get the intial sample count
+	{
+		unique_lock<mutex> input_lock(input_mutex_);
+		sample_count = sample_count_ = segment_->get_sample_count();
+	}
 
 	// Start the session
-	srd_session_start(session);
+	srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
+		g_variant_new_uint64((uint64_t)samplerate_));
 
-	for (int64_t i = 0;
-		!this_thread::interruption_requested() && i < sample_count;
-		i += DecodeChunkLength)
-	{
-		lock_guard<mutex> decode_lock(_global_decode_mutex);
+	srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
+		DecoderStack::annotation_callback, this);
 
-		const int64_t chunk_end = min(
-			i + DecodeChunkLength, sample_count);
-		snapshot->get_samples(chunk, i, chunk_end);
+	srd_session_start(session);
 
-		if (srd_session_send(session, i, i + sample_count,
-				chunk, chunk_end - i) != SRD_OK) {
-			_error_message = tr("Failed to initialise decoder");
-			break;
-		}
-	}
+	int64_t abs_start_samplenum = 0;
+	do {
+		decode_data(abs_start_samplenum, *sample_count, unit_size, session);
+		abs_start_samplenum = *sample_count;
+	} while (error_message_.isEmpty() && (sample_count = wait_for_data()));
+
+	// Make sure all annotations are known to the frontend
+	new_annotations();
 
 	// Destroy the session
 	srd_session_destroy(session);
 }
 
-void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
+void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder_stack)
 {
-	using namespace pv::view::decode;
-
 	assert(pdata);
 	assert(decoder);
 
-	DecoderStack *const d = (DecoderStack*)decoder;
+	DecoderStack *const ds = (DecoderStack*)decoder_stack;
+	assert(ds);
+
+	lock_guard<mutex> lock(ds->output_mutex_);
+
+	const Annotation a(pdata);
+
+	// Find the row
+	assert(pdata->pdo);
+	assert(pdata->pdo->di);
+	const srd_decoder *const decc = pdata->pdo->di->decoder;
+	assert(decc);
+
+	auto row_iter = ds->rows_.end();
+
+	// Try looking up the sub-row of this class
+	const auto r = ds->class_rows_.find(make_pair(decc, a.format()));
+	if (r != ds->class_rows_.end())
+		row_iter = ds->rows_.find((*r).second);
+	else {
+		// Failing that, use the decoder as a key
+		row_iter = ds->rows_.find(Row(decc));
+	}
+
+	assert(row_iter != ds->rows_.end());
+	if (row_iter == ds->rows_.end()) {
+		qDebug() << "Unexpected annotation: decoder = " << decc <<
+			", format = " << a.format();
+		assert(false);
+		return;
+	}
+
+	// Add the annotation
+	(*row_iter).second.push_annotation(a);
+
+	// Notify the frontend every DecodeNotifyPeriod annotations
+	if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0)
+		ds->new_annotations();
+}
+
+void DecoderStack::on_new_frame()
+{
+	begin_decode();
+}
 
-	shared_ptr<Annotation> a(new Annotation(pdata));
-	lock_guard<mutex> lock(d->_mutex);
-	d->_annotations.push_back(a);
+void DecoderStack::on_data_received()
+{
+	{
+		unique_lock<mutex> lock(input_mutex_);
+		if (segment_)
+			sample_count_ = segment_->get_sample_count();
+	}
+	input_cond_.notify_one();
+}
 
-	d->new_decode_data();
+void DecoderStack::on_frame_ended()
+{
+	{
+		unique_lock<mutex> lock(input_mutex_);
+		if (segment_)
+			frame_complete_ = true;
+	}
+	input_cond_.notify_one();
 }
 
 } // namespace data