portapack-mayhem/firmware/application/ui/ui_spectrum.cpp

/*
 * Copyright (C) 2015 Jared Boone, ShareBrained Technology, Inc.
 *
 * This file is part of PortaPack.
 *
 * 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, 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; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#include "ui_spectrum.hpp"

#include "spectrum_color_lut.hpp"

#include "portapack.hpp"
using namespace portapack;

#include "baseband_api.hpp"

#include "string_format.hpp"

#include <cmath>
#include <array>

namespace ui {
namespace spectrum {

/* FrequencyScale ********************************************************/

void FrequencyScale::on_show() {
	clear();
}

void FrequencyScale::set_spectrum_sampling_rate(const int new_sampling_rate) {
	if( (spectrum_sampling_rate != new_sampling_rate) ) {
		spectrum_sampling_rate = new_sampling_rate;
		set_dirty();
	}
}

void FrequencyScale::set_channel_filter(
	const int pass_frequency,
	const int stop_frequency
) {
	if( (channel_filter_pass_frequency != pass_frequency) ||
		(channel_filter_stop_frequency != stop_frequency) ) {
		channel_filter_pass_frequency = pass_frequency;
		channel_filter_stop_frequency = stop_frequency;
		set_dirty();
	}
}

void FrequencyScale::show_cursor(const bool v) {
	if (v != _show_cursor) {
		_show_cursor = v;
		set_dirty();
	}
}

void FrequencyScale::set_cursor_position(const int32_t value) {
	_show_cursor = true;
	cursor_position = value;
	set_dirty();
}

void FrequencyScale::paint(Painter& painter) {
	const auto r = screen_rect();

	clear_background(painter, r);

	if( !spectrum_sampling_rate ) {
		// Can't draw without non-zero scale.
		return;
	}

	draw_filter_ranges(painter, r);
	draw_frequency_ticks(painter, r);
	
	if (_show_cursor) {
		const Rect r_cursor {
			120 + cursor_position, r.bottom() - filter_band_height,
			2, filter_band_height
		};
		painter.fill_rectangle(
			r_cursor,
			Color::red()
		);
	}
}

void FrequencyScale::clear() {
	spectrum_sampling_rate = 0;
	set_dirty();
}

void FrequencyScale::clear_background(Painter& painter, const Rect r) {
	painter.fill_rectangle(r, Color::black());
}

void FrequencyScale::draw_frequency_ticks(Painter& painter, const Rect r) {
	const auto x_center = r.width() / 2;

	const Rect tick { r.left() + x_center, r.top(), 1, r.height() };
	painter.fill_rectangle(tick, Color::white());

	constexpr int tick_count_max = 4;
	float rough_tick_interval = float(spectrum_sampling_rate) / tick_count_max;
	int magnitude = 1;
	int magnitude_n = 0;
	while(rough_tick_interval >= 10.0f) {
		rough_tick_interval /= 10;
		magnitude *= 10;
		magnitude_n += 1;
	}
	const int tick_interval = std::ceil(rough_tick_interval);

	auto tick_offset = tick_interval;
	while((tick_offset * magnitude) < spectrum_sampling_rate / 2) {
		const Dim pixel_offset = tick_offset * magnitude * spectrum_bins / spectrum_sampling_rate;

		const std::string zero_pad =
			((magnitude_n % 3) == 0) ? "" :
			((magnitude_n % 3) == 1) ? "0" : "00";
		const std::string unit =
			(magnitude_n >= 6) ? "M" :
			(magnitude_n >= 3) ? "k" : "";
		const std::string label = to_string_dec_uint(tick_offset) + zero_pad + unit;
		const auto label_width = style().font.size_of(label).width();
		
		const Coord offset_low = r.left() + x_center - pixel_offset;
		const Rect tick_low { offset_low, r.top(), 1, r.height() };
		painter.fill_rectangle(tick_low, Color::white());
		painter.draw_string({ offset_low + 2, r.top() }, style(), label );

		const Coord offset_high = r.left() + x_center + pixel_offset;
		const Rect tick_high { offset_high, r.top(), 1, r.height() };
		painter.fill_rectangle(tick_high, Color::white());
		painter.draw_string({ offset_high - 2 - label_width, r.top() }, style(), label );

		tick_offset += tick_interval;
	}
}

