ijkplayer 编译-打包-Pod支持

1,317 阅读6分钟

ijkplayerbilibili 开源的一款优秀的视频播放器,基于 ffplay,支持 iOS/Android,点播/直播,以及多种编解码方式。官方虽不提供现成的 framework,但大家可以根据需要自定义配置后,自己打包。本文仅对自己之前编译打包的过程做一简要记录。

⭐️ 文中部分图片摘自文末 参考,在此表示感谢!

本文为 iOS 的编译打包过程,环境为 Mac + Xcode

0、准备工作

依次安装homebrewgityasm,前两个自不必说,最后一个yasm是一个汇编器。

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install git
brew install yasm
  1. 若要检测以上 3 项是否已安装,可使用对应的 --version 命令。
  2. 如果嫌弃 homebrew 安装太慢,可以参考这份提速方案:Mac安装Homebrew

一、获取 ijkplayer 源码

ijkplayer.png

在一个合适的位置新建一个文件夹,比如 Desktop,文件夹名为 ijkplayer

cd ~/Desktop
mkdir ijkplayer
cd ~/Desktop/ijkplayer/

获取 ijkplayer 源码

# 获取 ijkplayer 源码
git clone https://github.com/Bilibili/ijkplayer.git ijkplayer-ios
# 进入源码目录
cd ijkplayer-ios
# 切换分支 (目前最新版本为 k0.8.8,可以自行去 GitHub 查看最新版本号)
git checkout -B latest k0.8.8

二、选择需要的编解码器或支持的格式(此步骤可选)

默认支持编解码器/格式 module-lite.sh,若需修改,可以选择以下 3 种配置之一,反之可以跳过此步骤。

  • module-default.sh: 更多的编解码器/格式
  • module-lite-hevc.sh: 较少的编解码器/格式(包括 hevc)
  • module-lite.sh: 较少的编解码器/格式(默认)
# 进入 config 目录
cd config

# 删除当前的 module.sh 文件
rm module.sh

# 可根据需要替换为 `module-default.sh`, `module-lite-hevc.sh`, `module-lite.sh` 之一
# 创建软链接 module.sh 指向 module-lite-hevc.sh
ln -s module-lite-hevc.sh module.sh

cd ..
cd ios
sh compile-ffmpeg.sh clean

module.png

说明1:对于 iOS 而言,module.sh 这些配置脚本是在编译 ffmpeg(即执行 ./compile-ffmpeg.sh)的时候用的。

说明2:HEVC 是 High Efficiency Video Coding 的缩写,别称 H.265,是一种新的视频压缩标准,用来以替代 H.264/AVC 编码标准,2013年1月26号,HEVC 正式成为国际标准。

三、获取 ffmpeg 并初始化

有两种方案可供选择:

  • 精简版本:不修改脚本,直接执行,则会缺少 armv7s,需要配合步骤 七(A) 执行;
  • 全版本:自己修改脚本,加上 armv7s 的支持,需要配合步骤 七(B) 执行。

A.精简版本(缺少 armv7s)

cd ..
./init-ios.sh

注意执行此命令前后,ios 目录的变化:

init-ios-before.png

init-ios-after.png

B.全版本(含 armv7s)

修改 init-ios.sh 脚本,加上 armv7s 环境

# 修改前
FF_ALL_ARCHS_IOS8_SDK="armv7 arm64 i386 x86_64"

# 修改后
FF_ALL_ARCHS_IOS8_SDK="armv7 armv7s arm64 i386 x86_64"

修改后执行脚本,下载各种环境(armv7、armv7s、arm64、i386、x86_64)下的 ffmpeg:

./init-ios.sh

说明:这里支持的架构种类、数量可以根据需要增减,可以不局限于上文 A、B 这两种方案。

四、自定义音视频文件处理方式(可选)

在真正开始编译之前,可以对代码进行修改,以满足自己不同的需求,比如添加 DRM 相关逻辑,达到音视频资源的可控访问,如 只能使用自己 App 内的播放器播放等,因暂未得到公司批准,故此处不便展开讲解,见谅。

五、打开 OpenSSL 开关

cd ./config

打开其中的 module.sh,作如下修改:

# 修改前
`export COMMON_FF_CFG_FLAGS="$COMMON_FF_CFG_FLAGS --disable-protocol=crypto"` 

# 修改后(即将 `disable` 改成 `enable`)
`export COMMON_FF_CFG_FLAGS="$COMMON_FF_CFG_FLAGS --enable-protocol=crypto"`

对于 iOS,module.sh 这些配置脚本是在编译 ffmpeg(即执行 ./compile-ffmpeg.sh)的时候用的。

