Renamed C++ headers to .hpp

[pulseview.git] / pv / toolbars / samplingbar.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 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
 */

#include <extdef.h>

#include <assert.h>

#include <QAction>
#include <QDebug>
#include <QHelpEvent>
#include <QToolTip>

#include "samplingbar.hpp"

#include <pv/devicemanager.hpp>
#include <pv/popups/deviceoptions.hpp>
#include <pv/popups/channels.hpp>
#include <pv/util.hpp>

#include <libsigrok/libsigrok.hpp>

using std::map;
using std::vector;
using std::max;
using std::min;
using std::shared_ptr;
using std::string;

using sigrok::Capability;
using sigrok::ConfigKey;
using sigrok::Device;
using sigrok::Error;

namespace pv {
namespace toolbars {

const uint64_t SamplingBar::MinSampleCount = 100ULL;
const uint64_t SamplingBar::MaxSampleCount = 1000000000000ULL;
const uint64_t SamplingBar::DefaultSampleCount = 1000000;

SamplingBar::SamplingBar(SigSession &session, QWidget *parent) :
	QToolBar("Sampling Bar", parent),
	session_(session),
	device_selector_(this),
	updating_device_selector_(false),
	configure_button_(this),
	configure_button_action_(NULL),
	channels_button_(this),
	sample_count_(" samples", this),
	sample_rate_("Hz", this),
	updating_sample_rate_(false),
	updating_sample_count_(false),
	sample_count_supported_(false),
	icon_red_(":/icons/status-red.svg"),
	icon_green_(":/icons/status-green.svg"),
	icon_grey_(":/icons/status-grey.svg"),
	run_stop_button_(this)
{
	setObjectName(QString::fromUtf8("SamplingBar"));

	connect(&run_stop_button_, SIGNAL(clicked()),
		this, SLOT(on_run_stop()));
	connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
		this, SLOT(on_device_selected()));
	connect(&sample_count_, SIGNAL(value_changed()),
		this, SLOT(on_sample_count_changed()));
	connect(&sample_rate_, SIGNAL(value_changed()),
		this, SLOT(on_sample_rate_changed()));

	sample_count_.show_min_max_step(0, UINT64_MAX, 1);

	set_capture_state(pv::SigSession::Stopped);

	configure_button_.setIcon(QIcon::fromTheme("configure",
		QIcon(":/icons/configure.png")));

	channels_button_.setIcon(QIcon::fromTheme("channels",
		QIcon(":/icons/channels.svg")));

	run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);

	addWidget(&device_selector_);
	configure_button_action_ = addWidget(&configure_button_);
	addWidget(&channels_button_);
	addWidget(&sample_count_);
	addWidget(&sample_rate_);

	addWidget(&run_stop_button_);

	sample_count_.installEventFilter(this);
	sample_rate_.installEventFilter(this);
}

void SamplingBar::set_device_list(
	const std::list< std::pair<std::shared_ptr<sigrok::Device>, std::string> > &devices,
	shared_ptr<Device> selected)
{
	int selected_index = -1;

	assert(selected);

	updating_device_selector_ = true;

	device_selector_.clear();

	for (auto entry : devices) {
		auto device = entry.first;
		auto display_name = entry.second;

		assert(device);

		if (selected == device)
			selected_index = device_selector_.count();

		device_selector_.addItem(display_name.c_str(),
			qVariantFromValue(device));
	}

	// The selected device should have been in the list
	assert(selected_index != -1);
	device_selector_.setCurrentIndex(selected_index);

	update_device_config_widgets();

	updating_device_selector_ = false;
}

shared_ptr<Device> SamplingBar::get_selected_device() const
{
	const int index = device_selector_.currentIndex();
	if (index < 0)
		return shared_ptr<Device>();

	return device_selector_.itemData(index).value<shared_ptr<Device>>();
}

void SamplingBar::set_capture_state(pv::SigSession::capture_state state)
{
	const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
	run_stop_button_.setIcon(*icons[state]);
	run_stop_button_.setText((state == pv::SigSession::Stopped) ?
		tr("Run") : tr("Stop"));
	run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
}

void SamplingBar::update_sample_rate_selector()
{
	Glib::VariantContainerBase gvar_dict;
	GVariant *gvar_list;
	const uint64_t *elements = NULL;
	gsize num_elements;

	if (updating_sample_rate_)
		return;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	assert(!updating_sample_rate_);
	updating_sample_rate_ = true;

	try {
		gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
	} catch (Error error) {
		sample_rate_.show_none();
		updating_sample_rate_ = false;
		return;
	}

	if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
			"samplerate-steps", G_VARIANT_TYPE("at"))))
	{
		elements = (const uint64_t *)g_variant_get_fixed_array(
				gvar_list, &num_elements, sizeof(uint64_t));

		const uint64_t min = elements[0];
		const uint64_t max = elements[1];
		const uint64_t step = elements[2];

		g_variant_unref(gvar_list);

		assert(min > 0);
		assert(max > 0);
		assert(max > min);
		assert(step > 0);

		if (step == 1)
			sample_rate_.show_125_list(min, max);
		else
		{
			// When the step is not 1, we cam't make a 1-2-5-10
			// list of sample rates, because we may not be able to
			// make round numbers. Therefore in this case, show a
			// spin box.
			sample_rate_.show_min_max_step(min, max, step);
		}
	}
	else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
			"samplerates", G_VARIANT_TYPE("at"))))
	{
		elements = (const uint64_t *)g_variant_get_fixed_array(
				gvar_list, &num_elements, sizeof(uint64_t));
		sample_rate_.show_list(elements, num_elements);
		g_variant_unref(gvar_list);
	}
	updating_sample_rate_ = false;

	update_sample_rate_selector_value();
}

