video.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2025
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    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 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#include "video.hpp"
 
#include "draw_manager.hpp"
#include "font/text.hpp"
#include "log.hpp"
#include "picture.hpp"
#include "preferences/preferences.hpp"
#include "sdl/point.hpp"
#include "sdl/texture.hpp"
#include "sdl/utils.hpp"
#include "sdl/window.hpp"
#include "utils/general.hpp"
 
#ifdef __APPLE__
#include <TargetConditionals.h>
#include "desktop/apple_video.hpp"
#if TARGET_OS_OSX
#include "game_version.hpp"
#endif
#endif
 
#include <SDL3/SDL.h>
#include <SDL3/SDL_render.h> // SDL_Texture
 
#include <cassert>
#include <vector>
 
#ifdef __ANDROID__
extern "C" {
    SDL_Surface* Android_AP_getFrameBuffer();
}
#endif
 
static lg::log_domain log_display("display");
#define LOG_DP LOG_STREAM(info, log_display)
#define ERR_DP LOG_STREAM(err, log_display)
#define WRN_DP LOG_STREAM(warn, log_display)
#define DBG_DP LOG_STREAM(debug, log_display)
 
namespace
{
/** The SDL window object. Will be null only if headless_. */
std::unique_ptr<sdl::window> window;
 
/** The main offscreen render target. */
texture render_texture_ = {};
 
/** The current offscreen render target. */
texture current_render_target_ = {};
 
bool headless_ = false; /**< running with no window at all */
bool testing_ = false; /**< running unit tests */
point test_resolution_ = {1024, 768}; /**< resolution for unit tests */
int refresh_rate_ = 0;
point game_canvas_size_ = {0, 0};
int pixel_scale_ = 1;
int max_scale_ = 1;
rect input_area_ = {};
 
} // anon namespace
 
