Merge branch 'master' into fix-taiko-scroller-time-control

osu.Game.Rulesets.Taiko/UI/DrawableTaikoMascot.cs

@@ -0,0 +1,123 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Collections.Generic;
+using osu.Framework.Allocation;
+using osu.Framework.Audio.Track;
+using osu.Framework.Bindables;
+using osu.Framework.Extensions.IEnumerableExtensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Beatmaps.ControlPoints;
+using osu.Game.Graphics.Containers;
+using osu.Game.Rulesets.Judgements;
+using osu.Game.Rulesets.Taiko.Judgements;
+using osu.Game.Screens.Play;
+
+namespace osu.Game.Rulesets.Taiko.UI
+{
+    public class DrawableTaikoMascot : BeatSyncedContainer
+    {
+        public readonly Bindable<TaikoMascotAnimationState> State;
+        public readonly Bindable<JudgementResult> LastResult;
+
+        private readonly Dictionary<TaikoMascotAnimationState, TaikoMascotAnimation> animations;
+        private TaikoMascotAnimation currentAnimation;
+
+        private bool lastObjectHit = true;
+        private bool kiaiMode;
+
+        public DrawableTaikoMascot(TaikoMascotAnimationState startingState = TaikoMascotAnimationState.Idle)
+        {
+            Origin = Anchor = Anchor.BottomLeft;
+
+            State = new Bindable<TaikoMascotAnimationState>(startingState);
+            LastResult = new Bindable<JudgementResult>();
+
+            animations = new Dictionary<TaikoMascotAnimationState, TaikoMascotAnimation>();
+        }
+
+        [BackgroundDependencyLoader(true)]
+        private void load(TextureStore textures, GameplayBeatmap gameplayBeatmap)
+        {
+            InternalChildren = new[]
+            {
+                animations[TaikoMascotAnimationState.Idle] = new TaikoMascotAnimation(TaikoMascotAnimationState.Idle),
+                animations[TaikoMascotAnimationState.Clear] = new TaikoMascotAnimation(TaikoMascotAnimationState.Clear),
+                animations[TaikoMascotAnimationState.Kiai] = new TaikoMascotAnimation(TaikoMascotAnimationState.Kiai),
+                animations[TaikoMascotAnimationState.Fail] = new TaikoMascotAnimation(TaikoMascotAnimationState.Fail),
+            };
+
+            if (gameplayBeatmap != null)
+                ((IBindable<JudgementResult>)LastResult).BindTo(gameplayBeatmap.LastJudgementResult);
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            animations.Values.ForEach(animation => animation.Hide());
+
+            State.BindValueChanged(mascotStateChanged, true);
+            LastResult.BindValueChanged(onNewResult);
+        }
+
+        private void onNewResult(ValueChangedEvent<JudgementResult> resultChangedEvent)
+        {
+            var result = resultChangedEvent.NewValue;
+            if (result == null)
+                return;
+
+            // TODO: missing support for clear/fail state transition at end of beatmap gameplay
+
+            if (triggerComboClear(result) || triggerSwellClear(result))
+            {
+                State.Value = TaikoMascotAnimationState.Clear;
+                // always consider a clear equivalent to a hit to avoid clear -> miss transitions
+                lastObjectHit = true;
+            }
+
+            if (!result.Judgement.AffectsCombo)
+                return;
+
+            lastObjectHit = result.IsHit;
+        }
+
+        protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, TrackAmplitudes amplitudes)
+        {
+            kiaiMode = effectPoint.KiaiMode;
+        }
+
+        protected override void Update()
+        {
+            base.Update();
+            State.Value = getNextState();
+        }
+
+        private TaikoMascotAnimationState getNextState()
+        {
+            // don't change state if current animation is still playing (and we haven't rewound before it).
+            // used for clear state - others are manually animated on new beats.
+            if (currentAnimation?.Completed == false && currentAnimation.DisplayTime <= Time.Current)
+                return State.Value;
+
+            if (!lastObjectHit)
+                return TaikoMascotAnimationState.Fail;
+
+            return kiaiMode ? TaikoMascotAnimationState.Kiai : TaikoMascotAnimationState.Idle;
+        }
+
+        private void mascotStateChanged(ValueChangedEvent<TaikoMascotAnimationState> state)
+        {
+            currentAnimation?.Hide();
+            currentAnimation = animations[state.NewValue];
+            currentAnimation.Show();
+        }
+
+        private bool triggerComboClear(JudgementResult judgementResult)
+            => (judgementResult.ComboAtJudgement + 1) % 50 == 0 && judgementResult.Judgement.AffectsCombo && judgementResult.IsHit;
+
+        private bool triggerSwellClear(JudgementResult judgementResult)
+            => judgementResult.Judgement is TaikoSwellJudgement && judgementResult.IsHit;
+    }
+}

