pcsx2/common/GL/ContextEGL.cpp

/*  PCSX2 - PS2 Emulator for PCs
 *  Copyright (C) 2002-2021  PCSX2 Dev Team
 *
 *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
 *  of the GNU Lesser General Public License as published by the Free Software Found-
 *  ation, either version 3 of the License, or (at your option) any later version.
 *
 *  PCSX2 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 PCSX2.
 *  If not, see <http://www.gnu.org/licenses/>.
 */

#include "common/PrecompiledHeader.h"

#include "common/Console.h"
#include "ContextEGL.h"
#include <algorithm>
#include <cstring>
#include <optional>
#include <vector>

namespace GL
{
	ContextEGL::ContextEGL(const WindowInfo& wi)
		: Context(wi)
	{
	}

	ContextEGL::~ContextEGL()
	{
		DestroySurface();
		DestroyContext();
	}

	std::unique_ptr<Context> ContextEGL::Create(const WindowInfo& wi, gsl::span<const Version> versions_to_try)
	{
		std::unique_ptr<ContextEGL> context = std::make_unique<ContextEGL>(wi);
		if (!context->Initialize(versions_to_try))
			return nullptr;

		return context;
	}

	bool ContextEGL::Initialize(gsl::span<const Version> versions_to_try)
	{
		if (!gladLoadEGL())
		{
			Console.Error("Loading GLAD EGL functions failed");
			return false;
		}

		if (!SetDisplay())
			return false;

		int egl_major, egl_minor;
		if (!eglInitialize(m_display, &egl_major, &egl_minor))
		{
			Console.Error("eglInitialize() failed: %d", eglGetError());
			return false;
		}
		Console.WriteLn("EGL Version: %d.%d", egl_major, egl_minor);

		const char* extensions = eglQueryString(m_display, EGL_EXTENSIONS);
		if (extensions)
		{
			Console.WriteLn("EGL Extensions: %s", extensions);
			m_supports_surfaceless = std::strstr(extensions, "EGL_KHR_surfaceless_context") != nullptr;
		}
		if (!m_supports_surfaceless)
			Console.Warning("EGL implementation does not support surfaceless contexts, emulating with pbuffers");

		for (const Version& version : versions_to_try)
		{
			if (CreateContextAndSurface(version, nullptr, true))
				return true;
		}

		return false;
	}

	bool ContextEGL::SetDisplay()
	{
		m_display = eglGetDisplay(static_cast<EGLNativeDisplayType>(m_wi.display_connection));
		if (!m_display)
		{
			Console.Error("eglGetDisplay() failed: %d", eglGetError());
			return false;
		}

		return true;
	}

	void* ContextEGL::GetProcAddress(const char* name)
	{
		return reinterpret_cast<void*>(eglGetProcAddress(name));
	}

	bool ContextEGL::ChangeSurface(const WindowInfo& new_wi)
	{
		const bool was_current = (eglGetCurrentContext() == m_context);
		if (was_current)
			eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);

		if (m_surface != EGL_NO_SURFACE)
		{
			eglDestroySurface(m_display, m_surface);
			m_surface = EGL_NO_SURFACE;
		}

		m_wi = new_wi;
		if (!CreateSurface())
			return false;

		if (was_current && !eglMakeCurrent(m_display, m_surface, m_surface, m_context))
		{
			Console.Error("Failed to make context current again after surface change");
			return false;
		}

