Package net.bramp.ffmpeg.builder

Class FFmpegBuilder

java.lang.Object

net.bramp.ffmpeg.builder.FFmpegBuilder

public class FFmpegBuilder
extends Object

Builds a ffmpeg command line.

Author:

bramp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FFmpegBuilder.Verbosity	Log level options: ffmpeg documentation.

Field Summary

Fields

Modifier and Type	Field	Description
protected Strict	strict

Constructor Summary

Constructors

Constructor	Description
FFmpegBuilder()

Method Summary

Modifier and Type	Method	Description
FFmpegBuilder	addExtraArgs(String... values)	Add additional ouput arguments (for flags which aren't currently supported).
FFmpegHlsOutputBuilder	addHlsOutput(File file)	Adds a new HLS output file.
FFmpegHlsOutputBuilder	addHlsOutput(String filename)	Adds new HLS(Http Live Streaming) output file.
FFmpegHlsOutputBuilder	addHlsOutput(Path path)	Adds a new HLS output file.
FFmpegFileInputBuilder	addInput(File file)	Adds an input by file.
FFmpegFileInputBuilder	addInput(String filename)	Adds an input by filename or URL.
FFmpegFileInputBuilder	addInput(Path path)	Adds an input by path.
FFmpegFileInputBuilder	addInput(FFmpegProbeResult result)	Adds an input from a previously probed result.
<T extends AbstractFFmpegInputBuilder<T>> FFmpegBuilder	addInput(T input)	Adds a pre-built input builder and finalizes it.
FFmpegOutputBuilder	addOutput(File file)	Adds a new output file.
FFmpegOutputBuilder	addOutput(String filename)	Adds new output file.
FFmpegOutputBuilder	addOutput(URI uri)	Adds new output file.
FFmpegOutputBuilder	addOutput(Path path)	Adds a new output file.
FFmpegBuilder	addOutput(FFmpegOutputBuilder output)	Adds an existing FFmpegOutputBuilder.
FFmpegBuilder	addProgress(URI uri)	Sets the URI for progress reporting.
FFmpegOutputBuilder	addStdoutOutput()	Create new output (to stdout).
List<String>	build()	Builds and returns the list of command-line arguments for ffmpeg.
protected void	clearInputs()	Clears all previously added inputs.
protected <T extends AbstractFFmpegInputBuilder<T>> T	doAddInput(T input)	Adds an input builder to the list and returns it for further configuration.
boolean	getOverrideOutputFiles()	Returns whether output files will be overwritten.
String	getPassDirectory()	Returns the pass log file directory.
String	getPassPrefix()	Returns the pass log file prefix.
FFmpegBuilder	overrideOutputFiles(boolean override)	Sets whether to overwrite output files without asking.
FFmpegBuilder	readAtNativeFrameRate()	Deprecated. Use AbstractFFmpegInputBuilder.readAtNativeFrameRate() instead
FFmpegBuilder	setAudioFilter(String filter)	Sets the audio filter flag.
FFmpegBuilder	setComplexFilter(String filter)	Deprecated. Use AbstractFFmpegOutputBuilder.setComplexFilter(String) instead
FFmpegBuilder	setFormat(String format)	Deprecated. Specify this option on an input stream using AbstractFFmpegStreamBuilder.setFormat(String)
FFmpegFileInputBuilder	setInput(File file)	Clears existing inputs and sets the input by file.
FFmpegFileInputBuilder	setInput(String filename)	Clears existing inputs and sets the input by filename or URL.
FFmpegFileInputBuilder	setInput(Path path)	Clears existing inputs and sets the input by path.
FFmpegFileInputBuilder	setInput(FFmpegProbeResult result)	Clears existing inputs and sets the input from a probed result.
<T extends AbstractFFmpegInputBuilder<T>> FFmpegBuilder	setInput(T input)	Sets the input using an input builder, replacing any previous inputs.
FFmpegBuilder	setPass(int pass)	Sets the pass number for multi-pass encoding.
FFmpegBuilder	setPassDirectory(File directory)	Sets the directory for storing pass log files.
FFmpegBuilder	setPassDirectory(String directory)	Sets the directory for storing pass log files.
FFmpegBuilder	setPassDirectory(Path directory)	Sets the directory for storing pass log files.
FFmpegBuilder	setPassPrefix(String prefix)	Sets the pass log file prefix.
FFmpegBuilder	setStartOffset(long duration, TimeUnit units)	Deprecated. Specify this option on an input or output stream using AbstractFFmpegStreamBuilder.setStartOffset(long, TimeUnit)
FFmpegBuilder	setStrict(Strict strict)	Sets the strict standards compliance level.
FFmpegBuilder	setThreads(int threads)	Sets the number of threads to use for processing.
FFmpegBuilder	setUserAgent(String userAgent)	Sets the HTTP user agent string.
FFmpegBuilder	setVBR(Integer quality)	Sets vbr quality when decoding mp3 output.
FFmpegBuilder	setVerbosity(FFmpegBuilder.Verbosity verbosity)	Sets the logging verbosity level.
FFmpegBuilder	setVideoFilter(String filter)	Sets the video filter flag.

Methods inherited from class java.lang.Object

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

Field Details

strict

protected Strict strict

Constructor Details

FFmpegBuilder

public FFmpegBuilder()

Method Details

setStrict

public FFmpegBuilder setStrict(Strict strict)

Sets the strict standards compliance level.

overrideOutputFiles

public FFmpegBuilder overrideOutputFiles(boolean override)

Sets whether to overwrite output files without asking.

getOverrideOutputFiles

public boolean getOverrideOutputFiles()

Returns whether output files will be overwritten.

setPass

public FFmpegBuilder setPass(int pass)

Sets the pass number for multi-pass encoding.

setPassDirectory

public FFmpegBuilder setPassDirectory(String directory)

Sets the directory for storing pass log files.

setPassDirectory

public FFmpegBuilder setPassDirectory(File directory)

Sets the directory for storing pass log files.

setPassDirectory

public FFmpegBuilder setPassDirectory(Path directory)

Sets the directory for storing pass log files.

getPassDirectory

public String getPassDirectory()

Returns the pass log file directory.

setPassPrefix

public FFmpegBuilder setPassPrefix(String prefix)

Sets the pass log file prefix.

getPassPrefix

public String getPassPrefix()

Returns the pass log file prefix.

setVerbosity

public FFmpegBuilder setVerbosity(FFmpegBuilder.Verbosity verbosity)

Sets the logging verbosity level.

setUserAgent

public FFmpegBuilder setUserAgent(String userAgent)

Sets the HTTP user agent string.

readAtNativeFrameRate

@Deprecated
public FFmpegBuilder readAtNativeFrameRate()

Deprecated.

Use AbstractFFmpegInputBuilder.readAtNativeFrameRate() instead

Makes ffmpeg read the first input at the native frame read.

Returns:

this

addInput

public FFmpegFileInputBuilder addInput(FFmpegProbeResult result)

Adds an input from a previously probed result.

addInput

public FFmpegFileInputBuilder addInput(String filename)

Adds an input by filename or URL.

addInput

public FFmpegFileInputBuilder addInput(File file)

Adds an input by file.

addInput

public FFmpegFileInputBuilder addInput(Path path)

Adds an input by path.

addInput

public <T extends AbstractFFmpegInputBuilder<T>>
FFmpegBuilder addInput(T input)

Adds a pre-built input builder and finalizes it.

doAddInput

protected <T extends AbstractFFmpegInputBuilder<T>>
T doAddInput(T input)

Adds an input builder to the list and returns it for further configuration.

clearInputs

protected void clearInputs()

Clears all previously added inputs.

setInput

public FFmpegFileInputBuilder setInput(FFmpegProbeResult result)

Clears existing inputs and sets the input from a probed result.

setInput

public FFmpegFileInputBuilder setInput(String filename)

Clears existing inputs and sets the input by filename or URL.

setInput

public FFmpegFileInputBuilder setInput(File file)

Clears existing inputs and sets the input by file.

setInput

public FFmpegFileInputBuilder setInput(Path path)

Clears existing inputs and sets the input by path.

setInput

public <T extends AbstractFFmpegInputBuilder<T>>
FFmpegBuilder setInput(T input)

Sets the input using an input builder, replacing any previous inputs.

setThreads

public FFmpegBuilder setThreads(int threads)

Sets the number of threads to use for processing.

setFormat

@Deprecated
public FFmpegBuilder setFormat(String format)

Deprecated.

Specify this option on an input stream using AbstractFFmpegStreamBuilder.setFormat(String)

Sets the format for the first input stream.

Parameters:

format - the format of this input stream, not null

Returns:

this

setStartOffset

@Deprecated
public FFmpegBuilder setStartOffset(long duration,
 TimeUnit units)

Deprecated.

Specify this option on an input or output stream using AbstractFFmpegStreamBuilder.setStartOffset(long, TimeUnit)

Sets the start offset for the first input stream.

Parameters:

duration - the amount of the offset, measured in terms of the unit

units - the unit that the duration is measured in, not null

Returns:

this

addProgress

public FFmpegBuilder addProgress(URI uri)

Sets the URI for progress reporting.

setComplexFilter

@Deprecated
public FFmpegBuilder setComplexFilter(String filter)

Deprecated.

Use AbstractFFmpegOutputBuilder.setComplexFilter(String) instead

Sets the complex filter flag.

Parameters:

filter - the complex filter string

Returns:

this

setAudioFilter

public FFmpegBuilder setAudioFilter(String filter)

Sets the audio filter flag.

Parameters:

filter - the audio filter string

Returns:

this

setVideoFilter

public FFmpegBuilder setVideoFilter(String filter)

Sets the video filter flag.

Parameters:

filter - the video filter string

Returns:

this

setVBR

public FFmpegBuilder setVBR(Integer quality)

Sets vbr quality when decoding mp3 output.

Parameters:

quality - the quality between 0 and 9. Where 0 is best.

Returns:

FFmpegBuilder

addExtraArgs

public FFmpegBuilder addExtraArgs(String... values)

Add additional ouput arguments (for flags which aren't currently supported).

Parameters:

values - The extra arguments.

Returns:

this

addOutput

public FFmpegOutputBuilder addOutput(String filename)

Adds new output file.

Parameters:

filename - output file path

Returns:

A new FFmpegOutputBuilder

addOutput

public FFmpegOutputBuilder addOutput(File file)

Adds a new output file.

addOutput

public FFmpegOutputBuilder addOutput(Path path)

Adds a new output file.

addOutput

public FFmpegOutputBuilder addOutput(URI uri)

Adds new output file.

Parameters:

uri - output file uri typically a stream

Returns:

A new FFmpegOutputBuilder

addOutput

public FFmpegBuilder addOutput(FFmpegOutputBuilder output)

Adds an existing FFmpegOutputBuilder. This is similar to calling the other addOuput methods but instead allows an existing FFmpegOutputBuilder to be used, and reused.

 List<String> args = new FFmpegBuilder()
   .addOutput(new FFmpegOutputBuilder()
     .setFilename("output.flv")
     .setVideoCodec("flv")
   )
   .build();
 

Parameters:

output - FFmpegOutputBuilder to add

Returns:

this

addHlsOutput

public FFmpegHlsOutputBuilder addHlsOutput(String filename)

Adds new HLS(Http Live Streaming) output file.

 List<String> args = new FFmpegBuilder()
   .addHlsOutput("output.m3u8")
   .done().build();
 

Parameters:

filename - output file path

Returns:

A new FFmpegHlsOutputBuilder

addHlsOutput

public FFmpegHlsOutputBuilder addHlsOutput(File file)

Adds a new HLS output file.

addHlsOutput

public FFmpegHlsOutputBuilder addHlsOutput(Path path)

Adds a new HLS output file.

addStdoutOutput

public FFmpegOutputBuilder addStdoutOutput()

Create new output (to stdout).

Returns:

A new FFmpegOutputBuilder

build

@CheckReturnValue
public List<String> build()

Builds and returns the list of command-line arguments for ffmpeg.