Merge pull request #19184 from hrydgard/native-text-draw-mac-ios

Native text drawing on macOS/iOS

Author: hrydgard

CMakeLists.txt

@@ -1271,6 +1271,12 @@ if(OPENXR AND NOT ARMV7_DEVICE)
 	set(nativeExtraLibs ${nativeExtraLibs} openxr_loader)
 endif()
 
+if(IOS OR MACOSX)
+	set(nativeExtra ${nativeExtra}
+		Common/Render/Text/draw_text_cocoa.mm
+		Common/Render/Text/draw_text_cocoa.h)
+endif()
+
 if(ANDROID)
 	set(NativeAppSource ${NativeAppSource}
 		android/jni/app-android.cpp
@@ -1317,7 +1323,7 @@ elseif(IOS AND NOT LIBRETRO)
 		Common/Battery/AppleBatteryClient.m
 	)
 
-	set(nativeExtraLibs ${nativeExtraLibs} "-framework Foundation -framework MediaPlayer -framework AudioToolbox -framework CoreGraphics -framework QuartzCore -framework UIKit -framework GLKit -framework OpenAL -framework AVFoundation -framework CoreLocation -framework CoreVideo -framework CoreMedia -framework CoreServices -framework Metal -framework IOSurface" )
+	set(nativeExtraLibs ${nativeExtraLibs} "-framework Foundation -framework MediaPlayer -framework AudioToolbox -framework CoreGraphics -framework QuartzCore -framework UIKit -framework GLKit -framework OpenAL -framework AVFoundation -framework CoreLocation -framework CoreText -framework CoreVideo -framework CoreMedia -framework CoreServices -framework Metal -framework IOSurface" )
 	if(EXISTS "${CMAKE_IOS_SDK_ROOT}/System/Library/Frameworks/GameController.framework")
 		set(nativeExtraLibs ${nativeExtraLibs} "-weak_framework GameController")
 	endif()

Common/Math/geom2d.h

@@ -2,19 +2,19 @@
 
 #include <cmath>
 