		return true;
	}

	void ContextEGL::ResizeSurface(u32 new_surface_width /*= 0*/, u32 new_surface_height /*= 0*/)
	{
		if (new_surface_width == 0 && new_surface_height == 0)
		{
			EGLint surface_width, surface_height;
			if (eglQuerySurface(m_display, m_surface, EGL_WIDTH, &surface_width) &&
				eglQuerySurface(m_display, m_surface, EGL_HEIGHT, &surface_height))
			{
				m_wi.surface_width = static_cast<u32>(surface_width);
				m_wi.surface_height = static_cast<u32>(surface_height);
				return;
			}
			else
			{
				Console.Error("eglQuerySurface() failed: %d", eglGetError());
			}
		}

		m_wi.surface_width = new_surface_width;
		m_wi.surface_height = new_surface_height;
	}

	bool ContextEGL::SwapBuffers()
	{
		return eglSwapBuffers(m_display, m_surface);
	}

	bool ContextEGL::MakeCurrent()
	{
		if (!eglMakeCurrent(m_display, m_surface, m_surface, m_context))
		{
			Console.Error("eglMakeCurrent() failed: %d", eglGetError());
			return false;
		}

		return true;
	}

	bool ContextEGL::DoneCurrent()
	{
		return eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
	}

	bool ContextEGL::SetSwapInterval(s32 interval)
	{
		return eglSwapInterval(m_display, interval);
	}

	std::unique_ptr<Context> ContextEGL::CreateSharedContext(const WindowInfo& wi)
	{
		std::unique_ptr<ContextEGL> context = std::make_unique<ContextEGL>(wi);
		context->m_display = m_display;
		context->m_supports_surfaceless = m_supports_surfaceless;

		if (!context->CreateContextAndSurface(m_version, m_context, false))
			return nullptr;

		return context;
	}

	EGLNativeWindowType ContextEGL::GetNativeWindow(EGLConfig config)
	{
		return {};
	}

	bool ContextEGL::CreateSurface()
	{
		if (m_wi.type == WindowInfo::Type::Surfaceless)
		{
			if (m_supports_surfaceless)
				return true;
			else
				return CreatePBufferSurface();
		}

		EGLNativeWindowType native_window = GetNativeWindow(m_config);
		m_surface = eglCreateWindowSurface(m_display, m_config, native_window, nullptr);
		if (!m_surface)
		{
			Console.Error("eglCreateWindowSurface() failed: %d", eglGetError());
			return false;
		}

		// Some implementations may require the size to be queried at runtime.
		EGLint surface_width, surface_height;
		if (eglQuerySurface(m_display, m_surface, EGL_WIDTH, &surface_width) &&
			eglQuerySurface(m_display, m_surface, EGL_HEIGHT, &surface_height))
		{
			m_wi.surface_width = static_cast<u32>(surface_width);
			m_wi.surface_height = static_cast<u32>(surface_height);
		}
		else
		{
			Console.Error("eglQuerySurface() failed: %d", eglGetError());
		}

		return true;
	}

	bool ContextEGL::CreatePBufferSurface()
	{
		const u32 width = std::max<u32>(m_wi.surface_width, 1);
		const u32 height = std::max<u32>(m_wi.surface_height, 1);

		EGLint attrib_list[] = {
			EGL_WIDTH, static_cast<EGLint>(width),
			EGL_HEIGHT, static_cast<EGLint>(height),
			EGL_NONE,
		};

		m_surface = eglCreatePbufferSurface(m_display, m_config, attrib_list);
		if (!m_surface)
		{
			Console.Error("eglCreatePbufferSurface() failed: %d", eglGetError());
			return false;
		}

		Console.WriteLn("Created %ux%u pbuffer surface", width, height);
		return true;
	}

	bool ContextEGL::CheckConfigSurfaceFormat(EGLConfig config) const
	{
		int red_size, green_size, blue_size;
		if (!eglGetConfigAttrib(m_display, config, EGL_RED_SIZE, &red_size) ||
			!eglGetConfigAttrib(m_display, config, EGL_GREEN_SIZE, &green_size) ||
			!eglGetConfigAttrib(m_display, config, EGL_BLUE_SIZE, &blue_size))
		{
			return false;
		}

		return (red_size == 8 && green_size == 8 && blue_size == 8);
	}

	void ContextEGL::DestroyContext()
	{
		if (eglGetCurrentContext() == m_context)
			eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);

		if (m_context != EGL_NO_CONTEXT)
		{
			eglDestroyContext(m_display, m_context);
			m_context = EGL_NO_CONTEXT;
		}
	}

	void ContextEGL::DestroySurface()
	{
		if (eglGetCurrentSurface(EGL_DRAW) == m_surface)
			eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);

		if (m_surface != EGL_NO_SURFACE)
		{
			eglDestroySurface(m_display, m_surface);
			m_surface = EGL_NO_SURFACE;
		}
	}

	bool ContextEGL::CreateContext(const Version& version, EGLContext share_context)
	{
		Console.WriteLn(
			"Trying version %u.%u (%s)", version.major_version, version.minor_version,
			version.profile == Context::Profile::ES ? "ES" : (version.profile == Context::Profile::Core ? "Core" : "None"));

		const int renderable_type = version.profile == Profile::ES
			? ((version.major_version >= 3) ? EGL_OPENGL_ES3_BIT : ((version.major_version == 2) ? EGL_OPENGL_ES2_BIT : EGL_OPENGL_ES_BIT))
			: EGL_OPENGL_BIT;
		const int surface_attribs[] = {
			EGL_RENDERABLE_TYPE, renderable_type,
			EGL_SURFACE_TYPE, (m_wi.type != WindowInfo::Type::Surfaceless) ? EGL_WINDOW_BIT : 0,
			EGL_RED_SIZE, 8,
			EGL_GREEN_SIZE, 8,
			EGL_BLUE_SIZE, 8,
			EGL_NONE
		};

		EGLint num_configs;
		if (!eglChooseConfig(m_display, surface_attribs, nullptr, 0, &num_configs) || num_configs == 0)
		{
			Console.Error("eglChooseConfig() failed: %d", eglGetError());
			return false;
		}

		std::vector<EGLConfig> configs(static_cast<u32>(num_configs));
		if (!eglChooseConfig(m_display, surface_attribs, configs.data(), num_configs, &num_configs))
		{
			Console.Error("eglChooseConfig() failed: %d", eglGetError());
			return false;
		}
		configs.resize(static_cast<u32>(num_configs));

		m_config = [this, &configs]() {
			const auto found_config = std::find_if(std::begin(configs), std::end(configs), [&](const auto& check_config) {
				 return CheckConfigSurfaceFormat(check_config);
			});
			if (found_config == std::end(configs))
			{
				Console.Warning("No EGL configs matched exactly, using first.");
				return configs.front();
			}
			else
			{
				return *found_config;
			}
		}();

		const auto attribs = [version]() -> std::array<int, 8> {
			if (version.profile != Profile::NoProfile)
				return {
					EGL_CONTEXT_MAJOR_VERSION, version.major_version,
					EGL_CONTEXT_MINOR_VERSION, version.minor_version,
					EGL_NONE
				};
			return {EGL_NONE};
		}();

		if (!eglBindAPI((version.profile == Profile::ES) ? EGL_OPENGL_ES_API : EGL_OPENGL_API))
		{
			Console.Error("eglBindAPI(%s) failed", (version.profile == Profile::ES) ? "EGL_OPENGL_ES_API" : "EGL_OPENGL_API");
			return false;
		}

		m_context = eglCreateContext(m_display, m_config, share_context, attribs.data());
		if (!m_context)
		{
			Console.Error("eglCreateContext() failed: %d", eglGetError());
			return false;
		}

		Console.WriteLn(
			"Got version %u.%u (%s)", version.major_version, version.minor_version,
			version.profile == Context::Profile::ES ? "ES" : (version.profile == Context::Profile::Core ? "Core" : "None"));

		m_version = version;
		return true;
	}

	bool ContextEGL::CreateContextAndSurface(const Version& version, EGLContext share_context, bool make_current)
	{
		if (!CreateContext(version, share_context))
			return false;

		if (!CreateSurface())
		{
			Console.Error("Failed to create surface for context");
			eglDestroyContext(m_display, m_context);
			m_context = EGL_NO_CONTEXT;
			return false;
		}

		if (make_current && !eglMakeCurrent(m_display, m_surface, m_surface, m_context))
		{
			Console.Error("eglMakeCurrent() failed: %d", eglGetError());
			if (m_surface != EGL_NO_SURFACE)
			{
				eglDestroySurface(m_display, m_surface);
				m_surface = EGL_NO_SURFACE;
			}
			eglDestroyContext(m_display, m_context);
			m_context = EGL_NO_CONTEXT;
			return false;
		}

		return true;
	}
} // namespace GL