Skip to content

Commit 0788357

Browse files
Update README.md
1 parent 5373525 commit 0788357

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
123123
- No memory leaks or GC pressure with bitmaps.
124124
- Simple console application example is provided as an example.
125125

126-
### Setup
126+
### Setup(deprecated)
127127
- 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).
128128
- You can setup with a different dll name, constructor is overloaded.
129129
``` c#
@@ -137,7 +137,7 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
137137
H264Sharp.Encoder.ConfigType.CameraBasic);
138138
```
139139

140-
### Encode
140+
### Encode (deprecated)
141141
- You can encode from rgb/rgba/bgr/bgra/yuv_i420 on as raw data format, or System.Drawing.Bitmaps.
142142
- Raw data is compatible with OpenCV Mats or any other standard image container.
143143
- EncodedFrame represents h264 encoded bytes(NALs etc).
@@ -158,7 +158,7 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
158158
```
159159

160160

161-
### Decode
161+
### Decode(deprecated)
162162
- You can decode with pointers or with managed byte array as input.
163163
- You can decode into System.Drawing.Bitmaps or raw data format images (they are compatible with OpenCV Mats and any other standard image containers.).
164164
```C#
@@ -176,22 +176,22 @@ Cisco's OpenH264 C++/CLI wrapper with optimised image format conversion support.
176176
...
177177
```
178178

179-
## Converter dll
179+
## Converter dll(deprecated)
180180
A separate dll is provided for RGB <-> YUV conversions. Its compiled with clang LLVM with AVX2 intrinsics.
181181
</br>You can optionally include it on your executable path just like Openh264 dll.
182182
</br>
183183
</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.
184184
</br>External dll 2x+ faster than C++/Cli versions.
185185

186-
## TLDR how to install
186+
## TLDR how to install(deprecated)
187187
- Go to my releases find latest version.
188188
- Reference H264Sharp dll on your C# project.
189189
- 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).
190190
- Keep the original names if you want to use default constructors.
191191
- Optionally Add Converter64/32 dlls to your executable directory same way as openh264 dll.
192192
- Enjoy
193193

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

0 commit comments

Comments
 (0)