[pulseview.git] / pv / session.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifdef _WIN32
// Windows: Avoid boost/thread namespace pollution (which includes windows.h).
#define NOGDI
#define NORESOURCE
#endif
#include <boost/thread/locks.hpp>
#include <boost/thread/shared_mutex.hpp>

#ifdef ENABLE_DECODE
#include <libsigrokdecode/libsigrokdecode.h>
#endif

#include "session.hpp"

#include "devicemanager.hpp"

#include "data/analog.hpp"
#include "data/analogsegment.hpp"
#include "data/decoderstack.hpp"
#include "data/logic.hpp"
#include "data/logicsegment.hpp"
#include "data/signalbase.hpp"
#include "data/decode/decoder.hpp"

#include "devices/hardwaredevice.hpp"
#include "devices/sessionfile.hpp"

#include "view/analogsignal.hpp"
#include "view/decodetrace.hpp"
#include "view/logicsignal.hpp"

#include <cassert>
#include <mutex>
#include <stdexcept>

#include <sys/stat.h>

#include <QDebug>

#include <libsigrokcxx/libsigrokcxx.hpp>

using boost::shared_lock;
using boost::shared_mutex;
using boost::unique_lock;

using std::dynamic_pointer_cast;
using std::function;
using std::lock_guard;
using std::list;
using std::map;
using std::mutex;
using std::recursive_mutex;
using std::set;
using std::shared_ptr;
using std::string;
using std::unordered_set;
using std::vector;

using sigrok::Analog;
using sigrok::Channel;
using sigrok::ChannelType;
using sigrok::ConfigKey;
using sigrok::DatafeedCallbackFunction;
using sigrok::Error;
using sigrok::Header;
using sigrok::Logic;
using sigrok::Meta;
using sigrok::Packet;
using sigrok::PacketPayload;
using sigrok::Session;
using sigrok::SessionDevice;

using Glib::VariantBase;
using Glib::Variant;

namespace pv {
Session::Session(DeviceManager &device_manager) :
	device_manager_(device_manager),
	capture_state_(Stopped),
	cur_samplerate_(0)
{
}

Session::~Session()
{
	// Stop and join to the thread
	stop_capture();
}

DeviceManager& Session::device_manager()
{
	return device_manager_;
}

const DeviceManager& Session::device_manager() const
{
	return device_manager_;
}

shared_ptr<sigrok::Session> Session::session() const
{
	if (!device_)
		return shared_ptr<sigrok::Session>();
	return device_->session();
}

shared_ptr<devices::Device> Session::device() const
{
	return device_;
}

void Session::set_device(shared_ptr<devices::Device> device)
{
	assert(device);

	// Ensure we are not capturing before setting the device
	stop_capture();

	if (device_)
		device_->close();

	device_.reset();

	// Remove all stored data
	signals_.clear();
	{
		shared_lock<shared_mutex> lock(signals_mutex_);
		for (const shared_ptr<data::SignalData> d : all_signal_data_)
			d->clear();
	}
	all_signal_data_.clear();
	cur_logic_segment_.reset();

	for (auto entry : cur_analog_segments_) {
		shared_ptr<sigrok::Channel>(entry.first).reset();
		shared_ptr<data::AnalogSegment>(entry.second).reset();
	}

	logic_data_.reset();
	decode_traces_.clear();

	signals_changed();

	device_ = std::move(device);

	try {
		device_->open();
	} catch (const QString &e) {
		device_.reset();
		device_selected();
		throw;
	}

	device_->session()->add_datafeed_callback([=]
		(shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
			data_feed_in(device, packet);
		});

	update_signals();
	device_selected();
}

void Session::set_default_device()
{
	const list< shared_ptr<devices::HardwareDevice> > &devices =
		device_manager_.devices();

	if (devices.empty())
		return;

	// Try and find the demo device and select that by default
	const auto iter = std::find_if(devices.begin(), devices.end(),
		[] (const shared_ptr<devices::HardwareDevice> &d) {
			return d->hardware_device()->driver()->name() ==
			"demo";	});
	set_device((iter == devices.end()) ? devices.front() : *iter);
}

Session::capture_state Session::get_capture_state() const
{
	lock_guard<mutex> lock(sampling_mutex_);
	return capture_state_;
}

void Session::start_capture(function<void (const QString)> error_handler)
{
	if (!device_) {
		error_handler(tr("No active device set, can't start acquisition."));
		return;
	}

	stop_capture();

	// Check that at least one channel is enabled
	const shared_ptr<sigrok::Device> sr_dev = device_->device();
	if (sr_dev) {
		const auto channels = sr_dev->channels();
		if (!std::any_of(channels.begin(), channels.end(),
			[](shared_ptr<Channel> channel) {
				return channel->enabled(); })) {
			error_handler(tr("No channels enabled."));
			return;
		}
	}

	// Clear signal data
	{
		shared_lock<shared_mutex> lock(signals_mutex_);
		for (const shared_ptr<data::SignalData> d : all_signal_data_)
			d->clear();
	}

	// Begin the session
	sampling_thread_ = std::thread(
		&Session::sample_thread_proc, this, error_handler);
}

void Session::stop_capture()
{
	if (get_capture_state() != Stopped)
		device_->stop();

	// Check that sampling stopped
	if (sampling_thread_.joinable())
		sampling_thread_.join();
}

double Session::get_samplerate() const
{
	double samplerate = 0.0;

	{
		shared_lock<shared_mutex> lock(signals_mutex_);
		for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
			assert(d);
			const vector< shared_ptr<pv::data::Segment> > segments =
				d->segments();
			for (const shared_ptr<pv::data::Segment> &s : segments)
				samplerate = std::max(samplerate, s->samplerate());
		}
	}
	// If there is no sample rate given we use samples as unit
	if (samplerate == 0.0)
		samplerate = 1.0;