六、添加 https 支持(可选)

如果执行了此步骤,那么经过第七步编译后,会生成支持 https 的静态文件 libcrypto.alibssl.a,如果不需要支持 https,可以跳过这一步。

# 获取 openssl 并初始化
./init-ios-openssl.sh

cd ios

# 在 module.sh 中添加一行配置 以启用 openssl 组件
echo 'export COMMON_FF_CFG_FLAGS="$COMMON_FF_CFG_FLAGS --enable-openssl"' >> ../config/module.sh

注意执行 ./init-ios-openssl.sh 后,ios 目录下多了什么。

init-ios-openssl.png

七、编译 OpenSSL(可选) 和 FFmpeg

位置:~/Desktop/ijkplayer/ijkplayer-ios/ios/

这里也是分为精简版本(对应步骤:三(A))和全版本(对应步骤:三(B))两种方案,差别就是有没有 armv7s,另外,openssl 的编译不需要修改,默认是全版本。

A.精简版本

A-1.编译 openssl(如果不需要支持 https,可以跳过这一步)

./compile-ffmpeg.sh clean

./compile-openssl.sh all

编译结束,输出:

Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libssl.a are: armv7 i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libcrypto.a are: armv7 i386 x86_64 arm64

A-2.编译ffmpeg

./compile-ffmpeg.sh all

编译结束,输出:

Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libavcodec.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libavfilter.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libavformat.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libavutil.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libswscale.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libswresample.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libcrypto.a are: i386 x86_64 arm64
Architectures in the fat file: /Users/haihe/Desktop/ijkplayer/ijkplayer-ios/ios/build/universal/lib/libssl.a are: i386 x86_64 arm64

最终生成的文件位置见下图:

.h 文件: FFMPEG-compiled-h.png

.a 文件: FFMPEG-compiled-a.png

A-3.可能遇到的错误

  • error-1:
`xcrun: error: SDK "iphoneos" cannot be located`

如果提示以上错误,请执行下方命令,然后重新执行报错的命令

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer/
  • error-2:
./libavutil/arm/asm.S:50:9: error: unknown directive
        .arch armv7-a
        ^
make: *** [libavcodec/arm/aacpsdsp_neon.o] Error 1

这是因为在 Xcode 9.1 之后(不含) 已经弱化了对 32 位架构的支持, 有2种解决方法:

第一种:在 compile-ffmpeg.sh 中删除 armv7(共3处), 修改后的代码如下,然后重新执行报错的命令

# 第24行改为:
FF_ALL_ARCHS_IOS8_SDK="arm64 i386 x86_64"

# 第120行改为:
if [ "$FF_TARGET" = "armv7s" -o "$FF_TARGET" = "arm64" ]; then

# 第159行改为:
echo " compile-ffmpeg.sh arm64|i386|x86_64"

第二种:按照 issue #4494befovy 的方案处理

当然,如果只需要支持64位架构,这里就只保留 arm64 和 x86_64,也可以加上 arm64e。

arm64e 是苹果在 Xcode 10.1 中偷偷添加的新的系统架构,使用 Apple A12 或更高版本 A 系列处理器(如 iPhone XS、iPhone XS Max 和 iPhone XR )的设备支持 arm64e 体系结构。

B.全版本

B-1.下载安装指定版本的 Xcode

  • 下载 9.1 或更早版本的 Xcode(下载地址),如下:

    Xcode9_1_download.png

  • 下载的文件 Xcode 9.1.xip 文件无法直接打开,需满足两个条件:

    • 磁盘剩余空间必须大于 20G
    • 移除解压验证,切到需要解压的 Xcode 9.1.xip 文件所在目录,然后终端执行:
    xattr -d com.apple.quarantine Xcode 9.1.xip 
    
  • 直接双击即可解压,解压完成最好改个名字,比如我这里改成了 Xcode_9_1.app,以便区分不同版本。

    Xcode_old_edition.png

B-2.编译openssl(如果不需要支持 https,可以跳过这一步)

./compile-ffmpeg.sh clean

./compile-openssl.sh all

B-3.编译ffmpeg

  • 修改 compile-ffmpeg.sh 脚本,在下面 2 个地方加上 armv7s

    FF_ALL_ARCHS_IOS8_SDK="armv7 armv7s arm64 i386 x86_64"
    
    echo "  compile-ffmpeg.sh armv7|armv7s|arm64|i386|x86_64"
    
  • 指定 Xcode 为 9.1 版本

sudo xcode-select --switch /Applications/Xcode_9_1.app/Contents/Developer/
  • 执行脚本,编译 ffmpeg

    ./compile-ffmpeg.sh all
    

