process_context.hpp

Go to the documentation of this file.

#pragma once
 
// Per-block host state handed to Processor::process(): transport position,
// tempo, render hints, and the SMPTE frame rate. processor.hpp includes this
// header, so existing consumers keep compiling unchanged; new code should
// include it directly.
 
#include <pulp/format/process_block.hpp>
#include <pulp/format/transport_fields.hpp>
#include <cstdint>
 
namespace pulp::format {

enum class FrameRate {
    unknown = 0,
    fps_24,           
    fps_25,           
    fps_29_97,        
    fps_29_97_drop,   
    fps_30,           
    fps_30_drop,      
    fps_60,           
};

enum class RenderSpeedHint {
    Unknown = 0,
    Realtime,
    FasterThanRealtime,
    SlowerThanRealtime,
};

struct ProcessContext {
    double sample_rate = 0;
    int num_samples = 0;

    ProcessMode process_mode = ProcessMode::Realtime;

    bool is_bypassed = false;

    bool is_tail_drain = false;

    bool reset_requested = false;

    bool transport_jump = false;

    RenderSpeedHint render_speed_hint = RenderSpeedHint::Unknown;
 
    bool is_playing = false;
    bool is_recording = false;
    double tempo_bpm = 120.0;
    double position_beats = 0.0;   
    int64_t position_samples = 0;
    int time_sig_numerator = 4;
    int time_sig_denominator = 4;
 
    // New fields default to "host did not provide" sentinels so adapters that
    // don't populate them keep the pre-extension behavior exactly.

    int64_t bar = 0;

    bool is_looping = false;

    double loop_start_beats = 0.0;

    double loop_end_beats = 0.0;

    int64_t host_time_ns = 0;

    FrameRate frame_rate = FrameRate::unknown;

    bool tempo_changed = false;

    bool time_sig_changed = false;

    bool transport_changed = false;

    bool transport_started = false;

    TransportValidity transport_validity{};

    bool ordinary_loop_wrap = false;
 
    constexpr bool has_transport(TransportField field) const noexcept {
        return transport_validity.has(field);
    }
 
    bool is_realtime() const noexcept {
        return process_mode == ProcessMode::Realtime;
    }
 
    bool is_offline() const noexcept {
        return process_mode == ProcessMode::Offline;
    }
 
    bool allows_offline_quality_work() const noexcept {
        return is_offline() &&
               render_speed_hint != RenderSpeedHint::Realtime;
    }

    bool should_reset_dsp_state() const noexcept {
        return reset_requested || transport_jump;
    }

    bool should_reset_stream_history() const noexcept {
        return reset_requested || (transport_jump && !ordinary_loop_wrap);
    }

    bool is_maintenance_render() const noexcept {
        return is_bypassed || is_tail_drain;
    }

    bool should_render_tail_only() const noexcept {
        return is_tail_drain;
    }
};
 
} // namespace pulp::format