Skip to content

Commit 5373525

Browse files
Update README.md
1 parent e321e0d commit 5373525

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# H264Sharp
22
Cisco's OpenH264 Native wrapper for .Net with optimised image format conversion support. It is very suitable for realtime streaming over network.
3+
- Plug&Play
34
- Tested on .NetFramework and Net(up to 8).
45
- Compatible with OpenCV.(i.e. OpenCVsharp)
56
- Tested on WPF application with camera and screen capture (P2P Videocall).
67
- No memory leaks or GC pressure with bitmaps.
78
- Simple console application example is provided as an example.
89

9-
Library consist of native dll which acts as openH264 wrapper and image format converter (Yuv <-> rgb,bgr,rgba,bgra)
10+
Library consist of native dll which acts as OpenH264 wrapper and image format converter (YUV420p <-> RGB,BGR,RGBA,BGRA)
1011
<br/>Converters are vectorised(AVX2) for high performance.
1112

1213
C# library is .Net standard wrapper library for this dll and performs PInvoke to handle transcoding.
1314
## Nuget
15+
Install the nuget package and its ready to go. All native dependencies are automatically installed.
16+
1417
[![NuGet](https://img.shields.io/nuget/v/H264Sharp)](https://www.nuget.org/packages/H264Sharp/1.0.4)
1518
## Example
1619
Examples can be found on examples directroy.
@@ -173,22 +176,22 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
173176
...
174177
```
175178

176-
# Converter dll
179+
## Converter dll
177180
A separate dll is provided for RGB <-> YUV conversions. Its compiled with clang LLVM with AVX2 intrinsics.
178181
</br>You can optionally include it on your executable path just like Openh264 dll.
179182
</br>
180183
</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.
181184
</br>External dll 2x+ faster than C++/Cli versions.
182185

183-
# TLDR how to install
186+
## TLDR how to install
184187
- Go to my releases find latest version.
185188
- Reference H264Sharp dll on your C# project.
186189
- 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).
187190
- Keep the original names if you want to use default constructors.
188191
- Optionally Add Converter64/32 dlls to your executable directory same way as openh264 dll.
189192
- Enjoy
190193

191-
# Remarks
194+
## Remarks
192195
- Decode callbacks with raw image formats use cached back buffer, if you wont consume them immediately, make a copy or sync your system.
193196
- Encoder output "EncodedFrame" uses cached back buffer, if you wont consume them immediately, make a copy or sync your system.
194197
- .Net Core and .Net Framework releases are provided.

0 commit comments

Comments
 (0)