Skip to content

feat(android): add WebP image format + fix uncompressed PNG output #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PrestaEdit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(android): add WebP image format + fix uncompressed PNG output #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions config/nativephp.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,24 @@
*/
'status_bar_style' => 'auto',

/*
|--------------------------------------------------------------------------
| Image Format for Generated Android Resources
|--------------------------------------------------------------------------
|
| Format used when NativePHP generates Android bitmap resources (launcher
| icons + splash screens) at build time from `public/icon.png`,
| `public/splash.png`, and `public/splash-dark.png`.
|
| Options:
| 'png' - Default. Backwards compatible with existing projects.
| 'webp' - Recommended. 60-90% smaller AAB, satisfies Play Console's
| "optimize bitmap images" recommendation. Requires PHP GD
| compiled with WebP support (falls back to PNG otherwise).
|
*/
'image_format' => env('NATIVEPHP_ANDROID_IMAGE_FORMAT', 'png'),

/*
|--------------------------------------------------------------------------
| Android Theme Colors
Expand Down
70 changes: 57 additions & 13 deletions src/Concerns/InstallsAndroidSplashScreen.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ public function installAndroidSplashScreen(): void
$this->logToFile('Installing Android splash screen...');

try {
$lightSplashPath = public_path('splash.png');
$darkSplashPath = public_path('splash-dark.png');
// Accept either splash.png or splash.webp as source (webp takes
// precedence when both exist, since it's the smaller of the two).
$lightSplashPath = $this->locateSplashSource('splash');
$darkSplashPath = $this->locateSplashSource('splash-dark');

$hasLightSplash = File::exists($lightSplashPath);
$hasDarkSplash = File::exists($darkSplashPath);
$hasLightSplash = $lightSplashPath !== null;
$hasDarkSplash = $darkSplashPath !== null;

$this->logToFile(' Light splash (splash.png): '.($hasLightSplash ? 'found' : 'not found'));
$this->logToFile(' Dark splash (splash-dark.png): '.($hasDarkSplash ? 'found' : 'not found'));
$this->logToFile(' Light splash: '.($hasLightSplash ? basename($lightSplashPath) : 'not found'));
$this->logToFile(' Dark splash: '.($hasDarkSplash ? basename($darkSplashPath) : 'not found'));

if (! $hasLightSplash && ! $hasDarkSplash) {
$this->logToFile(' No splash screens found, skipping');
Expand All @@ -29,6 +31,7 @@ public function installAndroidSplashScreen(): void
}

$resDir = base_path('nativephp/android/app/src/main/res/');
$format = $this->androidImageFormat();

$sizes = [
'mdpi' => [320, 480],
Expand All @@ -39,29 +42,33 @@ public function installAndroidSplashScreen(): void
];

if ($hasLightSplash && $this->validateSplashImage($lightSplashPath)) {
$this->logToFile(' Generating light splash variants...');
$this->logToFile(" Generating light splash variants (.$format)...");
foreach ($sizes as $density => $dimensions) {
try {
$dstDir = $resDir."drawable-{$density}";
File::ensureDirectoryExists($dstDir);

$dstPath = $dstDir.DIRECTORY_SEPARATOR.'splash.png';
$this->resizePng($lightSplashPath, $dstPath, $dimensions[0], $dimensions[1]);
$this->cleanStaleSplash($dstDir, $format);

$dstPath = $dstDir.DIRECTORY_SEPARATOR.'splash.'.$format;
$this->resizeImage($lightSplashPath, $dstPath, $dimensions[0], $dimensions[1], $format);
} catch (\Exception $e) {
$this->logToFile(" Failed to generate $density: ".$e->getMessage());
}
}
}

if ($hasDarkSplash && $this->validateSplashImage($darkSplashPath)) {
$this->logToFile(' Generating dark splash variants...');
$this->logToFile(" Generating dark splash variants (.$format)...");
foreach ($sizes as $density => $dimensions) {
try {
$dstDir = $resDir."drawable-night-{$density}";
File::ensureDirectoryExists($dstDir);

$dstPath = $dstDir.DIRECTORY_SEPARATOR.'splash.png';
$this->resizePng($darkSplashPath, $dstPath, $dimensions[0], $dimensions[1]);
$this->cleanStaleSplash($dstDir, $format);

$dstPath = $dstDir.DIRECTORY_SEPARATOR.'splash.'.$format;
$this->resizeImage($darkSplashPath, $dstPath, $dimensions[0], $dimensions[1], $format);
} catch (\Exception $e) {
$this->logToFile(" Failed to generate night-$density: ".$e->getMessage());
}
Expand All @@ -75,9 +82,46 @@ public function installAndroidSplashScreen(): void
}
}

/**
* Look for `public/{name}.webp` first, then `public/{name}.png`.
*/
private function locateSplashSource(string $name): ?string
{
$webp = public_path($name.'.webp');
if (File::exists($webp) && function_exists('imagecreatefromwebp')) {
return $webp;
}

$png = public_path($name.'.png');
if (File::exists($png)) {
return $png;
}

return null;
}