	return samplerate;
}

const unordered_set< shared_ptr<view::Signal> > Session::signals() const
{
	shared_lock<shared_mutex> lock(signals_mutex_);
	return signals_;
}

#ifdef ENABLE_DECODE
bool Session::add_decoder(srd_decoder *const dec)
{
	map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
	shared_ptr<data::DecoderStack> decoder_stack;

	try {
		lock_guard<boost::shared_mutex> lock(signals_mutex_);

		// Create the decoder
		decoder_stack = shared_ptr<data::DecoderStack>(
			new data::DecoderStack(*this, dec));

		// Make a list of all the channels
		std::vector<const srd_channel*> all_channels;
		for (const GSList *i = dec->channels; i; i = i->next)
			all_channels.push_back((const srd_channel*)i->data);
		for (const GSList *i = dec->opt_channels; i; i = i->next)
			all_channels.push_back((const srd_channel*)i->data);

		// Auto select the initial channels
		for (const srd_channel *pdch : all_channels)
			for (shared_ptr<view::Signal> s : signals_) {
				shared_ptr<view::LogicSignal> l =
					dynamic_pointer_cast<view::LogicSignal>(s);
				if (l && QString::fromUtf8(pdch->name).
					toLower().contains(
					s->base()->name().toLower()))
					channels[pdch] = l;
			}

		assert(decoder_stack);
		assert(!decoder_stack->stack().empty());
		assert(decoder_stack->stack().front());
		decoder_stack->stack().front()->set_channels(channels);

		// Create the decode signal
		shared_ptr<data::SignalBase> signalbase =
			shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));

		shared_ptr<view::DecodeTrace> d(
			new view::DecodeTrace(*this, signalbase, decoder_stack,
				decode_traces_.size()));
		decode_traces_.push_back(d);
	} catch (std::runtime_error e) {
		return false;
	}

	signals_changed();

	// Do an initial decode
	decoder_stack->begin_decode();

	return true;
}

vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
{
	shared_lock<shared_mutex> lock(signals_mutex_);
	return decode_traces_;
}

void Session::remove_decode_signal(view::DecodeTrace *signal)
{
	for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
		if ((*i).get() == signal) {
			decode_traces_.erase(i);
			signals_changed();
			return;
		}
}
#endif

void Session::set_capture_state(capture_state state)
{
	bool changed;

	{
		lock_guard<mutex> lock(sampling_mutex_);
		changed = capture_state_ != state;
		capture_state_ = state;
	}

	if (changed)
		capture_state_changed(state);
}

