comp_compositor.h

Go to the documentation of this file.

// Copyright 2019-2024, Collabora, Ltd.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  Main compositor written using Vulkan header.
 * @author Jakob Bornecrantz <jakob@collabora.com>
 * @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
 * @ingroup comp_main
 */
 
#pragma once
 
#include "xrt/xrt_gfx_vk.h"
#include "xrt/xrt_config_build.h"
 
#include "util/u_threading.h"
#include "util/u_index_fifo.h"
#include "util/u_logging.h"
#include "util/u_frame_times_widget.h"
#include "util/u_native_images_debug.h"
 
#include "util/comp_base.h"
#include "util/comp_sync.h"
#include "util/comp_scratch.h"
#include "util/comp_swapchain.h"
 
#include "render/render_interface.h"
 
#include "main/comp_target.h"
#include "main/comp_window.h"
#include "main/comp_settings.h"
#include "main/comp_renderer.h"
 
struct comp_window_peek;
struct comp_target_factory;
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/*
 *
 * Defines
 *
 */
 
// clang-format off
#define COMP_INSTANCE_EXTENSIONS_COMMON                         \
        VK_EXT_DEBUG_REPORT_EXTENSION_NAME,                     \
        VK_KHR_EXTERNAL_FENCE_CAPABILITIES_EXTENSION_NAME,      \
        VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME,     \
        VK_KHR_EXTERNAL_SEMAPHORE_CAPABILITIES_EXTENSION_NAME,  \
        VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, \
        VK_KHR_SURFACE_EXTENSION_NAME
// clang-format on
 
 
/*
 *
 * Structs
 *
 */
 
/*!
 * Tracking frame state.
 */
struct comp_frame
{
        int64_t id;
        uint64_t predicted_display_time_ns;
        uint64_t desired_present_time_ns;
        uint64_t present_slop_ns;
};
 
/*!
 * Main compositor struct tying everything in the compositor together.
 *
 *
 * This ultimately implements @ref xrt_compositor_native but does so by
 * extending @ref comp_base. Yes, it looks like a little bit of "code reuse
 * through inheritance," but it is useful here to avoid lots of boilerplate
 * due to the use of C.
 *
 * @ingroup comp_main
 * @extends comp_base
 */
struct comp_compositor
{
        struct comp_base base;
 
        //! The settings.
        struct comp_settings settings;
 
        //! The device we are displaying to.
        struct xrt_device *xdev;
 
        //! Vulkan shaders that the compositor (renderer) uses.
        struct render_shaders shaders;
 
        //! Vulkan resources that the compositor (renderer) uses.
        struct render_resources nr;
 
        //! The selected target factory that we create our target from.
        const struct comp_target_factory *target_factory;
 
        //! The target we are displaying to.
        struct comp_target *target;
 
        //! Renderer helper.
        struct comp_renderer *r;
 
        //! Duration of a frame at current refresh rate.
        int64_t frame_interval_ns;
 
        //! Timestamp of last-rendered (immersive) frame.
        int64_t last_frame_time_ns;
 
        // Extents of one view, in pixels.
        VkExtent2D view_extents;
 
        //! Are we mirroring any of the views to the debug gui? If so, turn off the fast path.
        bool mirroring_to_debug_gui;
 
        //! On screen window to display the content of the HMD.
        struct comp_window_peek *peek;
 
        /*!
         * @brief Data exclusive to the begin_frame/end_frame for computing an
         * estimate of the app's needs.
         */
        struct
        {
                int64_t last_begin;
                int64_t last_end;
        } app_profiling;
 
        struct u_frame_times_widget compositor_frame_times;
 
        struct
        {
                struct comp_frame waited;
                struct comp_frame rendering;
        } frame;
 
        struct
        {
                // Per-view scratch images.
                struct comp_scratch_single_images views[2];
        } scratch;
 
        struct
        {
                //! Temporarily disable ATW
                bool atw_off;
 
                //! Should the fast path be disabled.
                bool disable_fast_path;
 
                struct u_swapchain_debug sc;
        } debug;
 
        //! If true, part of the compositor startup will be delayed until a session is started
        bool deferred_surface;
};
 
 
/*
 *
 * Functions and helpers.
 *
 */
 
/*!
 * Convenience function to convert an xrt_compositor to a comp_compositor.
 *
 * @private @memberof comp_compositor
 */
static inline struct comp_compositor *
comp_compositor(struct xrt_compositor *xc)
{
        return (struct comp_compositor *)xc;
}
 
/*!
 * Helper define for printing Vulkan errors.
 *
 * @relates comp_compositor
 */
#define CVK_ERROR(C, FUNC, MSG, RET) COMP_ERROR(C, FUNC ": %s\n\t" MSG, vk_result_string(RET));
 
/*!
 * Spew level logging.
 *
 * @relates comp_compositor
 */
#define COMP_SPEW(c, ...) U_LOG_IFL_T(c->settings.log_level, __VA_ARGS__);
 
/*!
 * Debug level logging.
 *
 * @relates comp_compositor
 */
#define COMP_DEBUG(c, ...) U_LOG_IFL_D(c->settings.log_level, __VA_ARGS__);
 
/*!
 * Info level logging.
 *
 * @relates comp_compositor
 */
#define COMP_INFO(c, ...) U_LOG_IFL_I(c->settings.log_level, __VA_ARGS__);
 
/*!
 * Warn level logging.
 *
 * @relates comp_compositor
 */
#define COMP_WARN(c, ...) U_LOG_IFL_W(c->settings.log_level, __VA_ARGS__);
 
/*!
 * Error level logging.
 *
 * @relates comp_compositor
 */
#define COMP_ERROR(c, ...) U_LOG_IFL_E(c->settings.log_level, __VA_ARGS__);
 
/*!
 * Mode printing.
 *
 * @relates comp_compositor
 */
#define COMP_PRINT_MODE(c, ...)                                                                                        \
        if (c->settings.print_modes) {                                                                                 \
                U_LOG_I(__VA_ARGS__);                                                                                  \
        }
 
 
#ifdef __cplusplus
}
#endif