add "Summary" module

add "pre-clip" video filter optims by using `clip`(s) and `copy` when possible composer cs
alchemy-fr · Sep 17, 2024 · bc30d52 · bc30d52
1 parent c1fa104
commit bc30d52
Show file tree

Hide file tree

Showing 26 changed files with 395 additions and 132 deletions.
diff --git a/lib/php/rendition-factory-bundle/DependencyInjection/AlchemyRenditionFactoryExtension.php b/lib/php/rendition-factory-bundle/DependencyInjection/AlchemyRenditionFactoryExtension.php
@@ -18,6 +18,5 @@ public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yaml');
-
     }
 }
diff --git a/lib/php/rendition-factory-bundle/Resources/config/services.yaml b/lib/php/rendition-factory-bundle/Resources/config/services.yaml
@@ -20,13 +20,9 @@ services:
         tags:
             - { name: !php/const Alchemy\RenditionFactory\Transformer\TransformerModuleInterface::TAG }
 
-#    Alchemy\RenditionFactory\Transformer\Video\VideoToAnimatedGifTransformerModule:
-#        tags:
-#            - { name: !php/const Alchemy\RenditionFactory\Transformer\TransformerModuleInterface::TAG }
-#
-#    Alchemy\RenditionFactory\Transformer\Video\VideoResizeTransformerModule:
-#        tags:
-#            - { name: !php/const Alchemy\RenditionFactory\Transformer\TransformerModuleInterface::TAG }
+    Alchemy\RenditionFactory\Transformer\Video\SummaryTransformerModule:
+        tags:
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\TransformerModuleInterface::TAG }
 
     Alchemy\RenditionFactory\Transformer\Video\FFMpegTransformerModule:
         tags:

diff --git a/lib/php/rendition-factory/src/Command/CreateCommand.php b/lib/php/rendition-factory/src/Command/CreateCommand.php
@@ -8,7 +8,6 @@
 use Alchemy\RenditionFactory\DTO\CreateRenditionOptions;
 use Alchemy\RenditionFactory\MimeType\MimeTypeGuesser;
 use Alchemy\RenditionFactory\RenditionCreator;
-use InvalidArgumentException;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -46,6 +45,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $time = microtime(true);
         $mimeType = $input->getOption('type');
         $src = $input->getArgument('src');
         if (!file_exists($src)) {
@@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return 1;
         }
 
-        if ($mimeType === null) {
+        if (null === $mimeType) {
             $mimeType = $this->mimeTypeGuesser->guessMimeTypeFromPath($src);
         }
 
@@ -71,7 +71,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $buildConfig,
                 $options
             );
-        } catch (InvalidArgumentException $e) {
+        } catch (\InvalidArgumentException $e) {
             $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
 
             return 1;
@@ -96,6 +96,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->renditionCreator->cleanUp();
         }
 
+        $output->writeln(sprintf('Execution time: %0.2f', microtime(true) - $time));
+
         return 0;
     }
 }
diff --git a/lib/php/rendition-factory/src/Config/FileLoaderInterface.php b/lib/php/rendition-factory/src/Config/FileLoaderInterface.php
@@ -3,7 +3,6 @@
 namespace Alchemy\RenditionFactory\Config;
 
 use Alchemy\RenditionFactory\DTO\BuildConfig\BuildConfig;
