使用 CMAKE 和 RPATH 捆绑 FFMPEG

Question

正如标题所解释的，我正在尝试将 FFMPEG 与我的可执行应用程序捆绑在一起。

但是，我似乎无法弄清楚 FFMPEG 共享库的运行时加载。我不确定什么是不正确的：

• 主项目和 FFMPEG 库的 RPATH/RUNPATH 。
• CMake 安装步骤。
• 或者只是我的整个方法（最有可能）。

这是一个 CMake 项目，希望最终找到一个“标准解决方案”，我将包含重现此问题所需的所有内容。

CMakeLists.txt：

cmake_minimum_required(VERSION 3.21) # Required for the install(RUNTIME_DEPENDENCY_SET...) subcommand
project(cmake-demo LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED YES)
set(CMAKE_CXX_EXTENSIONS NO)

set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_VISIBILITY_INLINES_HIDDEN YES)

set(CMAKE_POSITION_INDEPENDENT_CODE ON)

# Setup CMAKE_PREFIX_PATH for `find_package`
list(APPEND CMAKE_PREFIX_PATH ${CMAKE_CURRENT_LIST_DIR}/vendor/install)
find_package(PkgConfig REQUIRED)
pkg_check_modules(ffmpeg REQUIRED IMPORTED_TARGET libavdevice libavfilter libavformat libavcodec
    libswresample libswscale libavutil)

# Setup variable representing the vendor install directory
set(VENDOR_PATH ${CMAKE_CURRENT_LIST_DIR}/vendor/install)
# Set RPATH to the dependency install tree
set(CMAKE_INSTALL_RPATH $ORIGIN/../deps)

# Add our executable target
add_executable(demo main.cpp)
target_include_directories(demo PRIVATE ${VENDOR_PATH}/include)
target_link_libraries(demo PRIVATE PkgConfig::ffmpeg)

include(GNUInstallDirs)
install(TARGETS demo RUNTIME_DEPENDENCY_SET runtime_deps)
install(RUNTIME_DEPENDENCY_SET runtime_deps
    DESTINATION ${CMAKE_INSTALL_PREFIX}/deps
    # DIRECTORIES ${VENDOR_PATH}/lib
    POST_EXCLUDE_REGEXES "^/lib" "^/usr" "^/bin")

main.cpp：

extern "C"{
#include <libavcodec/avcodec.h>
}

#include <iostream>

int main(int argc, char* argv[])
{
    std::cout << "FFMPEG AVCODEC VERSION: " << avcodec_version() << std::endl;
    return 0;
}

说明：

设置 FFMPEG（这可能需要一段时间...）：

git clone https://github.com/FFmpeg/FFmpeg.git --recurse-submodules --shallow-submodules vendor/src/ffmpeg
git checkout release/5.0
export INSTALL_PATH=$PWD/vendor/install
cd vendor/src/ffmpeg
./configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldexeflags=-pie
# WITH RPATH (HARDCODED TO VENDOR install directory)
# ./configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldflags=-Wl,-rpath,$INSTALL_PATH/lib --extra-ldexeflags=-pie
make -j16 V=1
make install
cd ../../..

CMake 命令：

cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install
cmake --build build -j16 #-v
cmake --install build

步骤之间的清理：

# Run from top-level dir of project
rm -rf build install
rm -rf vendor/install # ONLY if you need to modify the FFMPEG step.

调查：

1. 按照 <一个href="https://stackoverflow.com/questions/38058041/ Correct-usage-of-rpath-relative-vs-absolute/38058216#38058216">这篇帖子我设置了RPATH/RUNPATH< /code> 到 $ORIGIN/../deps 的可执行文件，并且 FFMPEG 库上没有 RPATH。

• 当我这样做时，cmake 安装步骤失败，抱怨 libavutil.so 无法在 install(RUNTIME_DEPENDENCY_SET...) 函数中解析。这确实有意义，因为在 build 目录中生成的 cmake_install.cmake 脚本正在将演示可执行文件移动到安装目录并执行 file(RPATH_CHANGE...) 在进行运行时依赖集分析之前对可执行文件进行分析。根据 CMake 文档此处并使用readelf -d demo 可执行文件的 RUNPATH 是 $ORIGIN/../deps 并且只有文档中的情况 #1 适用于此处，因此图书馆不是根本就没有找到。

2. 从 1 中引用的 CMake 文档中， install(RUNTIME_DEPENDENCY_SET...) 函数有一个可用作搜索路径的 DIRECTORIES 参数。组合 1 中的设置时，在 CMakeLists.txt 中取消注释并重新运行所有 CMake 命令，安装就会成功（尽管如文档所述，CMake 确实会针对使用 DIRECTORIES 找到的所有依赖项发出警告） ）。但是，运行可执行文件（即./install/bin/demo）会失败，因为运行时加载程序无法找到libswresample.so。对此进行进一步调试，我运行了 export LD_DEBUG=libs 并尝试重新启动可执行文件。这表明运行时加载程序正在使用 demo 中的 $ORIGIN/../deps RUNPATH 查找 libavcodec.so。然而，当搜索传递依赖项时（即libavcodec.so对libswresample.so的依赖），的RUNPATH demo 没有被搜索，而是加载器回退到系统路径并且找不到库。
3. 通过在 FFMPEG 库上设置 RPATH，而不是在 CMake install(RUNTIME_DEPENDENCY_SET...) 子命令中使用 DIRECTORIES 参数，我能够满足 CMake 和加载程序的要求。 CMake 运行时没有任何警告，并且可执行文件按预期加载/运行。但是，这不是一个可行的解决方案，因为使用 ldd 检查 install/deps 文件夹中的库时，libswresample.so 和其他库指向 vendor/install 目录，该目录在部署时不会出现在捆绑包中。

