mayhem-firmware/firmware/application/ui_record_view.cpp

/*
 * Copyright (C) 2016 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_record_view.hpp"

#include "portapack.hpp"
using namespace portapack;

#include "io_file.hpp"
#include "io_wave.hpp"
#include "io_convert.hpp"

#include "baseband_api.hpp"
#include "metadata_file.hpp"
#include "oversample.hpp"
#include "rtc_time.hpp"
#include "string_format.hpp"
#include "utility.hpp"

#include <cstdint>
#include <vector>

namespace ui {

/*void RecordView::toggle_pitch_rssi() {
        pitch_rssi_enabled = !pitch_rssi_enabled;

        // Send to RSSI widget
        const PitchRSSIConfigureMessage message {
                pitch_rssi_enabled,
                0
        };
        shared_memory.application_queue.push(message);

        if( !pitch_rssi_enabled ) {
                button_pitch_rssi.set_foreground(Theme::getInstance()->fg_orange->foreground);
        } else {
                button_pitch_rssi.set_foreground(Theme::getInstance()->fg_green->foreground);
        }
}*/

RecordView::RecordView(
    const Rect parent_rect,
    const std::filesystem::path& filename_stem_pattern,
    const std::filesystem::path& folder,
    const FileType file_type,
    const size_t write_size,
    const size_t buffer_count)
    : View{parent_rect},
      filename_stem_pattern{filename_stem_pattern},
      folder{folder},
      file_type{file_type},
      write_size{write_size},
      buffer_count{buffer_count} {
    ensure_directory(folder);
    add_children({
        &rect_background,
        //&button_pitch_rssi,
        &button_record,
        &gps_icon,
        &text_record_filename,
        &text_record_dropped,
        &text_time_available,
    });

    rect_background.set_parent_rect({{0, 0}, size()});

    /*button_pitch_rssi.on_select = [this](ImageButton&) {
                this->toggle_pitch_rssi();
        };*/

    button_record.on_select = [this](ImageButton&) {
        this->toggle();
    };

    signal_token_tick_second = rtc_time::signal_tick_second += [this]() {
        this->on_tick_second();
    };
    gps_icon.hidden(true);
}

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

void RecordView::focus() {
    button_record.focus();
}

uint32_t RecordView::set_sampling_rate(uint32_t new_sampling_rate) {
    // Determine the oversampling needed (if any) and the actual sampling rate.
    auto oversample_rate = get_oversample_rate(new_sampling_rate);
    auto actual_sampling_rate = new_sampling_rate * toUType(oversample_rate);

    // Change the "REC" icon background to yellow when the selected rate exceeds hardware limits.
    // Above this threshold, samples will be dropped resulting incomplete capture files.
    if (new_sampling_rate > 1'250'000) {
        button_record.set_background(Theme::getInstance()->fg_yellow->foreground);
    } else {
        button_record.set_background(Theme::getInstance()->fg_yellow->background);
    }

    if (sampling_rate != new_sampling_rate) {
        stop();

        sampling_rate = new_sampling_rate;
        baseband::set_sample_rate(sampling_rate, oversample_rate);

        button_record.hidden(sampling_rate == 0);
        text_record_filename.hidden(sampling_rate == 0);
        text_record_dropped.hidden(sampling_rate == 0);
        text_time_available.hidden(sampling_rate == 0);
        rect_background.hidden(sampling_rate != 0);

        update_status_display();
    }

    return actual_sampling_rate;
}

OversampleRate RecordView::get_oversample_rate(uint32_t sample_rate) {
    // No oversampling necessary for baseband audio processors.
    if (file_type == FileType::WAV)
        return OversampleRate::None;

    return ::get_oversample_rate(sample_rate);
}

// Setter for datetime and frequency filename
void RecordView::set_filename_date_frequency(bool set) {
    filename_date_frequency = set;
    if (set)
        filename_as_is = false;
}

// Setter for leaving the filename untouched
void RecordView::set_filename_as_is(bool set) {
    filename_as_is = set;
    if (set)
        filename_date_frequency = false;
}

bool RecordView::is_active() const {
    return (bool)capture_thread;
}

void RecordView::toggle() {
    if (is_active()) {
        stop();
    } else {
        start();
    }
}

