Package net.bramp.ffmpeg.builder

Class AbstractFFmpegOutputBuilder<T extends AbstractFFmpegOutputBuilder<T>>

java.lang.Object

net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder<T>

net.bramp.ffmpeg.builder.AbstractFFmpegOutputBuilder<T>

Direct Known Subclasses:

FFmpegHlsOutputBuilder, FFmpegOutputBuilder

public abstract class AbstractFFmpegOutputBuilder<T extends AbstractFFmpegOutputBuilder<T>>
extends AbstractFFmpegStreamBuilder<T>

Builds a representation of a single output/encoding setting.

Field Summary

Fields

Modifier and Type	Field	Description
long	audio_bit_rate	Deprecated. Use getAudioBitRate() instead.
String	audio_bit_stream_filter	Deprecated. Use getVideoBitStreamFilter() instead.
String	audio_filter	Deprecated. Use getAudioFilter() instead.
Double	audio_quality	Deprecated. Use getAudioQuality() instead.
String	audio_sample_format	Deprecated. Use getAudioSampleFormat() instead.
protected Integer	bFrames	Specifies the number of b-frames ffmpeg is allowed to use. 0 will disable b-frames, null will let ffmpeg decide.
protected String	complexFilter
Double	constantRateFactor	Deprecated. Use getConstantRateFactor() instead.
long	video_bit_rate	Deprecated. Use getVideoBitRate() instead.
String	video_bit_stream_filter	Deprecated. Use getVideoBitStreamFilter() instead.
String	video_filter	Deprecated. Use getVideoFilter() instead.
String	video_preset	Deprecated. Use getVideoPreset() instead.
Double	video_quality	Deprecated. Use getVideoQuality() instead.

Fields inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder

audio_channels, audio_codec, audio_enabled, audio_preset, audio_sample_rate, DEVNULL, duration, extra_args, filename, format, maps, meta_tags, pass_padding_bitrate, preset, presetFilename, startOffset, strict, subtitle_enabled, subtitle_preset, targetSize, throwWarnings, uri, video_codec, video_copyinkf, video_enabled, video_frame_rate, video_frames, video_height, video_movflags, video_pixel_format, video_size, video_width

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractFFmpegOutputBuilder()	Constructs a default output builder.
protected	AbstractFFmpegOutputBuilder(FFmpegBuilder parent, String filename)	Constructs an output builder with the given parent and filename.
protected	AbstractFFmpegOutputBuilder(FFmpegBuilder parent, URI uri)	Constructs an output builder with the given parent and URI.

Method Summary

Modifier and Type	Method	Description
protected void	addAudioFlags(com.google.common.collect.ImmutableList.Builder<String> args)	Adds audio-related flags such as codec, channels, and sample rate to the arguments.
protected void	addGlobalFlags(FFmpegBuilder parent, com.google.common.collect.ImmutableList.Builder<String> args)	Adds global flags such as format, preset, and time options to the arguments.
protected void	addSourceTarget(int pass, com.google.common.collect.ImmutableList.Builder<String> args)	Adds source and target specific arguments for the given pass.
protected void	addVideoFlags(FFmpegBuilder parent, com.google.common.collect.ImmutableList.Builder<String> args)	Adds video-related flags such as codec, frame rate, and resolution to the arguments.
protected List<String>	build(int pass)	Builds the command-line arguments for the given pass using the parent builder.
protected List<String>	build(FFmpegBuilder parent, int pass)	Builds the arguments.
EncodingOptions	buildOptions()	Returns a representation of this Builder that can be safely serialised.
protected static String	formatDecimalInteger(double d)	Returns a double formatted as a string.
long	getAudioBitRate()
String	getAudioBitStreamFilter()
String	getAudioFilter()
Double	getAudioQuality()
String	getAudioSampleFormat()
String	getComplexFilter()
Double	getConstantRateFactor()
protected T	getThis()	Returns this instance for fluent API chaining.
long	getVideoBitRate()
String	getVideoBitStreamFilter()
String	getVideoFilter()
String	getVideoPreset()
Double	getVideoQuality()
final T	setAudioBitDepth(String bit_depth)	Deprecated. use setAudioSampleFormat(java.lang.String) instead.
T	setAudioBitRate(long bit_rate)	Sets the Audio bit rate.
T	setAudioBitStreamFilter(String filter)	Sets the audio bitstream filter.
T	setAudioFilter(String filter)	Sets Audio Filter.
T	setAudioQuality(double quality)	Sets the audio quality factor.
T	setAudioSampleFormat(String sample_format)	Sets the audio sample format.
T	setBFrames(int bFrames)	Sets the number of b-frames ffmpeg is allowed to use. 0 means: Do not use b-frames at all
T	setComplexFilter(String filter)	Sets a complex filtergraph.
T	setConstantRateFactor(double factor)	Sets the constant rate factor (CRF) for encoding quality.
T	setVideoBitRate(long bit_rate)	Sets the video bit rate in bits per second.
T	setVideoBitStreamFilter(String filter)	Sets the video bit stream filter.
T	setVideoFilter(String filter)	Sets Video Filter.
T	setVideoPreset(String preset)	Sets a video preset to use.
T	setVideoQuality(double quality)	Sets the video quality factor.