clean 操作执行时机:如果之前执行过 all 操作,再次执行时需要先执行一次 clean 进行清理。

八、打开 IJKMediaPlayer 项目

使用下方命令或直接双击 IJKMediaPlayer.xcodeproj 打开 ios 目录下的 IJKMediaPlayer 项目

open IJKMediaPlayer/IJKMediaPlayer.xcodeproj

open-IJKMediaFramework.png

九、添加 OpenSSL 相关包以支持 https(可选)

  • 如果不需要支持 https, 可以跳过此步, 直接开始打包 framework

  • 如果需要支持 https, 就要手动给 IJKMediaFramework 添加 libcrypto.alibssl.a 文件, 默认不会添加

这两个依赖库的目录为 ijkplayer-ios/ios/build/universal/lib, 只有执行了上面跟 OpenSSL 相关的操作, 才会在这个目录下生成 libcrypto.a 和 libssl.a

如下图,TARGETS -> IJKMediaFramework -> General -> Frameworks and Libraries -> + 找到 libcrypto.alibssl.a 并添加。

framework-openssl.png

十、打包静态 framework

大家会发现,这里除了 IJKMediaFramework, 还有一个 target 叫 IJKMediaFrameworkWithSSL, 但是不推荐使用这个, 因为大部分基于 ijkplayer 的第三方框架都是使用的前者, 如果将后者导入项目还是会报找不到包的错误, 即使要支持 https 也推荐使用前者, 然后按照上一步添加 OpenSSL 即可。

ijkmediaframework.png

不过,有时可能由于种种原因,导致上边 scheme 的位置只能看到 IJKMediaFrameworkWithSSL ,没有 IJKMediaFramework (如下图),但是,targets 的位置又是有的,此时只需要新建 scheme 就可以了。

No-IJKMediaFramework.png

1. 配置 Release 模式

打开 Edit Scheme...

framework-release1.png

Run -> Info -> Build Configuration -> 选择 Release

framework-release2.png

2. 打包真机 framework

如图,切换到 Generic iOS Device 或者自己的手机,执行 command + B 编译。

device.png

如果第七步删除了 compile-ffmpeg.sharmv7, 此处就会报下边 2 个错误, 直接注释掉即可。

framework-build-error1.png

framework-build-error2.png

可以在左侧的报错信息上右击选择 Review in Log, 就会在右侧打印需要修改的文件的路径,打开对应文件,注掉对应代码,保存即可。

Review-in-Log.png

3. 打包模拟器 framework

如图,切换到任一模拟器,执行 command + B 编译。

simulator.png

4. 合并 framework

如下图所示,IJKMediaFramework.framework 上右击选中 Show in Finder 进入 Products 目录。

framework-position.png 其中,Release-iphoneos 对应真机 framework, Release-iphonesimulator 对应模拟器 framework (如下图所示)。

framework-build.png

终端切换到 Products 目录后,执行下面的合并和替换操作:

合并

将真机和模拟器的framework合并成一个,注意,合并的是 IJKMediaFramework 不是 IJKMediaFramework.framework。

// lipo -create <真机framework路径> <模拟器framework路径> -output <合并得到的文件路径>
lipo -create Release-iphoneos/IJKMediaFramework.framework/IJKMediaFramework Release-iphonesimulator/IJKMediaFramework.framework/IJKMediaFramework -output IJKMediaFramework

framework-combine.png

替换

将合并后的 IJKMediaFramework 拷贝到 iphoneos/IJKMediaFramework.framework 中替换文件,注意点同 合并 操作。

// cp <被拷贝的文件> <目标文件夹>
cp IJKMediaFramework Release-iphoneos/IJKMediaFramework.framework/

framework-replace.png

十一、CocoaPods 支持

为了使用方便,省去手动添加依赖库的麻烦,可以让其支持 CocoaPods。

至于如何创建私有库,详见 CocoaPods ☞ 使用: 创建并管理私有仓库

十二、⚠️ 注意事项

  • MPEG4 格式支持

测试过程中发现,使用默认配置 module-lite.sh 编译出来的 IJKMediaFramework 播放 MPEG4 格式的视频时,只有声音没有画面。这是因为 module-lite.sh 默认并不包含对 MPEG4 的支持,需要做如下修改:

// module-lite.sh 文件中增加:

export COMMON_FF_CFG_FLAGS="$COMMON_FF_CFG_FLAGS --enable-decoder=mpeg4"
  • 修改源码

对与 ffmpeg 相关的文件修改之后,需要重新执行 compile-ffmpeg.sh 脚本编译 .a 文件,然后再打包 framework;如果仅仅修改了 ijkplayer 的代码,则直接打包 framework 即可。

参考