be.tarsos.transcoder.ffmpeg

Class Encoder

java.lang.Object

be.tarsos.transcoder.ffmpeg.Encoder

public class Encoder
extends java.lang.Object

Main class of the package. Instances can encode audio and video streams.

Author:

Carlo Pelliccia, Joren Six

Constructor Summary

Constructors

Constructor and Description
Encoder() It builds an encoder using a locator instance to locate the ffmpeg executable to use.

Method Summary

Modifier and Type	Method and Description
static void	addFFMPEGLocator(FFMPEGLocator locator)
void	encode(java.io.File source, java.io.File target, Attributes attributes) Re-encode a multimedia file.
Attributes	getInfo(java.io.File source) Returns a set informations about a multimedia file, if its format is supported for decoding.
static javax.sound.sampled.AudioFormat	getTargetAudioFormat(Attributes attributes) Constructs the target audio format.
static boolean	hasLocators()
javax.sound.sampled.AudioInputStream	stream(java.lang.String source, Attributes attributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder()

It builds an encoder using a locator instance to locate the ffmpeg executable to use.

Method Detail

addFFMPEGLocator

public static void addFFMPEGLocator(FFMPEGLocator locator)

hasLocators

public static boolean hasLocators()

getInfo

public Attributes getInfo(java.io.File source)
                   throws InputFormatException,
                          EncoderException

Returns a set informations about a multimedia file, if its format is supported for decoding.

Parameters:

source - The source multimedia file.

Returns:

A set of informations about the file and its contents.

Throws:

InputFormatException - If the format of the source file cannot be recognized and decoded.

EncoderException - If a problem occurs calling the underlying ffmpeg executable.

encode

public void encode(java.io.File source,
                   java.io.File target,
                   Attributes attributes)
            throws EncoderException

Re-encode a multimedia file.

Parameters:

source - The source multimedia file. It cannot be null. Be sure this file can be decoded.

target - The target multimedia re-encoded file. It cannot be null. If this file already exists, it will be overwrited.

attributes - A set of attributes for the attributes process.

Throws:

java.lang.IllegalArgumentException - If both audio and video parameters are null.

EncoderException - If a problems occurs during the attributes process.

stream

public javax.sound.sampled.AudioInputStream stream(java.lang.String source,
                                                   Attributes attributes)
                                            throws EncoderException

Throws:

EncoderException

getTargetAudioFormat

public static javax.sound.sampled.AudioFormat getTargetAudioFormat(Attributes attributes)

Constructs the target audio format. The audio format is one channel signed PCM of a given sample rate.

Parameters:

attributes - The audio format (sample rate, format, bit depth, channels,...) to convert to.

Returns:

The audio format after conversion.