Methods inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder

addExtraArgs, addFormatArgs, addMap, addMap, addMetaTag, addMetaTag, disableAudio, disableSubtitle, disableVideo, done, getFilename, getUri, isValidSize, setAudioChannels, setAudioCodec, setAudioPreset, setAudioSampleRate, setDuration, setFilename, setFilename, setFilename, setFormat, setFrames, setPassPaddingBitrate, setPreset, setPresetFilename, setPresetFilename, setPresetFilename, setStartOffset, setStrict, setSubtitleCodec, setSubtitlePreset, setTargetSize, setUri, setVideoCodec, setVideoCopyInkf, setVideoFrameRate, setVideoFrameRate, setVideoFrameRate, setVideoHeight, setVideoMovFlags, setVideoPixelFormat, setVideoResolution, setVideoResolution, setVideoWidth, useOptions, useOptions, useOptions, useOptions

Methods inherited from class java.lang.Object

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

Field Details

constantRateFactor

@Deprecated
public Double constantRateFactor

Deprecated.

Use getConstantRateFactor() instead.

The constant rate factor (CRF).

audio_sample_format

@Deprecated
public String audio_sample_format

Deprecated.

Use getAudioSampleFormat() instead.

The audio sample format.

audio_bit_rate

@Deprecated
public long audio_bit_rate

Deprecated.

Use getAudioBitRate() instead.

The audio bit rate.

audio_quality

@Deprecated
public Double audio_quality

Deprecated.

Use getAudioQuality() instead.

The audio quality.

audio_bit_stream_filter

@Deprecated
public String audio_bit_stream_filter

Deprecated.

Use getVideoBitStreamFilter() instead.

The audio bitstream filter.

audio_filter

@Deprecated
public String audio_filter

Deprecated.

Use getAudioFilter() instead.

The audio filter string.

video_bit_rate

@Deprecated
public long video_bit_rate

Deprecated.

Use getVideoBitRate() instead.

The video bit rate.

video_quality

@Deprecated
public Double video_quality

Deprecated.

Use getVideoQuality() instead.

The video quality.

video_preset

@Deprecated
public String video_preset

Deprecated.

Use getVideoPreset() instead.

The video encoding preset.

video_filter

@Deprecated
public String video_filter

Deprecated.

Use getVideoFilter() instead.

The video filter string.

video_bit_stream_filter

@Deprecated
public String video_bit_stream_filter

Deprecated.

Use getVideoBitStreamFilter() instead.

The video bitstream filter.

bFrames

protected Integer bFrames

Specifies the number of b-frames ffmpeg is allowed to use. 0 will disable b-frames, null will let ffmpeg decide.

complexFilter

protected String complexFilter

Constructor Details

AbstractFFmpegOutputBuilder

public AbstractFFmpegOutputBuilder()

Constructs a default output builder.

AbstractFFmpegOutputBuilder

protected AbstractFFmpegOutputBuilder(FFmpegBuilder parent,
 String filename)

Constructs an output builder with the given parent and filename.

AbstractFFmpegOutputBuilder

protected AbstractFFmpegOutputBuilder(FFmpegBuilder parent,
 URI uri)

Constructs an output builder with the given parent and URI.

Method Details

setConstantRateFactor

public T setConstantRateFactor(double factor)

Sets the constant rate factor (CRF) for encoding quality.

setVideoBitRate

public T setVideoBitRate(long bit_rate)

Sets the video bit rate in bits per second.

setVideoQuality

public T setVideoQuality(double quality)

Sets the video quality factor.

setVideoBitStreamFilter

public T setVideoBitStreamFilter(String filter)

Sets the video bit stream filter.

setVideoPreset

public T setVideoPreset(String preset)

Sets a video preset to use.

Uses `-vpre`.

Parameters:

preset - the preset

Returns:

this

setBFrames

public T setBFrames(int bFrames)

Sets the number of b-frames ffmpeg is allowed to use. 0 means: Do not use b-frames at all

Parameters:

bFrames - number of b-frames

Returns:

this

setVideoFilter

public T setVideoFilter(String filter)

Sets Video Filter.

TODO Build a fluent Filter builder

Parameters:

filter - The video filter.

Returns:

this

setAudioBitDepth

@Deprecated
@InlineMe(replacement="this.setAudioSampleFormat(bit_depth)")
public final T setAudioBitDepth(String bit_depth)

Deprecated.

use setAudioSampleFormat(java.lang.String) instead.

Sets the audio bit depth.

Parameters:

