QuickLook/QuickLook.Plugin/QuickLook.Plugin.ImageViewer/AnimatedImage/AnimatedImage.cs

// Copyright © 2018 Paddy Xu
// 
// This file is part of QuickLook program.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using QuickLook.Common.ExtensionMethods;
using QuickLook.Common.Plugin;

namespace QuickLook.Plugin.ImageViewer.AnimatedImage
{
    public class AnimatedImage : Image, IDisposable
    {
        // List<Pair<formats, type>>
        public static List<KeyValuePair<string[], Type>> Providers = new List<KeyValuePair<string[], Type>>();

        private AnimationProvider _animation;
        private bool _disposing;

        public void Dispose()
        {
            _disposing = true;

            BeginAnimation(AnimationFrameIndexProperty, null);
            Source = null;

            _animation?.Dispose();
            _animation = null;
        }

        public event EventHandler ImageLoaded;
        public event EventHandler DoZoomToFit;

        private static AnimationProvider InitAnimationProvider(Uri path, MetaProvider meta, ContextObject contextObject)
        {
            var ext = Path.GetExtension(path.LocalPath).ToLower();
            var type = Providers.First(p => p.Key.Contains(ext) || p.Key.Contains("*")).Value;

            var provider = type.CreateInstance<AnimationProvider>(path, meta, contextObject);

            return provider;
        }

        #region DependencyProperty

        public static readonly DependencyProperty AnimationFrameIndexProperty =
            DependencyProperty.Register("AnimationFrameIndex", typeof(int), typeof(AnimatedImage),
                new UIPropertyMetadata(-1, AnimationFrameIndexChanged));

        public static readonly DependencyProperty AnimationUriProperty =
            DependencyProperty.Register("AnimationUri", typeof(Uri), typeof(AnimatedImage),
                new UIPropertyMetadata(null, AnimationUriChanged));

        public static readonly DependencyProperty MetaProperty =
            DependencyProperty.Register("Meta", typeof(MetaProvider), typeof(AnimatedImage));

        public static readonly DependencyProperty ContextObjectProperty =
            DependencyProperty.Register("ContextObject", typeof(ContextObject), typeof(AnimatedImage));

        public int AnimationFrameIndex
        {
            get => (int) GetValue(AnimationFrameIndexProperty);
            set => SetValue(AnimationFrameIndexProperty, value);
        }

        public Uri AnimationUri
        {
            get => (Uri) GetValue(AnimationUriProperty);
            set => SetValue(AnimationUriProperty, value);
        }

        public MetaProvider Meta
        {
            private get => (MetaProvider) GetValue(MetaProperty);
            set => SetValue(MetaProperty, value);
        }

        public ContextObject ContextObject
        {
            private get => (ContextObject) GetValue(ContextObjectProperty);
            set => SetValue(ContextObjectProperty, value);
        }

        private static void AnimationUriChanged(DependencyObject obj, DependencyPropertyChangedEventArgs ev)
        {
            if (!(obj is AnimatedImage instance))
                return;

            //var thumbnail = instance.Meta?.GetThumbnail(true);
            //instance.Source = thumbnail;

            instance._animation = InitAnimationProvider((Uri) ev.NewValue, instance.Meta, instance.ContextObject);
            ShowThumbnailAndStartAnimation(instance);
        }

        private static void ShowThumbnailAndStartAnimation(AnimatedImage instance)
        {
            var task = instance._animation.GetThumbnail(instance.ContextObject.PreferredSize);
            if (task == null) return;

            task.ContinueWith(_ => instance.Dispatcher.Invoke(() =>
            {
                if (instance._disposing)
                    return;

                instance.Source = _.Result;

                if (_.Result != null)
                {
                    instance.DoZoomToFit?.Invoke(instance, new EventArgs());
                    instance.ImageLoaded?.Invoke(instance, new EventArgs());
                }

                instance.BeginAnimation(AnimationFrameIndexProperty, instance._animation?.Animator);
            }));
            task.Start();
        }

        private static void AnimationFrameIndexChanged(DependencyObject obj, DependencyPropertyChangedEventArgs ev)
        {
            if (!(obj is AnimatedImage instance))
                return;

            if (instance._disposing)
                return;

            var task = instance._animation.GetRenderedFrame((int) ev.NewValue);

            task.ContinueWith(_ => instance.Dispatcher.Invoke(() =>
            {
                if (instance._disposing)
                    return;

                var firstLoad = instance.Source == null;

                instance.Source = _.Result;

                if (firstLoad)
                {
                    instance.DoZoomToFit?.Invoke(instance, new EventArgs());
                    instance.ImageLoaded?.Invoke(instance, new EventArgs());
                }
            }));
            task.Start();
        }

        #endregion DependencyProperty
    }
}