org.gytheio.content.transform.ffmpeg

Class FfmpegContentTransformerWorker

java.lang.Object

org.gytheio.content.AbstractContentWorker

org.gytheio.content.transform.AbstractContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker

org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

org.gytheio.content.transform.ffmpeg.FfmpegContentTransformerWorker

All Implemented Interfaces:

org.gytheio.content.ContentWorker, org.gytheio.content.transform.ContentTransformerWorker

public class FfmpegContentTransformerWorker
extends org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

An FFmpeg command line implementation of a content hash node worker

Author:

Ray Gauss II

Nested Class Summary

Nested classes/interfaces inherited from class org.gytheio.content.transform.AbstractFileContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CMD_OPT_ASSIGNMENT
protected static String	CMD_OPT_AUDIO_BITRATE_v0
protected static String	CMD_OPT_AUDIO_BITRATE_v1
protected static String	CMD_OPT_AUDIO_CHANNELS
protected static String	CMD_OPT_AUDIO_CODEC_v0
protected static String	CMD_OPT_AUDIO_CODEC_v1
protected static String	CMD_OPT_AUDIO_SAMPLING_RATE
protected static String	CMD_OPT_DELIMITER
protected static String	CMD_OPT_DISABLE_AUDIO
protected static String	CMD_OPT_DISABLE_SUBTITLES
protected static String	CMD_OPT_DISABLE_VIDEO
protected static String	CMD_OPT_DURATION
protected static String	CMD_OPT_ENABLE_EXPERIMENTAL
protected static String	CMD_OPT_FORMAT
protected static String	CMD_OPT_FRAME_RATE
protected static String	CMD_OPT_FRAME_RATE_FILTER
protected static String	CMD_OPT_MOV_FLAGS
protected static String	CMD_OPT_MOV_FLAGS_FASTSTART
protected static String	CMD_OPT_MULTI_TARGET_INDEX_FORMATTER
protected static String	CMD_OPT_MULTI_TARGET_INDEX_REGEX
protected static String	CMD_OPT_NUM_VIDEO_FRAMES
protected static String	CMD_OPT_OFFSET
protected static String	CMD_OPT_PAIR_1_FRAME
protected static String	CMD_OPT_PARAM_ASSIGNMENT
protected static String	CMD_OPT_SCALE
protected static String	CMD_OPT_SIZE
protected static String	CMD_OPT_VIDEO_BITRATE_v0
protected static String	CMD_OPT_VIDEO_BITRATE_v1
protected static String	CMD_OPT_VIDEO_CODEC_v0
protected static String	CMD_OPT_VIDEO_CODEC_v1
protected static String	CMD_OPT_VIDEO_PRESET
protected static String	DEFAULT_OFFSET
protected static String	DEFAULT_VIDEO_PRESET
protected static String	DEFAULT_VIDEO_PRESET_PREFIX
protected static String	DEFAULT_VIDEO_PRESET_SUFFIX
static String	VAR_DURATION duration variable name
static String	VAR_OFFSET offset variable name
static String	VAR_SOURCE_OPTIONS
static String	VAR_TARGET_OPTIONS

Fields inherited from class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

executer, fileDetailsExecuter, VAR_SOURCE, VAR_TARGET, versionDetailsExecuter

Fields inherited from class org.gytheio.content.transform.AbstractContentTransformerWorker

targetContentReferenceHandler

Fields inherited from class org.gytheio.content.AbstractContentWorker

FRAMEWORK_PROPERTY_NAME, FRAMEWORK_PROPERTY_VERSION, sourceContentReferenceHandler, versionDetailsString, versionString

Constructor Summary

Constructors

