Update MediaPlayer to support audio and video file detection

fschoelzel · fschoelzel · commit e975562a238b · 2026-03-17T17:36:49.000+01:00
- use Audio and Video Use Groups
- refactor `MediaplayerController` using media instead of video
diff --git a/Classes/Controller/MediaPlayerController.php b/Classes/Controller/MediaPlayerController.php
@@ -50,152 +50,155 @@ public function mainAction(): ResponseInterface
 
         $doc = $this->document->getCurrentDocument();
         $pageNo = $this->requestData['page'];
-        $video = $this->getVideoInfo($doc, $pageNo);
-        if ($video === null) {
+        $media = $this->getMediaplayerInfo($doc, $pageNo);
+        if ($media === null) {
             return $this->htmlResponse();
         }
 
         $this->addPlayerAssets();
 
-        $this->view->assign('video', $video);
+        $this->view->assign('media', $media);
 
         return $this->htmlResponse();
     }
 
     /**
-     * Build video info to be passed to the player template.
+     * Build Mediaplayer info to be passed to the player template.
      *
      * @param AbstractDocument $doc
      * @param int $pageNo
      *
-     * @return ?mixed[] The video data, or `null` if no video source is found
+     * @return ?mixed[] The Mediaplayer data, or `null` if no audio/video-media source is found
      */
