From ecd33b60cfd29085635684409e885e3b74ca8bc3 Mon Sep 17 00:00:00 2001
From: Carolina Ziegler <ziegler@elan-ev.de>
Date: Mon, 15 Dec 2025 16:41:01 +0100
Subject: [PATCH] Generate Subtitles outside of partial-publish

Generates Subtitles once in schedule-and-upload.
---
 .../partial-generate-captions-whisper.xml     |  65 ++++
 .../files/etc/workflows/partial-publish.xml   | 317 ------------------
 .../etc/workflows/schedule-and-upload.xml     |  23 ++
 3 files changed, 88 insertions(+), 317 deletions(-)
 create mode 100644 roles/opencast/files/etc/workflows/partial-generate-captions-whisper.xml
 delete mode 100644 roles/opencast/files/etc/workflows/partial-publish.xml

diff --git a/roles/opencast/files/etc/workflows/partial-generate-captions-whisper.xml b/roles/opencast/files/etc/workflows/partial-generate-captions-whisper.xml
new file mode 100644
index 0000000..b776e38
--- /dev/null
+++ b/roles/opencast/files/etc/workflows/partial-generate-captions-whisper.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definition xmlns="http://workflow.opencastproject.org">
+    <id>partial-generate-captions-whisper</id>
+    <title>Generate Captions with Whisper</title>
+    <operations>
+
+        <!-- set default variables -->
+        <operation
+            id="defaults"
+            description="Applying default values">
+            <configurations>
+                <configuration key="captions_source_hastag_lang:en">false</configuration>
+            </configurations>
+        </operation>
+
+        <!-- delete old generated captions -->
+        <operation
+            id="tag"
+            description="Delete old captions">
+            <configurations>
+                <configuration key="source-tags">subtitle</configuration>
+                <configuration key="target-tags">-archive</configuration>
+            </configurations>
+        </operation>
+
+        <!-- generate captions in original audio language -->
+        <operation
+            id="speechtotext"
+            description="Generate subtitles (original language) via Whisper">
+            <configurations>
+                <configuration key="source-flavor">*/source</configuration>
+                <configuration key="target-flavor">captions/source</configuration>
+                <configuration key="target-tags">archive,subtitle</configuration>
+                <configuration key="limit-to-one">true</configuration>
+                <configuration key="track-selection-strategy">try_presenter_first</configuration>
+            </configurations>
+        </operation>
+
+        <!-- analyze the language of the generated subtitles -->
+        <operation
+            id="analyze-mediapackage"
+            description="Analyze media package and set control variables">
+            <configurations>
+                <configuration key="source-flavors">captions/source</configuration>
+                <configuration key="set-tag-variables">true</configuration>
+            </configurations>
+        </operation>
+
+        <!-- generate captions in english translation of original audio language -->
+        <operation
+            id="speechtotext"
+            description="Generate subtitles (english translation) via Whisper"
+            if="NOT ${captions_source_hastag_lang\:en}">
+            <configurations>
+                <configuration key="source-flavor">*/source</configuration>
+                <configuration key="target-flavor">captions/source</configuration>
+                <configuration key="target-tags">archive,subtitle</configuration>
+                <configuration key="translate">true</configuration>
+                <configuration key="limit-to-one">true</configuration>
+                <configuration key="track-selection-strategy">try_presenter_first</configuration>
+            </configurations>
+        </operation>
+
+    </operations>
+</definition>
\ No newline at end of file
diff --git a/roles/opencast/files/etc/workflows/partial-publish.xml b/roles/opencast/files/etc/workflows/partial-publish.xml
deleted file mode 100644
index 5537d08..0000000
--- a/roles/opencast/files/etc/workflows/partial-publish.xml
+++ /dev/null
@@ -1,317 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<definition xmlns="http://workflow.opencastproject.org">
-
-  <id>partial-publish</id>
-  <title>Publish the recording</title>
-  <operations>
-
-    <operation
-      id="select-tracks"
-      exception-handler-workflow="partial-error"
-      description="Selecting audio/video streams for processing">
-      <configurations>
-        <configuration key="source-flavor">*/source</configuration>
-        <configuration key="target-flavor">*/work</configuration>
-        <configuration key="target-tags">-archive</configuration>
-        <configuration key="audio-muxing">duplicate</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-      id="analyze-tracks"
-      exception-handler-workflow="partial-error"
-      description="Analyzing tracks in media package and setting control variables">
-      <configurations>
-        <configuration key="source-flavor">*/work</configuration>
-      </configurations>
-    </operation>
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Cut the video according the SMIL file                             -->
-    <!--                                                                   -->
-    <!-- Perform cutting according to the edit decision list.              -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <operation
-      id="clone"
-      exception-handler-workflow="partial-error"
-      description="Creating working copy of the cutting information">
-      <configurations>
-        <configuration key="source-flavor">smil/cutting</configuration>
-        <configuration key="target-flavor">smil/tmp</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-      id="editor"
-      exception-handler-workflow="partial-error"
-      description="Cutting the recording according to the edit decision list">
-      <configurations>
-        <configuration key="source-flavors">*/work</configuration>
-        <configuration key="smil-flavors">smil/tmp</configuration>
-        <configuration key="target-smil-flavor">smil/tmp</configuration>
-        <configuration key="target-flavor-subtype">trimmed</configuration>
-        <configuration key="interactive">false</configuration>
-      </configurations>
-    </operation>
-
-
-
-    <!-- Generate subtitles with whisper -->
-    <operation
-        id="speechtotext"
-        description="Generates subtitles via Whisper">
-        <configurations>
-            <configuration key="source-flavor">*/source</configuration>
-            <configuration key="target-flavor">captions/source</configuration>
-            <configuration key="target-tags">archive,subtitle,engage-download</configuration>
-            <configuration key="limit-to-one">true</configuration>
-            <configuration key="track-selection-strategy">try_presenter_first</configuration>
-        </configurations>
-    </operation>
-
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Extract preview images                                            -->
-    <!--                                                                   -->
-    <!-- From the edited recording, take preview images for the player,    -->
-    <!-- search results etc.                                               -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <!-- Encode to engage search result thumbnails -->
-
-    <operation
-      id="image"
-      exception-handler-workflow="partial-error"
-      description="Creating search result default thumbnails">
-      <configurations>
-        <configuration key="source-flavor">*/trimmed</configuration>
-        <configuration key="target-flavor">*/search+preview</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-        <configuration key="encoding-profile">search-cover.http</configuration>
-        <configuration key="time">3</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Encode to engage player preview images -->
-
-    <operation
-      id="image"
-      if="NOT ${presentation/thumbnail_edited}"
-      exception-handler-workflow="partial-error"
-      description="Creating player preview image for presentation video">
-      <configurations>
-        <configuration key="source-flavor">presentation/trimmed</configuration>
-        <configuration key="target-flavor">presentation/player+preview</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-        <configuration key="encoding-profile">player-preview.http</configuration>
-        <configuration key="time">3</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-        id="tag"
-        if="${presentation/thumbnail_edited}"
-        exception-handler-workflow="partial-error"
-        description="Prepare thumbnail for publication">
-      <configurations>
-        <configuration key="source-flavor">presentation/player+preview</configuration>
-        <configuration key="target-tags">+engage-download</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Create a cover image -->
-
-    <operation
-      id="image"
-      if="NOT ${presenter/thumbnail_edited}"
-      exception-handler-workflow="partial-error"
-      description="Creating player preview image for presenter video">
-      <configurations>
-        <configuration key="source-flavor">presenter/trimmed</configuration>
-        <configuration key="target-flavor">presenter/player+preview</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-        <configuration key="encoding-profile">player-preview.http</configuration>
-        <configuration key="time">3</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-      id="cover-image"
-      if="NOT (${presenter_work_video} OR $ ${presentation_work_video} OR ${presentation/thumbnail_edited}) AND (${presenter_work_audio} OR ${presentation_work_audio})"
-      description="Create a cover image for audio-only files">
-      <configurations>
-        <configuration key="stylesheet">file://${karaf.etc}/branding/coverimage.xsl</configuration>
-        <configuration key="width">1920</configuration>
-        <configuration key="height">1080</configuration>
-        <configuration key="posterimage-flavor">presenter/coverbackground</configuration>
-        <configuration key="target-flavor">presenter/player+preview</configuration>
-        <configuration key="target-tags">archive, engage-download</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-        id="tag"
-        if="${presenter/thumbnail_edited}"
-        exception-handler-workflow="partial-error"
-        description="Prepare thumbnail for publication">
-      <configurations>
-        <configuration key="source-flavor">presenter/player+preview</configuration>
-        <configuration key="target-tags">+engage-download</configuration>
-      </configurations>
-    </operation>
-
-
-    <!-- Generate timeline preview images -->
-
-    <operation
-      id="timelinepreviews"
-      if="(${presenter_work_video} OR $ ${presentation_work_video})"
-      fail-on-error="false"
-      exception-handler-workflow="partial-error"
-      description="Creating timeline preview images">
-      <configurations>
-        <configuration key="source-flavor">*/trimmed</configuration>
-        <configuration key="target-flavor">*/timeline+preview</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-        <configuration key="image-count">100</configuration>
-      </configurations>
-    </operation>
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Apply theming                                                     -->
-    <!--                                                                   -->
-    <!-- Add trailer and bumper to the recording prior to publication.     -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <operation
-      id="include"
-      if="(${presenter_work_video} OR $ ${presentation_work_video})"
-      description="Including theming operations">
-      <configurations>
-        <configuration key="workflow-id">partial-theming</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Mark captions for publication -->
-
-    <operation
-        id="tag"
-        description="Mark captions for publication">
-      <configurations>
-        <configuration key="source-flavors">captions/shifted</configuration>
-        <configuration key="target-flavor">captions/delivery</configuration>
-        <configuration key="target-tags">+engage-download</configuration>
-      </configurations>
-    </operation>
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Encode for publication to Engage                                  -->
-    <!--                                                                   -->
-    <!-- Encode audio and video formats to the distribution formats that   -->
-    <!-- are required by the Engage publication channel.                   -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <!-- Encode presenter (camera) and presentation (screen) -->
-    <!-- to Engage player format                             -->
-
-    <operation
-      id="encode"
-      if="(${presenter_work_video} OR $ ${presentation_work_video})"
-      exception-handler-workflow="partial-error"
-      description="Encoding videos to mp4 delivery format">
-      <configurations>
-        <configuration key="source-flavor">*/themed</configuration>
-        <configuration key="target-flavor">*/delivery</configuration>
-        <configuration key="target-tags">engage-download,engage-streaming</configuration>
-        <configuration key="encoding-profile">adaptive-parallel.http</configuration>
-      </configurations>
-    </operation>
-
-    <operation
-      id="encode"
-      if="NOT (${presenter_work_video} OR $ ${presentation_work_video}) AND (${presenter_work_audio} OR ${presentation_work_audio})"
-      exception-handler-workflow="partial-error"
-      description="Encoding audio-only files to mp3 delivery format">
-      <configurations>
-        <configuration key="source-flavor">*/trimmed</configuration>
-        <configuration key="target-flavor">*/delivery</configuration>
-        <configuration key="target-tags">engage-download,engage-streaming</configuration>
-        <configuration key="encoding-profile">audio-to-m4a.http</configuration>
-      </configurations>
-    </operation>
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Segment video streams and extract metadata                        -->
-    <!--                                                                   -->
-    <!-- Apply the video segmentation algorithm to the presentation tracks -->
-    <!-- and extract segment preview images and metadata.                  -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <!-- Run the videosegmentation -->
-
-    <operation
-      id="segment-video"
-      fail-on-error="false"
-      description="Detecting slide transitions in presentation track">
-      <configurations>
-        <configuration key="source-flavor">presentation/themed</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Generate segment preview images -->
-
-    <operation
-      id="segmentpreviews"
-      fail-on-error="false"
-      description="Creating preview images for presentation segments">
-      <configurations>
-        <configuration key="source-flavor">presentation/themed</configuration>
-        <configuration key="target-flavor">presentation/segment+preview</configuration>
-        <configuration key="reference-flavor">presentation/delivery</configuration>
-        <configuration key="reference-tags">engage-download</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-        <configuration key="encoding-profile">player-slides.http</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Extract text form slide preview images -->
-
-    <operation
-      id="extract-text"
-      fail-on-error="false"
-      description="Extracting text from presentation segments">
-      <configurations>
-        <configuration key="source-flavor">presentation/themed</configuration>
-        <configuration key="target-tags">engage-download</configuration>
-      </configurations>
-    </operation>
-
-
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-    <!-- Publish to publication channels                                   -->
-    <!--                                                                   -->
-    <!-- Send the encoded material along with the metadata to the          -->
-    <!-- publication channels.                                             -->
-    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-    <!-- Publish to engage player -->
-
-    <operation
-      id="publish-engage"
-      max-attempts="2"
-      exception-handler-workflow="partial-error"
-      description="Publishing to Opencast Media Module">
-      <configurations>
-        <configuration key="download-source-flavors">dublincore/*,security/*</configuration>
-        <configuration key="download-source-tags">engage-download</configuration>
-        <configuration key="streaming-source-tags">engage-streaming</configuration>
-        <configuration key="check-availability">false</configuration>
-      </configurations>
-    </operation>
-
-    <!-- Here you can place operations to publish to your publication channels -->
-
-  </operations>
-</definition>
diff --git a/roles/opencast/files/etc/workflows/schedule-and-upload.xml b/roles/opencast/files/etc/workflows/schedule-and-upload.xml
index 814e9d6..84e1bfb 100644
--- a/roles/opencast/files/etc/workflows/schedule-and-upload.xml
+++ b/roles/opencast/files/etc/workflows/schedule-and-upload.xml
@@ -98,6 +98,29 @@
       </configurations>
     </operation>
 
+
+    <!-- Generate subtitles via Whisper -->
+
+    <operation
+      id="include"
+      description="Generate Subtitles with Whisper"
+      if="${genSubtitles}">
+      <configurations>
+        <configuration key="workflow-id">partial-generate-captions-whisper</configuration>
+      </configurations>
+    </operation>
+
+    <!-- Archive generated subtitles -->
+
+    <operation
+      id="snapshot"
+      description="Archive preview information"
+      if="${genSubtitles}">
+      <configurations>
+        <configuration key="source-tags">archive</configuration>
+      </configurations>
+    </operation>
+
     <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
     <!-- Tag for review and cutting                                        -->
     <!--                                                                   -->