Constructor and Description
FfmpegContentTransformerWorker()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.gytheio.content.ContentReference	createMultiTargetContentReference(String mediaType)
protected boolean	disableAudio(String sourceMimetype, String targetMimetype) Determines whether or not audio should be disabled for the given source and target mimetypes.
protected boolean	disableSubtitles(String sourceMimetype, String targetMimetype) Determines whether or not subtitles should be disabled for the given source and target mimetypes.
protected boolean	disableVideo(String sourceMimetype, String targetMimetype) Determines whether or not video should be disabled for the given source and target mimetypes.
protected String	getCmdOptAudioBitrate()
protected String	getCmdOptAudioCodec()
protected String	getCmdOptVideoBitrate()
protected String	getCmdOptVideoCodec()
protected String	getComponentExclusionCommandOptions(String sourceMimetype, String targetMimetype)
protected String	getFfmpegAudioCodec(String targetMediaType, String gytheioAudioCodec)
protected String	getFfmpegVersionNumber()
protected String	getFfmpegVideoCodec(String gytheioVideoCodec)
protected String	getFormatCommandOptions(String sourceMimetype, String targetMimetype)
protected String	getResolution(String details)
protected String	getSourceCommandOptions(File sourceFile, File targetFile, String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options)
protected String	getSourceTemporalCommandOptions(String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options) Gets the ffmpeg command string for the time-based video conversion transform options provided which apply to the source input
protected String	getTargetAudioCommandOptions(String targetMediaType, org.gytheio.content.transform.options.TransformationOptions options)
protected String	getTargetCommandOptions(File sourceFile, File targetFile, String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options)
protected String	getTargetResizeCommandOptions(org.gytheio.content.transform.options.TransformationOptions options, File sourceFile) Gets the ffmpeg command string for the transform options provided
protected String	getTargetTemporalCommandOptions(String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options) Gets the ffmpeg command string for the time-based video conversion transform options provided which apply to the target output
protected String	getTargetVideoCommandOptions(String sourceMediaType, String targetMediaType, org.gytheio.content.transform.options.TransformationOptions options)
protected String	getVersionDetailOutput(String[] arguments) Uses the executable defined in versionDetailsExecuter with the given alternative arguments to obtain additional version detail output
protected String	getVideoPresetOptions()
protected void	initializationTest()
protected void	initializeExecuter()
protected void	initializeFileDetailsExecuter()
protected void	initializeVersionDetailsExecuter()
protected void	initializeVersionDetailsString()
protected boolean	isFilterSupported()
protected boolean	isSingleSourceFrameRangeRequired(String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options) Determines whether or not a single frame is required for the given source and target mimetypes.
protected boolean	isStoryboardThumbnailRequest(String sourceMimetype, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options) Determines whether or not the transformation request is for storyboard thumbnails.
static boolean	isSupportedSource(String mediaType) Determines if the source mimetype is supported by ffmpeg
static boolean	isSupportedTarget(String mimetype) Determines if FFmpeg can be made to support the given target mimetype.
boolean	isTransformable(List<String> sourceMediaTypes, String targetMediaType, org.gytheio.content.transform.options.TransformationOptions options)
boolean	isVersion1orGreater()
protected void	reinitializeVersionString()
protected void	singleTransformInternal(File sourceFile, String sourceMimetype, File targetFile, String targetMimetype, org.gytheio.content.transform.options.TransformationOptions options, org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)
protected List<File>	transformInternal(List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> sourcePairs, List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> targetPairs, org.gytheio.content.transform.options.TransformationOptions options, org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)

Methods inherited from class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

getDetails, initialize, setExecuter, setVersionDetailsExecuter

Methods inherited from class org.gytheio.content.transform.AbstractFileContentTransformerWorker

createTargetContentReference, createTempFile, getSourcePairs, getTargetPairs, initializationTest, isTempTargetUsed, transform, transform

Methods inherited from class org.gytheio.content.transform.AbstractContentTransformerWorker

getExtension, setTargetContentReferenceHandler, toString

Methods inherited from class org.gytheio.content.AbstractContentWorker

getProperties, getVersionDetailsString, getVersionString, initializeVersionString, isAvailable, loadProperties, setIsAvailable, setSourceContentReferenceHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gytheio.content.ContentWorker

getVersionDetailsString, getVersionString, isAvailable

Field Detail

CMD_OPT_ASSIGNMENT

protected static final String CMD_OPT_ASSIGNMENT

See Also:

Constant Field Values

CMD_OPT_PARAM_ASSIGNMENT

protected static final String CMD_OPT_PARAM_ASSIGNMENT

See Also:

Constant Field Values

CMD_OPT_DELIMITER

protected static final String CMD_OPT_DELIMITER

See Also:

