ijkplayer README

The project's README from github.com/bilibili/ijkplayer. As one markdown file: README.md.

ijkplayer

Platform Build Status
Android Build Status
iOS Build Status

Video player based on ffplay

Download

# required
allprojects {
    repositories {
        jcenter()
    }
}

dependencies {
    # required, enough for most devices.
    compile 'tv.danmaku.ijk.media:ijkplayer-java:0.8.8'
    compile 'tv.danmaku.ijk.media:ijkplayer-armv7a:0.8.8'

    # Other ABIs: optional
    compile 'tv.danmaku.ijk.media:ijkplayer-armv5:0.8.8'
    compile 'tv.danmaku.ijk.media:ijkplayer-arm64:0.8.8'
    compile 'tv.danmaku.ijk.media:ijkplayer-x86:0.8.8'
    compile 'tv.danmaku.ijk.media:ijkplayer-x86_64:0.8.8'

    # ExoPlayer as IMediaPlayer: optional, experimental
    compile 'tv.danmaku.ijk.media:ijkplayer-exo:0.8.8'
}

My Build Environment

Latest Changes

Features

NOT-ON-PLAN

Before Build

# install homebrew, git, yasm
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install git
brew install yasm

# add these lines to your ~/.bash_profile or ~/.profile
# export ANDROID_SDK=<your sdk path>
# export ANDROID_NDK=<your ndk path>

# on Cygwin (unmaintained)
# install git, make, yasm

cd config
rm module.sh
ln -s module-default.sh module.sh
cd android/contrib
# cd ios
sh compile-ffmpeg.sh clean

cd config
rm module.sh
ln -s module-lite-hevc.sh module.sh
cd android/contrib
# cd ios
sh compile-ffmpeg.sh clean

cd config
rm module.sh
ln -s module-lite.sh module.sh
cd android/contrib
# cd ios
sh compile-ffmpeg.sh clean

# choose [No] to use bash
sudo dpkg-reconfigure dash

Build Android

git clone https://github.com/Bilibili/ijkplayer.git ijkplayer-android
cd ijkplayer-android
git checkout -B latest k0.8.8

./init-android.sh

cd android/contrib
./compile-ffmpeg.sh clean
./compile-ffmpeg.sh all

cd ..
./compile-ijk.sh all

# Android Studio:
#     Open an existing Android Studio project
#     Select android/ijkplayer/ and import
#
#     define ext block in your root build.gradle
#     ext {
#       compileSdkVersion = 23       // depending on your sdk version
#       buildToolsVersion = "23.0.0" // depending on your build tools version
#
#       targetSdkVersion = 23        // depending on your sdk version
#     }
#
# If you want to enable debugging ijkplayer(native modules) on Android Studio 2.2+: (experimental)
#     sh android/patch-debugging-with-lldb.sh armv7a
#     Install Android Studio 2.2(+)
#     Preference -> Android SDK -> SDK Tools
#     Select (LLDB, NDK, Android SDK Build-tools,Cmake) and install
#     Open an existing Android Studio project
#     Select android/ijkplayer
#     Sync Project with Gradle Files
#     Run -> Edit Configurations -> Debugger -> Symbol Directories
#     Add "ijkplayer-armv7a/.externalNativeBuild/ndkBuild/release/obj/local/armeabi-v7a" to Symbol Directories
#     Run -> Debug 'ijkplayer-example'
#     if you want to reverse patches:
#     sh patch-debugging-with-lldb.sh reverse armv7a
#
# Eclipse: (obselete)
#     File -> New -> Project -> Android Project from Existing Code
#     Select android/ and import all project
#     Import appcompat-v7
#     Import preference-v7
#
# Gradle
#     cd ijkplayer
#     gradle

Build iOS

git clone https://github.com/Bilibili/ijkplayer.git ijkplayer-ios
cd ijkplayer-ios
git checkout -B latest k0.8.8

./init-ios.sh

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