void Session::update_signals()
{
	if (!device_) {
		signals_.clear();
		logic_data_.reset();
		return;
	}

	lock_guard<recursive_mutex> lock(data_mutex_);

	const shared_ptr<sigrok::Device> sr_dev = device_->device();
	if (!sr_dev) {
		signals_.clear();
		logic_data_.reset();
		return;
	}

	// Detect what data types we will receive
	auto channels = sr_dev->channels();
	unsigned int logic_channel_count = std::count_if(
		channels.begin(), channels.end(),
		[] (shared_ptr<Channel> channel) {
			return channel->type() == ChannelType::LOGIC; });

	// Create data containers for the logic data segments
	{
		lock_guard<recursive_mutex> data_lock(data_mutex_);

		if (logic_channel_count == 0) {
			logic_data_.reset();
		} else if (!logic_data_ ||
			logic_data_->num_channels() != logic_channel_count) {
			logic_data_.reset(new data::Logic(
				logic_channel_count));
			assert(logic_data_);
		}
	}

	// Make the Signals list
	{
		unique_lock<shared_mutex> lock(signals_mutex_);

		unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
		signals_.clear();

		for (auto channel : sr_dev->channels()) {
			shared_ptr<data::SignalBase> signalbase;
			shared_ptr<view::Signal> signal;

			// Find the channel in the old signals
			const auto iter = std::find_if(
				prev_sigs.cbegin(), prev_sigs.cend(),
				[&](const shared_ptr<view::Signal> &s) {
					return s->base()->channel() == channel;
				});
			if (iter != prev_sigs.end()) {
				// Copy the signal from the old set to the new
				signal = *iter;
			} else {
				// Create a new signal
				signalbase = shared_ptr<data::SignalBase>(
					new data::SignalBase(channel));

				switch(channel->type()->id()) {
				case SR_CHANNEL_LOGIC:
					signalbase->set_data(logic_data_);
					signal = shared_ptr<view::Signal>(
						new view::LogicSignal(*this,
							device_, signalbase));
					all_signal_data_.insert(logic_data_);
					signalbases_.insert(signalbase);
					break;

				case SR_CHANNEL_ANALOG:
				{
					shared_ptr<data::Analog> data(new data::Analog());
					signalbase->set_data(data);
					signal = shared_ptr<view::Signal>(
						new view::AnalogSignal(
							*this, signalbase));
					all_signal_data_.insert(data);
					signalbases_.insert(signalbase);
					break;
				}

				default:
					assert(0);
					break;
				}
			}

			assert(signal);
			signals_.insert(signal);
		}
	}

	signals_changed();
}

shared_ptr<data::SignalBase> Session::signalbase_from_channel(
	shared_ptr<sigrok::Channel> channel) const
{
	for (shared_ptr<data::SignalBase> sig : signalbases_) {
		assert(sig);
		if (sig->channel() == channel)
			return sig;
	}
	return shared_ptr<data::SignalBase>();
}

void Session::sample_thread_proc(function<void (const QString)> error_handler)
{
	assert(error_handler);

	if (!device_)
		return;

	cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);

	out_of_memory_ = false;

	try {
		device_->start();
	} catch (Error e) {
		error_handler(e.what());
		return;
	}

	set_capture_state(device_->session()->trigger() ?
		AwaitingTrigger : Running);

	device_->run();
	set_capture_state(Stopped);

	// Confirm that SR_DF_END was received
	if (cur_logic_segment_) {
		qDebug("SR_DF_END was not received.");
		assert(0);
	}

	if (out_of_memory_)
		error_handler(tr("Out of memory, acquisition stopped."));
}

void Session::feed_in_header()
{
	cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
}

void Session::feed_in_meta(shared_ptr<Meta> meta)
{
	for (auto entry : meta->config()) {
		switch (entry.first->id()) {
		case SR_CONF_SAMPLERATE:
			// We can't rely on the header to always contain the sample rate,
			// so in case it's supplied via a meta packet, we use it.
			if (!cur_samplerate_)
				cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());

			/// @todo handle samplerate changes
			break;
		default:
			// Unknown metadata is not an error.
			break;
		}
	}

	signals_changed();
}

void Session::feed_in_trigger()
{
	// The channel containing most samples should be most accurate
	uint64_t sample_count = 0;

	{
		shared_lock<shared_mutex> lock(signals_mutex_);
		for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
			assert(d);
			uint64_t temp_count = 0;

			const vector< shared_ptr<pv::data::Segment> > segments =
				d->segments();
			for (const shared_ptr<pv::data::Segment> &s : segments)
				temp_count += s->get_sample_count();

			if (temp_count > sample_count)
				sample_count = temp_count;
		}
	}

	trigger_event(sample_count / get_samplerate());
}

void Session::feed_in_frame_begin()
{
	if (cur_logic_segment_ || !cur_analog_segments_.empty())
		frame_began();
}

void Session::feed_in_logic(shared_ptr<Logic> logic)
{
	lock_guard<recursive_mutex> lock(data_mutex_);

	const size_t sample_count = logic->data_length() / logic->unit_size();

	if (!logic_data_) {
		// The only reason logic_data_ would not have been created is
		// if it was not possible to determine the signals when the
		// device was created.
		update_signals();
	}

	if (!cur_logic_segment_) {
		// This could be the first packet after a trigger
		set_capture_state(Running);

		// Create a new data segment
		cur_logic_segment_ = shared_ptr<data::LogicSegment>(
			new data::LogicSegment(
				logic, cur_samplerate_, sample_count));
		logic_data_->push_segment(cur_logic_segment_);

		// @todo Putting this here means that only listeners querying
		// for logic will be notified. Currently the only user of
		// frame_began is DecoderStack, but in future we need to signal
		// this after both analog and logic sweeps have begun.
		frame_began();
	} else {
		// Append to the existing data segment
		cur_logic_segment_->append_payload(logic);
	}

	data_received();
}

