Fix: Allow sub-second/float timecode

kitodo · Jul 1, 2022 · 23ff2a0 · 23ff2a0
1 parent 826a5b3
commit 23ff2a0
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 5 deletions.
diff --git a/Classes/Common/Helper.php b/Classes/Common/Helper.php
@@ -659,8 +659,10 @@ public static function renderFlashMessages($queue = 'kitodo.default.flashMessage
      * - `hh:mm:ss`
      * - `mm:ss`
      * - `ss`
+     *
+     * Floating point values may be used.
      */
-    public static function timecodeToSeconds(string $timecode): int
+    public static function timecodeToSeconds(string $timecode): float
     {
         $parts = explode(":", $timecode);
 
@@ -669,7 +671,7 @@ public static function timecodeToSeconds(string $timecode): int
 
         // Iterate through $parts reversely
         for ($i = count($parts) - 1; $i >= 0; $i--) {
-            $totalSeconds += $factor * $parts[$i];
+            $totalSeconds += $factor * (float) $parts[$i];
             $factor *= 60;
         }
 

diff --git a/Documentation/Features/MediaPlayer/METS.rst b/Documentation/Features/MediaPlayer/METS.rst
@@ -16,6 +16,8 @@ Only the begin is used.
      </mets:fptr>
    </mets:div>
 
+Fractional timecodes (e.g., ``00:06:04.5``) may be used.
+
 Multiple Sources
 ================
 

diff --git a/Tests/Fixtures/MetsDocument/av_beispiel.xml b/Tests/Fixtures/MetsDocument/av_beispiel.xml
@@ -198,10 +198,10 @@
             </mets:div>
             <mets:div ID="PHYS_0002" ORDER="2" TYPE="track">
                 <mets:fptr>
-                    <mets:area FILEID="FILE_0000_DEFAULT_MOV" BEGIN="00:00:20" BETYPE="TIME" EXTENT="00:00:20" EXTTYPE="TIME"></mets:area>
+                    <mets:area FILEID="FILE_0000_DEFAULT_MOV" BEGIN="00:00:20.5" BETYPE="TIME" EXTENT="00:00:20" EXTTYPE="TIME"></mets:area>
                 </mets:fptr>
                 <mets:fptr>
-                    <mets:area FILEID="FILE_0000_DEFAULT_MP4" BEGIN="00:00:20" BETYPE="TIME" EXTENT="00:00:20" EXTTYPE="TIME"></mets:area>
+                    <mets:area FILEID="FILE_0000_DEFAULT_MP4" BEGIN="00:00:20.5" BETYPE="TIME" EXTENT="00:00:20" EXTTYPE="TIME"></mets:area>
                 </mets:fptr>
             </mets:div>
             <mets:div ID="PHYS_0003" ORDER="3" TYPE="track">

diff --git a/Tests/Functional/Common/MetsDocumentTest.php b/Tests/Functional/Common/MetsDocumentTest.php
@@ -74,7 +74,7 @@ public function canGetLogicalStructure()
                     'admId' => '',
                     'videoChapter' => [
                         'fileId' => 'FILE_0000_DEFAULT_MOV',
-                        'timecode' => 20,
+                        'timecode' => 20.5,
                     ],
                 ],
                 [

diff --git a/Tests/Unit/Common/HelperTest.php b/Tests/Unit/Common/HelperTest.php
@@ -45,4 +45,15 @@ public function validXmlIsAccepted(): void
         $this->assertIsObject($node);
         $this->assertEquals('root', $node->getName());
     }
+
+    /**
+     * @test
+     * @group timecodeToSeconds
+     */
+    public function canConvertTimecode()
+    {
+        $this->assertEquals(20, Helper::timecodeToSeconds('20'));
+        $this->assertEquals(20.5, Helper::timecodeToSeconds('20.5'));
+        $this->assertEquals(80.5, Helper::timecodeToSeconds('1:20.5'));
+    }
 }