Skip to content

AVIF image support #5625

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.

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

Merged
merged 2 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion app/Http/Controller.php
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ protected function logActivity(string $type, string|Loggable $detail = ''): void
*/
protected function getImageValidationRules(): array
{
return ['image_extension', 'mimes:jpeg,png,gif,webp', 'max:' . (config('app.upload_limit') * 1000)];
return ['image_extension', 'mimes:jpeg,png,gif,webp,avif', 'max:' . (config('app.upload_limit') * 1000)];
}

/**
Expand Down
50 changes: 43 additions & 7 deletions app/Uploads/ImageResizer.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Exception;
use GuzzleHttp\Psr7\Utils;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Log;
use Intervention\Image\Decoders\BinaryImageDecoder;
use Intervention\Image\Drivers\Gd\Decoders\NativeObjectDecoder;
use Intervention\Image\Drivers\Gd\Driver;
Expand Down Expand Up @@ -93,8 +94,8 @@ public function resizeToThumbnailUrl(

$imageData = $disk->get($imagePath);

// Do not resize apng images where we're not cropping
if ($keepRatio && $this->isApngData($image, $imageData)) {
// Do not resize animated images where we're not cropping
if ($keepRatio && $this->isAnimated($image, $imageData)) {
Cache::put($thumbCacheKey, $image->path, static::THUMBNAIL_CACHE_TIME);

return $this->storage->getPublicUrl($image->path);
Expand Down Expand Up @@ -240,15 +241,50 @@ protected function getExtension(Image $image): string
/**
* Check if the given image and image data is apng.
*/
protected function isApngData(Image $image, string &$imageData): bool
protected function isApngData(string &$imageData): bool
{
$isPng = strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'png';
if (!$isPng) {
$initialHeader = substr($imageData, 0, strpos($imageData, 'IDAT'));

return str_contains($initialHeader, 'acTL');
}

/**
* Check if the given avif image data represents an animated image.
* This is based up the answer here: https://stackoverflow.com/a/79457313
*/
protected function isAnimatedAvifData(string &$imageData): bool
{
$stszPos = strpos($imageData, 'stsz');
if ($stszPos === false) {
return false;
}

$initialHeader = substr($imageData, 0, strpos($imageData, 'IDAT'));
// Look 12 bytes after the start of 'stsz'
$start = $stszPos + 12;
$end = $start + 4;
if ($end > strlen($imageData) - 1) {
return false;
}

return str_contains($initialHeader, 'acTL');
$data = substr($imageData, $start, 4);
$count = unpack('Nvalue', $data)['value'];
return $count > 1;
}

/**
* Check if the given image is animated.
*/
protected function isAnimated(Image $image, string &$imageData): bool
{
$extension = strtolower(pathinfo($image->path, PATHINFO_EXTENSION));
if ($extension === 'png') {
return $this->isApngData($imageData);
}

if ($extension === 'avif') {
return $this->isAnimatedAvifData($imageData);
}

return false;
}
}
2 changes: 1 addition & 1 deletion app/Uploads/ImageService.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

class ImageService
{
protected static array $supportedExtensions = ['jpg', 'jpeg', 'png', 'gif', 'webp'];
protected static array $supportedExtensions = ['jpg', 'jpeg', 'png', 'gif', 'webp', 'avif'];

public function __construct(
protected ImageStorage $storage,
Expand Down
15 changes: 14 additions & 1 deletion tests/Uploads/ImageTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,20 @@ public function test_image_display_thumbnail_generation_for_apng_images_uses_ori
$this->files->deleteAtRelativePath($imgDetails['path']);

$this->assertStringContainsString('thumbs-', $imgDetails['response']->thumbs->gallery);
$this->assertStringNotContainsString('thumbs-', $imgDetails['response']->thumbs->display);
$this->assertStringNotContainsString('scaled-', $imgDetails['response']->thumbs->display);
}

public function test_image_display_thumbnail_generation_for_animated_avif_images_uses_original_file()
{
$page = $this->entities->page();
$admin = $this->users->admin();
$this->actingAs($admin);

$imgDetails = $this->files->uploadGalleryImageToPage($this, $page, 'animated.avif');
$this->files->deleteAtRelativePath($imgDetails['path']);

$this->assertStringContainsString('thumbs-', $imgDetails['response']->thumbs->gallery);
$this->assertStringNotContainsString('scaled-', $imgDetails['response']->thumbs->display);
}

public function test_image_edit()
Expand Down
Binary file added tests/test-data/animated.avif
Binary file not shown.