Package com.github.kokorin.jaffree.ffmpeg

Class BaseInOut<T extends BaseInOut>

java.lang.Object

com.github.kokorin.jaffree.ffmpeg.BaseInOut<T>

Direct Known Subclasses:

BaseInput, BaseOutput

public abstract class BaseInOut<T extends BaseInOut>
extends Object

Constructor Summary

Constructors

Constructor	Description
BaseInOut()

Method Summary

Modifier and Type	Method	Description
T	addArgument(String argument)	Add custom argument.
T	addArguments(String key, String value)	Add custom arguments.
abstract List<String>	buildArguments()
protected List<String>	buildCommonArguments()
T	setCodec(StreamType type, String codecName)
T	setCodec(String streamSpecifier, String codecName)
T	setDuration(long durationMillis)	When used as an input option, limit the duration of data read from the input file.
T	setDuration(long duration, TimeUnit timeUnit)
T	setFormat(String format)	Force input or output file format.
T	setFrameRate(Number value)	Set frame rate.
T	setFrameRate(String streamSpecifier, Number value)	Set frame rate.
T	setFrameSize(Number width, Number height)	Set frame size
T	setFrameSize(String streamSpecifier, Number width, Number height)	Set frame size
T	setFrameSize(String streamSpecifier, String resolution)	Set frame size
T	setPixelFormat(String format)
T	setPixelFormat(String streamSpecifier, String value)
T	setPosition(long positionMillis)	When used as an input option, seeks in this input file to position.
T	setPosition(long position, TimeUnit unit)
T	setPositionEof(long positionEofMillis)	Like the setPosition(long) (-ss) option but relative to the "end of file".
T	setPositionEof(long positionEof, TimeUnit unit)	Like the setPositionEof(long) (-ss) option but relative to the "end of file".
protected T	thisAsT()
protected static List<String>	toArguments(String key, Map<String,Object> args)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseInOut

public BaseInOut()

Method Detail

setFormat

public T setFormat(String format)

Force input or output file format. The format is normally auto detected for input files and guessed from the file extension for output files, so this option is not needed in most cases.

Parameters:

format - format

Returns:

this

setDuration

public T setDuration(long durationMillis)

When used as an input option, limit the duration of data read from the input file.

When used as an output option, stop writing the output after its duration reaches duration.

Parameters:

durationMillis - duration in milliseconds

Returns:

this

setDuration

public T setDuration(long duration,
                     TimeUnit timeUnit)

Parameters:

duration - duration

timeUnit - unit of duration

Returns:

this

See Also:

setDuration(long)

setPosition

public T setPosition(long positionMillis)

When used as an input option, seeks in this input file to position.

Note that in most formats it is not possible to seek exactly, so ffmpeg will seek to the closest seek point before position. When transcoding and -accurate_seek is enabled (the default), this extra segment between the seek point and position will be decoded and discarded. When doing stream copy or when -noaccurate_seek is used, it will be preserved.

When used as an output option (before an output url), decodes but discards input until the timestamps reach position.

Parameters:

positionMillis - position in milliseconds.

Returns:

this

setPosition

public T setPosition(long position,
                     TimeUnit unit)

Parameters:

position - position.

unit - time unit

Returns:

this

See Also:

setPosition(long)

setPositionEof

public T setPositionEof(long positionEofMillis)

Like the setPosition(long) (-ss) option but relative to the "end of file". That is negative values are earlier in the file, 0 is at EOF.

Parameters:

positionEofMillis - position in milliseconds, relative to the EOF

Returns:

this

setPositionEof

public T setPositionEof(long positionEof,
                        TimeUnit unit)

Like the setPositionEof(long) (-ss) option but relative to the "end of file". That is negative values are earlier in the file, 0 is at EOF.

Parameters:

positionEof - position, relative to the EOF

unit - time unit

Returns:

this

See Also:

setPositionEof(long)

setFrameRate

public T setFrameRate(Number value)

Set frame rate.

As an input option, ignore any timestamps stored in the file and instead generate timestamps assuming constant frame rate fps.

As an output option, duplicate or drop input frames to achieve constant output frame rate fps.

Parameters:

value - Hz value, fraction or abbreviation

Returns:

this

setFrameRate

public T setFrameRate(String streamSpecifier,
                      Number value)

Set frame rate.

As an input option, ignore any timestamps stored in the file and instead generate timestamps assuming constant frame rate fps.

As an output option, duplicate or drop input frames to achieve constant output frame rate fps.

Parameters:

streamSpecifier - stream specifier

value - Hz value, fraction or abbreviation

Returns:

this

setFrameSize

public T setFrameSize(Number width,
                      Number height)

Set frame size

As an input option, this is a shortcut for the video_size private option, recognized by some demuxers for which the frame size is either not stored in the file or is configurable

As an output option, this inserts the scale video filter to the end of the corresponding filtergraph.

Parameters:

width - frame width

height - frame height

Returns:

this

setFrameSize

public T setFrameSize(String streamSpecifier,
                      Number width,
                      Number height)

Set frame size

As an input option, this is a shortcut for the video_size private option, recognized by some demuxers for which the frame size is either not stored in the file or is configurable

As an output option, this inserts the scale video filter to the end of the corresponding filtergraph.

Parameters:

streamSpecifier - stream specifier

width - frame width

height - frame height

Returns:

this

setFrameSize

public T setFrameSize(String streamSpecifier,
                      String resolution)

Set frame size

As an input option, this is a shortcut for the video_size private option, recognized by some demuxers for which the frame size is either not stored in the file or is configurable

As an output option, this inserts the scale video filter to the end of the corresponding filtergraph.

Parameters:

streamSpecifier - stream specifier

resolution - width + "x" + height

Returns:

this

setCodec

public T setCodec(StreamType type,
                  String codecName)

setCodec

public T setCodec(String streamSpecifier,
                  String codecName)

setPixelFormat

public T setPixelFormat(String format)

setPixelFormat

public T setPixelFormat(String streamSpecifier,
                        String value)

addArguments

public T addArguments(String key,
                      String value)

Add custom arguments. Intended for cases, that are not yet supported by jaffree

Parameters:

key - key to add

value - value to add

Returns:

this

addArgument

public T addArgument(String argument)

Add custom argument. Intended for cases, that are not yet supported by jaffree

Parameters:

argument - argument to add

Returns:

this

buildArguments

public abstract List<String> buildArguments()

buildCommonArguments

protected final List<String> buildCommonArguments()

thisAsT

protected final T thisAsT()

toArguments

protected static List<String> toArguments(String key,
                                          Map<String,Object> args)