From 50eb034ac96858dbed48924e39ca4af51b087fc7 Mon Sep 17 00:00:00 2001
From: Jordan Wages <jordan@jordanwages.com>
Date: Thu, 5 Jul 2018 02:00:37 -0500
Subject: [PATCH] Saving Configurations to Files

---
 butterflow-ui/AboutWindow.xaml            |  2 +-
 butterflow-ui/ButterflowSubregion.cs      |  6 +++
 butterflow-ui/MainWindow.xaml             |  7 +---
 butterflow-ui/MainWindow.xaml.cs          | 38 ++++++++++++++----
 butterflow-ui/OptionsConfiguration.cs     | 49 +++++++++++++++++++++--
 butterflow-ui/OptionsConfigurationFile.cs | 32 +++++++++++++++
 butterflow-ui/OptionsWindow.xaml.cs       |  6 ++-
 butterflow-ui/PropertyChangedAlerter.cs   | 11 +++++
 butterflow-ui/butterflow-ui.csproj        |  1 +
 9 files changed, 133 insertions(+), 19 deletions(-)
 create mode 100644 butterflow-ui/OptionsConfigurationFile.cs

diff --git a/butterflow-ui/AboutWindow.xaml b/butterflow-ui/AboutWindow.xaml
index d591b52..555d00d 100644
--- a/butterflow-ui/AboutWindow.xaml
+++ b/butterflow-ui/AboutWindow.xaml
@@ -13,7 +13,7 @@
         <StackPanel HorizontalAlignment="Center">
             <StackPanel HorizontalAlignment="Center" Orientation="Horizontal" Height="128">
                 <ContentControl VerticalAlignment="Center" Template="{StaticResource ButterflowUIIcon}" />
-                <TextBox VerticalAlignment="Center" Text="{x:Static loc:Localization.Title}" FontSize="64" FontFamily="Segoe UI Black" />
+                <TextBlock VerticalAlignment="Center" Text="{x:Static loc:Localization.Title}" FontSize="64" FontFamily="Segoe UI Black" />
             </StackPanel>
             <TextBlock Text="{x:Static loc:Localization.AboutWindowDescription}" TextAlignment="Center" />
             <Separator Margin="0,15" />