Constant Field Values

CMD_OPT_NUM_VIDEO_FRAMES

protected static final String CMD_OPT_NUM_VIDEO_FRAMES

See Also:

Constant Field Values

CMD_OPT_DISABLE_AUDIO

protected static final String CMD_OPT_DISABLE_AUDIO

See Also:

Constant Field Values

CMD_OPT_DISABLE_VIDEO

protected static final String CMD_OPT_DISABLE_VIDEO

See Also:

Constant Field Values

CMD_OPT_DISABLE_SUBTITLES

protected static final String CMD_OPT_DISABLE_SUBTITLES

See Also:

Constant Field Values

CMD_OPT_VIDEO_CODEC_v0

protected static final String CMD_OPT_VIDEO_CODEC_v0

See Also:

Constant Field Values

CMD_OPT_VIDEO_CODEC_v1

protected static final String CMD_OPT_VIDEO_CODEC_v1

See Also:

Constant Field Values

CMD_OPT_VIDEO_BITRATE_v0

protected static final String CMD_OPT_VIDEO_BITRATE_v0

See Also:

Constant Field Values

CMD_OPT_VIDEO_BITRATE_v1

protected static final String CMD_OPT_VIDEO_BITRATE_v1

See Also:

Constant Field Values

CMD_OPT_VIDEO_PRESET

protected static final String CMD_OPT_VIDEO_PRESET

See Also:

Constant Field Values

CMD_OPT_AUDIO_CODEC_v0

protected static final String CMD_OPT_AUDIO_CODEC_v0

See Also:

Constant Field Values

CMD_OPT_AUDIO_CODEC_v1

protected static final String CMD_OPT_AUDIO_CODEC_v1

See Also:

Constant Field Values

CMD_OPT_AUDIO_BITRATE_v0

protected static final String CMD_OPT_AUDIO_BITRATE_v0

See Also:

Constant Field Values

CMD_OPT_AUDIO_BITRATE_v1

protected static final String CMD_OPT_AUDIO_BITRATE_v1

See Also:

Constant Field Values

CMD_OPT_AUDIO_SAMPLING_RATE

protected static final String CMD_OPT_AUDIO_SAMPLING_RATE

See Also:

Constant Field Values

CMD_OPT_AUDIO_CHANNELS

protected static final String CMD_OPT_AUDIO_CHANNELS

See Also:

Constant Field Values

CMD_OPT_FORMAT

protected static final String CMD_OPT_FORMAT

See Also:

Constant Field Values

CMD_OPT_DURATION

protected static final String CMD_OPT_DURATION

See Also:

Constant Field Values

CMD_OPT_OFFSET

protected static final String CMD_OPT_OFFSET

See Also:

Constant Field Values

CMD_OPT_SIZE

protected static final String CMD_OPT_SIZE

See Also:

Constant Field Values

CMD_OPT_SCALE

protected static final String CMD_OPT_SCALE

See Also:

Constant Field Values

CMD_OPT_FRAME_RATE

protected static final String CMD_OPT_FRAME_RATE

See Also:

Constant Field Values

CMD_OPT_FRAME_RATE_FILTER

protected static final String CMD_OPT_FRAME_RATE_FILTER

See Also:

Constant Field Values

CMD_OPT_MOV_FLAGS

protected static final String CMD_OPT_MOV_FLAGS

See Also:

Constant Field Values

CMD_OPT_MOV_FLAGS_FASTSTART

protected static final String CMD_OPT_MOV_FLAGS_FASTSTART

See Also:

Constant Field Values

CMD_OPT_ENABLE_EXPERIMENTAL

protected static final String CMD_OPT_ENABLE_EXPERIMENTAL

See Also:

Constant Field Values

CMD_OPT_PAIR_1_FRAME

protected static final String CMD_OPT_PAIR_1_FRAME

See Also:

Constant Field Values

CMD_OPT_MULTI_TARGET_INDEX_FORMATTER

protected static final String CMD_OPT_MULTI_TARGET_INDEX_FORMATTER

See Also:

Constant Field Values

CMD_OPT_MULTI_TARGET_INDEX_REGEX

protected static final String CMD_OPT_MULTI_TARGET_INDEX_REGEX

