generic-library/openh264
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #89 from RichiH/patch-1

Browse Source 
README.md: Formatting
This commit is contained in:
Andreas Gal 2014-01-02 06:25:27 -08:00
commit 3958118bf0
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,9 +1,9 @@
OpenH264 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. 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 Encoder Features
------------------------ ----------------
- Constrained Baseline Profile up to Level 5.2 (4096x2304) - Constrained Baseline Profile up to Level 5.2 (4096x2304)
- Arbitrary resolution, not constrained to multiples of 16x16 - Arbitrary resolution, not constrained to multiples of 16x16
- Rate control with adaptive quantization, or constant quantization - Rate control with adaptive quantization, or constant quantization
@ -22,7 +22,7 @@ Encoder Features
- YUV 4:2:0 planar input - YUV 4:2:0 planar input
Decoder Features Decoder Features
------------------------ ----------------
- Constrained Baseline Profile up to Level 5.2 (4096x2304) - Constrained Baseline Profile up to Level 5.2 (4096x2304)
- Arbitrary resolution, not constrained to multiples of 16x16 - Arbitrary resolution, not constrained to multiples of 16x16
- Single thread for all slices - Single thread for all slices
@ -34,7 +34,7 @@ Decoder Features
- YUV 4:2:0 planar output - YUV 4:2:0 planar output
OS Support OS Support
---------------- ----------
- Windows 64-bit and 32-bit (initial release is only 32-bit, 64-bit will follow soon) - 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) - 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) - Linux 64-bit and 32-bit (initial release is only 32-bit, 64-bit will follow soon)
@ -42,17 +42,17 @@ OS Support
- iOS 64-bit and 32-bit (not supported yet, may be added in the future) - iOS 64-bit and 32-bit (not supported yet, may be added in the future)
Processor Support Processor Support
------------------------- -----------------
- Intel x86 optionally with MMX/SSE (no AVX yet, help is welcome) - 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) - ARMv7 optionally with NEON (initial release does not include this target, will follow later)
- Any architecture using C/C++ fallback functions - Any architecture using C/C++ fallback functions
Building the Library 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/ 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 For Windows Builds
----------------------- ------------------
Windows Visual Studio 2008/2010/2012 projects are available: Windows Visual Studio 2008/2010/2012 projects are available:
: build the decoder via the Visual Studio projects in codec/build/win32/dec : 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 : build the encoder via the Visual Studio projects in codec/build/win32/enc
@ -66,7 +66,7 @@ Windows batch files also exist for building:
: Visual Studio 2012 use testbin/AutoBuild_Windows_VS2012.bat : Visual Studio 2012 use testbin/AutoBuild_Windows_VS2012.bat
For Other Platforms For Other Platforms
------------------------ -------------------
From the main project directory: From the main project directory:
'make' for 32bit builds 'make' for 32bit builds
'make ENABLE64BIT=Yes' for 64bit builds 'make ENABLE64BIT=Yes' for 64bit builds
@ -78,7 +78,7 @@ A shell script to run the command-line apps is in testbin/CmdLineExample.sh
Usage information can be found in testbin/CmdLineReadMe Usage information can be found in testbin/CmdLineReadMe
Using the Source Using the Source
----------------------- ----------------
codec - encoder, decoder, console (test app), build (makefile, vcproj) codec - encoder, decoder, console (test app), build (makefile, vcproj)
processing - raw pixel processing (used by encoder) processing - raw pixel processing (used by encoder)
build - scripts for Makefile build system. build - scripts for Makefile build system.
@ -87,7 +87,7 @@ testbin - autobuild scripts, test app config files, yuv test files
bin - binaries for library and test app bin - binaries for library and test app
Known Issues Known Issues
------------------- ------------
See the issue tracker on https://github.com/cisco/openh264/issues See the issue tracker on https://github.com/cisco/openh264/issues
- Encoder errors when resolution exceeds 3840x2160 - Encoder errors when resolution exceeds 3840x2160
- Encoder errors when compressed frame size exceeds half uncompressed size - Encoder errors when compressed frame size exceeds half uncompressed size
@ -95,5 +95,5 @@ See the issue tracker on https://github.com/cisco/openh264/issues
- Decoder errors when compressed frame size exceeds 1MB - Decoder errors when compressed frame size exceeds 1MB
License License
---------- -------
BSD, see LICENSE file for details. BSD, see LICENSE file for details.