-struct Point {
-	Point() : x(0.0f), y(0.0f) {}
-	Point(float x_, float y_) : x(x_), y(y_) {}
+struct Point2D {
+	Point2D() : x(0.0f), y(0.0f) {}
+	Point2D(float x_, float y_) : x(x_), y(y_) {}
 
 	float x;
 	float y;
 
-	float distanceTo(const Point &other) const {
+	float distanceTo(const Point2D &other) const {
 		float dx = other.x - x, dy = other.y - y;
 		return sqrtf(dx*dx + dy*dy);
 	}
 
-	bool operator ==(const Point &other) const {
+	bool operator ==(const Point2D &other) const {
 		return x == other.x && y == other.y;
 	}
 
@@ -60,8 +60,8 @@ struct Bounds {
 	float y2() const { return y + h; }
 	float centerX() const { return x + w * 0.5f; }
 	float centerY() const { return y + h * 0.5f; }
-	Point Center() const {
-		return Point(centerX(), centerY());
+	Point2D Center() const {
+		return Point2D(centerX(), centerY());
 	}
 	Bounds Expand(float amount) const {
 		return Bounds(x - amount, y - amount, w + amount * 2, h + amount * 2);

Common/Render/Text/draw_text.cpp

@@ -8,6 +8,7 @@
 
 #include "Common/Render/Text/draw_text.h"
 #include "Common/Render/Text/draw_text_win.h"
+#include "Common/Render/Text/draw_text_cocoa.h"
 #include "Common/Render/Text/draw_text_uwp.h"
 #include "Common/Render/Text/draw_text_qt.h"
 #include "Common/Render/Text/draw_text_android.h"
@@ -70,15 +71,15 @@ void TextDrawer::DrawStringRect(DrawBuffer &target, std::string_view str, const
 	DrawString(target, toDraw.c_str(), x, y, color, align);
 }
 
-void TextDrawer::DrawStringBitmapRect(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, const Bounds &bounds, int align) {
+bool TextDrawer::DrawStringBitmapRect(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, const Bounds &bounds, int align) {
 	std::string toDraw(str);
 	int wrap = align & (FLAG_WRAP_TEXT | FLAG_ELLIPSIZE_TEXT);
 	if (wrap) {
 		bool rotated = (align & (ROTATE_90DEG_LEFT | ROTATE_90DEG_RIGHT)) != 0;
 		WrapString(toDraw, str, rotated ? bounds.h : bounds.w, wrap);
 	}
 
-	DrawStringBitmap(bitmapData, entry, texFormat, toDraw.c_str(), align);
+	return DrawStringBitmap(bitmapData, entry, texFormat, toDraw.c_str(), align);
 }
 
 TextDrawer *TextDrawer::Create(Draw::DrawContext *draw) {
@@ -89,6 +90,8 @@ TextDrawer *TextDrawer::Create(Draw::DrawContext *draw) {
 	drawer = new TextDrawerWin32(draw);
 #elif PPSSPP_PLATFORM(UWP)
 	drawer = new TextDrawerUWP(draw);
+#elif PPSSPP_PLATFORM(MAC) || PPSSPP_PLATFORM(IOS)
+	drawer = new TextDrawerCocoa(draw);
 #elif defined(USING_QT_UI)
 	drawer = new TextDrawerQt(draw);
 #elif PPSSPP_PLATFORM(ANDROID)

Common/Render/Text/draw_text.h

@@ -12,6 +12,7 @@
 
 #include <memory>
 #include <cstdint>
+#include <map>
 
 #include "Common/Data/Text/WrapText.h"
 #include "Common/Render/DrawBuffer.h"
@@ -33,6 +34,7 @@ struct TextStringEntry {
 struct TextMeasureEntry {
 	int width;
 	int height;
+	int leading;  // only used with Cocoa
 	int lastUsedFrame;
 };
 
@@ -46,10 +48,14 @@ class TextDrawer {
 	void SetFontScale(float xscale, float yscale);
 	virtual void MeasureString(std::string_view str, float *w, float *h) = 0;
 	virtual void MeasureStringRect(std::string_view str, const Bounds &bounds, float *w, float *h, int align = ALIGN_TOPLEFT) = 0;
+
+	// TODO: This one we should be able to make a default implementation for, calling the specialized DrawBitmap.
+	// Only problem is that we need to make sure that the texFormats are all supported by all the backends, or we explicitly limit.
 	virtual void DrawString(DrawBuffer &target, std::string_view str, float x, float y, uint32_t color, int align = ALIGN_TOPLEFT) = 0;
+
 	void DrawStringRect(DrawBuffer &target, std::string_view str, const Bounds &bounds, uint32_t color, int align);
-	virtual void DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align = ALIGN_TOPLEFT) = 0;
-	void DrawStringBitmapRect(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, const Bounds &bounds, int align);
+	virtual bool DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align = ALIGN_TOPLEFT) = 0;
+	bool DrawStringBitmapRect(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, const Bounds &bounds, int align);
 	// Use for housekeeping like throwing out old strings.
 	virtual void OncePerFrame() = 0;
 
@@ -86,6 +92,9 @@ class TextDrawer {
 	float fontScaleY_ = 1.0f;
 	float dpiScale_ = 1.0f;
 	bool ignoreGlobalDpi_ = false;
+
+	std::map<CacheKey, std::unique_ptr<TextStringEntry>> cache_;
+	std::map<CacheKey, std::unique_ptr<TextMeasureEntry>> sizeCache_;
 };
 
 class TextDrawerWordWrapper : public WordWrapper {

Common/Render/Text/draw_text_android.cpp

@@ -174,10 +174,10 @@ void TextDrawerAndroid::MeasureStringRect(std::string_view str, const Bounds &bo
 	*h = total_h * fontScaleY_ * dpiScale_;
 }
 
-void TextDrawerAndroid::DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align) {
+bool TextDrawerAndroid::DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align) {
 	if (str.empty()) {
 		bitmapData.clear();
-		return;
+		return false;
 	}
 
 	double size = 0.0;
@@ -244,6 +244,7 @@ void TextDrawerAndroid::DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextS
 	}
 	env->ReleaseIntArrayElements(imageData, jimage, 0);
 	env->DeleteLocalRef(imageData);
+	return true;
 }
 
 void TextDrawerAndroid::DrawString(DrawBuffer &target, std::string_view str, float x, float y, uint32_t color, int align) {

Common/Render/Text/draw_text_android.h

@@ -24,7 +24,7 @@ class TextDrawerAndroid : public TextDrawer {
 	void MeasureString(std::string_view str, float *w, float *h) override;
 	void MeasureStringRect(std::string_view str, const Bounds &bounds, float *w, float *h, int align = ALIGN_TOPLEFT) override;
 	void DrawString(DrawBuffer &target, std::string_view str, float x, float y, uint32_t color, int align = ALIGN_TOPLEFT) override;
-	void DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align = ALIGN_TOPLEFT) override;
+	bool DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align = ALIGN_TOPLEFT) override;
 	// Use for housekeeping like throwing out old strings.
 	void OncePerFrame() override;
 
@@ -43,9 +43,6 @@ class TextDrawerAndroid : public TextDrawer {
 	bool use4444Format_ = false;
 
 	std::map<uint32_t, AndroidFontEntry> fontMap_;
-
-	std::map<CacheKey, std::unique_ptr<TextStringEntry>> cache_;
-	std::map<CacheKey, std::unique_ptr<TextMeasureEntry>> sizeCache_;
 };
 
 #endif

Common/Render/Text/draw_text_cocoa.h

@@ -0,0 +1,40 @@
+#pragma once
+
+#include "ppsspp_config.h"
+
+#if PPSSPP_PLATFORM(MAC) || PPSSPP_PLATFORM(IOS)
+
+#include <map>
+#include "Common/Render/Text/draw_text.h"
+
+struct TextDrawerContext;
+// Internal struct but all details in .cpp file (pimpl to avoid pulling in excessive headers here)
+class TextDrawerFontContext;
+
+class TextDrawerCocoa : public TextDrawer {
+public:
+	TextDrawerCocoa(Draw::DrawContext *draw);
+	~TextDrawerCocoa();
+
+	uint32_t SetFont(const char *fontName, int size, int flags) override;
+	void SetFont(uint32_t fontHandle) override;  // Shortcut once you've set the font once.
+	void MeasureString(std::string_view str, float *w, float *h) override;
+	void MeasureStringRect(std::string_view str, const Bounds &bounds, float *w, float *h, int align = ALIGN_TOPLEFT) override;
+	void DrawString(DrawBuffer &target, std::string_view str, float x, float y, uint32_t color, int align = ALIGN_TOPLEFT) override;
+	bool DrawStringBitmap(std::vector<uint8_t> &bitmapData, TextStringEntry &entry, Draw::DataFormat texFormat, std::string_view str, int align = ALIGN_TOPLEFT) override;
+	// Use for housekeeping like throwing out old strings.
+	void OncePerFrame() override;
+
+protected:
+	void ClearCache() override;
+	void RecreateFonts();  // On DPI change
+
+	TextDrawerContext *ctx_;
+	std::map<uint32_t, std::unique_ptr<TextDrawerFontContext>> fontMap_;
+
+	uint32_t fontHash_;
+	std::map<CacheKey, std::unique_ptr<TextStringEntry>> cache_;
+	std::map<CacheKey, std::unique_ptr<TextMeasureEntry>> sizeCache_;
+};
+
+#endif