How to cut captions while preserving their tags?

[Rillke]

Tags on captions can indicate the language to the player. However, using the editor WOH, there is configuration like this:

  - id: editor
    exception-handler-workflow: partial-error
    description: " └── Cut the recording according to the edit decision list"
    configurations:
      - source-flavors: '*/work,captions/*'
      - smil-flavors: smil/tmp
      - target-smil-flavor: smil/tmp
      - target-flavor-subtype: trimmed
      - interactive: false

When we have a media package element with flavor captions/vtt+de and tags archive, engage-download, engage-streaming, generator-type:auto, generator:auto:whisper:large-v3-turbo, lang:de, lang:deu, large-v3-turbo, stt, subopencast-ts-api, whisper it ends up as captions/trimmed with no tags after cutting.

How to cut captions while preserving their tags?

[ssakkout]

Configure the workflow to copy over the tags from the original captions to the trimmed versions (by default, the editor WOH does not carry tags forward unless explicitly instructed)

Add the tag-override configuration to the editor WOH

- id: editor
  exception-handler-workflow: partial-error
  description: " └── Cut the recording according to the edit decision list"
  configurations:
    - source-flavors: '*/work,captions/*'
    - smil-flavors: smil/tmp
    - target-smil-flavor: smil/tmp
    - target-flavor-subtype: trimmed
    - interactive: false
    - tag-override: archive,engage-download,engage-streaming,generator-type:auto,generator:auto:whisper:large-v3-turbo,lang:de,lang:deu,large-v3-turbo,stt,subopencast-ts-api,whisper

If the tags are dynamic ( or you don't want to hardcode them in the workflow configuration)

enable automatic tag inheritance, it can be configured globally in the Opencast configuration files by setting the following property in custom.properties:

org.opencastproject.workflow.editor.copytags=true

Make sure the smil file is being generated with the expected flavor smil/tmp. And the target-flavor-subtype is set to trimmed, as seen in your configuration.
And ensure that no other WOH in the workflow overrides or removes tags after the trimming step.

[Rillke]

Thanks, can you point me to the correct place in code where tag-override is implemented? A snippet would be enough. Also, please add a link to the line containing the copytags property.

[ssakkout]

initially thought of modifying the following (line 573) in VideoEditorWorkflowOperationHandler.java:

  var reference = editedTrack.getReference();
  if (reference == null) {
    logger.warn("Edited track {} has no reference track assigned; skip restoring tags.",
        editedTrack.getIdentifier());
  } else if (track.getIdentifier().equals(reference.getIdentifier())) {
    editedTrack.setTags(track.getTags());
    mp.addDerived(editedTrack, track);
    mpAdded = true;
    break;
  }
}

to

// Check for the "tag-override" configuration property
String tagOverrideProperty = workflowInstance.getCurrentOperation().getConfiguration("tag-override");
if (tagOverrideProperty != null) {
  logger.info("Overriding tags for edited track using 'tag-override' configuration: {}", tagOverrideProperty);

  // Split the "tag-override" property into individual tags and add them to the edited track
  String[] overrideTags = tagOverrideProperty.split(",");
  for (String tag : overrideTags) {
    editedTrack.addTag(tag.trim());
  }
} else {
  // If "tag-override" is not set, restore the original tags from the source track
  logger.info("No 'tag-override' configuration found. Restoring tags from the source track.");
  for (Track track : sourceTracks) {
    var reference = editedTrack.getReference();
    if (reference == null) {
      logger.warn("Edited track {} has no reference track assigned; skipping tag restoration.",
          editedTrack.getIdentifier());
    } else if (track.getIdentifier().equals(reference.getIdentifier())) {
      editedTrack.setTags(track.getTags());
      mp.addDerived(editedTrack, track);
      mpAdded = true;
      break;
    }
  }
}

then add a new configuration property in your workflow

- id: video-editor
  configurations:
    - tag-override: "archive,engage-download,engage-streaming"

but if the copyTag is better option in this case then:

add method copyTag in the file AbstractWorkflowOperationHandler:

/**
 * Copies tags from the source track to the edited track.
 *
 * @param editedTrack The track to which the tags should be copied.
 * @param sourceTracks A collection of source tracks to copy tags from.
 */
protected void copyTags(Track editedTrack, Collection<Track> sourceTracks) {
  for (Track track : sourceTracks) {
    var reference = editedTrack.getReference();
    if (reference == null) {
      logger.warn("Edited track {} has no reference track assigned; skipping tag copying.",
          editedTrack.getIdentifier());
    } else if (track.getIdentifier().equals(reference.getIdentifier())) {
      editedTrack.setTags(track.getTags());
      break;
    }
  }
}

call copyTags(editedTrack, sourceTracks);

Using copyTags in VideoEditorWorkflowOperationHandler

// Check for the "tag-override" configuration property
String tagOverrideProperty = workflowInstance.getCurrentOperation().getConfiguration("tag-override");
if (tagOverrideProperty != null) {
  logger.info("Overriding tags for edited track using 'tag-override' configuration: {}", tagOverrideProperty);

  // Split the "tag-override" property into individual tags and add them to the edited track
  String[] overrideTags = tagOverrideProperty.split(",");
  for (String tag : overrideTags) {
    editedTrack.addTag(tag.trim());
  }
} else {
  // If "tag-override" is not set, copy tags from the source track
  logger.info("No 'tag-override' configuration found. Copying tags from the source track.");
  copyTags(editedTrack, sourceTracks);
}

[KatrinIhler]

I'm sorry, but this sounds like AI generated nonsense. No such options currently exist.

[KatrinIhler]

On which OC version are you? This might have fixed that: #5409