-use Alchemy\RenditionFactory\DTO\BuildConfig\FamilyBuildConfig;
 
 interface FileLoaderInterface
 {

diff --git a/lib/php/rendition-factory/src/Config/YamlLoader.php b/lib/php/rendition-factory/src/Config/YamlLoader.php
@@ -37,9 +37,7 @@ private function parseConfig(array $data): BuildConfig
         $families = [];
         foreach ($data as $familyKey => $familyConfig) {
             if (null === $family = FamilyEnum::tryFrom($familyKey)) {
-                throw new ModelException(sprintf('Invalid file type family "%s". Expected one of %s', $familyKey, implode(', ', array_map(
-                    fn (FamilyEnum $family) => $family->value,
-                    FamilyEnum::cases()))));
+                throw new ModelException(sprintf('Invalid file type family "%s". Expected one of %s', $familyKey, implode(', ', array_map(fn (FamilyEnum $family) => $family->value, FamilyEnum::cases()))));
             }
 
             if (null !== $familyConfig) {

diff --git a/lib/php/rendition-factory/src/Context/TransformationContextFactory.php b/lib/php/rendition-factory/src/Context/TransformationContextFactory.php
@@ -18,16 +18,14 @@ public function __construct(
         private MimeTypeGuesser $mimeTypeGuesser,
         ?string $workingDirectory = null,
         private ?HttpClientInterface $client = null,
-        private ?LoggerInterface $logger = null
-    )
-    {
+        private ?LoggerInterface $logger = null,
+    ) {
         $this->workingDirectory = $workingDirectory ?? sys_get_temp_dir();
     }
 
     public function create(
-        ?CreateRenditionOptions $options = null
-    ): TransformationContext
-    {
+        ?CreateRenditionOptions $options = null,
+    ): TransformationContext {
         $baseDir = $options?->getWorkingDirectory() ?? $this->workingDirectory;
         $cacheDir = $options?->getCacheDirectory() ?? $baseDir.'/cache';
         $dateWorkingDir = $baseDir.'/'.date('Y-m-d');

diff --git a/lib/php/rendition-factory/src/DTO/BaseFile.php b/lib/php/rendition-factory/src/DTO/BaseFile.php
@@ -2,7 +2,6 @@
 
 namespace Alchemy\RenditionFactory\DTO;
 
-
 abstract readonly class BaseFile implements BaseFileInterface
 {
     public function __construct(

diff --git a/lib/php/rendition-factory/src/DTO/BaseFileInterface.php b/lib/php/rendition-factory/src/DTO/BaseFileInterface.php
@@ -9,4 +9,6 @@ public function getPath(): string;
     public function getType(): string;
 
     public function getFamily(): FamilyEnum;
+
+    public function getExtension(): string;
 }
diff --git a/lib/php/rendition-factory/src/DTO/BuildConfig/BuildConfig.php b/lib/php/rendition-factory/src/DTO/BuildConfig/BuildConfig.php
@@ -8,8 +8,7 @@
 {
     public function __construct(
         private array $families,
-    )
-    {
+    ) {
     }
 
     public function getFamily(FamilyEnum $family): ?FamilyBuildConfig

diff --git a/lib/php/rendition-factory/src/DTO/BuildConfig/FamilyBuildConfig.php b/lib/php/rendition-factory/src/DTO/BuildConfig/FamilyBuildConfig.php
@@ -9,8 +9,7 @@ public function __construct(
         private array $transformations,
 
         private array $normalization,
-    )
-    {
+    ) {
     }
 
     public function getTransformations(): array
@@ -22,5 +21,4 @@ public function getNormalization(): array
     {
         return $this->normalization;
     }
-
 }
diff --git a/lib/php/rendition-factory/src/DTO/BuildConfig/Transformation.php b/lib/php/rendition-factory/src/DTO/BuildConfig/Transformation.php
@@ -8,8 +8,7 @@ public function __construct(
         private string $module,
         private array $options,
         private ?string $description,
-    )
-    {
+    ) {
     }
 
     public function getModule(): string

diff --git a/lib/php/rendition-factory/src/DTO/CreateRenditionOptions.php b/lib/php/rendition-factory/src/DTO/CreateRenditionOptions.php
@@ -10,8 +10,7 @@ public function __construct(
         private ?string $workingDirectory = null,
         private ?string $cacheDirectory = null,
         private ?MetadataContainerInterface $metadataContainer = null,
-    )
-    {
+    ) {
     }
 
     public function getWorkingDirectory(): ?string

diff --git a/lib/php/rendition-factory/src/DTO/Metadata/MetadataArray.php b/lib/php/rendition-factory/src/DTO/Metadata/MetadataArray.php
@@ -5,11 +5,11 @@
 final readonly class MetadataArray implements MetadataContainerInterface
 {
     public function __construct(
-        private array $metadata
+        private array $metadata,
     ) {
     }
 
-    public function getMetadata(string $name): string|null
+    public function getMetadata(string $name): ?string
     {
         return $this->metadata[$name] ?? null;
     }

diff --git a/lib/php/rendition-factory/src/DTO/Metadata/MetadataContainerInterface.php b/lib/php/rendition-factory/src/DTO/Metadata/MetadataContainerInterface.php
@@ -4,7 +4,7 @@
 
 interface MetadataContainerInterface
 {
-    public function getMetadata(string $name): string|null;
+    public function getMetadata(string $name): ?string;
 
     public function getTemplatingContext(): array;
 }
diff --git a/lib/php/rendition-factory/src/FileFamilyGuesser.php b/lib/php/rendition-factory/src/FileFamilyGuesser.php
@@ -51,7 +51,7 @@ private function isAnimatedGif(string $src): bool
         $count = 0;
 
         while (!feof($fh) && $count < 2) {
-            $chunk = fread($fh, 1024 * 100); //read 100kb at a time
+            $chunk = fread($fh, 1024 * 100); // read 100kb at a time
             $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', $chunk);
         }
 
@@ -63,12 +63,12 @@ private function isAnimatedGif(string $src): bool
     private function isWebpAnimated(string $src): bool
     {
         $result = false;
-        $fh = fopen($src, "rb");
+        $fh = fopen($src, 'rb');
         fseek($fh, 12);
-        if (fread($fh, 4) === 'VP8X') {
+        if ('VP8X' === fread($fh, 4)) {
             fseek($fh, 16);
             $myByte = fread($fh, 1);
-            $result = (bool)(((ord($myByte) >> 1) & 1));
+            $result = (bool) ((ord($myByte) >> 1) & 1);
         }
         fclose($fh);
 

diff --git a/lib/php/rendition-factory/src/RenditionCreator.php b/lib/php/rendition-factory/src/RenditionCreator.php
@@ -34,25 +34,16 @@ public function createRendition(
         string $src,
         string $mimeType,
         BuildConfig $buildConfig,
-        ?CreateRenditionOptions $options = null
-    ): OutputFileInterface
-    {
+        ?CreateRenditionOptions $options = null,
+    ): OutputFileInterface {
         $inputFile = new InputFile($src, $mimeType, $this->fileFamilyGuesser->getFamily($src, $mimeType));
         if (null == $familyBuildConfig = $buildConfig->getFamily($inputFile->getFamily())) {
-            throw new \InvalidArgumentException(sprintf(
-                'No build config defined for family "%s" (type: "%s")',
-                $inputFile->getFamily()->value,
-                $mimeType,
-            ));
+            throw new \InvalidArgumentException(sprintf('No build config defined for family "%s" (type: "%s")', $inputFile->getFamily()->value, $mimeType));
         }
 
         $transformations = $familyBuildConfig->getTransformations();
         if (empty($transformations)) {
-            throw new \InvalidArgumentException(sprintf(
-                'No transformation defined for family "%s" (type: "%s")',
-                $inputFile->getFamily()->value,
-                $mimeType,
-            ));
+            throw new \InvalidArgumentException(sprintf('No transformation defined for family "%s" (type: "%s")', $inputFile->getFamily()->value, $mimeType));
         }
 
         $context = $this->contextFactory->create(
@@ -83,7 +74,7 @@ public function cleanUp(): void
 
     private static function recursiveRmDir(string $dir): void
     {
-        $files = array_diff(scandir($dir), array('.','..'));
+        $files = array_diff(scandir($dir), ['.', '..']);
         foreach ($files as $file) {
             $path = $dir.'/'.$file;
             if (is_dir($path)) {

diff --git a/lib/php/rendition-factory/src/Templating/MetadataAccessor.php b/lib/php/rendition-factory/src/Templating/MetadataAccessor.php
@@ -8,8 +8,7 @@
 {
     public function __construct(
         private TransformationContext $context,
-    )
-    {
+    ) {
     }
 
     public function offsetExists(mixed $offset): bool

diff --git a/lib/php/rendition-factory/src/Transformer/Image/Imagine/Filter/StampFilter.php b/lib/php/rendition-factory/src/Transformer/Image/Imagine/Filter/StampFilter.php
@@ -17,9 +17,8 @@ public function __construct(
         private TransformationContext $context,
         private ImagineInterface $imagine,
         private TemplateResolverInterface $templateResolver,
-        private string $fontDirectory = __DIR__.'/../../../../../fonts'
-    )
-    {
+        private string $fontDirectory = __DIR__.'/../../../../../fonts',
+    ) {
     }
 
     public function load(ImageInterface $image, array $options = [])

diff --git a/lib/php/rendition-factory/src/Transformer/Image/Imagine/ImagineFilterFactory.php b/lib/php/rendition-factory/src/Transformer/Image/Imagine/ImagineFilterFactory.php
@@ -31,8 +31,7 @@
     public function __construct(
         private ImagineInterface $imagine,
         private TemplateResolverInterface $templateResolver,
-    )
-    {
+    ) {
     }
 
     public function createFilterManager(TransformationContext $context): FilterManager
@@ -48,7 +47,7 @@ public function createFilterManager(TransformationContext $context): FilterManag
             'resize' => new ResizeFilterLoader(),
             'thumbnail' => new ThumbnailFilterLoader(),
             'crop' => new CropFilterLoader(),
-//            'grayscale' => new GrayscaleFilterLoader(), Disabled because too slow (OnPixelBased)
+            //            'grayscale' => new GrayscaleFilterLoader(), Disabled because too slow (OnPixelBased)
             'watermark' => new WatermarkDownloadProxyFilterLoader(
                 $context,
                 $this->imagine,

diff --git a/lib/php/rendition-factory/src/Transformer/Image/Imagine/ImagineTransformerModule.php b/lib/php/rendition-factory/src/Transformer/Image/Imagine/ImagineTransformerModule.php
@@ -15,8 +15,7 @@
 {
     public function __construct(
         private ImagineFilterFactory $filterFactory,
-    )
-    {
+    ) {
     }
 
     public static function getName(): string

diff --git a/...hp/rendition-factory/src/Transformer/Image/Imagine/WatermarkDownloadProxyFilterLoader.php b/...hp/rendition-factory/src/Transformer/Image/Imagine/WatermarkDownloadProxyFilterLoader.php
@@ -13,8 +13,7 @@
     public function __construct(
         private TransformationContext $context,
         private ImagineInterface $imagine,
-    )
-    {
+    ) {
     }
 
     public function load(ImageInterface $image, array $options = [])

diff --git a/lib/php/rendition-factory/src/Transformer/TransformationContext.php b/lib/php/rendition-factory/src/Transformer/TransformationContext.php
@@ -15,7 +15,7 @@ public function __construct(
         private MimeTypeGuesser $mimeTypeGuesser,
         private HttpClientInterface $client,
         private LoggerInterface $logger,
-        private ?MetadataContainerInterface $metadata = null
+        private ?MetadataContainerInterface $metadata = null,
     ) {
     }
 

diff --git a/lib/php/rendition-factory/src/Transformer/Video/FFMpeg/Format/Video/WebM.php b/lib/php/rendition-factory/src/Transformer/Video/FFMpeg/Format/Video/WebM.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Alchemy\RenditionFactory\Transformer\Video\FFMpeg\Format\Video;
+
+class WebM extends \FFMpeg\Format\Video\WebM
+{
+    protected $videoCodecs = [];
+
+    public function __construct($audioCodec = 'libvorbis', $videoCodec = 'libvpx')
+    {
+        $this->videoCodecs = parent::getAvailableVideoCodecs();
+        if (!in_array('copy', $this->videoCodecs)) {
+            $this->videoCodecs[] = 'copy';
+        }
+        parent::__construct($audioCodec, $videoCodec);
+    }
+
+    public function getAvailableVideoCodecs()
+    {
+        return $this->videoCodecs;
+    }
+}
diff --git a/lib/php/rendition-factory/src/Transformer/Video/FFMpeg/Format/Video/X264.php b/lib/php/rendition-factory/src/Transformer/Video/FFMpeg/Format/Video/X264.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Alchemy\RenditionFactory\Transformer\Video\FFMpeg\Format\Video;
+
+class X264 extends \FFMpeg\Format\Video\X264
+{
+    protected $videoCodecs = [];
+
+    public function __construct($audioCodec = 'aac', $videoCodec = 'libx264')
+    {
+        $this->videoCodecs = parent::getAvailableVideoCodecs();
+        if (!in_array('copy', $this->videoCodecs)) {
+            $this->videoCodecs[] = 'copy';
+        }
+        parent::__construct($audioCodec, $videoCodec);
+    }
+
+    public function getAvailableVideoCodecs()
+    {
+        return $this->videoCodecs;
+    }
+}