See Also:

Constant Field Values

DEFAULT_VIDEO_PRESET

protected static final String DEFAULT_VIDEO_PRESET

See Also:

Constant Field Values

DEFAULT_VIDEO_PRESET_PREFIX

protected static final String DEFAULT_VIDEO_PRESET_PREFIX

See Also:

Constant Field Values

DEFAULT_VIDEO_PRESET_SUFFIX

protected static final String DEFAULT_VIDEO_PRESET_SUFFIX

See Also:

Constant Field Values

VAR_SOURCE_OPTIONS

public static final String VAR_SOURCE_OPTIONS

See Also:

Constant Field Values

VAR_TARGET_OPTIONS

public static final String VAR_TARGET_OPTIONS

See Also:

Constant Field Values

VAR_OFFSET

public static final String VAR_OFFSET

offset variable name

See Also:

Constant Field Values

VAR_DURATION

public static final String VAR_DURATION

duration variable name

See Also:

Constant Field Values

DEFAULT_OFFSET

protected static final String DEFAULT_OFFSET

See Also:

Constant Field Values

Constructor Detail

FfmpegContentTransformerWorker

public FfmpegContentTransformerWorker()

Method Detail

initializeExecuter

protected void initializeExecuter()

Specified by:

initializeExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializeVersionDetailsExecuter

protected void initializeVersionDetailsExecuter()

Specified by:

initializeVersionDetailsExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializeFileDetailsExecuter

protected void initializeFileDetailsExecuter()

Specified by:

initializeFileDetailsExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializationTest

protected void initializationTest()

Specified by:

initializationTest in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

getVersionDetailOutput

protected String getVersionDetailOutput(String[] arguments)

Uses the executable defined in versionDetailsExecuter with the given alternative arguments to obtain additional version detail output

Parameters:

arguments -

Returns:

the additional version details output

initializeVersionDetailsString

protected void initializeVersionDetailsString()

Overrides:

initializeVersionDetailsString in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

reinitializeVersionString

protected void reinitializeVersionString()

isSupportedSource

public static boolean isSupportedSource(String mediaType)

Determines if the source mimetype is supported by ffmpeg

Parameters:

mediaType - the mimetype to check

Returns:

Returns true if ffmpeg can handle the given mimetype format

isSupportedTarget

public static boolean isSupportedTarget(String mimetype)

Determines if FFmpeg can be made to support the given target mimetype.

Parameters:

mimetype - the mimetype to check

Returns:

Returns true if ffmpeg can handle the given mimetype format

See Also:

#setUnsupportedMimetypes(String)

isTransformable

public boolean isTransformable(List<String> sourceMediaTypes,
                      String targetMediaType,
                      org.gytheio.content.transform.options.TransformationOptions options)

transformInternal

protected List<File> transformInternal(List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> sourcePairs,
                           List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> targetPairs,
                           org.gytheio.content.transform.options.TransformationOptions options,
                           org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)
                                throws Exception

Specified by:

transformInternal in class org.gytheio.content.transform.AbstractFileContentTransformerWorker

Throws:

Exception

singleTransformInternal

protected void singleTransformInternal(File sourceFile,
                           String sourceMimetype,
                           File targetFile,
                           String targetMimetype,
                           org.gytheio.content.transform.options.TransformationOptions options,
                           org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)
                                throws Exception

Throws:

Exception

getSourceCommandOptions

protected String getSourceCommandOptions(File sourceFile,
                             File targetFile,
                             String sourceMimetype,
                             String targetMimetype,
                             org.gytheio.content.transform.options.TransformationOptions options)
                                  throws Exception

Throws:

Exception

getTargetCommandOptions

protected String getTargetCommandOptions(File sourceFile,
                             File targetFile,
                             String sourceMimetype,
                             String targetMimetype,
                             org.gytheio.content.transform.options.TransformationOptions options)
                                  throws Exception

Throws:

Exception

getFfmpegVersionNumber

protected String getFfmpegVersionNumber()

isFilterSupported

protected boolean isFilterSupported()

isVersion1orGreater

public boolean isVersion1orGreater()

getResolution

protected String getResolution(String details)

getTargetResizeCommandOptions

