ref: 7caa3941d5e56ee39ae77eefb56d94599b0313b3
parent: 469419bfb4cf1aba6550114795b4d8615927aa3c
author: Richard Hartmann <RichiH@users.noreply.github.com>
date: Wed Jan 1 09:57:34 EST 2014
README.md: Formatting
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
OpenH264
-=======
+========
OpenH264 is a codec library which supports H.264 encoding and decoding. It is suitable for use in real time applications such as WebRTC. See http://www.openh264.org/ for more details.
Encoder Features
-------------------------
+----------------
- Constrained Baseline Profile up to Level 5.2 (4096x2304)
- Arbitrary resolution, not constrained to multiples of 16x16
- Rate control with adaptive quantization, or constant quantization
@@ -22,7 +22,7 @@
- YUV 4:2:0 planar input
Decoder Features
-------------------------
+----------------
- Constrained Baseline Profile up to Level 5.2 (4096x2304)
- Arbitrary resolution, not constrained to multiples of 16x16
- Single thread for all slices
@@ -34,7 +34,7 @@
- YUV 4:2:0 planar output
OS Support
-----------------
+----------
- Windows 64-bit and 32-bit (initial release is only 32-bit, 64-bit will follow soon)
- Mac OS X 64-bit (initial release does not include this target, will follow soon)
- Linux 64-bit and 32-bit (initial release is only 32-bit, 64-bit will follow soon)
@@ -42,17 +42,17 @@
- iOS 64-bit and 32-bit (not supported yet, may be added in the future)
Processor Support
--------------------------
+-----------------
- Intel x86 optionally with MMX/SSE (no AVX yet, help is welcome)
- ARMv7 optionally with NEON (initial release does not include this target, will follow later)
- Any architecture using C/C++ fallback functions
Building the Library
------------------------
+--------------------
NASM needed to be installed for assembly code: workable version 2.07 or above, nasm can downloaded from http://www.nasm.us/
For Windows Builds
------------------------
+------------------
Windows Visual Studio 2008/2010/2012 projects are available:
: build the decoder via the Visual Studio projects in codec/build/win32/dec
: build the encoder via the Visual Studio projects in codec/build/win32/enc
@@ -66,7 +66,7 @@
: Visual Studio 2012 use testbin/AutoBuild_Windows_VS2012.bat
For Other Platforms
-------------------------
+-------------------
From the main project directory:
'make' for 32bit builds
'make ENABLE64BIT=Yes' for 64bit builds
@@ -78,7 +78,7 @@
Usage information can be found in testbin/CmdLineReadMe
Using the Source
------------------------
+----------------
codec - encoder, decoder, console (test app), build (makefile, vcproj)
processing - raw pixel processing (used by encoder)
build - scripts for Makefile build system.
@@ -87,7 +87,7 @@
bin - binaries for library and test app
Known Issues
--------------------
+------------
See the issue tracker on https://github.com/cisco/openh264/issues
- Encoder errors when resolution exceeds 3840x2160
- Encoder errors when compressed frame size exceeds half uncompressed size
@@ -95,5 +95,5 @@
- Decoder errors when compressed frame size exceeds 1MB
License
-----------
+-------
BSD, see LICENSE file for details.