aax_native_view.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <string>
 
// Native-view helpers for the AAX editor shell. AAX hands the plug-in a host
// owned parent view (NSView* on macOS) and sizes it from GetViewSize; the
// plug-in's child view has to be placed inside that parent explicitly. These
// helpers keep that placement, and the frame diagnostics that prove what the
// host actually did, out of the shared PluginViewHost so no other format's
// attach path changes. Every function is a no-op on platforms without a
// native AAX parent, so the adapter can call them unconditionally.
 
namespace pulp::format::aax {

struct AaxNativeRect {
    float x = 0.0f;
    float y = 0.0f;
    float width = 0.0f;
    float height = 0.0f;
};

struct AaxNativeGeometry {
    bool valid = false;          
    bool has_window = false;     
    bool parent_flipped = false; 
    AaxNativeRect parent_frame;  
    AaxNativeRect parent_bounds; 
    AaxNativeRect child_frame;   
    AaxNativeRect window_frame;  
    float backing_scale = 1.0f;  
};

constexpr float aax_child_top_left_y(float parent_height, float child_height, bool parent_flipped) {
    if (parent_flipped)
        return 0.0f;
    const float y = parent_height - child_height;
    return y > 0.0f ? y : 0.0f;
}

#if defined(__APPLE__)
float aax_display_scale(void* native_parent) noexcept;
#else
inline float aax_display_scale(void*) noexcept {
    return 1.0f;
}
#endif
 
#if defined(__APPLE__)
AaxNativeGeometry aax_native_geometry(void* native_parent, void* native_child) noexcept;

void aax_place_child_top_left(void* native_parent, void* native_child) noexcept;

void aax_fill_parent(void* native_parent, void* native_child) noexcept;

void aax_set_child_tracks_parent(void* native_child, bool tracks) noexcept;
#else
inline AaxNativeGeometry aax_native_geometry(void*, void*) noexcept {
    return {};
}
inline void aax_place_child_top_left(void*, void*) noexcept {}
inline void aax_fill_parent(void*, void*) noexcept {}
inline void aax_set_child_tracks_parent(void*, bool) noexcept {}
#endif

inline std::string aax_describe_geometry(const AaxNativeGeometry& g) {
    auto rect = [](const AaxNativeRect& r) {
        return std::to_string(static_cast<int>(r.width)) + "x" +
               std::to_string(static_cast<int>(r.height)) + "@" +
               std::to_string(static_cast<int>(r.x)) + "," + std::to_string(static_cast<int>(r.y));
    };
    if (!g.valid)
        return "invalid";
    return "parent=" + rect(g.parent_frame) + " parent_bounds=" + rect(g.parent_bounds) +
           " child=" + rect(g.child_frame) +
           " window=" + (g.has_window ? rect(g.window_frame) : std::string("none")) +
           " scale=" + std::to_string(g.backing_scale) + (g.parent_flipped ? " flipped" : "");
}
 
} // namespace pulp::format::aax