Package net.bramp.ffmpeg

Class FFprobe

java.lang.Object

net.bramp.ffmpeg.FFprobe

public class FFprobe
extends Object

Wrapper around FFprobe.

Author:

bramp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FFprobeBuilder	builder()	Returns a new FFprobeBuilder instance.
String	getPath()
boolean	isFFprobe()	Returns true if the binary we are using is the true ffprobe.
List<String>	path(List<String> args)	Returns the full path to the binary with arguments appended.
FFmpegProbeResult	probe(String mediaPath)	Probes the specified media file and returns the result.
FFmpegProbeResult	probe(String mediaPath, String userAgent)	Probes the specified media file with an optional user agent.
FFmpegProbeResult	probe(String mediaPath, String userAgent, String... extraArgs)	Probes media with an optional user agent and extra arguments.
FFmpegProbeResult	probe(List<String> args)	Probes media using the supplied arguments and returns the result.
FFmpegProbeResult	probe(FFprobeBuilder builder)	Probes media using the supplied FFprobeBuilder.
void	run(List<String> args)	Runs the binary (ffmpeg) with the supplied args.
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

Constructor Details

FFprobe

public FFprobe()
        throws IOException

Constructs an FFprobe instance using the default path.

Throws:

IOException

FFprobe

public FFprobe(@Nonnull
 ProcessFunction runFunction)
        throws IOException

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

Throws:

IOException

FFprobe

public FFprobe(@Nonnull
 String path)
        throws IOException

Constructs an FFprobe instance using the specified path.

Throws:

IOException

FFprobe

public FFprobe(@Nonnull
 String path,
 @Nonnull
 ProcessFunction runFunction)

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

Method Details

probe

public FFmpegProbeResult probe(String mediaPath)
                        throws IOException

Probes the specified media file and returns the result.

Throws:

IOException

probe

public FFmpegProbeResult probe(String mediaPath,
 @Nullable
 String userAgent)
                        throws IOException

Probes the specified media file with an optional user agent.

Throws:

IOException

probe

public FFmpegProbeResult probe(FFprobeBuilder builder)
                        throws IOException

Probes media using the supplied FFprobeBuilder.

Throws:

IOException

probe

public FFmpegProbeResult probe(String mediaPath,
 @Nullable
 String userAgent,
 @Nullable
 String... extraArgs)
                        throws IOException

Probes media with an optional user agent and extra arguments.

Throws:

IOException

probe

public FFmpegProbeResult probe(List<String> args)
                        throws IOException

Probes media using the supplied arguments and returns the result.

Throws:

IOException

isFFprobe

public boolean isFFprobe()
                  throws IOException

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

Returns:

true iff this is the official ffprobe binary.

Throws:

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

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.

builder

@CheckReturnValue
public FFprobeBuilder builder()

Returns a new FFprobeBuilder instance.

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.

getPath

public String getPath()

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