[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/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 traces
	signals_.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);
	device_->open();
	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)
{
	stop_capture();

	// Check that at least one channel is enabled
	assert(device_);
	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
	for (const shared_ptr<data::SignalData> d : get_data())
		d->clear();

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

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

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

set< shared_ptr<data::SignalData> > Session::get_data() const
{
	shared_lock<shared_mutex> lock(signals_mutex_);
	set< shared_ptr<data::SignalData> > data;
	for (const shared_ptr<view::Signal> sig : signals_) {
		assert(sig);
		data.insert(sig->data());
	}

	return data;
}

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

	for (const shared_ptr<pv::data::SignalData> d : get_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(
					l->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<view::DecodeTrace> d(
			new view::DecodeTrace(*this, 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<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->channel() == channel;
				});
			if (iter != prev_sigs.end()) {
				// Copy the signal from the old set to the new
				signal = *iter;
				auto logic_signal = dynamic_pointer_cast<
					view::LogicSignal>(signal);
				if (logic_signal)
					logic_signal->set_logic_data(
						logic_data_);
			} else {
				// Create a new signal
				switch(channel->type()->id()) {
				case SR_CHANNEL_LOGIC:
					signal = shared_ptr<view::Signal>(
						new view::LogicSignal(*this,
							device_, channel,
							logic_data_));
					break;

				case SR_CHANNEL_ANALOG:
				{
					shared_ptr<data::Analog> data(
						new data::Analog());
					signal = shared_ptr<view::Signal>(
						new view::AnalogSignal(
							*this, channel, data));
					break;
				}

				default:
					assert(0);
					break;
				}
			}

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

	signals_changed();
}

shared_ptr<view::Signal> Session::signal_from_channel(
	shared_ptr<Channel> channel) const
{
	lock_guard<boost::shared_mutex> lock(signals_mutex_);
	for (shared_ptr<view::Signal> sig : signals_) {
		assert(sig);
		if (sig->channel() == channel)
			return sig;
	}
	return shared_ptr<view::Signal>();
}

void Session::sample_thread_proc(shared_ptr<devices::Device> device,
	function<void (const QString)> error_handler)
{
	assert(device);
	assert(error_handler);

	(void)device;

	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;

	for (const shared_ptr<pv::data::SignalData> d : get_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<view::AnalogSignal> sig =
				dynamic_pointer_cast<view::AnalogSignal>(
					signal_from_channel(channel));
			assert(sig);

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