mdk-sdk

Download latest Nightly Build SDK from sourceforge or github actions

Sourceforge Github Releases NuGet

Changelog. API

Features

• Simple and powerful API set
• Cross platform: Windows(x86, arm), UWP, Linux, macOS, Android, OpenHarmony, iOS, tvOS, visionOS, Raspberry Pi, RockChip
• Hardware accelerated decoders for all platforms
• 0-copy GPU rendering for all platforms and all renderers(Vulkan is WIP.)
• Dynamic OpenGL
• OpenGL, D3D11, D3D12, Vulkan and Metal rendering w/ or w/o user provided context
• Integrated with any platform native ui apps, gui toolkits or other apps via OpenGL, D3D11/12, Vulkan and Metal (WinUI3, OBS, Flutter, Qt, SDL, GLFW, SFML, .NET Avalonia etc.) easily
• HDR display metadata passthrough, HDR <=> SDR tone mapping. You can use HDR display in Qt6(6.6+ for macOS, 6.x for windows), OBS Studio, Android SurfaceView and more.
• Dolby Vision decoding and rendering, including Profile 5, Profile 7 FEL. Support HEVC and AV1.
• HDR gain map support.
• HEVC, VP8/9 transparent videos(alpha channel) support for all decoders and renderers
• Professional codecs: GPU accelerated HAP codec rendering, higher HAP compression ratio and decoding speed, ProRes Raw rendering, Blackmagic RAW, R3D, N-RAW, nvJPEG2000
• Subtitle rendering, including ass, plain text, bitmap, closed caption. Support apple new font formats, android and ohos system fonts
• Seamless/Gapless media and bitrate switch for any media
• Optimized Continuous seeking. As fast as mpv, but much lower cpu, memory and gpu load. Suitable for timeline preview
• Smart FFmpeg runtime, dynamic load, binary compatible with 4.0~9.x

Install

CMake

  include(${MDK_SDK_DIR}/lib/cmake/FindMDK.cmake)
  target_link_libraries(your_target PRIVATE mdk)

Qt qmake

include($$MDK_SDK_DIR/mdk.pri)

CocoaPods

(Objective-)C/C++ Users

pod 'mdk'

Optionally you can use mdk.xcframework directly.

Swift Users

Add swift-mdk via swift package manager, or

pod 'swift-mdk'

and

import swift_mdk

Nuget

Install via NuGet in Visual Studio for both Windows desktop and UWP

OpenHarmony

ohpm install @mediadevkit/libmdk-napi

macOS Hardened Runtime

You may fail to run(or codesign) with default hardened runtime options because there are some dylib files in mdk.framework not signed correctly. You can either select Disable Library Validation in Hardened Runtime options, or sign dylib(RECOMMENDED): In Build Phase, add a New Run Script Phase with content

[ -n "$CODE_SIGN_IDENTITY" ] && find "$BUILT_PRODUCTS_DIR" -depth -path "*mdk.framework/*" -name "lib*.dylib" -exec codesign -f -vvvv -s"${EXPANDED_CODE_SIGN_IDENTITY}" ${OTHER_CODE_SIGN_FLAGS:-} --preserve-metadata=identifier,entitlements,flags {} \;

Distribute

• mdk(libmdk.so.0/ibmdk.dylib/mdk.dll) and ffmpeg library(or standard ffmpeg libraries) are always REQUIRED
• libass.dll/libass.dylib/ass.framework/libass.so can be optional if not using subtitle rendering
• mdk-braw.dll/libmdk-braw.{so,dylib}: optional, for blackmagic raw videos
• mdk-r3d.dll/libmdk-r3d.{so,dylib}: optional, for RED raw and N-RAW videos
• mdk.pdb/libmdk.so*.dsym: debug symbols.
• Add libdav1d.dll/libdav1d.dylib/dav1d.framework/libdav1d.so to support av1 software decoding

Documents

• wiki
• sdk headers

Recommended settings

Since 0.35.0, player.setProperty("video.decoders", GetGlobalOption("video.decoders.hint")) will prefer hardware decoders over software ones, and the following player.setDecoders() is not required.

• macOS, iOS: player.setDecoders(MediaType::Video, {"VT", "hap", "FFmpeg", "dav1d"});
• Windows: player.setDecoders(MediaType::Video, {"MFT:d3d=11", "D3D11", "DXVA", "CUDA", "hap", "FFmpeg", "dav1d"});
• Linux:

    // XInitThreads(); // If using x11. before any x11 api call. some gui toolkits already call this, e.g. qt, glfw
    SetGlobalOption("X11Display", DisplayPtr); // If using x11. Requred by VAAPI, VDPAU
    player.setDecoders(MediaType::Video, {"VAAPI", "VDPAU", "CUDA", "hap", "FFmpeg", "dav1d"});

• Raspberry Pi: use mdk-sdk-linux.tar.xz, delete libffmpeg.so.* to use system ffmpeg to support hardware decoder and use EGL for 0-copy rendering

    player.setDecoders(MediaType::Video, {"V4L2M2M", "FFmpeg:hwcontext=drm", "FFmpeg", "dav1d"});

• RockChip: mdk-sdk-linux.tar.xz contains a rockchip decoder plugin. You can also use ffmpeg's rkmpp decoder: delete libffmpeg.so.* and use upstream ffmpeg or ffmpeg-rockchip with rkmpp enabled. OpenGL ES2/3 0-copy rendering is supported

    SetGlobalOption("gl.ubo", "0"); // optional. required by some buggy drivers
    player.setDecoders(MediaType::Video, {"rockchip", "rkmpp", "FFmpeg", "dav1d"});

• Android:

    SetGlobalOption("JavaVM", JvmPtr); // REQUIRED
    player.setDecoders(MediaType::Video, {"AMediaCodec", "FFmpeg", "dav1d"});

Open Source

Modules and Dependencies

• License generator and validator
• Android java wrapper and example
• MediaFoundation decoder module
• av1 software decoder module
• sunxi decoder + renderer
• GFX surface and render loop
• JNI C++ api
• Android java and jni APIs in C++
• C++ TLS
• C++ compatibility layer
• cmake tools
• Blackmagic RAW
• R3D RAW, N-RAW
• nvJPEG2000
• rockchip

Examples and Plugins for Other Frameworks

• examples for different platforms and gui toolkits
• Swift player and QuickLook plugin for macOS
• obs-studio video source plugin
• as a qtmultimedia plugin

Language Bindings

• Swift binding
• Flutter/Dart
• C#
• OHOS ArkTS

Sponsors

Users

NOTIONTHEORY

!

Q-SYS UCI Viewer Diem easy live tv Kazumi 金嵘达科技 爱玩宝

License

• Free for opensource projects, QtAV donors and contributors: you can acquire a key from me. Can be commercial software
• Free for Flutter users. A key is already included. Can be commercial softwares.
• Free for other non-commercial users: you can acquire a key from me.
• Commercial license for other users: a key for an app for a single platform or multiple platforms.
• Other users without a key: make sure your sdk is updated, otherwise you may see an QR image in the last frame.

License key generator and validator is open source