void SamplingBar::update_sample_rate_selector_value()
{
	if (updating_sample_rate_)
		return;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	try {
		auto gvar = device->config_get(ConfigKey::SAMPLERATE);
		uint64_t samplerate =
			Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
		assert(!updating_sample_rate_);
		updating_sample_rate_ = true;
		sample_rate_.set_value(samplerate);
		updating_sample_rate_ = false;
	} catch (Error error) {
		qDebug() << "WARNING: Failed to get value of sample rate";
		return;
	}
}

void SamplingBar::update_sample_count_selector()
{
	if (updating_sample_count_)
		return;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	assert(!updating_sample_count_);
	updating_sample_count_ = true;

	if (sample_count_supported_)
	{
		uint64_t sample_count = sample_count_.value();
		uint64_t min_sample_count = 0;
		uint64_t max_sample_count = MaxSampleCount;

		if (sample_count == 0)
			sample_count = DefaultSampleCount;

		try {
			auto gvar = device->config_list(ConfigKey::LIMIT_SAMPLES);
			g_variant_get(gvar.gobj(), "(tt)",
				&min_sample_count, &max_sample_count);
		} catch (Error error) {}

		min_sample_count = min(max(min_sample_count, MinSampleCount),
			max_sample_count);

		sample_count_.show_125_list(
			min_sample_count, max_sample_count);

		try {
			auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
			sample_count = g_variant_get_uint64(gvar.gobj());
			if (sample_count == 0)
				sample_count = DefaultSampleCount;
			sample_count = min(max(sample_count, MinSampleCount),
				max_sample_count);
		} catch (Error error) {}

		sample_count_.set_value(sample_count);
	}
	else
		sample_count_.show_none();

	updating_sample_count_ = false;
}

void SamplingBar::update_device_config_widgets()
{
	using namespace pv::popups;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	// Update the configure popup
	DeviceOptions *const opts = new DeviceOptions(device, this);
	configure_button_action_->setVisible(
		!opts->binding().properties().empty());
	configure_button_.set_popup(opts);

	// Update the channels popup
	Channels *const channels = new Channels(session_, this);
	channels_button_.set_popup(channels);

	// Update supported options.
	sample_count_supported_ = false;

	try {
		for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
		{
			auto key = entry.first;
			auto capabilities = entry.second;
			switch (key->id()) {
			case SR_CONF_LIMIT_SAMPLES:
				if (capabilities.count(Capability::SET))
					sample_count_supported_ = true;
				break;
			case SR_CONF_LIMIT_FRAMES:
				if (capabilities.count(Capability::SET))
				{
					device->config_set(ConfigKey::LIMIT_FRAMES,
						Glib::Variant<guint64>::create(1));
					on_config_changed();
				}
				break;
			default:
				break;
			}
		}
	} catch (Error error) {}

	// Add notification of reconfigure events
	disconnect(this, SLOT(on_config_changed()));
	connect(&opts->binding(), SIGNAL(config_changed()),
		this, SLOT(on_config_changed()));

	// Update sweep timing widgets.
	update_sample_count_selector();
	update_sample_rate_selector();
}

void SamplingBar::commit_sample_count()
{
	uint64_t sample_count = 0;

	if (updating_sample_count_)
		return;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	sample_count = sample_count_.value();

	// Set the sample count
	assert(!updating_sample_count_);
	updating_sample_count_ = true;
	if (sample_count_supported_)
	{
		try {
			device->config_set(ConfigKey::LIMIT_SAMPLES,
				Glib::Variant<guint64>::create(sample_count));
			on_config_changed();
		} catch (Error error) {
			qDebug() << "Failed to configure sample count.";
			return;
		}
	}
	updating_sample_count_ = false;
}

void SamplingBar::commit_sample_rate()
{
	uint64_t sample_rate = 0;

	if (updating_sample_rate_)
		return;

	const shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	sample_rate = sample_rate_.value();
	if (sample_rate == 0)
		return;

	// Set the samplerate
	assert(!updating_sample_rate_);
	updating_sample_rate_ = true;
	try {
		device->config_set(ConfigKey::SAMPLERATE,
			Glib::Variant<guint64>::create(sample_rate));
		on_config_changed();
	} catch (Error error) {
		qDebug() << "Failed to configure samplerate.";
		return;
	}
	updating_sample_rate_ = false;
}

void SamplingBar::on_device_selected()
{
	if (updating_device_selector_)
		return;

	shared_ptr<Device> device = get_selected_device();
	if (!device)
		return;

	session_.set_device(device);

	update_device_config_widgets();
}

void SamplingBar::on_sample_count_changed()
{
	commit_sample_count();
}

void SamplingBar::on_sample_rate_changed()
{
	commit_sample_rate();
}

void SamplingBar::on_run_stop()
{
	commit_sample_count();
	commit_sample_rate();	
	run_stop();
}

void SamplingBar::on_config_changed()
{
	commit_sample_count();
	update_sample_count_selector();	
	commit_sample_rate();	
	update_sample_rate_selector();
}

bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
{
	if ((watched == &sample_count_ || watched == &sample_rate_) &&
		(event->type() == QEvent::ToolTip)) {
		double sec = (double)sample_count_.value() / sample_rate_.value();
		QHelpEvent *help_event = static_cast<QHelpEvent*>(event);

		QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
		QToolTip::showText(help_event->globalPos(), str);

		return true;
	}

	return false;
}

} // namespace toolbars
} // namespace pv