osu-framework / osu.Framework / Audio / Sample / Sample.cs

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using osu.Framework.Bindables;

namespace osu.Framework.Audio.Sample
{
    public abstract class Sample : AudioCollectionManager<SampleChannel>, ISample
    {
        public const int DEFAULT_CONCURRENCY = 2;

        public double Length { get; protected set; }

        public Bindable<int> PlaybackConcurrency { get; } = new Bindable<int>(DEFAULT_CONCURRENCY);

        internal Action<Sample> OnPlay;

        public SampleChannel Play()
        {
            var channel = GetChannel();
            channel.Play();
            return channel;
        }

        public SampleChannel GetChannel()
        {
            if (IsDisposed)
                throw new ObjectDisposedException(ToString(), "Can not get a channel from a disposed sample.");

            var channel = CreateChannel();

            if (channel != null)
                channel.OnPlay = onPlay;

            return channel;
        }

        private void onPlay(SampleChannel channel)
        {
            AddItem(channel);
            OnPlay?.Invoke(this);
        }

        public override bool IsAlive => base.IsAlive && (!PendingActions.IsEmpty || Items.Count > 0);

        /// <summary>
        /// Creates a unique playback of this <see cref="Sample"/>.
        /// </summary>
        /// <returns>The <see cref="SampleChannel"/> for the playback.</returns>
        protected abstract SampleChannel CreateChannel();
    }
}