minor refactoring and start of class comments

jasonm-unity · jasonm-unity · commit 61ee3dcb7f6b · 2017-06-02T12:43:30.000-04:00
diff --git a/docs/Overview.vsdx b/docs/Overview.vsdx
diff --git a/docs/~$$Overview.~vsdx b/docs/~$$Overview.~vsdx
diff --git a/docs/~$sign preview.docx b/docs/~$sign preview.docx
diff --git a/source/Core/FrameRecorder/Core/Engine/BaseImageRecorder.cs b/source/Core/FrameRecorder/Core/Engine/BaseImageRecorder.cs
diff --git a/source/Core/FrameRecorder/Core/Engine/FrameRecorderAttribute.cs b/source/Core/FrameRecorder/Core/Engine/FrameRecorderAttribute.cs
@@ -2,6 +2,12 @@
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
     public class FrameRecorderAttribute : Attribute
     {
diff --git a/source/Core/FrameRecorder/Core/Engine/FrameRecorderGOControler.cs b/source/Core/FrameRecorder/Core/Engine/FrameRecorderGOControler.cs
@@ -2,6 +2,12 @@
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public class FrameRecorderGOControler
     {
         const string k_HostGoName = "UnityEngine-Recorder-FrameRecorder";
diff --git a/source/Core/FrameRecorder/Core/Engine/GenericRecorder.cs b/source/Core/FrameRecorder/Core/Engine/GenericRecorder.cs
@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using UnityEngine.FrameRecorder.Input;
+#if UNITY_EDITOR
+    using UnityEditor;
+#endif
+
+namespace UnityEngine.FrameRecorder
+{
+    /// <summary>
+    /// What is it: 
+    /// Motivation: 
+    /// Notes: 
+    /// </summary>    
+    public abstract class GenericRecorder<TSettings> : Recorder where TSettings : RecorderSettings
+    {
+        [SerializeField]
+        protected TSettings m_Settings;
+        public override RecorderSettings settings
+        {
+            get { return m_Settings; }
+            set { m_Settings = (TSettings)value; }
+        }
+    }
+}
diff --git a/source/Core/FrameRecorder/Core/Engine/GenericRecorder.cs.meta b/source/Core/FrameRecorder/Core/Engine/GenericRecorder.cs.meta
diff --git a/source/Core/FrameRecorder/Core/Engine/InputSettings.cs b/source/Core/FrameRecorder/Core/Engine/InputSettings.cs
@@ -2,11 +2,21 @@
 
 namespace UnityEngine.FrameRecorder
 {
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public abstract class  RecorderInputSetting : ScriptableObject
     {
         public abstract Type inputType { get; }
     }
 
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public class InputSettings<TInput> : RecorderInputSetting
     {
         public override Type inputType
diff --git a/source/Core/FrameRecorder/Core/Engine/Recorder.cs b/source/Core/FrameRecorder/Core/Engine/Recorder.cs
@@ -12,6 +12,11 @@ public enum ERecordingSessionStage
         EndRecording,
     }
 
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public abstract class Recorder : ScriptableObject
     {
         double m_OriginalCaptureFrameRate;
diff --git a/source/Core/FrameRecorder/Core/Engine/RecorderComponent.cs b/source/Core/FrameRecorder/Core/Engine/RecorderComponent.cs
@@ -3,6 +3,12 @@
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     [ExecuteInEditMode]
     public class RecorderComponent : MonoBehaviour
     {
diff --git a/source/Core/FrameRecorder/Core/Engine/RecorderInput.cs b/source/Core/FrameRecorder/Core/Engine/RecorderInput.cs
@@ -2,6 +2,12 @@
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public class RecorderInput : IDisposable
     {
         public int SourceID { get; set; }
diff --git a/source/Core/FrameRecorder/Core/Engine/RecorderSettings.cs b/source/Core/FrameRecorder/Core/Engine/RecorderSettings.cs
@@ -27,6 +27,12 @@ public enum DurationMode
         TimeInterval
     }
 
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public abstract class RecorderSettings : ScriptableObject
     {
         [Range(1,10)]
diff --git a/source/Core/FrameRecorder/Core/Engine/RecordersInventory.cs b/source/Core/FrameRecorder/Core/Engine/RecordersInventory.cs
@@ -14,6 +14,13 @@ public class RecorderInfo
         public string displayName;
     }
 
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
+
     // to be internal once inside unity code base
     public static class RecordersInventory
     {
diff --git a/source/Core/FrameRecorder/Core/Engine/RecordingSession.cs b/source/Core/FrameRecorder/Core/Engine/RecordingSession.cs
@@ -1,13 +1,17 @@
 using System;
-using System.Collections.Generic;
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public class RecordingSession : IDisposable
     {
         public Recorder m_Recorder;
         public GameObject m_RecorderGO;
-        public List<UnityEngine.Object> m_ObjsOfInterest;
         public int m_FrameIndex; // count starts at 0.
         public double m_CurrentFrameStartTS;
         public double m_RecordingStartTS;
diff --git a/source/Core/FrameRecorder/Core/Engine/RenderTextureInput.cs b/source/Core/FrameRecorder/Core/Engine/RenderTextureInput.cs
@@ -1,5 +1,11 @@
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public abstract class RenderTextureInput : RecorderInput
     {
         public RenderTexture outputRT { get; set; }
diff --git a/source/Core/FrameRecorder/Core/Engine/Timeline/FrameRecorderClip.cs b/source/Core/FrameRecorder/Core/Engine/Timeline/FrameRecorderClip.cs
@@ -4,6 +4,12 @@
 
 namespace UnityEngine.FrameRecorder.Timeline
 {
+    /// <summary>
+    /// What is it: Implements a Timeline Clip asset that can be inserted onto a timeline track to trigger a recording of something.
+    /// Motivation: Allow Timeline to trigger recordings
+    /// 
+    /// Note: Instances of this call Own their associated Settings asset's lifetime.
+    /// </summary>
     public class FrameRecorderClip : PlayableAsset, ITimelineClipAsset
     {
         [SerializeField]
diff --git a/source/Core/FrameRecorder/Core/Engine/Timeline/FrameRecorderTrack.cs b/source/Core/FrameRecorder/Core/Engine/Timeline/FrameRecorderTrack.cs
@@ -2,11 +2,19 @@
 
 namespace UnityEngine.FrameRecorder.Timeline
 {
+
+    /// <summary>
+    /// What is it: Declares a type of Timeline Track that can host Recording clips
+    /// Motivation: Allow Timeline to trigger recordings
+    /// 
+    /// Note: Instances of this call Own their associated Settings asset's lifetime.
+    /// </summary>
     [System.Serializable]
     [TrackClipType(typeof(FrameRecorderClip))]
     [TrackMediaType(TimelineAsset.MediaType.Script)]
-    [TrackColor(0.53f, 0.0f, 0.08f)]
+    [TrackColor(0f, 0.53f, 0.08f)]
     public class FrameRecorderTrack : TrackAsset
     {
     }
+
 }
diff --git a/source/Core/FrameRecorder/Core/Engine/Timeline/RecorderPlayableBehaviour.cs b/source/Core/FrameRecorder/Core/Engine/Timeline/RecorderPlayableBehaviour.cs
@@ -3,8 +3,14 @@
 namespace UnityEngine.FrameRecorder.Timeline
 {
     /// <summary>
-    /// Note: Totally ignores the time info comming from the playable infrastructure. Only conciders scaled time.
-    /// </summary>
+    /// What is it: Implements a playable that records something triggered by a Timeline Recorder Clip.
+    /// Motivation: Allow Timeline to trigger recordings
+    /// 
+    /// Notes: 
+    ///     - Totally ignores the time info comming from the playable infrastructure. Only conciders scaled time.
+    ///     - Does not support multiple OnGraphStart...
+    ///     - It relies on WaitForEndOfFrameComponent to inform the Session object that it's time to record to frame.
+    /// </summary>    
     public class RecorderPlayableBehaviour : PlayableBehaviour
     {
         PlayState m_PlayState = PlayState.Paused;
@@ -67,8 +73,13 @@ public override void OnBehaviourPause(Playable playable, FrameData info)
         {
             if (session == null)
                 return;
+
             if (session.recording && m_PlayState == PlayState.Playing)
+            {
                 session.EndRecording();
+                session.Dispose();
+                session = null;
+            }
 
             m_PlayState = PlayState.Paused;
         }
diff --git a/source/Core/FrameRecorder/Core/Engine/Timeline/WaitForEndOfFrameComponent.cs b/source/Core/FrameRecorder/Core/Engine/Timeline/WaitForEndOfFrameComponent.cs
@@ -3,7 +3,18 @@
 
 namespace UnityEngine.FrameRecorder.Timeline
 {
-    // the purpose of this class is to signal the FrameRecorderPlayable when frame is done.
+
+    /// <summary>
+    /// What is it: Signals RecorderPlayableBehaviour when frame is reached.
+    /// Motivation: RecorderPlayableBehaviour does does not have a way to detect the end of frame, 
+    ///               which is when the RecordFrame signal must be given to the Recording session. Using this component,
+    ///               we can use MonoBehaviour coroutines to inform the Recorder of the end of frame.
+    /// 
+    /// Notes: 
+    ///     - There is a 1-to-1 instance count between RecorderPlayableBehaviour and WaitForEndOfFrameComponent
+    ///     - This component get's added to a transient GameObject, that lives in the scene in play mode and that is associated
+    ///       to the recording session.
+    /// </summary>    
     [ExecuteInEditMode]
     class WaitForEndOfFrameComponent : MonoBehaviour
     {
diff --git a/source/Core/FrameRecorder/Core/Engine/UnityHelpers.cs b/source/Core/FrameRecorder/Core/Engine/UnityHelpers.cs
@@ -2,6 +2,12 @@
 
 namespace UnityEngine.FrameRecorder
 {
+
+    /// <summary>
+    /// What is this: 
+    /// Motivation  : 
+    /// Notes: 
+    /// </summary>    
     public static class UnityHelpers
     {
         public static void Destroy(Object obj, bool allowDestroyingAssets = false)
diff --git a/source/Core/FrameRecorder/Recorders/PNG/Engine/PNGRecorder.cs b/source/Core/FrameRecorder/Recorders/PNG/Engine/PNGRecorder.cs
@@ -1,10 +1,12 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
+using UnityEngine.FrameRecorder.Input;
 
 namespace UnityEngine.FrameRecorder
 {
     [FrameRecorder(typeof(PNGRecorderSettings),"Video", "PNG" )]
-    public class PNGRecorder : BaseImageRecorder<PNGRecorderSettings>
+    public class PNGRecorder : GenericRecorder<PNGRecorderSettings>
     {
         string MakeFileName(RecordingSession session)
         {
@@ -40,5 +42,14 @@ public override void RecordFrame(RecordingSession session)
             File.WriteAllBytes(MakeFileName(session), bytes);
         }
 
+        public override List<RecorderInputSetting> DefaultInputs()
+        {
+            var settings = new List<RecorderInputSetting>();
+            var setting = ScriptableObject.CreateInstance(typeof(AdamBeautyInputSettings)) as AdamBeautyInputSettings;
+
+            settings.Add(setting);
+            return settings;
+        }
+
     }
 }
diff --git a/source/FrameCapturer/Recorders/EXR/EXRRecorder.cs b/source/FrameCapturer/Recorders/EXR/EXRRecorder.cs
@@ -7,7 +7,7 @@
 namespace UTJ.FrameCapturer.Recorders
 {
     [FrameRecorder(typeof(EXRRecorderSettings),"Video", "UTJ/OpenEXR" )]
-    public class EXRRecorder : BaseImageRecorder<EXRRecorderSettings>
+    public class EXRRecorder : GenericRecorder<EXRRecorderSettings>
     {
         static readonly string[] s_channelNames = { "R", "G", "B", "A" };
         fcAPI.fcExrContext m_ctx;
diff --git a/source/FrameCapturer/Recorders/GIF/GIFRecorder.cs b/source/FrameCapturer/Recorders/GIF/GIFRecorder.cs
@@ -1,17 +1,28 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using UnityEngine;
 using UnityEngine.FrameRecorder;
 using UnityEngine.FrameRecorder;
+using UnityEngine.FrameRecorder.Input;
 
 namespace UTJ.FrameCapturer.Recorders
 {
     [FrameRecorder(typeof(GIFRecorderSettings),"Video", "UTJ/GIF" )]
-    public class GIFRecorder : BaseImageRecorder<GIFRecorderSettings>
+    public class GIFRecorder : GenericRecorder<GIFRecorderSettings>
     {
         fcAPI.fcGifContext m_ctx;
         fcAPI.fcStream m_stream;
 
+        public override List<RecorderInputSetting> DefaultInputs()
+        {
+            var settings = new List<RecorderInputSetting>();
+            var setting = ScriptableObject.CreateInstance(typeof(AdamBeautyInputSettings)) as AdamBeautyInputSettings;
+
+            settings.Add(setting);
+            return settings;
+        }
+
         public override bool BeginRecording(RecordingSession session)
         {
             if (!base.BeginRecording(session)) { return false; }
diff --git a/source/FrameCapturer/Recorders/MP4/MP4Recorder.cs b/source/FrameCapturer/Recorders/MP4/MP4Recorder.cs
@@ -1,16 +1,27 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using UnityEngine;
 using UnityEngine.FrameRecorder;
 using UnityEngine.FrameRecorder;
+using UnityEngine.FrameRecorder.Input;
 
 namespace UTJ.FrameCapturer.Recorders
 {
     [FrameRecorder(typeof(MP4RecorderSettings),"Video", "UTJ/MPeg-4" )]
-    public class MP4Recorder : BaseImageRecorder<MP4RecorderSettings>
+    public class MP4Recorder : GenericRecorder<MP4RecorderSettings>
     {
         fcAPI.fcMP4Context m_ctx;
 
+        public override List<RecorderInputSetting> DefaultInputs()
+        {
+            var settings = new List<RecorderInputSetting>();
+            var setting = ScriptableObject.CreateInstance(typeof(AdamBeautyInputSettings)) as AdamBeautyInputSettings;
+
+            settings.Add(setting);
+            return settings;
+        }
+
         public override bool BeginRecording(RecordingSession session)
         {
             if (!base.BeginRecording(session)) { return false; }
diff --git a/source/FrameCapturer/Recorders/PNG/PNGRecorder.cs b/source/FrameCapturer/Recorders/PNG/PNGRecorder.cs
diff --git a/source/FrameCapturer/Recorders/WEBM/WEBMRecorder.cs b/source/FrameCapturer/Recorders/WEBM/WEBMRecorder.cs

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,12 @@`
`2`	`2`
`3`	`3`	`namespace UnityEngine.FrameRecorder`
`4`	`4`	`{`
	`5`	`+`
	`6`	`+ /// <summary>`
	`7`	`+ /// What is this:`
	`8`	`+ /// Motivation :`
	`9`	`+ /// Notes:`
	`10`	`+ /// </summary>`
`5`	`11`	`[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]`
`6`	`12`	`public class FrameRecorderAttribute : Attribute`
`7`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,21 @@`
`2`	`2`
`3`	`3`	`namespace UnityEngine.FrameRecorder`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// What is this:`
	`7`	`+ /// Motivation :`
	`8`	`+ /// Notes:`
	`9`	`+ /// </summary>`
`5`	`10`	`public abstract class RecorderInputSetting : ScriptableObject`
`6`	`11`	`{`
`7`	`12`	`public abstract Type inputType { get; }`
`8`	`13`	`}`
`9`	`14`
	`15`	`+ /// <summary>`
	`16`	`+ /// What is this:`
	`17`	`+ /// Motivation :`
	`18`	`+ /// Notes:`
	`19`	`+ /// </summary>`
`10`	`20`	`public class InputSettings<TInput> : RecorderInputSetting`
`11`	`21`	`{`
`12`	`22`	`public override Type inputType`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,11 @@ public enum ERecordingSessionStage`
`12`	`12`	`EndRecording,`
`13`	`13`	`}`
`14`	`14`
	`15`	`+ /// <summary>`
	`16`	`+ /// What is this:`
	`17`	`+ /// Motivation :`
	`18`	`+ /// Notes:`
	`19`	`+ /// </summary>`
`15`	`20`	`public abstract class Recorder : ScriptableObject`
`16`	`21`	`{`
`17`	`22`	`double m_OriginalCaptureFrameRate;`