Merge pull request #33 from jolicode/feat/avif-support

Add avif support

Author: xavierlacot

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.1.1] - 2025-11-12
+
+### Added
+
+- Support for AVIF and HEIF image formats
+
+### Fixed
+
+- Fixed the URL of variations displayed in the admin bridges when the image format has an alternative format defined (e.g., tiff or heic to jpeg)
+
 ## [0.1.0] - 2025-11-03
 
 This is the initial release of the bundle.
@@ -18,3 +28,4 @@ This is the initial release of the bundle.
 - debug toolbar and profiler panel to monitor media processing in your application
 
 [0.1.0]: https://github.com/jolicode/mediabundle/releases/tag/v0.1.0
+[0.1.1]: https://github.com/jolicode/mediabundle/releases/tag/v0.1.1

doc/bridges/easy-admin.rst

@@ -1,7 +1,7 @@
 EasyAdmin Integration
 =====================
 
-The ``JoliMediaBundle`` provides seamless integration with EasyAdmin, enabling you to manage media directly within your EasyAdmin interface. This integration includes features such as a media library, media browser, and media preview capabilities.
+The ``JoliMediaBundle`` provides seamless integration with `EasyAdmin <https://symfony.com/bundles/EasyAdminBundle/current/index.html>`_, enabling you to manage media directly within your EasyAdmin interface. This integration includes features such as a media library, media browser, and media preview capabilities.
 
 .. image:: ../images/bridges/easyadmin/grid-view.png
    :alt: The EasyAdmin media library grid view

doc/bridges/sonata-admin.rst

@@ -1,7 +1,7 @@
 Sonata Admin Integration
 ========================
 
-The ``JoliMediaBundle`` provides seamless integration with Sonata Admin, enabling you to manage media directly within your Sonata Admin interface. This integration includes features such as a media library, media browser, and media preview capabilities.
+The ``JoliMediaBundle`` provides seamless integration with `Sonata Admin <https://symfony.com/bundles/SonataAdminBundle/current/index.html>`_, enabling you to manage media directly within your Sonata Admin interface. This integration includes features such as a media library, media browser, and media preview capabilities.
 
 .. image:: ../images/bridges/sonata-admin/grid-view.png
    :alt: The Sonata Admin media library grid view

doc/getting-started/dependencies-and-tooling.rst

@@ -24,10 +24,16 @@ A typical Debian-based system can install the required dependencies using the fo
         gifsicle \
         imagemagick \
         jpegoptim \
+        libheif1 \
+        libheif-plugins-all \
         libimage-exiftool-perl \
         libmagickcore-dev \
         pngquant
 
+.. note::
+
+    The ``libheif1`` and ``libheif-plugins-all`` packages are required to handle AVIF and HEIF images with ImageMagick. Depending on your system, the versions provided by the package manager might be outdated and not (fully) support these formats. In this case, you will need to compile ImageMagick from source with HEIF support.
+
 Some tools are not available in the default repositories, so you will need to install them manually. The following commands will install all such tools:
 
 .. code-block:: bash

doc/index.rst

@@ -5,7 +5,7 @@ The JoliMediaBundle provides a set of tools to manage media in Symfony applicati
 
 It proposes multiple features:
 
-- `EasyAdmin <https://symfony.com/bundles/EasyAdminBundle/current/index.html>`_ and `SonataAdmin <https://symfony.com/bundles/SonataAdminBundle/current/index.html>`_ integrations
+- `EasyAdmin <bridges/easy-admin.rst>`_ and `SonataAdmin <bridges/sonata-admin.rst>`_ integrations
 - abstract media storage
 - processors to transform media (crop / resize / etc.)
 - post processors to optimize the media size
@@ -22,7 +22,7 @@ It proposes multiple features:
 🤓 Goals and approach
 --------------------
 
