Package net.bramp.ffmpeg

Class FFmpeg

java.lang.Object

net.bramp.ffmpeg.FFmpeg

public class FFmpeg
extends Object

Wrapper around FFmpeg.

Author:

bramp

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIO_DEPTH_DBL	Deprecated.
static final String	AUDIO_DEPTH_FLT	Deprecated.
static final String	AUDIO_DEPTH_S16	Deprecated.
static final String	AUDIO_DEPTH_S32	Deprecated.
static final String	AUDIO_DEPTH_U8	Deprecated.
static final String	AUDIO_FORMAT_DBL
static final String	AUDIO_FORMAT_FLT
static final String	AUDIO_FORMAT_S16
static final String	AUDIO_FORMAT_S32
static final String	AUDIO_FORMAT_U8
static final int	AUDIO_MONO
static final int	AUDIO_SAMPLE_11025
static final int	AUDIO_SAMPLE_12000
static final int	AUDIO_SAMPLE_16000
static final int	AUDIO_SAMPLE_22050
static final int	AUDIO_SAMPLE_32000
static final int	AUDIO_SAMPLE_44100
static final int	AUDIO_SAMPLE_48000
static final int	AUDIO_SAMPLE_8000
static final int	AUDIO_SAMPLE_96000
static final int	AUDIO_STEREO
static final String	DEFAULT_PATH
static final String	FFMPEG
static final Fraction	FPS_23_976
static final Fraction	FPS_24
static final Fraction	FPS_29_97
static final Fraction	FPS_30

Constructor Summary

Constructors

Constructor	Description
FFmpeg()	Constructs an FFmpeg instance using the default path.
FFmpeg(String path)	Constructs an FFmpeg instance using the specified path.
FFmpeg(String path, ProcessFunction runFunction)	Constructs an FFmpeg instance using the specified path and process function.
FFmpeg(ProcessFunction runFunction)	Constructs an FFmpeg instance using the default path and the specified process function.

Method Summary

Modifier and Type	Method	Description
FFmpegBuilder	builder()	Returns a new FFmpegBuilder instance.
List<ChannelLayout>	channelLayouts()	Returns the list of supported channel layouts.
List<Codec>	codecs()	Returns the list of supported codecs.
protected ProgressParser	createProgressParser(ProgressListener listener)	Creates a progress parser for the given listener.
List<Filter>	filters()	Returns the list of supported filters.
List<Format>	formats()	Returns the list of supported formats.
String	getPath()
boolean	isFFmpeg()	Returns true if the binary we are using is the true ffmpeg.
List<String>	path(List<String> args)	Returns the full path to the binary with arguments appended.
List<PixelFormat>	pixelFormats()	Returns the list of supported pixel formats.
void	run(List<String> args)	Runs the binary (ffmpeg) with the supplied args.
void	run(FFmpegBuilder builder)	Runs ffmpeg with the supplied builder.
void	run(FFmpegBuilder builder, ProgressListener listener)	Runs ffmpeg with the supplied builder and an optional progress listener.
void	setProcessErrorStream(Appendable processErrorStream)
void	setProcessOutputStream(Appendable processOutputStream)
protected void	throwOnError(Process p)
protected void	throwOnError(Process p, FFmpegProbeResult result)
String	version()	Returns the version string for this binary.
protected BufferedReader	wrapErrorInReader(Process p)
protected BufferedReader	wrapInReader(Process p)

Methods inherited from class java.lang.Object

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

Field Details

FFMPEG

public static final String FFMPEG

See Also:

• Constant Field Values

DEFAULT_PATH

public static final String DEFAULT_PATH

FPS_30

public static final Fraction FPS_30

FPS_29_97

public static final Fraction FPS_29_97

FPS_24

public static final Fraction FPS_24

FPS_23_976

public static final Fraction FPS_23_976

AUDIO_MONO

public static final int AUDIO_MONO

See Also:

• Constant Field Values

AUDIO_STEREO

public static final int AUDIO_STEREO

See Also:

• Constant Field Values

AUDIO_FORMAT_U8

public static final String AUDIO_FORMAT_U8

See Also:

• Constant Field Values

AUDIO_FORMAT_S16

public static final String AUDIO_FORMAT_S16

See Also:

• Constant Field Values

AUDIO_FORMAT_S32

public static final String AUDIO_FORMAT_S32

See Also:

• Constant Field Values

AUDIO_FORMAT_FLT

public static final String AUDIO_FORMAT_FLT

See Also:

• Constant Field Values

AUDIO_FORMAT_DBL

public static final String AUDIO_FORMAT_DBL

See Also:

• Constant Field Values

AUDIO_DEPTH_U8

@Deprecated
public static final String AUDIO_DEPTH_U8

Deprecated.

See Also:

• Constant Field Values

AUDIO_DEPTH_S16

@Deprecated
public static final String AUDIO_DEPTH_S16

Deprecated.

See Also:

• Constant Field Values

AUDIO_DEPTH_S32

@Deprecated
public static final String AUDIO_DEPTH_S32

Deprecated.

See Also:

• Constant Field Values

AUDIO_DEPTH_FLT

