/// <summary>
/// Removes all the <see cref="Chord"/> that match the conditions defined by the specified predicate.
/// </summary>
/// <param name="file"><see cref="MidiFile"/> to search for chords to remove.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to remove.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException"><paramref name="file"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void RemoveChords(this MidiFile file, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(file), file);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
file.GetTrackChunks().RemoveChords(match, notesTolerance);
}
/// <summary>
/// Removes all the <see cref="Chord"/> that match the conditions defined by the specified predicate.
/// </summary>
/// <param name="trackChunk"><see cref="TrackChunk"/> to search for chords to remove.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to remove.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException"><paramref name="trackChunk"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void RemoveChords(this TrackChunk trackChunk, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunk), trackChunk);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
trackChunk.Events.RemoveChords(match, notesTolerance);
}
/// <summary>
/// Gets chords contained in the specified <see cref="MidiFile"/>.
/// </summary>
/// <param name="file"><see cref="MidiFile"/> to search for chords.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords contained in <paramref name="file"/> ordered by time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="file"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static IEnumerable <Chord> GetChords(this MidiFile file, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(file), file);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(file.GetTrackChunks().GetChords(notesTolerance));
}
/// <summary>
/// Gets chords contained in the specified <see cref="EventsCollection"/>.
/// </summary>
/// <param name="eventsCollection"><see cref="EventsCollection"/> to search for chords.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords contained in <paramref name="eventsCollection"/> ordered by time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="eventsCollection"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static IEnumerable <Chord> GetChords(this EventsCollection eventsCollection, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(eventsCollection), eventsCollection);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(eventsCollection.ManageChords(notesTolerance).Chords.ToList());
}
/// <summary>
/// Creates an instance of the <see cref="ChordsManager"/> initializing it with the
/// events collection of the specified track chunk, notes tolerance and comparison delegate for events
/// that have same time.
/// </summary>
/// <param name="trackChunk"><see cref="TrackChunk"/> that holds chords to manage.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <param name="sameTimeEventsComparison">Delegate to compare events with the same absolute time.</param>
/// <returns>An instance of the <see cref="ChordsManager"/> that can be used to manage
/// chords represented by the <paramref name="trackChunk"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="trackChunk"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static ChordsManager ManageChords(this TrackChunk trackChunk, long notesTolerance = 0, Comparison <MidiEvent> sameTimeEventsComparison = null)
{
ThrowIfArgument.IsNull(nameof(trackChunk), trackChunk);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(trackChunk.Events.ManageChords(notesTolerance, sameTimeEventsComparison));
}
/// <summary>
/// Gets chords contained in the specified <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunk"><see cref="TrackChunk"/> to search for chords.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords contained in <paramref name="trackChunk"/> ordered by time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="trackChunk"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static IEnumerable <Chord> GetChords(this TrackChunk trackChunk, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunk), trackChunk);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(trackChunk.Events.GetChords(notesTolerance));
}
/// <summary>
/// Creates an instance of the <see cref="ChordsManager"/> initializing it with the
/// specified events collection, notes tolerance and comparison delegate for events that have same time.
/// </summary>
/// <param name="eventsCollection"><see cref="EventsCollection"/> that holds chords to manage.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <param name="sameTimeEventsComparison">Delegate to compare events with the same absolute time.</param>
/// <returns>An instance of the <see cref="ChordsManager"/> that can be used to manage chords
/// represented by the <paramref name="eventsCollection"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="eventsCollection"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static ChordsManager ManageChords(this EventsCollection eventsCollection, long notesTolerance = 0, Comparison <MidiEvent> sameTimeEventsComparison = null)
{
ThrowIfArgument.IsNull(nameof(eventsCollection), eventsCollection);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(new ChordsManager(eventsCollection, notesTolerance, sameTimeEventsComparison));
}
/// <summary>
/// Performs the specified action on each <see cref="Chord"/> contained in the <see cref="MidiFile"/>.
/// </summary>
/// <param name="file"><see cref="MidiFile"/> to search for chords to process.</param>
/// <param name="action">The action to perform on each <see cref="Chord"/> contained in the
/// <paramref name="file"/>.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to process.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="file"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="action"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void ProcessChords(this MidiFile file, Action <Chord> action, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(file), file);
ThrowIfArgument.IsNull(nameof(action), action);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
file.GetTrackChunks().ProcessChords(action, match, notesTolerance);
}
/// <summary>
/// Performs the specified action on each <see cref="Chord"/> contained in the <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunk"><see cref="TrackChunk"/> to search for chords to process.</param>
/// <param name="action">The action to perform on each <see cref="Chord"/> contained in the
/// <paramref name="trackChunk"/>.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to process.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="trackChunk"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="action"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void ProcessChords(this TrackChunk trackChunk, Action <Chord> action, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunk), trackChunk);
ThrowIfArgument.IsNull(nameof(action), action);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
trackChunk.Events.ProcessChords(action, match, notesTolerance);
}
/// <summary>
/// Creates chords from notes.
/// </summary>
/// <param name="notes">Notes to create chords from.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords made up from <paramref name="notes"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="notes"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static IEnumerable <Chord> GetChords(this IEnumerable <Note> notes, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(notes), notes);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(ChordsManager.CreateChords(notes, notesTolerance)
.OrderBy(c => c.Time)
.ToList());
}
/// <summary>
/// Removes all the <see cref="Chord"/> that match the conditions defined by the specified predicate.
/// </summary>
/// <param name="trackChunks">Collection of <see cref="TrackChunk"/> to search for chords to remove.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to remove.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException"><paramref name="trackChunks"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void RemoveChords(this IEnumerable <TrackChunk> trackChunks, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunks), trackChunks);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
foreach (var trackChunk in trackChunks)
{
trackChunk?.RemoveChords(match, notesTolerance);
}
}
/// <summary>
/// Removes all the <see cref="Chord"/> that match the conditions defined by the specified predicate.
/// </summary>
/// <param name="eventsCollection"><see cref="EventsCollection"/> to search for chords to remove.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to remove.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException"><paramref name="eventsCollection"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void RemoveChords(this EventsCollection eventsCollection, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(eventsCollection), eventsCollection);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
using (var chordsManager = eventsCollection.ManageChords(notesTolerance))
{
chordsManager.Chords.RemoveAll(match ?? (c => true));
}
}
/// <summary>
/// Gets chords contained in the specified collection of <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunks">Track chunks to search for chords.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords contained in <paramref name="trackChunks"/> ordered by time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="trackChunks"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static IEnumerable <Chord> GetChords(this IEnumerable <TrackChunk> trackChunks, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunks), trackChunks);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
return(trackChunks.Where(c => c != null)
.SelectMany(c => c.GetChords(notesTolerance))
.OrderBy(c => c.Time)
.ToList());
}
/// <summary>
/// Initializes a new instance of the <see cref="ChordsManager"/> with the specified events
/// collection, notes tolerance and comparison delegate for events that have same time.
/// </summary>
/// <param name="eventsCollection"><see cref="EventsCollection"/> that holds chord events to manage.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <param name="sameTimeEventsComparison">Delegate to compare events with the same absolute time.</param>
/// <exception cref="ArgumentNullException"><paramref name="eventsCollection"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public ChordsManager(EventsCollection eventsCollection, long notesTolerance = 0, Comparison <MidiEvent> sameTimeEventsComparison = null)
{
ThrowIfArgument.IsNull(nameof(eventsCollection), eventsCollection);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
_notesManager = eventsCollection.ManageNotes(sameTimeEventsComparison);
Chords = new ChordsCollection(CreateChords(_notesManager.Notes, notesTolerance));
Chords.CollectionChanged += OnChordsCollectionChanged;
}
/// <summary>
/// Performs the specified action on each <see cref="Chord"/> contained in the collection of
/// <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunks">Collection of <see cref="TrackChunk"/> to search for chords to process.</param>
/// <param name="action">The action to perform on each <see cref="Chord"/> contained in the
/// <paramref name="trackChunks"/>.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to process.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="trackChunks"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="action"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void ProcessChords(this IEnumerable <TrackChunk> trackChunks, Action <Chord> action, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(trackChunks), trackChunks);
ThrowIfArgument.IsNull(nameof(action), action);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
foreach (var trackChunk in trackChunks)
{
trackChunk?.ProcessChords(action, match, notesTolerance);
}
}
/// <summary>
/// Gets chords contained in the specified collection of <see cref="MidiEvent"/>.
/// </summary>
/// <param name="events">Collection of<see cref="MidiFile"/> to search for chords.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <returns>Collection of chords contained in <paramref name="events"/> ordered by time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="events"/> is <c>null</c>.</exception>
public static IEnumerable <Chord> GetChords(this IEnumerable <MidiEvent> events, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(events), events);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
var eventsCollection = new EventsCollection();
eventsCollection.AddRange(events);
return(eventsCollection.ManageChords(notesTolerance).Chords.ToList());
}
/// <summary>
/// Performs the specified action on each <see cref="Chord"/> contained in the <see cref="EventsCollection"/>.
/// </summary>
/// <param name="eventsCollection"><see cref="EventsCollection"/> to search for chords to process.</param>
/// <param name="action">The action to perform on each <see cref="Chord"/> contained in the
/// <paramref name="eventsCollection"/>.</param>
/// <param name="match">The predicate that defines the conditions of the <see cref="Chord"/> to process.</param>
/// <param name="notesTolerance">Notes tolerance that defines maximum distance of notes from the
/// start of the first note of a chord. Notes within this tolerance will be considered as a chord.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="eventsCollection"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="action"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="notesTolerance"/> is negative.</exception>
public static void ProcessChords(this EventsCollection eventsCollection, Action <Chord> action, Predicate <Chord> match = null, long notesTolerance = 0)
{
ThrowIfArgument.IsNull(nameof(eventsCollection), eventsCollection);
ThrowIfArgument.IsNull(nameof(action), action);
ThrowIfNotesTolerance.IsNegative(nameof(notesTolerance), notesTolerance);
using (var chordsManager = eventsCollection.ManageChords(notesTolerance))
{
foreach (var chord in chordsManager.Chords.Where(c => match?.Invoke(c) != false))
{
action(chord);
}
}
}