-The JoliMediaBundle aims to provide numerous facilities to manage media in Symfony applications, by using the best tools available, and following best practices. It is built on top of the [Flysystem](https://flysystem.thephpleague.com/) library to provide an abstraction layer for file storage, and multiple media processing libraries to handle media transformations and optimizations.
+The JoliMediaBundle aims to provide numerous facilities to manage media in Symfony applications, by using the best tools available, and following best practices. It is built on top of the `Flysystem <https://flysystem.thephpleague.com/>`_ library to provide an abstraction layer for file storage, and multiple media processing libraries to handle media transformations and optimizations.
 
 The project seeks to provide:
 

doc/variations/processors.rst

@@ -11,7 +11,7 @@ The main processors configuration is defined in the ``processors`` key of the ``
 - ``cwebp``: the processor to convert images to WebP format
 - ``gif2webp``: the processor to convert GIF images to WebP format
 - ``gifsicle``: the processor to convert GIF images into other GIF files
-- ``imagimagineick``: the processor to convert images using the Imagine library
+- ``imagine``: the processor to convert images using the Imagine library
 
 .. tip::
 
@@ -69,9 +69,9 @@ The ``imagine`` processor does not use a binary, it uses the Imagine library to
 cwebp processor options
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The ``gif2webp`` processor is used to convert JPEG, PNG, TIFF or WEBP images to WebP format. It supports two presets: ``near_lossless`` and ``lossy``.
+The ``cwebp`` processor is used to convert JPEG, PNG, TIFF or WEBP images to WebP format. It supports two presets: ``near_lossless`` and ``lossy``.
 
-The ``near_lossless`` configuration preset is used for images that you want to convert to WebP with minimal quality loss. Under the hood, the bundle never uses the ``near_lossless`` preset for JPEG or TIFF images or for imahgs that contain more than 20000 colors.
+The ``near_lossless`` configuration preset is used for images that you want to convert to WebP with minimal quality loss. Under the hood, the bundle never uses the ``near_lossless`` preset for JPEG or TIFF images or for images that contain more than 20000 colors.
 
 The ``lossy`` configuration preset is the default preset, it offers a good balance between quality and file size for most images.
 
@@ -89,7 +89,7 @@ The various configuration keys are mapped to `the official cwebp options <https:
 gif2webp processor options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The ``gif2webp`` processor is used to convert GIF images to WebP format. Its configuration keys are mapped to `the official gif2webp options <https://developers.google.com/speed/webp/docs/gif2webp>`_:
+The ``gif2webp`` processor is used to convert (animated) GIF images to WebP format. Its configuration keys are mapped to `the official gif2webp options <https://developers.google.com/speed/webp/docs/gif2webp>`_:
 
 - ``lossy``: ``-lossy``
 - ``metadata``: ``-metadata``
@@ -107,12 +107,16 @@ The ``gifsicle`` processor is used to convert GIF images into other GIF files. I
 imagine processor options
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The ``imagine`` processor is used to convert GIF, HEIF, JPEG, PNG, TIFF or WEBP images to the GIF, JPEG, PNG or TIFF format using `the Imagine library <https://github.com/php-imagine/Imagine>`_. It supports the following configuration keys:
+The ``imagine`` processor is used to convert AVIF, GIF, HEIF, JPEG, PNG, TIFF or WEBP images to the AVIF, GIF, JPEG, PNG or TIFF format using `the Imagine library <https://github.com/php-imagine/Imagine>`_. It supports the following configuration keys:
 
 - ``jpeg_quality``: the quality of the JPEG images, from 0 to 100 (default: 80). It is mapped to Imagine's ``jpeg_quality`` option
 - ``png_quality``: the quality of the PNG images, from 0 to 100 (default: 80). It is mapped to Imagine's ``png_compression_level`` and ``png_compression_filter`` options
 - ``quality``: the quality of the images, from 0 to 100 (default: 80). It is mapped to Imagine's ``quality`` option
 
+.. note::
+
+    The AVIF support is still a bit limited in Imagine. In particular, it does not work with animated AVIF images. As a consequence, converting an animated GIF to AVIF will only keep the first frame of the GIF image.
+
 Customizing processor options for a library or a variation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

src/Bridge/EasyAdmin/src/Controller/MediaAdminController.php

@@ -19,6 +19,7 @@
 use JoliCode\MediaBundle\Exception\MediaInUseException;
 use JoliCode\MediaBundle\Library\Library;
 use JoliCode\MediaBundle\Library\LibraryContainer;
+use JoliCode\MediaBundle\Model\MediaVariation;
 use JoliCode\MediaBundle\Resolver\Resolver;
 use JoliCode\MediaBundle\Storage\OriginalStorage;
 use League\Flysystem\PathTraversalDetected;
@@ -383,18 +384,28 @@ public function regenerateVariation(string $key, string $variation): RedirectRes
         ));
 
         $media = $this->resolver->resolveMedia($key);
-        $variation = $this->getLibrary()->getVariation($variation);
-        $mediaVariation = $variation->getForMedia($media);
-        $this->converter->convertMediaVariation($mediaVariation);
+        $mediaVariation = $this->resolver->resolveMediaVariation($media, $variation, $this->getLibrary()->getName());
 
