portapack-mayhem/firmware/application/ui_spectrum.hpp

/*
 * 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.
 */

#ifndef __UI_SPECTRUM_H__
#define __UI_SPECTRUM_H__

#include "ui.hpp"
#include "ui_widget.hpp"
#include "spectrum_color_lut.hpp"

#include "portapack.hpp"
using namespace portapack;

#include "message.hpp"

#include <cstdint>
#include <cmath>
#include <array>

namespace ui {
namespace spectrum {

class FrequencyScale : public Widget {
public:
	void set_spectrum_sampling_rate(const uint32_t new_sampling_rate, const size_t new_spectrum_bins) {
		if( (spectrum_sampling_rate != new_sampling_rate) ||
			(spectrum_bins != new_spectrum_bins) ) {
			spectrum_sampling_rate = new_sampling_rate;
			spectrum_bins = new_spectrum_bins;
			set_dirty();
		}
	}

	void set_channel_filter(
		const uint32_t pass_frequency,
		const uint32_t 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 paint(Painter& painter) override {
		const auto r = screen_rect();

		clear_background(painter, r);

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

		draw_filter_ranges(painter, r);
		draw_frequency_ticks(painter, r);
	}

	void clear() {
		spectrum_sampling_rate = 0;
		spectrum_bins = 0;
		set_dirty();
	}

private:
	static constexpr Dim filter_band_height = 4;

	uint32_t spectrum_sampling_rate { 0 };
	size_t spectrum_bins { 0 };
	uint32_t channel_filter_pass_frequency { 0 };
	uint32_t channel_filter_stop_frequency { 0 };

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

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

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

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

		size_t 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 Coord offset_low = static_cast<Coord>(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({ static_cast<Coord>(offset_low + 2), r.top() }, style(), label );

			const Coord offset_high = static_cast<Coord>(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({ static_cast<Coord>(offset_high + 2), r.top() }, style(), label );

			tick_offset += tick_interval;
		}
	}

	void 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 {
					static_cast<Coord>(r.left() + stop_x_lo), static_cast<Coord>(r.bottom() - filter_band_height),
					static_cast<Dim>(pass_x_lo - stop_x_lo), filter_band_height
				};
				painter.fill_rectangle(
					r_stop_lo,
					Color::yellow()
				);

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

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

class WaterfallView : public Widget {
public:
	void on_show() override {
		const auto screen_r = screen_rect();
		display.scroll_set_area(screen_r.top(), screen_r.bottom());
	}

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

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

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

	void 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
		);
	}
};

class WaterfallWidget : public View {
public:
	WaterfallWidget() {
		add_children({
			&waterfall_view,
			&frequency_scale,
		});
	}

	void on_show() override {
		context().message_map.register_handler(Message::ID::ChannelSpectrum,
			[this](const Message* const p) {
				this->on_channel_spectrum(reinterpret_cast<const ChannelSpectrumMessage*>(p)->spectrum);
			}
		);
	}

	void on_hide() override {
		context().message_map.unregister_handler(Message::ID::ChannelSpectrum);
	}

	void set_parent_rect(const Rect new_parent_rect) override {
		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(),
			static_cast<Dim>(new_parent_rect.height() - scale_height)
		});
	}

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

	void clear() {
		waterfall_view.clear();
		frequency_scale.clear();
	}

private:
	WaterfallView waterfall_view;
	FrequencyScale frequency_scale;

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

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

#endif/*__UI_SPECTRUM_H__*/