diff --git a/butterflow-ui/ButterflowSubregion.cs b/butterflow-ui/ButterflowSubregion.cs
index c40926c..cc1ef56 100644
--- a/butterflow-ui/ButterflowSubregion.cs
+++ b/butterflow-ui/ButterflowSubregion.cs
@@ -7,6 +7,7 @@ using System.Threading.Tasks;
 namespace butterflow_ui
 {
     /// <summary> A butterflow video subregion. Represents a snippet of a video on which butterflow will act. </summary>
+    [Serializable]
     public class ButterflowSubregion : PropertyChangedAlerter
     {
         #region Members
@@ -111,6 +112,11 @@ namespace butterflow_ui
             {
                 return this.identifier;
             }
+            private set
+            {
+                this.identifier = value;
+                OnPropertyChanged();
+            }
         }
         
         #endregion
diff --git a/butterflow-ui/MainWindow.xaml b/butterflow-ui/MainWindow.xaml
index 21804d4..24e0cf0 100644
--- a/butterflow-ui/MainWindow.xaml
+++ b/butterflow-ui/MainWindow.xaml
@@ -39,11 +39,6 @@
                         <ContentControl Template="{StaticResource SaveIcon}" />
                     </MenuItem.Icon>
                 </MenuItem>
-                <MenuItem Name="menuSaveConfigurationAs" Header="{x:Static loc:Localization.SaveAsMenuItem}" Click="menuSaveConfigurationAs_Click">
-                    <MenuItem.Icon>
-                        <ContentControl Template="{StaticResource SaveAsIcon}" />
-                    </MenuItem.Icon>
-                </MenuItem>
             </MenuItem>
             <MenuItem Header="{x:Static loc:Localization.EditMenu}">
                 <MenuItem Name="menuCopyArguments" Header="{x:Static loc:Localization.CopyArgumentsMenu}" Click="btnCopyArguments_Click">
@@ -127,7 +122,7 @@
                         <Label Content="{x:Static loc:Localization.ProcessLabel}" />
                     </StackPanel>
                 </Button>
-                <Button Grid.Row="1" Name="btnCancel" ToolTip="{x:Static loc:Localization.CancelTooltip}" IsEnabled="{Binding ButterflowWrapper.IsRunning, Mode=OneWay, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type butterflow_ui:MainWindow}}, UpdateSourceTrigger=PropertyChanged}" Click="btnProcess_Click">
+                <Button Grid.Row="1" Name="btnCancel" ToolTip="{x:Static loc:Localization.CancelTooltip}" IsEnabled="{Binding ButterflowWrapper.IsRunning, Mode=OneWay, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type butterflow_ui:MainWindow}}, UpdateSourceTrigger=PropertyChanged}" Click="btnCancel_Click">
                     <StackPanel Orientation="Horizontal">
                         <ContentControl MaxWidth="16" HorizontalAlignment="Center" Template="{StaticResource CancelIcon}" />
                         <Label Content="{x:Static loc:Localization.CancelLabel}" />
diff --git a/butterflow-ui/MainWindow.xaml.cs b/butterflow-ui/MainWindow.xaml.cs
index 574bd29..6d8649d 100644
--- a/butterflow-ui/MainWindow.xaml.cs
+++ b/butterflow-ui/MainWindow.xaml.cs
@@ -3,6 +3,7 @@ using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
+using System.Runtime.Serialization.Formatters.Binary;
 using System.Text;
 using System.Threading.Tasks;
 using System.Windows;
@@ -45,6 +46,7 @@ namespace butterflow_ui
         public MainWindow()
         {
             this.ButterflowWrapper.ParsedConsoleOutputRecieved += ButterflowWrapper_ParsedConsoleOutputRecieved;
+            this.OptionsConfiguration.AddConstantCallProperty("CommandLineOutput");
             InitializeComponent();
         }
 
@@ -313,6 +315,14 @@ namespace butterflow_ui
             this.ButterflowWrapper.Run(this.OptionsConfiguration);
         }
 
+        /// <summary> Event handler. Called by btnCancel for click events. </summary>
+        /// <param name="sender"> Source of the event. </param>
+        /// <param name="e">      Routed event information. </param>
+        private void btnCancel_Click(object sender, RoutedEventArgs e)
+        {
+            this.ButterflowWrapper.Cancel();
+        }
+
         /// <summary> Event handler. Called by btnRemoveSubregion for click events. </summary>
         /// <param name="sender"> Source of the event. </param>
         /// <param name="e">      Routed event information. </param>
@@ -340,7 +350,19 @@ namespace butterflow_ui
         /// <param name="e">      Routed event information. </param>
         private void menuOpen_Click(object sender, RoutedEventArgs e)
         {
+            var ofd = new OpenFileDialog();
+            ofd.Filter = "ButterflowUI Configuration|*.bui";
 
+            var result = ofd.ShowDialog(this);
+            if (result.HasValue && result.Value)
+            {
+                var binaryFormatter = new BinaryFormatter();
+                var file = binaryFormatter.Deserialize(ofd.OpenFile());
+                if(file is OptionsConfigurationFile)
+                {
+                    this.OptionsConfiguration.LoadFile((OptionsConfigurationFile)file);
+                }
+            }
         }
 
         /// <summary> Event handler. Called by menuSaveConfiguration for click events. </summary>
@@ -348,15 +370,15 @@ namespace butterflow_ui
         /// <param name="e">      Routed event information. </param>
         private void menuSaveConfiguration_Click(object sender, RoutedEventArgs e)
         {
+            var sfd = new SaveFileDialog();
+            sfd.Filter = "ButterflowUI Configuration|*.bui";
 
-        }
-
-        /// <summary> Event handler. Called by menuSaveConfigurationAs for click events. </summary>
-        /// <param name="sender"> Source of the event. </param>
-        /// <param name="e">      Routed event information. </param>
-        private void menuSaveConfigurationAs_Click(object sender, RoutedEventArgs e)
-        {
-
+            var result = sfd.ShowDialog(this);
+            if (result.HasValue && result.Value)
+            {
+                var binaryFormatter = new BinaryFormatter();
+                binaryFormatter.Serialize(sfd.OpenFile(), this.OptionsConfiguration.ToFile());
+            }
         }
 
         /// <summary> Event handler. Called by menuButterflowGithub for click events. </summary>