void RecordView::start() {
    stop();

    text_record_filename.set("");
    text_record_dropped.set("");
    trim_path = {};

    if (sampling_rate == 0) {
        return;
    }

    std::filesystem::path base_path;

    auto tmp_path = filename_stem_pattern;  // store it, to be able to modify without causing permanent change
    // check for geo data, if present append filename with _GEO
    if (latitude != 0 && longitude != 0 && latitude < 200 && longitude < 200) {
        tmp_path.append_filename(u"_GEO");
    }

    if (filename_date_frequency) {
        rtc_time::now(datetime);

        // ISO 8601
        std::string date_time =
            to_string_dec_uint(datetime.year(), 4, '0') +
            to_string_dec_uint(datetime.month(), 2, '0') +
            to_string_dec_uint(datetime.day(), 2, '0') + "T" +
            to_string_dec_uint(datetime.hour()) +
            to_string_dec_uint(datetime.minute()) +
            to_string_dec_uint(datetime.second());

        base_path = tmp_path.string() + "_" + date_time + "_" +
                    trim(to_string_freq(receiver_model.target_frequency())) + "Hz";
        base_path = folder / base_path;
    } else if (filename_as_is) {
        base_path = tmp_path.string();
        base_path = folder / base_path;
    } else
        base_path = next_filename_matching_pattern(folder / tmp_path);

    if (base_path.empty()) {
        return;
    }

    std::unique_ptr<stream::Writer> writer;
    switch (file_type) {
        case FileType::WAV: {
            auto p = std::make_unique<WAVFileWriter>();
            auto create_error = p->create(
                base_path.replace_extension(u".WAV"),
                sampling_rate,
                to_string_dec_uint(receiver_model.target_frequency()) + "Hz");
            if (create_error.is_valid()) {
                handle_error(create_error.value());
            } else {
                writer = std::move(p);
            }
        } break;

        case FileType::RawS8:
        case FileType::RawS16: {
            const auto metadata_file_error = write_metadata_file(
                get_metadata_path(base_path), {receiver_model.target_frequency(), sampling_rate, latitude, longitude, satinuse});
            if (metadata_file_error.is_valid()) {
                handle_error(metadata_file_error.value());
                return;
            }

            auto p = std::make_unique<FileConvertWriter>();
            trim_path = base_path.replace_extension((file_type == FileType::RawS8) ? u".C8" : u".C16");
            auto create_error = p->create(trim_path);
            if (create_error.is_valid()) {
                handle_error(create_error.value());
            } else {
                writer = std::move(p);
            }
        } break;

        default:
            break;
    };

    if (writer) {
        text_record_filename.set(truncate(base_path.filename().string(), 8));
        button_record.set_bitmap(&bitmap_stop);
        capture_thread = std::make_unique<CaptureThread>(
            std::move(writer),
            write_size, buffer_count,
            []() {
                CaptureThreadDoneMessage message{};
                EventDispatcher::send_message(message);
            },
            [](File::Error error) {
                CaptureThreadDoneMessage message{error.code()};
                EventDispatcher::send_message(message);
            });
    }

    update_status_display();
}

void RecordView::on_hide() {
    stop();  // Stop current recording
    View::on_hide();
}

void RecordView::stop() {
    if (is_active()) {
        capture_thread.reset();
        button_record.set_bitmap(&bitmap_record);
        trim_capture();
    }

    update_status_display();
}

void RecordView::on_tick_second() {
    update_status_display();
}

void RecordView::update_status_display() {
    if (is_active()) {
        const auto dropped_percent = std::min(99U, capture_thread->state().dropped_percent());
        const auto s = to_string_dec_uint(dropped_percent, 2, ' ') + "%";
        text_record_dropped.set(s);
    }

    /*
    if (pitch_rssi_enabled) {
        button_pitch_rssi.invert_colors();
    }
    */

    if (sampling_rate > 0) {
        const auto space_info = std::filesystem::space(u"");
        // - Audio is 1 int16_t per sample or '2' bytes per sample.
        // - C8 captures 2 (I,Q) int8_t per sample or '2' bytes per sample.
        // - C16 captures 2 (I,Q) int16_t per sample or '4' bytes per sample.
        const auto bytes_per_sample = file_type == FileType::RawS16 ? 4 : 2;
        const uint32_t bytes_per_second = sampling_rate * bytes_per_sample;
        const uint32_t available_seconds = space_info.free / bytes_per_second;
        const uint32_t seconds = available_seconds % 60;
        const uint32_t available_minutes = available_seconds / 60;
        const uint32_t minutes = available_minutes % 60;
        const uint32_t hours = available_minutes / 60;
        const std::string available_time =
            to_string_dec_uint(hours, 3, ' ') + ":" +
            to_string_dec_uint(minutes, 2, '0') + ":" +
            to_string_dec_uint(seconds, 2, '0');
        text_time_available.set(available_time);
    }
}

void RecordView::trim_capture() {
    using bucket_t = iq::PowerBuckets::Bucket;

    if (file_type != FileType::WAV && auto_trim && !trim_path.empty()) {
        // Need to heap alloc the buckets in this case. The large static buffer overflows the stack.
        std::vector<bucket_t> buckets(size_t(255), bucket_t{});
        ;
        iq::PowerBuckets power_buckets{
            .p = &buckets[0],
            .size = buckets.size()};

        trim_ui.show_reading();
        auto info = iq::profile_capture(trim_path, power_buckets);

        if (info) {
            // 7% - decent trimming without being too aggressive.
            auto trim_range = iq::compute_trim_range(*info, power_buckets, 7);

            trim_ui.show_trimming();
            iq::trim_capture_with_range(trim_path, trim_range, trim_ui.get_callback(), 1);
        }

        trim_ui.clear();
    }

    trim_path = {};
}

void RecordView::on_gps(const GPSPosDataMessage* msg) {
    if (msg->lat == 0 || msg->lat > 399) return;  // not valid one
    if (latitude == 0) gps_icon.hidden(false);    // prev was 0, so not shown already
    latitude = msg->lat;
    longitude = msg->lon;
    satinuse = msg->satinuse;
}

void RecordView::handle_capture_thread_done(const File::Error error) {
    stop();
    if (error.code()) {
        handle_error(error);
    }
}

void RecordView::handle_error(const File::Error error) {
    if (on_error) {
        on_error(error.what());
    }
}

} /* namespace ui */