protected String getTargetResizeCommandOptions(org.gytheio.content.transform.options.TransformationOptions options,
                                   File sourceFile)

Gets the ffmpeg command string for the transform options provided

Note: The current implementation assumes a 4:3 aspect ratio in the source and that the imageResizeOptions given signify max width and heights.

TODO: Future implementations should examine the source for the aspect ratio to correctly create the thumbnail.

Parameters:

options - transformation options

sourceFile -

Returns:

String the ffmpeg command options

getFfmpegVideoCodec

protected String getFfmpegVideoCodec(String gytheioVideoCodec)

getCmdOptVideoBitrate

protected String getCmdOptVideoBitrate()

getCmdOptVideoCodec

protected String getCmdOptVideoCodec()

getCmdOptAudioBitrate

protected String getCmdOptAudioBitrate()

getCmdOptAudioCodec

protected String getCmdOptAudioCodec()

getTargetVideoCommandOptions

protected String getTargetVideoCommandOptions(String sourceMediaType,
                                  String targetMediaType,
                                  org.gytheio.content.transform.options.TransformationOptions options)

getVideoPresetOptions

protected String getVideoPresetOptions()

getFfmpegAudioCodec

protected String getFfmpegAudioCodec(String targetMediaType,
                         String gytheioAudioCodec)

getTargetAudioCommandOptions

protected String getTargetAudioCommandOptions(String targetMediaType,
                                  org.gytheio.content.transform.options.TransformationOptions options)

getComponentExclusionCommandOptions

protected String getComponentExclusionCommandOptions(String sourceMimetype,
                                         String targetMimetype)

getFormatCommandOptions

protected String getFormatCommandOptions(String sourceMimetype,
                             String targetMimetype)

getSourceTemporalCommandOptions

protected String getSourceTemporalCommandOptions(String sourceMimetype,
                                     String targetMimetype,
                                     org.gytheio.content.transform.options.TransformationOptions options)

Gets the ffmpeg command string for the time-based video conversion transform options provided which apply to the source input

Parameters:

options - time-based options

Returns:

String the ffmpeg command options

getTargetTemporalCommandOptions

protected String getTargetTemporalCommandOptions(String sourceMimetype,
                                     String targetMimetype,
                                     org.gytheio.content.transform.options.TransformationOptions options)

Gets the ffmpeg command string for the time-based video conversion transform options provided which apply to the target output

Parameters:

options - time-based options

Returns:

String the ffmpeg command options

isSingleSourceFrameRangeRequired

protected boolean isSingleSourceFrameRangeRequired(String sourceMimetype,
                                       String targetMimetype,
                                       org.gytheio.content.transform.options.TransformationOptions options)

Determines whether or not a single frame is required for the given source and target mimetypes.

Parameters:

sourceMimetype -

targetMimetype -

Returns:

whether or not a page range must be specified for the transformer to read the target files

isStoryboardThumbnailRequest

protected boolean isStoryboardThumbnailRequest(String sourceMimetype,
                                   String targetMimetype,
                                   org.gytheio.content.transform.options.TransformationOptions options)

Determines whether or not the transformation request is for storyboard thumbnails.

Parameters:

sourceMimetype -

targetMimetype -

options -

Returns:

true if requesting storyboard thumbnails

disableVideo

protected boolean disableVideo(String sourceMimetype,
                   String targetMimetype)

Determines whether or not video should be disabled for the given source and target mimetypes.

Parameters:

sourceMimetype -

targetMimetype -

Returns:

whether or not to disable video in the output

disableAudio

protected boolean disableAudio(String sourceMimetype,
                   String targetMimetype)

Determines whether or not audio should be disabled for the given source and target mimetypes.

Parameters:

sourceMimetype -

targetMimetype -

Returns:

whether or not to disable audio in the output

disableSubtitles

protected boolean disableSubtitles(String sourceMimetype,
                       String targetMimetype)

Determines whether or not subtitles should be disabled for the given source and target mimetypes.

Parameters:

sourceMimetype -

targetMimetype -

Returns:

whether or not to disable subtitles in the output

createMultiTargetContentReference

protected org.gytheio.content.ContentReference createMultiTargetContentReference(String mediaType)