From d7da0de218a701188fade663a1fc10bfbcf6bb58 Mon Sep 17 00:00:00 2001 From: jygaulier Date: Wed, 4 Dec 2024 09:37:34 +0100 Subject: [PATCH] move video "formats" to video namespace ; fix documentation --- .../Command/DocumentationDumperCommand.php | 3 +- .../Resources/config/services.yaml | 48 +++++++++---------- .../src/DocumentationDumper.php | 4 +- .../Video/FFMpegTransformerModule.php | 4 +- .../Video}/Format/AacFormat.php | 4 +- .../Video}/Format/AnimatedGifFormat.php | 2 +- .../Video}/Format/AnimatedPngFormat.php | 2 +- .../Video}/Format/AnimatedWebpFormat.php | 2 +- .../Video}/Format/Audio/Aac.php | 2 +- .../Video}/Format/FormatInterface.php | 2 +- .../Video}/Format/JpegFormat.php | 2 +- .../Video}/Format/MkvFormat.php | 2 +- .../Video}/Format/Mp3Format.php | 2 +- .../Video}/Format/Mpeg4Format.php | 2 +- .../Video}/Format/MpegFormat.php | 2 +- .../Video}/Format/QuicktimeFormat.php | 2 +- .../Video}/Format/WavFormat.php | 2 +- .../Video}/Format/WebmFormat.php | 2 +- .../Transformer/Video/ModuleCommonArgs.php | 2 +- .../Video/VideoSummaryTransformerModule.php | 4 +- .../VideoToAnimationTransformerModule.php | 4 +- .../Video/VideoToFrameTransformerModule.php | 4 +- 22 files changed, 51 insertions(+), 52 deletions(-) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/AacFormat.php (84%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/AnimatedGifFormat.php (88%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/AnimatedPngFormat.php (89%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/AnimatedWebpFormat.php (88%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/Audio/Aac.php (84%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/FormatInterface.php (85%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/JpegFormat.php (88%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/MkvFormat.php (92%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/Mp3Format.php (91%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/Mpeg4Format.php (92%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/MpegFormat.php (92%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/QuicktimeFormat.php (92%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/WavFormat.php (91%) rename lib/php/rendition-factory/src/{ => Transformer/Video}/Format/WebmFormat.php (92%) diff --git a/databox/api/src/Command/DocumentationDumperCommand.php b/databox/api/src/Command/DocumentationDumperCommand.php index 2f8c49a99..d08905d68 100644 --- 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 index 47522f5a9..36fff1986 100644 --- 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 index e4c01fdd8..5bec29b1b 100644 --- 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 index 71b423bf5..e803112b2 100644 --- 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/lib/php/rendition-factory/src/Format/AacFormat.php b/lib/php/rendition-factory/src/Transformer/Video/Format/AacFormat.php similarity index 84% rename from lib/php/rendition-factory/src/Format/AacFormat.php rename to lib/php/rendition-factory/src/Transformer/Video/Format/AacFormat.php index 16b4188bd..acb738e29 100644 --- a/lib/php/rendition-factory/src/Format/AacFormat.php +++ b/lib/php/rendition-factory/src/Transformer/Video/Format/AacFormat.php @@ -1,9 +1,9 @@ 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 index bba56dfb2..0cd18d354 100644 --- 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 index cebf7dfd1..7937bed50 100644 --- 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')