diff --git a/butterflow-ui/OptionsConfiguration.cs b/butterflow-ui/OptionsConfiguration.cs
index c6ca0fb..b0fd3c6 100644
--- a/butterflow-ui/OptionsConfiguration.cs
+++ b/butterflow-ui/OptionsConfiguration.cs
@@ -11,7 +11,6 @@ namespace butterflow_ui
 {
 
     /// <summary> The butterflow options configuration. Contians all the options necessary to run butterflow and process a video. </summary>
-    [Serializable]
     public class OptionsConfiguration : PropertyChangedAlerter
     {
         #region Members
@@ -25,6 +24,7 @@ namespace butterflow_ui
         private const FlowFilterType DEFAULT_FLOW_FILTER_TYPE = FlowFilterType.box;
 
         /// <summary> An input interpreter used for converting string values to numeric values. </summary>
+        [NonSerialized]
         private InputInterpreter interpreter = new InputInterpreter();
         /// <summary> The aspect ratio used for calculating heights when the aspect ratio is locked. </summary>
         private decimal aspectRatio = 0;
@@ -394,8 +394,6 @@ namespace butterflow_ui
             this.smoothDerivativeStandardDeviation = DEFAULT_SMOOTH_DERIVATIVE_STANDARD_DEVIATION;
             this.flowFilterType = DEFAULT_FLOW_FILTER_TYPE;
 
-            AddConstantCallProperty("CommandLineOutput");
-
             this.subregions.CollectionChanged += Subregions_CollectionChanged; ;
         }
 
@@ -431,6 +429,51 @@ namespace butterflow_ui
             OnPropertyChanged("CommandLineOutput");
         }
 
+        /// <summary> Converts this object to a <seealso cref="OptionsConfigurationFile"/>. </summary>
+        /// <returns> This object as an OptionsConfigurationFile. </returns>
+        public OptionsConfigurationFile ToFile()
+        {
+            var file = new OptionsConfigurationFile()
+            {
+                FastPyramid = this.fastPyramid,
+                FlowFilterType = this.flowFilterType,
+                Iterations = this.iterations,
+                KeepAudio = this.keepAudio,
+                KeepSubregions = this.keepSubRegions,
+                Levels = this.levels,
+                LockAspectRatio = this.lockAspectRatio,
+                LosslessQuality = this.losslessQuality,
+                PixelNeighborhood = this.pixelNeighborhood,
+                PlaybackRate = this.playbackRate,
+                PyramidScale = this.pyramidScale,
+                SmoothDerivativeStandardDeviation = this.smoothDerivativeStandardDeviation,
+                SmoothMotion = this.smoothMotion,
+                WindowSize = this.windowSize
+            };
+
+            return file;
+        }
+
+        /// <summary> Loads an option configuration file's contents into the <seealso cref="OptionsConfiguration"/>. </summary>
+        /// <param name="file"> The file to load. </param>
+        public void LoadFile(OptionsConfigurationFile file)
+        {
+            this.FastPyramid = file.FastPyramid;
+            this.FlowFilterType = file.FlowFilterType;
+            this.Iterations = file.Iterations.ToString();
+            this.KeepAudio = file.KeepAudio;
+            this.KeepSubregions = file.KeepSubregions;
+            this.Levels = file.Levels.ToString();
+            this.LockAspectRatio = file.LockAspectRatio;
+            this.LosslessQuality = file.LosslessQuality;
+            this.PixelNeighborhood = file.PixelNeighborhood.ToString();
+            this.PlaybackRate = file.PlaybackRate;
+            this.PyramidScale = file.PyramidScale.ToString();
+            this.SmoothDerivativeStandardDeviation = file.SmoothDerivativeStandardDeviation.ToString();
+            this.SmoothMotion = file.SmoothMotion;
+            this.WindowSize = file.WindowSize.ToString();
+        }
+
         /// <summary> Converts this object to a butterflow options. </summary>
         /// <returns> This object as a string. </returns>
         public string ToButterflowArguments()
