net.raphimc.noteblocklib.util

Class SongUtil

java.lang.Object

net.raphimc.noteblocklib.util.SongUtil

public class SongUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SongUtil()

Method Summary

Modifier and Type	Method and Description
static <N extends Note> void	applyToAllNotes(SongView<N> songView, java.util.function.Consumer<N> noteConsumer) Applies the given consumer to all notes in the song view.
static <N extends Note> long	getNoteCount(SongView<N> songView) Returns the total amount of notes in a song.
static <N extends Note> java.util.Set<NbsCustomInstrument>	getUsedCustomInstruments(SongView<N> songView) Returns a list of all used custom instruments in a song.
static <N extends Note> java.util.Set<Instrument>	getUsedVanillaInstruments(SongView<N> songView) Returns a list of all used vanilla instruments in a song.
static <N extends Note> void	iterateAllNotes(SongView<N> songView, java.util.function.Predicate<N> notePredicate) Applies the given predicate to all notes in the song view.
static <N extends Note> void	removeDoubleNotes(SongView<N> songView) Removes duplicate notes which are on the same tick.
static <N extends Note> void	removeNotesIf(SongView<N> songView, java.util.function.Predicate<N> notePredicate) Removes all notes which match the given predicate.
static <N extends Note> void	removeSilentNotes(SongView<N> songView) Removes all notes which have a volume of 0.
static <N extends Note> void	removeSilentNotes(SongView<N> songView, float threshold) Removes all notes which have a volume lower than or equal the given threshold.

Methods inherited from class java.lang.Object

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

Constructor Detail

SongUtil

public SongUtil()

Method Detail

applyToAllNotes

public static <N extends Note> void applyToAllNotes(SongView<N> songView,
                                                    java.util.function.Consumer<N> noteConsumer)

Applies the given consumer to all notes in the song view.
This method will also modify the notes of the original song as the view references the original song notes.
Use cases for this method can be for example to transpose all notes in a song to be within the minecraft octave range.

Type Parameters:

N - The note type

Parameters:

songView - The song view

noteConsumer - The note consumer

iterateAllNotes

public static <N extends Note> void iterateAllNotes(SongView<N> songView,
                                                    java.util.function.Predicate<N> notePredicate)

Applies the given predicate to all notes in the song view.
The predicate can return true to break the iteration.

Type Parameters:

N - The note type

Parameters:

songView - The song view

notePredicate - The note predicate

removeNotesIf

public static <N extends Note> void removeNotesIf(SongView<N> songView,
                                                  java.util.function.Predicate<N> notePredicate)

Removes all notes which match the given predicate.

Type Parameters:

N - The note type

Parameters:

songView - The song view

notePredicate - The predicate

removeDoubleNotes

public static <N extends Note> void removeDoubleNotes(SongView<N> songView)

Removes duplicate notes which are on the same tick.
Useful when handling large MIDI files with a lot of duplicate notes.

Type Parameters:

N - The note type

Parameters:

songView - The song view

removeSilentNotes

public static <N extends Note> void removeSilentNotes(SongView<N> songView)

Removes all notes which have a volume of 0.

Type Parameters:

N - The note type

Parameters:

songView - The song view

removeSilentNotes

public static <N extends Note> void removeSilentNotes(SongView<N> songView,
                                                      float threshold)

Removes all notes which have a volume lower than or equal the given threshold.

Type Parameters:

N - The note type

Parameters:

songView - The song view

threshold - The threshold

getUsedVanillaInstruments

public static <N extends Note> java.util.Set<Instrument> getUsedVanillaInstruments(SongView<N> songView)

Returns a list of all used vanilla instruments in a song.

Type Parameters:

N - The note type

Parameters:

songView - The song view

Returns:

The used instruments

getUsedCustomInstruments

public static <N extends Note> java.util.Set<NbsCustomInstrument> getUsedCustomInstruments(SongView<N> songView)

Returns a list of all used custom instruments in a song.

Type Parameters:

N - The note type

Parameters:

songView - The song view

Returns:

The used custom instruments

getNoteCount

public static <N extends Note> long getNoteCount(SongView<N> songView)

Returns the total amount of notes in a song.

Type Parameters:

N - The note type

Parameters:

songView - The song view

Returns:

The note count