move video "formats" to video namespace ; fix documentation

alchemy-fr · Dec 4, 2024 · d7da0de · d7da0de
1 parent f0ff41e
commit d7da0de
Show file tree

Hide file tree

Showing 22 changed files with 51 additions and 52 deletions.
diff --git a/databox/api/src/Command/DocumentationDumperCommand.php b/databox/api/src/Command/DocumentationDumperCommand.php
@@ -8,7 +8,6 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-
 use Alchemy\RenditionFactory\DocumentationDumper as RenditionFactoryDocumentationDumper;
 
 
@@ -33,7 +32,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $output->writeln('# rendition factory');
+        $output->writeln('# ' . $this->renditionFactoryDocumentationDumper::getName());
         $output->writeln($this->renditionFactoryDocumentationDumper->dump());
 
         return 0;

diff --git a/lib/php/rendition-factory-bundle/Resources/config/services.yaml b/lib/php/rendition-factory-bundle/Resources/config/services.yaml
@@ -46,53 +46,53 @@ services:
             - { name: !php/const Alchemy\RenditionFactory\Transformer\TransformerModuleInterface::TAG }
 
     # Output "formats"
-    Alchemy\RenditionFactory\Format\JpegFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\JpegFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\MkvFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\MkvFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\Mpeg4Format:
+    Alchemy\RenditionFactory\Transformer\Video\Format\Mpeg4Format:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\MpegFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\MpegFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\QuicktimeFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\QuicktimeFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\WebmFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\WebmFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\AnimatedGifFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\AnimatedGifFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\AnimatedPngFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\AnimatedPngFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\AnimatedWebpFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\AnimatedWebpFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\WavFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\WavFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\AacFormat:
+    Alchemy\RenditionFactory\Transformer\Video\Format\AacFormat:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
-    Alchemy\RenditionFactory\Format\Mp3Format:
+    Alchemy\RenditionFactory\Transformer\Video\Format\Mp3Format:
         tags:
-            - { name: !php/const Alchemy\RenditionFactory\Format\FormatInterface::TAG }
+            - { name: !php/const Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface::TAG }
 
 
     Imagine\Imagick\Imagine: ~

diff --git a/lib/php/rendition-factory/src/DocumentationDumper.php b/lib/php/rendition-factory/src/DocumentationDumper.php
@@ -2,9 +2,9 @@
 
 namespace Alchemy\RenditionFactory;
 
-use Alchemy\RenditionFactory\Format\FormatInterface;
 use Alchemy\RenditionFactory\Transformer\Documentation;
 use Alchemy\RenditionFactory\Transformer\TransformerModuleInterface;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use Symfony\Component\Config\Definition\Dumper\YamlReferenceDumper;
 use Symfony\Component\DependencyInjection\Attribute\TaggedLocator;
 use Symfony\Component\DependencyInjection\ServiceLocator;
@@ -51,7 +51,7 @@ private function listFormats(): string
         }
         ksort($formats);
 