/**
* Remove a splash resource of the opposite extension so AAPT does not see
* two entries for the same resource name in the same folder.
*/
private function cleanStaleSplash(string $dir, string $keepFormat): void
{
$stale = $dir.DIRECTORY_SEPARATOR.'splash.'.($keepFormat === 'png' ? 'webp' : 'png');
if (File::exists($stale)) {
File::delete($stale);
}
}

private function validateSplashImage(string $splashPath): bool
{
$image = @imagecreatefrompng($splashPath);
$ext = strtolower(pathinfo($splashPath, PATHINFO_EXTENSION));

if ($ext === 'webp' && function_exists('imagecreatefromwebp')) {
$image = @imagecreatefromwebp($splashPath);
} else {
$image = @imagecreatefrompng($splashPath);
}

if ($image === false) {
return false;
}
Expand Down
70 changes: 57 additions & 13 deletions src/Concerns/InstallsAppIcon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ public function installAndroidIcon(): void
$this->logToFile(" Source icon: $iconPath");

$resDir = base_path('nativephp/android/app/src/main/res/');
$format = $this->androidImageFormat();

$sizes = [
'mipmap-mdpi' => 48,
Expand All @@ -103,9 +104,9 @@ public function installAndroidIcon(): void
];

$targets = [
'ic_launcher.png',
'ic_launcher_round.png',
'ic_launcher_foreground.png',
'ic_launcher',
'ic_launcher_round',
'ic_launcher_foreground',
];

$this->logToFile(' Generating icon sizes: '.implode(', ', array_keys($sizes)));
Expand All @@ -114,26 +115,46 @@ public function installAndroidIcon(): void
$dstDir = $resDir.$folder;
File::ensureDirectoryExists($dstDir);

foreach ($targets as $filename) {
$dstPath = $dstDir.'/'.$filename;
foreach ($targets as $basename) {
$dstPath = $dstDir.'/'.$basename.'.'.$format;

$webpPath = str_replace('.png', '.webp', $dstPath);
if (File::exists($webpPath)) {
File::delete($webpPath);
// Drop any stale resource of the opposite extension so AAPT does
// not see two entries for the same resource name.
$stalePath = $dstDir.'/'.$basename.'.'.($format === 'png' ? 'webp' : 'png');
if (File::exists($stalePath)) {
File::delete($stalePath);
}

$targetSize = ($filename === 'ic_launcher_foreground.png') ? $adaptiveSizes[$folder] : $size;
$targetSize = ($basename === 'ic_launcher_foreground') ? $adaptiveSizes[$folder] : $size;

$this->resizePng($iconPath, $dstPath, $targetSize, $targetSize);
$this->resizeImage($iconPath, $dstPath, $targetSize, $targetSize, $format);
}
}

$this->logToFile(' Android icon installed');
}

private function resizePng(string $src, string $dst, int $width, int $height): void
/**
* Output format for Android resource bitmaps (icons + splash).
* WebP is significantly smaller than PNG at equivalent quality and is
* supported natively by AAPT / Android since API 14 (lossless: API 18).
*/
protected function androidImageFormat(): string
{
$srcImage = imagecreatefrompng($src);
$format = strtolower((string) config('nativephp.android.image_format', 'png'));

if ($format === 'webp' && ! function_exists('imagewebp')) {
// GD compiled without WebP support: fall back to PNG rather than crash.
return 'png';
}

return $format === 'webp' ? 'webp' : 'png';
}

private function resizeImage(string $src, string $dst, int $width, int $height, string $format = 'png'): void
{
// Accept either PNG or WebP source images so users can supply either.
$srcImage = $this->readImage($src);
$srcWidth = imagesx($srcImage);
$srcHeight = imagesy($srcImage);

Expand Down Expand Up @@ -169,8 +190,31 @@ private function resizePng(string $src, string $dst, int $width, int $height): v
$srcWidth, $srcHeight
);

imagepng($resized, $dst, 0);
if ($format === 'webp') {
// Lossless WebP: preserves alpha and stays visually identical to the
// source. Roughly 60-90% smaller than an uncompressed PNG.
imagewebp($resized, $dst, IMG_WEBP_LOSSLESS);
} else {
// Level 9 = max PNG compression. The previous value (0) wrote
// uncompressed PNGs and made bundles 5-10x larger than needed.
imagepng($resized, $dst, 9);
}

imagedestroy($resized);
imagedestroy($srcImage);
}

/**
* Load a PNG or WebP source image with GD.
*/
private function readImage(string $path)
{
$ext = strtolower(pathinfo($path, PATHINFO_EXTENSION));

if ($ext === 'webp' && function_exists('imagecreatefromwebp')) {
return imagecreatefromwebp($path);
}

return imagecreatefrompng($path);
}
}
Loading