org.midica.midi

Class KaraokeAnalyzer

java.lang.Object

org.midica.midi.KaraokeAnalyzer

public class KaraokeAnalyzer
extends java.lang.Object

This class analyzes the karaoke-related messages of a MIDI sequence. It collects information from it and builds up the karaoke structures used by the player and the info window.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	chosenCharset
static int	KARAOKE_LYRICS
static int	KARAOKE_TEXT
private static java.util.HashMap<java.lang.String,java.lang.Object>	karaokeInfo
private static java.lang.String	karaokeMode
private static boolean	karLineEnded
private static long	karLineTick
private static java.util.regex.Pattern	karPattSecond
private static long	karPreAlertTicks
private static java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Long,java.lang.String>>	lyrics line begin tick – syllable tick – syllable
private static java.util.TreeSet<java.lang.Long>	lyricsEventTicks ticks of either lyrics events or pre-alerts
private static java.util.TreeMap<java.lang.Long,java.lang.String>	lyricsFlat Flat lyrics structure: tick – syllable
private static int	lyricsTrack
private static java.util.TreeMap<java.lang.Integer,java.lang.Integer>	lyricsTrackCounter
private static LyricUtil	lyricUtil
private static java.util.TreeSet<java.lang.Long>	markerTicks tick
private static float	MAX_SYL_SPACE_RATE
private static java.lang.String	midiFileCharset
private static float	PRE_ALERT_QUARTERS
private static java.util.TreeMap<java.lang.Integer,java.lang.Integer>	textTrackCounter
private static boolean	useLyrics

Constructor Summary

Constructors

Modifier	Constructor and Description
private	KaraokeAnalyzer() This class is only used statically so a public constructor is not needed.

Method Summary

Modifier and Type	Method and Description
static void	addEvent(int type, int track, long tick, byte[] content) Collects karaoke specific information from meta messages and adds the event to the lyrics, if necessary.
static void	chooseLyricsTypeAndTrack() Decides which meta event type and track number to use for the lyrics.
static void	countEventAndGetSongInfo(int type, int track, byte[] content) Counts the LYRICS or TEXT event by type and track for later determination about what to use for lyrics.
static java.lang.String	getFileCharset() Returns the last detected charset defined by a lyrics event in the sequence.
static java.util.HashMap<java.lang.String,java.lang.Object>	getKaraokeInfo() Returns karaoke-related information.
static java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Long,java.lang.String>>	getLyrics() Returns the tick/line/syllable structure of the lyrics.
static java.util.TreeSet<java.lang.Long>	getLyricsEventTicks() Returns all ticks where a lyrics event happens (either the lyrics itself for the pre-alert).
static java.util.TreeMap<java.lang.Long,java.lang.String>	getLyricsFlat() Returns the lyrics as tick/syllable pairs.
static java.lang.String	getLyricsForPlayer(long tick) Returns the lyrics including formatting to be displayed at the given tick.
static void	init(int resolution, java.lang.String charset, java.util.TreeSet<java.lang.Long> analyzerMarkerTicks) Initializes the internal data structures so that they are ready to be filled with karaoke and lyrics information.
static void	postprocess() Postprocesses data structures.
private static void	processKaraoke(java.lang.String text, int type, long tick, int track) Processes the given text as a karaoke meta or lyrics command.
static void	reset() Resets all information that can be queried in public getter methods.
static void	resetFileCharset() Resets the character set detected in the sequence.

Methods inherited from class java.lang.Object

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

Field Detail

KARAOKE_TEXT

public static final int KARAOKE_TEXT

See Also:

Constant Field Values

KARAOKE_LYRICS

public static final int KARAOKE_LYRICS

See Also:

Constant Field Values

PRE_ALERT_QUARTERS

private static final float PRE_ALERT_QUARTERS

See Also:

Constant Field Values

MAX_SYL_SPACE_RATE

private static final float MAX_SYL_SPACE_RATE

See Also:

Constant Field Values

chosenCharset

private static java.lang.String chosenCharset

lyricUtil

private static LyricUtil lyricUtil

midiFileCharset

private static java.lang.String midiFileCharset

karaokeMode

private static java.lang.String karaokeMode

karLineTick

private static long karLineTick

karLineEnded

private static boolean karLineEnded

karPreAlertTicks

private static long karPreAlertTicks

karPattSecond

private static java.util.regex.Pattern karPattSecond

textTrackCounter

private static java.util.TreeMap<java.lang.Integer,java.lang.Integer> textTrackCounter

lyricsTrackCounter

private static java.util.TreeMap<java.lang.Integer,java.lang.Integer> lyricsTrackCounter

lyricsTrack

private static int lyricsTrack

useLyrics

private static boolean useLyrics

karaokeInfo

private static java.util.HashMap<java.lang.String,java.lang.Object> karaokeInfo

lyricsEventTicks

private static java.util.TreeSet<java.lang.Long> lyricsEventTicks

