/// <summary>
/// Initializes a new instance of the <see cref="Playback"/> with the specified
/// collection of timed objects and tempo map.
/// </summary>
/// <param name="timedObjects">Collection of timed objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException"><paramref name="timedObjects"/> is null. -or-
/// <paramref name="tempoMap"/> is null.</exception>
public Playback(IEnumerable <ITimedObject> timedObjects, TempoMap tempoMap, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(timedObjects), timedObjects);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
var playbackEvents = GetPlaybackEvents(timedObjects, tempoMap);
_eventsEnumerator = playbackEvents.GetEnumerator();
_eventsEnumerator.MoveNext();
var lastPlaybackEvent = playbackEvents.LastOrDefault();
_duration = lastPlaybackEvent?.Time ?? TimeSpan.Zero;
_durationInTicks = lastPlaybackEvent?.RawTime ?? 0;
_notesMetadata = playbackEvents.Select(e => e.Metadata.Note).Where(m => m != null).ToList();
_notesMetadata.Sort((m1, m2) => m1.StartTime.CompareTo(m2.StartTime));
TempoMap = tempoMap;
clockSettings = clockSettings ?? new MidiClockSettings();
_clock = new MidiClock(false, clockSettings.CreateTickGeneratorCallback(ClockInterval));
_clock.Ticked += OnClockTicked;
Snapping = new PlaybackSnapping(playbackEvents, tempoMap);
}
/// <summary>
/// Plays MIDI events contained in the specified <see cref="MidiFile"/>.
/// </summary>
/// <param name="midiFile"><see cref="MidiFile"/> containing events to play.</param>
/// <param name="outputDevice">Output MIDI device to play events through.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="midiFile"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static void Play(this MidiFile midiFile, IOutputDevice outputDevice, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(midiFile), midiFile);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
midiFile.GetTrackChunks().Play(midiFile.GetTempoMap(), outputDevice, clockSettings);
}
private static Playback GetMusicalObjectsPlayback <TObject>(IEnumerable <TObject> objects,
TempoMap tempoMap,
IOutputDevice outputDevice,
Func <FourBitNumber, IEnumerable <MidiEvent> > programChangeEventsGetter,
MidiClockSettings clockSettings)
where TObject : IMusicalObject, ITimedObject
{
var programChangeEvents = objects.Select(n => n.Channel)
.Distinct()
.SelectMany(programChangeEventsGetter)
.Select(e => (ITimedObject) new TimedEvent(e));
return(new Playback(programChangeEvents.Concat((IEnumerable <ITimedObject>)objects), tempoMap, outputDevice, clockSettings));
}
/// <summary>
/// Initializes a new instance of the <see cref="Playback"/> with the specified
/// collection of timed objects, tempo map and output MIDI device to play events through.
/// </summary>
/// <param name="timedObjects">Collection of timed objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="timedObjects"/> through.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException"><paramref name="timedObjects"/> is null. -or-
/// <paramref name="tempoMap"/> is null. -or- <paramref name="outputDevice"/> is null.</exception>
public Playback(IEnumerable <ITimedObject> timedObjects, TempoMap tempoMap, IOutputDevice outputDevice, MidiClockSettings clockSettings = null)
: this(timedObjects, tempoMap, clockSettings)
{
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
OutputDevice = outputDevice;
}
/// <summary>
/// Initializes a new instance of the <see cref="Playback"/> with the specified
/// collection of MIDI events collections, tempo map and output MIDI device to play events through.
/// </summary>
/// <param name="events">Collection of MIDI events collections to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="events"/> through.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException"><paramref name="events"/> is null. -or-
/// <paramref name="tempoMap"/> is null. -or- <paramref name="outputDevice"/> is null.</exception>
public Playback(IEnumerable <IEnumerable <MidiEvent> > events, TempoMap tempoMap, IOutputDevice outputDevice, MidiClockSettings clockSettings = null)
: this(GetTimedObjects(events), tempoMap, outputDevice, clockSettings)
{
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the specified <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunk"><see cref="TrackChunk"/> containing events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the <paramref name="trackChunk"/>.</returns>
/// <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="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static Playback GetPlayback(this TrackChunk trackChunk, TempoMap tempoMap, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(trackChunk), trackChunk);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
return(new Playback(trackChunk.Events, tempoMap, clockSettings));
}
/// <summary>
/// Plays musical objects using the specified General MIDI 2 program.
/// </summary>
/// <typeparam name="TObject">The type of objects to play.</typeparam>
/// <param name="objects">Objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="objects"/> through.</param>
/// <param name="generalMidi2Program">Program that should be used to play <paramref name="objects"/>.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="objects"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="InvalidEnumArgumentException"><paramref name="generalMidi2Program"/> specified an invalid value.</exception>
public static void Play <TObject>(this IEnumerable <TObject> objects, TempoMap tempoMap, IOutputDevice outputDevice, GeneralMidi2Program generalMidi2Program, MidiClockSettings clockSettings = null)
where TObject : IMusicalObject, ITimedObject
{
ThrowIfArgument.IsNull(nameof(objects), objects);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
ThrowIfArgument.IsInvalidEnumValue(nameof(generalMidi2Program), generalMidi2Program);
using (var playback = objects.GetPlayback(tempoMap, outputDevice, generalMidi2Program, clockSettings))
{
playback.Play();
}
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the specified <see cref="MidiFile"/>.
/// </summary>
/// <param name="midiFile"><see cref="MidiFile"/> containing events to play.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the <paramref name="midiFile"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="midiFile"/> is <c>null</c>.</exception>
public static Playback GetPlayback(this MidiFile midiFile, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(midiFile), midiFile);
return(GetPlayback(midiFile.GetTrackChunks(), midiFile.GetTempoMap(), clockSettings));
}
/// <summary>
/// Plays MIDI events that will be produced by specified <see cref="Pattern"/>.
/// </summary>
/// <param name="pattern"><see cref="Pattern"/> producing events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="channel">MIDI channel to play channel events on.</param>
/// <param name="outputDevice">Output MIDI device to play events through.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="pattern"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static void Play(this Pattern pattern, TempoMap tempoMap, FourBitNumber channel, IOutputDevice outputDevice, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(pattern), pattern);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
pattern.ToTrackChunk(tempoMap, channel).Play(tempoMap, outputDevice, clockSettings);
}
/// <summary>
/// Plays MIDI events contained in the specified collection of <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunks">Collection of <see cref="TrackChunk"/> containing events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play events through.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</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="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static void Play(this IEnumerable <TrackChunk> trackChunks, TempoMap tempoMap, IOutputDevice outputDevice, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(trackChunks), trackChunks);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
using (var playback = trackChunks.GetPlayback(tempoMap, outputDevice, clockSettings))
{
playback.Play();
}
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing musical objects using
/// the specified General MIDI 2 program.
/// </summary>
/// <typeparam name="TObject">The type of objects to play.</typeparam>
/// <param name="objects">Objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="objects"/> through.</param>
/// <param name="generalMidi2Program">Program that should be used to play <paramref name="objects"/>.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing <paramref name="objects"/>.</returns>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="objects"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
/// <exception cref="InvalidEnumArgumentException"><paramref name="generalMidi2Program"/> specified an invalid value.</exception>
public static Playback GetPlayback <TObject>(this IEnumerable <TObject> objects, TempoMap tempoMap, IOutputDevice outputDevice, GeneralMidi2Program generalMidi2Program, MidiClockSettings clockSettings = null)
where TObject : IMusicalObject, ITimedObject
{
ThrowIfArgument.IsNull(nameof(objects), objects);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
ThrowIfArgument.IsInvalidEnumValue(nameof(generalMidi2Program), generalMidi2Program);
return(GetMusicalObjectsPlayback(objects,
tempoMap,
outputDevice,
channel => generalMidi2Program.GetProgramEvents(channel),
clockSettings));
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing musical objects using
/// the specified program.
/// </summary>
/// <typeparam name="TObject">The type of objects to play.</typeparam>
/// <param name="objects">Objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="objects"/> through.</param>
/// <param name="programNumber">Program that should be used to play <paramref name="objects"/>.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing <paramref name="objects"/>.</returns>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="objects"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static Playback GetPlayback <TObject>(this IEnumerable <TObject> objects, TempoMap tempoMap, IOutputDevice outputDevice, SevenBitNumber programNumber, MidiClockSettings clockSettings = null)
where TObject : IMusicalObject, ITimedObject
{
ThrowIfArgument.IsNull(nameof(objects), objects);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
return(GetMusicalObjectsPlayback(objects,
tempoMap,
outputDevice,
channel => new[] { new ProgramChangeEvent(programNumber)
{
Channel = channel
} },
clockSettings));
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing MIDI events that will be
/// produced by specified <see cref="Pattern"/>.
/// </summary>
/// <param name="pattern"><see cref="Pattern"/> producing events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="channel">MIDI channel to play channel events on.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing MIDI events that will be
/// produced by the <paramref name="pattern"/>.</returns>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="pattern"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static Playback GetPlayback(this Pattern pattern, TempoMap tempoMap, FourBitNumber channel, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(pattern), pattern);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
return(pattern.ToTrackChunk(tempoMap, channel).GetPlayback(tempoMap, clockSettings));
}
/// <summary>
/// Initializes a new instance of the <see cref="Playback"/> with the specified
/// collection of MIDI events and tempo map.
/// </summary>
/// <param name="events">Collection of MIDI events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException"><paramref name="events"/> is null. -or-
/// <paramref name="tempoMap"/> is null.</exception>
public Playback(IEnumerable <MidiEvent> events, TempoMap tempoMap, MidiClockSettings clockSettings = null)
: this(new[] { events }, tempoMap, clockSettings)
{
ThrowIfArgument.IsNull(nameof(events), events);
}
/// <summary>
/// Plays musical objects using the specified program.
/// </summary>
/// <typeparam name="TObject">The type of objects to play.</typeparam>
/// <param name="objects">Objects to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="outputDevice">Output MIDI device to play <paramref name="objects"/> through.</param>
/// <param name="programNumber">Program that should be used to play <paramref name="objects"/>.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <exception cref="ArgumentNullException">
/// <para>One of the following errors occured:</para>
/// <list type="bullet">
/// <item>
/// <description><paramref name="objects"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// <item>
/// <description><paramref name="outputDevice"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static void Play <TObject>(this IEnumerable <TObject> objects, TempoMap tempoMap, IOutputDevice outputDevice, SevenBitNumber programNumber, MidiClockSettings clockSettings = null)
where TObject : IMusicalObject, ITimedObject
{
ThrowIfArgument.IsNull(nameof(objects), objects);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
ThrowIfArgument.IsNull(nameof(outputDevice), outputDevice);
using (var playback = objects.GetPlayback(tempoMap, outputDevice, programNumber, clockSettings))
{
playback.Play();
}
}
private PlaybackCurrentTimeWatcher(MidiClockSettings clockSettings = null)
{
_clockSettings = clockSettings ?? new MidiClockSettings();
PollingInterval = DefaultPollingInterval;
}
/// <summary>
/// Retrieves an instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the specified collection of <see cref="TrackChunk"/>.
/// </summary>
/// <param name="trackChunks">Collection of <see cref="TrackChunk"/> containing events to play.</param>
/// <param name="tempoMap">Tempo map used to calculate events times.</param>
/// <param name="clockSettings">Settings of the internal playback's clock.</param>
/// <returns>An instance of the <see cref="Playback"/> for playing MIDI events contained in
/// the <paramref name="trackChunks"/>.</returns>
/// <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="tempoMap"/> is <c>null</c>.</description>
/// </item>
/// </list>
/// </exception>
public static Playback GetPlayback(this IEnumerable <TrackChunk> trackChunks, TempoMap tempoMap, MidiClockSettings clockSettings = null)
{
ThrowIfArgument.IsNull(nameof(trackChunks), trackChunks);
ThrowIfArgument.IsNull(nameof(tempoMap), tempoMap);
return(new Playback(trackChunks.Select(c => c.Events), tempoMap, clockSettings));
}