diff --git a/butterflow-ui/OptionsConfigurationFile.cs b/butterflow-ui/OptionsConfigurationFile.cs
new file mode 100644
index 0000000..2fe2080
--- /dev/null
+++ b/butterflow-ui/OptionsConfigurationFile.cs
@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace butterflow_ui
+{
+    /// <summary> An options configuration file. </summary>
+    [Serializable]
+    public class OptionsConfigurationFile
+    {
+        #region Properties
+
+        public string PlaybackRate { get; set; }
+        public bool KeepAudio { get; set; }
+        public bool KeepSubregions { get; set; }
+        public bool LosslessQuality { get; set; }
+        public bool SmoothMotion { get; set; }
+        public bool LockAspectRatio { get; set; }
+        public bool FastPyramid { get; set; }
+        public decimal PyramidScale { get; set; }
+        public int Levels { get; set; }
+        public int WindowSize { get; set; }
+        public int Iterations { get; set; }
+        public int PixelNeighborhood { get; set; }
+        public decimal SmoothDerivativeStandardDeviation { get; set; }
+        public FlowFilterType FlowFilterType { get; set; }
+
+        #endregion
+    }
+}
diff --git a/butterflow-ui/OptionsWindow.xaml.cs b/butterflow-ui/OptionsWindow.xaml.cs
index fae84b6..bf1969b 100644
--- a/butterflow-ui/OptionsWindow.xaml.cs
+++ b/butterflow-ui/OptionsWindow.xaml.cs
@@ -23,7 +23,11 @@ namespace butterflow_ui
 
         /// <summary> Gets or sets the supported languages. </summary>
         /// <value> The supported languages. </value>
-        public List<CultureInfo> SupportedLanguages { get; set; } = new List<CultureInfo>(new[] { CultureInfo.CreateSpecificCulture("en-US"), CultureInfo.CreateSpecificCulture("es-ES") });
+        public List<CultureInfo> SupportedLanguages { get; set; } = new List<CultureInfo>(new[]
+        {
+            CultureInfo.CreateSpecificCulture("en-US"),
+            CultureInfo.CreateSpecificCulture("es-ES")
+        });
 
         #endregion
 
diff --git a/butterflow-ui/PropertyChangedAlerter.cs b/butterflow-ui/PropertyChangedAlerter.cs
index 6fd36a9..2bf4250 100644
--- a/butterflow-ui/PropertyChangedAlerter.cs
+++ b/butterflow-ui/PropertyChangedAlerter.cs
@@ -42,10 +42,21 @@ namespace butterflow_ui
             }
         }
 
+        protected virtual void OnAllPropertiesChanged()
+        {
+            this.PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(string.Empty));
+        }
+
         /// <summary> Adds a property that will always be called when any property is updated.. </summary>
         /// <param name="name"> The name of the property. </param>
         public void AddConstantCallProperty(string name)
         {
+            if(this.alwaysCall == null)
+            {
+                // This item has been deserialized and the list needs to be reinitialized.
+                this.alwaysCall = new List<string>();
+            }
+
             if (!this.alwaysCall.Any(c => c.Equals(name, StringComparison.OrdinalIgnoreCase)))
             {
                 this.alwaysCall.Add(name);
diff --git a/butterflow-ui/butterflow-ui.csproj b/butterflow-ui/butterflow-ui.csproj
index 70d6744..b5abf22 100644
--- a/butterflow-ui/butterflow-ui.csproj
+++ b/butterflow-ui/butterflow-ui.csproj
@@ -68,6 +68,7 @@
     </Compile>
     <Compile Include="FlowFilterType.cs" />
     <Compile Include="InverseBoolConverter.cs" />
+    <Compile Include="OptionsConfigurationFile.cs" />
     <Compile Include="OptionsWindow.xaml.cs">
       <DependentUpon>OptionsWindow.xaml</DependentUpon>
     </Compile>