be.hogent.tarsos.util
Enum ConfKey

java.lang.Object
  java.lang.Enum<ConfKey>
      be.hogent.tarsos.util.ConfKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConfKey>

public enum ConfKey
extends java.lang.Enum<ConfKey>

Defines a configuration key.

Author:

Joren Six

Enum Constant Summary

absolute_cents_reference_frequency
The reference frequency to base all absolute cent calculations on.

annotation_threads
Defines the number of threads used to annotate files.

audio_file_name_pattern
If a filename matches this regular expression pattern it is an audio file.

data_directory
The (relative) directory to save transcoded files and data files.

file_export_dir
The location to export a file with a file chooser dialog.

file_import_dir
The location to import a file with a file chooser dialog.

file_recent
Files recently analysed.

histogram_bin_width
The histogram bin width in cents.

interval_scala_file
A scala file with pitch intervals used to compare detected intervals.

ipem_pitch_threshold
When using the IPEM polyphonic pitch tracker a threshold can be used to accept only some pitches.

midi_input_device
A MIDI device used as INPUT.

midi_instrument_index
An index for a General MIDI instrument

midi_output_device
A MIDI device used as OUTPUT.

mixer_input_device
Microphone mixer to use with Tarsos Live(tm).

mixer_output_device
Sound card device index.

pitch_contour_marks
The marks used in plots the value should be one of the following: none, points, dots, various, bigdots or pixels.

pitch_contour_unit
Defines the unit used in the pitch contour diagram.

pitch_histogram_start
The pitch histogram (range) start value in cents:
The default value is 0 (from 8Hz).

pitch_histogram_stop
The Ambitus (range) stop value in cents:
The default value is
1200 * 8 = 9600 cents = C8 = 4186.01 Hz.

pitch_tracker_current
The pitch tracker currently in use.

pitch_tracker_list
The pitch trackers currently in use.

reset_on_import
Reset the histograms when a new file is imported.

silence_threshold
A threshold used in the silence detector.

tarsos_live
Start Tarsos in Tarsos Live(tm) mode: analyse microphone input in in stead of static files.

transcode_audio
Transcode the audio or just copy it.

transcode_check_format
Checks if the transcoded audio is in the configured format, this can be skipped for performance reasons.

transcoded_audio_to
The format to transcode the audio to.

Method Summary

boolean	isRequiredDirectory() Checks if this key is a required directory.
static ConfKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConfKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

histogram_bin_width

public static final ConfKey histogram_bin_width

The histogram bin width in cents.

data_directory

public static final ConfKey data_directory

The (relative) directory to save transcoded files and data files.

absolute_cents_reference_frequency

public static final ConfKey absolute_cents_reference_frequency

The reference frequency to base all absolute cent calculations on.
The default value is the frequency of C0 with A4 tuned to 440Hz:
440/32 * Math.pow(2.0,0.25) = 16.35 Hz.

pitch_histogram_start

public static final ConfKey pitch_histogram_start

The pitch histogram (range) start value in cents:
The default value is 0 (from 8Hz).

pitch_histogram_stop

public static final ConfKey pitch_histogram_stop

The Ambitus (range) stop value in cents:
The default value is
1200 * 8 = 9600 cents = C8 = 4186.01 Hz.

transcode_audio

public static final ConfKey transcode_audio

Transcode the audio or just copy it.
The default is true.

transcoded_audio_to

public static final ConfKey transcoded_audio_to

The format to transcode the audio to. It is one of the enum values defined in DefaultAttributes.

transcode_check_format

public static final ConfKey transcode_check_format

Checks if the transcoded audio is in the configured format, this can be skipped for performance reasons.

pitch_tracker_current

public static final ConfKey pitch_tracker_current

The pitch tracker currently in use.

pitch_tracker_list

public static final ConfKey pitch_tracker_list

The pitch trackers currently in use.

midi_input_device

public static final ConfKey midi_input_device

A MIDI device used as INPUT.

midi_output_device

public static final ConfKey midi_output_device

A MIDI device used as OUTPUT. Should support the MIDI tuning standard.

midi_instrument_index

public static final ConfKey midi_instrument_index

An index for a General MIDI instrument

annotation_threads

public static final ConfKey annotation_threads

Defines the number of threads used to annotate files. Ideally this is the same as the number of cores on your CPU. Use one thread less if you want to keep your system responsive. My system has 4 so the default is 3.

audio_file_name_pattern

public static final ConfKey audio_file_name_pattern

If a filename matches this regular expression pattern it is an audio file.
The default is .*\.(mp3|...|mpc|MPC).

ipem_pitch_threshold

public static final ConfKey ipem_pitch_threshold

When using the IPEM polyphonic pitch tracker a threshold can be used to accept only some pitches. Default value is 0.05.

silence_threshold

public static final ConfKey silence_threshold

A threshold used in the silence detector.

pitch_contour_marks

public static final ConfKey pitch_contour_marks

The marks used in plots the value should be one of the following: none, points, dots, various, bigdots or pixels. The default value is points.

pitch_contour_unit

public static final ConfKey pitch_contour_unit

Defines the unit used in the pitch contour diagram. One of the PitchUnit enumeration names (HERTZ|RELATIVE_CENTS|ABSOLUTE_CENTS|MIDI_KEY|MIDI_CENT).

file_import_dir

public static final ConfKey file_import_dir

The location to import a file with a file chooser dialog.

file_export_dir

public static final ConfKey file_export_dir

The location to export a file with a file chooser dialog.

file_recent

public static final ConfKey file_recent

Files recently analysed.

tarsos_live

public static final ConfKey tarsos_live

Start Tarsos in Tarsos Live(tm) mode: analyse microphone input in in stead of static files.

interval_scala_file

public static final ConfKey interval_scala_file

A scala file with pitch intervals used to compare detected intervals.

mixer_input_device

public static final ConfKey mixer_input_device

Microphone mixer to use with Tarsos Live(tm).

mixer_output_device

public static final ConfKey mixer_output_device

Sound card device index.

reset_on_import

public static final ConfKey reset_on_import

Reset the histograms when a new file is imported. Or not.

Method Detail

values

public static ConfKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfKey c : ConfKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfKey valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isRequiredDirectory

public boolean isRequiredDirectory()

Checks if this key is a required directory.

Returns:

True if the configured value is a required directory, false otherwise.