void FrequencyScale::draw_filter_ranges(Painter& painter, const Rect r) {
	if( channel_filter_pass_frequency ) {
		const auto x_center = r.width() / 2;

		const auto pass_offset = channel_filter_pass_frequency * spectrum_bins / spectrum_sampling_rate;
		const auto stop_offset = channel_filter_stop_frequency * spectrum_bins / spectrum_sampling_rate;

		const auto pass_x_lo = x_center - pass_offset;
		const auto pass_x_hi = x_center + pass_offset;

		if( channel_filter_stop_frequency ) {
			const auto stop_x_lo = x_center - stop_offset;
			const auto stop_x_hi = x_center + stop_offset;

			const Rect r_stop_lo {
				r.left() + stop_x_lo, r.bottom() - filter_band_height,
				pass_x_lo - stop_x_lo, filter_band_height
			};
			painter.fill_rectangle(
				r_stop_lo,
				Color::yellow()
			);

			const Rect r_stop_hi {
				r.left() + pass_x_hi, r.bottom() - filter_band_height,
				stop_x_hi - pass_x_hi, filter_band_height
			};
			painter.fill_rectangle(
				r_stop_hi,
				Color::yellow()
			);
		}

		const Rect r_pass {
			r.left() + pass_x_lo, r.bottom() - filter_band_height,
			pass_x_hi - pass_x_lo, filter_band_height
		};
		painter.fill_rectangle(
			r_pass,
			Color::green()
		);
	}
}

/* WaterfallView *********************************************************/

void WaterfallView::on_show() {
	clear();

	const auto screen_r = screen_rect();
	display.scroll_set_area(screen_r.top(), screen_r.bottom());
}

void WaterfallView::on_hide() {
	/* TODO: Clear region to eliminate brief flash of content at un-shifted
	 * position?
	 */
	display.scroll_disable();
}

void WaterfallView::paint(Painter& painter) {
	// Do nothing.
	(void)painter;
}

void WaterfallView::on_channel_spectrum(
	const ChannelSpectrum& spectrum
) {
	/* TODO: static_assert that message.spectrum.db.size() >= pixel_row.size() */

	std::array<Color, 240> pixel_row;
	for(size_t i=0; i<120; i++) {
		const auto pixel_color = spectrum_rgb3_lut[spectrum.db[256 - 120 + i]];
		pixel_row[i] = pixel_color;
	}

	for(size_t i=120; i<240; i++) {
		const auto pixel_color = spectrum_rgb3_lut[spectrum.db[i - 120]];
		pixel_row[i] = pixel_color;
	}

	const auto draw_y = display.scroll(1);

	display.draw_pixels(
		{ { 0, draw_y }, { pixel_row.size(), 1 } },
		pixel_row
	);
}

void WaterfallView::clear() {
	display.fill_rectangle(
		screen_rect(),
		Color::black()
	);
}

/* WaterfallWidget *******************************************************/

WaterfallWidget::WaterfallWidget(const bool cursor) {
	set_focusable(cursor);
	
	add_children({
		&waterfall_view,
		&frequency_scale,
	});
}

WaterfallWidget::~WaterfallWidget() {
	rtc_time::signal_tick_second -= signal_token_tick_second;
}

void WaterfallWidget::on_tick_second() {
	frequency_scale.show_cursor(_blink);
	_blink = !_blink;
}

void WaterfallWidget::on_show() {
	baseband::spectrum_streaming_start();
}

void WaterfallWidget::on_hide() {
	baseband::spectrum_streaming_stop();
}

void WaterfallWidget::on_focus() {
	_blink = true;
	signal_token_tick_second = rtc_time::signal_tick_second += [this]() {
		this->on_tick_second();
	};
}

void WaterfallWidget::on_blur() {
	frequency_scale.show_cursor(false);
	rtc_time::signal_tick_second -= signal_token_tick_second;
}

bool WaterfallWidget::on_encoder(const EncoderEvent delta) {
	cursor_position += delta;
	
	cursor_position = std::min<int32_t>(cursor_position, 119);
	cursor_position = std::max<int32_t>(cursor_position, -120);
	
	frequency_scale.set_cursor_position(cursor_position);
	return true;
}

bool WaterfallWidget::on_key(const KeyEvent key) {
	if( key == KeyEvent::Select ) {
		if( on_select ) {
			on_select((cursor_position * sampling_rate) / 240);
			cursor_position = 0;
			frequency_scale.set_cursor_position(cursor_position);
			return true;
		}
	}

	return false;
}

void WaterfallWidget::set_parent_rect(const Rect new_parent_rect) {
	constexpr Dim scale_height = 20;

	View::set_parent_rect(new_parent_rect);
	frequency_scale.set_parent_rect({ 0, 0, new_parent_rect.width(), scale_height });
	waterfall_view.set_parent_rect({
		0, scale_height,
		new_parent_rect.width(),
		new_parent_rect.height() - scale_height
	});
}

void WaterfallWidget::paint(Painter& painter) {
	// TODO:
	(void)painter;
}

void WaterfallWidget::on_channel_spectrum(const ChannelSpectrum& spectrum) {
	waterfall_view.on_channel_spectrum(spectrum);
	sampling_rate = spectrum.sampling_rate;
	frequency_scale.set_spectrum_sampling_rate(sampling_rate);
	frequency_scale.set_channel_filter(
		spectrum.channel_filter_pass_frequency,
		spectrum.channel_filter_stop_frequency
	);
}

} /* namespace spectrum */
} /* namespace ui */