Wrapper for the FFmpeg that simplify usage it from C++ projects.

Currently covered next functionality:

• Core helper & utility classes (AVFrame → av::AudioSample & av::VideoFrame, AVRational → av::Rational and so on)
• Container formats & contexts muxing and demuxing
• Codecs & codecs contexts: encoding and decoding
• Streams (AVStream → av::Stream)
• Subtitles (AVSubtitle → av::SubtitleFrame): decoding, encoding, text/ASS payloads and bitmap rectangles
• Filters (audio & video): parsing from string, manual adding filters to the graph & other
• SW Video & Audio resamplers

You can read the full documentation here.

• FFmpeg >= 4.0
  • libavformat >= 58.x.x
  • libavcodec >= 58.x.x
  • libavdevice >= 58.x.x
  • libavfilter >= 7.x.x
  • libavutil >= 56.x.x
  • libswscale >= 5.x.x
  • libswresample >= 3.x.x
  • libpostproc >= 55.x.x
• GCC >= 9.0 (C++17 is required. See, GCC from 6.0 may built code, but unchecked)
• CMake (> 3.19)

You should install FFmpeg packages from the deb-multimedia.org site:

sudo apt-get install libavformat-dev \
                     libavcodec-dev \
                     libavutil-dev \
                     libavfilter-dev \
                     libswscale-dev \
                     libswresample-dev \
                     libpostproc-dev \
                     libavdevice-dev

If you are on Ubuntu bionic or Linux Mint 19.x you should add ffmpeg-4 PPA:

sudo add-apt-repository ppa:jonathonf/ffmpeg-4 -y
sudo apt update && sudo apt upgrade

After that just install the same packages as above.

git clone https://github.com/h4tr3d/avcpp.git avcpp-git
cd avcpp-git
mkdir build
cd build
cmake ..
make -j8

The test framework (Catch2) is downloaded automatically at configure time, so no submodules are required.

If FFmpeg located in non-standard place:

cmake -DPC_FFMPEG_LIBRARY_DIRS=<some_path> -DPC_FFMPEG_INCLUDE_DIRS=<some_path> ..

To point install prefix:

cmake -DCMAKE_INSTALL_PREFIX=/usr ..

Install:

sudo make install

or (for packaging)

sudo make DESTDIR=<some_prefix> install

Refer to CMake documentation for more details that can cover some special cases.

• AV_ENABLE_STATIC - Bool, enable static library build, On by default.
• AV_ENABLE_SHARED - Bool, enable shared library build, On by default.
• AV_BUILD_EXAMPLES - Bool, enable examples build, On by default.
• AVCPP_ENABLE_TESTS - Bool, enable tests build, On by default. Catch2 is downloaded at configure time with a pinned version and hash; set FETCHCONTENT_SOURCE_DIR_CATCH2 to use a local copy.
• AV_BUILD_TESTS - Deprecated alias for AVCPP_ENABLE_TESTS.
• AV_DISABLE_AVFORMAT - Bool, disable livavformat usage. libavformat enabled by default. As dependency disables libavfilter and libavdevice.
• AV_DISABLE_AVFILTER - Bool, disable libavfilter usage. libavfilter enabled by default. As dependency disables libavdevice.
• AV_DISABLE_AVDEVICE - Bool, disable libavdevice usage. libavdevice enabled by default.
• AVCPP_TEST_DATA - Bool, enable tests that use the avcpp-test-data binary fixtures, Off by default. The fixtures are fetched over HTTPS from a separate repository; point FETCHCONTENT_SOURCE_DIR_AVCPP_TEST_DATA at a local checkout to avoid a network fetch.
• C++ related
  • CMAKE_CXX_STANDARD - Can be defined globally to override default C++ version. C++17 required at least.
• FFmpeg related:
  • FFMPEG_PKG_CONFIG_SUFFIX - String, TBD
  • PC_<component>_LIBRARY_DIRS - Path, hint where FFmpeg component library looking
  • PC_FFMPEG_LIBRARY_DIRS - Path, hint where a whole FFmpeg libraries looking
  • PC_<component>_INCLUDE_DIRS - Path, hint where a FFmpeg component includes looking
  • PC_FFMPEG_INCLUDE_DIRS - Path, hint where a whole FFmpeg includes looking
  • <component> are:
    • AVCODEC
    • AVDEVICE
    • AVFORMAT
    • AVFILTER
    • AVUTIL
    • POSTPROC
    • SWSCALE
    • SWRESAMPLE

AvCpp can be simple integrated into CMake-based project as Git submodule.

Just do something like:

git submodule add https://github.com/h4tr3d/avcpp.git 3rdparty/avcpp

And in the your CMakeLists.txt:

add_subdirectory(3rdparty/avcpp)

AvCpp detects that it included as non-root projects and skips some steps, like installation.

CMake parameters pointed above may be sets before add_subdirectory().

Than use via target_link_libraries:

target_link_libraries(prog PRIVATE avcpp::avcpp)

Just do in your CMakeLists.txt:

include(FetchContent)
FetchContent_Declare(
    avcpp
    GIT_REPOSITORY https://github.com/h4tr3d/avcpp.git
    GIT_TAG        v3.0.1
)
FetchContent_MakeAvailable(avcpp)

Than use via target_link_libraries:

target_link_libraries(prog PRIVATE avcpp::avcpp)

CMake arguments can be set before FetchContent_MakeAvailable call:

FetchContent_Declare(
    avcpp
    ...
)
set(AV_ENABLE_STATIC On)
set(AV_ENABLE_SHARED Off)
FetchContent_MakeAvailable(avcpp)

Just put into vcpkg.json:

{
    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
    "dependencies": [
        ...
        "avcpp",
        ...
    ],
    "name": "your-app-name",
    "version-string": "0.0.1"
}

Than in the your CMakeLists.txt:

find_package(avcpp CONFIG REQUIRED)
target_link_libraries(prog PRIVATE avcpp::avcpp)

Before you can begin with the building you have to clone the repository like this:

git clone https://github.com/h4tr3d/avcpp.git avcpp-git
cd avcpp-git

IDE Integration:

There are extentions for various IDEs like VS Code/Codium, Eclipse, Xcode, etc. Refer to the docs for more information.

Building the project:

If you don't have the dependencies installed, meson will download and compile them. Because ffmpeg is so large (~2000 c files), you should consider using your package manager to install them. You can then build the project with the following commands:

mkdir build
cd build
meson ..
meson compile

Configuring the project:

By default the sample projects and the test are compiled. If you don't want this you can disable it with the following commands:

meson configure -Dbuild_tests=false
meson configure -Dbuild_samples=false

build_tests is the Meson equivalent of the CMake option AVCPP_ENABLE_TESTS. The optional binary fixtures are controlled by the test_data option and require the avcpp-test-data subproject; it is the Meson equivalent of the CMake option AVCPP_TEST_DATA.

You can set the install prefix using meson --prefix <your/own/prefix>. To see all of the available options just type meson configure and meson configure --help to get more information.

Installing the project:

Just type meson install and the project will be installed in the configured prefix (/usr/local by default).

Running the tests:

To run the test just use meson test. If you disabled the test this will do nothing.