AmberscriptAttachTranscriptionOperationHandler.java

/*
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */
package org.opencastproject.transcription.workflowoperation;

import org.opencastproject.caption.api.CaptionService;
import org.opencastproject.job.api.Job;
import org.opencastproject.job.api.JobContext;
import org.opencastproject.mediapackage.MediaPackage;
import org.opencastproject.mediapackage.MediaPackageElement;
import org.opencastproject.mediapackage.MediaPackageElementFlavor;
import org.opencastproject.mediapackage.MediaPackageElementParser;
import org.opencastproject.mediapackage.Track;
import org.opencastproject.mediapackage.track.TrackImpl;
import org.opencastproject.serviceregistry.api.ServiceRegistry;
import org.opencastproject.transcription.api.TranscriptionService;
import org.opencastproject.transcription.api.TranscriptionServiceException;
import org.opencastproject.workflow.api.AbstractWorkflowOperationHandler;
import org.opencastproject.workflow.api.ConfiguredTagsAndFlavors;
import org.opencastproject.workflow.api.WorkflowInstance;
import org.opencastproject.workflow.api.WorkflowOperationException;
import org.opencastproject.workflow.api.WorkflowOperationHandler;
import org.opencastproject.workflow.api.WorkflowOperationInstance;
import org.opencastproject.workflow.api.WorkflowOperationResult;
import org.opencastproject.workflow.api.WorkflowOperationResult.Action;
import org.opencastproject.workspace.api.Workspace;

import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Component(
    immediate = true,
    service = WorkflowOperationHandler.class,
    property = {
        "service.description=Attach Transcription Workflow Operation Handler (Amberscript)",
        "workflow.operation=amberscript-attach-transcription"
    }
)
public class AmberscriptAttachTranscriptionOperationHandler extends AbstractWorkflowOperationHandler {

  private static final Logger logger = LoggerFactory.getLogger(AmberscriptAttachTranscriptionOperationHandler.class);

  /** Workflow configuration option keys */
  static final String TRANSCRIPTION_JOB_ID = "transcription-job-id";
  static final String TARGET_CAPTION_FORMAT = "target-caption-format";
  static final String TARGET_TYPE = "target-element-type";

  private TranscriptionService service = null;
  private CaptionService captionService;

  private Workspace workspace;

  @Override
  @Activate
  protected void activate(ComponentContext cc) {
    super.activate(cc);
  }

  @Override
  public WorkflowOperationResult start(final WorkflowInstance workflowInstance, JobContext context)
          throws WorkflowOperationException {
    MediaPackage mediaPackage = workflowInstance.getMediaPackage();
    WorkflowOperationInstance operation = workflowInstance.getCurrentOperation();

    logger.debug("Attach transcription for mediapackage '{}' started.", mediaPackage);

    String jobId = StringUtils.trimToNull(operation.getConfiguration(TRANSCRIPTION_JOB_ID));
    if (jobId == null) {
      throw new WorkflowOperationException(TRANSCRIPTION_JOB_ID + " missing.");
    }

    ConfiguredTagsAndFlavors tagsAndFlavors = getTagsAndFlavors(
        workflowInstance, Configuration.none, Configuration.none, Configuration.many, Configuration.one);
    MediaPackageElementFlavor targetFlavor = tagsAndFlavors.getSingleTargetFlavor();
    ConfiguredTagsAndFlavors.TargetTags targetTagOption = tagsAndFlavors.getTargetTags();
    String captionFormatOption = StringUtils.trimToNull(operation.getConfiguration(TARGET_CAPTION_FORMAT));
    MediaPackageElement.Type type = getTargetType(operation.getConfiguration(TARGET_TYPE));

    // If the target format is not specified, convert to vtt (default output format is srt)
    String format = (captionFormatOption != null) ? captionFormatOption : "vtt";

    try {
      MediaPackageElement transcription
          = service.getGeneratedTranscription(mediaPackage.getIdentifier().toString(), jobId, type);

      Job job = captionService.convert(transcription, "subrip", format, service.getLanguage());
      if (!waitForStatus(job).isSuccess()) {
        throw new WorkflowOperationException("Transcription format conversion job did not complete successfully.");
      }
      MediaPackageElement convertedTranscription = MediaPackageElementParser.getFromXml(job.getPayload());
      workspace.delete(transcription.getURI());

      // The SubRip converter always returns Attachments. We may need to turn it into a Track
      if (type == MediaPackageElement.Type.Track) {
        var elem = new TrackImpl();
        elem.setURI(convertedTranscription.getURI());
        elem.setIdentifier(convertedTranscription.getIdentifier());
        elem.setMimeType(convertedTranscription.getMimeType());
        for (var tag: convertedTranscription.getTags()) {
          elem.addTag(tag);
        }
        convertedTranscription = elem;
      }

      convertedTranscription.addTag("generator-type:auto");
      convertedTranscription.addTag("generator:amberscript");
      convertedTranscription.setFlavor(targetFlavor);
      applyTargetTagsToElement(targetTagOption, convertedTranscription);
      mediaPackage.add(convertedTranscription);
      logger.info("Added transcription to the media package {} as {}: {}", mediaPackage,
          convertedTranscription.getElementType(),
          convertedTranscription.getURI());

    } catch (TranscriptionServiceException e) {
      if (e.isCancel()) {
        logger.warn(e.getMessage());
        return createResult(mediaPackage, Action.SKIP);
      }
      throw new WorkflowOperationException(e);
    } catch (Exception e) {
      throw new WorkflowOperationException(e);
    }

    return createResult(mediaPackage, Action.CONTINUE);
  }

  /**
   * Parse the target-type configuration and return the requested MediaPackageElement.Type
   * @param typeUnparsed Configuration value
   * @return Requested type
   */
  private static MediaPackageElement.Type getTargetType(String typeUnparsed) {
    if (StringUtils.isBlank(typeUnparsed)) {
      return Track.TYPE;
    }
    if (MediaPackageElement.Type.Attachment.name().equalsIgnoreCase(typeUnparsed)) {
      return MediaPackageElement.Type.Attachment;
    }
    if (MediaPackageElement.Type.Track.name().equalsIgnoreCase(typeUnparsed)) {
      return MediaPackageElement.Type.Track;
    }
    throw new IllegalArgumentException(String.format("The requested type '%s' is illegal. Please"
            + "check the operation's configuration keys.", typeUnparsed));
  }

  @Reference(target = "(provider=amberscript)")
  public void setTranscriptionService(TranscriptionService service) {
    this.service = service;
  }

  @Reference
  public void setWorkspace(Workspace service) {
    this.workspace = service;
  }

  @Reference
  public void setCaptionService(CaptionService service) {
    this.captionService = service;
  }

  @Reference
  @Override
  public void setServiceRegistry(ServiceRegistry serviceRegistry) {
    super.setServiceRegistry(serviceRegistry);
  }

}