Add option for custom background styles

Author: lin-xianming

CHANGELOG.md

@@ -3,12 +3,11 @@
 #### v2.0.0
 
 - Merged Quick Power, Quick Volume, and Rapidmenu
-- Support testkit firmware 3.60
-- Added "Restart" text to poweroff button (20 languages)
-- Configurable Quick Menu PS button push time
-- Option to restart with the standby button
+- Configurable Quick Menu open time
+- Configurable power buttons
+- Custom background styles and other visual enhancements
 - Fixed a bug where SceShell's internal state becomes inconsistent
-- Many visual enhancements
+- Support testkit firmware 3.60
 
 ### Changelog - Quick Power
 

README.md

@@ -2,11 +2,11 @@
 
 Quick Menu Plus adds the following features to the Quick Menu on the PlayStation Vita and PlayStation TV.
 
-- Power off and standby buttons for Vita
-- Restart from the Quick Menu
-- Volume slidebar for Vita
-- Configurable Quick Menu PS button push time
-- Remove gradient overlay from the Quick Menu
+- Power off, restart, and standby buttons
+- Configurable power buttons
+- Volume slidebar
+- Faster Quick Menu open time
+- Custom background styles
 
 ![preview.png](https://git.shotatoshounenwachigau.moe/vita/quickmenuplus/plain/preview-small.png?h=assets)
 
@@ -31,10 +31,14 @@ Put files in the directory `ur0:/data/quickmenuplus` to configure Quick Menu Plu
 
 - `pushtime.txt` sets the Quick Menu PS button push time. Put in the file the desired push time in microseconds. For example, put `250000` for 250 milliseconds. If the file does not exist, the push time is unchanged.
 
-- `standbyisrestart.txt` sets the standby button to function as a restart button. Put in the file `1` to enable, or `0` to disable. If the file does not exist, the default is disable.
+- `standbyisrestart.txt` sets the standby button to function as a restart button. Put in the file `1` to enable, or `0` to disable. If the file does not exist, the default is disable. When this setting is disabled, hold the "Power Off・Restart" button to restart, and press to power off.
 
     ![standbyisrestart-preview.png](https://git.shotatoshounenwachigau.moe/vita/quickmenuplus/plain/standbyisrestart-preview-small.png?h=assets)
 
+- `bgstyle.txt` sets the background style. Put in the file `0` for original, `1` for translucent, and `2` for black. If the file does not exist, the default is original. Black can reduce power consumption for OLED screens. The gradient effect is removed in all styles.
+
+    ![bgstyle-preview.png](https://git.shotatoshounenwachigau.moe/vita/quickmenuplus/plain/bgstyle-preview-small.png?h=assets)
+
 ## Contributing
 
 Use [git-format-patch](https://www.git-scm.com/docs/git-format-patch) or [git-request-pull](https://www.git-scm.com/docs/git-request-pull) and email me at <[email protected]>.

ScePaf.yml

@@ -9,6 +9,7 @@ modules:
         functions:
           scePafButtonSetRepeat: 0x16479BA7
           scePafWidgetFindById: 0x9D304F4A
+          scePafWidgetSetColour: 0x627CDA4E
       ScePafToplevel:
         kernel: false
         nid: 0x4D9A9DD0

quickmenuplus.c

@@ -44,7 +44,7 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 #define N_INJECT 3
 static SceUID inject_id[N_INJECT];
 
-#define N_HOOK 6
+#define N_HOOK 7
 static SceUID hook_id[N_HOOK];
 static tai_hook_ref_t hook_ref[N_HOOK];
 
@@ -78,7 +78,12 @@ static const SceWChar16 *restart_text[N_LANG] = {
 	u"Yeniden başlatmak",
 };
 
+#define BG_STYLE_ORIGINAL    0
+#define BG_STYLE_TRANSLUCENT 1
+#define BG_STYLE_BLACK       2
+
 static bool standby_is_restart = false;
+static int bg_style = BG_STYLE_ORIGINAL;
 
 static atomic_int system_volume;
 
@@ -134,13 +139,16 @@ static ScePafWidget *get_widget(ScePafWidget *parent, SceUInt32 id) {
 	return scePafWidgetFindById(parent, &param, 0);
 }
 
+static void colour_convert_rgba(float *farr, SceUInt32 rgba) {
+	farr[0] = (float)((rgba >> 0x18) & 0xFF) / 255.0;
+	farr[1] = (float)((rgba >> 0x10) & 0xFF) / 255.0;
+	farr[2] = (float)((rgba >> 0x08) & 0xFF) / 255.0;
+	farr[3] = (float)((rgba >> 0x00) & 0xFF) / 255.0;
+}
+
 static void set_btn_colour(ScePafWidget *widget, SceUInt32 colour) {
-	float _colour[4] = {
-		(float)((colour >> 0x18) & 0xFF) / 255.0,
-		(float)((colour >> 0x10) & 0xFF) / 255.0,
-		(float)((colour >> 0x08) & 0xFF) / 255.0,
-		(float)((colour >> 0x00) & 0xFF) / 255.0,
-	};
+	float _colour[4];
+	colour_convert_rgba(_colour, colour);
 
 	// style objs are indexed in the order they appear in the RCO XML
 	ScePafStyle *plane_obj = widget->vptr->get_style_obj(widget, 0);
@@ -149,6 +157,12 @@ static void set_btn_colour(ScePafWidget *widget, SceUInt32 colour) {
 	}
 }
 
+static void set_widget_colour(ScePafWidget *widget, SceUInt32 colour) {
+	float _colour[4];
+	colour_convert_rgba(_colour, colour);
+	scePafWidgetSetColour(0.0, widget, _colour, 0, 0x10001, 0, 0, 0);
+}
+
 static void set_power_text(ScePafWidget *parent) {
 	ScePafWidget *box_widget = get_widget(parent, QUICK_MENU_BOX_ID);
 	if (box_widget) {
@@ -245,6 +259,24 @@ static int process_volume_hook(int *audio_info, void *button_info) {
 	return TAI_NEXT(process_volume_hook, hook_ref[5], audio_info, button_info);
 }
 
+// This function initialises some fields of the Quick Menu background plane
+// which has ID 0xE83F6AF0. Disabling this function or using other arguments
+// did not seem to make any difference.
+// r1 - 3
+// r2 - {960.0, 544.0}
+// r3 - {0.0, 0.0}
+static void bg_plane_init_hook(ScePafWidget *r0, int r1, float *r2, float *r3) {
+	TAI_NEXT(bg_plane_init_hook, hook_ref[6], r0, r1, r2, r3);
+	switch (bg_style) {
+		case BG_STYLE_TRANSLUCENT:
+			set_widget_colour(r0, 0x282828C0);
+			break;
+		case BG_STYLE_BLACK:
+			set_widget_colour(r0, 0x000000FF);
+			break;
+	}
+}
+
 static void startup(void) {
 	sceClibMemset(inject_id, 0xFF, sizeof(inject_id));
 	sceClibMemset(hook_id, 0xFF, sizeof(hook_id));
@@ -270,6 +302,7 @@ USED int module_start(UNUSED SceSize args, UNUSED const void *argp) {
 	}
 
 	standby_is_restart = config_read_key("standbyisrestart");
+	bg_style = config_read_key("bgstyle");
 
 	// get SceShell module info
 	tai_module_info_t minfo;
@@ -380,6 +413,19 @@ USED int module_start(UNUSED SceSize args, UNUSED const void *argp) {
 	// Disable quick menu gradient effect (cmp r0, r0)
 	GLZ(INJECT_ABS(2, (void*)(quick_menu_init + 0x186), "\x80\x42", 2));
 
+	if (bg_style != BG_STYLE_ORIGINAL) {
+		// Address of branch to bg_plane_init
+		int bg_plane_init_bl = quick_menu_init + 0x12C;
+
+		// Address of the function bg_plane_init
+		int bg_plane_init;
+		GLZ(decode_bl_t1(*(int*)bg_plane_init_bl, &bg_plane_init));
+		bg_plane_init += bg_plane_init_bl + 4;
+
+		// Custom style for the Quick Menu background
+		GLZ(HOOK_OFFSET(6, minfo.modid, bg_plane_init - seg0, 1, bg_plane_init));
+	}
+
 	return SCE_KERNEL_START_SUCCESS;
 
 fail:

scepaf.h

@@ -82,4 +82,6 @@ const SceWChar16 *scePafLabelFindById(ScePafPlugin*, const ScePafResourceSearchP
 
 ScePafWidget *scePafWidgetFindById(ScePafWidget*, const ScePafResourceSearchParam*, int);
 
+void scePafWidgetSetColour(float, ScePafWidget*, float*, int, int, int, int, int);
+
 #endif