-        $text = '## Supported formats'."\n";
+        $text = "## Video transformers output `format`s.\n";
         $text .= "| Family | Format | Mime type | Extensions |\n";
         $text .= "|-|-|-|-|\n";
         foreach ($formats as $familyFormats) {

diff --git a/lib/php/rendition-factory/src/Transformer/Video/FFMpegTransformerModule.php b/lib/php/rendition-factory/src/Transformer/Video/FFMpegTransformerModule.php
@@ -8,10 +8,10 @@
 use Alchemy\RenditionFactory\DTO\InputFileInterface;
 use Alchemy\RenditionFactory\DTO\OutputFile;
 use Alchemy\RenditionFactory\DTO\OutputFileInterface;
-use Alchemy\RenditionFactory\Format\FormatInterface;
 use Alchemy\RenditionFactory\Transformer\Documentation;
 use Alchemy\RenditionFactory\Transformer\TransformerModuleInterface;
 use Alchemy\RenditionFactory\Transformer\Video\FFMpeg\Filter\ResizeFilter;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use FFMpeg;
 use FFMpeg\Coordinate\TimeCode;
 use FFMpeg\Format\FormatInterface as FFMpegFormatInterface;
@@ -74,7 +74,7 @@ public function buildConfiguration(NodeBuilder $builder): void
             ->arrayNode('options')
                 ->children()
                     ->scalarNode('format')
-                        ->info('output format')
+                        ->info('output format (see Video transformers output `format`s)')
                     ->end()
                     ->scalarNode('extension')
                         ->info('extension of the output file')

diff --git a/...endition-factory/src/Format/AacFormat.php → ...rc/Transformer/Video/Format/AacFormat.php b/...endition-factory/src/Format/AacFormat.php → ...rc/Transformer/Video/Format/AacFormat.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
-use Alchemy\RenditionFactory\Format\Audio\Aac;
+use Alchemy\RenditionFactory\Transformer\Video\Format\Audio\Aac;
 
 class AacFormat implements FormatInterface
 {

diff --git a/...-factory/src/Format/AnimatedGifFormat.php → ...former/Video/Format/AnimatedGifFormat.php b/...-factory/src/Format/AnimatedGifFormat.php → ...former/Video/Format/AnimatedGifFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 

diff --git a/...-factory/src/Format/AnimatedPngFormat.php → ...former/Video/Format/AnimatedPngFormat.php b/...-factory/src/Format/AnimatedPngFormat.php → ...former/Video/Format/AnimatedPngFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 

diff --git a/...factory/src/Format/AnimatedWebpFormat.php → ...ormer/Video/Format/AnimatedWebpFormat.php b/...factory/src/Format/AnimatedWebpFormat.php → ...ormer/Video/Format/AnimatedWebpFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 

diff --git a/...endition-factory/src/Format/Audio/Aac.php → ...rc/Transformer/Video/Format/Audio/Aac.php b/...endition-factory/src/Format/Audio/Aac.php → ...rc/Transformer/Video/Format/Audio/Aac.php
@@ -4,7 +4,7 @@
  * This file replaces FFMpeg\Format\Audio\aac because alpine lacks libfdk
  */
 
-namespace Alchemy\RenditionFactory\Format\Audio;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format\Audio;
 
 use FFMpeg\Format\Audio\DefaultAudio;
 

diff --git a/...on-factory/src/Format/FormatInterface.php → ...nsformer/Video/Format/FormatInterface.php b/...on-factory/src/Format/FormatInterface.php → ...nsformer/Video/Format/FormatInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 

diff --git a/...ndition-factory/src/Format/JpegFormat.php → ...c/Transformer/Video/Format/JpegFormat.php b/...ndition-factory/src/Format/JpegFormat.php → ...c/Transformer/Video/Format/JpegFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 

diff --git a/...endition-factory/src/Format/MkvFormat.php → ...rc/Transformer/Video/Format/MkvFormat.php b/...endition-factory/src/Format/MkvFormat.php → ...rc/Transformer/Video/Format/MkvFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Video\X264;

diff --git a/...endition-factory/src/Format/Mp3Format.php → ...rc/Transformer/Video/Format/Mp3Format.php b/...endition-factory/src/Format/Mp3Format.php → ...rc/Transformer/Video/Format/Mp3Format.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Audio\Mp3;

diff --git a/...dition-factory/src/Format/Mpeg4Format.php → .../Transformer/Video/Format/Mpeg4Format.php b/...dition-factory/src/Format/Mpeg4Format.php → .../Transformer/Video/Format/Mpeg4Format.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Video\X264;

diff --git a/...ndition-factory/src/Format/MpegFormat.php → ...c/Transformer/Video/Format/MpegFormat.php b/...ndition-factory/src/Format/MpegFormat.php → ...c/Transformer/Video/Format/MpegFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Video\X264;

diff --git a/...on-factory/src/Format/QuicktimeFormat.php → ...nsformer/Video/Format/QuicktimeFormat.php b/...on-factory/src/Format/QuicktimeFormat.php → ...nsformer/Video/Format/QuicktimeFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Video\X264;

diff --git a/...endition-factory/src/Format/WavFormat.php → ...rc/Transformer/Video/Format/WavFormat.php b/...endition-factory/src/Format/WavFormat.php → ...rc/Transformer/Video/Format/WavFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Audio\Wav;

diff --git a/...ndition-factory/src/Format/WebmFormat.php → ...c/Transformer/Video/Format/WebmFormat.php b/...ndition-factory/src/Format/WebmFormat.php → ...c/Transformer/Video/Format/WebmFormat.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Alchemy\RenditionFactory\Format;
+namespace Alchemy\RenditionFactory\Transformer\Video\Format;
 
 use Alchemy\RenditionFactory\DTO\FamilyEnum;
 use FFMpeg\Format\Video\WebM;

diff --git a/lib/php/rendition-factory/src/Transformer/Video/ModuleCommonArgs.php b/lib/php/rendition-factory/src/Transformer/Video/ModuleCommonArgs.php
@@ -4,7 +4,7 @@
 
 use Alchemy\RenditionFactory\Config\ModuleOptionsResolver;
 use Alchemy\RenditionFactory\Context\TransformationContextInterface;
-use Alchemy\RenditionFactory\Format\FormatInterface;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use FFMpeg;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 

diff --git a/lib/php/rendition-factory/src/Transformer/Video/VideoSummaryTransformerModule.php b/lib/php/rendition-factory/src/Transformer/Video/VideoSummaryTransformerModule.php
@@ -8,9 +8,9 @@
 use Alchemy\RenditionFactory\DTO\InputFileInterface;
 use Alchemy\RenditionFactory\DTO\OutputFile;
 use Alchemy\RenditionFactory\DTO\OutputFileInterface;
-use Alchemy\RenditionFactory\Format\FormatInterface;
 use Alchemy\RenditionFactory\Transformer\Documentation;
 use Alchemy\RenditionFactory\Transformer\TransformerModuleInterface;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use FFMpeg;
 use FFMpeg\Coordinate\TimeCode;
 use FFMpeg\Format\VideoInterface;
@@ -70,7 +70,7 @@ public function buildConfiguration(NodeBuilder $builder): void
                    ->end()
                    ->scalarNode('format')
                         ->isRequired()
-                        ->info('Output format')
+                        ->info('output format (see Video transformers output `format`s)')
                         ->example('video-mpeg')
                    ->end()
                     ->scalarNode('extension')

diff --git a/lib/php/rendition-factory/src/Transformer/Video/VideoToAnimationTransformerModule.php b/lib/php/rendition-factory/src/Transformer/Video/VideoToAnimationTransformerModule.php
@@ -8,9 +8,9 @@
 use Alchemy\RenditionFactory\DTO\InputFileInterface;
 use Alchemy\RenditionFactory\DTO\OutputFile;
 use Alchemy\RenditionFactory\DTO\OutputFileInterface;
-use Alchemy\RenditionFactory\Format\FormatInterface;
 use Alchemy\RenditionFactory\Transformer\Documentation;
 use Alchemy\RenditionFactory\Transformer\TransformerModuleInterface;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use FFMpeg;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
@@ -82,7 +82,7 @@ public function buildConfiguration(NodeBuilder $builder): void
                     ->end()
                     ->scalarNode('format')
                         ->isRequired()
-                        ->info('Output format')
+                        ->info('output format (see Video transformers output `format`s)')
                         ->example('animated-png')
                     ->end()
                     ->scalarNode('extension')

diff --git a/lib/php/rendition-factory/src/Transformer/Video/VideoToFrameTransformerModule.php b/lib/php/rendition-factory/src/Transformer/Video/VideoToFrameTransformerModule.php
@@ -8,9 +8,9 @@
 use Alchemy\RenditionFactory\DTO\InputFileInterface;
 use Alchemy\RenditionFactory\DTO\OutputFile;
 use Alchemy\RenditionFactory\DTO\OutputFileInterface;
-use Alchemy\RenditionFactory\Format\FormatInterface;
 use Alchemy\RenditionFactory\Transformer\Documentation;
 use Alchemy\RenditionFactory\Transformer\TransformerModuleInterface;
+use Alchemy\RenditionFactory\Transformer\Video\Format\FormatInterface;
 use FFMpeg\Media\Video;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
@@ -54,7 +54,7 @@ public function buildConfiguration(NodeBuilder $builder): void
                     ->end()
                     ->scalarNode('format')
                         ->isRequired()
-                        ->info('Output format')
+                        ->info('output format (see Video transformers output `format`s)')
                         ->example('image-jpeg')
                     ->end()
                     ->scalarNode('extension')