@Deprecated
public static final String AUDIO_DEPTH_FLT

Deprecated.

See Also:

• Constant Field Values

AUDIO_DEPTH_DBL

@Deprecated
public static final String AUDIO_DEPTH_DBL

Deprecated.

See Also:

• Constant Field Values

AUDIO_SAMPLE_8000

public static final int AUDIO_SAMPLE_8000

See Also:

• Constant Field Values

AUDIO_SAMPLE_11025

public static final int AUDIO_SAMPLE_11025

See Also:

• Constant Field Values

AUDIO_SAMPLE_12000

public static final int AUDIO_SAMPLE_12000

See Also:

• Constant Field Values

AUDIO_SAMPLE_16000

public static final int AUDIO_SAMPLE_16000

See Also:

• Constant Field Values

AUDIO_SAMPLE_22050

public static final int AUDIO_SAMPLE_22050

See Also:

• Constant Field Values

AUDIO_SAMPLE_32000

public static final int AUDIO_SAMPLE_32000

See Also:

• Constant Field Values

AUDIO_SAMPLE_44100

public static final int AUDIO_SAMPLE_44100

See Also:

• Constant Field Values

AUDIO_SAMPLE_48000

public static final int AUDIO_SAMPLE_48000

See Also:

• Constant Field Values

AUDIO_SAMPLE_96000

public static final int AUDIO_SAMPLE_96000

See Also:

• Constant Field Values

Constructor Details

FFmpeg

public FFmpeg()
       throws IOException

Constructs an FFmpeg instance using the default path.

Throws:

IOException

FFmpeg

public FFmpeg(@Nonnull
 ProcessFunction runFunction)
       throws IOException

Constructs an FFmpeg instance using the default path and the specified process function.

Throws:

IOException

FFmpeg

public FFmpeg(@Nonnull
 String path)
       throws IOException

Constructs an FFmpeg instance using the specified path.

Throws:

IOException

FFmpeg

public FFmpeg(@Nonnull
 String path,
 @Nonnull
 ProcessFunction runFunction)
       throws IOException

Constructs an FFmpeg instance using the specified path and process function.

Throws:

IOException

Method Details

isFFmpeg

public boolean isFFmpeg()
                 throws IOException

Returns true if the binary we are using is the true ffmpeg. This is to avoid conflict with avconv (from the libav project), that some symlink to ffmpeg.

Returns:

true iff this is the official ffmpeg binary.

Throws:

IOException - If a I/O error occurs while executing ffmpeg.

codecs

@Nonnull
public List<Codec> codecs()
                   throws IOException

Returns the list of supported codecs.

Throws:

IOException

filters

@Nonnull
public List<Filter> filters()
                     throws IOException

Returns the list of supported filters.

Throws:

IOException

formats

@Nonnull
public List<Format> formats()
                     throws IOException

Returns the list of supported formats.

Throws:

IOException

pixelFormats

public List<PixelFormat> pixelFormats()
                               throws IOException

Returns the list of supported pixel formats.

Throws:

IOException

channelLayouts

public List<ChannelLayout> channelLayouts()
                                   throws IOException

Returns the list of supported channel layouts.

Throws:

IOException

createProgressParser

protected ProgressParser createProgressParser(ProgressListener listener)
                                       throws IOException

Creates a progress parser for the given listener.

Throws:

IOException

run

public void run(List<String> args)
         throws IOException

Runs the binary (ffmpeg) with the supplied args. Blocking until finished.

Parameters:

args - The arguments to pass to the binary.

Throws:

IOException - If there is a problem executing the binary.

run

public void run(FFmpegBuilder builder)
         throws IOException

Runs ffmpeg with the supplied builder.

Throws:

IOException

run

public void run(FFmpegBuilder builder,
 @Nullable
 ProgressListener listener)
         throws IOException

Runs ffmpeg with the supplied builder and an optional progress listener.

Parameters:

builder - the ffmpeg builder

listener - optional progress listener

Throws:

IOException - if an I/O error occurs

builder

@CheckReturnValue
public FFmpegBuilder builder()

Returns a new FFmpegBuilder instance.

getPath

public String getPath()

setProcessOutputStream

public void setProcessOutputStream(@Nonnull
 Appendable processOutputStream)

setProcessErrorStream

public void setProcessErrorStream(@Nonnull
 Appendable processErrorStream)

wrapInReader

protected BufferedReader wrapInReader(Process p)

wrapErrorInReader

protected BufferedReader wrapErrorInReader(Process p)

throwOnError

protected void throwOnError(Process p)
                     throws IOException

Throws:

IOException

throwOnError

protected void throwOnError(Process p,
 FFmpegProbeResult result)
                     throws IOException

Throws:

IOException

version

@Nonnull
public String version()
               throws IOException

Returns the version string for this binary.

Returns:

the version string.

Throws:

IOException - If there is an error capturing output from the binary.

path

public List<String> path(List<String> args)
                  throws IOException

Returns the full path to the binary with arguments appended.

Parameters:

args - The arguments to pass to the binary.

Returns:

The full path and arguments to execute the binary.

Throws:

IOException - If there is an error capturing output from the binary