Merge branch 'master' of https://github.com/ReferenceType/H264Sharp

Author: ReferenceType

README.md

@@ -1,20 +1,24 @@
 # H264Sharp
 Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support. It is very suitable for realtime streaming over network.
 - Offers managed and unmanaged API.
-- Tested on .NetFramework and NetCore(up to 7).
+- Tested on .NetFramework and NetCore(up to 8).
 - Compatible with OpenCV.(i.e. OpenCVsharp)
 - Tested on WPF application with camera and screen capture (P2P Videocall).
 - No memory leaks or GC pressure with bitmaps.
-- Simple console application example is provided on repo as an example.
+- Simple console application example is provided as an example.
 
 ### Setup
-- Default Constructor will look for `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` automatically on executable directory depending on process type.
+- Default Constructor will look for `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` automatically on executable directory depending on process type(64/32 bit).
 - You can setup with a different dll name, constructor is overloaded.
 ``` c#
   decoder = new H264Sharp.Decoder();
 
   encoder = new H264Sharp.Encoder();
-  encoder.Initialize(width, height, bps: 3_000_000, fps: 30, H264Sharp.Encoder.ConfigType.CameraBasic);
+  encoder.Initialize(width,
+                     height,
+                     bps: 3_000_000,
+                     fps: 30,
+                     H264Sharp.Encoder.ConfigType.CameraBasic);
 ```
 
 ### Encode 
@@ -26,9 +30,12 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
   {
       foreach (var frame in frames)
       {
-          //hints.. 
+          //You can convert to managed array
           //byte[] b = frame.ToByteArray();
+
+          // You can copy to Managed array
           //frame.CopyTo(buffer, 0);
+
           Decode(frame.Data, frame.Length, frame.Type);
       }
   }
@@ -41,30 +48,33 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
 ```C#
   void Decode(IntPtr data, int length, FrameType type)
   {
-      //if (decoder.Decode(data, length, noDelay:true, out DecodingState statusCode, out RgbImage rgb)) 
-      //if (decoder.Decode(data, length, noDelay:true, out DecodingState statusCode, out Yuv420p yuv420)) 
       if (decoder.Decode(data, length, noDelay:true, out DecodingState statusCode, out Bitmap bmp)) 
       {
           // Do stuff..
           // bmp.Save("t.bmp");
       }
   }
+// You can use other formats as:
+ decoder.Decode(data, length, noDelay:true, out DecodingState statusCode, out RgbImage rgb)
+ decoder.Decode(data, length, noDelay:true, out DecodingState statusCode, out Yuv420p yuv420)
+ ...
 ```
 
 # Converter dll
-A separate dll is provided for RGB <-> YUV conversions. Its compiled with clang LLVM and has AVX2 intrinsics.
+A separate dll is provided for RGB <-> YUV conversions. Its compiled with clang LLVM with AVX2 intrinsics.
 </br>You can optionally include it on your executable path just like Openh264 dll.
 </br>
-</br>If wrapper cannot find the Converter32/64 dll it will fall back to use C++/Cli versions.
+</br>If wrapper cannot find the Converter32/64 dll or if your machine does not support AVX2 it will fall back to use default C++/Cli versions.
 </br>External dll 2x+ faster than C++/Cli versions.
 
 # TLDR how to install
-- Go to my releases find lates version.
-- Reference H264Sharp dll on your project.
+- Go to my releases find latest version.
+- Reference H264Sharp dll on your C# project.
 - Add `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` or both to your executable directory(Or include on your project and ckeck copy to output-> copy if newer).
 - Keep the original names if you want to use default constructors.
 - Optionally Add Converter64/32 dlls to your executable directory same way as openh264 dll.
 - Enjoy
+
 # Remarks
 - Decode callbacks with raw image formats use cached back buffer, if you wont consume them immediately, make a copy or sync your system.
 - Encoder output "EncodedFrame" uses cached back buffer, if you wont consume them immediately, make a copy or sync your system.