-        $this->addFlash(
-            'success',
-            $this->translator->trans(
-                'variation.regenerated_success',
-                ['%variation%' => $variation->getName(), '%media%' => $media->getPath()],
-                'JoliMediaEasyAdminBundle'
-            )
-        );
+        if (!$mediaVariation instanceof MediaVariation) {
+            $this->addFlash(
+                'danger',
+                $this->translator->trans(
+                    'variation.regenerated_failure',
+                    ['%variation%' => $variation, '%media%' => $media->getPath()],
+                    'JoliMediaEasyAdminBundle'
+                )
+            );
+        } else {
+            $this->converter->convertMediaVariation($mediaVariation);
+            $this->addFlash(
+                'success',
+                $this->translator->trans(
+                    'variation.regenerated_success',
+                    ['%variation%' => $variation, '%media%' => $media->getPath()],
+                    'JoliMediaEasyAdminBundle'
+                )
+            );
+        }
 
         return $this->redirect($this->adminUrlGenerator
             ->setRoute('joli_media_easy_admin_show', [
@@ -544,7 +555,7 @@ public function show(AdminContext $adminContext, Request $request, string $key):
                 }
 
                 if ($variation->canBeAppliedTo($media)) {
-                    $media->createVariation($variation);
+                    $this->resolver->resolveMediaVariation($media, $variation, $this->getLibrary()->getName());
                 }
             }
         }

src/Bridge/EasyAdmin/translations/JoliMediaEasyAdminBundle.en.yaml

@@ -105,6 +105,7 @@ root: 'Root'
 variation:
     label: 'Variation'
     label_plural: 'Variations'
+    regenerated_failure: 'Failed to regenerate the variation "%variation%" for the media "%media%"'
     regenerated_success: 'Variation "%variation%" regenerated successfully for the media "%media%"'
     stored: 'Stored?'
 view:

src/Bridge/EasyAdmin/translations/JoliMediaEasyAdminBundle.fr.yaml

@@ -103,9 +103,10 @@ preview:
     unavailable: 'Aperçu non disponible.'
 root: 'Racine'
 variation:
-    label: 'Variante'
-    label_plural: 'Variantes'
-    regenerated_success: 'La variante "%variation%" a été régénérée avec succès pour le média "%media%"'
+    label: 'Variation'
+    label_plural: 'Variations'
+    regenerated_failure: 'Échec de la régénération de la variation "%variation%" pour le média "%media%"'
+    regenerated_success: 'La variation "%variation%" a été régénérée avec succès pour le média "%media%"'
     stored: 'Stockée ?'
 view:
     grid: 'Vue grille'

src/Bridge/SonataAdmin/src/Controller/MediaAdminController.php

@@ -16,6 +16,7 @@
 use JoliCode\MediaBundle\Exception\MediaInUseException;
 use JoliCode\MediaBundle\Library\Library;
 use JoliCode\MediaBundle\Library\LibraryContainer;
+use JoliCode\MediaBundle\Model\MediaVariation;
 use JoliCode\MediaBundle\Resolver\Resolver;
 use JoliCode\MediaBundle\Storage\OriginalStorage;
 use League\Flysystem\PathTraversalDetected;
@@ -353,18 +354,28 @@ public function regenerateVariation(string $key, string $variation): RedirectRes
         ));
 
         $media = $this->resolver->resolveMedia($key);
-        $variation = $this->getLibrary()->getVariation($variation);
-        $mediaVariation = $variation->getForMedia($media);
-        $this->converter->convertMediaVariation($mediaVariation);
+        $mediaVariation = $this->resolver->resolveMediaVariation($media, $variation, $this->getLibrary()->getName());
 
-        $this->addFlash(
-            'sonata_flash_success',
-            $this->translator->trans(
-                'variation.regenerated_success',
-                ['%variation%' => $variation->getName(), '%media%' => $media->getPath()],
-                'JoliMediaSonataAdminBundle'
-            )
-        );
+        if (!$mediaVariation instanceof MediaVariation) {
+            $this->addFlash(
+                'sonata_flash_error',
+                $this->translator->trans(
+                    'variation.regenerated_failure',
+                    ['%variation%' => $variation, '%media%' => $media->getPath()],
+                    'JoliMediaSonataAdminBundle'
+                )
+            );
+        } else {
+            $this->converter->convertMediaVariation($mediaVariation);
+            $this->addFlash(
+                'sonata_flash_success',
+                $this->translator->trans(
+                    'variation.regenerated_success',
+                    ['%variation%' => $variation, '%media%' => $media->getPath()],
+                    'JoliMediaSonataAdminBundle'
+                )
+            );
+        }
 
         return $this->redirectToRoute('joli_media_sonata_admin_show', [
             'key' => $key,
@@ -503,7 +514,7 @@ public function show(Request $request, string $key): Response
                 }
 
                 if ($variation->canBeAppliedTo($media)) {
-                    $media->createVariation($variation);
+                    $this->resolver->resolveMediaVariation($media, $variation, $this->getLibrary()->getName());
                 }
             }
         }