namespace video
{
 
// Non-public interface
void render_screen(); // exposed and used only in draw_manager.cpp
 
// Internal functions
static void init_window(bool hidden=false);
static void init_test_window();
static void init_fake();
static void init_test();
static bool update_framebuffer();
static bool update_test_framebuffer();
static point draw_offset();
 
 
void init(fake type)
{
    LOG_DP << "initializing video";
    if(SDL_WasInit(SDL_INIT_VIDEO)) {
        throw error("video subsystem already initialized");
    }
    if(!SDL_InitSubSystem(SDL_INIT_VIDEO)) {
        ERR_DP << "Could not initialize SDL_video: " << SDL_GetError();
        throw error("Video initialization failed");
    }
 
    switch(type) {
    case fake::none:
        init_window();
        break;
    case fake::no_window:
        init_fake();
        break;
    case fake::no_draw:
        init_test();
        break;
    case fake::hide_window:
        init_window(true);
        break;
    default:
        throw error("unrecognized fake type passed to video::init");
    }
}
 
void deinit()
{
    LOG_DP << "deinitializing video";
 
    // Clear any static texture caches,
    // lest they try to delete textures after SDL_Quit.
    image::flush_cache();
    render_texture_.reset();
    current_render_target_.reset();
 
    // Destroy the window, and thus also the renderer.
    window.reset();
 
    // Close the video subsystem.
    if(SDL_WasInit(SDL_INIT_VIDEO)) {
        LOG_DP << "quitting SDL video subsystem";
        SDL_QuitSubSystem(SDL_INIT_VIDEO);
    }
    if(SDL_WasInit(SDL_INIT_VIDEO)) {
        // This should not have been initialized multiple times
        throw error("video subsystem still initialized after deinit");
    }
}
 
bool headless()
{
    return headless_;
}
 
bool testing()
{
    return testing_;
}
 
void init_fake()
{
    LOG_DP << "running headless";
    headless_ = true;
    refresh_rate_ = 1;
    game_canvas_size_ = {800,600};
}
 
void init_test()
{
    testing_ = true;
    refresh_rate_ = 1;
    init_test_window();
}
 
/** Returns true if the buffer was changed */
bool update_test_framebuffer()
{
    if (!window) {
        throw("trying to update test framebuffer with no window");
    }
 
    bool changed = false;
 
    // TODO: code unduplication
    // Build or update the current render texture.
    if (render_texture_) {
        SDL_PropertiesID props = SDL_GetTextureProperties(render_texture_.get());
        int w = SDL_GetNumberProperty(props, SDL_PROP_TEXTURE_WIDTH_NUMBER, 0);
        int h = SDL_GetNumberProperty(props, SDL_PROP_TEXTURE_HEIGHT_NUMBER, 0);
        if (w != test_resolution_.x || h != test_resolution_.y) {
            // Delete it and let it be recreated.
            LOG_DP << "destroying old render texture";
            render_texture_.reset();
        }
    }
    if (!render_texture_) {
        LOG_DP << "creating offscreen render texture";
        render_texture_.assign(SDL_CreateTexture(
            *window,
            SDL_PIXELFORMAT_ARGB8888,
            SDL_TEXTUREACCESS_TARGET,
            test_resolution_.x, test_resolution_.y
        ));
        LOG_DP << "updated render target to " << test_resolution_.x
            << "x" << test_resolution_.y;
        changed = true;
    }
 
    pixel_scale_ = 1;
    game_canvas_size_ = test_resolution_;
    input_area_ = {{}, test_resolution_};
 
    // The render texture is always the render target in this case.
    force_render_target(render_texture_);
 
    return changed;
}
 
bool update_framebuffer()
{
    if (!window) {
        throw error("trying to update framebuffer with no window");
    }
 
    if (testing_) {
        return update_test_framebuffer();
    }
 
    bool changed = false;
 
    // Make sure we're getting values from the native window.
    SDL_SetRenderTarget(*window, nullptr);
 
    // Find max valid pixel scale at current output size.
    point osize(window->get_output_size());
    max_scale_ = std::min(
        osize.x / pref_constants::min_window_width,
        osize.y / pref_constants::min_window_height);
    max_scale_ = std::min(max_scale_, pref_constants::max_pixel_scale);
 
    // Determine best pixel scale according to preference and window size
    int scale = 1;
    if (prefs::get().auto_pixel_scale()) {
        // Try to match the default size (1280x720) but do not reduce below
        int def_scale = std::min(
            osize.x / pref_constants::def_window_width,
            osize.y / pref_constants::def_window_height);
        scale = std::min(max_scale_, def_scale);
        // Otherwise reduce to keep below the max window size (1920x1080).
        int min_scale = std::min(
            osize.x / (pref_constants::max_window_width+1) + 1,
            osize.y / (pref_constants::max_window_height+1) + 1);
        scale = std::max(scale, min_scale);
    } else {
        scale = std::min(max_scale_, prefs::get().pixel_scale());
    }
    // Cache it for easy access.
    if (pixel_scale_ != scale) {
        pixel_scale_ = scale;
        changed = true;
    }
 
    // Update logical size if it doesn't match the current resolution and scale.
    point lsize(window->get_logical_size());
    point wsize(window->get_size());
    if (lsize.x != osize.x / scale || lsize.y != osize.y / scale) {
        if (!prefs::get().auto_pixel_scale() && scale < prefs::get().pixel_scale()) {
            LOG_DP << "reducing pixel scale from desired "
                << prefs::get().pixel_scale() << " to maximum allowable "
                << scale;
        }
        LOG_DP << "pixel scale: " << scale;
        LOG_DP << "overriding logical size";
        LOG_DP << "  old lsize: " << lsize;
        LOG_DP << "  old wsize: " << wsize;
        LOG_DP << "  old osize: " << osize;
        window->set_logical_size(osize.x / scale, osize.y / scale);
        lsize = window->get_logical_size();
        wsize = window->get_size();
        osize = window->get_output_size();
        LOG_DP << "  new lsize: " << lsize;
        LOG_DP << "  new wsize: " << wsize;
        LOG_DP << "  new osize: " << osize;
        float sx, sy;
        SDL_GetRenderScale(*window, &sx, &sy);
        LOG_DP << "  render scale: " << sx << ", " << sy;
    }
    // Cache it for easy access
    game_canvas_size_ = lsize;
 
    // Build or update the current render texture.
    if (render_texture_) {
        SDL_PropertiesID props = SDL_GetTextureProperties(render_texture_.get());
        int w = SDL_GetNumberProperty(props, SDL_PROP_TEXTURE_WIDTH_NUMBER, 0);
        int h = SDL_GetNumberProperty(props, SDL_PROP_TEXTURE_HEIGHT_NUMBER, 0);
        if (w != osize.x || h != osize.y) {
            // Delete it and let it be recreated.
            LOG_DP << "destroying old render texture";
            render_texture_.reset();
        } else {
            // This isn't currently used, but ensure it's accurate anyway.
            render_texture_.set_draw_size(lsize);
        }
    }
    if (!render_texture_) {
        LOG_DP << "creating offscreen render texture";
        render_texture_.assign(SDL_CreateTexture(
            *window,
            SDL_PIXELFORMAT_ARGB8888,
            SDL_TEXTUREACCESS_TARGET,
            osize.x, osize.y
        ));
        // This isn't really necessary, but might be nice to have attached
        render_texture_.set_draw_size(lsize);
        changed = true;
    }
 
    // Assign the render texture now. It will be used for all drawing.
    force_render_target(render_texture_);
 
    // By default input area is the same as the window area.
    input_area_ = {{}, wsize};
 
    rect active_area = to_output(draw_area());
    if (active_area.size() != osize) {
        LOG_DP << "render target offset: LT " << active_area.origin() << " RB "
               << osize - active_area.size() - active_area.origin();
        // Translate active_area into display coordinates as input_area_
        input_area_ = {
            (active_area.origin() * wsize) / osize,
            (active_area.size() * wsize) / osize
        };
        LOG_DP << "input area: " << input_area_;
    }
 
    return changed;
}
 
void init_test_window()
{
    LOG_DP << "creating test window " << test_resolution_.x
        << "x" << test_resolution_.y;
 
    uint32_t window_flags = 0;
    window_flags |= SDL_WINDOW_HIDDEN;
    // The actual window won't be used, as we'll be rendering to texture.
 
    window.reset(new sdl::window(
        "", test_resolution_.x, test_resolution_.y,
        window_flags
    ));
 
    update_test_framebuffer();
}
 
void init_window(bool hidden)
{
#ifdef __ANDROID__
    prefs::get().set_fullscreen(true);
#endif
#if defined(__APPLE__) && TARGET_OS_IPHONE
    desktop::apple::install_keyboard_dismiss_toolbar();
#endif
    // Dimensions
    const point res = prefs::get().resolution();
    const int w = res.x;
    const int h = res.y;
 
    uint32_t window_flags = 0;
 
    // Add any more default flags here
    window_flags |= SDL_WINDOW_RESIZABLE;
    window_flags |= SDL_WINDOW_HIGH_PIXEL_DENSITY;
 
    if(prefs::get().fullscreen()) {
        window_flags |= SDL_WINDOW_FULLSCREEN;
    }
 
    if(prefs::get().maximized()) {
        window_flags |= SDL_WINDOW_MAXIMIZED;
    }
 
    if(hidden) {
        LOG_DP << "hiding main window";
        window_flags |= SDL_WINDOW_HIDDEN;
    }
 
    // Initialize window
    window.reset(new sdl::window("", w, h, window_flags));
 
    // It is assumed that this function is only ever called once.
    // If that is no longer true, then you should clean things up.
    assert(!render_texture_);
 
    PLAIN_LOG << "Setting mode to " << w << "x" << h;
 
    window->set_minimum_size(pref_constants::min_window_width, pref_constants::min_window_height);
 
    const SDL_DisplayMode* currentDisplayMode = SDL_GetCurrentDisplayMode(window->get_display_index());
    refresh_rate_ = currentDisplayMode->refresh_rate != 0 ? currentDisplayMode->refresh_rate : 60;
 
#ifdef __ANDROID__
    window->set_size(w, h);
#endif
 
    update_framebuffer();
}
 
bool has_window()
{
    return bool(window);
}
 
point output_size()
{
    if (testing_) {
        return test_resolution_;
    }
    // As we are rendering via an abstraction, we should never need this.
    return window->get_output_size();
}
 
point window_size()
{
    if (testing_) {
        return test_resolution_;
    }
    return window->get_size();
}
 
rect game_canvas()
{
    return {point{}, game_canvas_size_};
}
 
point game_canvas_size()
{
    return game_canvas_size_;
}
 
point draw_size()
{
    return current_render_target_.draw_size();
}
 
rect draw_area()
{
    return {point{}, draw_size()};
}
 
point draw_offset()
{
    // As we are using SDL_RenderSetIntegerScale, there may be a slight
    // offset of the drawable area on the render target if the target size
    // is not perfectly divisble by the scale.
    // SDL doesn't provide any way of retrieving this offset,
    // so we just have to base our calculation on the known behaviour.
    point osize = output_size();
    point dsize = draw_size();
    point scale = osize / dsize;
    return (osize - (scale * dsize)) / 2;
}
 
rect output_area()
{
    return {point{}, output_size()};
}
 
rect to_output(const rect& r)
{
    // Multiply r by integer scale, adding draw_offset to the position.
    point dsize = current_render_target_.draw_size();
    point osize = current_render_target_.get_raw_size();
    point pos = (r.origin() * (osize / dsize)) + draw_offset();
    point size = r.size() * (osize / dsize);
    return {pos, size};
}
 
rect input_area()
{
    return input_area_;
}
 
int get_pixel_scale()
{
    return pixel_scale_;
}
 
int get_max_pixel_scale()
{
    return max_scale_;
}
 
int native_refresh_rate()
{
    return refresh_rate_;
}
 
int current_refresh_rate()
{
    // TODO: this should be more clever, depending on usage
    if(auto preferred = prefs::get().refresh_rate(); preferred > 0) {
        return std::min(preferred, refresh_rate_);
    } else {
        return refresh_rate_;
    }
}
 
float content_scaling()
{
    SDL_DisplayID id = SDL_GetDisplayForWindow(*window);
    if(id != 0) {
        return SDL_GetDisplayContentScale(id);
    }
    return 0.0f;
}
float pixel_density()
{
    return SDL_GetWindowPixelDensity(*window);
}
float display_scaling()
{
    return SDL_GetWindowDisplayScale(*window);
}
 
void force_render_target(const texture& t)
{
    if (!SDL_SetRenderTarget(get_renderer(), t)) {
        ERR_DP << "failed to set render target to "
            << static_cast<void*>(t.get()) << ' '
            << t.draw_size() << " / " << t.get_raw_size();
        ERR_DP << "last SDL error: " << SDL_GetError();
        throw error("failed to set render target");
    }
    current_render_target_ = t;
 
    if (testing_) {
        return;
    }
 
    // The scale factor gets reset when the render target changes,
    // so make sure it gets set back appropriately.
    if (!t) {
        DBG_DP << "rendering to window / screen";
        window->set_logical_size(game_canvas_size_);
    } else if (t == render_texture_) {
        DBG_DP << "rendering to primary buffer";
        window->set_logical_size(game_canvas_size_);
    } else {
        DBG_DP << "rendering to custom target "
            << static_cast<void*>(t.get()) << ' '
            << t.draw_size() << " / " << t.get_raw_size();
        window->set_logical_size(t.w(), t.h());
    }
}
 
void clear_render_target()
{
    force_render_target({});
}
 
void reset_render_target()
{
    force_render_target(render_texture_);
}
 
texture get_render_target()
{
#ifndef __ANDROID__
    // This should always be up-to-date, but assert for sanity.
    assert(current_render_target_ == SDL_GetRenderTarget(get_renderer()));
#endif
    return current_render_target_;
}
 
// Note: this is not thread-safe.
// Drawing functions should not be called while this is active.
// SDL renderer usage is not thread-safe anyway, so this is fine.
void render_screen()
{
    if(headless_ || testing_) {
        // No need to present anything in this case
        return;
    }
 
    if(!window) {
        WRN_DP << "trying to render with no window";
        return;
    }
 
    // This should only ever be called when the main render texture is the
    // current render target. It could be adapted otherwise... but let's not.
    if(SDL_GetRenderTarget(*window) != render_texture_) {
        ERR_DP << "trying to render screen, but current render texture is "
            << static_cast<void*>(SDL_GetRenderTarget(*window))
            << " | " << static_cast<void*>(current_render_target_.get())
            << ". It should be " << static_cast<void*>(render_texture_.get());
        throw error("tried to render screen from wrong render target");
    }
 
    // Clear the render target so we're drawing to the window.
    clear_render_target();
 
    // Use fully transparent black to clear the window backbuffer
    SDL_SetRenderDrawColor(*window, 0u, 0u, 0u, 0u);
 
    // Clear the window backbuffer before rendering the render texture.
    SDL_RenderClear(*window);
 
    // Copy the render texture to the window.
    SDL_RenderTexture(*window, render_texture_, nullptr, nullptr);
 
    // Finalize and display the frame.
    SDL_RenderPresent(*window);
 
    // Reset the render target to the render texture.
    reset_render_target();
}
 
surface read_pixels(rect* r)
{
    if (!window) {
        WRN_DP << "trying to read pixels with no window";
        return surface();
    }
 
    // This should be what we want to read from.
    texture& target = current_render_target_;
 
    // Make doubly sure.
    if (target != SDL_GetRenderTarget(*window)) {
        SDL_Texture* t = SDL_GetRenderTarget(*window);
        ERR_DP << "render target " << static_cast<void*>(target.get())
            << ' ' << target.draw_size() << " / " << target.get_raw_size()
            << " doesn't match window render target "
            << static_cast<void*>(t);
        throw error("unexpected render target while reading pixels");
    }
 
    // Intersect the draw area with the given rect.
    rect r_clipped = draw_area();
    if (r) {
        r_clipped.clip(*r);
        if (r_clipped != *r) {
            DBG_DP << "modifying pixel read area from " << *r
                   << " to " << r_clipped;
            *r = r_clipped;
        }
    }
 
    // Convert the rect to output coordinates, if necessary.
    rect o = to_output(r_clipped);
 
    // Create surface and read pixels
    surface s = SDL_RenderReadPixels(*window, &o);
    return s;
}
 
surface read_pixels_low_res(rect* r)
{
    if(!window) {
        WRN_DP << "trying to read pixels with no window";
        return surface();
    }
    surface s = read_pixels(r);
    if(r) {
        return scale_surface(s, r->w, r->h);
    } else {
        return scale_surface(s, draw_size().x, draw_size().y);
    }
}
 
void set_window_title(const std::string& title)
{
    assert(window);
    window->set_title(title);
}
 
void set_window_icon(surface& icon)
{
    assert(window);
    window->set_icon(icon);
}
 
SDL_Renderer* get_renderer()
{
    if(window) {
        return *window;
    } else {
        return nullptr;
    }
}
 
SDL_Window* get_window()
{
    if(window) {
        return *window;
    } else {
        return nullptr;
    }
}
 
std::string current_driver()
{
    const char* const drvname = SDL_GetCurrentVideoDriver();
    return drvname ? drvname : "<not initialized>";
}
 
std::vector<std::string> enumerate_drivers()
{
    std::vector<std::string> res;
    int num_drivers = SDL_GetNumVideoDrivers();
 
    for(int n = 0; n < num_drivers; ++n) {
        const char* drvname = SDL_GetVideoDriver(n);
        res.emplace_back(drvname ? drvname : "<invalid driver>");
    }
 
    return res;
}
 
/**
 * Tests whether the given flags are currently set on the SDL window.
 *
 * @param flags               The flags to test, OR'd together.
 */
static bool window_has_flags(uint32_t flags)
{
    return window && (window->get_flags() & flags) != 0;
}
 
bool window_is_visible()
{
    return !window_has_flags(SDL_WINDOW_HIDDEN);
}
 
bool window_has_focus()
{
    return window_has_flags(SDL_WINDOW_MOUSE_FOCUS | SDL_WINDOW_INPUT_FOCUS);
}
 
bool window_has_mouse_focus()
{
    return window_has_flags(SDL_WINDOW_MOUSE_FOCUS);
}
 
std::vector<point> get_available_resolutions(const bool include_current)
{
    std::vector<point> result;
 
#ifdef __ANDROID__
    result.push_back(prefs::get().resolution());
    return result;
#endif
 
    if(!window) {
        return result;
    }
 
    const int display_index = window->get_display_index();
 
    int mode_count = 0;
    SDL_DisplayMode** modes = SDL_GetFullscreenDisplayModes(display_index, &mode_count);
    if(mode_count <= 0 || !modes) {
        PLAIN_LOG << "No modes supported";
        return result;
    }
 
    const point min_res(pref_constants::min_window_width, pref_constants::min_window_height);
 
    // The maximum size to which this window can be set. For some reason this won't
    // pop up as a display mode of its own.
    rect bounds;
    SDL_GetDisplayBounds(display_index, &bounds);
 
    for(SDL_DisplayMode* mode : utils::span(modes, mode_count)) {
        assert(mode);
        point size{mode->w, mode->h};
 
        if(min_res <= size && size <= bounds.size()) {
            result.push_back(size);
        }
    }
 
    SDL_free(modes);
 
    if(!utils::contains(result, min_res)) {
        result.push_back(min_res);
    }
 
    if(include_current) {
        result.push_back(current_resolution());
    }
 
    std::sort(result.begin(), result.end());
    result.erase(std::unique(result.begin(), result.end()), result.end());
 
    return result;
}
 
point current_resolution()
{
    if (testing_) {
        return test_resolution_;
    }
    return window->get_size();
}
 
void set_fullscreen(bool fullscreen)
{
    if (headless_ || testing_) {
        return;
    }
 
    if (fullscreen) {
        window->full_screen();
    } else if (prefs::get().maximized()) {
        window->to_window();
        window->maximize();
    } else {
        window->to_window();
        window->restore();
    }
 
    // Update the config value in any case.
    prefs::get().set_fullscreen(fullscreen);
}
 
void toggle_fullscreen()
{
    set_fullscreen(!prefs::get().fullscreen());
}
 
bool set_resolution(const point& resolution)
{
    if(resolution == current_resolution()) {
        return false;
    }
 
    if(!window) {
        throw error("tried to set resolution with no window");
    }
 
    if(testing_) {
        LOG_DP << "resizing test resolution to " << resolution;
        test_resolution_ = resolution;
        return update_test_framebuffer();
    }
 
    window->restore();
    window->set_size(resolution.x, resolution.y);
    window->center();
 
    update_buffers();
 
    // Change the saved values in preferences.
    LOG_DP << "updating resolution to " << resolution;
    prefs::get().set_resolution(resolution);
    prefs::get().set_maximized(false);
 
    return true;
}
 
void update_buffers(bool autoupdate)
{
    if(headless_) {
        return;
    }
 
    LOG_DP << "updating video buffers";
    if(update_framebuffer() && autoupdate) {
        draw_manager::invalidate_all();
    }
}
 
std::vector<std::string> get_available_renderers()
{
    std::vector<std::string> renderers;
 
    int renderer_count = SDL_GetNumRenderDrivers();
    for(int i = 0; i < renderer_count; i++) {
        renderers.emplace_back(SDL_GetRenderDriver(i));
    }
 
    return renderers;
}
 
std::vector<std::pair<std::string, std::string>> renderer_report()
{
    std::vector<std::pair<std::string, std::string>> res;
    SDL_Renderer* rnd = get_renderer();
 
    if(rnd) {
        std::string renderer_name = SDL_GetRendererName(rnd) ? SDL_GetRendererName(rnd) : "<unknown>";
        SDL_PropertiesID props = SDL_GetRendererProperties(rnd);
 
        res.emplace_back("Renderer", renderer_name);
        res.emplace_back("VSync", SDL_GetNumberProperty(props, SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER, 0) != 0 ? "on" : "off");
    }
 
    return res;
}
 
} // namespace video