Adding additional unit tests for static overlay, video splitter component and FFmpeg functionality.

Author: techyian

src/MMALSharp.FFmpeg/Handlers/FFmpegCaptureHandler.cs

@@ -15,13 +15,13 @@ namespace MMALSharp.Handlers
     public class FFmpegCaptureHandler : ICaptureHandler
     {
         private Process _process;
-                    
+        
         /// <summary>
         /// Streams video from the standard output stream via FFmpeg to an RTMP server.
         /// </summary>
         /// <param name="streamName">The meta name of the stream.</param>
         /// <param name="streamUrl">The url of your RTMP server - the url to stream to.</param>
-        /// <returns></returns>
+        /// <returns>A new instance of <see cref="FFmpegCaptureHandler"/> with process arguments to push to an RTMP stream.</returns>
         public static FFmpegCaptureHandler RTMPStreamer(string streamName, string streamUrl)
         {
             return new FFmpegCaptureHandler($"-i - -vcodec copy -an -f flv -metadata streamName={streamName} {streamUrl}");
@@ -32,13 +32,18 @@ public static FFmpegCaptureHandler RTMPStreamer(string streamName, string stream
         /// </summary>
         /// <param name="directory">The directory to store the output video file.</param>
         /// <param name="filename">The name of the video file.</param>
-        /// <returns></returns>
+        /// <returns>A new instance of <see cref="FFmpegCaptureHandler"/> with process arguments to convert raw video into a compatible AVI container.</returns>
         public static FFmpegCaptureHandler RawVideoToAvi(string directory, string filename)
         {            
             System.IO.Directory.CreateDirectory(directory);                        
+            
             return new FFmpegCaptureHandler($"-re -i - -c:v copy -an -f avi {directory.TrimEnd()}/{filename}.avi");
         }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="FFmpegCaptureHandler"/> with the specified process arguments.
+        /// </summary>
+        /// <param name="argument">The <see cref="ProcessStartInfo"/> argument.</param>
         public FFmpegCaptureHandler(string argument)
         {
             var processStartInfo = new ProcessStartInfo
@@ -105,6 +110,10 @@ public ProcessResult Process(uint allocSize)
             throw new NotImplementedException();
         }
 
+        /// <summary>
+        /// Writes frame data to the StandardInput stream to be processed by FFmpeg.
+        /// </summary>
+        /// <param name="data">The frame data to push to FFmpeg.</param>
         public void Process(byte[] data)
         {
             try
@@ -118,7 +127,7 @@ public void Process(byte[] data)
                 throw;         
             }            
         }
-
+        
         public void Split()
         {
             throw new NotImplementedException();

src/MMALSharp/MMALCameraConfig.cs

@@ -525,8 +525,8 @@ public struct Resolution : IComparable<Resolution>
         /// <summary>
         /// Creates a new instance of the <see cref="Resolution"/> class with the specified width and height.
         /// </summary>
-        /// <param name="width"></param>
-        /// <param name="height"></param>
+        /// <param name="width">The width to assign this resolution with.</param>
+        /// <param name="height">The height to assign this resolution with.</param>
         public Resolution(int width, int height)
         {
             Width = width;
@@ -604,7 +604,7 @@ public Resolution(int width, int height)
         /// <summary>
         /// Compares this Resolution instance against the Resolution passed in. 
         /// </summary>
-        /// <param name="res"></param>
+        /// <param name="res">The resolution we are comparing to.</param>
         /// <returns>0 if width and height are same. 1 if source width is greater than target. -1 if target greater than source.</returns>
         public int CompareTo(Resolution res)
         {
@@ -634,7 +634,7 @@ public int CompareTo(Resolution res)
         /// </summary>
         /// <param name="width">The width to be padded to.</param>
         /// <param name="height">The height to be padded to.</param>
-        /// <returns></returns>
+        /// <returns>A new <see cref="Resolution"/> struct, padded to the required width/height.</returns>
         public Resolution Pad(int width = 32, int height = 16)
         {
             return new Resolution(MMALUtil.VCOS_ALIGN_UP(this.Width, width),

src/MMALSharp/Ports/MMALPortImpl.cs

@@ -164,7 +164,7 @@ internal override void NativeOutputPortCallback(MMAL_PORT_T* port, MMAL_BUFFER_H
                 this.ReleaseOutputBuffer(bufferImpl);
 
                 // If this buffer signals the end of data stream, allow waiting thread to continue.
-                if (eos)
+                if (eos || failed)
                 {
                     if (this.Trigger != null && this.Trigger.CurrentCount > 0)
                     {

tests/MMALSharp.Tests/FFmpegTests.cs

@@ -3,9 +3,88 @@
 // Licensed under the MIT License. Please see LICENSE.txt for License info.
 // </copyright>
 
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using MMALSharp.Components;
+using MMALSharp.FFmpeg;
+using MMALSharp.Handlers;
+using MMALSharp.Native;
+using Nito.AsyncEx;
+using Xunit;
+
 namespace MMALSharp.Tests
 {
+    [Collection("MMALCollection")]
     public class FFmpegTests
     {
+        private readonly MMALFixture _fixture;
+
+        public FFmpegTests(MMALFixture fixture)
+        {
+            _fixture = fixture;
+            TestData.Fixture = fixture;
+        }
+
+        [Fact]
+        public void RawVideoConvert()
+        {
+            TestHelper.BeginTest("RawVideoConvert");
+            TestHelper.SetConfigurationDefaults();
+
+            AsyncContext.Run(async () =>
+            {
+                TestHelper.CleanDirectory("/home/pi/videos/tests");
+
+                using (var ffCaptureHandler = FFmpegCaptureHandler.RawVideoToAvi("/home/pi/videos/tests", "testing1234"))
+                using (var vidEncoder = new MMALVideoEncoder(ffCaptureHandler))
+                using (var renderer = new MMALVideoRenderer())
+                {
+                    _fixture.MMALCamera.ConfigureCameraSettings();
+
+                    vidEncoder.ConfigureOutputPort(0, MMALEncoding.H264, MMALEncoding.I420, 0, 25000000);
+
+                    _fixture.MMALCamera.Camera.VideoPort.ConnectTo(vidEncoder);
+                    _fixture.MMALCamera.Camera.PreviewPort.ConnectTo(renderer);
+
+                    // Camera warm up time
+                    await Task.Delay(2000);
+
+                    var cts = new CancellationTokenSource(TimeSpan.FromMinutes(3));
+
+                    // Take video for 3 minutes.
+                    await _fixture.MMALCamera.ProcessAsync(_fixture.MMALCamera.Camera.VideoPort, cts.Token);
+
+                    _fixture.CheckAndAssertFilepath("/home/pi/videos/tests/testing1234.avi");
+                }
+            });
+        }
+
+        [Fact]
+        public void ImagesToVideo()
+        {
+            TestHelper.BeginTest("ImagesToVideo");
+            TestHelper.SetConfigurationDefaults();
+
+            AsyncContext.Run(async () =>
+            {
+                TestHelper.CleanDirectory("/home/pi/videos/tests");
+                TestHelper.CleanDirectory("/home/pi/images/tests");
+
+                // This example will take an image every 5 seconds for 1 minute.
+                using (var imgCaptureHandler = new ImageStreamCaptureHandler("/home/pi/images/", "jpg"))
+                {
+                    var cts = new CancellationTokenSource(TimeSpan.FromMinutes(1));
+
+                    var tl = new Timelapse { Mode = TimelapseMode.Second, CancellationToken = cts.Token, Value = 5 };
+                    await _fixture.MMALCamera.TakePictureTimelapse(imgCaptureHandler, MMALEncoding.JPEG, MMALEncoding.I420, tl);
+
+                    // Process all images captured into a video at 2fps.
+                    imgCaptureHandler.ImagesToVideo("/home/pi/videos/tests", 2);
+
+                    _fixture.CheckAndAssertFilepath("/home/pi/videos/tests/out.avi");
+                }
+            });
+        }
     }
 }