Moved SPainter and GPSSim to ext app (#1721)

* Moved GPSSim
* Moved spainter

firmware/application/external/gpssim/gps_sim_app.cpp

@@ -0,0 +1,215 @@
+/*
+ * Copyright (C) 2016 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2016 Furrtek
+ * Copyright (C) 2020 Shao
+ *
+ * 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 "gps_sim_app.hpp"
+#include "string_format.hpp"
+
+#include "ui_fileman.hpp"
+#include "io_file.hpp"
+#include "metadata_file.hpp"
+#include "utility.hpp"
+
+#include "baseband_api.hpp"
+#include "portapack.hpp"
+#include "portapack_persistent_memory.hpp"
+
+using namespace portapack;
+namespace fs = std::filesystem;
+
+namespace ui::external_app::gpssim {
+
+void GpsSimAppView::set_ready() {
+    ready_signal = true;
+}
+
+void GpsSimAppView::on_file_changed(const fs::path& new_file_path) {
+    file_path = fs::path(u"/") + new_file_path;
+    File::Size file_size{};
+
+    {  // Get the size of the data file.
+        File data_file;
+        auto error = data_file.open(file_path);
+        if (error) {
+            file_error();
+            return;
+        }
+
+        file_size = data_file.size();
+    }
+
+    // Get original record frequency if available.
+    auto metadata_path = get_metadata_path(file_path);
+    auto metadata = read_metadata_file(metadata_path);
+
+    if (metadata) {
+        field_frequency.set_value(metadata->center_frequency);
+        transmitter_model.set_sampling_rate(metadata->sample_rate);
+    }
+
+    // UI Fixup.
+    text_sample_rate.set(unit_auto_scale(transmitter_model.sampling_rate(), 3, 1) + "Hz");
+    progressbar.set_max(file_size);
+    text_filename.set(truncate(file_path.filename().string(), 12));
+
+    auto duration = ms_duration(file_size, transmitter_model.sampling_rate(), 2);
+    text_duration.set(to_string_time_ms(duration));
+
+    // TODO: fix in UI framework with 'try_focus()'?
+    // Hack around focus getting called by ctor before parent is set.
+    if (parent())
+        button_play.focus();
+}
+
+void GpsSimAppView::on_tx_progress(const uint32_t progress) {
+    progressbar.set_value(progress);
+}
+
+void GpsSimAppView::focus() {
+    button_open.focus();
+}
+
+void GpsSimAppView::file_error() {
+    nav_.display_modal("Error", "File read error.");
+}
+
+bool GpsSimAppView::is_active() const {
+    return (bool)replay_thread;
+}
+
+void GpsSimAppView::toggle() {
+    if (is_active()) {
+        stop(false);
+    } else {
+        start();
+    }
+}
+
+void GpsSimAppView::start() {
+    stop(false);
+
+    std::unique_ptr<stream::Reader> reader;
+
+    auto p = std::make_unique<FileReader>();
+    auto open_error = p->open(file_path);
+    if (open_error.is_valid()) {
+        file_error();
+    } else {
+        reader = std::move(p);
+    }
+
+    if (reader) {
+        button_play.set_bitmap(&bitmap_stop);
+
+        replay_thread = std::make_unique<ReplayThread>(
+            std::move(reader),
+            read_size, buffer_count,
+            &ready_signal,
+            [](uint32_t return_code) {
+                ReplayThreadDoneMessage message{return_code};
+                EventDispatcher::send_message(message);
+            });
+    }
+
+    transmitter_model.enable();
+}
+
+void GpsSimAppView::stop(const bool do_loop) {
+    if (is_active())
+        replay_thread.reset();
+
+    if (do_loop && check_loop.value()) {
+        start();
+    } else {
+        transmitter_model.disable();
+        button_play.set_bitmap(&bitmap_play);
+    }
+
+    ready_signal = false;
+}
+
+void GpsSimAppView::handle_replay_thread_done(const uint32_t return_code) {
+    if (return_code == ReplayThread::END_OF_FILE) {
+        stop(true);
+    } else if (return_code == ReplayThread::READ_ERROR) {
+        stop(false);
+        file_error();
+    }
+
+    progressbar.set_value(0);
+}
+
+GpsSimAppView::GpsSimAppView(
+    NavigationView& nav)
+    : nav_(nav) {
+    // baseband::run_image(portapack::spi_flash::image_tag_gps);
+    baseband::run_prepared_image(portapack::memory::map::m4_code.base());
+
+    add_children({
+        &button_open,
+        &text_filename,
+        &text_sample_rate,
+        &text_duration,
+        &progressbar,
+        &field_frequency,
+        &tx_view,  // now it handles previous rfgain, rfamp.
+        &check_loop,
+        &button_play,
+        &waterfall,
+    });
+
+    field_frequency.set_step(5000);
+
+    button_play.on_select = [this](ImageButton&) {
+        this->toggle();
+    };
+
+    button_open.on_select = [this, &nav](Button&) {
+        auto open_view = nav.push<FileLoadView>(".C8");
+        open_view->on_changed = [this](std::filesystem::path new_file_path) {
+            on_file_changed(new_file_path);
+        };
+    };
+}
+
+GpsSimAppView::~GpsSimAppView() {
+    transmitter_model.disable();
+    baseband::shutdown();
+}
+
+void GpsSimAppView::on_hide() {
+    // TODO: Terrible kludge because widget system doesn't notify Waterfall that
+    // it's being shown or hidden.
+    if (is_active())
+        stop(false);
+    waterfall.on_hide();
+    View::on_hide();
+}
+
+void GpsSimAppView::set_parent_rect(const Rect new_parent_rect) {
+    View::set_parent_rect(new_parent_rect);
+
+    const ui::Rect waterfall_rect{0, header_height, new_parent_rect.width(), new_parent_rect.height() - header_height};
+    waterfall.set_parent_rect(waterfall_rect);
+}
+
+} /* namespace ui::external_app::gpssim */

firmware/application/external/gpssim/gps_sim_app.hpp

@@ -0,0 +1,148 @@
+/*
+ * Copyright (C) 2016 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2016 Furrtek
+ * Copyright (C) 2020 Shao
+ *
+ * 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 __GPS_SIM_APP_HPP__
+#define __GPS_SIM_APP_HPP__
+
+#include "app_settings.hpp"
+#include "ui_language.hpp"
+#include "radio_state.hpp"
+#include "ui_widget.hpp"
+#include "ui_navigation.hpp"
+#include "ui_receiver.hpp"
+#include "ui_freq_field.hpp"
+#include "replay_thread.hpp"
+#include "ui_spectrum.hpp"
+#include "ui_transmitter.hpp"
+
+#include <string>
+#include <memory>
+
+namespace ui::external_app::gpssim {
+
+class GpsSimAppView : public View {
+   public:
+    GpsSimAppView(NavigationView& nav);
+    ~GpsSimAppView();
+
+    void on_hide() override;
+    void set_parent_rect(const Rect new_parent_rect) override;
+    void focus() override;
+
+    std::string title() const override { return "GPS Sim TX"; };
+
+   private:
+    NavigationView& nav_;
+    TxRadioState radio_state_{
+        1575420000 /* frequency */,
+        15000000 /* bandwidth */,
+        2600000 /* sampling rate */
+    };
+    app_settings::SettingsManager settings_{
+        "tx_gps", app_settings::Mode::TX};
+
+    static constexpr ui::Dim header_height = 3 * 16;
+
+    const size_t read_size{16384};
+    const size_t buffer_count{3};
+
+    void on_file_changed(const std::filesystem::path& new_file_path);
+    void on_tx_progress(const uint32_t progress);
+
+    void toggle();
+    void start();
+    void stop(const bool do_loop);
+    bool is_active() const;
+    void set_ready();
+    void handle_replay_thread_done(const uint32_t return_code);
+    void file_error();
+
+    std::filesystem::path file_path{};
+    std::unique_ptr<ReplayThread> replay_thread{};
+    bool ready_signal{false};
+
+    Button button_open{
+        {0 * 8, 0 * 16, 10 * 8, 2 * 16},
+        "Open file"};
+
+    Text text_filename{
+        {11 * 8, 0 * 16, 12 * 8, 16},
+        "-"};
+    Text text_sample_rate{
+        {24 * 8, 0 * 16, 6 * 8, 16},
+        "-"};
+
+    Text text_duration{
+        {11 * 8, 1 * 16, 6 * 8, 16},
+        "-"};
+    ProgressBar progressbar{
+        {18 * 8, 1 * 16, 12 * 8, 16}};
+
+    TxFrequencyField field_frequency{
+        {0 * 8, 2 * 16},
+        nav_};
+
+    TransmitterView2 tx_view{
+        {11 * 8, 2 * 16},
+        /*short_ui*/ true};
+
+    Checkbox check_loop{
+        {21 * 8, 2 * 16},
+        4,
+        LanguageHelper::currentMessages[LANG_LOOP],
+        true};
+    ImageButton button_play{
+        {28 * 8, 2 * 16, 2 * 8, 1 * 16},
+        &bitmap_play,
+        Color::green(),
+        Color::black()};
+
+    spectrum::WaterfallView waterfall{};
+
+    MessageHandlerRegistration message_handler_replay_thread_error{
+        Message::ID::ReplayThreadDone,
+        [this](const Message* const p) {
+            const auto message = *reinterpret_cast<const ReplayThreadDoneMessage*>(p);
+            this->handle_replay_thread_done(message.return_code);
+        }};
+
+    MessageHandlerRegistration message_handler_fifo_signal{
+        Message::ID::RequestSignal,
+        [this](const Message* const p) {
+            const auto message = static_cast<const RequestSignalMessage*>(p);
+            if (message->signal == RequestSignalMessage::Signal::FillRequest) {
+                this->set_ready();
+            }
+        }};
+
+    MessageHandlerRegistration message_handler_tx_progress{
+        Message::ID::TXProgress,
+        [this](const Message* const p) {
+            const auto message = *reinterpret_cast<const TXProgressMessage*>(p);
+            this->on_tx_progress(message.progress);
+        }};
+};
+
+} /* namespace ui::external_app::gpssim */
+
+#endif /*__GPS_SIM_APP_HPP__*/