有谁知道标准方法是什么或者我上面缺少什么？我对任何和所有建议/工具持开放态度，但我这样做是为了尝试了解什么是“标准实践”，并希望将其扩展到跨平台解决方案（即 Windows/macOS）。因此，我想避免弄乱系统级加载器配置（ldconfig）。

谢谢！

Answer 1

重现问题

为了尝试重现您的问题，我实际上放弃了所有 CMake 内容，只是从命令行编译了 main.cpp 。我想您会同意问题的根源在于 ffmpeg 构建。

g++ -I vendor/install/include -c -o main.o main.cpp
g++ -L vendor/install/lib -o main main.o -lavcodec

输出如下所示：

usr/bin/ld: warning: libswresample.so.4, needed by vendor/install/lib/libavcodec.so, not found (try using -rpath or -rpath-link)
/usr/bin/ld: warning: libavutil.so.57, needed by vendor/install/lib/libavcodec.so, not found (try using -rpath or -rpath-link)
/usr/bin/ld: vendor/install/lib/libavcodec.so: undefined reference to `av_opt_set_int@LIBAVUTIL_57'
/usr/bin/ld: vendor/install/lib/libavcodec.so: undefined reference to `av_get_picture_type_char@LIBAVUTIL_57'
# many more lines of undefined references

您可以通过添加 -rpath-link... 来消除此问题...

g++ -Wl,-rpath-link,vendor/install/lib -L vendor/install/lib -o main main.o -lavcodec

但可执行文件失败并出现以下错误：

./main: error while loading shared libraries: libavcodec.so.59: cannot open shared object file: No such file or directory

如果您使用 -rpath 而不是-rpath-link，您会收到此错误：

./main: error while loading shared libraries: libswresample.so.4: cannot open shared object file: No such file or directory

最后一个错误是因为 libavcodec.so 引用了 libwresample.so，并且没有它在它的 RPATH 中。 main 成功找到 libavcodec.so，但随后动态链接器卡住了。

解决问题

据我所知，ffmpeg configure 脚本会清理通过 --extra-ldflags 传入的参数及其变体。无论您如何努力，我认为它都不会允许您以这种方式传递 $ 符号。要传递未经清理的参数，您应该在调用 configure 时在环境中设置 LDFLAGS （及其变体）。最终目标是将字符串 -Wl,-rpath,'$ORIGIN' 放入命令中以创建每个库，这意味着我们希望将该值分配给 LDSOFLAGS。让我们首先直接传递它：

LDSOFLAGS=-Wl,-rpath,'$ORIGIN' ../configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldexeflags=-pie

在 src/build/ffbuild/config.mak 中，我们看到以下行：

LDSOFLAGS=-Wl,-rpath,$ORIGIN

在本例中，单引号由运行 configure 的 shell 解释 命令，因此它们不会出现在生成的 makefile 中。

但是，如果我们对单引号进行转义，那么 shell 将扩展 $ORIGIN 环境变量（在本例中为空），并生成以下行：

LDSOFLAGS=-Wl,-rpath,''

如果将“真正的”单引号放在转义的内部然而，

LDSOFLAGS=-Wl,-rpath,\''$ORIGIN'\' ../configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldexeflags=-pie

它会产生正确的行：

LDSOFLAGS=-Wl,-rpath,'$ORIGIN'

但是现在，存在 make 也 使用 $ 符号的问题。通常，我们可以通过用 $$ 替换它来转义 $ 符号。 但是，您可以在src/ffbuild/library.mak中看到LDSOFLAGS在define RULES内部使用，然后将其与行 $(eval $(RULES)) 一起应用。这将立即扩展 LDSOFLAGS 及其内部的任何变量，这意味着在最终版本中 $$ 将被替换为单个 $配方，所以，我们需要使用四个 $ 符号才能在 eval 中的扩展中生存下来执行配方时的扩展。

LDSOFLAGS=-Wl,-rpath,\''$$ORIGIN'\' ../configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldexeflags=-pie

为了完整起见，我们还定义 LDEXEFLAGS ，以便 ffmpeg 可执行文件正常工作。请注意，LDEXEFLAGS 仅需要两个 $ 符号（您必须查看 makefile 才能知道这一点）。

LDEXEFLAGS=-Wl,-rpath,\''$ORIGIN/../lib'\' LDSOFLAGS=-Wl,-rpath,\''$$ORIGIN'\' ../configure --prefix=$INSTALL_PATH --enable-shared --disable-static --enable-pic --enable-lto --extra-cflags=-fPIC --extra-ldexeflags=-pie

构建和安装后，最后要做的就是确保 main 也具有正确的 RPATH：

g++ -Wl,-rpath,'$ORIGIN/vendor/install/lib' -L vendor/install/lib -o main main.o -lavcodec

结果如下：

$ ./main
FFMPEG AVCODEC VERSION: 3871332