adams.flow.sink.ffmpeg
Class AbstractFFmpegPluginWithOptions

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.flow.sink.ffmpeg.AbstractFFmpegPlugin
              extended by adams.flow.sink.ffmpeg.AbstractFFmpegPluginWithOptions
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable
Direct Known Subclasses:
MovieFromImages

public abstract class AbstractFFmpegPluginWithOptions
extends AbstractFFmpegPlugin

Ancestor for FFmpeg plugins that offers the user to specify additional input/output options.

Version:
$Revision: 6162 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

Field Summary
protected  String m_AdditionalInputOptions
          additional input options to use for ffmpeg.
protected  String m_AdditionalOutputOptions
          additional output options to use for ffmpeg.
 
Fields inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPlugin
m_BitRate, m_FramesPerSecond, m_Input, m_Owner
 
Fields inherited from class adams.core.option.AbstractOptionHandler
m_DebugLevel, m_OptionManager
 
Constructor Summary
AbstractFFmpegPluginWithOptions()
           
 
Method Summary
 String additionalInputOptionsTipText()
          Returns the tip text for this property.
 String additionalOutputOptionsTipText()
          Returns the tip text for this property.
protected abstract  String assembleActualInputOptions()
          Assembles the actual input command-line options, not including the additional options or the input file.
protected abstract  String assembleActualOutputOptions()
          Assembles the actual output command-line options, not including the additional options.
protected  String assembleInputOptions()
          Assembles the input command-line options, actual and additional.
protected  String assembleOutputOptions()
          Assembles the ouput command-line options.
 void defineOptions()
          Adds options to the internal list of options.
 String getAdditionalInputOptions()
          Returns the additional input options to use.
 String getAdditionalOutputOptions()
          Returns the additional output options to use.
 String getQuickInfo()
          Returns a quick info about the plugin, which will be displayed in the GUI.
 void setAdditionalInputOptions(String value)
          Sets the additional input options to use.
 void setAdditionalOutputOptions(String value)
          Sets the additional output options to use.
 
Methods inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPlugin
bitRateTipText, execute, framesPerSecondTipText, getBitRate, getExecutable, getFramesPerSecond, getInput, getOwner, handleException, initialize, reset, setBitRate, setFramesPerSecond, setInput, setOwner, setUp
 
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString
 
Methods inherited from class adams.core.ConsoleObject
getDebugging, getSystemErr, getSystemOut, sizeOf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_AdditionalInputOptions

protected String m_AdditionalInputOptions
additional input options to use for ffmpeg.


m_AdditionalOutputOptions

protected String m_AdditionalOutputOptions
additional output options to use for ffmpeg.

Constructor Detail

AbstractFFmpegPluginWithOptions

public AbstractFFmpegPluginWithOptions()
Method Detail

defineOptions

public void defineOptions()
Adds options to the internal list of options.

Specified by:
defineOptions in interface OptionHandler
Overrides:
defineOptions in class AbstractFFmpegPlugin

getQuickInfo

public String getQuickInfo()
Returns a quick info about the plugin, which will be displayed in the GUI.

Overrides:
getQuickInfo in class AbstractFFmpegPlugin
Returns:
null if no info available, otherwise short string

setAdditionalInputOptions

public void setAdditionalInputOptions(String value)
Sets the additional input options to use.

Parameters:
value - the options

getAdditionalInputOptions

public String getAdditionalInputOptions()
Returns the additional input options to use.

Returns:
the options

additionalInputOptionsTipText

public String additionalInputOptionsTipText()
Returns the tip text for this property.

Returns:
tip text for this property suitable for displaying in the GUI or for listing the options.

setAdditionalOutputOptions

public void setAdditionalOutputOptions(String value)
Sets the additional output options to use.

Parameters:
value - the options

getAdditionalOutputOptions

public String getAdditionalOutputOptions()
Returns the additional output options to use.

Returns:
the options

additionalOutputOptionsTipText

public String additionalOutputOptionsTipText()
Returns the tip text for this property.

Returns:
tip text for this property suitable for displaying in the GUI or for listing the options.

assembleActualInputOptions

protected abstract String assembleActualInputOptions()
Assembles the actual input command-line options, not including the additional options or the input file.

Returns:
the command-line

assembleInputOptions

protected String assembleInputOptions()
Assembles the input command-line options, actual and additional.

Specified by:
assembleInputOptions in class AbstractFFmpegPlugin
Returns:
the command-line

assembleActualOutputOptions

protected abstract String assembleActualOutputOptions()
Assembles the actual output command-line options, not including the additional options.

Returns:
the command-line

assembleOutputOptions

protected String assembleOutputOptions()
Assembles the ouput command-line options.

Specified by:
assembleOutputOptions in class AbstractFFmpegPlugin
Returns:
the command-line


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.