-    protected function getVideoInfo(AbstractDocument $doc, int $pageNo): ?array
+    protected function getMediaplayerInfo(AbstractDocument $doc, int $pageNo): ?array
     {
-        // Get image file use groups
-        $imageUseGroups = $this->useGroupsConfiguration->getImage();
+        // Get audio file use groups
+        $audioUseGroups = $this->useGroupsConfiguration->getAudio();
         // Get video file use groups
         $videoUseGroups = $this->useGroupsConfiguration->getVideo();
         $mainVideoUseGroup = $videoUseGroups[0] ?? '';
+        // Merge audio and video file use groups without duplicates
+        $mediaplayerUseGroups = array_unique([...$audioUseGroups, ...$videoUseGroups]);
 
         // Get thumbnail file use groups
         $thumbnailUseGroups = $this->useGroupsConfiguration->getThumbnail();
-
         // Get waveform file use groups
         $waveformUseGroups = $this->useGroupsConfiguration->getWaveform();
+        // Get image file use groups
+        $imageUseGroups = $this->useGroupsConfiguration->getImage();
 
-        // Collect video file source URLs
+        // Collect audio/video-media file source URLs
         // TODO: This is for multiple sources (MPD, HLS, MP3, ...) - revisit, make sure it's ordered by preference!
-        $videoSources = $this->collectVideoSources($doc, $pageNo, $videoUseGroups);
-        if (empty($videoSources)) {
+        $mediaplayerSources = $this->collectMediaSources($doc, $pageNo, $mediaplayerUseGroups);
+        if (empty($mediaplayerSources)) {
             return null;
         }
 
         // List all chapters for chapter markers
-        $videoChapters = $this->collectVideoChapters($doc);
+        $mediaChapters = $this->collectMediaChapters($doc);
 
-        // Get additional video URLs
-        $videoUrl = $this->collectAdditionalVideoUrls($doc, $pageNo, $thumbnailUseGroups, $waveformUseGroups, $imageUseGroups);
+        // Get additional audio/video-media URLs
+        $mediaUrl = $this->collectAdditionalMediaUrls($doc, $pageNo, $thumbnailUseGroups, $waveformUseGroups, $imageUseGroups);
 
         return [
-            'start' => $videoChapters[$pageNo - 1]['timecode'] ?? '',
-            'mode' => $this->determineInitialMode($videoSources, $mainVideoUseGroup),
-            'chapters' => $videoChapters,
+            'start' => $mediaChapters[$pageNo - 1]['timecode'] ?? '',
+            'mode' => $this->determineInitialMode($mediaplayerSources, $mainVideoUseGroup),
+            'chapters' => $mediaChapters,
             'metadata' => $doc->getToplevelMetadata(),
-            'sources' => $videoSources,
-            'url' => $videoUrl,
+            'sources' => $mediaplayerSources,
+            'url' => $mediaUrl,
         ];
     }
 
     /**
-     * Collects video sources for the given document.
+     * Collects Audio/Video-Media sources for the given document.
      *
-     * @param AbstractDocument $doc The document object to collect video sources from
-     * @param int $pageNo The page number to collect video sources for
-     * @param string[] $videoUseGroups The array of video use groups to search for video sources
+     * @param AbstractDocument $doc The document object to collect media sources from
+     * @param int $pageNo The page number to collect media sources for
+     * @param string[] $mediaplayerUseGroups The array of mediaplayer use groups to search for media sources
      *
-     * @return mixed[] An array of video sources with details like MIME type, URL, file ID, and frame rate
+     * @return mixed[] An array of media sources with details like MIME type, URL, file ID, and frame rate
      */
-    private function collectVideoSources(AbstractDocument $doc, int $pageNo, array $videoUseGroups): array
+    private function collectMediaSources(AbstractDocument $doc, int $pageNo, array $mediaplayerUseGroups): array
     {
-        $videoSources = [];
-        $videoFiles = $this->findFiles($doc, $pageNo, $videoUseGroups);
-        foreach ($videoFiles as $videoFile) {
-            if ($this->isMediaMime($videoFile['mimeType'])) {
-                $fileMetadata = $doc->getMetadata($videoFile['fileId']);
+        $mediaplayerSources = [];
+        $mediaFiles = $this->findFiles($doc, $pageNo, $mediaplayerUseGroups);
+        foreach ($mediaFiles as $mediaFile) {
+            if ($this->isMediaMime($mediaFile['mimeType'])) {
+                $fileMetadata = $doc->getMetadata($mediaFile['fileId']);
 
-                $videoSources[] = [
-                    'fileGrp' => $videoFile['fileGrp'],
-                    'mimeType' => $videoFile['mimeType'],
-                    'url' => $videoFile['url'],
-                    'fileId' => $videoFile['fileId'],
+                $mediaplayerSources[] = [
+                    'fileGrp' => $mediaFile['fileGrp'],
+                    'mimeType' => $mediaFile['mimeType'],
+                    'url' => $mediaFile['url'],
+                    'fileId' => $mediaFile['fileId'],
                     'frameRate' => $fileMetadata['video_frame_rate'][0] ?? '',
                 ];
             }
         }
-        return $videoSources;
+        return $mediaplayerSources;
     }
 
     /**
-     * Determine the initial mode (video or audio) based on the provided video sources and the main video use group.
+     * Determine the initial mode (video or audio) based on the provided audio/video-media sources and the main video use group.
      *
-     * @param mixed[] $videoSources An array of video sources with details like MIME type, URL, file ID, and frame rate
+     * @param mixed[] $mediaplayerSources An array of media sources with details like MIME type, URL, file ID, and frame rate
      * @param string $mainVideoUseGroup The main video use group to prioritize
      *
      * @return string The initial mode ('video' or 'audio')
      */
-    private function determineInitialMode(array $videoSources, string $mainVideoUseGroup): string
+    private function determineInitialMode(array $mediaplayerSources, string $mainVideoUseGroup): string
     {
-        foreach ($videoSources as $videoSource) {
+        foreach ($mediaplayerSources as $mediaplayerSource) {
             // TODO: Better guess of initial mode?
             //       Perhaps we could look for VIDEOMD/AUDIOMD in METS
-            if ($videoSource['fileGrp'] === $mainVideoUseGroup || str_starts_with($videoSource['mimeType'], 'video/')) {
+            if ($mediaplayerSource['fileGrp'] === $mainVideoUseGroup || str_starts_with($mediaplayerSource['mimeType'], 'video/')) {
                 return 'video';
             }
         }
         return 'audio';
     }
 
     /**
-     * Collects all video chapters for chapter markers from the given AbstractDocument.
+     * Collects all audio/video-media chapters for chapter markers from the given AbstractDocument.
      *
-     * @param AbstractDocument $doc The AbstractDocument object to collect video chapters from
+     * @param AbstractDocument $doc The AbstractDocument object to collect media chapters from
      *
-     * @return mixed[] An array of video chapters with details like file IDs, page numbers, titles, and timecodes
+     * @return mixed[] An array of media chapters with details like file IDs, page numbers, titles, and timecodes
      */
-    private function collectVideoChapters(AbstractDocument $doc): array
+    private function collectMediaChapters(AbstractDocument $doc): array
     {
-        $videoChapters = [];
+        $mediaChapters = [];
         foreach ($doc->tableOfContents as $entry) {
-            $this->recurseChapters($entry, $videoChapters);
+            $this->recurseChapters($entry, $mediaChapters);
         }
-        return $videoChapters;
+        return $mediaChapters;
     }
 
     /**
-     * Collects additional video URLs like poster and waveform for a given document, page number, thumb file use groups, and waveform file use groups.
+     * Collects additional audio/video-media URLs like poster and waveform for a given document, page number, thumb file use groups, and waveform file use groups.
      *
      * @param AbstractDocument $doc The document object
      * @param int $pageNo The page number
      * @param string[] $thumbnailUseGroups An array of thumb file use groups
      * @param string[] $waveformUseGroups An array of waveform file use groups
      * @param string[] $imageUseGroups An array of image file use groups
      *
-     * @return mixed[] An array containing additional video URLs like poster and waveform
+     * @return mixed[] An array containing additional audio/video-media URLs like poster and waveform
      */
-    private function collectAdditionalVideoUrls(AbstractDocument $doc, int $pageNo, array $thumbnailUseGroups, array $waveformUseGroups, array $imageUseGroups): array
+    private function collectAdditionalMediaUrls(AbstractDocument $doc, int $pageNo, array $thumbnailUseGroups, array $waveformUseGroups, array $imageUseGroups): array
     {
-        $videoUrl = [];
+        $mediaUrl = [];
 
         $showPoster = $this->settings['constants']['showPoster'] ?? null;
         $thumbFiles = $this->findFiles($doc, 0, $thumbnailUseGroups); // 0 = for whole video (not just chapter)
         if (!empty($thumbFiles) && (int) $showPoster === 1) {
-            $videoUrl['poster'] = $thumbFiles[0];
+            $mediaUrl['poster'] = $thumbFiles[0];
         }
 
         $waveformFiles = $this->findFiles($doc, $pageNo, $waveformUseGroups);
         if (!empty($waveformFiles)) {
-            $videoUrl['waveform'] = $waveformFiles[0];
+            $mediaUrl['waveform'] = $waveformFiles[0];
         }
 
         $showAudioLabelImage = $this->settings['constants']['showAudioLabelImage'] ?? null;
@@ -204,10 +207,10 @@ private function collectAdditionalVideoUrls(AbstractDocument $doc, int $pageNo,
             && (int) $showAudioLabelImage === 1
             && Helper::filterFilesByMimeType($audioLabelImageFiles[0], ['image'], ['JPG'], 'mimeType')
         ) {
-            $videoUrl['audioLabelImage'] = $audioLabelImageFiles[0];
+            $mediaUrl['audioLabelImage'] = $audioLabelImageFiles[0];
         }
 
-        return $videoUrl;
+        return $mediaUrl;
     }
 
     /**
diff --git a/Classes/ViewHelpers/MediaPlayerConfigViewHelper.php b/Classes/ViewHelpers/MediaPlayerConfigViewHelper.php
@@ -136,10 +136,8 @@ private static function getTranslations(SiteLanguage $language, string $translat
                 // - Pass $languageKey to ensure that translation matches ISO code
                 $phrases[$translationKey] = LocalizationUtility::translate(
                     "LLL:$translationFile:$translationKey",
-                    /* extensionName= */
-                    null,
-                    /* arguments= */
-                    null,
+                    null, // extensionName
+                    null, // arguments
                     $languageKey
                 );
             }
diff --git a/Configuration/FlexForms/MediaPlayer.xml b/Configuration/FlexForms/MediaPlayer.xml
@@ -32,7 +32,7 @@
                         <config>
                             <type>input</type>
                             <eval>required,alphanum_x,nospace</eval>
-                            <default>tx-dlf-video</default>
+                            <default>tx-dlf-media</default>
                         </config>
                     </settings.elementId>
                     <settings.shareButtons>
diff --git a/Documentation/Plugins/Index.rst b/Documentation/Plugins/Index.rst
@@ -566,7 +566,7 @@ FlexForm Configuration
 Media Player
 ------------
 
-The MediaPlayer plugin is only active if the selected document has valid video file use groups (useGroupsVideo).
+The MediaPlayer plugin is only active if the selected document has valid audio or video file use groups (useGroupsAudio, useGroupsVideo).
 
 :typoscript:`plugin.tx_dlf_mediaplayer.settings.`
 
@@ -596,7 +596,7 @@ The MediaPlayer plugin is only active if the selected document has valid video f
    :Data Type:
       :ref:`t3tsref:data-type-string`
    :Default:
-      tx-dlf-video
+      tx-dlf-media
    :Description:
       ID value of the HTML element for the media player.
 
diff --git a/Resources/Private/Less/SlubMediaPlayer/SlubMediaPlayer.less b/Resources/Private/Less/SlubMediaPlayer/SlubMediaPlayer.less
@@ -16,7 +16,8 @@ slub-media {
     }
 }
 
-body[data-has-video] {
+// hide irrelevant controls when a/v mediaplayer is present (e.g. doublepage, rotate, zoom)
+body[mediaplayer] {
     .page-control,
     .document-functions li.doublepage,
     .view-functions li.rotate,
diff --git a/Resources/Private/Templates/MediaPlayer/Main.html b/Resources/Private/Templates/MediaPlayer/Main.html
@@ -3,9 +3,9 @@
       data-namespace-typo3-fluid="true"
       lang="en">
 
-<f:if condition="{video}">
+<f:if condition="{media}">
     <script>
-        document.body.setAttribute("data-has-video", "yes");
+        document.body.setAttribute("mediaplayer", "yes");
     </script>
 
     <kitodo:mediaPlayerConfig id="MEDIA_CONFIG" settings="{settings}" />
@@ -14,12 +14,12 @@
         <div class="media-panel">
             <!-- Wrapper panels for toolbox toggles -->
             <div class="media-panel-wrappers">
-                <f:if condition="{settings.constants.showAudioLabelImage} == 1 && {video.url.audioLabelImage}">
+                <f:if condition="{settings.constants.showAudioLabelImage} == 1 && {media.url.audioLabelImage}">
                     <div id="panel-audiolabelimage" class="panel panel-audiolabelimage visible" data-panel="audiolabelimage">
                         <div class="audiolabelimage-inner">
-                            <div class="audiolabelimage-bg" style="background-image: url('{video.url.audioLabelImage.url}');"></div>
+                            <div class="audiolabelimage-bg" style="background-image: url('{media.url.audioLabelImage.url}');"></div>
                             <div class="audiolabelimage-art">
-                                <img src="{video.url.audioLabelImage.url}" alt="Audio Label Image">
+                                <img src="{media.url.audioLabelImage.url}" alt="Audio Label Image">
                             </div>
                         </div>
                     </div>
@@ -54,21 +54,21 @@
         </div>
 
         <div id="tx-dlf-view" class="tx-dlf-view">
-            <f:if condition="{video.url.waveform}">
-                <dlf-waveform hidden id="{settings.elementId}-waveform" forPlayer="{settings.elementId}" src="{video.url.waveform.url}" type="{video.url.waveform.mimeType}"></dlf-waveform>
+            <f:if condition="{media.url.waveform}">
+                <dlf-waveform hidden id="{settings.elementId}-waveform" forPlayer="{settings.elementId}" src="{media.url.waveform.url}" type="{media.url.waveform.mimeType}"></dlf-waveform>
             </f:if>
 
-            <slub-media id="{settings.elementId}" player-view="combined-container" poster="{video.url.poster.url}" config="MEDIA_CONFIG" start="{video.start}" mode="auto" mode-fallback="{video.mode}">
+            <slub-media id="{settings.elementId}" player-view="combined-container" poster="{media.url.poster.url}" config="MEDIA_CONFIG" start="{media.start}" mode="auto" mode-fallback="{media.mode}">
                 <f:comment>NOTE: If one of these doesn't exist, the player will try the next one.</f:comment>
-                <f:for each="{video.sources}" as="source">
+                <f:for each="{media.sources}" as="source">
                     <source src="{source.url}" type="{source.mimeType}" data-fps="{source.frameRate}" data-fileid="{source.fileId}">
                 </f:for>
 
-                <f:for each="{video.chapters}" as="chapter">
+                <f:for each="{media.chapters}" as="chapter">
                     <dlf-chapter title="{chapter.title}" timecode="{chapter.timecode}" fileids="{chapter.fileIdsJoin}" pageNo="{chapter.pageNo}"></dlf-chapter>
                 </f:for>
 
-                <f:for each="{video.metadata}" as="values" key="key">
+                <f:for each="{media.metadata}" as="values" key="key">
                     <f:for each="{values}" as="value">
                         <dlf-meta key="{key}" value="{value}"></dlf-meta>
                     </f:for>
@@ -77,7 +77,7 @@
                 <dlf-media-controls>
                     <button data-type="volume"></button>
                     <button data-type="mute"></button>
-                    <f:if condition="{video.url.waveform}">
+                    <f:if condition="{media.url.waveform}">
                         <button class="material-icons-round sxnd-waveform-button" data-t-title="control.waveform.tooltip" data-action="sound_tools.waveform.toggle">graphic_eq</button>
                     </f:if>
                     <button class="material-icons-round sxnd-screenshot-button" data-t-title="control.screenshot.tooltip" data-action="modal.screenshot.open">photo_camera</button>

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@ slub-media {`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
`19`		`-body[data-has-video] {`
	`19`	`+// hide irrelevant controls when a/v mediaplayer is present (e.g. doublepage, rotate, zoom)`
	`20`	`+body[mediaplayer] {`
`20`	`21`	`.page-control,`
`21`	`22`	`.document-functions li.doublepage,`
`22`	`23`	`.view-functions li.rotate,`