bit_depth - The sample format, one of the net.bramp.ffmpeg.FFmpeg#AUDIO_DEPTH_* constants.

Returns:

this

See Also:

• FFmpeg.AUDIO_DEPTH_U8
• FFmpeg.AUDIO_DEPTH_S16
• FFmpeg.AUDIO_DEPTH_S32
• FFmpeg.AUDIO_DEPTH_FLT
• FFmpeg.AUDIO_DEPTH_DBL

setAudioSampleFormat

public T setAudioSampleFormat(String sample_format)

Sets the audio sample format.

Parameters:

sample_format - The sample format, one of the net.bramp.ffmpeg.FFmpeg#AUDIO_FORMAT_* constants.

Returns:

this

See Also:

• FFmpeg.AUDIO_FORMAT_U8
• FFmpeg.AUDIO_FORMAT_S16
• FFmpeg.AUDIO_FORMAT_S32
• FFmpeg.AUDIO_FORMAT_FLT
• FFmpeg.AUDIO_FORMAT_DBL

setAudioBitRate

public T setAudioBitRate(long bit_rate)

Sets the Audio bit rate.

Parameters:

bit_rate - Audio bitrate in bits per second.

Returns:

this

setAudioQuality

public T setAudioQuality(double quality)

Sets the audio quality factor.

setAudioBitStreamFilter

public T setAudioBitStreamFilter(String filter)

Sets the audio bitstream filter.

setComplexFilter

public T setComplexFilter(String filter)

Sets a complex filtergraph.

setAudioFilter

public T setAudioFilter(String filter)

Sets Audio Filter.

TODO Build a fluent Filter builder

Parameters:

filter - The audio filter.

Returns:

this

buildOptions

@CheckReturnValue
public EncodingOptions buildOptions()

Returns a representation of this Builder that can be safely serialised.

NOTE: This method is horribly out of date, and its use should be rethought.

Specified by:

buildOptions in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

Returns:

A new EncodingOptions capturing this Builder's state

build

@CheckReturnValue
protected List<String> build(int pass)

Description copied from class: AbstractFFmpegStreamBuilder

Builds the command-line arguments for the given pass using the parent builder.

Overrides:

build in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

build

@CheckReturnValue
protected List<String> build(FFmpegBuilder parent,
 int pass)

Builds the arguments.

Overrides:

build in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

Parameters:

parent - The parent FFmpegBuilder

pass - The particular pass. For one-pass this value will be zero, for multi-pass, it will be 1 for the first pass, 2 for the second, and so on.

Returns:

The arguments

formatDecimalInteger

protected static String formatDecimalInteger(double d)

Returns a double formatted as a string. If the double is an integer, then trailing zeros are striped.

Parameters:

d - the double to format.

Returns:

The formatted double.

addGlobalFlags

protected void addGlobalFlags(FFmpegBuilder parent,
 com.google.common.collect.ImmutableList.Builder<String> args)

Description copied from class: AbstractFFmpegStreamBuilder

Adds global flags such as format, preset, and time options to the arguments.

Overrides:

addGlobalFlags in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

addVideoFlags

protected void addVideoFlags(FFmpegBuilder parent,
 com.google.common.collect.ImmutableList.Builder<String> args)

Description copied from class: AbstractFFmpegStreamBuilder

Adds video-related flags such as codec, frame rate, and resolution to the arguments.

Overrides:

addVideoFlags in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

addAudioFlags

protected void addAudioFlags(com.google.common.collect.ImmutableList.Builder<String> args)

Description copied from class: AbstractFFmpegStreamBuilder

Adds audio-related flags such as codec, channels, and sample rate to the arguments.

Overrides:

addAudioFlags in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

addSourceTarget

protected void addSourceTarget(int pass,
 com.google.common.collect.ImmutableList.Builder<String> args)

Description copied from class: AbstractFFmpegStreamBuilder

Adds source and target specific arguments for the given pass.

Specified by:

addSourceTarget in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

getThis

@CheckReturnValue
protected T getThis()

Description copied from class: AbstractFFmpegStreamBuilder

Returns this instance for fluent API chaining.

Specified by:

getThis in class AbstractFFmpegStreamBuilder<T extends AbstractFFmpegOutputBuilder<T>>

getConstantRateFactor

public Double getConstantRateFactor()

getAudioSampleFormat

public String getAudioSampleFormat()

getAudioBitRate

public long getAudioBitRate()

getAudioQuality

public Double getAudioQuality()

getAudioBitStreamFilter

public String getAudioBitStreamFilter()

getAudioFilter

public String getAudioFilter()

getVideoBitRate

public long getVideoBitRate()

getVideoQuality

public Double getVideoQuality()

getVideoPreset

public String getVideoPreset()

getVideoFilter

public String getVideoFilter()

getVideoBitStreamFilter

public String getVideoBitStreamFilter()

getComplexFilter

public String getComplexFilter()