void Session::feed_in_analog(shared_ptr<Analog> analog)
{
	lock_guard<recursive_mutex> lock(data_mutex_);

	const vector<shared_ptr<Channel>> channels = analog->channels();
	const unsigned int channel_count = channels.size();
	const size_t sample_count = analog->num_samples() / channel_count;
	const float *data = static_cast<const float *>(analog->data_pointer());
	bool sweep_beginning = false;

	if (signals_.empty())
		update_signals();

	for (auto channel : channels) {
		shared_ptr<data::AnalogSegment> segment;

		// Try to get the segment of the channel
		const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
			iterator iter = cur_analog_segments_.find(channel);
		if (iter != cur_analog_segments_.end())
			segment = (*iter).second;
		else {
			// If no segment was found, this means we haven't
			// created one yet. i.e. this is the first packet
			// in the sweep containing this segment.
			sweep_beginning = true;

			// Create a segment, keep it in the maps of channels
			segment = shared_ptr<data::AnalogSegment>(
				new data::AnalogSegment(
					cur_samplerate_, sample_count));
			cur_analog_segments_[channel] = segment;

			// Find the analog data associated with the channel
			shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
			assert(base);

			shared_ptr<data::Analog> data(base->analog_data());
			assert(data);

			// Push the segment into the analog data.
			data->push_segment(segment);
		}

		assert(segment);

		// Append the samples in the segment
		segment->append_interleaved_samples(data++, sample_count,
			channel_count);
	}

	if (sweep_beginning) {
		// This could be the first packet after a trigger
		set_capture_state(Running);
	}

	data_received();
}

