org.midica.file.write

Class AudioExporter

java.lang.Object

org.midica.file.write.Exporter

org.midica.file.write.AudioExporter

public class AudioExporter
extends Exporter

This class is used to export the currently loaded MIDI sequence as an audio file. Different audio formats are supported.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANNELS
static int	DEFAULT_CHANNELS
static java.lang.String	DEFAULT_ENCODING
static boolean	DEFAULT_IS_BIG_ENDIAN
static float	DEFAULT_SAMPLE_RATE
static int	DEFAULT_SAMPLE_SIZE_BITS
static java.lang.String	ENCODING
static boolean	IS_BIG_ENDIAN
static float	SAMPLE_RATE
static int	SAMPLE_SIZE_BITS

Constructor Summary

Constructors

Constructor and Description
AudioExporter() Creates a new audio exporter.

Method Summary

Modifier and Type	Method and Description
ExportResult	export(java.io.File file) Exports an audio file.
private static javax.sound.sampled.AudioFormat.Encoding	getEncoding(java.lang.String encodingStr) Returns an encoding by a string.
static java.util.ArrayList<javax.sound.sampled.AudioFormat.Encoding>	getEncodings() Returns a list with all possible encoding formats.
private static javax.sound.sampled.AudioFileFormat.Type	getFileType(java.io.File file) Returns a file type according to the given file’s extension,
static java.lang.String	getSupportedFileExtensions() Returns a comma-separated list of all supported file extensions for audio exports.
static java.util.ArrayList<java.lang.String>	getSupportedFileTypes() Returns a list of all file types that are supported by the operating system.
private void	refreshConfig() Re-reads all config variables that are relevant for audio export.

Methods inherited from class org.midica.file.write.Exporter

createFile

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

DEFAULT_SAMPLE_SIZE_BITS

public static final int DEFAULT_SAMPLE_SIZE_BITS

See Also:

Constant Field Values

DEFAULT_SAMPLE_RATE

public static final float DEFAULT_SAMPLE_RATE

See Also:

Constant Field Values

DEFAULT_CHANNELS

public static final int DEFAULT_CHANNELS

See Also:

Constant Field Values

DEFAULT_IS_BIG_ENDIAN

public static final boolean DEFAULT_IS_BIG_ENDIAN

See Also:

Constant Field Values

ENCODING

public static java.lang.String ENCODING

SAMPLE_SIZE_BITS

public static int SAMPLE_SIZE_BITS

SAMPLE_RATE

public static float SAMPLE_RATE

CHANNELS

public static int CHANNELS

IS_BIG_ENDIAN

public static boolean IS_BIG_ENDIAN

Constructor Detail

AudioExporter

public AudioExporter()

Creates a new audio exporter.

Method Detail

export

public ExportResult export(java.io.File file)
                    throws ExportException

Exports an audio file.

Specified by:

export in class Exporter

Parameters:

file - target audio file

Returns:

an empty data structure (warnings are not used for audio exports).

Throws:

ExportException - if the file can not be exported correctly.

getEncodings

public static java.util.ArrayList<javax.sound.sampled.AudioFormat.Encoding> getEncodings()

Returns a list with all possible encoding formats.

getSupportedFileTypes

public static java.util.ArrayList<java.lang.String> getSupportedFileTypes()

Returns a list of all file types that are supported by the operating system. Each entry contains the name of the file type and the according file extension(s).

Returns:

the supported file types.

getSupportedFileExtensions

public static java.lang.String getSupportedFileExtensions()

Returns a comma-separated list of all supported file extensions for audio exports.

Returns:

list of supported audio file extensions.

getEncoding

private static javax.sound.sampled.AudioFormat.Encoding getEncoding(java.lang.String encodingStr)

Returns an encoding by a string.

Parameters:

encodingStr - encoding string like it is used in the config file

Returns:

the according encoding, or PCM_SIGNED, if no matching encoding is found.

getFileType

private static javax.sound.sampled.AudioFileFormat.Type getFileType(java.io.File file)

Returns a file type according to the given file’s extension,

Parameters:

file - the target file

Returns:

the file type

refreshConfig

private void refreshConfig()

Re-reads all config variables that are relevant for audio export.