osu.Game.Rulesets.Taiko/UI/DrawableTaikoRuleset.cs

@@ -42,7 +42,7 @@ namespace osu.Game.Rulesets.Taiko.UI
         {
             new BarLineGenerator<BarLine>(Beatmap).BarLines.ForEach(bar => Playfield.Add(bar.Major ? new DrawableBarLineMajor(bar) : new DrawableBarLine(bar)));
 
-            FrameStableComponents.Add(scroller = new SkinnableDrawable(new TaikoSkinComponent(TaikoSkinComponents.TaikoScroller), _ => Empty())
+            FrameStableComponents.Add(scroller = new SkinnableDrawable(new TaikoSkinComponent(TaikoSkinComponents.Scroller), _ => Empty())
             {
                 RelativeSizeAxes = Axes.X,
                 Depth = float.MaxValue

osu.Game.Rulesets.Taiko/UI/TaikoMascotAnimation.cs

@@ -0,0 +1,133 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using osu.Framework.Allocation;
+using osu.Framework.Audio.Track;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Animations;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Beatmaps.ControlPoints;
+using osu.Game.Graphics.Containers;
+using osu.Game.Skinning;
+using osuTK;
+
+namespace osu.Game.Rulesets.Taiko.UI
+{
+    public sealed class TaikoMascotAnimation : BeatSyncedContainer
+    {
+        private readonly TextureAnimation textureAnimation;
+
+        private int currentFrame;
+
+        public double DisplayTime;
+
+        public TaikoMascotAnimation(TaikoMascotAnimationState state)
+        {
+            InternalChild = textureAnimation = createTextureAnimation(state).With(animation =>
+            {
+                animation.Origin = animation.Anchor = Anchor.BottomLeft;
+                animation.Scale = new Vector2(0.51f); // close enough to stable
+            });
+
+            RelativeSizeAxes = Axes.Both;
+            Origin = Anchor = Anchor.BottomLeft;
+
+            // needs to be always present to prevent the animation clock consuming time spent when not present.
+            AlwaysPresent = true;
+        }
+
+        public bool Completed => !textureAnimation.IsPlaying || textureAnimation.PlaybackPosition >= textureAnimation.Duration;
+
+        public override void Show()
+        {
+            base.Show();
+            DisplayTime = Time.Current;
+            textureAnimation.Seek(0);
+        }
+
+        protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, TrackAmplitudes amplitudes)
+        {
+            // assume that if the animation is playing on its own, it's independent from the beat and doesn't need to be touched.
+            if (textureAnimation.FrameCount == 0 || textureAnimation.IsPlaying)
+                return;
+
+            textureAnimation.GotoFrame(currentFrame);
+            currentFrame = (currentFrame + 1) % textureAnimation.FrameCount;
+        }
+
+        private static TextureAnimation createTextureAnimation(TaikoMascotAnimationState state)
+        {
+            switch (state)
+            {
+                case TaikoMascotAnimationState.Clear:
+                    return new ClearMascotTextureAnimation();
+
+                case TaikoMascotAnimationState.Idle:
+                case TaikoMascotAnimationState.Kiai:
+                case TaikoMascotAnimationState.Fail:
+                    return new ManualMascotTextureAnimation(state);
+
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(state), $"Mascot animations for state {state} are not supported");
+            }
+        }
+
+        private class ManualMascotTextureAnimation : TextureAnimation
+        {
+            private readonly TaikoMascotAnimationState state;
+
+            public ManualMascotTextureAnimation(TaikoMascotAnimationState state)
+            {
+                this.state = state;
+
+                IsPlaying = false;
+            }
+
+            [BackgroundDependencyLoader]
+            private void load(ISkinSource skin)
+            {
+                for (int frameIndex = 0; true; frameIndex++)
+                {
+                    var texture = getAnimationFrame(skin, state, frameIndex);
+
+                    if (texture == null)
+                        break;
+
+                    AddFrame(texture);
+                }
+            }
+        }
+
+        private class ClearMascotTextureAnimation : TextureAnimation
+        {
+            private const float clear_animation_speed = 1000 / 10f;
+
+            private static readonly int[] clear_animation_sequence = { 0, 1, 2, 3, 4, 5, 6, 5, 6, 5, 4, 3, 2, 1, 0 };
+
+            public ClearMascotTextureAnimation()
+            {
+                DefaultFrameLength = clear_animation_speed;
+                Loop = false;
+            }
+
+            [BackgroundDependencyLoader]
+            private void load(ISkinSource skin)
+            {
+                foreach (var frameIndex in clear_animation_sequence)
+                {
+                    var texture = getAnimationFrame(skin, TaikoMascotAnimationState.Clear, frameIndex);
+
+                    if (texture == null)
+                        // as per https://osu.ppy.sh/help/wiki/Skinning/osu!taiko#pippidon
+                        break;
+
+                    AddFrame(texture);
+                }
+            }
+        }
+
+        private static Texture getAnimationFrame(ISkin skin, TaikoMascotAnimationState state, int frameIndex)
+            => skin.GetTexture($"pippidon{state.ToString().ToLower()}{frameIndex}");
+    }
+}

osu.Game.Rulesets.Taiko/UI/TaikoMascotAnimationState.cs

@@ -0,0 +1,13 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+namespace osu.Game.Rulesets.Taiko.UI
+{
+    public enum TaikoMascotAnimationState
+    {
+        Idle,
+        Clear,
+        Kiai,
+        Fail
+    }
+}

osu.Game.Rulesets.Taiko/UI/TaikoPlayfield.cs

@@ -15,6 +15,7 @@ using osu.Game.Rulesets.Taiko.Objects.Drawables;
 using osu.Game.Rulesets.Taiko.Judgements;
 using osu.Game.Rulesets.Taiko.Objects;
 using osu.Game.Skinning;
+using osuTK;
 
 namespace osu.Game.Rulesets.Taiko.UI
 {
@@ -32,6 +33,7 @@ namespace osu.Game.Rulesets.Taiko.UI
         private JudgementContainer<DrawableTaikoJudgement> judgementContainer;
         private ScrollingHitObjectContainer drumRollHitContainer;
         internal Drawable HitTarget;
+        private SkinnableDrawable mascot;
 
         private ProxyContainer topLevelHitContainer;
         private ProxyContainer barlineContainer;
@@ -125,12 +127,20 @@ namespace osu.Game.Rulesets.Taiko.UI
                         },
                     }
                 },
+                mascot = new SkinnableDrawable(new TaikoSkinComponent(TaikoSkinComponents.Mascot), _ => Empty())
+                {
+                    Origin = Anchor.BottomLeft,
+                    Anchor = Anchor.TopLeft,
+                    RelativePositionAxes = Axes.Y,
+                    RelativeSizeAxes = Axes.None,
+                    Y = 0.2f
+                },
                 topLevelHitContainer = new ProxyContainer
                 {
                     Name = "Top level hit objects",
                     RelativeSizeAxes = Axes.Both,
                 },
-                drumRollHitContainer.CreateProxy()
+                drumRollHitContainer.CreateProxy(),
             };
         }
 
@@ -142,6 +152,8 @@ namespace osu.Game.Rulesets.Taiko.UI
             // This is basically allowing for correct alignment as relative pieces move around them.
             rightArea.Padding = new MarginPadding { Left = leftArea.DrawWidth };
             hitTargetOffsetContent.Padding = new MarginPadding { Left = HitTarget.DrawWidth / 2 };
+
+            mascot.Scale = new Vector2(DrawHeight / DEFAULT_HEIGHT);
         }
 
         public override void Add(DrawableHitObject h)