# Demo
#     open ios/IJKMediaDemo/IJKMediaDemo.xcodeproj with Xcode
# 
# Import into Your own Application
#     Select your project in Xcode.
#     File -> Add Files to ... -> Select ios/IJKMediaPlayer/IJKMediaPlayer.xcodeproj
#     Select your Application's target.
#     Build Phases -> Target Dependencies -> Select IJKMediaFramework
#     Build Phases -> Link Binary with Libraries -> Add:
#         IJKMediaFramework.framework
#
#         AudioToolbox.framework
#         AVFoundation.framework
#         CoreGraphics.framework
#         CoreMedia.framework
#         CoreVideo.framework
#         libbz2.tbd
#         libz.tbd
#         MediaPlayer.framework
#         MobileCoreServices.framework
#         OpenGLES.framework
#         QuartzCore.framework
#         UIKit.framework
#         VideoToolbox.framework
#
#         ... (Maybe something else, if you get any link error)
#

Support (支持)

License

Copyright (c) 2017 Bilibili
Licensed under LGPLv2.1 or later

ijkplayer required features are based on or derives from projects below:

android/ijkplayer-exo is based on or derives from projects below:

android/example is based on or derives from projects below:

ios/IJKMediaDemo is based on or derives from projects below:

ijkplayer's build scripts are based on or derives from projects below:

Commercial Use

ijkplayer is licensed under LGPLv2.1 or later, so itself is free for commercial use under LGPLv2.1 or later

But ijkplayer is also based on other different projects under various licenses, which I have no idea whether they are compatible to each other or to your product.

IANAL, you should always ask your lawyer for these stuffs before use it in your product.

ijkplayer (bilibili/ijkplayer)

Searching Database…

33.2K ·GitHub
Ijkplayer
What is this?ijkplayer is Bilibili's open-source video player library for Android and iOS, built on FFmpeg (n3.4) and ffplay, with hardware decoding via MediaCodec and VideoToolbox.
Is this a video player app I can install, or a library for my own app?A library you integrate into your own app, not a stand-alone player: on Android it exposes a MediaPlayer-like API, on iOS a MediaPlayer.framework-like one.
How do I get it into my project?On Android you add it with Gradle. iOS prebuilt binaries are listed as 'in coming', so there you build it from source with the bundled scripts first.
What do I need on my machine to build it?The reference setup is a Mac: Android needs the NDK (the author used r10e), Android Studio 2.1.3 and Gradle 2.14.1; iOS needs Xcode (7.3) and HomeBrew.
Does hardware decoding work on every supported version?Only from certain versions up: MediaCodec needs Android 4.1+ (API 16+) and VideoToolbox needs iOS 8+; below those floors you are on FFmpeg software decoding.
Which Android and iOS versions does it actually support?Android API 9~23 on ARMv7a, ARM64v8a and x86 (ARMv5 untested on real devices), and iOS 7.0~10.2.x on armv7, arm64, i386 and x86_64.
Can I use it in a commercial app?ijkplayer itself is LGPLv2.1 or later and free for commercial use, but it builds on projects under various licenses, so the author suggests clearing compatibility with a lawyer. GitHub detects GPL-2.0 for the repo.
Can I fall back to a different player backend?Yes. On Android you can use android.media.MediaPlayer or ExoPlayer as an alternative backend (there is a separate ijkplayer-exo module), and on iOS AVFoundation's AVPlayer; MPMoviePlayerController is obsolete since iOS 8.
Can I make the library smaller?Yes. The default build already removes rarely used FFmpeg components via config/module-lite.sh, and the Before Build section offers variants with more codecs or fewer (optionally keeping HEVC) to trade binary size against format support.
Is anything explicitly off the roadmap?Yes — the NOT-ON-PLAN list: obsolete platforms (Android API-8 and below, iOS pre-6.0), obsolete CPUs (ARMv5, ARMv6, MIPS), native subtitle rendering, and avfilter support.
What are similar projects?vlc, GSYVideoPlayer, mpv, JiaoZiVideoPlayer, xbmc, ExoPlayer, BBLL, android-airplay-server
Which topics is it in?player, lgpl, bilibili, video-player, opengl, android-library, gplv2, ffmpeg, audio, streaming, video, c
Creator
bilibili
Size
8.1 MB
Stars
33.2K
Updated
CommitApr 26
Age
13y
Commits · 90 Days