com.adobe.acs.commons.dam.audio.impl.AudioHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.10.0

Show newest version

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.adobe.acs.commons.dam.audio.impl;

import com.day.cq.dam.api.Asset;
import com.day.cq.dam.handler.ffmpeg.ExecutableLocator;
import org.apache.sling.api.resource.ResourceResolver;

import java.io.File;

/**
 * Audio helper interface to reduce code duplication when working with FFMpeg to process Audio files.
 */
public interface AudioHelper {

    /**
     * Prepare an asset for processing by FFMpeg. The actual work is handled by the audioProcessor passed.
     *
     * @param asset an Asset
     * @param resourceResolver a ResourceResolver
     * @param args some arguments object
     * @param audioProcessor an implementation of the AudioProcessor interface
     * @param  the arguments type
     * @param  the processor result type
     * @return the result of processing
     * @throws AudioException if something goes wrong
     */
     R process(Asset asset, ResourceResolver resourceResolver, A args, AudioProcessor audioProcessor) throws AudioException;

    /**
     * Callback interface to actually invoke FFMpeg
     * @param  the arguments type
     * @param  the result type
     */
    interface AudioProcessor {

        /**
         * Process a file given an FFMpeg environment.
         *
         * @param asset an Asset
         * @param resourceResolver a ResourceResolver
         * @param tempFile the Asset's original rendition as a File
         * @param locator the FFMpeg Executable Locator
         * @param workingDir a working directory for FFMpeg
         * @param args the arguments object
         * @return a result
         * @throws AudioException if something goes wrong
         */
        R processAudio(Asset asset, ResourceResolver resourceResolver, File tempFile, ExecutableLocator locator, File workingDir, A args)
                throws AudioException;
    }

}