void Session::data_feed_in(shared_ptr<sigrok::Device> device,
	shared_ptr<Packet> packet)
{
	(void)device;

	assert(device);
	assert(device == device_->device());
	assert(packet);

	switch (packet->type()->id()) {
	case SR_DF_HEADER:
		feed_in_header();
		break;

	case SR_DF_META:
		feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
		break;

	case SR_DF_TRIGGER:
		feed_in_trigger();
		break;

	case SR_DF_FRAME_BEGIN:
		feed_in_frame_begin();
		break;

	case SR_DF_LOGIC:
		try {
			feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
		} catch (std::bad_alloc) {
			out_of_memory_ = true;
			device_->stop();
		}
		break;

	case SR_DF_ANALOG:
		try {
			feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
		} catch (std::bad_alloc) {
			out_of_memory_ = true;
			device_->stop();
		}
		break;

	case SR_DF_END:
	{
		{
			lock_guard<recursive_mutex> lock(data_mutex_);
			cur_logic_segment_.reset();
			cur_analog_segments_.clear();
		}
		frame_ended();
		break;
	}
	default:
		break;
	}
}

} // namespace pv
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2012-14 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	#ifdef _WIN32
	22	// Windows: Avoid boost/thread namespace pollution (which includes windows.h).
	23	#define NOGDI
	24	#define NORESOURCE
	25	#endif
	26	#include <boost/thread/locks.hpp>
	27	#include <boost/thread/shared_mutex.hpp>
	28
	29	#ifdef ENABLE_DECODE
	30	#include <libsigrokdecode/libsigrokdecode.h>
	31	#endif
	32
	33	#include "session.hpp"
	34
	35	#include "devicemanager.hpp"
	36
	37	#include "data/analog.hpp"
	38	#include "data/analogsegment.hpp"
	39	#include "data/decoderstack.hpp"
	40	#include "data/logic.hpp"
	41	#include "data/logicsegment.hpp"
	42	#include "data/signalbase.hpp"
	43	#include "data/decode/decoder.hpp"
	44
	45	#include "devices/hardwaredevice.hpp"
	46	#include "devices/sessionfile.hpp"
	47
	48	#include "view/analogsignal.hpp"
	49	#include "view/decodetrace.hpp"
	50	#include "view/logicsignal.hpp"
	51
	52	#include <cassert>
	53	#include <mutex>
	54	#include <stdexcept>
	55
	56	#include <sys/stat.h>
	57
	58	#include <QDebug>
	59
	60	#include <libsigrokcxx/libsigrokcxx.hpp>
	61
	62	using boost::shared_lock;
	63	using boost::shared_mutex;
	64	using boost::unique_lock;
	65
	66	using std::dynamic_pointer_cast;
	67	using std::function;
	68	using std::lock_guard;
	69	using std::list;
	70	using std::map;
	71	using std::mutex;
	72	using std::recursive_mutex;
	73	using std::set;
	74	using std::shared_ptr;
	75	using std::string;
	76	using std::unordered_set;
	77	using std::vector;
	78
	79	using sigrok::Analog;
	80	using sigrok::Channel;
	81	using sigrok::ChannelType;
	82	using sigrok::ConfigKey;
	83	using sigrok::DatafeedCallbackFunction;
	84	using sigrok::Error;
	85	using sigrok::Header;
	86	using sigrok::Logic;
	87	using sigrok::Meta;
	88	using sigrok::Packet;
	89	using sigrok::PacketPayload;
	90	using sigrok::Session;
	91	using sigrok::SessionDevice;
	92
	93	using Glib::VariantBase;
	94	using Glib::Variant;
	95
	96	namespace pv {
	97	Session::Session(DeviceManager &device_manager) :
	98	device_manager_(device_manager),
	99	capture_state_(Stopped),
	100	cur_samplerate_(0)
	101	{
	102	}
	103
	104	Session::~Session()
	105	{
	106	// Stop and join to the thread
	107	stop_capture();
	108	}
	109
	110	DeviceManager& Session::device_manager()
	111	{
	112	return device_manager_;
	113	}
	114
	115	const DeviceManager& Session::device_manager() const
	116	{
	117	return device_manager_;
	118	}
	119
	120	shared_ptr<sigrok::Session> Session::session() const
	121	{
	122	if (!device_)
	123	return shared_ptr<sigrok::Session>();
	124	return device_->session();
	125	}
	126
	127	shared_ptr<devices::Device> Session::device() const
	128	{
	129	return device_;
	130	}
	131
	132	void Session::set_device(shared_ptr<devices::Device> device)
	133	{
	134	assert(device);
	135
	136	// Ensure we are not capturing before setting the device
	137	stop_capture();
	138
	139	if (device_)
	140	device_->close();
	141
	142	device_.reset();
	143
	144	// Remove all stored data
	145	signals_.clear();
	146	{
	147	shared_lock<shared_mutex> lock(signals_mutex_);
	148	for (const shared_ptr<data::SignalData> d : all_signal_data_)
	149	d->clear();
	150	}
	151	all_signal_data_.clear();
	152	cur_logic_segment_.reset();
	153
	154	for (auto entry : cur_analog_segments_) {
	155	shared_ptr<sigrok::Channel>(entry.first).reset();
	156	shared_ptr<data::AnalogSegment>(entry.second).reset();
	157	}
	158
	159	logic_data_.reset();
	160	decode_traces_.clear();
	161
	162	signals_changed();
	163
	164	device_ = std::move(device);
	165
	166	try {
	167	device_->open();
	168	} catch (const QString &e) {
	169	device_.reset();
	170	device_selected();
	171	throw;
	172	}
	173
	174	device_->session()->add_datafeed_callback([=]
	175	(shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
	176	data_feed_in(device, packet);
	177	});
	178
	179	update_signals();
	180	device_selected();
	181	}
	182
	183	void Session::set_default_device()
	184	{
	185	const list< shared_ptr<devices::HardwareDevice> > &devices =
	186	device_manager_.devices();
	187
	188	if (devices.empty())
	189	return;
	190
	191	// Try and find the demo device and select that by default
	192	const auto iter = std::find_if(devices.begin(), devices.end(),
	193	[] (const shared_ptr<devices::HardwareDevice> &d) {
	194	return d->hardware_device()->driver()->name() ==
	195	"demo"; });
	196	set_device((iter == devices.end()) ? devices.front() : *iter);
	197	}
	198
	199	Session::capture_state Session::get_capture_state() const
	200	{
	201	lock_guard<mutex> lock(sampling_mutex_);
	202	return capture_state_;
	203	}
	204
	205	void Session::start_capture(function<void (const QString)> error_handler)
	206	{
	207	if (!device_) {
	208	error_handler(tr("No active device set, can't start acquisition."));
	209	return;
	210	}
	211
	212	stop_capture();
	213
	214	// Check that at least one channel is enabled
	215	const shared_ptr<sigrok::Device> sr_dev = device_->device();
	216	if (sr_dev) {
	217	const auto channels = sr_dev->channels();
	218	if (!std::any_of(channels.begin(), channels.end(),
	219	[](shared_ptr<Channel> channel) {
	220	return channel->enabled(); })) {
	221	error_handler(tr("No channels enabled."));
	222	return;
	223	}
	224	}
	225
	226	// Clear signal data
	227	{
	228	shared_lock<shared_mutex> lock(signals_mutex_);
	229	for (const shared_ptr<data::SignalData> d : all_signal_data_)
	230	d->clear();
	231	}
	232
	233	// Begin the session
	234	sampling_thread_ = std::thread(
	235	&Session::sample_thread_proc, this, error_handler);
	236	}
	237
	238	void Session::stop_capture()
	239	{
	240	if (get_capture_state() != Stopped)
	241	device_->stop();
	242
	243	// Check that sampling stopped
	244	if (sampling_thread_.joinable())
	245	sampling_thread_.join();
	246	}
	247
	248	double Session::get_samplerate() const
	249	{
	250	double samplerate = 0.0;
	251
	252	{
	253	shared_lock<shared_mutex> lock(signals_mutex_);
	254	for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
	255	assert(d);
	256	const vector< shared_ptr<pv::data::Segment> > segments =
	257	d->segments();
	258	for (const shared_ptr<pv::data::Segment> &s : segments)
	259	samplerate = std::max(samplerate, s->samplerate());
	260	}
	261	}
	262	// If there is no sample rate given we use samples as unit
	263	if (samplerate == 0.0)
	264	samplerate = 1.0;
	265
	266	return samplerate;
	267	}
	268
	269	const unordered_set< shared_ptr<view::Signal> > Session::signals() const
	270	{
	271	shared_lock<shared_mutex> lock(signals_mutex_);
	272	return signals_;
	273	}
	274
	275	#ifdef ENABLE_DECODE
	276	bool Session::add_decoder(srd_decoder *const dec)
	277	{
	278	map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
	279	shared_ptr<data::DecoderStack> decoder_stack;
	280
	281	try {
	282	lock_guard<boost::shared_mutex> lock(signals_mutex_);
	283
	284	// Create the decoder
	285	decoder_stack = shared_ptr<data::DecoderStack>(
	286	new data::DecoderStack(*this, dec));
	287
	288	// Make a list of all the channels
	289	std::vector<const srd_channel*> all_channels;
	290	for (const GSList *i = dec->channels; i; i = i->next)
	291	all_channels.push_back((const srd_channel*)i->data);
	292	for (const GSList *i = dec->opt_channels; i; i = i->next)
	293	all_channels.push_back((const srd_channel*)i->data);
	294
	295	// Auto select the initial channels
	296	for (const srd_channel *pdch : all_channels)
	297	for (shared_ptr<view::Signal> s : signals_) {
	298	shared_ptr<view::LogicSignal> l =
	299	dynamic_pointer_cast<view::LogicSignal>(s);
	300	if (l && QString::fromUtf8(pdch->name).
	301	toLower().contains(
	302	s->base()->name().toLower()))
	303	channels[pdch] = l;
	304	}
	305
	306	assert(decoder_stack);
	307	assert(!decoder_stack->stack().empty());
	308	assert(decoder_stack->stack().front());
	309	decoder_stack->stack().front()->set_channels(channels);
	310
	311	// Create the decode signal
	312	shared_ptr<data::SignalBase> signalbase =
	313	shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
	314
	315	shared_ptr<view::DecodeTrace> d(
	316	new view::DecodeTrace(*this, signalbase, decoder_stack,
	317	decode_traces_.size()));
	318	decode_traces_.push_back(d);
	319	} catch (std::runtime_error e) {
	320	return false;
	321	}
	322
	323	signals_changed();
	324
	325	// Do an initial decode
	326	decoder_stack->begin_decode();
	327
	328	return true;
	329	}
	330
	331	vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
	332	{
	333	shared_lock<shared_mutex> lock(signals_mutex_);
	334	return decode_traces_;
	335	}
	336
	337	void Session::remove_decode_signal(view::DecodeTrace *signal)
	338	{
	339	for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
	340	if ((*i).get() == signal) {
	341	decode_traces_.erase(i);
	342	signals_changed();
	343	return;
	344	}
	345	}
	346	#endif
	347
	348	void Session::set_capture_state(capture_state state)
	349	{
	350	bool changed;
	351
	352	{
	353	lock_guard<mutex> lock(sampling_mutex_);
	354	changed = capture_state_ != state;
	355	capture_state_ = state;
	356	}
	357
	358	if (changed)
	359	capture_state_changed(state);
	360	}
	361
	362	void Session::update_signals()
	363	{
	364	if (!device_) {
	365	signals_.clear();
	366	logic_data_.reset();
	367	return;
	368	}
	369
	370	lock_guard<recursive_mutex> lock(data_mutex_);
	371
	372	const shared_ptr<sigrok::Device> sr_dev = device_->device();
	373	if (!sr_dev) {
	374	signals_.clear();
	375	logic_data_.reset();
	376	return;
	377	}
	378
	379	// Detect what data types we will receive
	380	auto channels = sr_dev->channels();
	381	unsigned int logic_channel_count = std::count_if(
	382	channels.begin(), channels.end(),
	383	[] (shared_ptr<Channel> channel) {
	384	return channel->type() == ChannelType::LOGIC; });
	385
	386	// Create data containers for the logic data segments
	387	{
	388	lock_guard<recursive_mutex> data_lock(data_mutex_);
	389
	390	if (logic_channel_count == 0) {
	391	logic_data_.reset();
	392	} else if (!logic_data_ \|\|
	393	logic_data_->num_channels() != logic_channel_count) {
	394	logic_data_.reset(new data::Logic(
	395	logic_channel_count));
	396	assert(logic_data_);
	397	}
	398	}
	399
	400	// Make the Signals list
	401	{
	402	unique_lock<shared_mutex> lock(signals_mutex_);
	403
	404	unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
	405	signals_.clear();
	406
	407	for (auto channel : sr_dev->channels()) {
	408	shared_ptr<data::SignalBase> signalbase;
	409	shared_ptr<view::Signal> signal;
	410
	411	// Find the channel in the old signals
	412	const auto iter = std::find_if(
	413	prev_sigs.cbegin(), prev_sigs.cend(),
	414	[&](const shared_ptr<view::Signal> &s) {
	415	return s->base()->channel() == channel;
	416	});
	417	if (iter != prev_sigs.end()) {
	418	// Copy the signal from the old set to the new
	419	signal = *iter;
	420	} else {
	421	// Create a new signal
	422	signalbase = shared_ptr<data::SignalBase>(
	423	new data::SignalBase(channel));
	424
	425	switch(channel->type()->id()) {
	426	case SR_CHANNEL_LOGIC:
	427	signalbase->set_data(logic_data_);
	428	signal = shared_ptr<view::Signal>(
	429	new view::LogicSignal(*this,
	430	device_, signalbase));
	431	all_signal_data_.insert(logic_data_);
	432	signalbases_.insert(signalbase);
	433	break;
	434
	435	case SR_CHANNEL_ANALOG:
	436	{
	437	shared_ptr<data::Analog> data(new data::Analog());
	438	signalbase->set_data(data);
	439	signal = shared_ptr<view::Signal>(
	440	new view::AnalogSignal(
	441	*this, signalbase));
	442	all_signal_data_.insert(data);
	443	signalbases_.insert(signalbase);
	444	break;
	445	}
	446
	447	default:
	448	assert(0);
	449	break;
	450	}
	451	}
	452
	453	assert(signal);
	454	signals_.insert(signal);
	455	}
	456	}
	457
	458	signals_changed();
	459	}
	460
	461	shared_ptr<data::SignalBase> Session::signalbase_from_channel(
	462	shared_ptr<sigrok::Channel> channel) const
	463	{
	464	for (shared_ptr<data::SignalBase> sig : signalbases_) {
	465	assert(sig);
	466	if (sig->channel() == channel)
	467	return sig;
	468	}
	469	return shared_ptr<data::SignalBase>();
	470	}
	471
	472	void Session::sample_thread_proc(function<void (const QString)> error_handler)
	473	{
	474	assert(error_handler);
	475
	476	if (!device_)
	477	return;
	478
	479	cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
	480
	481	out_of_memory_ = false;
	482
	483	try {
	484	device_->start();
	485	} catch (Error e) {
	486	error_handler(e.what());
	487	return;
	488	}
	489
	490	set_capture_state(device_->session()->trigger() ?
	491	AwaitingTrigger : Running);
	492
	493	device_->run();
	494	set_capture_state(Stopped);
	495
	496	// Confirm that SR_DF_END was received
	497	if (cur_logic_segment_) {
	498	qDebug("SR_DF_END was not received.");
	499	assert(0);
	500	}
	501
	502	if (out_of_memory_)
	503	error_handler(tr("Out of memory, acquisition stopped."));
	504	}
	505
	506	void Session::feed_in_header()
	507	{
	508	cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
	509	}
	510
	511	void Session::feed_in_meta(shared_ptr<Meta> meta)
	512	{
	513	for (auto entry : meta->config()) {
	514	switch (entry.first->id()) {
	515	case SR_CONF_SAMPLERATE:
	516	// We can't rely on the header to always contain the sample rate,
	517	// so in case it's supplied via a meta packet, we use it.
	518	if (!cur_samplerate_)
	519	cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
	520
	521	/// @todo handle samplerate changes
	522	break;
	523	default:
	524	// Unknown metadata is not an error.
	525	break;
	526	}
	527	}
	528
	529	signals_changed();
	530	}
	531
	532	void Session::feed_in_trigger()
	533	{
	534	// The channel containing most samples should be most accurate
	535	uint64_t sample_count = 0;
	536
	537	{
	538	shared_lock<shared_mutex> lock(signals_mutex_);
	539	for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
	540	assert(d);
	541	uint64_t temp_count = 0;
	542
	543	const vector< shared_ptr<pv::data::Segment> > segments =
	544	d->segments();
	545	for (const shared_ptr<pv::data::Segment> &s : segments)
	546	temp_count += s->get_sample_count();
	547
	548	if (temp_count > sample_count)
	549	sample_count = temp_count;
	550	}
	551	}
	552
	553	trigger_event(sample_count / get_samplerate());
	554	}
	555
	556	void Session::feed_in_frame_begin()
	557	{
	558	if (cur_logic_segment_ \|\| !cur_analog_segments_.empty())
	559	frame_began();
	560	}
	561
	562	void Session::feed_in_logic(shared_ptr<Logic> logic)
	563	{
	564	lock_guard<recursive_mutex> lock(data_mutex_);
	565
	566	const size_t sample_count = logic->data_length() / logic->unit_size();
	567
	568	if (!logic_data_) {
	569	// The only reason logic_data_ would not have been created is
	570	// if it was not possible to determine the signals when the
	571	// device was created.
	572	update_signals();
	573	}
	574
	575	if (!cur_logic_segment_) {
	576	// This could be the first packet after a trigger
	577	set_capture_state(Running);
	578
	579	// Create a new data segment
	580	cur_logic_segment_ = shared_ptr<data::LogicSegment>(
	581	new data::LogicSegment(
	582	logic, cur_samplerate_, sample_count));
	583	logic_data_->push_segment(cur_logic_segment_);
	584
	585	// @todo Putting this here means that only listeners querying
	586	// for logic will be notified. Currently the only user of
	587	// frame_began is DecoderStack, but in future we need to signal
	588	// this after both analog and logic sweeps have begun.
	589	frame_began();
	590	} else {
	591	// Append to the existing data segment
	592	cur_logic_segment_->append_payload(logic);
	593	}
	594
	595	data_received();
	596	}
	597
	598	void Session::feed_in_analog(shared_ptr<Analog> analog)
	599	{
	600	lock_guard<recursive_mutex> lock(data_mutex_);
	601
	602	const vector<shared_ptr<Channel>> channels = analog->channels();
	603	const unsigned int channel_count = channels.size();
	604	const size_t sample_count = analog->num_samples() / channel_count;
	605	const float data = static_cast<const float >(analog->data_pointer());
	606	bool sweep_beginning = false;
	607
	608	if (signals_.empty())
	609	update_signals();
	610
	611	for (auto channel : channels) {
	612	shared_ptr<data::AnalogSegment> segment;
	613
	614	// Try to get the segment of the channel
	615	const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
	616	iterator iter = cur_analog_segments_.find(channel);
	617	if (iter != cur_analog_segments_.end())
	618	segment = (*iter).second;
	619	else {
	620	// If no segment was found, this means we haven't
	621	// created one yet. i.e. this is the first packet
	622	// in the sweep containing this segment.
	623	sweep_beginning = true;
	624
	625	// Create a segment, keep it in the maps of channels
	626	segment = shared_ptr<data::AnalogSegment>(
	627	new data::AnalogSegment(
	628	cur_samplerate_, sample_count));
	629	cur_analog_segments_[channel] = segment;
	630
	631	// Find the analog data associated with the channel
	632	shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
	633	assert(base);
	634
	635	shared_ptr<data::Analog> data(base->analog_data());
	636	assert(data);
	637
	638	// Push the segment into the analog data.
	639	data->push_segment(segment);
	640	}
	641
	642	assert(segment);
	643
	644	// Append the samples in the segment
	645	segment->append_interleaved_samples(data++, sample_count,
	646	channel_count);
	647	}
	648
	649	if (sweep_beginning) {
	650	// This could be the first packet after a trigger
	651	set_capture_state(Running);
	652	}
	653
	654	data_received();
	655	}
	656
	657	void Session::data_feed_in(shared_ptr<sigrok::Device> device,
	658	shared_ptr<Packet> packet)
	659	{
	660	(void)device;
	661
	662	assert(device);
	663	assert(device == device_->device());
	664	assert(packet);
	665
	666	switch (packet->type()->id()) {
	667	case SR_DF_HEADER:
	668	feed_in_header();
	669	break;
	670
	671	case SR_DF_META:
	672	feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
	673	break;
	674
	675	case SR_DF_TRIGGER:
	676	feed_in_trigger();
	677	break;
	678
	679	case SR_DF_FRAME_BEGIN:
	680	feed_in_frame_begin();
	681	break;
	682
	683	case SR_DF_LOGIC:
	684	try {
	685	feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
	686	} catch (std::bad_alloc) {
	687	out_of_memory_ = true;
	688	device_->stop();
	689	}
	690	break;
	691
	692	case SR_DF_ANALOG:
	693	try {
	694	feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
	695	} catch (std::bad_alloc) {
	696	out_of_memory_ = true;
	697	device_->stop();
	698	}
	699	break;
	700
	701	case SR_DF_END:
	702	{
	703	{
	704	lock_guard<recursive_mutex> lock(data_mutex_);
	705	cur_logic_segment_.reset();
	706	cur_analog_segments_.clear();
	707	}
	708	frame_ended();
	709	break;
	710	}
	711	default:
	712	break;
	713	}
	714	}
	715
	716	} // namespace pv