|author||Cullen Jennings <firstname.lastname@example.org>||Fri Oct 15 01:21:42 2021|
|committer||GitHub <email@example.com>||Fri Oct 15 01:21:42 2021|
Test Travis Builds
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.
NASM needed to be installed for assembly code: workable version 2.10.06 or above, NASM can downloaded from http://www.nasm.us/. For Mac OSX 64-bit NASM needed to be below version 2.11.08 as NASM 2.11.08 will introduce error when using RIP-relative addresses in Mac OSX 64-bit
To build the arm assembly for Windows Phone, gas-preprocessor is required. It can be downloaded from git://git.libav.org/gas-preprocessor.git
To build for android platform, You need to install android sdk and ndk. You also need to export
**ANDROID_SDK**/tools to PATH. On Linux, this can be done by
The codec and demo can be built by
make OS=android NDKROOT=**ANDROID_NDK** TARGET=**ANDROID_TARGET**
**ANDROID_TARGET** can be found in
**ANDROID_SDK**/platforms, such as
android-12. You can also set
NDKLEVEL according to your device and NDK version.
ARCH specifies the architecture of android device. Currently
x86_64 are supported, the default is
mips64 can also be used, but there's no specific optimization for those architectures.)
NDKLEVEL specifies android api level, the default is 12. Available possibilities can be found in
**ANDROID_NDK**/platforms, such as
android-21 (strip away the
By default these commands build for the
armeabi-v7a ABI. To build for the other android ABIs, add
ARCH=mips64. To build for the older
armeabi ABI (which has armv5te as baseline), add
ARCH=arm is implicit). To build for 64-bit ABI, such as
arm64, explicitly set
NDKLEVEL to 21 or higher.
You can build the libraries and demo applications using xcode project files located in
You can also build the libraries (but not the demo applications) using the make based build system from the command line. Build with
make OS=ios ARCH=**ARCH**
Valid values for
**ARCH** are the normal iOS architecture names such as
x86_64 for the simulator. Another settable iOS specific parameter is
SDK_MIN, specifying the minimum deployment target for the built library. For other details on building using make on the command line, see ‘For All Platforms’ below.
You can build the libraries (but not the demo applications) using the make based build system from the command line. Build with
make OS=linux ARCH=**ARCH**
You can set
ARCH according to your linux device .
ARCH specifies the architecture of the device. Currently
x86_64 are supported
NOTICE: If your computer is x86 architecture, for build the libnary which be used on arm/aarch64 machine, you may need to use cross-compiler, for example: make OS=linux CC=aarch64-linux-gnu-gcc CXX=aarch64-linux-gnu-g++ ARCH=arm64 or make OS=linux CC=arm-linux-gnueabi-gcc CXX=arm-linux-gnueabi-g++ ARCH=arm
Our Windows builds use MinGW which can be downloaded from http://www.mingw.org/
To build with gcc, add the MinGW bin directory (e.g.
/c/MinGW/bin) to your path and follow the ‘For All Platforms’ instructions below.
To build with Visual Studio you will need to set up your path to run cl.exe. The easiest way is to start MSYS from a developer command line session. Instructions can be found at http://msdn.microsoft.com/en-us/library/ms229859(v=vs.110).aspx. If you need to do it by hand here is an example from a Windows 64bit install of VS2012:
export PATH="$PATH:/c/Program Files (x86)/Microsoft Visual Studio 11.0/VC/bin:/c/Program Files (x86)/Microsoft Visual Studio 11.0/Common7/IDE"
You will also need to set your INCLUDE and LIB paths to point to your VS and SDK installs. Something like this, again from Win64 with VS2012 (note the use of Windows-style paths here).
export INCLUDE="C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\include;C:\Program Files (x86)\Windows Kits\8.0\Include\um;C:\Program Files (x86)\Windows Kits\8.0\Include\shared" export LIB="C:\Program Files (x86)\Windows Kits\8.0\Lib\Win8\um\x86;C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\lib"
OS=msvc to the make line of the ‘For All Platforms’ instructions.
Follow the instructions above for normal Windows builds, but use
OS=msvc-wp instead of
OS=msvc. You will also need gas-preprocessor (as mentioned below “Building the Library”).
If building for Windows Phone with MSVC 2013, there's no included bat file that sets the lib paths to the Windows Phone kit, but that can be done with a command like this:
export LIB="c:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\lib\store\arm;c:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\lib\arm;c:\Program Files (x86)\Windows Phone Kits\8.1\lib\arm"
This is only necessary for building the DLL; the static library can be built without setting this.
Note, only Windows Phone 8.1 or newer is supported, 8.0 is no longer supported.
From the main project directory:
makefor automatically detecting architecture and building accordingly
make ARCH=i386for x86 32-bit builds
make ARCH=x86_64for x86 64-bit builds
make V=Nofor a silent build (not showing the actual compiler commands)
make DEBUGSYMBOLS=Truefor two libraries, one is normal libraries, another one is removed the debugging symbol table entries (those created by the -g option)
The command line programs
h264dec will appear in the main project directory.
A shell script to run the command-line apps is in
Usage information can be found in
Meson build definitions have been added, and are known to work on Linux and Windows, for x86 and x86 64-bit.
See http://mesonbuild.com/Installing.html for instructions on how to install meson, then:
meson builddir ninja -C builddir
Run the tests with:
meson test -C builddir -v
ninja -C builddir install
codec- encoder, decoder, console (test app), build (makefile, vcproj)
build- scripts for Makefile build system
test- GTest unittest files
testbin- autobuild scripts, test app config files
res- yuv and bitstream test files
See the issue tracker on https://github.com/cisco/openh264/issues
LICENSE file for details.