firmware/application/external/gpssim/main.cpp

@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ *
+ * 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.hpp"
+#include "gps_sim_app.hpp"
+#include "ui_navigation.hpp"
+#include "external_app.hpp"
+
+namespace ui::external_app::gpssim {
+void initialize_app(ui::NavigationView& nav) {
+    nav.push<GpsSimAppView>();
+}
+}  // namespace ui::external_app::gpssim
+
+extern "C" {
+
+__attribute__((section(".external_app.app_gpssim.application_information"), used)) application_information_t _application_information_gpssim = {
+    /*.memory_location = */ (uint8_t*)0x00000000,
+    /*.externalAppEntry = */ ui::external_app::gpssim::initialize_app,
+    /*.header_version = */ CURRENT_HEADER_VERSION,
+    /*.app_version = */ VERSION_MD5,
+
+    /*.app_name = */ "GPSSim",
+    /*.bitmap_data = */ {
+        0xC0,
+        0x07,
+        0xE0,
+        0x0F,
+        0x70,
+        0x1F,
+        0x78,
+        0x3E,
+        0x78,
+        0x3C,
+        0x78,
+        0x38,
+        0x78,
+        0x30,
+        0x78,
+        0x38,
+        0x78,
+        0x3C,
+        0x70,
+        0x1E,
+        0x70,
+        0x1F,
+        0xE0,
+        0x0F,
+        0xC0,
+        0x07,
+        0x80,
+        0x03,
+        0x20,
+        0x09,
+        0x50,
+        0x14,
+    },
+    /*.icon_color = */ ui::Color::green().v,
+    /*.menu_location = */ app_location_t::TX,
+
+    /*.m4_app_tag = portapack::spi_flash::image_tag_gpssim */ {'P', 'G', 'P', 'S'},
+    /*.m4_app_offset = */ 0x00000000,  // will be filled at compile time
+};
+}