ticks of either lyrics events or pre-alerts

markerTicks

private static java.util.TreeSet<java.lang.Long> markerTicks

tick

lyrics

private static java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Long,java.lang.String>> lyrics

line begin tick – syllable tick – syllable

lyricsFlat

private static java.util.TreeMap<java.lang.Long,java.lang.String> lyricsFlat

Flat lyrics structure: tick – syllable

Constructor Detail

KaraokeAnalyzer

private KaraokeAnalyzer()

This class is only used statically so a public constructor is not needed.

Method Detail

reset

public static void reset()

Resets all information that can be queried in public getter methods. This is called before a MIDI or MidicaPL file is parsed so that the getters don’t return the information of a former parsing after a later parsing failed.

getLyricsFlat

public static java.util.TreeMap<java.lang.Long,java.lang.String> getLyricsFlat()

Returns the lyrics as tick/syllable pairs.

• key: syllable tick
• value: syllable

Returns:

lyrics structure as described above.

init

public static void init(int resolution,
                        java.lang.String charset,
                        java.util.TreeSet<java.lang.Long> analyzerMarkerTicks)

Initializes the internal data structures so that they are ready to be filled with karaoke and lyrics information.

Parameters:

resolution - The sequence’s resolution in ticks per quarter note.

charset - The charset that has been chosen in the file chooser.

analyzerMarkerTicks - Marker ticks from the SequenceAnalyzer.

resetFileCharset

public static void resetFileCharset()

Resets the character set detected in the sequence. Called from the SequenceAnalyzer between several parsing runs of the same sequence.

getFileCharset

public static java.lang.String getFileCharset()

Returns the last detected charset defined by a lyrics event in the sequence.

Returns:

the last detected charset.

chooseLyricsTypeAndTrack

public static void chooseLyricsTypeAndTrack()

Decides which meta event type and track number to use for the lyrics.

getKaraokeInfo

public static java.util.HashMap<java.lang.String,java.lang.Object> getKaraokeInfo()

Returns karaoke-related information.

Lyrics related fields:

• lyrics: lyrics structure containing:
  • line begin tick
  • syllable tick
  • syllable
• lyrics_full:
  • the lyrics as one single string

Fields from RP-026 tags:

• title: title tag
• composer: composer tag
• lyricist: lyrics tag
• artist: artist tag
• software: software tag

Simple Soft Karaoke fields:

• sk_type: content of the @K tag
• sk_version: content of the @V tag
• sk_language: content of the @L tag
• sk_title: content of first @T tag
• sk_author: content of second @T tag
• sk_copyright: content of third @T tag

Special Soft Karaoke fields:

• sk_infos: ArrayList<String> of all contents of @I tags
• info: all @I tags, joined with \n

Returns:

the information as described above.

countEventAndGetSongInfo

public static void countEventAndGetSongInfo(int type,
                                            int track,
                                            byte[] content)

Counts the LYRICS or TEXT event by type and track for later determination about what to use for lyrics. Also retrieves song and karaoke related fields.

Parameters:

type - META message type: KARAOKE_TEXT or KARAOKE_LYRICS.

track - track number of the META message

content - text content of the META message.

addEvent

public static void addEvent(int type,
                            int track,
                            long tick,
                            byte[] content)

Collects karaoke specific information from meta messages and adds the event to the lyrics, if necessary.

Parameters:

type - META message type: KARAOKE_TEXT or KARAOKE_LYRICS.

track - Track number of the META message.

tick - Tickstamp of the META message.

content - Text content of the META message.

processKaraoke

private static void processKaraoke(java.lang.String text,
                                   int type,
                                   long tick,
                                   int track)

Processes the given text as a karaoke meta or lyrics command.

Parameters:

text - The text from the text or lyrics message.

type - The message type (1: text, 2: lyrics).

tick - Tickstamp of the event.

track - Track number of the event.

postprocess

public static void postprocess()

Postprocesses data structures.

• Joins all info headers (beginning with “@I”) to a single string.
• Deletes non printable characters.
• Adds spaces if necessary.
• Creates a full lyrics string for the info view.
• Re-organizes lines, if necessary.
• Replacements for the HTML view.
• HTML formatting for the second voice.

getLyrics

public static java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Long,java.lang.String>> getLyrics()

Returns the tick/line/syllable structure of the lyrics.

• first level: line begin tick
• second level: syllable begin tick
• third level: syllable

Returns:

the lyrics structure as described above.

getLyricsEventTicks

public static java.util.TreeSet<java.lang.Long> getLyricsEventTicks()

Returns all ticks where a lyrics event happens (either the lyrics itself for the pre-alert).

Returns:

the ticks.

getLyricsForPlayer

public static java.lang.String getLyricsForPlayer(long tick)

Returns the lyrics including formatting to be displayed at the given tick.

Parameters:

tick - Tickstamp in the MIDI sequence.

Returns:

the lyrics to be displayed.