From f88f73cbd2ce4b5e7d93521080518de38e350a2e Mon Sep 17 00:00:00 2001 From: Roman Laptev Date: Tue, 5 May 2026 21:06:05 +0300 Subject: [PATCH 1/7] Add SPM to media_kit_video --- .../media_kit_libs_ios_audio/ios/.gitignore | 3 + .../ios/media_kit_libs_ios_audio.podspec | 5 +- .../MediaKitLibsIosAudioPlugin.swift | 0 .../PrivacyInfo.xcprivacy | 14 + .../ios/media_kit_libs_ios_audio/pubspec.yaml | 4 +- .../media_kit_libs_ios_video/ios/.gitignore | 3 + .../ios/media_kit_libs_ios_video.podspec | 5 +- .../MediaKitLibsIosVideoPlugin.swift | 0 .../PrivacyInfo.xcprivacy | 14 + .../ios/media_kit_libs_ios_video/pubspec.yaml | 4 +- .../macos/.gitignore | 3 + .../macos/media_kit_libs_macos_audio.podspec | 7 +- .../MediaKitLibsMacosAudioPlugin.swift | 0 .../PrivacyInfo.xcprivacy | 14 + .../media_kit_libs_macos_audio/pubspec.yaml | 4 +- .../macos/.gitignore | 3 + .../macos/media_kit_libs_macos_video.podspec | 7 +- .../MediaKitLibsMacosVideoPlugin.swift | 0 .../PrivacyInfo.xcprivacy | 14 + .../media_kit_libs_macos_video/pubspec.yaml | 4 +- .../darwin/Classes/plugin/MPVHelpers.swift | 7 + .../Classes/plugin/MPVVideoOutParams.swift | 4 + .../plugin/ResizableTextureProtocol.swift | 2 + .../Classes/plugin/SafeResizableTexture.swift | 4 + .../plugin/SwappableObjectManager.swift | 2 + .../darwin/Classes/plugin/TextureSW.swift | 8 + .../Classes/plugin/TextureSWContext.swift | 4 + .../darwin/Classes/plugin/UtilsProtocol.swift | 2 + .../darwin/Classes/plugin/VideoOutput.swift | 3 + .../common/darwin/Classes/plugin/Worker.swift | 2 + media_kit_video/ios/.gitignore | 3 + .../Classes/plugin/common/MPVHelpers.swift | 1 - .../plugin/common/MPVVideoOutParams.swift | 1 - .../plugin/common/MediaKitVideoPlugin.swift | 1 - .../common/ResizableTextureProtocol.swift | 1 - .../plugin/common/SafeResizableTexture.swift | 1 - .../common/SwappableObjectManager.swift | 1 - .../ios/Classes/plugin/common/TextureSW.swift | 1 - .../plugin/common/TextureSWContext.swift | 1 - .../Classes/plugin/common/UtilsProtocol.swift | 1 - .../Classes/plugin/common/VideoOutput.swift | 1 - .../common/VideoOutputConfiguration.swift | 1 - .../plugin/common/VideoOutputManager.swift | 1 - .../ios/Classes/plugin/common/Worker.swift | 1 - .../stub/common/MediaKitVideoPlugin.swift | 1 - media_kit_video/ios/media_kit_video.podspec | 7 +- .../ios/media_kit_video/Package.swift | 33 + .../Sources/Mpv/include/module.modulemap | 7 + .../Sources/Mpv/include/mpv/client.h | 1896 +++++++++++++++++ .../Sources/Mpv/include/mpv/render.h | 738 +++++++ .../Sources/Mpv/include/mpv/render_gl.h | 211 ++ .../Sources/Mpv/include/mpv/stream_cb.h | 240 +++ .../ios/media_kit_video/Sources/Mpv/shim.c | 1 + .../media_kit_video/PrivacyInfo.xcprivacy | 14 + .../media_kit_video}/plugin/TextureHW.swift | 4 + .../plugin/common/MPVHelpers.swift | 1 + .../plugin/common/MPVVideoOutParams.swift | 1 + .../plugin/common/MediaKitVideoPlugin.swift | 1 + .../common/ResizableTextureProtocol.swift | 1 + .../plugin/common/SafeResizableTexture.swift | 1 + .../common/SwappableObjectManager.swift | 1 + .../plugin/common/TextureSW.swift | 1 + .../plugin/common/TextureSWContext.swift | 1 + .../plugin/common/UtilsProtocol.swift | 1 + .../plugin/common/VideoOutput.swift | 1 + .../common/VideoOutputConfiguration.swift | 1 + .../plugin/common/VideoOutputManager.swift | 1 + .../plugin/common/Worker.swift | 1 + .../plugin/gles/OpenGLESHelpers.swift | 0 .../plugin/gles/TextureGLESContext.swift | 3 + .../stub/common/MediaKitVideoPlugin.swift | 1 + media_kit_video/macos/.gitignore | 3 + .../Classes/plugin/common/MPVHelpers.swift | 1 - .../plugin/common/MPVVideoOutParams.swift | 1 - .../plugin/common/MediaKitVideoPlugin.swift | 1 - .../common/ResizableTextureProtocol.swift | 1 - .../plugin/common/SafeResizableTexture.swift | 1 - .../common/SwappableObjectManager.swift | 1 - .../Classes/plugin/common/TextureSW.swift | 1 - .../plugin/common/TextureSWContext.swift | 1 - .../Classes/plugin/common/UtilsProtocol.swift | 1 - .../Classes/plugin/common/VideoOutput.swift | 1 - .../common/VideoOutputConfiguration.swift | 1 - .../plugin/common/VideoOutputManager.swift | 1 - .../macos/Classes/plugin/common/Worker.swift | 1 - .../stub/common/MediaKitVideoPlugin.swift | 1 - media_kit_video/macos/media_kit_video.podspec | 9 +- .../macos/media_kit_video/Package.swift | 33 + .../Sources/Mpv/include/module.modulemap | 7 + .../Sources/Mpv/include/mpv/client.h | 1896 +++++++++++++++++ .../Sources/Mpv/include/mpv/render.h | 738 +++++++ .../Sources/Mpv/include/mpv/render_gl.h | 211 ++ .../Sources/Mpv/include/mpv/stream_cb.h | 240 +++ .../macos/media_kit_video/Sources/Mpv/shim.c | 1 + .../media_kit_video/PrivacyInfo.xcprivacy | 14 + .../media_kit_video}/plugin/TextureHW.swift | 4 + .../media_kit_video}/plugin/Utils.swift | 0 .../plugin/common/MPVHelpers.swift | 1 + .../plugin/common/MPVVideoOutParams.swift | 1 + .../plugin/common/MediaKitVideoPlugin.swift | 1 + .../common/ResizableTextureProtocol.swift | 1 + .../plugin/common/SafeResizableTexture.swift | 1 + .../common/SwappableObjectManager.swift | 1 + .../plugin/common/TextureSW.swift | 1 + .../plugin/common/TextureSWContext.swift | 1 + .../plugin/common/UtilsProtocol.swift | 1 + .../plugin/common/VideoOutput.swift | 1 + .../common/VideoOutputConfiguration.swift | 1 + .../plugin/common/VideoOutputManager.swift | 1 + .../plugin/common/Worker.swift | 1 + .../plugin/gl/OpenGLHelpers.swift | 0 .../plugin/gl/TextureGLContext.swift | 4 + .../stub/common/MediaKitVideoPlugin.swift | 1 + media_kit_video/pubspec.yaml | 4 +- 114 files changed, 6474 insertions(+), 49 deletions(-) rename libs/ios/media_kit_libs_ios_audio/ios/{Classes => media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio}/MediaKitLibsIosAudioPlugin.swift (100%) create mode 100644 libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/PrivacyInfo.xcprivacy rename libs/ios/media_kit_libs_ios_video/ios/{Classes => media_kit_libs_ios_video/Sources/media_kit_libs_ios_video}/MediaKitLibsIosVideoPlugin.swift (100%) create mode 100644 libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/PrivacyInfo.xcprivacy rename libs/macos/media_kit_libs_macos_audio/macos/{Classes => media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio}/MediaKitLibsMacosAudioPlugin.swift (100%) create mode 100644 libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/PrivacyInfo.xcprivacy rename libs/macos/media_kit_libs_macos_video/macos/{Classes => media_kit_libs_macos_video/Sources/media_kit_libs_macos_video}/MediaKitLibsMacosVideoPlugin.swift (100%) create mode 100644 libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/PrivacyInfo.xcprivacy delete mode 120000 media_kit_video/ios/Classes/plugin/common/MPVHelpers.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/MPVVideoOutParams.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/MediaKitVideoPlugin.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/ResizableTextureProtocol.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/SafeResizableTexture.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/SwappableObjectManager.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/TextureSW.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/TextureSWContext.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/UtilsProtocol.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/VideoOutput.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/VideoOutputConfiguration.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/VideoOutputManager.swift delete mode 120000 media_kit_video/ios/Classes/plugin/common/Worker.swift delete mode 120000 media_kit_video/ios/Classes/stub/common/MediaKitVideoPlugin.swift create mode 100644 media_kit_video/ios/media_kit_video/Package.swift create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h create mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c create mode 100644 media_kit_video/ios/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy rename media_kit_video/ios/{Classes => media_kit_video/Sources/media_kit_video}/plugin/TextureHW.swift (99%) create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift rename media_kit_video/ios/{Classes => media_kit_video/Sources/media_kit_video}/plugin/gles/OpenGLESHelpers.swift (100%) rename media_kit_video/ios/{Classes => media_kit_video/Sources/media_kit_video}/plugin/gles/TextureGLESContext.swift (98%) create mode 120000 media_kit_video/ios/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/MPVHelpers.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/MPVVideoOutParams.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/MediaKitVideoPlugin.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/ResizableTextureProtocol.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/SafeResizableTexture.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/SwappableObjectManager.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/TextureSW.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/TextureSWContext.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/UtilsProtocol.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/VideoOutput.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/VideoOutputConfiguration.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/VideoOutputManager.swift delete mode 120000 media_kit_video/macos/Classes/plugin/common/Worker.swift delete mode 120000 media_kit_video/macos/Classes/stub/common/MediaKitVideoPlugin.swift create mode 100644 media_kit_video/macos/media_kit_video/Package.swift create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h create mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c create mode 100644 media_kit_video/macos/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy rename media_kit_video/macos/{Classes => media_kit_video/Sources/media_kit_video}/plugin/TextureHW.swift (99%) rename media_kit_video/macos/{Classes => media_kit_video/Sources/media_kit_video}/plugin/Utils.swift (100%) create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift rename media_kit_video/macos/{Classes => media_kit_video/Sources/media_kit_video}/plugin/gl/OpenGLHelpers.swift (100%) rename media_kit_video/macos/{Classes => media_kit_video/Sources/media_kit_video}/plugin/gl/TextureGLContext.swift (95%) create mode 120000 media_kit_video/macos/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift diff --git a/libs/ios/media_kit_libs_ios_audio/ios/.gitignore b/libs/ios/media_kit_libs_ios_audio/ios/.gitignore index 791fcbb1d..55bb48baa 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/.gitignore +++ b/libs/ios/media_kit_libs_ios_audio/ios/.gitignore @@ -1,2 +1,5 @@ .cache Frameworks +.build +.swiftpm +Package.resolved diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec index 932c5a3e3..79ddd868b 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec @@ -16,8 +16,11 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.source_files = 'Classes/**/*' + s.source_files = 'media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/**/*.swift' s.dependency 'Flutter' + s.resource_bundles = { + 'media_kit_libs_ios_audio_privacy' => ['media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/PrivacyInfo.xcprivacy'] + } s.vendored_frameworks = 'Frameworks/*.xcframework' diff --git a/libs/ios/media_kit_libs_ios_audio/ios/Classes/MediaKitLibsIosAudioPlugin.swift b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/MediaKitLibsIosAudioPlugin.swift similarity index 100% rename from libs/ios/media_kit_libs_ios_audio/ios/Classes/MediaKitLibsIosAudioPlugin.swift rename to libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/MediaKitLibsIosAudioPlugin.swift diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/PrivacyInfo.xcprivacy b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Sources/media_kit_libs_ios_audio/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml index a23fda9ee..c5dcb6a00 100644 --- a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ">=2.17.0 <4.0.0" - flutter: ">=3.0.0" + sdk: ^3.5.0 + flutter: ">=3.24.0" dependencies: flutter: diff --git a/libs/ios/media_kit_libs_ios_video/ios/.gitignore b/libs/ios/media_kit_libs_ios_video/ios/.gitignore index 791fcbb1d..55bb48baa 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/.gitignore +++ b/libs/ios/media_kit_libs_ios_video/ios/.gitignore @@ -1,2 +1,5 @@ .cache Frameworks +.build +.swiftpm +Package.resolved diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec index d3ea2ad12..74a1dfd25 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec @@ -16,8 +16,11 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.source_files = 'Classes/**/*' + s.source_files = 'media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/**/*.swift' s.dependency 'Flutter' + s.resource_bundles = { + 'media_kit_libs_ios_video_privacy' => ['media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/PrivacyInfo.xcprivacy'] + } s.vendored_frameworks = 'Frameworks/*.xcframework' diff --git a/libs/ios/media_kit_libs_ios_video/ios/Classes/MediaKitLibsIosVideoPlugin.swift b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/MediaKitLibsIosVideoPlugin.swift similarity index 100% rename from libs/ios/media_kit_libs_ios_video/ios/Classes/MediaKitLibsIosVideoPlugin.swift rename to libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/MediaKitLibsIosVideoPlugin.swift diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/PrivacyInfo.xcprivacy b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Sources/media_kit_libs_ios_video/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/libs/ios/media_kit_libs_ios_video/pubspec.yaml b/libs/ios/media_kit_libs_ios_video/pubspec.yaml index 905f8f95f..45fcdb510 100644 --- a/libs/ios/media_kit_libs_ios_video/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ">=2.17.0 <4.0.0" - flutter: ">=3.0.0" + sdk: ^3.5.0 + flutter: ">=3.24.0" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_audio/macos/.gitignore b/libs/macos/media_kit_libs_macos_audio/macos/.gitignore index 791fcbb1d..55bb48baa 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/.gitignore +++ b/libs/macos/media_kit_libs_macos_audio/macos/.gitignore @@ -1,2 +1,5 @@ .cache Frameworks +.build +.swiftpm +Package.resolved diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec index 539ac1e89..0a8cc00d4 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec @@ -16,12 +16,15 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.source_files = 'Classes/**/*' + s.source_files = 'media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/**/*.swift' s.dependency 'FlutterMacOS' + s.resource_bundles = { + 'media_kit_libs_macos_audio_privacy' => ['media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/PrivacyInfo.xcprivacy'] + } s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :osx, '10.9' + s.platform = :osx, '10.15' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } s.swift_version = '5.0' end diff --git a/libs/macos/media_kit_libs_macos_audio/macos/Classes/MediaKitLibsMacosAudioPlugin.swift b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/MediaKitLibsMacosAudioPlugin.swift similarity index 100% rename from libs/macos/media_kit_libs_macos_audio/macos/Classes/MediaKitLibsMacosAudioPlugin.swift rename to libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/MediaKitLibsMacosAudioPlugin.swift diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/PrivacyInfo.xcprivacy b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Sources/media_kit_libs_macos_audio/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml index 93972d8db..aa642e250 100644 --- a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ">=2.17.0 <4.0.0" - flutter: ">=3.0.0" + sdk: ^3.5.0 + flutter: ">=3.24.0" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_video/macos/.gitignore b/libs/macos/media_kit_libs_macos_video/macos/.gitignore index 791fcbb1d..55bb48baa 100644 --- a/libs/macos/media_kit_libs_macos_video/macos/.gitignore +++ b/libs/macos/media_kit_libs_macos_video/macos/.gitignore @@ -1,2 +1,5 @@ .cache Frameworks +.build +.swiftpm +Package.resolved diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec index 270cca5a7..88e264dbc 100644 --- a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec @@ -16,12 +16,15 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.source_files = 'Classes/**/*' + s.source_files = 'media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/**/*.swift' s.dependency 'FlutterMacOS' + s.resource_bundles = { + 'media_kit_libs_macos_video_privacy' => ['media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/PrivacyInfo.xcprivacy'] + } s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :osx, '10.9' + s.platform = :osx, '10.15' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } s.swift_version = '5.0' end diff --git a/libs/macos/media_kit_libs_macos_video/macos/Classes/MediaKitLibsMacosVideoPlugin.swift b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/MediaKitLibsMacosVideoPlugin.swift similarity index 100% rename from libs/macos/media_kit_libs_macos_video/macos/Classes/MediaKitLibsMacosVideoPlugin.swift rename to libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/MediaKitLibsMacosVideoPlugin.swift diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/PrivacyInfo.xcprivacy b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Sources/media_kit_libs_macos_video/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/libs/macos/media_kit_libs_macos_video/pubspec.yaml b/libs/macos/media_kit_libs_macos_video/pubspec.yaml index 93598472a..fd3a52337 100644 --- a/libs/macos/media_kit_libs_macos_video/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ">=2.17.0 <4.0.0" - flutter: ">=3.0.0" + sdk: ^3.5.0 + flutter: ">=3.24.0" dependencies: flutter: diff --git a/media_kit_video/common/darwin/Classes/plugin/MPVHelpers.swift b/media_kit_video/common/darwin/Classes/plugin/MPVHelpers.swift index 26b6d18ec..35b073803 100644 --- a/media_kit_video/common/darwin/Classes/plugin/MPVHelpers.swift +++ b/media_kit_video/common/darwin/Classes/plugin/MPVHelpers.swift @@ -1,3 +1,10 @@ +import Darwin +import Foundation + +#if SWIFT_PACKAGE + import Mpv +#endif + public enum MPVHelpers { public static func checkError(_ status: CInt) { if status < 0 { diff --git a/media_kit_video/common/darwin/Classes/plugin/MPVVideoOutParams.swift b/media_kit_video/common/darwin/Classes/plugin/MPVVideoOutParams.swift index 160ea5792..8b02dd195 100644 --- a/media_kit_video/common/darwin/Classes/plugin/MPVVideoOutParams.swift +++ b/media_kit_video/common/darwin/Classes/plugin/MPVVideoOutParams.swift @@ -1,3 +1,7 @@ +#if SWIFT_PACKAGE + import Mpv +#endif + public class MPVVideoOutParams { public let dw: Int64 public let dh: Int64 diff --git a/media_kit_video/common/darwin/Classes/plugin/ResizableTextureProtocol.swift b/media_kit_video/common/darwin/Classes/plugin/ResizableTextureProtocol.swift index eae5f7c72..531f014af 100644 --- a/media_kit_video/common/darwin/Classes/plugin/ResizableTextureProtocol.swift +++ b/media_kit_video/common/darwin/Classes/plugin/ResizableTextureProtocol.swift @@ -1,3 +1,5 @@ +import CoreGraphics + #if canImport(Flutter) import Flutter #elseif canImport(FlutterMacOS) diff --git a/media_kit_video/common/darwin/Classes/plugin/SafeResizableTexture.swift b/media_kit_video/common/darwin/Classes/plugin/SafeResizableTexture.swift index 58fc4bfc7..5fdc915ec 100644 --- a/media_kit_video/common/darwin/Classes/plugin/SafeResizableTexture.swift +++ b/media_kit_video/common/darwin/Classes/plugin/SafeResizableTexture.swift @@ -1,3 +1,7 @@ +import CoreGraphics +import CoreVideo +import Foundation + #if canImport(Flutter) import Flutter #elseif canImport(FlutterMacOS) diff --git a/media_kit_video/common/darwin/Classes/plugin/SwappableObjectManager.swift b/media_kit_video/common/darwin/Classes/plugin/SwappableObjectManager.swift index 2bdb50a16..d1a0e24b7 100644 --- a/media_kit_video/common/darwin/Classes/plugin/SwappableObjectManager.swift +++ b/media_kit_video/common/darwin/Classes/plugin/SwappableObjectManager.swift @@ -1,3 +1,5 @@ +import Foundation + // This class was created to prevent a frameBuffer read by Flutter from being // concurrently modified by a write method (mpv's renderer). // diff --git a/media_kit_video/common/darwin/Classes/plugin/TextureSW.swift b/media_kit_video/common/darwin/Classes/plugin/TextureSW.swift index 7745f3101..a711f62af 100644 --- a/media_kit_video/common/darwin/Classes/plugin/TextureSW.swift +++ b/media_kit_video/common/darwin/Classes/plugin/TextureSW.swift @@ -1,3 +1,11 @@ +import CoreGraphics +import CoreVideo +import Foundation + +#if SWIFT_PACKAGE + import Mpv +#endif + #if canImport(Flutter) import Flutter #elseif canImport(FlutterMacOS) diff --git a/media_kit_video/common/darwin/Classes/plugin/TextureSWContext.swift b/media_kit_video/common/darwin/Classes/plugin/TextureSWContext.swift index db329c411..5405f094e 100644 --- a/media_kit_video/common/darwin/Classes/plugin/TextureSWContext.swift +++ b/media_kit_video/common/darwin/Classes/plugin/TextureSWContext.swift @@ -1,3 +1,7 @@ +import CoreGraphics +import CoreVideo +import Foundation + public class TextureSWContext { public let pixelBuffer: CVPixelBuffer diff --git a/media_kit_video/common/darwin/Classes/plugin/UtilsProtocol.swift b/media_kit_video/common/darwin/Classes/plugin/UtilsProtocol.swift index 6d6fda1a6..e76a02764 100644 --- a/media_kit_video/common/darwin/Classes/plugin/UtilsProtocol.swift +++ b/media_kit_video/common/darwin/Classes/plugin/UtilsProtocol.swift @@ -1,3 +1,5 @@ +import Foundation + public protocol UtilsProtocol: NSObject { func enterNativeFullscreen() func exitNativeFullscreen() diff --git a/media_kit_video/common/darwin/Classes/plugin/VideoOutput.swift b/media_kit_video/common/darwin/Classes/plugin/VideoOutput.swift index 9441c7e37..a377f2794 100644 --- a/media_kit_video/common/darwin/Classes/plugin/VideoOutput.swift +++ b/media_kit_video/common/darwin/Classes/plugin/VideoOutput.swift @@ -1,3 +1,6 @@ +import CoreGraphics +import Foundation + #if canImport(Flutter) import Flutter #elseif canImport(FlutterMacOS) diff --git a/media_kit_video/common/darwin/Classes/plugin/Worker.swift b/media_kit_video/common/darwin/Classes/plugin/Worker.swift index dbb2c0b7c..7510fda6b 100644 --- a/media_kit_video/common/darwin/Classes/plugin/Worker.swift +++ b/media_kit_video/common/darwin/Classes/plugin/Worker.swift @@ -1,3 +1,5 @@ +import Foundation + // https://stackoverflow.com/questions/49043257/how-to-ensure-to-run-some-code-on-same-background-thread/49075382#49075382 class Worker { public typealias Job = () -> Void diff --git a/media_kit_video/ios/.gitignore b/media_kit_video/ios/.gitignore index 05dd1fe0c..6b52dcb68 100644 --- a/media_kit_video/ios/.gitignore +++ b/media_kit_video/ios/.gitignore @@ -1 +1,4 @@ Headers +.build +.swiftpm +Package.resolved diff --git a/media_kit_video/ios/Classes/plugin/common/MPVHelpers.swift b/media_kit_video/ios/Classes/plugin/common/MPVHelpers.swift deleted file mode 120000 index 227135ca5..000000000 --- a/media_kit_video/ios/Classes/plugin/common/MPVHelpers.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MPVHelpers.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/MPVVideoOutParams.swift b/media_kit_video/ios/Classes/plugin/common/MPVVideoOutParams.swift deleted file mode 120000 index 86edcf4c5..000000000 --- a/media_kit_video/ios/Classes/plugin/common/MPVVideoOutParams.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MPVVideoOutParams.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/MediaKitVideoPlugin.swift b/media_kit_video/ios/Classes/plugin/common/MediaKitVideoPlugin.swift deleted file mode 120000 index 28b20891a..000000000 --- a/media_kit_video/ios/Classes/plugin/common/MediaKitVideoPlugin.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/ResizableTextureProtocol.swift b/media_kit_video/ios/Classes/plugin/common/ResizableTextureProtocol.swift deleted file mode 120000 index 5f582e365..000000000 --- a/media_kit_video/ios/Classes/plugin/common/ResizableTextureProtocol.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/ResizableTextureProtocol.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/SafeResizableTexture.swift b/media_kit_video/ios/Classes/plugin/common/SafeResizableTexture.swift deleted file mode 120000 index cb7753279..000000000 --- a/media_kit_video/ios/Classes/plugin/common/SafeResizableTexture.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/SafeResizableTexture.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/SwappableObjectManager.swift b/media_kit_video/ios/Classes/plugin/common/SwappableObjectManager.swift deleted file mode 120000 index e5dc8c841..000000000 --- a/media_kit_video/ios/Classes/plugin/common/SwappableObjectManager.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/SwappableObjectManager.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/TextureSW.swift b/media_kit_video/ios/Classes/plugin/common/TextureSW.swift deleted file mode 120000 index 6ababc7cf..000000000 --- a/media_kit_video/ios/Classes/plugin/common/TextureSW.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/TextureSW.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/TextureSWContext.swift b/media_kit_video/ios/Classes/plugin/common/TextureSWContext.swift deleted file mode 120000 index 6d7183e0a..000000000 --- a/media_kit_video/ios/Classes/plugin/common/TextureSWContext.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/TextureSWContext.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/UtilsProtocol.swift b/media_kit_video/ios/Classes/plugin/common/UtilsProtocol.swift deleted file mode 120000 index c0b658dff..000000000 --- a/media_kit_video/ios/Classes/plugin/common/UtilsProtocol.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/UtilsProtocol.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/VideoOutput.swift b/media_kit_video/ios/Classes/plugin/common/VideoOutput.swift deleted file mode 120000 index 78c7f1d78..000000000 --- a/media_kit_video/ios/Classes/plugin/common/VideoOutput.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutput.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/VideoOutputConfiguration.swift b/media_kit_video/ios/Classes/plugin/common/VideoOutputConfiguration.swift deleted file mode 120000 index 4d3b4d907..000000000 --- a/media_kit_video/ios/Classes/plugin/common/VideoOutputConfiguration.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutputConfiguration.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/VideoOutputManager.swift b/media_kit_video/ios/Classes/plugin/common/VideoOutputManager.swift deleted file mode 120000 index 52289a9c2..000000000 --- a/media_kit_video/ios/Classes/plugin/common/VideoOutputManager.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutputManager.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/common/Worker.swift b/media_kit_video/ios/Classes/plugin/common/Worker.swift deleted file mode 120000 index bf3a22856..000000000 --- a/media_kit_video/ios/Classes/plugin/common/Worker.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/Worker.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/stub/common/MediaKitVideoPlugin.swift b/media_kit_video/ios/Classes/stub/common/MediaKitVideoPlugin.swift deleted file mode 120000 index 38cd66192..000000000 --- a/media_kit_video/ios/Classes/stub/common/MediaKitVideoPlugin.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/stub/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video.podspec b/media_kit_video/ios/media_kit_video.podspec index 81b6e0719..1679528a6 100644 --- a/media_kit_video/ios/media_kit_video.podspec +++ b/media_kit_video/ios/media_kit_video.podspec @@ -26,13 +26,16 @@ Pod::Spec.new do |s| s.platform = :ios, '9.0' s.swift_version = '5.0' s.dependency 'Flutter' + s.resource_bundles = { + 'media_kit_video_privacy' => ['media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy'] + } if mku.libs_found # Define paths to frameworks dir framework_search_paths_iphoneos = sprintf('$(PROJECT_DIR)/../.symlinks/plugins/%s/ios/Frameworks/.symlinks/mpv/ios', mku.libs_package) framework_search_paths_iphonesimulator = sprintf('$(PROJECT_DIR)/../.symlinks/plugins/%s/ios/Frameworks/.symlinks/mpv/ios-simulator', mku.libs_package) - s.source_files = 'Classes/plugin/**/*.swift', 'Headers/**/*.h' + s.source_files = 'media_kit_video/Sources/media_kit_video/plugin/**/*.swift', 'Headers/**/*.h' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'GCC_WARN_INHIBIT_ALL_WARNINGS' => 'YES', @@ -44,7 +47,7 @@ Pod::Spec.new do |s| 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386', } else - s.source_files = 'Classes/stub/**/*.swift' + s.source_files = 'media_kit_video/Sources/media_kit_video/stub/**/*.swift' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } end end diff --git a/media_kit_video/ios/media_kit_video/Package.swift b/media_kit_video/ios/media_kit_video/Package.swift new file mode 100644 index 000000000..484c6feed --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Package.swift @@ -0,0 +1,33 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let package = Package( + name: "media_kit_video", + platforms: [ + .iOS("13.0") + ], + products: [ + .library(name: "media-kit-video", targets: ["media_kit_video"]) + ], + dependencies: [], + targets: [ + .target( + name: "Mpv", + path: "Sources/Mpv", + sources: ["shim.c"], + publicHeadersPath: "include" + ), + .target( + name: "media_kit_video", + dependencies: [ + .target(name: "Mpv") + ], + sources: ["plugin"], + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap new file mode 100644 index 000000000..7226723bb --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap @@ -0,0 +1,7 @@ +module Mpv { + header "mpv/client.h" + header "mpv/render.h" + header "mpv/render_gl.h" + header "mpv/stream_cb.h" + export * +} diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h new file mode 100644 index 000000000..b9697eb74 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h @@ -0,0 +1,1896 @@ +/* Copyright (C) 2017 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +/* + * Note: the client API is licensed under ISC (see above) to enable + * other wrappers outside of mpv. But keep in mind that the + * mpv core is by default still GPLv2+ - unless built with + * --enable-lgpl, which makes it LGPLv2+. + */ + +#ifndef MPV_CLIENT_API_H_ +#define MPV_CLIENT_API_H_ + +#include +#include + +/* New symbols must still be added to libmpv/mpv.def. */ +#ifdef _WIN32 +#define MPV_EXPORT __declspec(dllexport) +#elif defined(__GNUC__) || defined(__clang__) +#define MPV_EXPORT __attribute__((visibility("default"))) +#else +#define MPV_EXPORT +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Mechanisms provided by this API + * ------------------------------- + * + * This API provides general control over mpv playback. It does not give you + * direct access to individual components of the player, only the whole thing. + * It's somewhat equivalent to MPlayer's slave mode. You can send commands, + * retrieve or set playback status or settings with properties, and receive + * events. + * + * The API can be used in two ways: + * 1) Internally in mpv, to provide additional features to the command line + * player. Lua scripting uses this. (Currently there is no plugin API to + * get a client API handle in external user code. It has to be a fixed + * part of the player at compilation time.) + * 2) Using mpv as a library with mpv_create(). This basically allows embedding + * mpv in other applications. + * + * Documentation + * ------------- + * + * The libmpv C API is documented directly in this header. Note that most + * actual interaction with this player is done through + * options/commands/properties, which can be accessed through this API. + * Essentially everything is done with them, including loading a file, + * retrieving playback progress, and so on. + * + * These are documented elsewhere: + * * http://mpv.io/manual/master/#options + * * http://mpv.io/manual/master/#list-of-input-commands + * * http://mpv.io/manual/master/#properties + * + * You can also look at the examples here: + * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv + * + * Event loop + * ---------- + * + * In general, the API user should run an event loop in order to receive events. + * This event loop should call mpv_wait_event(), which will return once a new + * mpv client API is available. It is also possible to integrate client API + * usage in other event loops (e.g. GUI toolkits) with the + * mpv_set_wakeup_callback() function, and then polling for events by calling + * mpv_wait_event() with a 0 timeout. + * + * Note that the event loop is detached from the actual player. Not calling + * mpv_wait_event() will not stop playback. It will eventually congest the + * event queue of your API handle, though. + * + * Synchronous vs. asynchronous calls + * ---------------------------------- + * + * The API allows both synchronous and asynchronous calls. Synchronous calls + * have to wait until the playback core is ready, which currently can take + * an unbounded time (e.g. if network is slow or unresponsive). Asynchronous + * calls just queue operations as requests, and return the result of the + * operation as events. + * + * Asynchronous calls + * ------------------ + * + * The client API includes asynchronous functions. These allow you to send + * requests instantly, and get replies as events at a later point. The + * requests are made with functions carrying the _async suffix, and replies + * are returned by mpv_wait_event() (interleaved with the normal event stream). + * + * A 64 bit userdata value is used to allow the user to associate requests + * with replies. The value is passed as reply_userdata parameter to the request + * function. The reply to the request will have the reply + * mpv_event->reply_userdata field set to the same value as the + * reply_userdata parameter of the corresponding request. + * + * This userdata value is arbitrary and is never interpreted by the API. Note + * that the userdata value 0 is also allowed, but then the client must be + * careful not accidentally interpret the mpv_event->reply_userdata if an + * event is not a reply. (For non-replies, this field is set to 0.) + * + * Asynchronous calls may be reordered in arbitrarily with other synchronous + * and asynchronous calls. If you want a guaranteed order, you need to wait + * until asynchronous calls report completion before doing the next call. + * + * See also the section "Asynchronous command details" in the manpage. + * + * Multithreading + * -------------- + * + * The client API is generally fully thread-safe, unless otherwise noted. + * Currently, there is no real advantage in using more than 1 thread to access + * the client API, since everything is serialized through a single lock in the + * playback core. + * + * Basic environment requirements + * ------------------------------ + * + * This documents basic requirements on the C environment. This is especially + * important if mpv is used as library with mpv_create(). + * + * - The LC_NUMERIC locale category must be set to "C". If your program calls + * setlocale(), be sure not to use LC_ALL, or if you do, reset LC_NUMERIC + * to its sane default: setlocale(LC_NUMERIC, "C"). + * - If a X11 based VO is used, mpv will set the xlib error handler. This error + * handler is process-wide, and there's no proper way to share it with other + * xlib users within the same process. This might confuse GUI toolkits. + * - mpv uses some other libraries that are not library-safe, such as Fribidi + * (used through libass), ALSA, FFmpeg, and possibly more. + * - The FPU precision must be set at least to double precision. + * - On Windows, mpv will call timeBeginPeriod(1). + * - On memory exhaustion, mpv will kill the process. + * - In certain cases, mpv may start sub processes (such as with the ytdl + * wrapper script). + * - Using UNIX IPC (off by default) will override the SIGPIPE signal handler, + * and set it to SIG_IGN. Some invocations of the "subprocess" command will + * also do that. + * - mpv may start sub processes, so overriding SIGCHLD, or waiting on all PIDs + * (such as calling wait()) by the parent process or any other library within + * the process must be avoided. libmpv itself only waits for its own PIDs. + * - If anything in the process registers signal handlers, they must set the + * SA_RESTART flag. Otherwise you WILL get random failures on signals. + * + * Encoding of filenames + * --------------------- + * + * mpv uses UTF-8 everywhere. + * + * On some platforms (like Linux), filenames actually do not have to be UTF-8; + * for this reason libmpv supports non-UTF-8 strings. libmpv uses what the + * kernel uses and does not recode filenames. At least on Linux, passing a + * string to libmpv is like passing a string to the fopen() function. + * + * On Windows, filenames are always UTF-8, libmpv converts between UTF-8 and + * UTF-16 when using win32 API functions. libmpv never uses or accepts + * filenames in the local 8 bit encoding. It does not use fopen() either; + * it uses _wfopen(). + * + * On OS X, filenames and other strings taken/returned by libmpv can have + * inconsistent unicode normalization. This can sometimes lead to problems. + * You have to hope for the best. + * + * Also see the remarks for MPV_FORMAT_STRING. + * + * Embedding the video window + * -------------------------- + * + * Using the render API (in render.h) is recommended. This API requires + * you to create and maintain an OpenGL context, to which you can render + * video using a specific API call. This API does not include keyboard or mouse + * input directly. + * + * There is an older way to embed the native mpv window into your own. You have + * to get the raw window handle, and set it as "wid" option. This works on X11, + * win32, and OSX only. It's much easier to use than the render API, but + * also has various problems. + * + * Also see client API examples and the mpv manpage. There is an extensive + * discussion here: + * https://github.com/mpv-player/mpv-examples/tree/master/libmpv#methods-of-embedding-the-video-window + * + * Compatibility + * ------------- + * + * mpv development doesn't stand still, and changes to mpv internals as well as + * to its interface can cause compatibility issues to client API users. + * + * The API is versioned (see MPV_CLIENT_API_VERSION), and changes to it are + * documented in DOCS/client-api-changes.rst. The C API itself will probably + * remain compatible for a long time, but the functionality exposed by it + * could change more rapidly. For example, it's possible that options are + * renamed, or change the set of allowed values. + * + * Defensive programming should be used to potentially deal with the fact that + * options, commands, and properties could disappear, change their value range, + * or change the underlying datatypes. It might be a good idea to prefer + * MPV_FORMAT_STRING over other types to decouple your code from potential + * mpv changes. + * + * Also see: DOCS/compatibility.rst + * + * Future changes + * -------------- + * + * This are the planned changes that will most likely be done on the next major + * bump of the library: + * + * - remove all symbols that are marked as deprecated + * - reassign enum numerical values to remove gaps + * - disabling all events by default + */ + +/** + * The version is incremented on each API change. The 16 lower bits form the + * minor version number, and the 16 higher bits the major version number. If + * the API becomes incompatible to previous versions, the major version + * number is incremented. This affects only C part, and not properties and + * options. + * + * Every API bump is described in DOCS/client-api-changes.rst + * + * You can use MPV_MAKE_VERSION() and compare the result with integer + * relational operators (<, >, <=, >=). + */ +#define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) +#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(2, 1) + +/** + * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before + * including any libmpv headers. Then deprecated symbols will be excluded + * from the headers. (Of course, deprecated properties and commands and + * other functionality will still work.) + */ +#ifndef MPV_ENABLE_DEPRECATED +#define MPV_ENABLE_DEPRECATED 1 +#endif + +/** + * Return the MPV_CLIENT_API_VERSION the mpv source has been compiled with. + */ +MPV_EXPORT unsigned long mpv_client_api_version(void); + +/** + * Client context used by the client API. Every client has its own private + * handle. + */ +typedef struct mpv_handle mpv_handle; + +/** + * List of error codes than can be returned by API functions. 0 and positive + * return values always mean success, negative values are always errors. + */ +typedef enum mpv_error { + /** + * No error happened (used to signal successful operation). + * Keep in mind that many API functions returning error codes can also + * return positive values, which also indicate success. API users can + * hardcode the fact that ">= 0" means success. + */ + MPV_ERROR_SUCCESS = 0, + /** + * The event ringbuffer is full. This means the client is choked, and can't + * receive any events. This can happen when too many asynchronous requests + * have been made, but not answered. Probably never happens in practice, + * unless the mpv core is frozen for some reason, and the client keeps + * making asynchronous requests. (Bugs in the client API implementation + * could also trigger this, e.g. if events become "lost".) + */ + MPV_ERROR_EVENT_QUEUE_FULL = -1, + /** + * Memory allocation failed. + */ + MPV_ERROR_NOMEM = -2, + /** + * The mpv core wasn't configured and initialized yet. See the notes in + * mpv_create(). + */ + MPV_ERROR_UNINITIALIZED = -3, + /** + * Generic catch-all error if a parameter is set to an invalid or + * unsupported value. This is used if there is no better error code. + */ + MPV_ERROR_INVALID_PARAMETER = -4, + /** + * Trying to set an option that doesn't exist. + */ + MPV_ERROR_OPTION_NOT_FOUND = -5, + /** + * Trying to set an option using an unsupported MPV_FORMAT. + */ + MPV_ERROR_OPTION_FORMAT = -6, + /** + * Setting the option failed. Typically this happens if the provided option + * value could not be parsed. + */ + MPV_ERROR_OPTION_ERROR = -7, + /** + * The accessed property doesn't exist. + */ + MPV_ERROR_PROPERTY_NOT_FOUND = -8, + /** + * Trying to set or get a property using an unsupported MPV_FORMAT. + */ + MPV_ERROR_PROPERTY_FORMAT = -9, + /** + * The property exists, but is not available. This usually happens when the + * associated subsystem is not active, e.g. querying audio parameters while + * audio is disabled. + */ + MPV_ERROR_PROPERTY_UNAVAILABLE = -10, + /** + * Error setting or getting a property. + */ + MPV_ERROR_PROPERTY_ERROR = -11, + /** + * General error when running a command with mpv_command and similar. + */ + MPV_ERROR_COMMAND = -12, + /** + * Generic error on loading (usually used with mpv_event_end_file.error). + */ + MPV_ERROR_LOADING_FAILED = -13, + /** + * Initializing the audio output failed. + */ + MPV_ERROR_AO_INIT_FAILED = -14, + /** + * Initializing the video output failed. + */ + MPV_ERROR_VO_INIT_FAILED = -15, + /** + * There was no audio or video data to play. This also happens if the + * file was recognized, but did not contain any audio or video streams, + * or no streams were selected. + */ + MPV_ERROR_NOTHING_TO_PLAY = -16, + /** + * When trying to load the file, the file format could not be determined, + * or the file was too broken to open it. + */ + MPV_ERROR_UNKNOWN_FORMAT = -17, + /** + * Generic error for signaling that certain system requirements are not + * fulfilled. + */ + MPV_ERROR_UNSUPPORTED = -18, + /** + * The API function which was called is a stub only. + */ + MPV_ERROR_NOT_IMPLEMENTED = -19, + /** + * Unspecified error. + */ + MPV_ERROR_GENERIC = -20 +} mpv_error; + +/** + * Return a string describing the error. For unknown errors, the string + * "unknown error" is returned. + * + * @param error error number, see enum mpv_error + * @return A static string describing the error. The string is completely + * static, i.e. doesn't need to be deallocated, and is valid forever. + */ +MPV_EXPORT const char *mpv_error_string(int error); + +/** + * General function to deallocate memory returned by some of the API functions. + * Call this only if it's explicitly documented as allowed. Calling this on + * mpv memory not owned by the caller will lead to undefined behavior. + * + * @param data A valid pointer returned by the API, or NULL. + */ +MPV_EXPORT void mpv_free(void *data); + +/** + * Return the name of this client handle. Every client has its own unique + * name, which is mostly used for user interface purposes. + * + * @return The client name. The string is read-only and is valid until the + * mpv_handle is destroyed. + */ +MPV_EXPORT const char *mpv_client_name(mpv_handle *ctx); + +/** + * Return the ID of this client handle. Every client has its own unique ID. This + * ID is never reused by the core, even if the mpv_handle at hand gets destroyed + * and new handles get allocated. + * + * IDs are never 0 or negative. + * + * Some mpv APIs (not necessarily all) accept a name in the form "@" in + * addition of the proper mpv_client_name(), where "" is the ID in decimal + * form (e.g. "@123"). For example, the "script-message-to" command takes the + * client name as first argument, but also accepts the client ID formatted in + * this manner. + * + * @return The client ID. + */ +MPV_EXPORT int64_t mpv_client_id(mpv_handle *ctx); + +/** + * Create a new mpv instance and an associated client API handle to control + * the mpv instance. This instance is in a pre-initialized state, + * and needs to be initialized to be actually used with most other API + * functions. + * + * Some API functions will return MPV_ERROR_UNINITIALIZED in the uninitialized + * state. You can call mpv_set_property() (or mpv_set_property_string() and + * other variants, and before mpv 0.21.0 mpv_set_option() etc.) to set initial + * options. After this, call mpv_initialize() to start the player, and then use + * e.g. mpv_command() to start playback of a file. + * + * The point of separating handle creation and actual initialization is that + * you can configure things which can't be changed during runtime. + * + * Unlike the command line player, this will have initial settings suitable + * for embedding in applications. The following settings are different: + * - stdin/stdout/stderr and the terminal will never be accessed. This is + * equivalent to setting the --no-terminal option. + * (Technically, this also suppresses C signal handling.) + * - No config files will be loaded. This is roughly equivalent to using + * --config=no. Since libmpv 1.15, you can actually re-enable this option, + * which will make libmpv load config files during mpv_initialize(). If you + * do this, you are strongly encouraged to set the "config-dir" option too. + * (Otherwise it will load the mpv command line player's config.) + * For example: + * mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config root + * mpv_set_option_string(mpv, "config", "yes"); // enable config loading + * (call mpv_initialize() _after_ this) + * - Idle mode is enabled, which means the playback core will enter idle mode + * if there are no more files to play on the internal playlist, instead of + * exiting. This is equivalent to the --idle option. + * - Disable parts of input handling. + * - Most of the different settings can be viewed with the command line player + * by running "mpv --show-profile=libmpv". + * + * All this assumes that API users want a mpv instance that is strictly + * isolated from the command line player's configuration, user settings, and + * so on. You can re-enable disabled features by setting the appropriate + * options. + * + * The mpv command line parser is not available through this API, but you can + * set individual options with mpv_set_property(). Files for playback must be + * loaded with mpv_command() or others. + * + * Note that you should avoid doing concurrent accesses on the uninitialized + * client handle. (Whether concurrent access is definitely allowed or not has + * yet to be decided.) + * + * @return a new mpv client API handle. Returns NULL on error. Currently, this + * can happen in the following situations: + * - out of memory + * - LC_NUMERIC is not set to "C" (see general remarks) + */ +MPV_EXPORT mpv_handle *mpv_create(void); + +/** + * Initialize an uninitialized mpv instance. If the mpv instance is already + * running, an error is returned. + * + * This function needs to be called to make full use of the client API if the + * client API handle was created with mpv_create(). + * + * Only the following options are required to be set _before_ mpv_initialize(): + * - options which are only read at initialization time: + * - config + * - config-dir + * - input-conf + * - load-scripts + * - script + * - player-operation-mode + * - input-app-events (OSX) + * - all encoding mode options + * + * @return error code + */ +MPV_EXPORT int mpv_initialize(mpv_handle *ctx); + +/** + * Disconnect and destroy the mpv_handle. ctx will be deallocated with this + * API call. + * + * If the last mpv_handle is detached, the core player is destroyed. In + * addition, if there are only weak mpv_handles (such as created by + * mpv_create_weak_client() or internal scripts), these mpv_handles will + * be sent MPV_EVENT_SHUTDOWN. This function may block until these clients + * have responded to the shutdown event, and the core is finally destroyed. + */ +MPV_EXPORT void mpv_destroy(mpv_handle *ctx); + +/** + * Similar to mpv_destroy(), but brings the player and all clients down + * as well, and waits until all of them are destroyed. This function blocks. The + * advantage over mpv_destroy() is that while mpv_destroy() merely + * detaches the client handle from the player, this function quits the player, + * waits until all other clients are destroyed (i.e. all mpv_handles are + * detached), and also waits for the final termination of the player. + * + * Since mpv_destroy() is called somewhere on the way, it's not safe to + * call other functions concurrently on the same context. + * + * Since mpv client API version 1.29: + * The first call on any mpv_handle will block until the core is destroyed. + * This means it will wait until other mpv_handle have been destroyed. If you + * want asynchronous destruction, just run the "quit" command, and then react + * to the MPV_EVENT_SHUTDOWN event. + * If another mpv_handle already called mpv_terminate_destroy(), this call will + * not actually block. It will destroy the mpv_handle, and exit immediately, + * while other mpv_handles might still be uninitializing. + * + * Before mpv client API version 1.29: + * If this is called on a mpv_handle that was not created with mpv_create(), + * this function will merely send a quit command and then call + * mpv_destroy(), without waiting for the actual shutdown. + */ +MPV_EXPORT void mpv_terminate_destroy(mpv_handle *ctx); + +/** + * Create a new client handle connected to the same player core as ctx. This + * context has its own event queue, its own mpv_request_event() state, its own + * mpv_request_log_messages() state, its own set of observed properties, and + * its own state for asynchronous operations. Otherwise, everything is shared. + * + * This handle should be destroyed with mpv_destroy() if no longer + * needed. The core will live as long as there is at least 1 handle referencing + * it. Any handle can make the core quit, which will result in every handle + * receiving MPV_EVENT_SHUTDOWN. + * + * This function can not be called before the main handle was initialized with + * mpv_initialize(). The new handle is always initialized, unless ctx=NULL was + * passed. + * + * @param ctx Used to get the reference to the mpv core; handle-specific + * settings and parameters are not used. + * If NULL, this function behaves like mpv_create() (ignores name). + * @param name The client name. This will be returned by mpv_client_name(). If + * the name is already in use, or contains non-alphanumeric + * characters (other than '_'), the name is modified to fit. + * If NULL, an arbitrary name is automatically chosen. + * @return a new handle, or NULL on error + */ +MPV_EXPORT mpv_handle *mpv_create_client(mpv_handle *ctx, const char *name); + +/** + * This is the same as mpv_create_client(), but the created mpv_handle is + * treated as a weak reference. If all mpv_handles referencing a core are + * weak references, the core is automatically destroyed. (This still goes + * through normal uninit of course. Effectively, if the last non-weak mpv_handle + * is destroyed, then the weak mpv_handles receive MPV_EVENT_SHUTDOWN and are + * asked to terminate as well.) + * + * Note if you want to use this like refcounting: you have to be aware that + * mpv_terminate_destroy() _and_ mpv_destroy() for the last non-weak + * mpv_handle will block until all weak mpv_handles are destroyed. + */ +MPV_EXPORT mpv_handle *mpv_create_weak_client(mpv_handle *ctx, const char *name); + +/** + * Load a config file. This loads and parses the file, and sets every entry in + * the config file's default section as if mpv_set_option_string() is called. + * + * The filename should be an absolute path. If it isn't, the actual path used + * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the + * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. + * + * If a fatal error happens when parsing a config file, MPV_ERROR_OPTION_ERROR + * is returned. Errors when setting options as well as other types or errors + * are ignored (even if options do not exist). You can still try to capture + * the resulting error messages with mpv_request_log_messages(). Note that it's + * possible that some options were successfully set even if any of these errors + * happen. + * + * @param filename absolute path to the config file on the local filesystem + * @return error code + */ +MPV_EXPORT int mpv_load_config_file(mpv_handle *ctx, const char *filename); + +/** + * Return the internal time in microseconds. This has an arbitrary start offset, + * but will never wrap or go backwards. + * + * Note that this is always the real time, and doesn't necessarily have to do + * with playback time. For example, playback could go faster or slower due to + * playback speed, or due to playback being paused. Use the "time-pos" property + * instead to get the playback status. + * + * Unlike other libmpv APIs, this can be called at absolutely any time (even + * within wakeup callbacks), as long as the context is valid. + * + * Safe to be called from mpv render API threads. + */ +MPV_EXPORT int64_t mpv_get_time_us(mpv_handle *ctx); + +/** + * Data format for options and properties. The API functions to get/set + * properties and options support multiple formats, and this enum describes + * them. + */ +typedef enum mpv_format { + /** + * Invalid. Sometimes used for empty values. This is always defined to 0, + * so a normal 0-init of mpv_format (or e.g. mpv_node) is guaranteed to set + * this it to MPV_FORMAT_NONE (which makes some things saner as consequence). + */ + MPV_FORMAT_NONE = 0, + /** + * The basic type is char*. It returns the raw property string, like + * using ${=property} in input.conf (see input.rst). + * + * NULL isn't an allowed value. + * + * Warning: although the encoding is usually UTF-8, this is not always the + * case. File tags often store strings in some legacy codepage, + * and even filenames don't necessarily have to be in UTF-8 (at + * least on Linux). If you pass the strings to code that requires + * valid UTF-8, you have to sanitize it in some way. + * On Windows, filenames are always UTF-8, and libmpv converts + * between UTF-8 and UTF-16 when using win32 API functions. See + * the "Encoding of filenames" section for details. + * + * Example for reading: + * + * char *result = NULL; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_STRING, &result) < 0) + * goto error; + * printf("%s\n", result); + * mpv_free(result); + * + * Or just use mpv_get_property_string(). + * + * Example for writing: + * + * char *value = "the new value"; + * // yep, you pass the address to the variable + * // (needed for symmetry with other types and mpv_get_property) + * mpv_set_property(ctx, "property", MPV_FORMAT_STRING, &value); + * + * Or just use mpv_set_property_string(). + * + */ + MPV_FORMAT_STRING = 1, + /** + * The basic type is char*. It returns the OSD property string, like + * using ${property} in input.conf (see input.rst). In many cases, this + * is the same as the raw string, but in other cases it's formatted for + * display on OSD. It's intended to be human readable. Do not attempt to + * parse these strings. + * + * Only valid when doing read access. The rest works like MPV_FORMAT_STRING. + */ + MPV_FORMAT_OSD_STRING = 2, + /** + * The basic type is int. The only allowed values are 0 ("no") + * and 1 ("yes"). + * + * Example for reading: + * + * int result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_FLAG, &result) < 0) + * goto error; + * printf("%s\n", result ? "true" : "false"); + * + * Example for writing: + * + * int flag = 1; + * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); + */ + MPV_FORMAT_FLAG = 3, + /** + * The basic type is int64_t. + */ + MPV_FORMAT_INT64 = 4, + /** + * The basic type is double. + */ + MPV_FORMAT_DOUBLE = 5, + /** + * The type is mpv_node. + * + * For reading, you usually would pass a pointer to a stack-allocated + * mpv_node value to mpv, and when you're done you call + * mpv_free_node_contents(&node). + * You're expected not to write to the data - if you have to, copy it + * first (which you have to do manually). + * + * For writing, you construct your own mpv_node, and pass a pointer to the + * API. The API will never write to your data (and copy it if needed), so + * you're free to use any form of allocation or memory management you like. + * + * Warning: when reading, always check the mpv_node.format member. For + * example, properties might change their type in future versions + * of mpv, or sometimes even during runtime. + * + * Example for reading: + * + * mpv_node result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_NODE, &result) < 0) + * goto error; + * printf("format=%d\n", (int)result.format); + * mpv_free_node_contents(&result). + * + * Example for writing: + * + * mpv_node value; + * value.format = MPV_FORMAT_STRING; + * value.u.string = "hello"; + * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); + */ + MPV_FORMAT_NODE = 6, + /** + * Used with mpv_node only. Can usually not be used directly. + */ + MPV_FORMAT_NODE_ARRAY = 7, + /** + * See MPV_FORMAT_NODE_ARRAY. + */ + MPV_FORMAT_NODE_MAP = 8, + /** + * A raw, untyped byte array. Only used only with mpv_node, and only in + * some very specific situations. (Some commands use it.) + */ + MPV_FORMAT_BYTE_ARRAY = 9 +} mpv_format; + +/** + * Generic data storage. + * + * If mpv writes this struct (e.g. via mpv_get_property()), you must not change + * the data. In some cases (mpv_get_property()), you have to free it with + * mpv_free_node_contents(). If you fill this struct yourself, you're also + * responsible for freeing it, and you must not call mpv_free_node_contents(). + */ +typedef struct mpv_node { + union { + char *string; /** valid if format==MPV_FORMAT_STRING */ + int flag; /** valid if format==MPV_FORMAT_FLAG */ + int64_t int64; /** valid if format==MPV_FORMAT_INT64 */ + double double_; /** valid if format==MPV_FORMAT_DOUBLE */ + /** + * valid if format==MPV_FORMAT_NODE_ARRAY + * or if format==MPV_FORMAT_NODE_MAP + */ + struct mpv_node_list *list; + /** + * valid if format==MPV_FORMAT_BYTE_ARRAY + */ + struct mpv_byte_array *ba; + } u; + /** + * Type of the data stored in this struct. This value rules what members in + * the given union can be accessed. The following formats are currently + * defined to be allowed in mpv_node: + * + * MPV_FORMAT_STRING (u.string) + * MPV_FORMAT_FLAG (u.flag) + * MPV_FORMAT_INT64 (u.int64) + * MPV_FORMAT_DOUBLE (u.double_) + * MPV_FORMAT_NODE_ARRAY (u.list) + * MPV_FORMAT_NODE_MAP (u.list) + * MPV_FORMAT_BYTE_ARRAY (u.ba) + * MPV_FORMAT_NONE (no member) + * + * If you encounter a value you don't know, you must not make any + * assumptions about the contents of union u. + */ + mpv_format format; +} mpv_node; + +/** + * (see mpv_node) + */ +typedef struct mpv_node_list { + /** + * Number of entries. Negative values are not allowed. + */ + int num; + /** + * MPV_FORMAT_NODE_ARRAY: + * values[N] refers to value of the Nth item + * + * MPV_FORMAT_NODE_MAP: + * values[N] refers to value of the Nth key/value pair + * + * If num > 0, values[0] to values[num-1] (inclusive) are valid. + * Otherwise, this can be NULL. + */ + mpv_node *values; + /** + * MPV_FORMAT_NODE_ARRAY: + * unused (typically NULL), access is not allowed + * + * MPV_FORMAT_NODE_MAP: + * keys[N] refers to key of the Nth key/value pair. If num > 0, keys[0] to + * keys[num-1] (inclusive) are valid. Otherwise, this can be NULL. + * The keys are in random order. The only guarantee is that keys[N] belongs + * to the value values[N]. NULL keys are not allowed. + */ + char **keys; +} mpv_node_list; + +/** + * (see mpv_node) + */ +typedef struct mpv_byte_array { + /** + * Pointer to the data. In what format the data is stored is up to whatever + * uses MPV_FORMAT_BYTE_ARRAY. + */ + void *data; + /** + * Size of the data pointed to by ptr. + */ + size_t size; +} mpv_byte_array; + +/** + * Frees any data referenced by the node. It doesn't free the node itself. + * Call this only if the mpv client API set the node. If you constructed the + * node yourself (manually), you have to free it yourself. + * + * If node->format is MPV_FORMAT_NONE, this call does nothing. Likewise, if + * the client API sets a node with this format, this function doesn't need to + * be called. (This is just a clarification that there's no danger of anything + * strange happening in these cases.) + */ +MPV_EXPORT void mpv_free_node_contents(mpv_node *node); + +/** + * Set an option. Note that you can't normally set options during runtime. It + * works in uninitialized state (see mpv_create()), and in some cases in at + * runtime. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. + * + * Note: this is semi-deprecated. For most purposes, this is not needed anymore. + * Starting with mpv version 0.21.0 (version 1.23) most options can be set + * with mpv_set_property() (and related functions), and even before + * mpv_initialize(). In some obscure corner cases, using this function + * to set options might still be required (see + * "Inconsistencies between options and properties" in the manpage). Once + * these are resolved, the option setting functions might be fully + * deprecated. + * + * @param name Option name. This is the same as on the mpv command line, but + * without the leading "--". + * @param format see enum mpv_format. + * @param[in] data Option value (according to the format). + * @return error code + */ +MPV_EXPORT int mpv_set_option(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Convenience function to set an option to a string value. This is like + * calling mpv_set_option() with MPV_FORMAT_STRING. + * + * @return error code + */ +MPV_EXPORT int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data); + +/** + * Send a command to the player. Commands are the same as those used in + * input.conf, except that this function takes parameters in a pre-split + * form. + * + * The commands and their parameters are documented in input.rst. + * + * Does not use OSD and string expansion by default (unlike mpv_command_string() + * and input.conf). + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @return error code + */ +MPV_EXPORT int mpv_command(mpv_handle *ctx, const char **args); + +/** + * Same as mpv_command(), but allows passing structured data in any format. + * In particular, calling mpv_command() is exactly like calling + * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and + * every arg passed in order as MPV_FORMAT_STRING. + * + * Does not use OSD and string expansion by default. + * + * The args argument can have one of the following formats: + * + * MPV_FORMAT_NODE_ARRAY: + * Positional arguments. Each entry is an argument using an arbitrary + * format (the format must be compatible to the used command). Usually, + * the first item is the command name (as MPV_FORMAT_STRING). The order + * of arguments is as documented in each command description. + * + * MPV_FORMAT_NODE_MAP: + * Named arguments. This requires at least an entry with the key "name" + * to be present, which must be a string, and contains the command name. + * The special entry "_flags" is optional, and if present, must be an + * array of strings, each being a command prefix to apply. All other + * entries are interpreted as arguments. They must use the argument names + * as documented in each command description. Some commands do not + * support named arguments at all, and must use MPV_FORMAT_NODE_ARRAY. + * + * @param[in] args mpv_node with format set to one of the values documented + * above (see there for details) + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific return + * data. You must call mpv_free_node_contents() to free it + * (again, only if the command actually succeeds). + * Not many commands actually use this at all. + * @return error code (the result parameter is not set on error) + */ +MPV_EXPORT int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); + +/** + * This is essentially identical to mpv_command() but it also returns a result. + * + * Does not use OSD and string expansion by default. + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific return + * data. You must call mpv_free_node_contents() to free it + * (again, only if the command actually succeeds). + * Not many commands actually use this at all. + * @return error code (the result parameter is not set on error) + */ +MPV_EXPORT int mpv_command_ret(mpv_handle *ctx, const char **args, mpv_node *result); + +/** + * Same as mpv_command, but use input.conf parsing for splitting arguments. + * This is slightly simpler, but also more error prone, since arguments may + * need quoting/escaping. + * + * This also has OSD and string expansion enabled by default. + */ +MPV_EXPORT int mpv_command_string(mpv_handle *ctx, const char *args); + +/** + * Same as mpv_command, but run the command asynchronously. + * + * Commands are executed asynchronously. You will receive a + * MPV_EVENT_COMMAND_REPLY event. This event will also have an + * error code set if running the command failed. For commands that + * return data, the data is put into mpv_event_command.result. + * + * The only case when you do not receive an event is when the function call + * itself fails. This happens only if parsing the command itself (or otherwise + * validating it) fails, i.e. the return code of the API call is not 0 or + * positive. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args NULL-terminated list of strings (see mpv_command()) + * @return error code (if parsing or queuing the command fails) + */ +MPV_EXPORT int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, + const char **args); + +/** + * Same as mpv_command_node(), but run it asynchronously. Basically, this + * function is to mpv_command_node() what mpv_command_async() is to + * mpv_command(). + * + * See mpv_command_async() for details. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args as in mpv_command_node() + * @return error code (if parsing or queuing the command fails) + */ +MPV_EXPORT int mpv_command_node_async(mpv_handle *ctx, uint64_t reply_userdata, + mpv_node *args); + +/** + * Signal to all async requests with the matching ID to abort. This affects + * the following API calls: + * + * mpv_command_async + * mpv_command_node_async + * + * All of these functions take a reply_userdata parameter. This API function + * tells all requests with the matching reply_userdata value to try to return + * as soon as possible. If there are multiple requests with matching ID, it + * aborts all of them. + * + * This API function is mostly asynchronous itself. It will not wait until the + * command is aborted. Instead, the command will terminate as usual, but with + * some work not done. How this is signaled depends on the specific command (for + * example, the "subprocess" command will indicate it by "killed_by_us" set to + * true in the result). How long it takes also depends on the situation. The + * aborting process is completely asynchronous. + * + * Not all commands may support this functionality. In this case, this function + * will have no effect. The same is true if the request using the passed + * reply_userdata has already terminated, has not been started yet, or was + * never in use at all. + * + * You have to be careful of race conditions: the time during which the abort + * request will be effective is _after_ e.g. mpv_command_async() has returned, + * and before the command has signaled completion with MPV_EVENT_COMMAND_REPLY. + * + * @param reply_userdata ID of the request to be aborted (see above) + */ +MPV_EXPORT void mpv_abort_async_command(mpv_handle *ctx, uint64_t reply_userdata); + +/** + * Set a property to a given value. Properties are essentially variables which + * can be queried or set at runtime. For example, writing to the pause property + * will actually pause or unpause playback. + * + * If the format doesn't match with the internal format of the property, access + * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data + * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 + * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING + * usually invokes a string parser. The same happens when calling this function + * with MPV_FORMAT_NODE: the underlying format may be converted to another + * type if possible. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. (Before API version 1.21, this was different.) + * + * Note: starting with mpv 0.21.0 (client API version 1.23), this can be used to + * set options in general. It even can be used before mpv_initialize() + * has been called. If called before mpv_initialize(), setting properties + * not backed by options will result in MPV_ERROR_PROPERTY_UNAVAILABLE. + * In some cases, properties and options still conflict. In these cases, + * mpv_set_property() accesses the options before mpv_initialize(), and + * the properties after mpv_initialize(). These conflicts will be removed + * in mpv 0.23.0. See mpv_set_option() for further remarks. + * + * @param name The property name. See input.rst for a list of properties. + * @param format see enum mpv_format. + * @param[in] data Option value. + * @return error code + */ +MPV_EXPORT int mpv_set_property(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Convenience function to set a property to a string value. + * + * This is like calling mpv_set_property() with MPV_FORMAT_STRING. + */ +MPV_EXPORT int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data); + +/** + * Convenience function to delete a property. + * + * This is equivalent to running the command "del [name]". + * + * @param name The property name. See input.rst for a list of properties. + * @return error code + */ +MPV_EXPORT int mpv_del_property(mpv_handle *ctx, const char *name); + +/** + * Set a property asynchronously. You will receive the result of the operation + * as MPV_EVENT_SET_PROPERTY_REPLY event. The mpv_event.error field will contain + * the result status of the operation. Otherwise, this function is similar to + * mpv_set_property(). + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @param[in] data Option value. The value will be copied by the function. It + * will never be modified by the client API. + * @return error code if sending the request failed + */ +MPV_EXPORT int mpv_set_property_async(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, mpv_format format, void *data); + +/** + * Read the value of the given property. + * + * If the format doesn't match with the internal format of the property, access + * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data + * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 + * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING + * usually invokes a string formatter. + * + * @param name The property name. + * @param format see enum mpv_format. + * @param[out] data Pointer to the variable holding the option value. On + * success, the variable will be set to a copy of the option + * value. For formats that require dynamic memory allocation, + * you can free the value with mpv_free() (strings) or + * mpv_free_node_contents() (MPV_FORMAT_NODE). + * @return error code + */ +MPV_EXPORT int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Return the value of the property with the given name as string. This is + * equivalent to mpv_get_property() with MPV_FORMAT_STRING. + * + * See MPV_FORMAT_STRING for character encoding issues. + * + * On error, NULL is returned. Use mpv_get_property() if you want fine-grained + * error reporting. + * + * @param name The property name. + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ +MPV_EXPORT char *mpv_get_property_string(mpv_handle *ctx, const char *name); + +/** + * Return the property as "OSD" formatted string. This is the same as + * mpv_get_property_string, but using MPV_FORMAT_OSD_STRING. + * + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ +MPV_EXPORT char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name); + +/** + * Get a property asynchronously. You will receive the result of the operation + * as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event. + * You should check the mpv_event.error field on the reply event. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @return error code if sending the request failed + */ +MPV_EXPORT int mpv_get_property_async(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, mpv_format format); + +/** + * Get a notification whenever the given property changes. You will receive + * updates as MPV_EVENT_PROPERTY_CHANGE. Note that this is not very precise: + * for some properties, it may not send updates even if the property changed. + * This depends on the property, and it's a valid feature request to ask for + * better update handling of a specific property. (For some properties, like + * ``clock``, which shows the wall clock, this mechanism doesn't make too + * much sense anyway.) + * + * Property changes are coalesced: the change events are returned only once the + * event queue becomes empty (e.g. mpv_wait_event() would block or return + * MPV_EVENT_NONE), and then only one event per changed property is returned. + * + * You always get an initial change notification. This is meant to initialize + * the user's state to the current value of the property. + * + * Normally, change events are sent only if the property value changes according + * to the requested format. mpv_event_property will contain the property value + * as data member. + * + * Warning: if a property is unavailable or retrieving it caused an error, + * MPV_FORMAT_NONE will be set in mpv_event_property, even if the + * format parameter was set to a different value. In this case, the + * mpv_event_property.data field is invalid. + * + * If the property is observed with the format parameter set to MPV_FORMAT_NONE, + * you get low-level notifications whether the property _may_ have changed, and + * the data member in mpv_event_property will be unset. With this mode, you + * will have to determine yourself whether the property really changed. On the + * other hand, this mechanism can be faster and uses less resources. + * + * Observing a property that doesn't exist is allowed. (Although it may still + * cause some sporadic change events.) + * + * Keep in mind that you will get change notifications even if you change a + * property yourself. Try to avoid endless feedback loops, which could happen + * if you react to the change notifications triggered by your own change. + * + * Only the mpv_handle on which this was called will receive the property + * change events, or can unobserve them. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_PROPERTY_CHANGE + * events. (Also see section about asynchronous calls, + * although this function is somewhat different from + * actual asynchronous calls.) + * If you have no use for this, pass 0. + * Also see mpv_unobserve_property(). + * @param name The property name. + * @param format see enum mpv_format. Can be MPV_FORMAT_NONE to omit values + * from the change events. + * @return error code (usually fails only on OOM or unsupported format) + */ +MPV_EXPORT int mpv_observe_property(mpv_handle *mpv, uint64_t reply_userdata, + const char *name, mpv_format format); + +/** + * Undo mpv_observe_property(). This will remove all observed properties for + * which the given number was passed as reply_userdata to mpv_observe_property. + * + * Safe to be called from mpv render API threads. + * + * @param registered_reply_userdata ID that was passed to mpv_observe_property + * @return negative value is an error code, >=0 is number of removed properties + * on success (includes the case when 0 were removed) + */ +MPV_EXPORT int mpv_unobserve_property(mpv_handle *mpv, uint64_t registered_reply_userdata); + +typedef enum mpv_event_id { + /** + * Nothing happened. Happens on timeouts or sporadic wakeups. + */ + MPV_EVENT_NONE = 0, + /** + * Happens when the player quits. The player enters a state where it tries + * to disconnect all clients. Most requests to the player will fail, and + * the client should react to this and quit with mpv_destroy() as soon as + * possible. + */ + MPV_EVENT_SHUTDOWN = 1, + /** + * See mpv_request_log_messages(). + */ + MPV_EVENT_LOG_MESSAGE = 2, + /** + * Reply to a mpv_get_property_async() request. + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_GET_PROPERTY_REPLY = 3, + /** + * Reply to a mpv_set_property_async() request. + * (Unlike MPV_EVENT_GET_PROPERTY, mpv_event_property is not used.) + */ + MPV_EVENT_SET_PROPERTY_REPLY = 4, + /** + * Reply to a mpv_command_async() or mpv_command_node_async() request. + * See also mpv_event and mpv_event_command. + */ + MPV_EVENT_COMMAND_REPLY = 5, + /** + * Notification before playback start of a file (before the file is loaded). + * See also mpv_event and mpv_event_start_file. + */ + MPV_EVENT_START_FILE = 6, + /** + * Notification after playback end (after the file was unloaded). + * See also mpv_event and mpv_event_end_file. + */ + MPV_EVENT_END_FILE = 7, + /** + * Notification when the file has been loaded (headers were read etc.), and + * decoding starts. + */ + MPV_EVENT_FILE_LOADED = 8, +#if MPV_ENABLE_DEPRECATED + /** + * Idle mode was entered. In this mode, no file is played, and the playback + * core waits for new commands. (The command line player normally quits + * instead of entering idle mode, unless --idle was specified. If mpv + * was started with mpv_create(), idle mode is enabled by default.) + * + * @deprecated This is equivalent to using mpv_observe_property() on the + * "idle-active" property. The event is redundant, and might be + * removed in the far future. As a further warning, this event + * is not necessarily sent at the right point anymore (at the + * start of the program), while the property behaves correctly. + */ + MPV_EVENT_IDLE = 11, + /** + * Sent every time after a video frame is displayed. Note that currently, + * this will be sent in lower frequency if there is no video, or playback + * is paused - but that will be removed in the future, and it will be + * restricted to video frames only. + * + * @deprecated Use mpv_observe_property() with relevant properties instead + * (such as "playback-time"). + */ + MPV_EVENT_TICK = 14, +#endif + /** + * Triggered by the script-message input command. The command uses the + * first argument of the command as client name (see mpv_client_name()) to + * dispatch the message, and passes along all arguments starting from the + * second argument as strings. + * See also mpv_event and mpv_event_client_message. + */ + MPV_EVENT_CLIENT_MESSAGE = 16, + /** + * Happens after video changed in some way. This can happen on resolution + * changes, pixel format changes, or video filter changes. The event is + * sent after the video filters and the VO are reconfigured. Applications + * embedding a mpv window should listen to this event in order to resize + * the window if needed. + * Note that this event can happen sporadically, and you should check + * yourself whether the video parameters really changed before doing + * something expensive. + */ + MPV_EVENT_VIDEO_RECONFIG = 17, + /** + * Similar to MPV_EVENT_VIDEO_RECONFIG. This is relatively uninteresting, + * because there is no such thing as audio output embedding. + */ + MPV_EVENT_AUDIO_RECONFIG = 18, + /** + * Happens when a seek was initiated. Playback stops. Usually it will + * resume with MPV_EVENT_PLAYBACK_RESTART as soon as the seek is finished. + */ + MPV_EVENT_SEEK = 20, + /** + * There was a discontinuity of some sort (like a seek), and playback + * was reinitialized. Usually happens on start of playback and after + * seeking. The main purpose is allowing the client to detect when a seek + * request is finished. + */ + MPV_EVENT_PLAYBACK_RESTART = 21, + /** + * Event sent due to mpv_observe_property(). + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_PROPERTY_CHANGE = 22, + /** + * Happens if the internal per-mpv_handle ringbuffer overflows, and at + * least 1 event had to be dropped. This can happen if the client doesn't + * read the event queue quickly enough with mpv_wait_event(), or if the + * client makes a very large number of asynchronous calls at once. + * + * Event delivery will continue normally once this event was returned + * (this forces the client to empty the queue completely). + */ + MPV_EVENT_QUEUE_OVERFLOW = 24, + /** + * Triggered if a hook handler was registered with mpv_hook_add(), and the + * hook is invoked. If you receive this, you must handle it, and continue + * the hook with mpv_hook_continue(). + * See also mpv_event and mpv_event_hook. + */ + MPV_EVENT_HOOK = 25, + // Internal note: adjust INTERNAL_EVENT_BASE when adding new events. +} mpv_event_id; + +/** + * Return a string describing the event. For unknown events, NULL is returned. + * + * Note that all events actually returned by the API will also yield a non-NULL + * string with this function. + * + * @param event event ID, see see enum mpv_event_id + * @return A static string giving a short symbolic name of the event. It + * consists of lower-case alphanumeric characters and can include "-" + * characters. This string is suitable for use in e.g. scripting + * interfaces. + * The string is completely static, i.e. doesn't need to be deallocated, + * and is valid forever. + */ +MPV_EXPORT const char *mpv_event_name(mpv_event_id event); + +typedef struct mpv_event_property { + /** + * Name of the property. + */ + const char *name; + /** + * Format of the data field in the same struct. See enum mpv_format. + * This is always the same format as the requested format, except when + * the property could not be retrieved (unavailable, or an error happened), + * in which case the format is MPV_FORMAT_NONE. + */ + mpv_format format; + /** + * Received property value. Depends on the format. This is like the + * pointer argument passed to mpv_get_property(). + * + * For example, for MPV_FORMAT_STRING you get the string with: + * + * char *value = *(char **)(event_property->data); + * + * Note that this is set to NULL if retrieving the property failed (the + * format will be MPV_FORMAT_NONE). + */ + void *data; +} mpv_event_property; + +/** + * Numeric log levels. The lower the number, the more important the message is. + * MPV_LOG_LEVEL_NONE is never used when receiving messages. The string in + * the comment after the value is the name of the log level as used for the + * mpv_request_log_messages() function. + * Unused numeric values are unused, but reserved for future use. + */ +typedef enum mpv_log_level { + MPV_LOG_LEVEL_NONE = 0, /// "no" - disable absolutely all messages + MPV_LOG_LEVEL_FATAL = 10, /// "fatal" - critical/aborting errors + MPV_LOG_LEVEL_ERROR = 20, /// "error" - simple errors + MPV_LOG_LEVEL_WARN = 30, /// "warn" - possible problems + MPV_LOG_LEVEL_INFO = 40, /// "info" - informational message + MPV_LOG_LEVEL_V = 50, /// "v" - noisy informational message + MPV_LOG_LEVEL_DEBUG = 60, /// "debug" - very noisy technical information + MPV_LOG_LEVEL_TRACE = 70, /// "trace" - extremely noisy +} mpv_log_level; + +typedef struct mpv_event_log_message { + /** + * The module prefix, identifies the sender of the message. As a special + * case, if the message buffer overflows, this will be set to the string + * "overflow" (which doesn't appear as prefix otherwise), and the text + * field will contain an informative message. + */ + const char *prefix; + /** + * The log level as string. See mpv_request_log_messages() for possible + * values. The level "no" is never used here. + */ + const char *level; + /** + * The log message. It consists of 1 line of text, and is terminated with + * a newline character. (Before API version 1.6, it could contain multiple + * or partial lines.) + */ + const char *text; + /** + * The same contents as the level field, but as a numeric ID. + * Since API version 1.6. + */ + mpv_log_level log_level; +} mpv_event_log_message; + +/// Since API version 1.9. +typedef enum mpv_end_file_reason { + /** + * The end of file was reached. Sometimes this may also happen on + * incomplete or corrupted files, or if the network connection was + * interrupted when playing a remote file. It also happens if the + * playback range was restricted with --end or --frames or similar. + */ + MPV_END_FILE_REASON_EOF = 0, + /** + * Playback was stopped by an external action (e.g. playlist controls). + */ + MPV_END_FILE_REASON_STOP = 2, + /** + * Playback was stopped by the quit command or player shutdown. + */ + MPV_END_FILE_REASON_QUIT = 3, + /** + * Some kind of error happened that lead to playback abort. Does not + * necessarily happen on incomplete or broken files (in these cases, both + * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). + * + * mpv_event_end_file.error will be set. + */ + MPV_END_FILE_REASON_ERROR = 4, + /** + * The file was a playlist or similar. When the playlist is read, its + * entries will be appended to the playlist after the entry of the current + * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE + * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then + * playback continues with the playlist contents. + * Since API version 1.18. + */ + MPV_END_FILE_REASON_REDIRECT = 5, +} mpv_end_file_reason; + +/// Since API version 1.108. +typedef struct mpv_event_start_file { + /** + * Playlist entry ID of the file being loaded now. + */ + int64_t playlist_entry_id; +} mpv_event_start_file; + +typedef struct mpv_event_end_file { + /** + * Corresponds to the values in enum mpv_end_file_reason. + * + * Unknown values should be treated as unknown. + */ + mpv_end_file_reason reason; + /** + * If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code + * (one of MPV_ERROR_...) giving an approximate reason why playback + * failed. In other cases, this field is 0 (no error). + * Since API version 1.9. + */ + int error; + /** + * Playlist entry ID of the file that was being played or attempted to be + * played. This has the same value as the playlist_entry_id field in the + * corresponding mpv_event_start_file event. + * Since API version 1.108. + */ + int64_t playlist_entry_id; + /** + * If loading ended, because the playlist entry to be played was for example + * a playlist, and the current playlist entry is replaced with a number of + * other entries. This may happen at least with MPV_END_FILE_REASON_REDIRECT + * (other event types may use this for similar but different purposes in the + * future). In this case, playlist_insert_id will be set to the playlist + * entry ID of the first inserted entry, and playlist_insert_num_entries to + * the total number of inserted playlist entries. Note this in this specific + * case, the ID of the last inserted entry is playlist_insert_id+num-1. + * Beware that depending on circumstances, you may observe the new playlist + * entries before seeing the event (e.g. reading the "playlist" property or + * getting a property change notification before receiving the event). + * Since API version 1.108. + */ + int64_t playlist_insert_id; + /** + * See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never + * negative. + * Since API version 1.108. + */ + int playlist_insert_num_entries; +} mpv_event_end_file; + +typedef struct mpv_event_client_message { + /** + * Arbitrary arguments chosen by the sender of the message. If num_args > 0, + * you can access args[0] through args[num_args - 1] (inclusive). What + * these arguments mean is up to the sender and receiver. + * None of the valid items are NULL. + */ + int num_args; + const char **args; +} mpv_event_client_message; + +typedef struct mpv_event_hook { + /** + * The hook name as passed to mpv_hook_add(). + */ + const char *name; + /** + * Internal ID that must be passed to mpv_hook_continue(). + */ + uint64_t id; +} mpv_event_hook; + +// Since API version 1.102. +typedef struct mpv_event_command { + /** + * Result data of the command. Note that success/failure is signaled + * separately via mpv_event.error. This field is only for result data + * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set + * to MPV_FORMAT_NONE on failure. + */ + mpv_node result; +} mpv_event_command; + +typedef struct mpv_event { + /** + * One of mpv_event. Keep in mind that later ABI compatible releases might + * add new event types. These should be ignored by the API user. + */ + mpv_event_id event_id; + /** + * This is mainly used for events that are replies to (asynchronous) + * requests. It contains a status code, which is >= 0 on success, or < 0 + * on error (a mpv_error value). Usually, this will be set if an + * asynchronous request fails. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + */ + int error; + /** + * If the event is in reply to a request (made with this API and this + * API handle), this is set to the reply_userdata parameter of the request + * call. Otherwise, this field is 0. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + * MPV_EVENT_PROPERTY_CHANGE + * MPV_EVENT_HOOK + */ + uint64_t reply_userdata; + /** + * The meaning and contents of the data member depend on the event_id: + * MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* + * MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* + * MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* + * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* + * MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) + * MPV_EVENT_END_FILE: mpv_event_end_file* + * MPV_EVENT_HOOK: mpv_event_hook* + * MPV_EVENT_COMMAND_REPLY* mpv_event_command* + * other: NULL + * + * Note: future enhancements might add new event structs for existing or new + * event types. + */ + void *data; +} mpv_event; + +/** + * Convert the given src event to a mpv_node, and set *dst to the result. *dst + * is set to a MPV_FORMAT_NODE_MAP, with fields for corresponding mpv_event and + * mpv_event.data/mpv_event_* fields. + * + * The exact details are not completely documented out of laziness. A start + * is located in the "Events" section of the manpage. + * + * *dst may point to newly allocated memory, or pointers in mpv_event. You must + * copy the entire mpv_node if you want to reference it after mpv_event becomes + * invalid (such as making a new mpv_wait_event() call, or destroying the + * mpv_handle from which it was returned). Call mpv_free_node_contents() to free + * any memory allocations made by this API function. + * + * Safe to be called from mpv render API threads. + * + * @param dst Target. This is not read and fully overwritten. Must be released + * with mpv_free_node_contents(). Do not write to pointers returned + * by it. (On error, this may be left as an empty node.) + * @param src The source event. Not modified (it's not const due to the author's + * prejudice of the C version of const). + * @return error code (MPV_ERROR_NOMEM only, if at all) + */ +MPV_EXPORT int mpv_event_to_node(mpv_node *dst, mpv_event *src); + +/** + * Enable or disable the given event. + * + * Some events are enabled by default. Some events can't be disabled. + * + * (Informational note: currently, all events are enabled by default, except + * MPV_EVENT_TICK.) + * + * Safe to be called from mpv render API threads. + * + * @param event See enum mpv_event_id. + * @param enable 1 to enable receiving this event, 0 to disable it. + * @return error code + */ +MPV_EXPORT int mpv_request_event(mpv_handle *ctx, mpv_event_id event, int enable); + +/** + * Enable or disable receiving of log messages. These are the messages the + * command line player prints to the terminal. This call sets the minimum + * required log level for a message to be received with MPV_EVENT_LOG_MESSAGE. + * + * @param min_level Minimal log level as string. Valid log levels: + * no fatal error warn info v debug trace + * The value "no" disables all messages. This is the default. + * An exception is the value "terminal-default", which uses the + * log level as set by the "--msg-level" option. This works + * even if the terminal is disabled. (Since API version 1.19.) + * Also see mpv_log_level. + * @return error code + */ +MPV_EXPORT int mpv_request_log_messages(mpv_handle *ctx, const char *min_level); + +/** + * Wait for the next event, or until the timeout expires, or if another thread + * makes a call to mpv_wakeup(). Passing 0 as timeout will never wait, and + * is suitable for polling. + * + * The internal event queue has a limited size (per client handle). If you + * don't empty the event queue quickly enough with mpv_wait_event(), it will + * overflow and silently discard further events. If this happens, making + * asynchronous requests will fail as well (with MPV_ERROR_EVENT_QUEUE_FULL). + * + * Only one thread is allowed to call this on the same mpv_handle at a time. + * The API won't complain if more than one thread calls this, but it will cause + * race conditions in the client when accessing the shared mpv_event struct. + * Note that most other API functions are not restricted by this, and no API + * function internally calls mpv_wait_event(). Additionally, concurrent calls + * to different mpv_handles are always safe. + * + * As long as the timeout is 0, this is safe to be called from mpv render API + * threads. + * + * @param timeout Timeout in seconds, after which the function returns even if + * no event was received. A MPV_EVENT_NONE is returned on + * timeout. A value of 0 will disable waiting. Negative values + * will wait with an infinite timeout. + * @return A struct containing the event ID and other data. The pointer (and + * fields in the struct) stay valid until the next mpv_wait_event() + * call, or until the mpv_handle is destroyed. You must not write to + * the struct, and all memory referenced by it will be automatically + * released by the API on the next mpv_wait_event() call, or when the + * context is destroyed. The return value is never NULL. + */ +MPV_EXPORT mpv_event *mpv_wait_event(mpv_handle *ctx, double timeout); + +/** + * Interrupt the current mpv_wait_event() call. This will wake up the thread + * currently waiting in mpv_wait_event(). If no thread is waiting, the next + * mpv_wait_event() call will return immediately (this is to avoid lost + * wakeups). + * + * mpv_wait_event() will receive a MPV_EVENT_NONE if it's woken up due to + * this call. But note that this dummy event might be skipped if there are + * already other events queued. All what counts is that the waiting thread + * is woken up at all. + * + * Safe to be called from mpv render API threads. + */ +MPV_EXPORT void mpv_wakeup(mpv_handle *ctx); + +/** + * Set a custom function that should be called when there are new events. Use + * this if blocking in mpv_wait_event() to wait for new events is not feasible. + * + * Keep in mind that the callback will be called from foreign threads. You + * must not make any assumptions of the environment, and you must return as + * soon as possible (i.e. no long blocking waits). Exiting the callback through + * any other means than a normal return is forbidden (no throwing exceptions, + * no longjmp() calls). You must not change any local thread state (such as + * the C floating point environment). + * + * You are not allowed to call any client API functions inside of the callback. + * In particular, you should not do any processing in the callback, but wake up + * another thread that does all the work. The callback is meant strictly for + * notification only, and is called from arbitrary core parts of the player, + * that make no considerations for reentrant API use or allowing the callee to + * spend a lot of time doing other things. Keep in mind that it's also possible + * that the callback is called from a thread while a mpv API function is called + * (i.e. it can be reentrant). + * + * In general, the client API expects you to call mpv_wait_event() to receive + * notifications, and the wakeup callback is merely a helper utility to make + * this easier in certain situations. Note that it's possible that there's + * only one wakeup callback invocation for multiple events. You should call + * mpv_wait_event() with no timeout until MPV_EVENT_NONE is reached, at which + * point the event queue is empty. + * + * If you actually want to do processing in a callback, spawn a thread that + * does nothing but call mpv_wait_event() in a loop and dispatches the result + * to a callback. + * + * Only one wakeup callback can be set. + * + * @param cb function that should be called if a wakeup is required + * @param d arbitrary userdata passed to cb + */ +MPV_EXPORT void mpv_set_wakeup_callback(mpv_handle *ctx, void (*cb)(void *d), void *d); + +/** + * Block until all asynchronous requests are done. This affects functions like + * mpv_command_async(), which return immediately and return their result as + * events. + * + * This is a helper, and somewhat equivalent to calling mpv_wait_event() in a + * loop until all known asynchronous requests have sent their reply as event, + * except that the event queue is not emptied. + * + * In case you called mpv_suspend() before, this will also forcibly reset the + * suspend counter of the given handle. + */ +MPV_EXPORT void mpv_wait_async_requests(mpv_handle *ctx); + +/** + * A hook is like a synchronous event that blocks the player. You register + * a hook handler with this function. You will get an event, which you need + * to handle, and once things are ready, you can let the player continue with + * mpv_hook_continue(). + * + * Currently, hooks can't be removed explicitly. But they will be implicitly + * removed if the mpv_handle it was registered with is destroyed. This also + * continues the hook if it was being handled by the destroyed mpv_handle (but + * this should be avoided, as it might mess up order of hook execution). + * + * Hook handlers are ordered globally by priority and order of registration. + * Handlers for the same hook with same priority are invoked in order of + * registration (the handler registered first is run first). Handlers with + * lower priority are run first (which seems backward). + * + * See the "Hooks" section in the manpage to see which hooks are currently + * defined. + * + * Some hooks might be reentrant (so you get multiple MPV_EVENT_HOOK for the + * same hook). If this can happen for a specific hook type, it will be + * explicitly documented in the manpage. + * + * Only the mpv_handle on which this was called will receive the hook events, + * or can "continue" them. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_HOOK events. + * If you have no use for this, pass 0. + * @param name The hook name. This should be one of the documented names. But + * if the name is unknown, the hook event will simply be never + * raised. + * @param priority See remarks above. Use 0 as a neutral default. + * @return error code (usually fails only on OOM) + */ +MPV_EXPORT int mpv_hook_add(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, int priority); + +/** + * Respond to a MPV_EVENT_HOOK event. You must call this after you have handled + * the event. There is no way to "cancel" or "stop" the hook. + * + * Calling this will will typically unblock the player for whatever the hook + * is responsible for (e.g. for the "on_load" hook it lets it continue + * playback). + * + * It is explicitly undefined behavior to call this more than once for each + * MPV_EVENT_HOOK, to pass an incorrect ID, or to call this on a mpv_handle + * different from the one that registered the handler and received the event. + * + * @param id This must be the value of the mpv_event_hook.id field for the + * corresponding MPV_EVENT_HOOK. + * @return error code + */ +MPV_EXPORT int mpv_hook_continue(mpv_handle *ctx, uint64_t id); + +#if MPV_ENABLE_DEPRECATED + +/** + * Return a UNIX file descriptor referring to the read end of a pipe. This + * pipe can be used to wake up a poll() based processing loop. The purpose of + * this function is very similar to mpv_set_wakeup_callback(), and provides + * a primitive mechanism to handle coordinating a foreign event loop and the + * libmpv event loop. The pipe is non-blocking. It's closed when the mpv_handle + * is destroyed. This function always returns the same value (on success). + * + * This is in fact implemented using the same underlying code as for + * mpv_set_wakeup_callback() (though they don't conflict), and it is as if each + * callback invocation writes a single 0 byte to the pipe. When the pipe + * becomes readable, the code calling poll() (or select()) on the pipe should + * read all contents of the pipe and then call mpv_wait_event(c, 0) until + * no new events are returned. The pipe contents do not matter and can just + * be discarded. There is not necessarily one byte per readable event in the + * pipe. For example, the pipes are non-blocking, and mpv won't block if the + * pipe is full. Pipes are normally limited to 4096 bytes, so if there are + * more than 4096 events, the number of readable bytes can not equal the number + * of events queued. Also, it's possible that mpv does not write to the pipe + * once it's guaranteed that the client was already signaled. See the example + * below how to do it correctly. + * + * Example: + * + * int pipefd = mpv_get_wakeup_pipe(mpv); + * if (pipefd < 0) + * error(); + * while (1) { + * struct pollfd pfds[1] = { + * { .fd = pipefd, .events = POLLIN }, + * }; + * // Wait until there are possibly new mpv events. + * poll(pfds, 1, -1); + * if (pfds[0].revents & POLLIN) { + * // Empty the pipe. Doing this before calling mpv_wait_event() + * // ensures that no wakeups are missed. It's not so important to + * // make sure the pipe is really empty (it will just cause some + * // additional wakeups in unlikely corner cases). + * char unused[256]; + * read(pipefd, unused, sizeof(unused)); + * while (1) { + * mpv_event *ev = mpv_wait_event(mpv, 0); + * // If MPV_EVENT_NONE is received, the event queue is empty. + * if (ev->event_id == MPV_EVENT_NONE) + * break; + * // Process the event. + * ... + * } + * } + * } + * + * @deprecated this function will be removed in the future. If you need this + * functionality, use mpv_set_wakeup_callback(), create a pipe + * manually, and call write() on your pipe in the callback. + * + * @return A UNIX FD of the read end of the wakeup pipe, or -1 on error. + * On MS Windows/MinGW, this will always return -1. + */ +MPV_EXPORT int mpv_get_wakeup_pipe(mpv_handle *ctx); + +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h new file mode 100644 index 000000000..29f9b91e9 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h @@ -0,0 +1,738 @@ +/* Copyright (C) 2018 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_RENDER_H_ +#define MPV_CLIENT_API_RENDER_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Overview + * -------- + * + * This API can be used to make mpv render using supported graphic APIs (such + * as OpenGL). It can be used to handle video display. + * + * The renderer needs to be created with mpv_render_context_create() before + * you start playback (or otherwise cause a VO to be created). Then (with most + * backends) mpv_render_context_render() can be used to explicitly render the + * current video frame. Use mpv_render_context_set_update_callback() to get + * notified when there is a new frame to draw. + * + * Preferably rendering should be done in a separate thread. If you call + * normal libmpv API functions on the renderer thread, deadlocks can result + * (these are made non-fatal with timeouts, but user experience will obviously + * suffer). See "Threading" section below. + * + * You can output and embed video without this API by setting the mpv "wid" + * option to a native window handle (see "Embedding the video window" section + * in the client.h header). In general, using the render API is recommended, + * because window embedding can cause various issues, especially with GUI + * toolkits and certain platforms. + * + * Supported backends + * ------------------ + * + * OpenGL: via MPV_RENDER_API_TYPE_OPENGL, see render_gl.h header. + * Software: via MPV_RENDER_API_TYPE_SW, see section "Software renderer" + * + * Threading + * --------- + * + * You are recommended to do rendering on a separate thread than normal libmpv + * use. + * + * The mpv_render_* functions can be called from any thread, under the + * following conditions: + * - only one of the mpv_render_* functions can be called at the same time + * (unless they belong to different mpv cores created by mpv_create()) + * - never can be called from within the callbacks set with + * mpv_set_wakeup_callback() or mpv_render_context_set_update_callback() + * - if the OpenGL backend is used, for all functions the OpenGL context + * must be "current" in the calling thread, and it must be the same OpenGL + * context as the mpv_render_context was created with. Otherwise, undefined + * behavior will occur. + * - the thread does not call libmpv API functions other than the mpv_render_* + * functions, except APIs which are declared as safe (see below). Likewise, + * there must be no lock or wait dependency from the render thread to a + * thread using other libmpv functions. Basically, the situation that your + * render thread waits for a "not safe" libmpv API function to return must + * not happen. If you ignore this requirement, deadlocks can happen, which + * are made non-fatal with timeouts; then playback quality will be degraded, + * and the message + * mpv_render_context_render() not being called or stuck. + * is logged. If you set MPV_RENDER_PARAM_ADVANCED_CONTROL, you promise that + * this won't happen, and must absolutely guarantee it, or a real deadlock + * will freeze the mpv core thread forever. + * + * libmpv functions which are safe to call from a render thread are: + * - functions marked with "Safe to be called from mpv render API threads." + * - client.h functions which don't have an explicit or implicit mpv_handle + * parameter + * - mpv_render_* functions; but only for the same mpv_render_context pointer. + * If the pointer is different, mpv_render_context_free() is not safe. (The + * reason is that if MPV_RENDER_PARAM_ADVANCED_CONTROL is set, it may have + * to process still queued requests from the core, which it can do only for + * the current context, while requests for other contexts would deadlock. + * Also, it may have to wait and block for the core to terminate the video + * chain to make sure no resources are used after context destruction.) + * - if the mpv_handle parameter refers to a different mpv core than the one + * you're rendering for (very obscure, but allowed) + * + * Note about old libmpv version: + * + * Before API version 1.105 (basically in mpv 0.29.x), simply enabling + * MPV_RENDER_PARAM_ADVANCED_CONTROL could cause deadlock issues. This can + * be worked around by setting the "vd-lavc-dr" option to "no". + * In addition, you were required to call all mpv_render*() API functions + * from the same thread on which mpv_render_context_create() was originally + * run (for the same the mpv_render_context). Not honoring it led to UB + * (deadlocks, use of invalid pthread_t handles), even if you moved your GL + * context to a different thread correctly. + * These problems were addressed in API version 1.105 (mpv 0.30.0). + * + * Context and handle lifecycle + * ---------------------------- + * + * Video initialization will fail if the render context was not initialized yet + * (with mpv_render_context_create()), or it will revert to a VO that creates + * its own window. + * + * Currently, there can be only 1 mpv_render_context at a time per mpv core. + * + * Calling mpv_render_context_free() while a VO is using the render context is + * active will disable video. + * + * You must free the context with mpv_render_context_free() before the mpv core + * is destroyed. If this doesn't happen, undefined behavior will result. + * + * Software renderer + * ----------------- + * + * MPV_RENDER_API_TYPE_SW provides an extremely simple (but slow) renderer to + * memory surfaces. You probably don't want to use this. Use other render API + * types, or other methods of video embedding. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_SW. + * + * Call mpv_render_context_render() with various MPV_RENDER_PARAM_SW_* fields + * to render the video frame to an in-memory surface. The following fields are + * required: MPV_RENDER_PARAM_SW_SIZE, MPV_RENDER_PARAM_SW_FORMAT, + * MPV_RENDER_PARAM_SW_STRIDE, MPV_RENDER_PARAM_SW_POINTER. + * + * This method of rendering is very slow, because everything, including color + * conversion, scaling, and OSD rendering, is done on the CPU, single-threaded. + * In particular, large video or display sizes, as well as presence of OSD or + * subtitles can make it too slow for realtime. As with other software rendering + * VOs, setting "sw-fast" may help. Enabling or disabling zimg may help, + * depending on the platform. + * + * In addition, certain multimedia job creation measures like HDR may not work + * properly, and will have to be manually handled by for example inserting + * filters. + * + * This API is not really suitable to extract individual frames from video etc. + * (basically non-playback uses) - there are better libraries for this. It can + * be used this way, but it may be clunky and tricky. + * + * Further notes: + * - MPV_RENDER_PARAM_FLIP_Y is currently ignored (unsupported) + * - MPV_RENDER_PARAM_DEPTH is ignored (meaningless) + */ + +/** + * Opaque context, returned by mpv_render_context_create(). + */ +typedef struct mpv_render_context mpv_render_context; + +/** + * Parameters for mpv_render_param (which is used in a few places such as + * mpv_render_context_create(). + * + * Also see mpv_render_param for conventions and how to use it. + */ +typedef enum mpv_render_param_type { + /** + * Not a valid value, but also used to terminate a params array. Its value + * is always guaranteed to be 0 (even if the ABI changes in the future). + */ + MPV_RENDER_PARAM_INVALID = 0, + /** + * The render API to use. Valid for mpv_render_context_create(). + * + * Type: char* + * + * Defined APIs: + * + * MPV_RENDER_API_TYPE_OPENGL: + * OpenGL desktop 2.1 or later (preferably core profile compatible to + * OpenGL 3.2), or OpenGLES 2.0 or later. + * Providing MPV_RENDER_PARAM_OPENGL_INIT_PARAMS is required. + * It is expected that an OpenGL context is valid and "current" when + * calling mpv_render_* functions (unless specified otherwise). It + * must be the same context for the same mpv_render_context. + */ + MPV_RENDER_PARAM_API_TYPE = 1, + /** + * Required parameters for initializing the OpenGL renderer. Valid for + * mpv_render_context_create(). + * Type: mpv_opengl_init_params* + */ + MPV_RENDER_PARAM_OPENGL_INIT_PARAMS = 2, + /** + * Describes a GL render target. Valid for mpv_render_context_render(). + * Type: mpv_opengl_fbo* + */ + MPV_RENDER_PARAM_OPENGL_FBO = 3, + /** + * Control flipped rendering. Valid for mpv_render_context_render(). + * Type: int* + * If the value is set to 0, render normally. Otherwise, render it flipped, + * which is needed e.g. when rendering to an OpenGL default framebuffer + * (which has a flipped coordinate system). + */ + MPV_RENDER_PARAM_FLIP_Y = 4, + /** + * Control surface depth. Valid for mpv_render_context_render(). + * Type: int* + * This implies the depth of the surface passed to the render function in + * bits per channel. If omitted or set to 0, the renderer will assume 8. + * Typically used to control dithering. + */ + MPV_RENDER_PARAM_DEPTH = 5, + /** + * ICC profile blob. Valid for mpv_render_context_set_parameter(). + * Type: mpv_byte_array* + * Set an ICC profile for use with the "icc-profile-auto" option. (If the + * option is not enabled, the ICC data will not be used.) + */ + MPV_RENDER_PARAM_ICC_PROFILE = 6, + /** + * Ambient light in lux. Valid for mpv_render_context_set_parameter(). + * Type: int* + * This can be used for automatic gamma correction. + */ + MPV_RENDER_PARAM_AMBIENT_LIGHT = 7, + /** + * X11 Display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The Display must stay valid for the lifetime + * of the mpv_render_context. + * Type: Display* + */ + MPV_RENDER_PARAM_X11_DISPLAY = 8, + /** + * Wayland display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The wl_display must stay valid for the + * lifetime of the mpv_render_context. + * Type: struct wl_display* + */ + MPV_RENDER_PARAM_WL_DISPLAY = 9, + /** + * Better control about rendering and enabling some advanced features. Valid + * for mpv_render_context_create(). + * + * This conflates multiple requirements the API user promises to abide if + * this option is enabled: + * + * - The API user's render thread, which is calling the mpv_render_*() + * functions, never waits for the core. Otherwise deadlocks can happen. + * See "Threading" section. + * - The callback set with mpv_render_context_set_update_callback() can now + * be called even if there is no new frame. The API user should call the + * mpv_render_context_update() function, and interpret the return value + * for whether a new frame should be rendered. + * - Correct functionality is impossible if the update callback is not set, + * or not set soon enough after mpv_render_context_create() (the core can + * block while waiting for you to call mpv_render_context_update(), and + * if the update callback is not correctly set, it will deadlock, or + * block for too long). + * + * In general, setting this option will enable the following features (and + * possibly more): + * + * - "Direct rendering", which means the player decodes directly to a + * texture, which saves a copy per video frame ("vd-lavc-dr" option + * needs to be enabled, and the rendering backend as well as the + * underlying GPU API/driver needs to have support for it). + * - Rendering screenshots with the GPU API if supported by the backend + * (instead of using a suboptimal software fallback via libswscale). + * + * Warning: do not just add this without reading the "Threading" section + * above, and then wondering that deadlocks happen. The + * requirements are tricky. But also note that even if advanced + * control is disabled, not adhering to the rules will lead to + * playback problems. Enabling advanced controls simply makes + * violating these rules fatal. + * + * Type: int*: 0 for disable (default), 1 for enable + */ + MPV_RENDER_PARAM_ADVANCED_CONTROL = 10, + /** + * Return information about the next frame to render. Valid for + * mpv_render_context_get_info(). + * + * Type: mpv_render_frame_info* + * + * It strictly returns information about the _next_ frame. The implication + * is that e.g. mpv_render_context_update()'s return value will have + * MPV_RENDER_UPDATE_FRAME set, and the user is supposed to call + * mpv_render_context_render(). If there is no next frame, then the + * return value will have is_valid set to 0. + */ + MPV_RENDER_PARAM_NEXT_FRAME_INFO = 11, + /** + * Enable or disable video timing. Valid for mpv_render_context_render(). + * + * Type: int*: 0 for disable, 1 for enable (default) + * + * When video is timed to audio, the player attempts to render video a bit + * ahead, and then do a blocking wait until the target display time is + * reached. This blocks mpv_render_context_render() for up to the amount + * specified with the "video-timing-offset" global option. You can set + * this parameter to 0 to disable this kind of waiting. If you do, it's + * recommended to use the target time value in mpv_render_frame_info to + * wait yourself, or to set the "video-timing-offset" to 0 instead. + * + * Disabling this without doing anything in addition will result in A/V sync + * being slightly off. + */ + MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, + /** + * Use to skip rendering in mpv_render_context_render(). + * + * Type: int*: 0 for rendering (default), 1 for skipping + * + * If this is set, you don't need to pass a target surface to the render + * function (and if you do, it's completely ignored). This can still call + * into the lower level APIs (i.e. if you use OpenGL, the OpenGL context + * must be set). + * + * Be aware that the render API will consider this frame as having been + * rendered. All other normal rules also apply, for example about whether + * you have to call mpv_render_context_report_swap(). It also does timing + * in the same way. + */ + MPV_RENDER_PARAM_SKIP_RENDERING = 13, + /** + * Deprecated. Not supported. Use MPV_RENDER_PARAM_DRM_DISPLAY_V2 instead. + * Type : struct mpv_opengl_drm_params* + */ + MPV_RENDER_PARAM_DRM_DISPLAY = 14, + /** + * DRM draw surface size, contains draw surface dimensions. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_draw_surface_size* + */ + MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE = 15, + /** + * DRM display, contains drm display handles. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_params_v2* + */ + MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];) + * + * The video frame is transformed as with other VOs. Typically, this means + * the video gets scaled and black bars are added if the video size or + * aspect ratio mismatches with the target size. + */ + MPV_RENDER_PARAM_SW_SIZE = 17, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: char* (e.g.: char *f = "rgb0"; param.data = f;) + * + * Valid values are: + * "rgb0", "bgr0", "0bgr", "0rgb" + * 4 bytes per pixel RGB, 1 byte (8 bit) per component, component bytes + * with increasing address from left to right (e.g. "rgb0" has r at + * address 0), the "0" component contains uninitialized garbage (often + * the value 0, but not necessarily; the bad naming is inherited from + * FFmpeg) + * Pixel alignment size: 4 bytes + * "rgb24" + * 3 bytes per pixel RGB. This is strongly discouraged because it is + * very slow. + * Pixel alignment size: 1 bytes + * other + * The API may accept other pixel formats, using mpv internal format + * names, as long as it's internally marked as RGB, has exactly 1 + * plane, and is supported as conversion output. It is not a good idea + * to rely on any of these. Their semantics and handling could change. + */ + MPV_RENDER_PARAM_SW_FORMAT = 18, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: size_t* + * + * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the + * target surface. It must be a multiple of the pixel size, and have space + * for the surface width as specified by MPV_RENDER_PARAM_SW_SIZE. + * + * Both stride and pointer value should be a multiple of 64 to facilitate + * fast SIMD operation. Lower alignment might trigger slower code paths, + * and in the worst case, will copy the entire target frame. If mpv is built + * with zimg (and zimg is not disabled), the performance impact might be + * less. + * In either cases, the pointer and stride must be aligned at least to the + * pixel alignment size. Otherwise, crashes and undefined behavior is + * possible on platforms which do not support unaligned accesses (either + * through normal memory access or aligned SIMD memory access instructions). + */ + MPV_RENDER_PARAM_SW_STRIDE = 19, + /* + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data pointer, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: void* + * + * This points to the first pixel at the left/top corner (0, 0). In + * particular, each line y starts at (pointer + stride * y). Upon rendering, + * all data between pointer and (pointer + stride * h) is overwritten. + * Whether the padding between (w, y) and (0, y + 1) is overwritten is left + * unspecified (it should not be, but unfortunately some scaler backends + * will do it anyway). It is assumed that even the padding after the last + * line (starting at bytepos(w, h) until (pointer + stride * h)) is + * writable. + * + * See MPV_RENDER_PARAM_SW_STRIDE for alignment requirements. + */ + MPV_RENDER_PARAM_SW_POINTER = 20, +} mpv_render_param_type; + +/** + * For backwards compatibility with the old naming of + * MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + */ +#define MPV_RENDER_PARAM_DRM_OSD_SIZE MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + +/** + * Used to pass arbitrary parameters to some mpv_render_* functions. The + * meaning of the data parameter is determined by the type, and each + * MPV_RENDER_PARAM_* documents what type the value must point to. + * + * Each value documents the required data type as the pointer you cast to + * void* and set on mpv_render_param.data. For example, if MPV_RENDER_PARAM_FOO + * documents the type as Something* , then the code should look like this: + * + * Something foo = {...}; + * mpv_render_param param; + * param.type = MPV_RENDER_PARAM_FOO; + * param.data = & foo; + * + * Normally, the data field points to exactly 1 object. If the type is char*, + * it points to a 0-terminated string. + * + * In all cases (unless documented otherwise) the pointers need to remain + * valid during the call only. Unless otherwise documented, the API functions + * will not write to the params array or any data pointed to it. + * + * As a convention, parameter arrays are always terminated by type==0. There + * is no specific order of the parameters required. The order of the 2 fields in + * this struct is guaranteed (even after ABI changes). + */ +typedef struct mpv_render_param { + enum mpv_render_param_type type; + void *data; +} mpv_render_param; + + +/** + * Predefined values for MPV_RENDER_PARAM_API_TYPE. + */ +// See render_gl.h +#define MPV_RENDER_API_TYPE_OPENGL "opengl" +// See section "Software renderer" +#define MPV_RENDER_API_TYPE_SW "sw" + +/** + * Flags used in mpv_render_frame_info.flags. Each value represents a bit in it. + */ +typedef enum mpv_render_frame_info_flag { + /** + * Set if there is actually a next frame. If unset, there is no next frame + * yet, and other flags and fields that require a frame to be queued will + * be unset. + * + * This is set for _any_ kind of frame, even for redraw requests. + * + * Note that when this is unset, it simply means no new frame was + * decoded/queued yet, not necessarily that the end of the video was + * reached. A new frame can be queued after some time. + * + * If the return value of mpv_render_context_render() had the + * MPV_RENDER_UPDATE_FRAME flag set, this flag will usually be set as well, + * unless the frame is rendered, or discarded by other asynchronous events. + */ + MPV_RENDER_FRAME_INFO_PRESENT = 1 << 0, + /** + * If set, the frame is not an actual new video frame, but a redraw request. + * For example if the video is paused, and an option that affects video + * rendering was changed (or any other reason), an update request can be + * issued and this flag will be set. + * + * Typically, redraw frames will not be subject to video timing. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REDRAW = 1 << 1, + /** + * If set, this is supposed to reproduce the previous frame perfectly. This + * is usually used for certain "video-sync" options ("display-..." modes). + * Typically the renderer will blit the video from a FBO. Unset otherwise. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, + /** + * If set, the player timing code expects that the user thread blocks on + * vsync (by either delaying the render call, or by making a call to + * mpv_render_context_report_swap() at vsync time). + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, +} mpv_render_frame_info_flag; + +/** + * Information about the next video frame that will be rendered. Can be + * retrieved with MPV_RENDER_PARAM_NEXT_FRAME_INFO. + */ +typedef struct mpv_render_frame_info { + /** + * A bitset of mpv_render_frame_info_flag values (i.e. multiple flags are + * combined with bitwise or). + */ + uint64_t flags; + /** + * Absolute time at which the frame is supposed to be displayed. This is in + * the same unit and base as the time returned by mpv_get_time_us(). For + * frames that are redrawn, or if vsync locked video timing is used (see + * "video-sync" option), then this can be 0. The "video-timing-offset" + * option determines how much "headroom" the render thread gets (but a high + * enough frame rate can reduce it anyway). mpv_render_context_render() will + * normally block until the time is elapsed, unless you pass it + * MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 0. + */ + int64_t target_time; +} mpv_render_frame_info; + +/** + * Initialize the renderer state. Depending on the backend used, this will + * access the underlying GPU API and initialize its own objects. + * + * You must free the context with mpv_render_context_free(). Not doing so before + * the mpv core is destroyed may result in memory leaks or crashes. + * + * Currently, only at most 1 context can exists per mpv core (it represents the + * main video output). + * + * You should pass the following parameters: + * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API. + * - Backend-specific init parameter, like MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is + * strongly recommended. + * - If you want to use hwdec, possibly hwdec interop resources. + * + * @param res set to the context (on success) or NULL (on failure). The value + * is never read and always overwritten. + * @param mpv handle used to get the core (the mpv_render_context won't depend + * on this specific handle, only the core referenced by it) + * @param params an array of parameters, terminated by type==0. It's left + * unspecified what happens with unknown parameters. At least + * MPV_RENDER_PARAM_API_TYPE is required, and most backends will + * require another backend-specific parameter. + * @return error code, including but not limited to: + * MPV_ERROR_UNSUPPORTED: the OpenGL version is not supported + * (or required extensions are missing) + * MPV_ERROR_NOT_IMPLEMENTED: an unknown API type was provided, or + * support for the requested API was not + * built in the used libmpv binary. + * MPV_ERROR_INVALID_PARAMETER: at least one of the provided parameters was + * not valid. + */ +MPV_EXPORT int mpv_render_context_create(mpv_render_context **res, mpv_handle *mpv, + mpv_render_param *params); + +/** + * Attempt to change a single parameter. Not all backends and parameter types + * support all kinds of changes. + * + * @param ctx a valid render context + * @param param the parameter type and data that should be set + * @return error code. If a parameter could actually be changed, this returns + * success, otherwise an error code depending on the parameter type + * and situation. + */ +MPV_EXPORT int mpv_render_context_set_parameter(mpv_render_context *ctx, + mpv_render_param param); + +/** + * Retrieve information from the render context. This is NOT a counterpart to + * mpv_render_context_set_parameter(), because you generally can't read + * parameters set with it, and this function is not meant for this purpose. + * Instead, this is for communicating information from the renderer back to the + * user. See mpv_render_param_type; entries which support this function + * explicitly mention it, and for other entries you can assume it will fail. + * + * You pass param with param.type set and param.data pointing to a variable + * of the required data type. The function will then overwrite that variable + * with the returned value (at least on success). + * + * @param ctx a valid render context + * @param param the parameter type and data that should be retrieved + * @return error code. If a parameter could actually be retrieved, this returns + * success, otherwise an error code depending on the parameter type + * and situation. MPV_ERROR_NOT_IMPLEMENTED is used for unknown + * param.type, or if retrieving it is not supported. + */ +MPV_EXPORT int mpv_render_context_get_info(mpv_render_context *ctx, + mpv_render_param param); + +typedef void (*mpv_render_update_fn)(void *cb_ctx); + +/** + * Set the callback that notifies you when a new video frame is available, or + * if the video display configuration somehow changed and requires a redraw. + * Similar to mpv_set_wakeup_callback(), you must not call any mpv API from + * the callback, and all the other listed restrictions apply (such as not + * exiting the callback by throwing exceptions). + * + * This can be called from any thread, except from an update callback. In case + * of the OpenGL backend, no OpenGL state or API is accessed. + * + * Calling this will raise an update callback immediately. + * + * @param callback callback(callback_ctx) is called if the frame should be + * redrawn + * @param callback_ctx opaque argument to the callback + */ +MPV_EXPORT void mpv_render_context_set_update_callback(mpv_render_context *ctx, + mpv_render_update_fn callback, + void *callback_ctx); + +/** + * The API user is supposed to call this when the update callback was invoked + * (like all mpv_render_* functions, this has to happen on the render thread, + * and _not_ from the update callback itself). + * + * This is optional if MPV_RENDER_PARAM_ADVANCED_CONTROL was not set (default). + * Otherwise, it's a hard requirement that this is called after each update + * callback. If multiple update callback happened, and the function could not + * be called sooner, it's OK to call it once after the last callback. + * + * If an update callback happens during or after this function, the function + * must be called again at the soonest possible time. + * + * If MPV_RENDER_PARAM_ADVANCED_CONTROL was set, this will do additional work + * such as allocating textures for the video decoder. + * + * @return a bitset of mpv_render_update_flag values (i.e. multiple flags are + * combined with bitwise or). Typically, this will tell the API user + * what should happen next. E.g. if the MPV_RENDER_UPDATE_FRAME flag is + * set, mpv_render_context_render() should be called. If flags unknown + * to the API user are set, or if the return value is 0, nothing needs + * to be done. + */ +MPV_EXPORT uint64_t mpv_render_context_update(mpv_render_context *ctx); + +/** + * Flags returned by mpv_render_context_update(). Each value represents a bit + * in the function's return value. + */ +typedef enum mpv_render_update_flag { + /** + * A new video frame must be rendered. mpv_render_context_render() must be + * called. + */ + MPV_RENDER_UPDATE_FRAME = 1 << 0, +} mpv_render_context_flag; + +/** + * Render video. + * + * Typically renders the video to a target surface provided via mpv_render_param + * (the details depend on the backend in use). Options like "panscan" are + * applied to determine which part of the video should be visible and how the + * video should be scaled. You can change these options at runtime by using the + * mpv property API. + * + * The renderer will reconfigure itself every time the target surface + * configuration (such as size) is changed. + * + * This function implicitly pulls a video frame from the internal queue and + * renders it. If no new frame is available, the previous frame is redrawn. + * The update callback set with mpv_render_context_set_update_callback() + * notifies you when a new frame was added. The details potentially depend on + * the backends and the provided parameters. + * + * Generally, libmpv will invoke your update callback some time before the video + * frame should be shown, and then lets this function block until the supposed + * display time. This will limit your rendering to video FPS. You can prevent + * this by setting the "video-timing-offset" global option to 0. (This applies + * only to "audio" video sync mode.) + * + * You should pass the following parameters: + * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO. + * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y. + * + * @param ctx a valid render context + * @param params an array of parameters, terminated by type==0. Which parameters + * are required depends on the backend. It's left unspecified what + * happens with unknown parameters. + * @return error code + */ +MPV_EXPORT int mpv_render_context_render(mpv_render_context *ctx, mpv_render_param *params); + +/** + * Tell the renderer that a frame was flipped at the given time. This is + * optional, but can help the player to achieve better timing. + * + * Note that calling this at least once informs libmpv that you will use this + * function. If you use it inconsistently, expect bad video playback. + * + * If this is called while no video is initialized, it is ignored. + * + * @param ctx a valid render context + */ +MPV_EXPORT void mpv_render_context_report_swap(mpv_render_context *ctx); + +/** + * Destroy the mpv renderer state. + * + * If video is still active (e.g. a file playing), video will be disabled + * forcefully. + * + * @param ctx a valid render context. After this function returns, this is not + * a valid pointer anymore. NULL is also allowed and does nothing. + */ +MPV_EXPORT void mpv_render_context_free(mpv_render_context *ctx); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h new file mode 100644 index 000000000..a2c31f0c7 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h @@ -0,0 +1,211 @@ +/* Copyright (C) 2018 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_RENDER_GL_H_ +#define MPV_CLIENT_API_RENDER_GL_H_ + +#include "render.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * OpenGL backend + * -------------- + * + * This header contains definitions for using OpenGL with the render.h API. + * + * OpenGL interop + * -------------- + * + * The OpenGL backend has some special rules, because OpenGL itself uses + * implicit per-thread contexts, which causes additional API problems. + * + * This assumes the OpenGL context lives on a certain thread controlled by the + * API user. All mpv_render_* APIs have to be assumed to implicitly use the + * OpenGL context if you pass a mpv_render_context using the OpenGL backend, + * unless specified otherwise. + * + * The OpenGL context is indirectly accessed through the OpenGL function + * pointers returned by the get_proc_address callback in mpv_opengl_init_params. + * Generally, mpv will not load the system OpenGL library when using this API. + * + * OpenGL state + * ------------ + * + * OpenGL has a large amount of implicit state. All the mpv functions mentioned + * above expect that the OpenGL state is reasonably set to OpenGL standard + * defaults. Likewise, mpv will attempt to leave the OpenGL context with + * standard defaults. The following state is excluded from this: + * + * - the glViewport state + * - the glScissor state (but GL_SCISSOR_TEST is in its default value) + * - glBlendFuncSeparate() state (but GL_BLEND is in its default value) + * - glClearColor() state + * - mpv may overwrite the callback set with glDebugMessageCallback() + * - mpv always disables GL_DITHER at init + * + * Messing with the state could be avoided by creating shared OpenGL contexts, + * but this is avoided for the sake of compatibility and interoperability. + * + * On OpenGL 2.1, mpv will strictly call functions like glGenTextures() to + * create OpenGL objects. You will have to do the same. This ensures that + * objects created by mpv and the API users don't clash. Also, legacy state + * must be either in its defaults, or not interfere with core state. + * + * API use + * ------- + * + * The mpv_render_* API is used. That API supports multiple backends, and this + * section documents specifics for the OpenGL backend. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_OPENGL, and MPV_RENDER_PARAM_OPENGL_INIT_PARAMS provided. + * + * Call mpv_render_context_render() with MPV_RENDER_PARAM_OPENGL_FBO to render + * the video frame to an FBO. + * + * Hardware decoding + * ----------------- + * + * Hardware decoding via this API is fully supported, but requires some + * additional setup. (At least if direct hardware decoding modes are wanted, + * instead of copying back surface data from GPU to CPU RAM.) + * + * There may be certain requirements on the OpenGL implementation: + * + * - Windows: ANGLE is required (although in theory GL/DX interop could be used) + * - Intel/Linux: EGL is required, and also the native display resource needs + * to be provided (e.g. MPV_RENDER_PARAM_X11_DISPLAY for X11 and + * MPV_RENDER_PARAM_WL_DISPLAY for Wayland) + * - nVidia/Linux: Both GLX and EGL should work (GLX is required if vdpau is + * used, e.g. due to old drivers.) + * - OSX: CGL is required (CGLGetCurrentContext() returning non-NULL) + * - iOS: EAGL is required (EAGLContext.currentContext returning non-nil) + * + * Once these things are setup, hardware decoding can be enabled/disabled at + * any time by setting the "hwdec" property. + */ + +/** + * For initializing the mpv OpenGL state via MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + */ +typedef struct mpv_opengl_init_params { + /** + * This retrieves OpenGL function pointers, and will use them in subsequent + * operation. + * Usually, you can simply call the GL context APIs from this callback (e.g. + * glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always + * return pointers for all standard functions (even if present); in this + * case you have to compensate by looking up these functions yourself when + * libmpv wants to resolve them through this callback. + * libmpv will not normally attempt to resolve GL functions on its own, nor + * does it link to GL libraries directly. + */ + void *(*get_proc_address)(void *ctx, const char *name); + /** + * Value passed as ctx parameter to get_proc_address(). + */ + void *get_proc_address_ctx; +} mpv_opengl_init_params; + +/** + * For MPV_RENDER_PARAM_OPENGL_FBO. + */ +typedef struct mpv_opengl_fbo { + /** + * Framebuffer object name. This must be either a valid FBO generated by + * glGenFramebuffers() that is complete and color-renderable, or 0. If the + * value is 0, this refers to the OpenGL default framebuffer. + */ + int fbo; + /** + * Valid dimensions. This must refer to the size of the framebuffer. This + * must always be set. + */ + int w, h; + /** + * Underlying texture internal format (e.g. GL_RGBA8), or 0 if unknown. If + * this is the default framebuffer, this can be an equivalent. + */ + int internal_format; +} mpv_opengl_fbo; + +/** + * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. + */ +typedef struct mpv_opengl_drm_params { + int fd; + int crtc_id; + int connector_id; + struct _drmModeAtomicReq **atomic_request_ptr; + int render_fd; +} mpv_opengl_drm_params; + +/** + * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. + */ +typedef struct mpv_opengl_drm_draw_surface_size { + /** + * size of the draw plane surface in pixels. + */ + int width, height; +} mpv_opengl_drm_draw_surface_size; + +/** + * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. + */ +typedef struct mpv_opengl_drm_params_v2 { + /** + * DRM fd (int). Set to -1 if invalid. + */ + int fd; + + /** + * Currently used crtc id + */ + int crtc_id; + + /** + * Currently used connector id + */ + int connector_id; + + /** + * Pointer to a drmModeAtomicReq pointer that is being used for the renderloop. + * This pointer should hold a pointer to the atomic request pointer + * The atomic request pointer is usually changed at every renderloop. + */ + struct _drmModeAtomicReq **atomic_request_ptr; + + /** + * DRM render node. Used for VAAPI interop. + * Set to -1 if invalid. + */ + int render_fd; +} mpv_opengl_drm_params_v2; + + +/** + * For backwards compatibility with the old naming of mpv_opengl_drm_draw_surface_size + */ +#define mpv_opengl_drm_osd_size mpv_opengl_drm_draw_surface_size + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h new file mode 100644 index 000000000..9d1c2cc8d --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h @@ -0,0 +1,240 @@ +/* Copyright (C) 2017 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_STREAM_CB_H_ +#define MPV_CLIENT_API_STREAM_CB_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Warning: this API is not stable yet. + * + * Overview + * -------- + * + * This API can be used to make mpv read from a stream with a custom + * implementation. This interface is inspired by funopen on BSD and + * fopencookie on linux. The stream is backed by user-defined callbacks + * which can implement customized open, read, seek, size and close behaviors. + * + * Usage + * ----- + * + * Register your stream callbacks with the mpv_stream_cb_add_ro() function. You + * have to provide a mpv_stream_cb_open_ro_fn callback to it (open_fn argument). + * + * Once registered, you can `loadfile myprotocol://myfile`. Your open_fn will be + * invoked with the URI and you must fill out the provided mpv_stream_cb_info + * struct. This includes your stream callbacks (like read_fn), and an opaque + * cookie, which will be passed as the first argument to all the remaining + * stream callbacks. + * + * Note that your custom callbacks must not invoke libmpv APIs as that would + * cause a deadlock. (Unless you call a different mpv_handle than the one the + * callback was registered for, and the mpv_handles refer to different mpv + * instances.) + * + * Stream lifetime + * --------------- + * + * A stream remains valid until its close callback has been called. It's up to + * libmpv to call the close callback, and the libmpv user cannot close it + * directly with the stream_cb API. + * + * For example, if you consider your custom stream to become suddenly invalid + * (maybe because the underlying stream died), libmpv will continue using your + * stream. All you can do is returning errors from each callback, until libmpv + * gives up and closes it. + * + * Protocol registration and lifetime + * ---------------------------------- + * + * Protocols remain registered until the mpv instance is terminated. This means + * in particular that it can outlive the mpv_handle that was used to register + * it, but once mpv_terminate_destroy() is called, your registered callbacks + * will not be called again. + * + * Protocol unregistration is finished after the mpv core has been destroyed + * (e.g. after mpv_terminate_destroy() has returned). + * + * If you do not call mpv_terminate_destroy() yourself (e.g. plugin-style code), + * you will have to deal with the registration or even streams outliving your + * code. Here are some possible ways to do this: + * - call mpv_terminate_destroy(), which destroys the core, and will make sure + * all streams are closed once this function returns + * - you refcount all resources your stream "cookies" reference, so that it + * doesn't matter if streams live longer than expected + * - create "cancellation" semantics: after your protocol has been unregistered, + * notify all your streams that are still opened, and make them drop all + * referenced resources - then return errors from the stream callbacks as + * long as the stream is still opened + * + */ + +/** + * Read callback used to implement a custom stream. The semantics of the + * callback match read(2) in blocking mode. Short reads are allowed (you can + * return less bytes than requested, and libmpv will retry reading the rest + * with another call). If no data can be immediately read, the callback must + * block until there is new data. A return of 0 will be interpreted as final + * EOF, although libmpv might retry the read, or seek to a different position. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param buf buffer to read data into + * @param size of the buffer + * @return number of bytes read into the buffer + * @return 0 on EOF + * @return -1 on error + */ +typedef int64_t (*mpv_stream_cb_read_fn)(void *cookie, char *buf, uint64_t nbytes); + +/** + * Seek callback used to implement a custom stream. + * + * Note that mpv will issue a seek to position 0 immediately after opening. This + * is used to test whether the stream is seekable (since seekability might + * depend on the URI contents, not just the protocol). Return + * MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This + * seek also serves to establish the fact that streams start at position 0. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param offset target absolute stream position + * @return the resulting offset of the stream + * MPV_ERROR_UNSUPPORTED or MPV_ERROR_GENERIC if the seek failed + */ +typedef int64_t (*mpv_stream_cb_seek_fn)(void *cookie, int64_t offset); + +/** + * Size callback used to implement a custom stream. + * + * Return MPV_ERROR_UNSUPPORTED if no size is known. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @return the total size in bytes of the stream + */ +typedef int64_t (*mpv_stream_cb_size_fn)(void *cookie); + +/** + * Close callback used to implement a custom stream. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ +typedef void (*mpv_stream_cb_close_fn)(void *cookie); + +/** + * Cancel callback used to implement a custom stream. + * + * This callback is used to interrupt any current or future read and seek + * operations. It will be called from a separate thread than the demux + * thread, and should not block. + * + * This callback can be NULL. + * + * Available since API 1.106. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ +typedef void (*mpv_stream_cb_cancel_fn)(void *cookie); + +/** + * See mpv_stream_cb_open_ro_fn callback. + */ +typedef struct mpv_stream_cb_info { + /** + * Opaque user-provided value, which will be passed to the other callbacks. + * The close callback will be called to release the cookie. It is not + * interpreted by mpv. It doesn't even need to be a valid pointer. + * + * The user sets this in the mpv_stream_cb_open_ro_fn callback. + */ + void *cookie; + + /** + * Callbacks set by the user in the mpv_stream_cb_open_ro_fn callback. Some + * of them are optional, and can be left unset. + * + * The following callbacks are mandatory: read_fn, close_fn + */ + mpv_stream_cb_read_fn read_fn; + mpv_stream_cb_seek_fn seek_fn; + mpv_stream_cb_size_fn size_fn; + mpv_stream_cb_close_fn close_fn; + mpv_stream_cb_cancel_fn cancel_fn; /* since API 1.106 */ +} mpv_stream_cb_info; + +/** + * Open callback used to implement a custom read-only (ro) stream. The user + * must set the callback fields in the passed info struct. The cookie field + * also can be set to store state associated to the stream instance. + * + * Note that the info struct is valid only for the duration of this callback. + * You can't change the callbacks or the pointer to the cookie at a later point. + * + * Each stream instance created by the open callback can have different + * callbacks. + * + * The close_fn callback will terminate the stream instance. The pointers to + * your callbacks and cookie will be discarded, and the callbacks will not be + * called again. + * + * @param user_data opaque user data provided via mpv_stream_cb_add() + * @param uri name of the stream to be opened (with protocol prefix) + * @param info fields which the user should fill + * @return 0 on success, MPV_ERROR_LOADING_FAILED if the URI cannot be opened. + */ +typedef int (*mpv_stream_cb_open_ro_fn)(void *user_data, char *uri, + mpv_stream_cb_info *info); + +/** + * Add a custom stream protocol. This will register a protocol handler under + * the given protocol prefix, and invoke the given callbacks if an URI with the + * matching protocol prefix is opened. + * + * The "ro" is for read-only - only read-only streams can be registered with + * this function. + * + * The callback remains registered until the mpv core is registered. + * + * If a custom stream with the same name is already registered, then the + * MPV_ERROR_INVALID_PARAMETER error is returned. + * + * @param protocol protocol prefix, for example "foo" for "foo://" URIs + * @param user_data opaque pointer passed into the mpv_stream_cb_open_fn + * callback. + * @return error code + */ +MPV_EXPORT int mpv_stream_cb_add_ro(mpv_handle *ctx, const char *protocol, void *user_data, + mpv_stream_cb_open_ro_fn open_fn); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c b/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c new file mode 100644 index 000000000..9b5faec70 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c @@ -0,0 +1 @@ +#include "mpv/client.h" diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/media_kit_video/ios/Classes/plugin/TextureHW.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift similarity index 99% rename from media_kit_video/ios/Classes/plugin/TextureHW.swift rename to media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift index a3c3acd8e..c369c6acc 100644 --- a/media_kit_video/ios/Classes/plugin/TextureHW.swift +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift @@ -1,6 +1,10 @@ import Flutter import OpenGLES +#if SWIFT_PACKAGE + import Mpv +#endif + public class TextureHW: NSObject, FlutterTexture, ResizableTextureProtocol { public typealias UpdateCallback = () -> Void diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift new file mode 120000 index 000000000..a4704e4d9 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MPVHelpers.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift new file mode 120000 index 000000000..6feea1962 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MPVVideoOutParams.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift new file mode 120000 index 000000000..7526e39c7 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift new file mode 120000 index 000000000..ead958248 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/ResizableTextureProtocol.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift new file mode 120000 index 000000000..e71d4abd1 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/SafeResizableTexture.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift new file mode 120000 index 000000000..6a160006c --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/SwappableObjectManager.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift new file mode 120000 index 000000000..77f4a4a6d --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/TextureSW.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift new file mode 120000 index 000000000..06c3bdc6c --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/TextureSWContext.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift new file mode 120000 index 000000000..a122f40ef --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/UtilsProtocol.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift new file mode 120000 index 000000000..b51cdfd75 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutput.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift new file mode 120000 index 000000000..a7ee17420 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutputConfiguration.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift new file mode 120000 index 000000000..02f018076 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutputManager.swift \ No newline at end of file diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift new file mode 120000 index 000000000..4895bec3b --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/Worker.swift \ No newline at end of file diff --git a/media_kit_video/ios/Classes/plugin/gles/OpenGLESHelpers.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/gles/OpenGLESHelpers.swift similarity index 100% rename from media_kit_video/ios/Classes/plugin/gles/OpenGLESHelpers.swift rename to media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/gles/OpenGLESHelpers.swift diff --git a/media_kit_video/ios/Classes/plugin/gles/TextureGLESContext.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/gles/TextureGLESContext.swift similarity index 98% rename from media_kit_video/ios/Classes/plugin/gles/TextureGLESContext.swift rename to media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/gles/TextureGLESContext.swift index c2952be32..0e4b7d10b 100644 --- a/media_kit_video/ios/Classes/plugin/gles/TextureGLESContext.swift +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/plugin/gles/TextureGLESContext.swift @@ -1,3 +1,6 @@ +import OpenGLES +import UIKit + public class TextureGLESContext { private let context: EAGLContext public let frameBuffer: GLuint diff --git a/media_kit_video/ios/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift new file mode 120000 index 000000000..906542b40 --- /dev/null +++ b/media_kit_video/ios/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/stub/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/macos/.gitignore b/media_kit_video/macos/.gitignore index 05dd1fe0c..6b52dcb68 100644 --- a/media_kit_video/macos/.gitignore +++ b/media_kit_video/macos/.gitignore @@ -1 +1,4 @@ Headers +.build +.swiftpm +Package.resolved diff --git a/media_kit_video/macos/Classes/plugin/common/MPVHelpers.swift b/media_kit_video/macos/Classes/plugin/common/MPVHelpers.swift deleted file mode 120000 index 227135ca5..000000000 --- a/media_kit_video/macos/Classes/plugin/common/MPVHelpers.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MPVHelpers.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/MPVVideoOutParams.swift b/media_kit_video/macos/Classes/plugin/common/MPVVideoOutParams.swift deleted file mode 120000 index 86edcf4c5..000000000 --- a/media_kit_video/macos/Classes/plugin/common/MPVVideoOutParams.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MPVVideoOutParams.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/MediaKitVideoPlugin.swift b/media_kit_video/macos/Classes/plugin/common/MediaKitVideoPlugin.swift deleted file mode 120000 index 28b20891a..000000000 --- a/media_kit_video/macos/Classes/plugin/common/MediaKitVideoPlugin.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/ResizableTextureProtocol.swift b/media_kit_video/macos/Classes/plugin/common/ResizableTextureProtocol.swift deleted file mode 120000 index 5f582e365..000000000 --- a/media_kit_video/macos/Classes/plugin/common/ResizableTextureProtocol.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/ResizableTextureProtocol.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/SafeResizableTexture.swift b/media_kit_video/macos/Classes/plugin/common/SafeResizableTexture.swift deleted file mode 120000 index cb7753279..000000000 --- a/media_kit_video/macos/Classes/plugin/common/SafeResizableTexture.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/SafeResizableTexture.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/SwappableObjectManager.swift b/media_kit_video/macos/Classes/plugin/common/SwappableObjectManager.swift deleted file mode 120000 index e5dc8c841..000000000 --- a/media_kit_video/macos/Classes/plugin/common/SwappableObjectManager.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/SwappableObjectManager.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/TextureSW.swift b/media_kit_video/macos/Classes/plugin/common/TextureSW.swift deleted file mode 120000 index 6ababc7cf..000000000 --- a/media_kit_video/macos/Classes/plugin/common/TextureSW.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/TextureSW.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/TextureSWContext.swift b/media_kit_video/macos/Classes/plugin/common/TextureSWContext.swift deleted file mode 120000 index 6d7183e0a..000000000 --- a/media_kit_video/macos/Classes/plugin/common/TextureSWContext.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/TextureSWContext.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/UtilsProtocol.swift b/media_kit_video/macos/Classes/plugin/common/UtilsProtocol.swift deleted file mode 120000 index c0b658dff..000000000 --- a/media_kit_video/macos/Classes/plugin/common/UtilsProtocol.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/UtilsProtocol.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/VideoOutput.swift b/media_kit_video/macos/Classes/plugin/common/VideoOutput.swift deleted file mode 120000 index 78c7f1d78..000000000 --- a/media_kit_video/macos/Classes/plugin/common/VideoOutput.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutput.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/VideoOutputConfiguration.swift b/media_kit_video/macos/Classes/plugin/common/VideoOutputConfiguration.swift deleted file mode 120000 index 4d3b4d907..000000000 --- a/media_kit_video/macos/Classes/plugin/common/VideoOutputConfiguration.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutputConfiguration.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/VideoOutputManager.swift b/media_kit_video/macos/Classes/plugin/common/VideoOutputManager.swift deleted file mode 120000 index 52289a9c2..000000000 --- a/media_kit_video/macos/Classes/plugin/common/VideoOutputManager.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/VideoOutputManager.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/common/Worker.swift b/media_kit_video/macos/Classes/plugin/common/Worker.swift deleted file mode 120000 index bf3a22856..000000000 --- a/media_kit_video/macos/Classes/plugin/common/Worker.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/plugin/Worker.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/stub/common/MediaKitVideoPlugin.swift b/media_kit_video/macos/Classes/stub/common/MediaKitVideoPlugin.swift deleted file mode 120000 index 38cd66192..000000000 --- a/media_kit_video/macos/Classes/stub/common/MediaKitVideoPlugin.swift +++ /dev/null @@ -1 +0,0 @@ -../../../../common/darwin/Classes/stub/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video.podspec b/media_kit_video/macos/media_kit_video.podspec index 15c3a9ca0..1226d1179 100644 --- a/media_kit_video/macos/media_kit_video.podspec +++ b/media_kit_video/macos/media_kit_video.podspec @@ -23,15 +23,18 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.platform = :osx, '10.9' + s.platform = :osx, '10.15' s.swift_version = '5.0' s.dependency 'FlutterMacOS' + s.resource_bundles = { + 'media_kit_video_privacy' => ['media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy'] + } if mku.libs_found # Define paths to frameworks dir framework_search_paths_macosx = sprintf('$(PROJECT_DIR)/../Flutter/ephemeral/.symlinks/plugins/%s/macos/Frameworks/.symlinks/mpv/macos', mku.libs_package) - s.source_files = 'Classes/plugin/**/*.swift', 'Headers/**/*.h' + s.source_files = 'media_kit_video/Sources/media_kit_video/plugin/**/*.swift', 'Headers/**/*.h' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'GCC_WARN_INHIBIT_ALL_WARNINGS' => 'YES', @@ -40,7 +43,7 @@ Pod::Spec.new do |s| 'OTHER_LDFLAGS' => '"$(inherited)" -framework Mpv', } else - s.source_files = 'Classes/stub/**/*.swift' + s.source_files = 'media_kit_video/Sources/media_kit_video/stub/**/*.swift' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } end end diff --git a/media_kit_video/macos/media_kit_video/Package.swift b/media_kit_video/macos/media_kit_video/Package.swift new file mode 100644 index 000000000..482fffa59 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Package.swift @@ -0,0 +1,33 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let package = Package( + name: "media_kit_video", + platforms: [ + .macOS("10.15") + ], + products: [ + .library(name: "media-kit-video", targets: ["media_kit_video"]) + ], + dependencies: [], + targets: [ + .target( + name: "Mpv", + path: "Sources/Mpv", + sources: ["shim.c"], + publicHeadersPath: "include" + ), + .target( + name: "media_kit_video", + dependencies: [ + .target(name: "Mpv") + ], + sources: ["plugin"], + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap new file mode 100644 index 000000000..7226723bb --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap @@ -0,0 +1,7 @@ +module Mpv { + header "mpv/client.h" + header "mpv/render.h" + header "mpv/render_gl.h" + header "mpv/stream_cb.h" + export * +} diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h new file mode 100644 index 000000000..b9697eb74 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h @@ -0,0 +1,1896 @@ +/* Copyright (C) 2017 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +/* + * Note: the client API is licensed under ISC (see above) to enable + * other wrappers outside of mpv. But keep in mind that the + * mpv core is by default still GPLv2+ - unless built with + * --enable-lgpl, which makes it LGPLv2+. + */ + +#ifndef MPV_CLIENT_API_H_ +#define MPV_CLIENT_API_H_ + +#include +#include + +/* New symbols must still be added to libmpv/mpv.def. */ +#ifdef _WIN32 +#define MPV_EXPORT __declspec(dllexport) +#elif defined(__GNUC__) || defined(__clang__) +#define MPV_EXPORT __attribute__((visibility("default"))) +#else +#define MPV_EXPORT +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Mechanisms provided by this API + * ------------------------------- + * + * This API provides general control over mpv playback. It does not give you + * direct access to individual components of the player, only the whole thing. + * It's somewhat equivalent to MPlayer's slave mode. You can send commands, + * retrieve or set playback status or settings with properties, and receive + * events. + * + * The API can be used in two ways: + * 1) Internally in mpv, to provide additional features to the command line + * player. Lua scripting uses this. (Currently there is no plugin API to + * get a client API handle in external user code. It has to be a fixed + * part of the player at compilation time.) + * 2) Using mpv as a library with mpv_create(). This basically allows embedding + * mpv in other applications. + * + * Documentation + * ------------- + * + * The libmpv C API is documented directly in this header. Note that most + * actual interaction with this player is done through + * options/commands/properties, which can be accessed through this API. + * Essentially everything is done with them, including loading a file, + * retrieving playback progress, and so on. + * + * These are documented elsewhere: + * * http://mpv.io/manual/master/#options + * * http://mpv.io/manual/master/#list-of-input-commands + * * http://mpv.io/manual/master/#properties + * + * You can also look at the examples here: + * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv + * + * Event loop + * ---------- + * + * In general, the API user should run an event loop in order to receive events. + * This event loop should call mpv_wait_event(), which will return once a new + * mpv client API is available. It is also possible to integrate client API + * usage in other event loops (e.g. GUI toolkits) with the + * mpv_set_wakeup_callback() function, and then polling for events by calling + * mpv_wait_event() with a 0 timeout. + * + * Note that the event loop is detached from the actual player. Not calling + * mpv_wait_event() will not stop playback. It will eventually congest the + * event queue of your API handle, though. + * + * Synchronous vs. asynchronous calls + * ---------------------------------- + * + * The API allows both synchronous and asynchronous calls. Synchronous calls + * have to wait until the playback core is ready, which currently can take + * an unbounded time (e.g. if network is slow or unresponsive). Asynchronous + * calls just queue operations as requests, and return the result of the + * operation as events. + * + * Asynchronous calls + * ------------------ + * + * The client API includes asynchronous functions. These allow you to send + * requests instantly, and get replies as events at a later point. The + * requests are made with functions carrying the _async suffix, and replies + * are returned by mpv_wait_event() (interleaved with the normal event stream). + * + * A 64 bit userdata value is used to allow the user to associate requests + * with replies. The value is passed as reply_userdata parameter to the request + * function. The reply to the request will have the reply + * mpv_event->reply_userdata field set to the same value as the + * reply_userdata parameter of the corresponding request. + * + * This userdata value is arbitrary and is never interpreted by the API. Note + * that the userdata value 0 is also allowed, but then the client must be + * careful not accidentally interpret the mpv_event->reply_userdata if an + * event is not a reply. (For non-replies, this field is set to 0.) + * + * Asynchronous calls may be reordered in arbitrarily with other synchronous + * and asynchronous calls. If you want a guaranteed order, you need to wait + * until asynchronous calls report completion before doing the next call. + * + * See also the section "Asynchronous command details" in the manpage. + * + * Multithreading + * -------------- + * + * The client API is generally fully thread-safe, unless otherwise noted. + * Currently, there is no real advantage in using more than 1 thread to access + * the client API, since everything is serialized through a single lock in the + * playback core. + * + * Basic environment requirements + * ------------------------------ + * + * This documents basic requirements on the C environment. This is especially + * important if mpv is used as library with mpv_create(). + * + * - The LC_NUMERIC locale category must be set to "C". If your program calls + * setlocale(), be sure not to use LC_ALL, or if you do, reset LC_NUMERIC + * to its sane default: setlocale(LC_NUMERIC, "C"). + * - If a X11 based VO is used, mpv will set the xlib error handler. This error + * handler is process-wide, and there's no proper way to share it with other + * xlib users within the same process. This might confuse GUI toolkits. + * - mpv uses some other libraries that are not library-safe, such as Fribidi + * (used through libass), ALSA, FFmpeg, and possibly more. + * - The FPU precision must be set at least to double precision. + * - On Windows, mpv will call timeBeginPeriod(1). + * - On memory exhaustion, mpv will kill the process. + * - In certain cases, mpv may start sub processes (such as with the ytdl + * wrapper script). + * - Using UNIX IPC (off by default) will override the SIGPIPE signal handler, + * and set it to SIG_IGN. Some invocations of the "subprocess" command will + * also do that. + * - mpv may start sub processes, so overriding SIGCHLD, or waiting on all PIDs + * (such as calling wait()) by the parent process or any other library within + * the process must be avoided. libmpv itself only waits for its own PIDs. + * - If anything in the process registers signal handlers, they must set the + * SA_RESTART flag. Otherwise you WILL get random failures on signals. + * + * Encoding of filenames + * --------------------- + * + * mpv uses UTF-8 everywhere. + * + * On some platforms (like Linux), filenames actually do not have to be UTF-8; + * for this reason libmpv supports non-UTF-8 strings. libmpv uses what the + * kernel uses and does not recode filenames. At least on Linux, passing a + * string to libmpv is like passing a string to the fopen() function. + * + * On Windows, filenames are always UTF-8, libmpv converts between UTF-8 and + * UTF-16 when using win32 API functions. libmpv never uses or accepts + * filenames in the local 8 bit encoding. It does not use fopen() either; + * it uses _wfopen(). + * + * On OS X, filenames and other strings taken/returned by libmpv can have + * inconsistent unicode normalization. This can sometimes lead to problems. + * You have to hope for the best. + * + * Also see the remarks for MPV_FORMAT_STRING. + * + * Embedding the video window + * -------------------------- + * + * Using the render API (in render.h) is recommended. This API requires + * you to create and maintain an OpenGL context, to which you can render + * video using a specific API call. This API does not include keyboard or mouse + * input directly. + * + * There is an older way to embed the native mpv window into your own. You have + * to get the raw window handle, and set it as "wid" option. This works on X11, + * win32, and OSX only. It's much easier to use than the render API, but + * also has various problems. + * + * Also see client API examples and the mpv manpage. There is an extensive + * discussion here: + * https://github.com/mpv-player/mpv-examples/tree/master/libmpv#methods-of-embedding-the-video-window + * + * Compatibility + * ------------- + * + * mpv development doesn't stand still, and changes to mpv internals as well as + * to its interface can cause compatibility issues to client API users. + * + * The API is versioned (see MPV_CLIENT_API_VERSION), and changes to it are + * documented in DOCS/client-api-changes.rst. The C API itself will probably + * remain compatible for a long time, but the functionality exposed by it + * could change more rapidly. For example, it's possible that options are + * renamed, or change the set of allowed values. + * + * Defensive programming should be used to potentially deal with the fact that + * options, commands, and properties could disappear, change their value range, + * or change the underlying datatypes. It might be a good idea to prefer + * MPV_FORMAT_STRING over other types to decouple your code from potential + * mpv changes. + * + * Also see: DOCS/compatibility.rst + * + * Future changes + * -------------- + * + * This are the planned changes that will most likely be done on the next major + * bump of the library: + * + * - remove all symbols that are marked as deprecated + * - reassign enum numerical values to remove gaps + * - disabling all events by default + */ + +/** + * The version is incremented on each API change. The 16 lower bits form the + * minor version number, and the 16 higher bits the major version number. If + * the API becomes incompatible to previous versions, the major version + * number is incremented. This affects only C part, and not properties and + * options. + * + * Every API bump is described in DOCS/client-api-changes.rst + * + * You can use MPV_MAKE_VERSION() and compare the result with integer + * relational operators (<, >, <=, >=). + */ +#define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) +#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(2, 1) + +/** + * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before + * including any libmpv headers. Then deprecated symbols will be excluded + * from the headers. (Of course, deprecated properties and commands and + * other functionality will still work.) + */ +#ifndef MPV_ENABLE_DEPRECATED +#define MPV_ENABLE_DEPRECATED 1 +#endif + +/** + * Return the MPV_CLIENT_API_VERSION the mpv source has been compiled with. + */ +MPV_EXPORT unsigned long mpv_client_api_version(void); + +/** + * Client context used by the client API. Every client has its own private + * handle. + */ +typedef struct mpv_handle mpv_handle; + +/** + * List of error codes than can be returned by API functions. 0 and positive + * return values always mean success, negative values are always errors. + */ +typedef enum mpv_error { + /** + * No error happened (used to signal successful operation). + * Keep in mind that many API functions returning error codes can also + * return positive values, which also indicate success. API users can + * hardcode the fact that ">= 0" means success. + */ + MPV_ERROR_SUCCESS = 0, + /** + * The event ringbuffer is full. This means the client is choked, and can't + * receive any events. This can happen when too many asynchronous requests + * have been made, but not answered. Probably never happens in practice, + * unless the mpv core is frozen for some reason, and the client keeps + * making asynchronous requests. (Bugs in the client API implementation + * could also trigger this, e.g. if events become "lost".) + */ + MPV_ERROR_EVENT_QUEUE_FULL = -1, + /** + * Memory allocation failed. + */ + MPV_ERROR_NOMEM = -2, + /** + * The mpv core wasn't configured and initialized yet. See the notes in + * mpv_create(). + */ + MPV_ERROR_UNINITIALIZED = -3, + /** + * Generic catch-all error if a parameter is set to an invalid or + * unsupported value. This is used if there is no better error code. + */ + MPV_ERROR_INVALID_PARAMETER = -4, + /** + * Trying to set an option that doesn't exist. + */ + MPV_ERROR_OPTION_NOT_FOUND = -5, + /** + * Trying to set an option using an unsupported MPV_FORMAT. + */ + MPV_ERROR_OPTION_FORMAT = -6, + /** + * Setting the option failed. Typically this happens if the provided option + * value could not be parsed. + */ + MPV_ERROR_OPTION_ERROR = -7, + /** + * The accessed property doesn't exist. + */ + MPV_ERROR_PROPERTY_NOT_FOUND = -8, + /** + * Trying to set or get a property using an unsupported MPV_FORMAT. + */ + MPV_ERROR_PROPERTY_FORMAT = -9, + /** + * The property exists, but is not available. This usually happens when the + * associated subsystem is not active, e.g. querying audio parameters while + * audio is disabled. + */ + MPV_ERROR_PROPERTY_UNAVAILABLE = -10, + /** + * Error setting or getting a property. + */ + MPV_ERROR_PROPERTY_ERROR = -11, + /** + * General error when running a command with mpv_command and similar. + */ + MPV_ERROR_COMMAND = -12, + /** + * Generic error on loading (usually used with mpv_event_end_file.error). + */ + MPV_ERROR_LOADING_FAILED = -13, + /** + * Initializing the audio output failed. + */ + MPV_ERROR_AO_INIT_FAILED = -14, + /** + * Initializing the video output failed. + */ + MPV_ERROR_VO_INIT_FAILED = -15, + /** + * There was no audio or video data to play. This also happens if the + * file was recognized, but did not contain any audio or video streams, + * or no streams were selected. + */ + MPV_ERROR_NOTHING_TO_PLAY = -16, + /** + * When trying to load the file, the file format could not be determined, + * or the file was too broken to open it. + */ + MPV_ERROR_UNKNOWN_FORMAT = -17, + /** + * Generic error for signaling that certain system requirements are not + * fulfilled. + */ + MPV_ERROR_UNSUPPORTED = -18, + /** + * The API function which was called is a stub only. + */ + MPV_ERROR_NOT_IMPLEMENTED = -19, + /** + * Unspecified error. + */ + MPV_ERROR_GENERIC = -20 +} mpv_error; + +/** + * Return a string describing the error. For unknown errors, the string + * "unknown error" is returned. + * + * @param error error number, see enum mpv_error + * @return A static string describing the error. The string is completely + * static, i.e. doesn't need to be deallocated, and is valid forever. + */ +MPV_EXPORT const char *mpv_error_string(int error); + +/** + * General function to deallocate memory returned by some of the API functions. + * Call this only if it's explicitly documented as allowed. Calling this on + * mpv memory not owned by the caller will lead to undefined behavior. + * + * @param data A valid pointer returned by the API, or NULL. + */ +MPV_EXPORT void mpv_free(void *data); + +/** + * Return the name of this client handle. Every client has its own unique + * name, which is mostly used for user interface purposes. + * + * @return The client name. The string is read-only and is valid until the + * mpv_handle is destroyed. + */ +MPV_EXPORT const char *mpv_client_name(mpv_handle *ctx); + +/** + * Return the ID of this client handle. Every client has its own unique ID. This + * ID is never reused by the core, even if the mpv_handle at hand gets destroyed + * and new handles get allocated. + * + * IDs are never 0 or negative. + * + * Some mpv APIs (not necessarily all) accept a name in the form "@" in + * addition of the proper mpv_client_name(), where "" is the ID in decimal + * form (e.g. "@123"). For example, the "script-message-to" command takes the + * client name as first argument, but also accepts the client ID formatted in + * this manner. + * + * @return The client ID. + */ +MPV_EXPORT int64_t mpv_client_id(mpv_handle *ctx); + +/** + * Create a new mpv instance and an associated client API handle to control + * the mpv instance. This instance is in a pre-initialized state, + * and needs to be initialized to be actually used with most other API + * functions. + * + * Some API functions will return MPV_ERROR_UNINITIALIZED in the uninitialized + * state. You can call mpv_set_property() (or mpv_set_property_string() and + * other variants, and before mpv 0.21.0 mpv_set_option() etc.) to set initial + * options. After this, call mpv_initialize() to start the player, and then use + * e.g. mpv_command() to start playback of a file. + * + * The point of separating handle creation and actual initialization is that + * you can configure things which can't be changed during runtime. + * + * Unlike the command line player, this will have initial settings suitable + * for embedding in applications. The following settings are different: + * - stdin/stdout/stderr and the terminal will never be accessed. This is + * equivalent to setting the --no-terminal option. + * (Technically, this also suppresses C signal handling.) + * - No config files will be loaded. This is roughly equivalent to using + * --config=no. Since libmpv 1.15, you can actually re-enable this option, + * which will make libmpv load config files during mpv_initialize(). If you + * do this, you are strongly encouraged to set the "config-dir" option too. + * (Otherwise it will load the mpv command line player's config.) + * For example: + * mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config root + * mpv_set_option_string(mpv, "config", "yes"); // enable config loading + * (call mpv_initialize() _after_ this) + * - Idle mode is enabled, which means the playback core will enter idle mode + * if there are no more files to play on the internal playlist, instead of + * exiting. This is equivalent to the --idle option. + * - Disable parts of input handling. + * - Most of the different settings can be viewed with the command line player + * by running "mpv --show-profile=libmpv". + * + * All this assumes that API users want a mpv instance that is strictly + * isolated from the command line player's configuration, user settings, and + * so on. You can re-enable disabled features by setting the appropriate + * options. + * + * The mpv command line parser is not available through this API, but you can + * set individual options with mpv_set_property(). Files for playback must be + * loaded with mpv_command() or others. + * + * Note that you should avoid doing concurrent accesses on the uninitialized + * client handle. (Whether concurrent access is definitely allowed or not has + * yet to be decided.) + * + * @return a new mpv client API handle. Returns NULL on error. Currently, this + * can happen in the following situations: + * - out of memory + * - LC_NUMERIC is not set to "C" (see general remarks) + */ +MPV_EXPORT mpv_handle *mpv_create(void); + +/** + * Initialize an uninitialized mpv instance. If the mpv instance is already + * running, an error is returned. + * + * This function needs to be called to make full use of the client API if the + * client API handle was created with mpv_create(). + * + * Only the following options are required to be set _before_ mpv_initialize(): + * - options which are only read at initialization time: + * - config + * - config-dir + * - input-conf + * - load-scripts + * - script + * - player-operation-mode + * - input-app-events (OSX) + * - all encoding mode options + * + * @return error code + */ +MPV_EXPORT int mpv_initialize(mpv_handle *ctx); + +/** + * Disconnect and destroy the mpv_handle. ctx will be deallocated with this + * API call. + * + * If the last mpv_handle is detached, the core player is destroyed. In + * addition, if there are only weak mpv_handles (such as created by + * mpv_create_weak_client() or internal scripts), these mpv_handles will + * be sent MPV_EVENT_SHUTDOWN. This function may block until these clients + * have responded to the shutdown event, and the core is finally destroyed. + */ +MPV_EXPORT void mpv_destroy(mpv_handle *ctx); + +/** + * Similar to mpv_destroy(), but brings the player and all clients down + * as well, and waits until all of them are destroyed. This function blocks. The + * advantage over mpv_destroy() is that while mpv_destroy() merely + * detaches the client handle from the player, this function quits the player, + * waits until all other clients are destroyed (i.e. all mpv_handles are + * detached), and also waits for the final termination of the player. + * + * Since mpv_destroy() is called somewhere on the way, it's not safe to + * call other functions concurrently on the same context. + * + * Since mpv client API version 1.29: + * The first call on any mpv_handle will block until the core is destroyed. + * This means it will wait until other mpv_handle have been destroyed. If you + * want asynchronous destruction, just run the "quit" command, and then react + * to the MPV_EVENT_SHUTDOWN event. + * If another mpv_handle already called mpv_terminate_destroy(), this call will + * not actually block. It will destroy the mpv_handle, and exit immediately, + * while other mpv_handles might still be uninitializing. + * + * Before mpv client API version 1.29: + * If this is called on a mpv_handle that was not created with mpv_create(), + * this function will merely send a quit command and then call + * mpv_destroy(), without waiting for the actual shutdown. + */ +MPV_EXPORT void mpv_terminate_destroy(mpv_handle *ctx); + +/** + * Create a new client handle connected to the same player core as ctx. This + * context has its own event queue, its own mpv_request_event() state, its own + * mpv_request_log_messages() state, its own set of observed properties, and + * its own state for asynchronous operations. Otherwise, everything is shared. + * + * This handle should be destroyed with mpv_destroy() if no longer + * needed. The core will live as long as there is at least 1 handle referencing + * it. Any handle can make the core quit, which will result in every handle + * receiving MPV_EVENT_SHUTDOWN. + * + * This function can not be called before the main handle was initialized with + * mpv_initialize(). The new handle is always initialized, unless ctx=NULL was + * passed. + * + * @param ctx Used to get the reference to the mpv core; handle-specific + * settings and parameters are not used. + * If NULL, this function behaves like mpv_create() (ignores name). + * @param name The client name. This will be returned by mpv_client_name(). If + * the name is already in use, or contains non-alphanumeric + * characters (other than '_'), the name is modified to fit. + * If NULL, an arbitrary name is automatically chosen. + * @return a new handle, or NULL on error + */ +MPV_EXPORT mpv_handle *mpv_create_client(mpv_handle *ctx, const char *name); + +/** + * This is the same as mpv_create_client(), but the created mpv_handle is + * treated as a weak reference. If all mpv_handles referencing a core are + * weak references, the core is automatically destroyed. (This still goes + * through normal uninit of course. Effectively, if the last non-weak mpv_handle + * is destroyed, then the weak mpv_handles receive MPV_EVENT_SHUTDOWN and are + * asked to terminate as well.) + * + * Note if you want to use this like refcounting: you have to be aware that + * mpv_terminate_destroy() _and_ mpv_destroy() for the last non-weak + * mpv_handle will block until all weak mpv_handles are destroyed. + */ +MPV_EXPORT mpv_handle *mpv_create_weak_client(mpv_handle *ctx, const char *name); + +/** + * Load a config file. This loads and parses the file, and sets every entry in + * the config file's default section as if mpv_set_option_string() is called. + * + * The filename should be an absolute path. If it isn't, the actual path used + * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the + * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. + * + * If a fatal error happens when parsing a config file, MPV_ERROR_OPTION_ERROR + * is returned. Errors when setting options as well as other types or errors + * are ignored (even if options do not exist). You can still try to capture + * the resulting error messages with mpv_request_log_messages(). Note that it's + * possible that some options were successfully set even if any of these errors + * happen. + * + * @param filename absolute path to the config file on the local filesystem + * @return error code + */ +MPV_EXPORT int mpv_load_config_file(mpv_handle *ctx, const char *filename); + +/** + * Return the internal time in microseconds. This has an arbitrary start offset, + * but will never wrap or go backwards. + * + * Note that this is always the real time, and doesn't necessarily have to do + * with playback time. For example, playback could go faster or slower due to + * playback speed, or due to playback being paused. Use the "time-pos" property + * instead to get the playback status. + * + * Unlike other libmpv APIs, this can be called at absolutely any time (even + * within wakeup callbacks), as long as the context is valid. + * + * Safe to be called from mpv render API threads. + */ +MPV_EXPORT int64_t mpv_get_time_us(mpv_handle *ctx); + +/** + * Data format for options and properties. The API functions to get/set + * properties and options support multiple formats, and this enum describes + * them. + */ +typedef enum mpv_format { + /** + * Invalid. Sometimes used for empty values. This is always defined to 0, + * so a normal 0-init of mpv_format (or e.g. mpv_node) is guaranteed to set + * this it to MPV_FORMAT_NONE (which makes some things saner as consequence). + */ + MPV_FORMAT_NONE = 0, + /** + * The basic type is char*. It returns the raw property string, like + * using ${=property} in input.conf (see input.rst). + * + * NULL isn't an allowed value. + * + * Warning: although the encoding is usually UTF-8, this is not always the + * case. File tags often store strings in some legacy codepage, + * and even filenames don't necessarily have to be in UTF-8 (at + * least on Linux). If you pass the strings to code that requires + * valid UTF-8, you have to sanitize it in some way. + * On Windows, filenames are always UTF-8, and libmpv converts + * between UTF-8 and UTF-16 when using win32 API functions. See + * the "Encoding of filenames" section for details. + * + * Example for reading: + * + * char *result = NULL; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_STRING, &result) < 0) + * goto error; + * printf("%s\n", result); + * mpv_free(result); + * + * Or just use mpv_get_property_string(). + * + * Example for writing: + * + * char *value = "the new value"; + * // yep, you pass the address to the variable + * // (needed for symmetry with other types and mpv_get_property) + * mpv_set_property(ctx, "property", MPV_FORMAT_STRING, &value); + * + * Or just use mpv_set_property_string(). + * + */ + MPV_FORMAT_STRING = 1, + /** + * The basic type is char*. It returns the OSD property string, like + * using ${property} in input.conf (see input.rst). In many cases, this + * is the same as the raw string, but in other cases it's formatted for + * display on OSD. It's intended to be human readable. Do not attempt to + * parse these strings. + * + * Only valid when doing read access. The rest works like MPV_FORMAT_STRING. + */ + MPV_FORMAT_OSD_STRING = 2, + /** + * The basic type is int. The only allowed values are 0 ("no") + * and 1 ("yes"). + * + * Example for reading: + * + * int result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_FLAG, &result) < 0) + * goto error; + * printf("%s\n", result ? "true" : "false"); + * + * Example for writing: + * + * int flag = 1; + * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); + */ + MPV_FORMAT_FLAG = 3, + /** + * The basic type is int64_t. + */ + MPV_FORMAT_INT64 = 4, + /** + * The basic type is double. + */ + MPV_FORMAT_DOUBLE = 5, + /** + * The type is mpv_node. + * + * For reading, you usually would pass a pointer to a stack-allocated + * mpv_node value to mpv, and when you're done you call + * mpv_free_node_contents(&node). + * You're expected not to write to the data - if you have to, copy it + * first (which you have to do manually). + * + * For writing, you construct your own mpv_node, and pass a pointer to the + * API. The API will never write to your data (and copy it if needed), so + * you're free to use any form of allocation or memory management you like. + * + * Warning: when reading, always check the mpv_node.format member. For + * example, properties might change their type in future versions + * of mpv, or sometimes even during runtime. + * + * Example for reading: + * + * mpv_node result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_NODE, &result) < 0) + * goto error; + * printf("format=%d\n", (int)result.format); + * mpv_free_node_contents(&result). + * + * Example for writing: + * + * mpv_node value; + * value.format = MPV_FORMAT_STRING; + * value.u.string = "hello"; + * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); + */ + MPV_FORMAT_NODE = 6, + /** + * Used with mpv_node only. Can usually not be used directly. + */ + MPV_FORMAT_NODE_ARRAY = 7, + /** + * See MPV_FORMAT_NODE_ARRAY. + */ + MPV_FORMAT_NODE_MAP = 8, + /** + * A raw, untyped byte array. Only used only with mpv_node, and only in + * some very specific situations. (Some commands use it.) + */ + MPV_FORMAT_BYTE_ARRAY = 9 +} mpv_format; + +/** + * Generic data storage. + * + * If mpv writes this struct (e.g. via mpv_get_property()), you must not change + * the data. In some cases (mpv_get_property()), you have to free it with + * mpv_free_node_contents(). If you fill this struct yourself, you're also + * responsible for freeing it, and you must not call mpv_free_node_contents(). + */ +typedef struct mpv_node { + union { + char *string; /** valid if format==MPV_FORMAT_STRING */ + int flag; /** valid if format==MPV_FORMAT_FLAG */ + int64_t int64; /** valid if format==MPV_FORMAT_INT64 */ + double double_; /** valid if format==MPV_FORMAT_DOUBLE */ + /** + * valid if format==MPV_FORMAT_NODE_ARRAY + * or if format==MPV_FORMAT_NODE_MAP + */ + struct mpv_node_list *list; + /** + * valid if format==MPV_FORMAT_BYTE_ARRAY + */ + struct mpv_byte_array *ba; + } u; + /** + * Type of the data stored in this struct. This value rules what members in + * the given union can be accessed. The following formats are currently + * defined to be allowed in mpv_node: + * + * MPV_FORMAT_STRING (u.string) + * MPV_FORMAT_FLAG (u.flag) + * MPV_FORMAT_INT64 (u.int64) + * MPV_FORMAT_DOUBLE (u.double_) + * MPV_FORMAT_NODE_ARRAY (u.list) + * MPV_FORMAT_NODE_MAP (u.list) + * MPV_FORMAT_BYTE_ARRAY (u.ba) + * MPV_FORMAT_NONE (no member) + * + * If you encounter a value you don't know, you must not make any + * assumptions about the contents of union u. + */ + mpv_format format; +} mpv_node; + +/** + * (see mpv_node) + */ +typedef struct mpv_node_list { + /** + * Number of entries. Negative values are not allowed. + */ + int num; + /** + * MPV_FORMAT_NODE_ARRAY: + * values[N] refers to value of the Nth item + * + * MPV_FORMAT_NODE_MAP: + * values[N] refers to value of the Nth key/value pair + * + * If num > 0, values[0] to values[num-1] (inclusive) are valid. + * Otherwise, this can be NULL. + */ + mpv_node *values; + /** + * MPV_FORMAT_NODE_ARRAY: + * unused (typically NULL), access is not allowed + * + * MPV_FORMAT_NODE_MAP: + * keys[N] refers to key of the Nth key/value pair. If num > 0, keys[0] to + * keys[num-1] (inclusive) are valid. Otherwise, this can be NULL. + * The keys are in random order. The only guarantee is that keys[N] belongs + * to the value values[N]. NULL keys are not allowed. + */ + char **keys; +} mpv_node_list; + +/** + * (see mpv_node) + */ +typedef struct mpv_byte_array { + /** + * Pointer to the data. In what format the data is stored is up to whatever + * uses MPV_FORMAT_BYTE_ARRAY. + */ + void *data; + /** + * Size of the data pointed to by ptr. + */ + size_t size; +} mpv_byte_array; + +/** + * Frees any data referenced by the node. It doesn't free the node itself. + * Call this only if the mpv client API set the node. If you constructed the + * node yourself (manually), you have to free it yourself. + * + * If node->format is MPV_FORMAT_NONE, this call does nothing. Likewise, if + * the client API sets a node with this format, this function doesn't need to + * be called. (This is just a clarification that there's no danger of anything + * strange happening in these cases.) + */ +MPV_EXPORT void mpv_free_node_contents(mpv_node *node); + +/** + * Set an option. Note that you can't normally set options during runtime. It + * works in uninitialized state (see mpv_create()), and in some cases in at + * runtime. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. + * + * Note: this is semi-deprecated. For most purposes, this is not needed anymore. + * Starting with mpv version 0.21.0 (version 1.23) most options can be set + * with mpv_set_property() (and related functions), and even before + * mpv_initialize(). In some obscure corner cases, using this function + * to set options might still be required (see + * "Inconsistencies between options and properties" in the manpage). Once + * these are resolved, the option setting functions might be fully + * deprecated. + * + * @param name Option name. This is the same as on the mpv command line, but + * without the leading "--". + * @param format see enum mpv_format. + * @param[in] data Option value (according to the format). + * @return error code + */ +MPV_EXPORT int mpv_set_option(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Convenience function to set an option to a string value. This is like + * calling mpv_set_option() with MPV_FORMAT_STRING. + * + * @return error code + */ +MPV_EXPORT int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data); + +/** + * Send a command to the player. Commands are the same as those used in + * input.conf, except that this function takes parameters in a pre-split + * form. + * + * The commands and their parameters are documented in input.rst. + * + * Does not use OSD and string expansion by default (unlike mpv_command_string() + * and input.conf). + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @return error code + */ +MPV_EXPORT int mpv_command(mpv_handle *ctx, const char **args); + +/** + * Same as mpv_command(), but allows passing structured data in any format. + * In particular, calling mpv_command() is exactly like calling + * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and + * every arg passed in order as MPV_FORMAT_STRING. + * + * Does not use OSD and string expansion by default. + * + * The args argument can have one of the following formats: + * + * MPV_FORMAT_NODE_ARRAY: + * Positional arguments. Each entry is an argument using an arbitrary + * format (the format must be compatible to the used command). Usually, + * the first item is the command name (as MPV_FORMAT_STRING). The order + * of arguments is as documented in each command description. + * + * MPV_FORMAT_NODE_MAP: + * Named arguments. This requires at least an entry with the key "name" + * to be present, which must be a string, and contains the command name. + * The special entry "_flags" is optional, and if present, must be an + * array of strings, each being a command prefix to apply. All other + * entries are interpreted as arguments. They must use the argument names + * as documented in each command description. Some commands do not + * support named arguments at all, and must use MPV_FORMAT_NODE_ARRAY. + * + * @param[in] args mpv_node with format set to one of the values documented + * above (see there for details) + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific return + * data. You must call mpv_free_node_contents() to free it + * (again, only if the command actually succeeds). + * Not many commands actually use this at all. + * @return error code (the result parameter is not set on error) + */ +MPV_EXPORT int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); + +/** + * This is essentially identical to mpv_command() but it also returns a result. + * + * Does not use OSD and string expansion by default. + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific return + * data. You must call mpv_free_node_contents() to free it + * (again, only if the command actually succeeds). + * Not many commands actually use this at all. + * @return error code (the result parameter is not set on error) + */ +MPV_EXPORT int mpv_command_ret(mpv_handle *ctx, const char **args, mpv_node *result); + +/** + * Same as mpv_command, but use input.conf parsing for splitting arguments. + * This is slightly simpler, but also more error prone, since arguments may + * need quoting/escaping. + * + * This also has OSD and string expansion enabled by default. + */ +MPV_EXPORT int mpv_command_string(mpv_handle *ctx, const char *args); + +/** + * Same as mpv_command, but run the command asynchronously. + * + * Commands are executed asynchronously. You will receive a + * MPV_EVENT_COMMAND_REPLY event. This event will also have an + * error code set if running the command failed. For commands that + * return data, the data is put into mpv_event_command.result. + * + * The only case when you do not receive an event is when the function call + * itself fails. This happens only if parsing the command itself (or otherwise + * validating it) fails, i.e. the return code of the API call is not 0 or + * positive. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args NULL-terminated list of strings (see mpv_command()) + * @return error code (if parsing or queuing the command fails) + */ +MPV_EXPORT int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, + const char **args); + +/** + * Same as mpv_command_node(), but run it asynchronously. Basically, this + * function is to mpv_command_node() what mpv_command_async() is to + * mpv_command(). + * + * See mpv_command_async() for details. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args as in mpv_command_node() + * @return error code (if parsing or queuing the command fails) + */ +MPV_EXPORT int mpv_command_node_async(mpv_handle *ctx, uint64_t reply_userdata, + mpv_node *args); + +/** + * Signal to all async requests with the matching ID to abort. This affects + * the following API calls: + * + * mpv_command_async + * mpv_command_node_async + * + * All of these functions take a reply_userdata parameter. This API function + * tells all requests with the matching reply_userdata value to try to return + * as soon as possible. If there are multiple requests with matching ID, it + * aborts all of them. + * + * This API function is mostly asynchronous itself. It will not wait until the + * command is aborted. Instead, the command will terminate as usual, but with + * some work not done. How this is signaled depends on the specific command (for + * example, the "subprocess" command will indicate it by "killed_by_us" set to + * true in the result). How long it takes also depends on the situation. The + * aborting process is completely asynchronous. + * + * Not all commands may support this functionality. In this case, this function + * will have no effect. The same is true if the request using the passed + * reply_userdata has already terminated, has not been started yet, or was + * never in use at all. + * + * You have to be careful of race conditions: the time during which the abort + * request will be effective is _after_ e.g. mpv_command_async() has returned, + * and before the command has signaled completion with MPV_EVENT_COMMAND_REPLY. + * + * @param reply_userdata ID of the request to be aborted (see above) + */ +MPV_EXPORT void mpv_abort_async_command(mpv_handle *ctx, uint64_t reply_userdata); + +/** + * Set a property to a given value. Properties are essentially variables which + * can be queried or set at runtime. For example, writing to the pause property + * will actually pause or unpause playback. + * + * If the format doesn't match with the internal format of the property, access + * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data + * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 + * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING + * usually invokes a string parser. The same happens when calling this function + * with MPV_FORMAT_NODE: the underlying format may be converted to another + * type if possible. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. (Before API version 1.21, this was different.) + * + * Note: starting with mpv 0.21.0 (client API version 1.23), this can be used to + * set options in general. It even can be used before mpv_initialize() + * has been called. If called before mpv_initialize(), setting properties + * not backed by options will result in MPV_ERROR_PROPERTY_UNAVAILABLE. + * In some cases, properties and options still conflict. In these cases, + * mpv_set_property() accesses the options before mpv_initialize(), and + * the properties after mpv_initialize(). These conflicts will be removed + * in mpv 0.23.0. See mpv_set_option() for further remarks. + * + * @param name The property name. See input.rst for a list of properties. + * @param format see enum mpv_format. + * @param[in] data Option value. + * @return error code + */ +MPV_EXPORT int mpv_set_property(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Convenience function to set a property to a string value. + * + * This is like calling mpv_set_property() with MPV_FORMAT_STRING. + */ +MPV_EXPORT int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data); + +/** + * Convenience function to delete a property. + * + * This is equivalent to running the command "del [name]". + * + * @param name The property name. See input.rst for a list of properties. + * @return error code + */ +MPV_EXPORT int mpv_del_property(mpv_handle *ctx, const char *name); + +/** + * Set a property asynchronously. You will receive the result of the operation + * as MPV_EVENT_SET_PROPERTY_REPLY event. The mpv_event.error field will contain + * the result status of the operation. Otherwise, this function is similar to + * mpv_set_property(). + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @param[in] data Option value. The value will be copied by the function. It + * will never be modified by the client API. + * @return error code if sending the request failed + */ +MPV_EXPORT int mpv_set_property_async(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, mpv_format format, void *data); + +/** + * Read the value of the given property. + * + * If the format doesn't match with the internal format of the property, access + * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data + * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 + * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING + * usually invokes a string formatter. + * + * @param name The property name. + * @param format see enum mpv_format. + * @param[out] data Pointer to the variable holding the option value. On + * success, the variable will be set to a copy of the option + * value. For formats that require dynamic memory allocation, + * you can free the value with mpv_free() (strings) or + * mpv_free_node_contents() (MPV_FORMAT_NODE). + * @return error code + */ +MPV_EXPORT int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format, + void *data); + +/** + * Return the value of the property with the given name as string. This is + * equivalent to mpv_get_property() with MPV_FORMAT_STRING. + * + * See MPV_FORMAT_STRING for character encoding issues. + * + * On error, NULL is returned. Use mpv_get_property() if you want fine-grained + * error reporting. + * + * @param name The property name. + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ +MPV_EXPORT char *mpv_get_property_string(mpv_handle *ctx, const char *name); + +/** + * Return the property as "OSD" formatted string. This is the same as + * mpv_get_property_string, but using MPV_FORMAT_OSD_STRING. + * + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ +MPV_EXPORT char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name); + +/** + * Get a property asynchronously. You will receive the result of the operation + * as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event. + * You should check the mpv_event.error field on the reply event. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @return error code if sending the request failed + */ +MPV_EXPORT int mpv_get_property_async(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, mpv_format format); + +/** + * Get a notification whenever the given property changes. You will receive + * updates as MPV_EVENT_PROPERTY_CHANGE. Note that this is not very precise: + * for some properties, it may not send updates even if the property changed. + * This depends on the property, and it's a valid feature request to ask for + * better update handling of a specific property. (For some properties, like + * ``clock``, which shows the wall clock, this mechanism doesn't make too + * much sense anyway.) + * + * Property changes are coalesced: the change events are returned only once the + * event queue becomes empty (e.g. mpv_wait_event() would block or return + * MPV_EVENT_NONE), and then only one event per changed property is returned. + * + * You always get an initial change notification. This is meant to initialize + * the user's state to the current value of the property. + * + * Normally, change events are sent only if the property value changes according + * to the requested format. mpv_event_property will contain the property value + * as data member. + * + * Warning: if a property is unavailable or retrieving it caused an error, + * MPV_FORMAT_NONE will be set in mpv_event_property, even if the + * format parameter was set to a different value. In this case, the + * mpv_event_property.data field is invalid. + * + * If the property is observed with the format parameter set to MPV_FORMAT_NONE, + * you get low-level notifications whether the property _may_ have changed, and + * the data member in mpv_event_property will be unset. With this mode, you + * will have to determine yourself whether the property really changed. On the + * other hand, this mechanism can be faster and uses less resources. + * + * Observing a property that doesn't exist is allowed. (Although it may still + * cause some sporadic change events.) + * + * Keep in mind that you will get change notifications even if you change a + * property yourself. Try to avoid endless feedback loops, which could happen + * if you react to the change notifications triggered by your own change. + * + * Only the mpv_handle on which this was called will receive the property + * change events, or can unobserve them. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_PROPERTY_CHANGE + * events. (Also see section about asynchronous calls, + * although this function is somewhat different from + * actual asynchronous calls.) + * If you have no use for this, pass 0. + * Also see mpv_unobserve_property(). + * @param name The property name. + * @param format see enum mpv_format. Can be MPV_FORMAT_NONE to omit values + * from the change events. + * @return error code (usually fails only on OOM or unsupported format) + */ +MPV_EXPORT int mpv_observe_property(mpv_handle *mpv, uint64_t reply_userdata, + const char *name, mpv_format format); + +/** + * Undo mpv_observe_property(). This will remove all observed properties for + * which the given number was passed as reply_userdata to mpv_observe_property. + * + * Safe to be called from mpv render API threads. + * + * @param registered_reply_userdata ID that was passed to mpv_observe_property + * @return negative value is an error code, >=0 is number of removed properties + * on success (includes the case when 0 were removed) + */ +MPV_EXPORT int mpv_unobserve_property(mpv_handle *mpv, uint64_t registered_reply_userdata); + +typedef enum mpv_event_id { + /** + * Nothing happened. Happens on timeouts or sporadic wakeups. + */ + MPV_EVENT_NONE = 0, + /** + * Happens when the player quits. The player enters a state where it tries + * to disconnect all clients. Most requests to the player will fail, and + * the client should react to this and quit with mpv_destroy() as soon as + * possible. + */ + MPV_EVENT_SHUTDOWN = 1, + /** + * See mpv_request_log_messages(). + */ + MPV_EVENT_LOG_MESSAGE = 2, + /** + * Reply to a mpv_get_property_async() request. + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_GET_PROPERTY_REPLY = 3, + /** + * Reply to a mpv_set_property_async() request. + * (Unlike MPV_EVENT_GET_PROPERTY, mpv_event_property is not used.) + */ + MPV_EVENT_SET_PROPERTY_REPLY = 4, + /** + * Reply to a mpv_command_async() or mpv_command_node_async() request. + * See also mpv_event and mpv_event_command. + */ + MPV_EVENT_COMMAND_REPLY = 5, + /** + * Notification before playback start of a file (before the file is loaded). + * See also mpv_event and mpv_event_start_file. + */ + MPV_EVENT_START_FILE = 6, + /** + * Notification after playback end (after the file was unloaded). + * See also mpv_event and mpv_event_end_file. + */ + MPV_EVENT_END_FILE = 7, + /** + * Notification when the file has been loaded (headers were read etc.), and + * decoding starts. + */ + MPV_EVENT_FILE_LOADED = 8, +#if MPV_ENABLE_DEPRECATED + /** + * Idle mode was entered. In this mode, no file is played, and the playback + * core waits for new commands. (The command line player normally quits + * instead of entering idle mode, unless --idle was specified. If mpv + * was started with mpv_create(), idle mode is enabled by default.) + * + * @deprecated This is equivalent to using mpv_observe_property() on the + * "idle-active" property. The event is redundant, and might be + * removed in the far future. As a further warning, this event + * is not necessarily sent at the right point anymore (at the + * start of the program), while the property behaves correctly. + */ + MPV_EVENT_IDLE = 11, + /** + * Sent every time after a video frame is displayed. Note that currently, + * this will be sent in lower frequency if there is no video, or playback + * is paused - but that will be removed in the future, and it will be + * restricted to video frames only. + * + * @deprecated Use mpv_observe_property() with relevant properties instead + * (such as "playback-time"). + */ + MPV_EVENT_TICK = 14, +#endif + /** + * Triggered by the script-message input command. The command uses the + * first argument of the command as client name (see mpv_client_name()) to + * dispatch the message, and passes along all arguments starting from the + * second argument as strings. + * See also mpv_event and mpv_event_client_message. + */ + MPV_EVENT_CLIENT_MESSAGE = 16, + /** + * Happens after video changed in some way. This can happen on resolution + * changes, pixel format changes, or video filter changes. The event is + * sent after the video filters and the VO are reconfigured. Applications + * embedding a mpv window should listen to this event in order to resize + * the window if needed. + * Note that this event can happen sporadically, and you should check + * yourself whether the video parameters really changed before doing + * something expensive. + */ + MPV_EVENT_VIDEO_RECONFIG = 17, + /** + * Similar to MPV_EVENT_VIDEO_RECONFIG. This is relatively uninteresting, + * because there is no such thing as audio output embedding. + */ + MPV_EVENT_AUDIO_RECONFIG = 18, + /** + * Happens when a seek was initiated. Playback stops. Usually it will + * resume with MPV_EVENT_PLAYBACK_RESTART as soon as the seek is finished. + */ + MPV_EVENT_SEEK = 20, + /** + * There was a discontinuity of some sort (like a seek), and playback + * was reinitialized. Usually happens on start of playback and after + * seeking. The main purpose is allowing the client to detect when a seek + * request is finished. + */ + MPV_EVENT_PLAYBACK_RESTART = 21, + /** + * Event sent due to mpv_observe_property(). + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_PROPERTY_CHANGE = 22, + /** + * Happens if the internal per-mpv_handle ringbuffer overflows, and at + * least 1 event had to be dropped. This can happen if the client doesn't + * read the event queue quickly enough with mpv_wait_event(), or if the + * client makes a very large number of asynchronous calls at once. + * + * Event delivery will continue normally once this event was returned + * (this forces the client to empty the queue completely). + */ + MPV_EVENT_QUEUE_OVERFLOW = 24, + /** + * Triggered if a hook handler was registered with mpv_hook_add(), and the + * hook is invoked. If you receive this, you must handle it, and continue + * the hook with mpv_hook_continue(). + * See also mpv_event and mpv_event_hook. + */ + MPV_EVENT_HOOK = 25, + // Internal note: adjust INTERNAL_EVENT_BASE when adding new events. +} mpv_event_id; + +/** + * Return a string describing the event. For unknown events, NULL is returned. + * + * Note that all events actually returned by the API will also yield a non-NULL + * string with this function. + * + * @param event event ID, see see enum mpv_event_id + * @return A static string giving a short symbolic name of the event. It + * consists of lower-case alphanumeric characters and can include "-" + * characters. This string is suitable for use in e.g. scripting + * interfaces. + * The string is completely static, i.e. doesn't need to be deallocated, + * and is valid forever. + */ +MPV_EXPORT const char *mpv_event_name(mpv_event_id event); + +typedef struct mpv_event_property { + /** + * Name of the property. + */ + const char *name; + /** + * Format of the data field in the same struct. See enum mpv_format. + * This is always the same format as the requested format, except when + * the property could not be retrieved (unavailable, or an error happened), + * in which case the format is MPV_FORMAT_NONE. + */ + mpv_format format; + /** + * Received property value. Depends on the format. This is like the + * pointer argument passed to mpv_get_property(). + * + * For example, for MPV_FORMAT_STRING you get the string with: + * + * char *value = *(char **)(event_property->data); + * + * Note that this is set to NULL if retrieving the property failed (the + * format will be MPV_FORMAT_NONE). + */ + void *data; +} mpv_event_property; + +/** + * Numeric log levels. The lower the number, the more important the message is. + * MPV_LOG_LEVEL_NONE is never used when receiving messages. The string in + * the comment after the value is the name of the log level as used for the + * mpv_request_log_messages() function. + * Unused numeric values are unused, but reserved for future use. + */ +typedef enum mpv_log_level { + MPV_LOG_LEVEL_NONE = 0, /// "no" - disable absolutely all messages + MPV_LOG_LEVEL_FATAL = 10, /// "fatal" - critical/aborting errors + MPV_LOG_LEVEL_ERROR = 20, /// "error" - simple errors + MPV_LOG_LEVEL_WARN = 30, /// "warn" - possible problems + MPV_LOG_LEVEL_INFO = 40, /// "info" - informational message + MPV_LOG_LEVEL_V = 50, /// "v" - noisy informational message + MPV_LOG_LEVEL_DEBUG = 60, /// "debug" - very noisy technical information + MPV_LOG_LEVEL_TRACE = 70, /// "trace" - extremely noisy +} mpv_log_level; + +typedef struct mpv_event_log_message { + /** + * The module prefix, identifies the sender of the message. As a special + * case, if the message buffer overflows, this will be set to the string + * "overflow" (which doesn't appear as prefix otherwise), and the text + * field will contain an informative message. + */ + const char *prefix; + /** + * The log level as string. See mpv_request_log_messages() for possible + * values. The level "no" is never used here. + */ + const char *level; + /** + * The log message. It consists of 1 line of text, and is terminated with + * a newline character. (Before API version 1.6, it could contain multiple + * or partial lines.) + */ + const char *text; + /** + * The same contents as the level field, but as a numeric ID. + * Since API version 1.6. + */ + mpv_log_level log_level; +} mpv_event_log_message; + +/// Since API version 1.9. +typedef enum mpv_end_file_reason { + /** + * The end of file was reached. Sometimes this may also happen on + * incomplete or corrupted files, or if the network connection was + * interrupted when playing a remote file. It also happens if the + * playback range was restricted with --end or --frames or similar. + */ + MPV_END_FILE_REASON_EOF = 0, + /** + * Playback was stopped by an external action (e.g. playlist controls). + */ + MPV_END_FILE_REASON_STOP = 2, + /** + * Playback was stopped by the quit command or player shutdown. + */ + MPV_END_FILE_REASON_QUIT = 3, + /** + * Some kind of error happened that lead to playback abort. Does not + * necessarily happen on incomplete or broken files (in these cases, both + * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). + * + * mpv_event_end_file.error will be set. + */ + MPV_END_FILE_REASON_ERROR = 4, + /** + * The file was a playlist or similar. When the playlist is read, its + * entries will be appended to the playlist after the entry of the current + * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE + * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then + * playback continues with the playlist contents. + * Since API version 1.18. + */ + MPV_END_FILE_REASON_REDIRECT = 5, +} mpv_end_file_reason; + +/// Since API version 1.108. +typedef struct mpv_event_start_file { + /** + * Playlist entry ID of the file being loaded now. + */ + int64_t playlist_entry_id; +} mpv_event_start_file; + +typedef struct mpv_event_end_file { + /** + * Corresponds to the values in enum mpv_end_file_reason. + * + * Unknown values should be treated as unknown. + */ + mpv_end_file_reason reason; + /** + * If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code + * (one of MPV_ERROR_...) giving an approximate reason why playback + * failed. In other cases, this field is 0 (no error). + * Since API version 1.9. + */ + int error; + /** + * Playlist entry ID of the file that was being played or attempted to be + * played. This has the same value as the playlist_entry_id field in the + * corresponding mpv_event_start_file event. + * Since API version 1.108. + */ + int64_t playlist_entry_id; + /** + * If loading ended, because the playlist entry to be played was for example + * a playlist, and the current playlist entry is replaced with a number of + * other entries. This may happen at least with MPV_END_FILE_REASON_REDIRECT + * (other event types may use this for similar but different purposes in the + * future). In this case, playlist_insert_id will be set to the playlist + * entry ID of the first inserted entry, and playlist_insert_num_entries to + * the total number of inserted playlist entries. Note this in this specific + * case, the ID of the last inserted entry is playlist_insert_id+num-1. + * Beware that depending on circumstances, you may observe the new playlist + * entries before seeing the event (e.g. reading the "playlist" property or + * getting a property change notification before receiving the event). + * Since API version 1.108. + */ + int64_t playlist_insert_id; + /** + * See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never + * negative. + * Since API version 1.108. + */ + int playlist_insert_num_entries; +} mpv_event_end_file; + +typedef struct mpv_event_client_message { + /** + * Arbitrary arguments chosen by the sender of the message. If num_args > 0, + * you can access args[0] through args[num_args - 1] (inclusive). What + * these arguments mean is up to the sender and receiver. + * None of the valid items are NULL. + */ + int num_args; + const char **args; +} mpv_event_client_message; + +typedef struct mpv_event_hook { + /** + * The hook name as passed to mpv_hook_add(). + */ + const char *name; + /** + * Internal ID that must be passed to mpv_hook_continue(). + */ + uint64_t id; +} mpv_event_hook; + +// Since API version 1.102. +typedef struct mpv_event_command { + /** + * Result data of the command. Note that success/failure is signaled + * separately via mpv_event.error. This field is only for result data + * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set + * to MPV_FORMAT_NONE on failure. + */ + mpv_node result; +} mpv_event_command; + +typedef struct mpv_event { + /** + * One of mpv_event. Keep in mind that later ABI compatible releases might + * add new event types. These should be ignored by the API user. + */ + mpv_event_id event_id; + /** + * This is mainly used for events that are replies to (asynchronous) + * requests. It contains a status code, which is >= 0 on success, or < 0 + * on error (a mpv_error value). Usually, this will be set if an + * asynchronous request fails. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + */ + int error; + /** + * If the event is in reply to a request (made with this API and this + * API handle), this is set to the reply_userdata parameter of the request + * call. Otherwise, this field is 0. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + * MPV_EVENT_PROPERTY_CHANGE + * MPV_EVENT_HOOK + */ + uint64_t reply_userdata; + /** + * The meaning and contents of the data member depend on the event_id: + * MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* + * MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* + * MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* + * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* + * MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) + * MPV_EVENT_END_FILE: mpv_event_end_file* + * MPV_EVENT_HOOK: mpv_event_hook* + * MPV_EVENT_COMMAND_REPLY* mpv_event_command* + * other: NULL + * + * Note: future enhancements might add new event structs for existing or new + * event types. + */ + void *data; +} mpv_event; + +/** + * Convert the given src event to a mpv_node, and set *dst to the result. *dst + * is set to a MPV_FORMAT_NODE_MAP, with fields for corresponding mpv_event and + * mpv_event.data/mpv_event_* fields. + * + * The exact details are not completely documented out of laziness. A start + * is located in the "Events" section of the manpage. + * + * *dst may point to newly allocated memory, or pointers in mpv_event. You must + * copy the entire mpv_node if you want to reference it after mpv_event becomes + * invalid (such as making a new mpv_wait_event() call, or destroying the + * mpv_handle from which it was returned). Call mpv_free_node_contents() to free + * any memory allocations made by this API function. + * + * Safe to be called from mpv render API threads. + * + * @param dst Target. This is not read and fully overwritten. Must be released + * with mpv_free_node_contents(). Do not write to pointers returned + * by it. (On error, this may be left as an empty node.) + * @param src The source event. Not modified (it's not const due to the author's + * prejudice of the C version of const). + * @return error code (MPV_ERROR_NOMEM only, if at all) + */ +MPV_EXPORT int mpv_event_to_node(mpv_node *dst, mpv_event *src); + +/** + * Enable or disable the given event. + * + * Some events are enabled by default. Some events can't be disabled. + * + * (Informational note: currently, all events are enabled by default, except + * MPV_EVENT_TICK.) + * + * Safe to be called from mpv render API threads. + * + * @param event See enum mpv_event_id. + * @param enable 1 to enable receiving this event, 0 to disable it. + * @return error code + */ +MPV_EXPORT int mpv_request_event(mpv_handle *ctx, mpv_event_id event, int enable); + +/** + * Enable or disable receiving of log messages. These are the messages the + * command line player prints to the terminal. This call sets the minimum + * required log level for a message to be received with MPV_EVENT_LOG_MESSAGE. + * + * @param min_level Minimal log level as string. Valid log levels: + * no fatal error warn info v debug trace + * The value "no" disables all messages. This is the default. + * An exception is the value "terminal-default", which uses the + * log level as set by the "--msg-level" option. This works + * even if the terminal is disabled. (Since API version 1.19.) + * Also see mpv_log_level. + * @return error code + */ +MPV_EXPORT int mpv_request_log_messages(mpv_handle *ctx, const char *min_level); + +/** + * Wait for the next event, or until the timeout expires, or if another thread + * makes a call to mpv_wakeup(). Passing 0 as timeout will never wait, and + * is suitable for polling. + * + * The internal event queue has a limited size (per client handle). If you + * don't empty the event queue quickly enough with mpv_wait_event(), it will + * overflow and silently discard further events. If this happens, making + * asynchronous requests will fail as well (with MPV_ERROR_EVENT_QUEUE_FULL). + * + * Only one thread is allowed to call this on the same mpv_handle at a time. + * The API won't complain if more than one thread calls this, but it will cause + * race conditions in the client when accessing the shared mpv_event struct. + * Note that most other API functions are not restricted by this, and no API + * function internally calls mpv_wait_event(). Additionally, concurrent calls + * to different mpv_handles are always safe. + * + * As long as the timeout is 0, this is safe to be called from mpv render API + * threads. + * + * @param timeout Timeout in seconds, after which the function returns even if + * no event was received. A MPV_EVENT_NONE is returned on + * timeout. A value of 0 will disable waiting. Negative values + * will wait with an infinite timeout. + * @return A struct containing the event ID and other data. The pointer (and + * fields in the struct) stay valid until the next mpv_wait_event() + * call, or until the mpv_handle is destroyed. You must not write to + * the struct, and all memory referenced by it will be automatically + * released by the API on the next mpv_wait_event() call, or when the + * context is destroyed. The return value is never NULL. + */ +MPV_EXPORT mpv_event *mpv_wait_event(mpv_handle *ctx, double timeout); + +/** + * Interrupt the current mpv_wait_event() call. This will wake up the thread + * currently waiting in mpv_wait_event(). If no thread is waiting, the next + * mpv_wait_event() call will return immediately (this is to avoid lost + * wakeups). + * + * mpv_wait_event() will receive a MPV_EVENT_NONE if it's woken up due to + * this call. But note that this dummy event might be skipped if there are + * already other events queued. All what counts is that the waiting thread + * is woken up at all. + * + * Safe to be called from mpv render API threads. + */ +MPV_EXPORT void mpv_wakeup(mpv_handle *ctx); + +/** + * Set a custom function that should be called when there are new events. Use + * this if blocking in mpv_wait_event() to wait for new events is not feasible. + * + * Keep in mind that the callback will be called from foreign threads. You + * must not make any assumptions of the environment, and you must return as + * soon as possible (i.e. no long blocking waits). Exiting the callback through + * any other means than a normal return is forbidden (no throwing exceptions, + * no longjmp() calls). You must not change any local thread state (such as + * the C floating point environment). + * + * You are not allowed to call any client API functions inside of the callback. + * In particular, you should not do any processing in the callback, but wake up + * another thread that does all the work. The callback is meant strictly for + * notification only, and is called from arbitrary core parts of the player, + * that make no considerations for reentrant API use or allowing the callee to + * spend a lot of time doing other things. Keep in mind that it's also possible + * that the callback is called from a thread while a mpv API function is called + * (i.e. it can be reentrant). + * + * In general, the client API expects you to call mpv_wait_event() to receive + * notifications, and the wakeup callback is merely a helper utility to make + * this easier in certain situations. Note that it's possible that there's + * only one wakeup callback invocation for multiple events. You should call + * mpv_wait_event() with no timeout until MPV_EVENT_NONE is reached, at which + * point the event queue is empty. + * + * If you actually want to do processing in a callback, spawn a thread that + * does nothing but call mpv_wait_event() in a loop and dispatches the result + * to a callback. + * + * Only one wakeup callback can be set. + * + * @param cb function that should be called if a wakeup is required + * @param d arbitrary userdata passed to cb + */ +MPV_EXPORT void mpv_set_wakeup_callback(mpv_handle *ctx, void (*cb)(void *d), void *d); + +/** + * Block until all asynchronous requests are done. This affects functions like + * mpv_command_async(), which return immediately and return their result as + * events. + * + * This is a helper, and somewhat equivalent to calling mpv_wait_event() in a + * loop until all known asynchronous requests have sent their reply as event, + * except that the event queue is not emptied. + * + * In case you called mpv_suspend() before, this will also forcibly reset the + * suspend counter of the given handle. + */ +MPV_EXPORT void mpv_wait_async_requests(mpv_handle *ctx); + +/** + * A hook is like a synchronous event that blocks the player. You register + * a hook handler with this function. You will get an event, which you need + * to handle, and once things are ready, you can let the player continue with + * mpv_hook_continue(). + * + * Currently, hooks can't be removed explicitly. But they will be implicitly + * removed if the mpv_handle it was registered with is destroyed. This also + * continues the hook if it was being handled by the destroyed mpv_handle (but + * this should be avoided, as it might mess up order of hook execution). + * + * Hook handlers are ordered globally by priority and order of registration. + * Handlers for the same hook with same priority are invoked in order of + * registration (the handler registered first is run first). Handlers with + * lower priority are run first (which seems backward). + * + * See the "Hooks" section in the manpage to see which hooks are currently + * defined. + * + * Some hooks might be reentrant (so you get multiple MPV_EVENT_HOOK for the + * same hook). If this can happen for a specific hook type, it will be + * explicitly documented in the manpage. + * + * Only the mpv_handle on which this was called will receive the hook events, + * or can "continue" them. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_HOOK events. + * If you have no use for this, pass 0. + * @param name The hook name. This should be one of the documented names. But + * if the name is unknown, the hook event will simply be never + * raised. + * @param priority See remarks above. Use 0 as a neutral default. + * @return error code (usually fails only on OOM) + */ +MPV_EXPORT int mpv_hook_add(mpv_handle *ctx, uint64_t reply_userdata, + const char *name, int priority); + +/** + * Respond to a MPV_EVENT_HOOK event. You must call this after you have handled + * the event. There is no way to "cancel" or "stop" the hook. + * + * Calling this will will typically unblock the player for whatever the hook + * is responsible for (e.g. for the "on_load" hook it lets it continue + * playback). + * + * It is explicitly undefined behavior to call this more than once for each + * MPV_EVENT_HOOK, to pass an incorrect ID, or to call this on a mpv_handle + * different from the one that registered the handler and received the event. + * + * @param id This must be the value of the mpv_event_hook.id field for the + * corresponding MPV_EVENT_HOOK. + * @return error code + */ +MPV_EXPORT int mpv_hook_continue(mpv_handle *ctx, uint64_t id); + +#if MPV_ENABLE_DEPRECATED + +/** + * Return a UNIX file descriptor referring to the read end of a pipe. This + * pipe can be used to wake up a poll() based processing loop. The purpose of + * this function is very similar to mpv_set_wakeup_callback(), and provides + * a primitive mechanism to handle coordinating a foreign event loop and the + * libmpv event loop. The pipe is non-blocking. It's closed when the mpv_handle + * is destroyed. This function always returns the same value (on success). + * + * This is in fact implemented using the same underlying code as for + * mpv_set_wakeup_callback() (though they don't conflict), and it is as if each + * callback invocation writes a single 0 byte to the pipe. When the pipe + * becomes readable, the code calling poll() (or select()) on the pipe should + * read all contents of the pipe and then call mpv_wait_event(c, 0) until + * no new events are returned. The pipe contents do not matter and can just + * be discarded. There is not necessarily one byte per readable event in the + * pipe. For example, the pipes are non-blocking, and mpv won't block if the + * pipe is full. Pipes are normally limited to 4096 bytes, so if there are + * more than 4096 events, the number of readable bytes can not equal the number + * of events queued. Also, it's possible that mpv does not write to the pipe + * once it's guaranteed that the client was already signaled. See the example + * below how to do it correctly. + * + * Example: + * + * int pipefd = mpv_get_wakeup_pipe(mpv); + * if (pipefd < 0) + * error(); + * while (1) { + * struct pollfd pfds[1] = { + * { .fd = pipefd, .events = POLLIN }, + * }; + * // Wait until there are possibly new mpv events. + * poll(pfds, 1, -1); + * if (pfds[0].revents & POLLIN) { + * // Empty the pipe. Doing this before calling mpv_wait_event() + * // ensures that no wakeups are missed. It's not so important to + * // make sure the pipe is really empty (it will just cause some + * // additional wakeups in unlikely corner cases). + * char unused[256]; + * read(pipefd, unused, sizeof(unused)); + * while (1) { + * mpv_event *ev = mpv_wait_event(mpv, 0); + * // If MPV_EVENT_NONE is received, the event queue is empty. + * if (ev->event_id == MPV_EVENT_NONE) + * break; + * // Process the event. + * ... + * } + * } + * } + * + * @deprecated this function will be removed in the future. If you need this + * functionality, use mpv_set_wakeup_callback(), create a pipe + * manually, and call write() on your pipe in the callback. + * + * @return A UNIX FD of the read end of the wakeup pipe, or -1 on error. + * On MS Windows/MinGW, this will always return -1. + */ +MPV_EXPORT int mpv_get_wakeup_pipe(mpv_handle *ctx); + +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h new file mode 100644 index 000000000..29f9b91e9 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h @@ -0,0 +1,738 @@ +/* Copyright (C) 2018 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_RENDER_H_ +#define MPV_CLIENT_API_RENDER_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Overview + * -------- + * + * This API can be used to make mpv render using supported graphic APIs (such + * as OpenGL). It can be used to handle video display. + * + * The renderer needs to be created with mpv_render_context_create() before + * you start playback (or otherwise cause a VO to be created). Then (with most + * backends) mpv_render_context_render() can be used to explicitly render the + * current video frame. Use mpv_render_context_set_update_callback() to get + * notified when there is a new frame to draw. + * + * Preferably rendering should be done in a separate thread. If you call + * normal libmpv API functions on the renderer thread, deadlocks can result + * (these are made non-fatal with timeouts, but user experience will obviously + * suffer). See "Threading" section below. + * + * You can output and embed video without this API by setting the mpv "wid" + * option to a native window handle (see "Embedding the video window" section + * in the client.h header). In general, using the render API is recommended, + * because window embedding can cause various issues, especially with GUI + * toolkits and certain platforms. + * + * Supported backends + * ------------------ + * + * OpenGL: via MPV_RENDER_API_TYPE_OPENGL, see render_gl.h header. + * Software: via MPV_RENDER_API_TYPE_SW, see section "Software renderer" + * + * Threading + * --------- + * + * You are recommended to do rendering on a separate thread than normal libmpv + * use. + * + * The mpv_render_* functions can be called from any thread, under the + * following conditions: + * - only one of the mpv_render_* functions can be called at the same time + * (unless they belong to different mpv cores created by mpv_create()) + * - never can be called from within the callbacks set with + * mpv_set_wakeup_callback() or mpv_render_context_set_update_callback() + * - if the OpenGL backend is used, for all functions the OpenGL context + * must be "current" in the calling thread, and it must be the same OpenGL + * context as the mpv_render_context was created with. Otherwise, undefined + * behavior will occur. + * - the thread does not call libmpv API functions other than the mpv_render_* + * functions, except APIs which are declared as safe (see below). Likewise, + * there must be no lock or wait dependency from the render thread to a + * thread using other libmpv functions. Basically, the situation that your + * render thread waits for a "not safe" libmpv API function to return must + * not happen. If you ignore this requirement, deadlocks can happen, which + * are made non-fatal with timeouts; then playback quality will be degraded, + * and the message + * mpv_render_context_render() not being called or stuck. + * is logged. If you set MPV_RENDER_PARAM_ADVANCED_CONTROL, you promise that + * this won't happen, and must absolutely guarantee it, or a real deadlock + * will freeze the mpv core thread forever. + * + * libmpv functions which are safe to call from a render thread are: + * - functions marked with "Safe to be called from mpv render API threads." + * - client.h functions which don't have an explicit or implicit mpv_handle + * parameter + * - mpv_render_* functions; but only for the same mpv_render_context pointer. + * If the pointer is different, mpv_render_context_free() is not safe. (The + * reason is that if MPV_RENDER_PARAM_ADVANCED_CONTROL is set, it may have + * to process still queued requests from the core, which it can do only for + * the current context, while requests for other contexts would deadlock. + * Also, it may have to wait and block for the core to terminate the video + * chain to make sure no resources are used after context destruction.) + * - if the mpv_handle parameter refers to a different mpv core than the one + * you're rendering for (very obscure, but allowed) + * + * Note about old libmpv version: + * + * Before API version 1.105 (basically in mpv 0.29.x), simply enabling + * MPV_RENDER_PARAM_ADVANCED_CONTROL could cause deadlock issues. This can + * be worked around by setting the "vd-lavc-dr" option to "no". + * In addition, you were required to call all mpv_render*() API functions + * from the same thread on which mpv_render_context_create() was originally + * run (for the same the mpv_render_context). Not honoring it led to UB + * (deadlocks, use of invalid pthread_t handles), even if you moved your GL + * context to a different thread correctly. + * These problems were addressed in API version 1.105 (mpv 0.30.0). + * + * Context and handle lifecycle + * ---------------------------- + * + * Video initialization will fail if the render context was not initialized yet + * (with mpv_render_context_create()), or it will revert to a VO that creates + * its own window. + * + * Currently, there can be only 1 mpv_render_context at a time per mpv core. + * + * Calling mpv_render_context_free() while a VO is using the render context is + * active will disable video. + * + * You must free the context with mpv_render_context_free() before the mpv core + * is destroyed. If this doesn't happen, undefined behavior will result. + * + * Software renderer + * ----------------- + * + * MPV_RENDER_API_TYPE_SW provides an extremely simple (but slow) renderer to + * memory surfaces. You probably don't want to use this. Use other render API + * types, or other methods of video embedding. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_SW. + * + * Call mpv_render_context_render() with various MPV_RENDER_PARAM_SW_* fields + * to render the video frame to an in-memory surface. The following fields are + * required: MPV_RENDER_PARAM_SW_SIZE, MPV_RENDER_PARAM_SW_FORMAT, + * MPV_RENDER_PARAM_SW_STRIDE, MPV_RENDER_PARAM_SW_POINTER. + * + * This method of rendering is very slow, because everything, including color + * conversion, scaling, and OSD rendering, is done on the CPU, single-threaded. + * In particular, large video or display sizes, as well as presence of OSD or + * subtitles can make it too slow for realtime. As with other software rendering + * VOs, setting "sw-fast" may help. Enabling or disabling zimg may help, + * depending on the platform. + * + * In addition, certain multimedia job creation measures like HDR may not work + * properly, and will have to be manually handled by for example inserting + * filters. + * + * This API is not really suitable to extract individual frames from video etc. + * (basically non-playback uses) - there are better libraries for this. It can + * be used this way, but it may be clunky and tricky. + * + * Further notes: + * - MPV_RENDER_PARAM_FLIP_Y is currently ignored (unsupported) + * - MPV_RENDER_PARAM_DEPTH is ignored (meaningless) + */ + +/** + * Opaque context, returned by mpv_render_context_create(). + */ +typedef struct mpv_render_context mpv_render_context; + +/** + * Parameters for mpv_render_param (which is used in a few places such as + * mpv_render_context_create(). + * + * Also see mpv_render_param for conventions and how to use it. + */ +typedef enum mpv_render_param_type { + /** + * Not a valid value, but also used to terminate a params array. Its value + * is always guaranteed to be 0 (even if the ABI changes in the future). + */ + MPV_RENDER_PARAM_INVALID = 0, + /** + * The render API to use. Valid for mpv_render_context_create(). + * + * Type: char* + * + * Defined APIs: + * + * MPV_RENDER_API_TYPE_OPENGL: + * OpenGL desktop 2.1 or later (preferably core profile compatible to + * OpenGL 3.2), or OpenGLES 2.0 or later. + * Providing MPV_RENDER_PARAM_OPENGL_INIT_PARAMS is required. + * It is expected that an OpenGL context is valid and "current" when + * calling mpv_render_* functions (unless specified otherwise). It + * must be the same context for the same mpv_render_context. + */ + MPV_RENDER_PARAM_API_TYPE = 1, + /** + * Required parameters for initializing the OpenGL renderer. Valid for + * mpv_render_context_create(). + * Type: mpv_opengl_init_params* + */ + MPV_RENDER_PARAM_OPENGL_INIT_PARAMS = 2, + /** + * Describes a GL render target. Valid for mpv_render_context_render(). + * Type: mpv_opengl_fbo* + */ + MPV_RENDER_PARAM_OPENGL_FBO = 3, + /** + * Control flipped rendering. Valid for mpv_render_context_render(). + * Type: int* + * If the value is set to 0, render normally. Otherwise, render it flipped, + * which is needed e.g. when rendering to an OpenGL default framebuffer + * (which has a flipped coordinate system). + */ + MPV_RENDER_PARAM_FLIP_Y = 4, + /** + * Control surface depth. Valid for mpv_render_context_render(). + * Type: int* + * This implies the depth of the surface passed to the render function in + * bits per channel. If omitted or set to 0, the renderer will assume 8. + * Typically used to control dithering. + */ + MPV_RENDER_PARAM_DEPTH = 5, + /** + * ICC profile blob. Valid for mpv_render_context_set_parameter(). + * Type: mpv_byte_array* + * Set an ICC profile for use with the "icc-profile-auto" option. (If the + * option is not enabled, the ICC data will not be used.) + */ + MPV_RENDER_PARAM_ICC_PROFILE = 6, + /** + * Ambient light in lux. Valid for mpv_render_context_set_parameter(). + * Type: int* + * This can be used for automatic gamma correction. + */ + MPV_RENDER_PARAM_AMBIENT_LIGHT = 7, + /** + * X11 Display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The Display must stay valid for the lifetime + * of the mpv_render_context. + * Type: Display* + */ + MPV_RENDER_PARAM_X11_DISPLAY = 8, + /** + * Wayland display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The wl_display must stay valid for the + * lifetime of the mpv_render_context. + * Type: struct wl_display* + */ + MPV_RENDER_PARAM_WL_DISPLAY = 9, + /** + * Better control about rendering and enabling some advanced features. Valid + * for mpv_render_context_create(). + * + * This conflates multiple requirements the API user promises to abide if + * this option is enabled: + * + * - The API user's render thread, which is calling the mpv_render_*() + * functions, never waits for the core. Otherwise deadlocks can happen. + * See "Threading" section. + * - The callback set with mpv_render_context_set_update_callback() can now + * be called even if there is no new frame. The API user should call the + * mpv_render_context_update() function, and interpret the return value + * for whether a new frame should be rendered. + * - Correct functionality is impossible if the update callback is not set, + * or not set soon enough after mpv_render_context_create() (the core can + * block while waiting for you to call mpv_render_context_update(), and + * if the update callback is not correctly set, it will deadlock, or + * block for too long). + * + * In general, setting this option will enable the following features (and + * possibly more): + * + * - "Direct rendering", which means the player decodes directly to a + * texture, which saves a copy per video frame ("vd-lavc-dr" option + * needs to be enabled, and the rendering backend as well as the + * underlying GPU API/driver needs to have support for it). + * - Rendering screenshots with the GPU API if supported by the backend + * (instead of using a suboptimal software fallback via libswscale). + * + * Warning: do not just add this without reading the "Threading" section + * above, and then wondering that deadlocks happen. The + * requirements are tricky. But also note that even if advanced + * control is disabled, not adhering to the rules will lead to + * playback problems. Enabling advanced controls simply makes + * violating these rules fatal. + * + * Type: int*: 0 for disable (default), 1 for enable + */ + MPV_RENDER_PARAM_ADVANCED_CONTROL = 10, + /** + * Return information about the next frame to render. Valid for + * mpv_render_context_get_info(). + * + * Type: mpv_render_frame_info* + * + * It strictly returns information about the _next_ frame. The implication + * is that e.g. mpv_render_context_update()'s return value will have + * MPV_RENDER_UPDATE_FRAME set, and the user is supposed to call + * mpv_render_context_render(). If there is no next frame, then the + * return value will have is_valid set to 0. + */ + MPV_RENDER_PARAM_NEXT_FRAME_INFO = 11, + /** + * Enable or disable video timing. Valid for mpv_render_context_render(). + * + * Type: int*: 0 for disable, 1 for enable (default) + * + * When video is timed to audio, the player attempts to render video a bit + * ahead, and then do a blocking wait until the target display time is + * reached. This blocks mpv_render_context_render() for up to the amount + * specified with the "video-timing-offset" global option. You can set + * this parameter to 0 to disable this kind of waiting. If you do, it's + * recommended to use the target time value in mpv_render_frame_info to + * wait yourself, or to set the "video-timing-offset" to 0 instead. + * + * Disabling this without doing anything in addition will result in A/V sync + * being slightly off. + */ + MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, + /** + * Use to skip rendering in mpv_render_context_render(). + * + * Type: int*: 0 for rendering (default), 1 for skipping + * + * If this is set, you don't need to pass a target surface to the render + * function (and if you do, it's completely ignored). This can still call + * into the lower level APIs (i.e. if you use OpenGL, the OpenGL context + * must be set). + * + * Be aware that the render API will consider this frame as having been + * rendered. All other normal rules also apply, for example about whether + * you have to call mpv_render_context_report_swap(). It also does timing + * in the same way. + */ + MPV_RENDER_PARAM_SKIP_RENDERING = 13, + /** + * Deprecated. Not supported. Use MPV_RENDER_PARAM_DRM_DISPLAY_V2 instead. + * Type : struct mpv_opengl_drm_params* + */ + MPV_RENDER_PARAM_DRM_DISPLAY = 14, + /** + * DRM draw surface size, contains draw surface dimensions. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_draw_surface_size* + */ + MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE = 15, + /** + * DRM display, contains drm display handles. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_params_v2* + */ + MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];) + * + * The video frame is transformed as with other VOs. Typically, this means + * the video gets scaled and black bars are added if the video size or + * aspect ratio mismatches with the target size. + */ + MPV_RENDER_PARAM_SW_SIZE = 17, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: char* (e.g.: char *f = "rgb0"; param.data = f;) + * + * Valid values are: + * "rgb0", "bgr0", "0bgr", "0rgb" + * 4 bytes per pixel RGB, 1 byte (8 bit) per component, component bytes + * with increasing address from left to right (e.g. "rgb0" has r at + * address 0), the "0" component contains uninitialized garbage (often + * the value 0, but not necessarily; the bad naming is inherited from + * FFmpeg) + * Pixel alignment size: 4 bytes + * "rgb24" + * 3 bytes per pixel RGB. This is strongly discouraged because it is + * very slow. + * Pixel alignment size: 1 bytes + * other + * The API may accept other pixel formats, using mpv internal format + * names, as long as it's internally marked as RGB, has exactly 1 + * plane, and is supported as conversion output. It is not a good idea + * to rely on any of these. Their semantics and handling could change. + */ + MPV_RENDER_PARAM_SW_FORMAT = 18, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: size_t* + * + * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the + * target surface. It must be a multiple of the pixel size, and have space + * for the surface width as specified by MPV_RENDER_PARAM_SW_SIZE. + * + * Both stride and pointer value should be a multiple of 64 to facilitate + * fast SIMD operation. Lower alignment might trigger slower code paths, + * and in the worst case, will copy the entire target frame. If mpv is built + * with zimg (and zimg is not disabled), the performance impact might be + * less. + * In either cases, the pointer and stride must be aligned at least to the + * pixel alignment size. Otherwise, crashes and undefined behavior is + * possible on platforms which do not support unaligned accesses (either + * through normal memory access or aligned SIMD memory access instructions). + */ + MPV_RENDER_PARAM_SW_STRIDE = 19, + /* + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data pointer, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: void* + * + * This points to the first pixel at the left/top corner (0, 0). In + * particular, each line y starts at (pointer + stride * y). Upon rendering, + * all data between pointer and (pointer + stride * h) is overwritten. + * Whether the padding between (w, y) and (0, y + 1) is overwritten is left + * unspecified (it should not be, but unfortunately some scaler backends + * will do it anyway). It is assumed that even the padding after the last + * line (starting at bytepos(w, h) until (pointer + stride * h)) is + * writable. + * + * See MPV_RENDER_PARAM_SW_STRIDE for alignment requirements. + */ + MPV_RENDER_PARAM_SW_POINTER = 20, +} mpv_render_param_type; + +/** + * For backwards compatibility with the old naming of + * MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + */ +#define MPV_RENDER_PARAM_DRM_OSD_SIZE MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + +/** + * Used to pass arbitrary parameters to some mpv_render_* functions. The + * meaning of the data parameter is determined by the type, and each + * MPV_RENDER_PARAM_* documents what type the value must point to. + * + * Each value documents the required data type as the pointer you cast to + * void* and set on mpv_render_param.data. For example, if MPV_RENDER_PARAM_FOO + * documents the type as Something* , then the code should look like this: + * + * Something foo = {...}; + * mpv_render_param param; + * param.type = MPV_RENDER_PARAM_FOO; + * param.data = & foo; + * + * Normally, the data field points to exactly 1 object. If the type is char*, + * it points to a 0-terminated string. + * + * In all cases (unless documented otherwise) the pointers need to remain + * valid during the call only. Unless otherwise documented, the API functions + * will not write to the params array or any data pointed to it. + * + * As a convention, parameter arrays are always terminated by type==0. There + * is no specific order of the parameters required. The order of the 2 fields in + * this struct is guaranteed (even after ABI changes). + */ +typedef struct mpv_render_param { + enum mpv_render_param_type type; + void *data; +} mpv_render_param; + + +/** + * Predefined values for MPV_RENDER_PARAM_API_TYPE. + */ +// See render_gl.h +#define MPV_RENDER_API_TYPE_OPENGL "opengl" +// See section "Software renderer" +#define MPV_RENDER_API_TYPE_SW "sw" + +/** + * Flags used in mpv_render_frame_info.flags. Each value represents a bit in it. + */ +typedef enum mpv_render_frame_info_flag { + /** + * Set if there is actually a next frame. If unset, there is no next frame + * yet, and other flags and fields that require a frame to be queued will + * be unset. + * + * This is set for _any_ kind of frame, even for redraw requests. + * + * Note that when this is unset, it simply means no new frame was + * decoded/queued yet, not necessarily that the end of the video was + * reached. A new frame can be queued after some time. + * + * If the return value of mpv_render_context_render() had the + * MPV_RENDER_UPDATE_FRAME flag set, this flag will usually be set as well, + * unless the frame is rendered, or discarded by other asynchronous events. + */ + MPV_RENDER_FRAME_INFO_PRESENT = 1 << 0, + /** + * If set, the frame is not an actual new video frame, but a redraw request. + * For example if the video is paused, and an option that affects video + * rendering was changed (or any other reason), an update request can be + * issued and this flag will be set. + * + * Typically, redraw frames will not be subject to video timing. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REDRAW = 1 << 1, + /** + * If set, this is supposed to reproduce the previous frame perfectly. This + * is usually used for certain "video-sync" options ("display-..." modes). + * Typically the renderer will blit the video from a FBO. Unset otherwise. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, + /** + * If set, the player timing code expects that the user thread blocks on + * vsync (by either delaying the render call, or by making a call to + * mpv_render_context_report_swap() at vsync time). + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, +} mpv_render_frame_info_flag; + +/** + * Information about the next video frame that will be rendered. Can be + * retrieved with MPV_RENDER_PARAM_NEXT_FRAME_INFO. + */ +typedef struct mpv_render_frame_info { + /** + * A bitset of mpv_render_frame_info_flag values (i.e. multiple flags are + * combined with bitwise or). + */ + uint64_t flags; + /** + * Absolute time at which the frame is supposed to be displayed. This is in + * the same unit and base as the time returned by mpv_get_time_us(). For + * frames that are redrawn, or if vsync locked video timing is used (see + * "video-sync" option), then this can be 0. The "video-timing-offset" + * option determines how much "headroom" the render thread gets (but a high + * enough frame rate can reduce it anyway). mpv_render_context_render() will + * normally block until the time is elapsed, unless you pass it + * MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 0. + */ + int64_t target_time; +} mpv_render_frame_info; + +/** + * Initialize the renderer state. Depending on the backend used, this will + * access the underlying GPU API and initialize its own objects. + * + * You must free the context with mpv_render_context_free(). Not doing so before + * the mpv core is destroyed may result in memory leaks or crashes. + * + * Currently, only at most 1 context can exists per mpv core (it represents the + * main video output). + * + * You should pass the following parameters: + * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API. + * - Backend-specific init parameter, like MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is + * strongly recommended. + * - If you want to use hwdec, possibly hwdec interop resources. + * + * @param res set to the context (on success) or NULL (on failure). The value + * is never read and always overwritten. + * @param mpv handle used to get the core (the mpv_render_context won't depend + * on this specific handle, only the core referenced by it) + * @param params an array of parameters, terminated by type==0. It's left + * unspecified what happens with unknown parameters. At least + * MPV_RENDER_PARAM_API_TYPE is required, and most backends will + * require another backend-specific parameter. + * @return error code, including but not limited to: + * MPV_ERROR_UNSUPPORTED: the OpenGL version is not supported + * (or required extensions are missing) + * MPV_ERROR_NOT_IMPLEMENTED: an unknown API type was provided, or + * support for the requested API was not + * built in the used libmpv binary. + * MPV_ERROR_INVALID_PARAMETER: at least one of the provided parameters was + * not valid. + */ +MPV_EXPORT int mpv_render_context_create(mpv_render_context **res, mpv_handle *mpv, + mpv_render_param *params); + +/** + * Attempt to change a single parameter. Not all backends and parameter types + * support all kinds of changes. + * + * @param ctx a valid render context + * @param param the parameter type and data that should be set + * @return error code. If a parameter could actually be changed, this returns + * success, otherwise an error code depending on the parameter type + * and situation. + */ +MPV_EXPORT int mpv_render_context_set_parameter(mpv_render_context *ctx, + mpv_render_param param); + +/** + * Retrieve information from the render context. This is NOT a counterpart to + * mpv_render_context_set_parameter(), because you generally can't read + * parameters set with it, and this function is not meant for this purpose. + * Instead, this is for communicating information from the renderer back to the + * user. See mpv_render_param_type; entries which support this function + * explicitly mention it, and for other entries you can assume it will fail. + * + * You pass param with param.type set and param.data pointing to a variable + * of the required data type. The function will then overwrite that variable + * with the returned value (at least on success). + * + * @param ctx a valid render context + * @param param the parameter type and data that should be retrieved + * @return error code. If a parameter could actually be retrieved, this returns + * success, otherwise an error code depending on the parameter type + * and situation. MPV_ERROR_NOT_IMPLEMENTED is used for unknown + * param.type, or if retrieving it is not supported. + */ +MPV_EXPORT int mpv_render_context_get_info(mpv_render_context *ctx, + mpv_render_param param); + +typedef void (*mpv_render_update_fn)(void *cb_ctx); + +/** + * Set the callback that notifies you when a new video frame is available, or + * if the video display configuration somehow changed and requires a redraw. + * Similar to mpv_set_wakeup_callback(), you must not call any mpv API from + * the callback, and all the other listed restrictions apply (such as not + * exiting the callback by throwing exceptions). + * + * This can be called from any thread, except from an update callback. In case + * of the OpenGL backend, no OpenGL state or API is accessed. + * + * Calling this will raise an update callback immediately. + * + * @param callback callback(callback_ctx) is called if the frame should be + * redrawn + * @param callback_ctx opaque argument to the callback + */ +MPV_EXPORT void mpv_render_context_set_update_callback(mpv_render_context *ctx, + mpv_render_update_fn callback, + void *callback_ctx); + +/** + * The API user is supposed to call this when the update callback was invoked + * (like all mpv_render_* functions, this has to happen on the render thread, + * and _not_ from the update callback itself). + * + * This is optional if MPV_RENDER_PARAM_ADVANCED_CONTROL was not set (default). + * Otherwise, it's a hard requirement that this is called after each update + * callback. If multiple update callback happened, and the function could not + * be called sooner, it's OK to call it once after the last callback. + * + * If an update callback happens during or after this function, the function + * must be called again at the soonest possible time. + * + * If MPV_RENDER_PARAM_ADVANCED_CONTROL was set, this will do additional work + * such as allocating textures for the video decoder. + * + * @return a bitset of mpv_render_update_flag values (i.e. multiple flags are + * combined with bitwise or). Typically, this will tell the API user + * what should happen next. E.g. if the MPV_RENDER_UPDATE_FRAME flag is + * set, mpv_render_context_render() should be called. If flags unknown + * to the API user are set, or if the return value is 0, nothing needs + * to be done. + */ +MPV_EXPORT uint64_t mpv_render_context_update(mpv_render_context *ctx); + +/** + * Flags returned by mpv_render_context_update(). Each value represents a bit + * in the function's return value. + */ +typedef enum mpv_render_update_flag { + /** + * A new video frame must be rendered. mpv_render_context_render() must be + * called. + */ + MPV_RENDER_UPDATE_FRAME = 1 << 0, +} mpv_render_context_flag; + +/** + * Render video. + * + * Typically renders the video to a target surface provided via mpv_render_param + * (the details depend on the backend in use). Options like "panscan" are + * applied to determine which part of the video should be visible and how the + * video should be scaled. You can change these options at runtime by using the + * mpv property API. + * + * The renderer will reconfigure itself every time the target surface + * configuration (such as size) is changed. + * + * This function implicitly pulls a video frame from the internal queue and + * renders it. If no new frame is available, the previous frame is redrawn. + * The update callback set with mpv_render_context_set_update_callback() + * notifies you when a new frame was added. The details potentially depend on + * the backends and the provided parameters. + * + * Generally, libmpv will invoke your update callback some time before the video + * frame should be shown, and then lets this function block until the supposed + * display time. This will limit your rendering to video FPS. You can prevent + * this by setting the "video-timing-offset" global option to 0. (This applies + * only to "audio" video sync mode.) + * + * You should pass the following parameters: + * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO. + * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y. + * + * @param ctx a valid render context + * @param params an array of parameters, terminated by type==0. Which parameters + * are required depends on the backend. It's left unspecified what + * happens with unknown parameters. + * @return error code + */ +MPV_EXPORT int mpv_render_context_render(mpv_render_context *ctx, mpv_render_param *params); + +/** + * Tell the renderer that a frame was flipped at the given time. This is + * optional, but can help the player to achieve better timing. + * + * Note that calling this at least once informs libmpv that you will use this + * function. If you use it inconsistently, expect bad video playback. + * + * If this is called while no video is initialized, it is ignored. + * + * @param ctx a valid render context + */ +MPV_EXPORT void mpv_render_context_report_swap(mpv_render_context *ctx); + +/** + * Destroy the mpv renderer state. + * + * If video is still active (e.g. a file playing), video will be disabled + * forcefully. + * + * @param ctx a valid render context. After this function returns, this is not + * a valid pointer anymore. NULL is also allowed and does nothing. + */ +MPV_EXPORT void mpv_render_context_free(mpv_render_context *ctx); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h new file mode 100644 index 000000000..a2c31f0c7 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h @@ -0,0 +1,211 @@ +/* Copyright (C) 2018 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_RENDER_GL_H_ +#define MPV_CLIENT_API_RENDER_GL_H_ + +#include "render.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * OpenGL backend + * -------------- + * + * This header contains definitions for using OpenGL with the render.h API. + * + * OpenGL interop + * -------------- + * + * The OpenGL backend has some special rules, because OpenGL itself uses + * implicit per-thread contexts, which causes additional API problems. + * + * This assumes the OpenGL context lives on a certain thread controlled by the + * API user. All mpv_render_* APIs have to be assumed to implicitly use the + * OpenGL context if you pass a mpv_render_context using the OpenGL backend, + * unless specified otherwise. + * + * The OpenGL context is indirectly accessed through the OpenGL function + * pointers returned by the get_proc_address callback in mpv_opengl_init_params. + * Generally, mpv will not load the system OpenGL library when using this API. + * + * OpenGL state + * ------------ + * + * OpenGL has a large amount of implicit state. All the mpv functions mentioned + * above expect that the OpenGL state is reasonably set to OpenGL standard + * defaults. Likewise, mpv will attempt to leave the OpenGL context with + * standard defaults. The following state is excluded from this: + * + * - the glViewport state + * - the glScissor state (but GL_SCISSOR_TEST is in its default value) + * - glBlendFuncSeparate() state (but GL_BLEND is in its default value) + * - glClearColor() state + * - mpv may overwrite the callback set with glDebugMessageCallback() + * - mpv always disables GL_DITHER at init + * + * Messing with the state could be avoided by creating shared OpenGL contexts, + * but this is avoided for the sake of compatibility and interoperability. + * + * On OpenGL 2.1, mpv will strictly call functions like glGenTextures() to + * create OpenGL objects. You will have to do the same. This ensures that + * objects created by mpv and the API users don't clash. Also, legacy state + * must be either in its defaults, or not interfere with core state. + * + * API use + * ------- + * + * The mpv_render_* API is used. That API supports multiple backends, and this + * section documents specifics for the OpenGL backend. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_OPENGL, and MPV_RENDER_PARAM_OPENGL_INIT_PARAMS provided. + * + * Call mpv_render_context_render() with MPV_RENDER_PARAM_OPENGL_FBO to render + * the video frame to an FBO. + * + * Hardware decoding + * ----------------- + * + * Hardware decoding via this API is fully supported, but requires some + * additional setup. (At least if direct hardware decoding modes are wanted, + * instead of copying back surface data from GPU to CPU RAM.) + * + * There may be certain requirements on the OpenGL implementation: + * + * - Windows: ANGLE is required (although in theory GL/DX interop could be used) + * - Intel/Linux: EGL is required, and also the native display resource needs + * to be provided (e.g. MPV_RENDER_PARAM_X11_DISPLAY for X11 and + * MPV_RENDER_PARAM_WL_DISPLAY for Wayland) + * - nVidia/Linux: Both GLX and EGL should work (GLX is required if vdpau is + * used, e.g. due to old drivers.) + * - OSX: CGL is required (CGLGetCurrentContext() returning non-NULL) + * - iOS: EAGL is required (EAGLContext.currentContext returning non-nil) + * + * Once these things are setup, hardware decoding can be enabled/disabled at + * any time by setting the "hwdec" property. + */ + +/** + * For initializing the mpv OpenGL state via MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + */ +typedef struct mpv_opengl_init_params { + /** + * This retrieves OpenGL function pointers, and will use them in subsequent + * operation. + * Usually, you can simply call the GL context APIs from this callback (e.g. + * glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always + * return pointers for all standard functions (even if present); in this + * case you have to compensate by looking up these functions yourself when + * libmpv wants to resolve them through this callback. + * libmpv will not normally attempt to resolve GL functions on its own, nor + * does it link to GL libraries directly. + */ + void *(*get_proc_address)(void *ctx, const char *name); + /** + * Value passed as ctx parameter to get_proc_address(). + */ + void *get_proc_address_ctx; +} mpv_opengl_init_params; + +/** + * For MPV_RENDER_PARAM_OPENGL_FBO. + */ +typedef struct mpv_opengl_fbo { + /** + * Framebuffer object name. This must be either a valid FBO generated by + * glGenFramebuffers() that is complete and color-renderable, or 0. If the + * value is 0, this refers to the OpenGL default framebuffer. + */ + int fbo; + /** + * Valid dimensions. This must refer to the size of the framebuffer. This + * must always be set. + */ + int w, h; + /** + * Underlying texture internal format (e.g. GL_RGBA8), or 0 if unknown. If + * this is the default framebuffer, this can be an equivalent. + */ + int internal_format; +} mpv_opengl_fbo; + +/** + * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. + */ +typedef struct mpv_opengl_drm_params { + int fd; + int crtc_id; + int connector_id; + struct _drmModeAtomicReq **atomic_request_ptr; + int render_fd; +} mpv_opengl_drm_params; + +/** + * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. + */ +typedef struct mpv_opengl_drm_draw_surface_size { + /** + * size of the draw plane surface in pixels. + */ + int width, height; +} mpv_opengl_drm_draw_surface_size; + +/** + * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. + */ +typedef struct mpv_opengl_drm_params_v2 { + /** + * DRM fd (int). Set to -1 if invalid. + */ + int fd; + + /** + * Currently used crtc id + */ + int crtc_id; + + /** + * Currently used connector id + */ + int connector_id; + + /** + * Pointer to a drmModeAtomicReq pointer that is being used for the renderloop. + * This pointer should hold a pointer to the atomic request pointer + * The atomic request pointer is usually changed at every renderloop. + */ + struct _drmModeAtomicReq **atomic_request_ptr; + + /** + * DRM render node. Used for VAAPI interop. + * Set to -1 if invalid. + */ + int render_fd; +} mpv_opengl_drm_params_v2; + + +/** + * For backwards compatibility with the old naming of mpv_opengl_drm_draw_surface_size + */ +#define mpv_opengl_drm_osd_size mpv_opengl_drm_draw_surface_size + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h new file mode 100644 index 000000000..9d1c2cc8d --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h @@ -0,0 +1,240 @@ +/* Copyright (C) 2017 the mpv developers + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MPV_CLIENT_API_STREAM_CB_H_ +#define MPV_CLIENT_API_STREAM_CB_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Warning: this API is not stable yet. + * + * Overview + * -------- + * + * This API can be used to make mpv read from a stream with a custom + * implementation. This interface is inspired by funopen on BSD and + * fopencookie on linux. The stream is backed by user-defined callbacks + * which can implement customized open, read, seek, size and close behaviors. + * + * Usage + * ----- + * + * Register your stream callbacks with the mpv_stream_cb_add_ro() function. You + * have to provide a mpv_stream_cb_open_ro_fn callback to it (open_fn argument). + * + * Once registered, you can `loadfile myprotocol://myfile`. Your open_fn will be + * invoked with the URI and you must fill out the provided mpv_stream_cb_info + * struct. This includes your stream callbacks (like read_fn), and an opaque + * cookie, which will be passed as the first argument to all the remaining + * stream callbacks. + * + * Note that your custom callbacks must not invoke libmpv APIs as that would + * cause a deadlock. (Unless you call a different mpv_handle than the one the + * callback was registered for, and the mpv_handles refer to different mpv + * instances.) + * + * Stream lifetime + * --------------- + * + * A stream remains valid until its close callback has been called. It's up to + * libmpv to call the close callback, and the libmpv user cannot close it + * directly with the stream_cb API. + * + * For example, if you consider your custom stream to become suddenly invalid + * (maybe because the underlying stream died), libmpv will continue using your + * stream. All you can do is returning errors from each callback, until libmpv + * gives up and closes it. + * + * Protocol registration and lifetime + * ---------------------------------- + * + * Protocols remain registered until the mpv instance is terminated. This means + * in particular that it can outlive the mpv_handle that was used to register + * it, but once mpv_terminate_destroy() is called, your registered callbacks + * will not be called again. + * + * Protocol unregistration is finished after the mpv core has been destroyed + * (e.g. after mpv_terminate_destroy() has returned). + * + * If you do not call mpv_terminate_destroy() yourself (e.g. plugin-style code), + * you will have to deal with the registration or even streams outliving your + * code. Here are some possible ways to do this: + * - call mpv_terminate_destroy(), which destroys the core, and will make sure + * all streams are closed once this function returns + * - you refcount all resources your stream "cookies" reference, so that it + * doesn't matter if streams live longer than expected + * - create "cancellation" semantics: after your protocol has been unregistered, + * notify all your streams that are still opened, and make them drop all + * referenced resources - then return errors from the stream callbacks as + * long as the stream is still opened + * + */ + +/** + * Read callback used to implement a custom stream. The semantics of the + * callback match read(2) in blocking mode. Short reads are allowed (you can + * return less bytes than requested, and libmpv will retry reading the rest + * with another call). If no data can be immediately read, the callback must + * block until there is new data. A return of 0 will be interpreted as final + * EOF, although libmpv might retry the read, or seek to a different position. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param buf buffer to read data into + * @param size of the buffer + * @return number of bytes read into the buffer + * @return 0 on EOF + * @return -1 on error + */ +typedef int64_t (*mpv_stream_cb_read_fn)(void *cookie, char *buf, uint64_t nbytes); + +/** + * Seek callback used to implement a custom stream. + * + * Note that mpv will issue a seek to position 0 immediately after opening. This + * is used to test whether the stream is seekable (since seekability might + * depend on the URI contents, not just the protocol). Return + * MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This + * seek also serves to establish the fact that streams start at position 0. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param offset target absolute stream position + * @return the resulting offset of the stream + * MPV_ERROR_UNSUPPORTED or MPV_ERROR_GENERIC if the seek failed + */ +typedef int64_t (*mpv_stream_cb_seek_fn)(void *cookie, int64_t offset); + +/** + * Size callback used to implement a custom stream. + * + * Return MPV_ERROR_UNSUPPORTED if no size is known. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @return the total size in bytes of the stream + */ +typedef int64_t (*mpv_stream_cb_size_fn)(void *cookie); + +/** + * Close callback used to implement a custom stream. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ +typedef void (*mpv_stream_cb_close_fn)(void *cookie); + +/** + * Cancel callback used to implement a custom stream. + * + * This callback is used to interrupt any current or future read and seek + * operations. It will be called from a separate thread than the demux + * thread, and should not block. + * + * This callback can be NULL. + * + * Available since API 1.106. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ +typedef void (*mpv_stream_cb_cancel_fn)(void *cookie); + +/** + * See mpv_stream_cb_open_ro_fn callback. + */ +typedef struct mpv_stream_cb_info { + /** + * Opaque user-provided value, which will be passed to the other callbacks. + * The close callback will be called to release the cookie. It is not + * interpreted by mpv. It doesn't even need to be a valid pointer. + * + * The user sets this in the mpv_stream_cb_open_ro_fn callback. + */ + void *cookie; + + /** + * Callbacks set by the user in the mpv_stream_cb_open_ro_fn callback. Some + * of them are optional, and can be left unset. + * + * The following callbacks are mandatory: read_fn, close_fn + */ + mpv_stream_cb_read_fn read_fn; + mpv_stream_cb_seek_fn seek_fn; + mpv_stream_cb_size_fn size_fn; + mpv_stream_cb_close_fn close_fn; + mpv_stream_cb_cancel_fn cancel_fn; /* since API 1.106 */ +} mpv_stream_cb_info; + +/** + * Open callback used to implement a custom read-only (ro) stream. The user + * must set the callback fields in the passed info struct. The cookie field + * also can be set to store state associated to the stream instance. + * + * Note that the info struct is valid only for the duration of this callback. + * You can't change the callbacks or the pointer to the cookie at a later point. + * + * Each stream instance created by the open callback can have different + * callbacks. + * + * The close_fn callback will terminate the stream instance. The pointers to + * your callbacks and cookie will be discarded, and the callbacks will not be + * called again. + * + * @param user_data opaque user data provided via mpv_stream_cb_add() + * @param uri name of the stream to be opened (with protocol prefix) + * @param info fields which the user should fill + * @return 0 on success, MPV_ERROR_LOADING_FAILED if the URI cannot be opened. + */ +typedef int (*mpv_stream_cb_open_ro_fn)(void *user_data, char *uri, + mpv_stream_cb_info *info); + +/** + * Add a custom stream protocol. This will register a protocol handler under + * the given protocol prefix, and invoke the given callbacks if an URI with the + * matching protocol prefix is opened. + * + * The "ro" is for read-only - only read-only streams can be registered with + * this function. + * + * The callback remains registered until the mpv core is registered. + * + * If a custom stream with the same name is already registered, then the + * MPV_ERROR_INVALID_PARAMETER error is returned. + * + * @param protocol protocol prefix, for example "foo" for "foo://" URIs + * @param user_data opaque pointer passed into the mpv_stream_cb_open_fn + * callback. + * @return error code + */ +MPV_EXPORT int mpv_stream_cb_add_ro(mpv_handle *ctx, const char *protocol, void *user_data, + mpv_stream_cb_open_ro_fn open_fn); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c b/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c new file mode 100644 index 000000000..9b5faec70 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c @@ -0,0 +1 @@ +#include "mpv/client.h" diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy new file mode 100644 index 000000000..a34b7e2e6 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyTrackingDomains + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + + diff --git a/media_kit_video/macos/Classes/plugin/TextureHW.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift similarity index 99% rename from media_kit_video/macos/Classes/plugin/TextureHW.swift rename to media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift index 079ebf957..d8fa80dbc 100644 --- a/media_kit_video/macos/Classes/plugin/TextureHW.swift +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/TextureHW.swift @@ -2,6 +2,10 @@ import FlutterMacOS import OpenGL.GL import OpenGL.GL3 +#if SWIFT_PACKAGE + import Mpv +#endif + public class TextureHW: NSObject, FlutterTexture, ResizableTextureProtocol { public typealias UpdateCallback = () -> Void diff --git a/media_kit_video/macos/Classes/plugin/Utils.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/Utils.swift similarity index 100% rename from media_kit_video/macos/Classes/plugin/Utils.swift rename to media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/Utils.swift diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift new file mode 120000 index 000000000..a4704e4d9 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVHelpers.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MPVHelpers.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift new file mode 120000 index 000000000..6feea1962 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MPVVideoOutParams.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MPVVideoOutParams.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift new file mode 120000 index 000000000..7526e39c7 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/MediaKitVideoPlugin.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift new file mode 120000 index 000000000..ead958248 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/ResizableTextureProtocol.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/ResizableTextureProtocol.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift new file mode 120000 index 000000000..e71d4abd1 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SafeResizableTexture.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/SafeResizableTexture.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift new file mode 120000 index 000000000..6a160006c --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/SwappableObjectManager.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/SwappableObjectManager.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift new file mode 120000 index 000000000..77f4a4a6d --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSW.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/TextureSW.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift new file mode 120000 index 000000000..06c3bdc6c --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/TextureSWContext.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/TextureSWContext.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift new file mode 120000 index 000000000..a122f40ef --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/UtilsProtocol.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/UtilsProtocol.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift new file mode 120000 index 000000000..b51cdfd75 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutput.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutput.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift new file mode 120000 index 000000000..a7ee17420 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputConfiguration.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutputConfiguration.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift new file mode 120000 index 000000000..02f018076 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/VideoOutputManager.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/VideoOutputManager.swift \ No newline at end of file diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift new file mode 120000 index 000000000..4895bec3b --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/common/Worker.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/plugin/Worker.swift \ No newline at end of file diff --git a/media_kit_video/macos/Classes/plugin/gl/OpenGLHelpers.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/gl/OpenGLHelpers.swift similarity index 100% rename from media_kit_video/macos/Classes/plugin/gl/OpenGLHelpers.swift rename to media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/gl/OpenGLHelpers.swift diff --git a/media_kit_video/macos/Classes/plugin/gl/TextureGLContext.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/gl/TextureGLContext.swift similarity index 95% rename from media_kit_video/macos/Classes/plugin/gl/TextureGLContext.swift rename to media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/gl/TextureGLContext.swift index e28a9f09c..bb1d707f0 100644 --- a/media_kit_video/macos/Classes/plugin/gl/TextureGLContext.swift +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/plugin/gl/TextureGLContext.swift @@ -1,3 +1,7 @@ +import Cocoa +import OpenGL.GL +import OpenGL.GL3 + public class TextureGLContext { private let context: CGLContextObj private let renderBuffer: GLuint diff --git a/media_kit_video/macos/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift new file mode 120000 index 000000000..906542b40 --- /dev/null +++ b/media_kit_video/macos/media_kit_video/Sources/media_kit_video/stub/common/MediaKitVideoPlugin.swift @@ -0,0 +1 @@ +../../../../../../common/darwin/Classes/stub/MediaKitVideoPlugin.swift \ No newline at end of file diff --git a/media_kit_video/pubspec.yaml b/media_kit_video/pubspec.yaml index 75c3b13cc..058e55ff3 100644 --- a/media_kit_video/pubspec.yaml +++ b/media_kit_video/pubspec.yaml @@ -12,8 +12,8 @@ topics: - cross-platform environment: - sdk: ">=2.17.0 <4.0.0" - flutter: ">=3.7.0" + sdk: ^3.5.0 + flutter: ">=3.24.0" dependencies: flutter: From 588f2e3ed59b92def06d68fed3992d2d1f0e8c2b Mon Sep 17 00:00:00 2001 From: Roman Laptev Date: Fri, 8 May 2026 16:06:13 +0300 Subject: [PATCH 2/7] New xcframework (#1) --- .../ios/media_kit_libs_ios_audio/ios/Makefile | 4 +- .../ios/media_kit_libs_ios_audio.podspec | 2 +- .../media_kit_libs_ios_audio/Package.swift | 57 + .../ios/media_kit_libs_ios_video.podspec | 2 +- .../media_kit_libs_ios_video/Package.swift | 73 + .../media_kit_libs_macos_audio/Package.swift | 57 + .../media_kit_libs_macos_video/Package.swift | 73 + media_kit_video/ios/media_kit_video.podspec | 2 +- .../ios/media_kit_video/Package.swift | 10 +- .../Sources/Mpv/include/module.modulemap | 7 - .../Sources/Mpv/include/mpv/client.h | 1896 ----------------- .../Sources/Mpv/include/mpv/render.h | 738 ------- .../Sources/Mpv/include/mpv/render_gl.h | 211 -- .../Sources/Mpv/include/mpv/stream_cb.h | 240 --- .../ios/media_kit_video/Sources/Mpv/shim.c | 1 - .../macos/media_kit_video/Package.swift | 10 +- .../Sources/Mpv/include/module.modulemap | 7 - .../Sources/Mpv/include/mpv/client.h | 1896 ----------------- .../Sources/Mpv/include/mpv/render.h | 738 ------- .../Sources/Mpv/include/mpv/render_gl.h | 211 -- .../Sources/Mpv/include/mpv/stream_cb.h | 240 --- .../macos/media_kit_video/Sources/Mpv/shim.c | 1 - tool/update_darwin_libmpv_artifacts.sh | 271 +++ 23 files changed, 538 insertions(+), 6209 deletions(-) create mode 100644 libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift create mode 100644 libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift create mode 100644 libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift create mode 100644 libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h delete mode 100644 media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h delete mode 100644 media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c create mode 100755 tool/update_darwin_libmpv_artifacts.sh diff --git a/libs/ios/media_kit_libs_ios_audio/ios/Makefile b/libs/ios/media_kit_libs_ios_audio/ios/Makefile index 72541f381..3b999d852 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/Makefile +++ b/libs/ios/media_kit_libs_ios_audio/ios/Makefile @@ -1,7 +1,7 @@ all: Frameworks/*.xcframework Frameworks/.symlinks -MPV_XCFRAMEWORKS_VERSION=v0.6.0 -MPV_XCFRAMEWORKS_SHA256SUM=8b8de92dc5482b8950c18bce6b8fa90204fd15af18f371acc9f5be07a4234e49 +MPV_XCFRAMEWORKS_VERSION=v0.7.0 +MPV_XCFRAMEWORKS_SHA256SUM=b84ef31ce2431e6a5beb2808d458f8bf5d266bba5bcfc26498b87800986b22a3 TAR=tar TAR_WILDCARDS_FLAG := $(shell ${TAR} --version 2>&1 | grep -q 'GNU' && echo "--wildcards" || echo "") diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec index 79ddd868b..456ac8342 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :ios, '9.0' + s.platform = :ios, '13.0' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', # Flutter.framework does not contain a i386 slice. diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift new file mode 100644 index 000000000..dfe77bf82 --- /dev/null +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift @@ -0,0 +1,57 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let libmpvTargets = [ + "Avcodec", + "Avfilter", + "Avformat", + "Avutil", + "Mbedcrypto", + "Mbedtls", + "Mbedx509", + "Mpv", + "Swresample", + "Swscale" +] + +let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_ios-universal-audio-default" +let libmpvChecksums = [ + "Avcodec": "fc72195ca32ed023a6230e4e558323fdb14d8e779b7c68cf97ed56ac6d00aebb", + "Avfilter": "e4d71789a98a9f0d60d83de15b7facf6bcf5914f25a6614e8b956296899a99d7", + "Avformat": "4abb7dd215203a22caaabb215b0b2f5e10fd1fe0c8a1ae874908eeea8859eb1e", + "Avutil": "63573305de494575ca29b4bfe328997c0e844132d9e4b6bf8c22ffd4f3cf6273", + "Mbedcrypto": "b016619250601bac48c1b628f958d352d58716bf74fcb6168d7c0ef7b1a78e4d", + "Mbedtls": "457264fdcdaea78ff643c5d3fa184876f955fe202471b7f2b856fb698794269e", + "Mbedx509": "1cde5fa0f6d5308d3a012ce4925551aaad0449e63af82de2ee509970645e96e6", + "Mpv": "0c052ddcb71ab19bd1ae2bbc74514bbfad2ef71eb7b41468c7e71ee9cf7dd2dd", + "Swresample": "5ddbeb5a57a59e87d3b62f33d6340fbcdc35a3dc972064d53c87b9cabf97b4fc", + "Swscale": "302507bbd858e5fc84a88a441ae4b14d577a5a6bd8119ed2e2367468fc9a9dbb" +] + +let package = Package( + name: "media_kit_libs_ios_audio", + platforms: [ + .iOS("13.0") + ], + products: [ + .library(name: "media_kit_libs_ios_audio", targets: ["media_kit_libs_ios_audio"] + libmpvTargets) + ], + dependencies: [], + targets: libmpvTargets.map { framework in + .binaryTarget( + name: framework, + url: "\(libmpvArtifactBase)_\(framework).zip", + checksum: libmpvChecksums[framework]! + ) + } + [ + .target( + name: "media_kit_libs_ios_audio", + dependencies: libmpvTargets.map { framework in .target(name: framework) }, + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec index 74a1dfd25..20c13fa77 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :ios, '9.0' + s.platform = :ios, '13.0' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', # Flutter.framework does not contain a i386 slice. diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift new file mode 100644 index 000000000..9e6bd27a8 --- /dev/null +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift @@ -0,0 +1,73 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let libmpvTargets = [ + "Ass", + "Avcodec", + "Avfilter", + "Avformat", + "Avutil", + "Dav1d", + "Freetype", + "Fribidi", + "Harfbuzz", + "Mbedcrypto", + "Mbedtls", + "Mbedx509", + "Mpv", + "Png16", + "Swresample", + "Swscale", + "Uchardet", + "Xml2" +] + +let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_ios-universal-video-default" +let libmpvChecksums = [ + "Ass": "152cebec157ab9a8c0ea7c69709586455174654bb992b6e6a6603bbe3d315b2b", + "Avcodec": "a6baa1a31800d2b589613d767a0725fe1c76b3e9b4530403e26f2aa80ab99af7", + "Avfilter": "93724550b2613d656a9f26be5dcacf5bcead491cf41f1b1da368fa938053c1f2", + "Avformat": "d7ebc5cf298f3a680253a4370259b0b04056197f216aa2f499f764871482e192", + "Avutil": "eb6854669f86977eca3aee104372188a48ef4ca7a1628e1d5843108b97b0fcf9", + "Dav1d": "e3af3deac054737be3adc5505ce73b81d9a865f5d7c3521ef947158af2307246", + "Freetype": "64299703e582c1a7b0954ee513a0a53edaea0807e6afb0b73d71f9441017c156", + "Fribidi": "67532b36791dbb227ba6f526ea96a62c19cf32da1c1661e17c3055e087c705d2", + "Harfbuzz": "8d585274490514ba3832935db718a49e1f3dc7d03470f9a3a8880c1b4f30678e", + "Mbedcrypto": "b016619250601bac48c1b628f958d352d58716bf74fcb6168d7c0ef7b1a78e4d", + "Mbedtls": "457264fdcdaea78ff643c5d3fa184876f955fe202471b7f2b856fb698794269e", + "Mbedx509": "1cde5fa0f6d5308d3a012ce4925551aaad0449e63af82de2ee509970645e96e6", + "Mpv": "9956f3360a16f4284b8d2aaecf7169c46fb5f427fd0e144dc4a959bac16b8f10", + "Png16": "07a73635dac96817136d595c09fe9854590cd0436c24093f60ee50c75705cb43", + "Swresample": "8361e29e94e8ab82b7a7763a51db9c65dcbb23e06fdb2c79f8874bde6a13ff23", + "Swscale": "2eaf89744d0b08e948b5637e643e12f87f6f67bea8eb06db01c012206ba2ba08", + "Uchardet": "82f0117f1dd69cb2b57aaaf3d561a15af21584d9f4b6dc5b821e06468dec09fe", + "Xml2": "370b24ec59970288f81281a6ace234632630b357963b18e9891eb98bca5cc164" +] + +let package = Package( + name: "media_kit_libs_ios_video", + platforms: [ + .iOS("13.0") + ], + products: [ + .library(name: "media_kit_libs_ios_video", targets: ["media_kit_libs_ios_video"] + libmpvTargets) + ], + dependencies: [], + targets: libmpvTargets.map { framework in + .binaryTarget( + name: framework, + url: "\(libmpvArtifactBase)_\(framework).zip", + checksum: libmpvChecksums[framework]! + ) + } + [ + .target( + name: "media_kit_libs_ios_video", + dependencies: libmpvTargets.map { framework in .target(name: framework) }, + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift new file mode 100644 index 000000000..4d7071869 --- /dev/null +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift @@ -0,0 +1,57 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let libmpvTargets = [ + "Avcodec", + "Avfilter", + "Avformat", + "Avutil", + "Mbedcrypto", + "Mbedtls", + "Mbedx509", + "Mpv", + "Swresample", + "Swscale" +] + +let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_macos-universal-audio-full" +let libmpvChecksums = [ + "Avcodec": "1372bdc0fa7f4ded6b565d29023aba08dd0ed9d6b1916bd2f03409c6370f4e1d", + "Avfilter": "8c471be58b680ae3ac60ffef3ea166447adcd40f660b051a6e4f59aecdd45893", + "Avformat": "3bb73535b43a1cc992777c3b017eb5a84bf4d0ae437c9250ff8511a161617a46", + "Avutil": "3d65e0b2bd65cad4c8a639194398753329dc657c2f418a9c7c662ec8947d76d4", + "Mbedcrypto": "1107eef2c02409840b5f51f9333e527e027aef26f2246af5831f489d50eb6ba0", + "Mbedtls": "f9e8b88cf029b1d8c3093fb3c3150ebc8815f05b7ca259950a1c05e31c7ac532", + "Mbedx509": "8697ad3585f41fb8b8806efaabdd6ff1fa617c7b5a05c13aa86152902ae12917", + "Mpv": "6f5d7fe8b31235d28d8a5fb97b801f0cfc3f19ccad7ac2cb9100f699aafb95e3", + "Swresample": "87c53bd728d0406624c782497a0ef971d28226a84f67997c1891db8bc6c2cc12", + "Swscale": "ea7786b057662edc505696bd9dbbb8bc48feadd869eee1d8eaeab8b2da15d9ed" +] + +let package = Package( + name: "media_kit_libs_macos_audio", + platforms: [ + .macOS("10.15") + ], + products: [ + .library(name: "media_kit_libs_macos_audio", targets: ["media_kit_libs_macos_audio"] + libmpvTargets) + ], + dependencies: [], + targets: libmpvTargets.map { framework in + .binaryTarget( + name: framework, + url: "\(libmpvArtifactBase)_\(framework).zip", + checksum: libmpvChecksums[framework]! + ) + } + [ + .target( + name: "media_kit_libs_macos_audio", + dependencies: libmpvTargets.map { framework in .target(name: framework) }, + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift new file mode 100644 index 000000000..487cd60b4 --- /dev/null +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift @@ -0,0 +1,73 @@ +// swift-tools-version: 5.9 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let libmpvTargets = [ + "Ass", + "Avcodec", + "Avfilter", + "Avformat", + "Avutil", + "Dav1d", + "Freetype", + "Fribidi", + "Harfbuzz", + "Mbedcrypto", + "Mbedtls", + "Mbedx509", + "Mpv", + "Png16", + "Swresample", + "Swscale", + "Uchardet", + "Xml2" +] + +let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_macos-universal-video-default" +let libmpvChecksums = [ + "Ass": "fd5e0767d9c5646e4be90555f716baf129f4572d5ca63cd7e7402629a5dfd4df", + "Avcodec": "5c7556bcae6c6236e8b2ce13b5cea57efe82117b5254d5d718b6e2e1215ebfce", + "Avfilter": "1a601279068c88268d6402cc1438cc77db96015fe4580550a495303dd523dde5", + "Avformat": "ebcf285d7a991c20bdb79f74e99ab8a43177387c1a408b063b1e34f706586f7d", + "Avutil": "ca43c5ef524c62fec0dba34326b4c4e41f6ecd6dd0a4560ace34e5f05840f3aa", + "Dav1d": "7a7d9d8683f54ac0a60d58cfa6a8e3d8111892ae76e2837c5f1a86327688e09e", + "Freetype": "babdeee15b17fd79ecd11686421a8c7307e6bf54ede4c0780523449c74c9a514", + "Fribidi": "1c71675f70baa0e55e63736b9ba3bc1de26fbe206f6a07dd1ed4ac87d2379225", + "Harfbuzz": "e1676afce4985bda71d79991c4ac422faacf601274e1a2d569bb323bd7eeb419", + "Mbedcrypto": "1107eef2c02409840b5f51f9333e527e027aef26f2246af5831f489d50eb6ba0", + "Mbedtls": "f9e8b88cf029b1d8c3093fb3c3150ebc8815f05b7ca259950a1c05e31c7ac532", + "Mbedx509": "8697ad3585f41fb8b8806efaabdd6ff1fa617c7b5a05c13aa86152902ae12917", + "Mpv": "e127db446f863d18f188736baafce9f12511696c7b2bbaf4ddf3a50b502a03b1", + "Png16": "7d7298dd45acafdbbbfbef062a70c9f39209fb612bf5c3997f5542d97adee62e", + "Swresample": "99023ac41623fba61f9145ddf74bb6660fae974740e28012367e4335643b4cb8", + "Swscale": "587da3b1fdf67b55de3993ccd648d5e61f19fdd567a8772e740483867c4f5f09", + "Uchardet": "312a6958e337571af3002c5eb8a2f856321f6625ddcb3a966d54984cff14e350", + "Xml2": "ed2c252c95e5f0ab2fd74c8d769c614f3b6d93821f349c481fff05047b864ab8" +] + +let package = Package( + name: "media_kit_libs_macos_video", + platforms: [ + .macOS("10.15") + ], + products: [ + .library(name: "media_kit_libs_macos_video", targets: ["media_kit_libs_macos_video"] + libmpvTargets) + ], + dependencies: [], + targets: libmpvTargets.map { framework in + .binaryTarget( + name: framework, + url: "\(libmpvArtifactBase)_\(framework).zip", + checksum: libmpvChecksums[framework]! + ) + } + [ + .target( + name: "media_kit_libs_macos_video", + dependencies: libmpvTargets.map { framework in .target(name: framework) }, + resources: [ + .process("PrivacyInfo.xcprivacy") + ] + ) + ] +) diff --git a/media_kit_video/ios/media_kit_video.podspec b/media_kit_video/ios/media_kit_video.podspec index 1679528a6..2a7e653d3 100644 --- a/media_kit_video/ios/media_kit_video.podspec +++ b/media_kit_video/ios/media_kit_video.podspec @@ -23,7 +23,7 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.platform = :ios, '9.0' + s.platform = :ios, '13.0' s.swift_version = '5.0' s.dependency 'Flutter' s.resource_bundles = { diff --git a/media_kit_video/ios/media_kit_video/Package.swift b/media_kit_video/ios/media_kit_video/Package.swift index 484c6feed..d8bfcce64 100644 --- a/media_kit_video/ios/media_kit_video/Package.swift +++ b/media_kit_video/ios/media_kit_video/Package.swift @@ -13,17 +13,9 @@ let package = Package( ], dependencies: [], targets: [ - .target( - name: "Mpv", - path: "Sources/Mpv", - sources: ["shim.c"], - publicHeadersPath: "include" - ), .target( name: "media_kit_video", - dependencies: [ - .target(name: "Mpv") - ], + dependencies: [], sources: ["plugin"], resources: [ .process("PrivacyInfo.xcprivacy") diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap deleted file mode 100644 index 7226723bb..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/module.modulemap +++ /dev/null @@ -1,7 +0,0 @@ -module Mpv { - header "mpv/client.h" - header "mpv/render.h" - header "mpv/render_gl.h" - header "mpv/stream_cb.h" - export * -} diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h deleted file mode 100644 index b9697eb74..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/client.h +++ /dev/null @@ -1,1896 +0,0 @@ -/* Copyright (C) 2017 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/* - * Note: the client API is licensed under ISC (see above) to enable - * other wrappers outside of mpv. But keep in mind that the - * mpv core is by default still GPLv2+ - unless built with - * --enable-lgpl, which makes it LGPLv2+. - */ - -#ifndef MPV_CLIENT_API_H_ -#define MPV_CLIENT_API_H_ - -#include -#include - -/* New symbols must still be added to libmpv/mpv.def. */ -#ifdef _WIN32 -#define MPV_EXPORT __declspec(dllexport) -#elif defined(__GNUC__) || defined(__clang__) -#define MPV_EXPORT __attribute__((visibility("default"))) -#else -#define MPV_EXPORT -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Mechanisms provided by this API - * ------------------------------- - * - * This API provides general control over mpv playback. It does not give you - * direct access to individual components of the player, only the whole thing. - * It's somewhat equivalent to MPlayer's slave mode. You can send commands, - * retrieve or set playback status or settings with properties, and receive - * events. - * - * The API can be used in two ways: - * 1) Internally in mpv, to provide additional features to the command line - * player. Lua scripting uses this. (Currently there is no plugin API to - * get a client API handle in external user code. It has to be a fixed - * part of the player at compilation time.) - * 2) Using mpv as a library with mpv_create(). This basically allows embedding - * mpv in other applications. - * - * Documentation - * ------------- - * - * The libmpv C API is documented directly in this header. Note that most - * actual interaction with this player is done through - * options/commands/properties, which can be accessed through this API. - * Essentially everything is done with them, including loading a file, - * retrieving playback progress, and so on. - * - * These are documented elsewhere: - * * http://mpv.io/manual/master/#options - * * http://mpv.io/manual/master/#list-of-input-commands - * * http://mpv.io/manual/master/#properties - * - * You can also look at the examples here: - * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv - * - * Event loop - * ---------- - * - * In general, the API user should run an event loop in order to receive events. - * This event loop should call mpv_wait_event(), which will return once a new - * mpv client API is available. It is also possible to integrate client API - * usage in other event loops (e.g. GUI toolkits) with the - * mpv_set_wakeup_callback() function, and then polling for events by calling - * mpv_wait_event() with a 0 timeout. - * - * Note that the event loop is detached from the actual player. Not calling - * mpv_wait_event() will not stop playback. It will eventually congest the - * event queue of your API handle, though. - * - * Synchronous vs. asynchronous calls - * ---------------------------------- - * - * The API allows both synchronous and asynchronous calls. Synchronous calls - * have to wait until the playback core is ready, which currently can take - * an unbounded time (e.g. if network is slow or unresponsive). Asynchronous - * calls just queue operations as requests, and return the result of the - * operation as events. - * - * Asynchronous calls - * ------------------ - * - * The client API includes asynchronous functions. These allow you to send - * requests instantly, and get replies as events at a later point. The - * requests are made with functions carrying the _async suffix, and replies - * are returned by mpv_wait_event() (interleaved with the normal event stream). - * - * A 64 bit userdata value is used to allow the user to associate requests - * with replies. The value is passed as reply_userdata parameter to the request - * function. The reply to the request will have the reply - * mpv_event->reply_userdata field set to the same value as the - * reply_userdata parameter of the corresponding request. - * - * This userdata value is arbitrary and is never interpreted by the API. Note - * that the userdata value 0 is also allowed, but then the client must be - * careful not accidentally interpret the mpv_event->reply_userdata if an - * event is not a reply. (For non-replies, this field is set to 0.) - * - * Asynchronous calls may be reordered in arbitrarily with other synchronous - * and asynchronous calls. If you want a guaranteed order, you need to wait - * until asynchronous calls report completion before doing the next call. - * - * See also the section "Asynchronous command details" in the manpage. - * - * Multithreading - * -------------- - * - * The client API is generally fully thread-safe, unless otherwise noted. - * Currently, there is no real advantage in using more than 1 thread to access - * the client API, since everything is serialized through a single lock in the - * playback core. - * - * Basic environment requirements - * ------------------------------ - * - * This documents basic requirements on the C environment. This is especially - * important if mpv is used as library with mpv_create(). - * - * - The LC_NUMERIC locale category must be set to "C". If your program calls - * setlocale(), be sure not to use LC_ALL, or if you do, reset LC_NUMERIC - * to its sane default: setlocale(LC_NUMERIC, "C"). - * - If a X11 based VO is used, mpv will set the xlib error handler. This error - * handler is process-wide, and there's no proper way to share it with other - * xlib users within the same process. This might confuse GUI toolkits. - * - mpv uses some other libraries that are not library-safe, such as Fribidi - * (used through libass), ALSA, FFmpeg, and possibly more. - * - The FPU precision must be set at least to double precision. - * - On Windows, mpv will call timeBeginPeriod(1). - * - On memory exhaustion, mpv will kill the process. - * - In certain cases, mpv may start sub processes (such as with the ytdl - * wrapper script). - * - Using UNIX IPC (off by default) will override the SIGPIPE signal handler, - * and set it to SIG_IGN. Some invocations of the "subprocess" command will - * also do that. - * - mpv may start sub processes, so overriding SIGCHLD, or waiting on all PIDs - * (such as calling wait()) by the parent process or any other library within - * the process must be avoided. libmpv itself only waits for its own PIDs. - * - If anything in the process registers signal handlers, they must set the - * SA_RESTART flag. Otherwise you WILL get random failures on signals. - * - * Encoding of filenames - * --------------------- - * - * mpv uses UTF-8 everywhere. - * - * On some platforms (like Linux), filenames actually do not have to be UTF-8; - * for this reason libmpv supports non-UTF-8 strings. libmpv uses what the - * kernel uses and does not recode filenames. At least on Linux, passing a - * string to libmpv is like passing a string to the fopen() function. - * - * On Windows, filenames are always UTF-8, libmpv converts between UTF-8 and - * UTF-16 when using win32 API functions. libmpv never uses or accepts - * filenames in the local 8 bit encoding. It does not use fopen() either; - * it uses _wfopen(). - * - * On OS X, filenames and other strings taken/returned by libmpv can have - * inconsistent unicode normalization. This can sometimes lead to problems. - * You have to hope for the best. - * - * Also see the remarks for MPV_FORMAT_STRING. - * - * Embedding the video window - * -------------------------- - * - * Using the render API (in render.h) is recommended. This API requires - * you to create and maintain an OpenGL context, to which you can render - * video using a specific API call. This API does not include keyboard or mouse - * input directly. - * - * There is an older way to embed the native mpv window into your own. You have - * to get the raw window handle, and set it as "wid" option. This works on X11, - * win32, and OSX only. It's much easier to use than the render API, but - * also has various problems. - * - * Also see client API examples and the mpv manpage. There is an extensive - * discussion here: - * https://github.com/mpv-player/mpv-examples/tree/master/libmpv#methods-of-embedding-the-video-window - * - * Compatibility - * ------------- - * - * mpv development doesn't stand still, and changes to mpv internals as well as - * to its interface can cause compatibility issues to client API users. - * - * The API is versioned (see MPV_CLIENT_API_VERSION), and changes to it are - * documented in DOCS/client-api-changes.rst. The C API itself will probably - * remain compatible for a long time, but the functionality exposed by it - * could change more rapidly. For example, it's possible that options are - * renamed, or change the set of allowed values. - * - * Defensive programming should be used to potentially deal with the fact that - * options, commands, and properties could disappear, change their value range, - * or change the underlying datatypes. It might be a good idea to prefer - * MPV_FORMAT_STRING over other types to decouple your code from potential - * mpv changes. - * - * Also see: DOCS/compatibility.rst - * - * Future changes - * -------------- - * - * This are the planned changes that will most likely be done on the next major - * bump of the library: - * - * - remove all symbols that are marked as deprecated - * - reassign enum numerical values to remove gaps - * - disabling all events by default - */ - -/** - * The version is incremented on each API change. The 16 lower bits form the - * minor version number, and the 16 higher bits the major version number. If - * the API becomes incompatible to previous versions, the major version - * number is incremented. This affects only C part, and not properties and - * options. - * - * Every API bump is described in DOCS/client-api-changes.rst - * - * You can use MPV_MAKE_VERSION() and compare the result with integer - * relational operators (<, >, <=, >=). - */ -#define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) -#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(2, 1) - -/** - * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before - * including any libmpv headers. Then deprecated symbols will be excluded - * from the headers. (Of course, deprecated properties and commands and - * other functionality will still work.) - */ -#ifndef MPV_ENABLE_DEPRECATED -#define MPV_ENABLE_DEPRECATED 1 -#endif - -/** - * Return the MPV_CLIENT_API_VERSION the mpv source has been compiled with. - */ -MPV_EXPORT unsigned long mpv_client_api_version(void); - -/** - * Client context used by the client API. Every client has its own private - * handle. - */ -typedef struct mpv_handle mpv_handle; - -/** - * List of error codes than can be returned by API functions. 0 and positive - * return values always mean success, negative values are always errors. - */ -typedef enum mpv_error { - /** - * No error happened (used to signal successful operation). - * Keep in mind that many API functions returning error codes can also - * return positive values, which also indicate success. API users can - * hardcode the fact that ">= 0" means success. - */ - MPV_ERROR_SUCCESS = 0, - /** - * The event ringbuffer is full. This means the client is choked, and can't - * receive any events. This can happen when too many asynchronous requests - * have been made, but not answered. Probably never happens in practice, - * unless the mpv core is frozen for some reason, and the client keeps - * making asynchronous requests. (Bugs in the client API implementation - * could also trigger this, e.g. if events become "lost".) - */ - MPV_ERROR_EVENT_QUEUE_FULL = -1, - /** - * Memory allocation failed. - */ - MPV_ERROR_NOMEM = -2, - /** - * The mpv core wasn't configured and initialized yet. See the notes in - * mpv_create(). - */ - MPV_ERROR_UNINITIALIZED = -3, - /** - * Generic catch-all error if a parameter is set to an invalid or - * unsupported value. This is used if there is no better error code. - */ - MPV_ERROR_INVALID_PARAMETER = -4, - /** - * Trying to set an option that doesn't exist. - */ - MPV_ERROR_OPTION_NOT_FOUND = -5, - /** - * Trying to set an option using an unsupported MPV_FORMAT. - */ - MPV_ERROR_OPTION_FORMAT = -6, - /** - * Setting the option failed. Typically this happens if the provided option - * value could not be parsed. - */ - MPV_ERROR_OPTION_ERROR = -7, - /** - * The accessed property doesn't exist. - */ - MPV_ERROR_PROPERTY_NOT_FOUND = -8, - /** - * Trying to set or get a property using an unsupported MPV_FORMAT. - */ - MPV_ERROR_PROPERTY_FORMAT = -9, - /** - * The property exists, but is not available. This usually happens when the - * associated subsystem is not active, e.g. querying audio parameters while - * audio is disabled. - */ - MPV_ERROR_PROPERTY_UNAVAILABLE = -10, - /** - * Error setting or getting a property. - */ - MPV_ERROR_PROPERTY_ERROR = -11, - /** - * General error when running a command with mpv_command and similar. - */ - MPV_ERROR_COMMAND = -12, - /** - * Generic error on loading (usually used with mpv_event_end_file.error). - */ - MPV_ERROR_LOADING_FAILED = -13, - /** - * Initializing the audio output failed. - */ - MPV_ERROR_AO_INIT_FAILED = -14, - /** - * Initializing the video output failed. - */ - MPV_ERROR_VO_INIT_FAILED = -15, - /** - * There was no audio or video data to play. This also happens if the - * file was recognized, but did not contain any audio or video streams, - * or no streams were selected. - */ - MPV_ERROR_NOTHING_TO_PLAY = -16, - /** - * When trying to load the file, the file format could not be determined, - * or the file was too broken to open it. - */ - MPV_ERROR_UNKNOWN_FORMAT = -17, - /** - * Generic error for signaling that certain system requirements are not - * fulfilled. - */ - MPV_ERROR_UNSUPPORTED = -18, - /** - * The API function which was called is a stub only. - */ - MPV_ERROR_NOT_IMPLEMENTED = -19, - /** - * Unspecified error. - */ - MPV_ERROR_GENERIC = -20 -} mpv_error; - -/** - * Return a string describing the error. For unknown errors, the string - * "unknown error" is returned. - * - * @param error error number, see enum mpv_error - * @return A static string describing the error. The string is completely - * static, i.e. doesn't need to be deallocated, and is valid forever. - */ -MPV_EXPORT const char *mpv_error_string(int error); - -/** - * General function to deallocate memory returned by some of the API functions. - * Call this only if it's explicitly documented as allowed. Calling this on - * mpv memory not owned by the caller will lead to undefined behavior. - * - * @param data A valid pointer returned by the API, or NULL. - */ -MPV_EXPORT void mpv_free(void *data); - -/** - * Return the name of this client handle. Every client has its own unique - * name, which is mostly used for user interface purposes. - * - * @return The client name. The string is read-only and is valid until the - * mpv_handle is destroyed. - */ -MPV_EXPORT const char *mpv_client_name(mpv_handle *ctx); - -/** - * Return the ID of this client handle. Every client has its own unique ID. This - * ID is never reused by the core, even if the mpv_handle at hand gets destroyed - * and new handles get allocated. - * - * IDs are never 0 or negative. - * - * Some mpv APIs (not necessarily all) accept a name in the form "@" in - * addition of the proper mpv_client_name(), where "" is the ID in decimal - * form (e.g. "@123"). For example, the "script-message-to" command takes the - * client name as first argument, but also accepts the client ID formatted in - * this manner. - * - * @return The client ID. - */ -MPV_EXPORT int64_t mpv_client_id(mpv_handle *ctx); - -/** - * Create a new mpv instance and an associated client API handle to control - * the mpv instance. This instance is in a pre-initialized state, - * and needs to be initialized to be actually used with most other API - * functions. - * - * Some API functions will return MPV_ERROR_UNINITIALIZED in the uninitialized - * state. You can call mpv_set_property() (or mpv_set_property_string() and - * other variants, and before mpv 0.21.0 mpv_set_option() etc.) to set initial - * options. After this, call mpv_initialize() to start the player, and then use - * e.g. mpv_command() to start playback of a file. - * - * The point of separating handle creation and actual initialization is that - * you can configure things which can't be changed during runtime. - * - * Unlike the command line player, this will have initial settings suitable - * for embedding in applications. The following settings are different: - * - stdin/stdout/stderr and the terminal will never be accessed. This is - * equivalent to setting the --no-terminal option. - * (Technically, this also suppresses C signal handling.) - * - No config files will be loaded. This is roughly equivalent to using - * --config=no. Since libmpv 1.15, you can actually re-enable this option, - * which will make libmpv load config files during mpv_initialize(). If you - * do this, you are strongly encouraged to set the "config-dir" option too. - * (Otherwise it will load the mpv command line player's config.) - * For example: - * mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config root - * mpv_set_option_string(mpv, "config", "yes"); // enable config loading - * (call mpv_initialize() _after_ this) - * - Idle mode is enabled, which means the playback core will enter idle mode - * if there are no more files to play on the internal playlist, instead of - * exiting. This is equivalent to the --idle option. - * - Disable parts of input handling. - * - Most of the different settings can be viewed with the command line player - * by running "mpv --show-profile=libmpv". - * - * All this assumes that API users want a mpv instance that is strictly - * isolated from the command line player's configuration, user settings, and - * so on. You can re-enable disabled features by setting the appropriate - * options. - * - * The mpv command line parser is not available through this API, but you can - * set individual options with mpv_set_property(). Files for playback must be - * loaded with mpv_command() or others. - * - * Note that you should avoid doing concurrent accesses on the uninitialized - * client handle. (Whether concurrent access is definitely allowed or not has - * yet to be decided.) - * - * @return a new mpv client API handle. Returns NULL on error. Currently, this - * can happen in the following situations: - * - out of memory - * - LC_NUMERIC is not set to "C" (see general remarks) - */ -MPV_EXPORT mpv_handle *mpv_create(void); - -/** - * Initialize an uninitialized mpv instance. If the mpv instance is already - * running, an error is returned. - * - * This function needs to be called to make full use of the client API if the - * client API handle was created with mpv_create(). - * - * Only the following options are required to be set _before_ mpv_initialize(): - * - options which are only read at initialization time: - * - config - * - config-dir - * - input-conf - * - load-scripts - * - script - * - player-operation-mode - * - input-app-events (OSX) - * - all encoding mode options - * - * @return error code - */ -MPV_EXPORT int mpv_initialize(mpv_handle *ctx); - -/** - * Disconnect and destroy the mpv_handle. ctx will be deallocated with this - * API call. - * - * If the last mpv_handle is detached, the core player is destroyed. In - * addition, if there are only weak mpv_handles (such as created by - * mpv_create_weak_client() or internal scripts), these mpv_handles will - * be sent MPV_EVENT_SHUTDOWN. This function may block until these clients - * have responded to the shutdown event, and the core is finally destroyed. - */ -MPV_EXPORT void mpv_destroy(mpv_handle *ctx); - -/** - * Similar to mpv_destroy(), but brings the player and all clients down - * as well, and waits until all of them are destroyed. This function blocks. The - * advantage over mpv_destroy() is that while mpv_destroy() merely - * detaches the client handle from the player, this function quits the player, - * waits until all other clients are destroyed (i.e. all mpv_handles are - * detached), and also waits for the final termination of the player. - * - * Since mpv_destroy() is called somewhere on the way, it's not safe to - * call other functions concurrently on the same context. - * - * Since mpv client API version 1.29: - * The first call on any mpv_handle will block until the core is destroyed. - * This means it will wait until other mpv_handle have been destroyed. If you - * want asynchronous destruction, just run the "quit" command, and then react - * to the MPV_EVENT_SHUTDOWN event. - * If another mpv_handle already called mpv_terminate_destroy(), this call will - * not actually block. It will destroy the mpv_handle, and exit immediately, - * while other mpv_handles might still be uninitializing. - * - * Before mpv client API version 1.29: - * If this is called on a mpv_handle that was not created with mpv_create(), - * this function will merely send a quit command and then call - * mpv_destroy(), without waiting for the actual shutdown. - */ -MPV_EXPORT void mpv_terminate_destroy(mpv_handle *ctx); - -/** - * Create a new client handle connected to the same player core as ctx. This - * context has its own event queue, its own mpv_request_event() state, its own - * mpv_request_log_messages() state, its own set of observed properties, and - * its own state for asynchronous operations. Otherwise, everything is shared. - * - * This handle should be destroyed with mpv_destroy() if no longer - * needed. The core will live as long as there is at least 1 handle referencing - * it. Any handle can make the core quit, which will result in every handle - * receiving MPV_EVENT_SHUTDOWN. - * - * This function can not be called before the main handle was initialized with - * mpv_initialize(). The new handle is always initialized, unless ctx=NULL was - * passed. - * - * @param ctx Used to get the reference to the mpv core; handle-specific - * settings and parameters are not used. - * If NULL, this function behaves like mpv_create() (ignores name). - * @param name The client name. This will be returned by mpv_client_name(). If - * the name is already in use, or contains non-alphanumeric - * characters (other than '_'), the name is modified to fit. - * If NULL, an arbitrary name is automatically chosen. - * @return a new handle, or NULL on error - */ -MPV_EXPORT mpv_handle *mpv_create_client(mpv_handle *ctx, const char *name); - -/** - * This is the same as mpv_create_client(), but the created mpv_handle is - * treated as a weak reference. If all mpv_handles referencing a core are - * weak references, the core is automatically destroyed. (This still goes - * through normal uninit of course. Effectively, if the last non-weak mpv_handle - * is destroyed, then the weak mpv_handles receive MPV_EVENT_SHUTDOWN and are - * asked to terminate as well.) - * - * Note if you want to use this like refcounting: you have to be aware that - * mpv_terminate_destroy() _and_ mpv_destroy() for the last non-weak - * mpv_handle will block until all weak mpv_handles are destroyed. - */ -MPV_EXPORT mpv_handle *mpv_create_weak_client(mpv_handle *ctx, const char *name); - -/** - * Load a config file. This loads and parses the file, and sets every entry in - * the config file's default section as if mpv_set_option_string() is called. - * - * The filename should be an absolute path. If it isn't, the actual path used - * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the - * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. - * - * If a fatal error happens when parsing a config file, MPV_ERROR_OPTION_ERROR - * is returned. Errors when setting options as well as other types or errors - * are ignored (even if options do not exist). You can still try to capture - * the resulting error messages with mpv_request_log_messages(). Note that it's - * possible that some options were successfully set even if any of these errors - * happen. - * - * @param filename absolute path to the config file on the local filesystem - * @return error code - */ -MPV_EXPORT int mpv_load_config_file(mpv_handle *ctx, const char *filename); - -/** - * Return the internal time in microseconds. This has an arbitrary start offset, - * but will never wrap or go backwards. - * - * Note that this is always the real time, and doesn't necessarily have to do - * with playback time. For example, playback could go faster or slower due to - * playback speed, or due to playback being paused. Use the "time-pos" property - * instead to get the playback status. - * - * Unlike other libmpv APIs, this can be called at absolutely any time (even - * within wakeup callbacks), as long as the context is valid. - * - * Safe to be called from mpv render API threads. - */ -MPV_EXPORT int64_t mpv_get_time_us(mpv_handle *ctx); - -/** - * Data format for options and properties. The API functions to get/set - * properties and options support multiple formats, and this enum describes - * them. - */ -typedef enum mpv_format { - /** - * Invalid. Sometimes used for empty values. This is always defined to 0, - * so a normal 0-init of mpv_format (or e.g. mpv_node) is guaranteed to set - * this it to MPV_FORMAT_NONE (which makes some things saner as consequence). - */ - MPV_FORMAT_NONE = 0, - /** - * The basic type is char*. It returns the raw property string, like - * using ${=property} in input.conf (see input.rst). - * - * NULL isn't an allowed value. - * - * Warning: although the encoding is usually UTF-8, this is not always the - * case. File tags often store strings in some legacy codepage, - * and even filenames don't necessarily have to be in UTF-8 (at - * least on Linux). If you pass the strings to code that requires - * valid UTF-8, you have to sanitize it in some way. - * On Windows, filenames are always UTF-8, and libmpv converts - * between UTF-8 and UTF-16 when using win32 API functions. See - * the "Encoding of filenames" section for details. - * - * Example for reading: - * - * char *result = NULL; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_STRING, &result) < 0) - * goto error; - * printf("%s\n", result); - * mpv_free(result); - * - * Or just use mpv_get_property_string(). - * - * Example for writing: - * - * char *value = "the new value"; - * // yep, you pass the address to the variable - * // (needed for symmetry with other types and mpv_get_property) - * mpv_set_property(ctx, "property", MPV_FORMAT_STRING, &value); - * - * Or just use mpv_set_property_string(). - * - */ - MPV_FORMAT_STRING = 1, - /** - * The basic type is char*. It returns the OSD property string, like - * using ${property} in input.conf (see input.rst). In many cases, this - * is the same as the raw string, but in other cases it's formatted for - * display on OSD. It's intended to be human readable. Do not attempt to - * parse these strings. - * - * Only valid when doing read access. The rest works like MPV_FORMAT_STRING. - */ - MPV_FORMAT_OSD_STRING = 2, - /** - * The basic type is int. The only allowed values are 0 ("no") - * and 1 ("yes"). - * - * Example for reading: - * - * int result; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_FLAG, &result) < 0) - * goto error; - * printf("%s\n", result ? "true" : "false"); - * - * Example for writing: - * - * int flag = 1; - * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); - */ - MPV_FORMAT_FLAG = 3, - /** - * The basic type is int64_t. - */ - MPV_FORMAT_INT64 = 4, - /** - * The basic type is double. - */ - MPV_FORMAT_DOUBLE = 5, - /** - * The type is mpv_node. - * - * For reading, you usually would pass a pointer to a stack-allocated - * mpv_node value to mpv, and when you're done you call - * mpv_free_node_contents(&node). - * You're expected not to write to the data - if you have to, copy it - * first (which you have to do manually). - * - * For writing, you construct your own mpv_node, and pass a pointer to the - * API. The API will never write to your data (and copy it if needed), so - * you're free to use any form of allocation or memory management you like. - * - * Warning: when reading, always check the mpv_node.format member. For - * example, properties might change their type in future versions - * of mpv, or sometimes even during runtime. - * - * Example for reading: - * - * mpv_node result; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_NODE, &result) < 0) - * goto error; - * printf("format=%d\n", (int)result.format); - * mpv_free_node_contents(&result). - * - * Example for writing: - * - * mpv_node value; - * value.format = MPV_FORMAT_STRING; - * value.u.string = "hello"; - * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); - */ - MPV_FORMAT_NODE = 6, - /** - * Used with mpv_node only. Can usually not be used directly. - */ - MPV_FORMAT_NODE_ARRAY = 7, - /** - * See MPV_FORMAT_NODE_ARRAY. - */ - MPV_FORMAT_NODE_MAP = 8, - /** - * A raw, untyped byte array. Only used only with mpv_node, and only in - * some very specific situations. (Some commands use it.) - */ - MPV_FORMAT_BYTE_ARRAY = 9 -} mpv_format; - -/** - * Generic data storage. - * - * If mpv writes this struct (e.g. via mpv_get_property()), you must not change - * the data. In some cases (mpv_get_property()), you have to free it with - * mpv_free_node_contents(). If you fill this struct yourself, you're also - * responsible for freeing it, and you must not call mpv_free_node_contents(). - */ -typedef struct mpv_node { - union { - char *string; /** valid if format==MPV_FORMAT_STRING */ - int flag; /** valid if format==MPV_FORMAT_FLAG */ - int64_t int64; /** valid if format==MPV_FORMAT_INT64 */ - double double_; /** valid if format==MPV_FORMAT_DOUBLE */ - /** - * valid if format==MPV_FORMAT_NODE_ARRAY - * or if format==MPV_FORMAT_NODE_MAP - */ - struct mpv_node_list *list; - /** - * valid if format==MPV_FORMAT_BYTE_ARRAY - */ - struct mpv_byte_array *ba; - } u; - /** - * Type of the data stored in this struct. This value rules what members in - * the given union can be accessed. The following formats are currently - * defined to be allowed in mpv_node: - * - * MPV_FORMAT_STRING (u.string) - * MPV_FORMAT_FLAG (u.flag) - * MPV_FORMAT_INT64 (u.int64) - * MPV_FORMAT_DOUBLE (u.double_) - * MPV_FORMAT_NODE_ARRAY (u.list) - * MPV_FORMAT_NODE_MAP (u.list) - * MPV_FORMAT_BYTE_ARRAY (u.ba) - * MPV_FORMAT_NONE (no member) - * - * If you encounter a value you don't know, you must not make any - * assumptions about the contents of union u. - */ - mpv_format format; -} mpv_node; - -/** - * (see mpv_node) - */ -typedef struct mpv_node_list { - /** - * Number of entries. Negative values are not allowed. - */ - int num; - /** - * MPV_FORMAT_NODE_ARRAY: - * values[N] refers to value of the Nth item - * - * MPV_FORMAT_NODE_MAP: - * values[N] refers to value of the Nth key/value pair - * - * If num > 0, values[0] to values[num-1] (inclusive) are valid. - * Otherwise, this can be NULL. - */ - mpv_node *values; - /** - * MPV_FORMAT_NODE_ARRAY: - * unused (typically NULL), access is not allowed - * - * MPV_FORMAT_NODE_MAP: - * keys[N] refers to key of the Nth key/value pair. If num > 0, keys[0] to - * keys[num-1] (inclusive) are valid. Otherwise, this can be NULL. - * The keys are in random order. The only guarantee is that keys[N] belongs - * to the value values[N]. NULL keys are not allowed. - */ - char **keys; -} mpv_node_list; - -/** - * (see mpv_node) - */ -typedef struct mpv_byte_array { - /** - * Pointer to the data. In what format the data is stored is up to whatever - * uses MPV_FORMAT_BYTE_ARRAY. - */ - void *data; - /** - * Size of the data pointed to by ptr. - */ - size_t size; -} mpv_byte_array; - -/** - * Frees any data referenced by the node. It doesn't free the node itself. - * Call this only if the mpv client API set the node. If you constructed the - * node yourself (manually), you have to free it yourself. - * - * If node->format is MPV_FORMAT_NONE, this call does nothing. Likewise, if - * the client API sets a node with this format, this function doesn't need to - * be called. (This is just a clarification that there's no danger of anything - * strange happening in these cases.) - */ -MPV_EXPORT void mpv_free_node_contents(mpv_node *node); - -/** - * Set an option. Note that you can't normally set options during runtime. It - * works in uninitialized state (see mpv_create()), and in some cases in at - * runtime. - * - * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a - * mpv_node with the given format and data, and passing the mpv_node to this - * function. - * - * Note: this is semi-deprecated. For most purposes, this is not needed anymore. - * Starting with mpv version 0.21.0 (version 1.23) most options can be set - * with mpv_set_property() (and related functions), and even before - * mpv_initialize(). In some obscure corner cases, using this function - * to set options might still be required (see - * "Inconsistencies between options and properties" in the manpage). Once - * these are resolved, the option setting functions might be fully - * deprecated. - * - * @param name Option name. This is the same as on the mpv command line, but - * without the leading "--". - * @param format see enum mpv_format. - * @param[in] data Option value (according to the format). - * @return error code - */ -MPV_EXPORT int mpv_set_option(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Convenience function to set an option to a string value. This is like - * calling mpv_set_option() with MPV_FORMAT_STRING. - * - * @return error code - */ -MPV_EXPORT int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data); - -/** - * Send a command to the player. Commands are the same as those used in - * input.conf, except that this function takes parameters in a pre-split - * form. - * - * The commands and their parameters are documented in input.rst. - * - * Does not use OSD and string expansion by default (unlike mpv_command_string() - * and input.conf). - * - * @param[in] args NULL-terminated list of strings. Usually, the first item - * is the command, and the following items are arguments. - * @return error code - */ -MPV_EXPORT int mpv_command(mpv_handle *ctx, const char **args); - -/** - * Same as mpv_command(), but allows passing structured data in any format. - * In particular, calling mpv_command() is exactly like calling - * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and - * every arg passed in order as MPV_FORMAT_STRING. - * - * Does not use OSD and string expansion by default. - * - * The args argument can have one of the following formats: - * - * MPV_FORMAT_NODE_ARRAY: - * Positional arguments. Each entry is an argument using an arbitrary - * format (the format must be compatible to the used command). Usually, - * the first item is the command name (as MPV_FORMAT_STRING). The order - * of arguments is as documented in each command description. - * - * MPV_FORMAT_NODE_MAP: - * Named arguments. This requires at least an entry with the key "name" - * to be present, which must be a string, and contains the command name. - * The special entry "_flags" is optional, and if present, must be an - * array of strings, each being a command prefix to apply. All other - * entries are interpreted as arguments. They must use the argument names - * as documented in each command description. Some commands do not - * support named arguments at all, and must use MPV_FORMAT_NODE_ARRAY. - * - * @param[in] args mpv_node with format set to one of the values documented - * above (see there for details) - * @param[out] result Optional, pass NULL if unused. If not NULL, and if the - * function succeeds, this is set to command-specific return - * data. You must call mpv_free_node_contents() to free it - * (again, only if the command actually succeeds). - * Not many commands actually use this at all. - * @return error code (the result parameter is not set on error) - */ -MPV_EXPORT int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); - -/** - * This is essentially identical to mpv_command() but it also returns a result. - * - * Does not use OSD and string expansion by default. - * - * @param[in] args NULL-terminated list of strings. Usually, the first item - * is the command, and the following items are arguments. - * @param[out] result Optional, pass NULL if unused. If not NULL, and if the - * function succeeds, this is set to command-specific return - * data. You must call mpv_free_node_contents() to free it - * (again, only if the command actually succeeds). - * Not many commands actually use this at all. - * @return error code (the result parameter is not set on error) - */ -MPV_EXPORT int mpv_command_ret(mpv_handle *ctx, const char **args, mpv_node *result); - -/** - * Same as mpv_command, but use input.conf parsing for splitting arguments. - * This is slightly simpler, but also more error prone, since arguments may - * need quoting/escaping. - * - * This also has OSD and string expansion enabled by default. - */ -MPV_EXPORT int mpv_command_string(mpv_handle *ctx, const char *args); - -/** - * Same as mpv_command, but run the command asynchronously. - * - * Commands are executed asynchronously. You will receive a - * MPV_EVENT_COMMAND_REPLY event. This event will also have an - * error code set if running the command failed. For commands that - * return data, the data is put into mpv_event_command.result. - * - * The only case when you do not receive an event is when the function call - * itself fails. This happens only if parsing the command itself (or otherwise - * validating it) fails, i.e. the return code of the API call is not 0 or - * positive. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata the value mpv_event.reply_userdata of the reply will - * be set to (see section about asynchronous calls) - * @param args NULL-terminated list of strings (see mpv_command()) - * @return error code (if parsing or queuing the command fails) - */ -MPV_EXPORT int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, - const char **args); - -/** - * Same as mpv_command_node(), but run it asynchronously. Basically, this - * function is to mpv_command_node() what mpv_command_async() is to - * mpv_command(). - * - * See mpv_command_async() for details. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata the value mpv_event.reply_userdata of the reply will - * be set to (see section about asynchronous calls) - * @param args as in mpv_command_node() - * @return error code (if parsing or queuing the command fails) - */ -MPV_EXPORT int mpv_command_node_async(mpv_handle *ctx, uint64_t reply_userdata, - mpv_node *args); - -/** - * Signal to all async requests with the matching ID to abort. This affects - * the following API calls: - * - * mpv_command_async - * mpv_command_node_async - * - * All of these functions take a reply_userdata parameter. This API function - * tells all requests with the matching reply_userdata value to try to return - * as soon as possible. If there are multiple requests with matching ID, it - * aborts all of them. - * - * This API function is mostly asynchronous itself. It will not wait until the - * command is aborted. Instead, the command will terminate as usual, but with - * some work not done. How this is signaled depends on the specific command (for - * example, the "subprocess" command will indicate it by "killed_by_us" set to - * true in the result). How long it takes also depends on the situation. The - * aborting process is completely asynchronous. - * - * Not all commands may support this functionality. In this case, this function - * will have no effect. The same is true if the request using the passed - * reply_userdata has already terminated, has not been started yet, or was - * never in use at all. - * - * You have to be careful of race conditions: the time during which the abort - * request will be effective is _after_ e.g. mpv_command_async() has returned, - * and before the command has signaled completion with MPV_EVENT_COMMAND_REPLY. - * - * @param reply_userdata ID of the request to be aborted (see above) - */ -MPV_EXPORT void mpv_abort_async_command(mpv_handle *ctx, uint64_t reply_userdata); - -/** - * Set a property to a given value. Properties are essentially variables which - * can be queried or set at runtime. For example, writing to the pause property - * will actually pause or unpause playback. - * - * If the format doesn't match with the internal format of the property, access - * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data - * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 - * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING - * usually invokes a string parser. The same happens when calling this function - * with MPV_FORMAT_NODE: the underlying format may be converted to another - * type if possible. - * - * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a - * mpv_node with the given format and data, and passing the mpv_node to this - * function. (Before API version 1.21, this was different.) - * - * Note: starting with mpv 0.21.0 (client API version 1.23), this can be used to - * set options in general. It even can be used before mpv_initialize() - * has been called. If called before mpv_initialize(), setting properties - * not backed by options will result in MPV_ERROR_PROPERTY_UNAVAILABLE. - * In some cases, properties and options still conflict. In these cases, - * mpv_set_property() accesses the options before mpv_initialize(), and - * the properties after mpv_initialize(). These conflicts will be removed - * in mpv 0.23.0. See mpv_set_option() for further remarks. - * - * @param name The property name. See input.rst for a list of properties. - * @param format see enum mpv_format. - * @param[in] data Option value. - * @return error code - */ -MPV_EXPORT int mpv_set_property(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Convenience function to set a property to a string value. - * - * This is like calling mpv_set_property() with MPV_FORMAT_STRING. - */ -MPV_EXPORT int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data); - -/** - * Convenience function to delete a property. - * - * This is equivalent to running the command "del [name]". - * - * @param name The property name. See input.rst for a list of properties. - * @return error code - */ -MPV_EXPORT int mpv_del_property(mpv_handle *ctx, const char *name); - -/** - * Set a property asynchronously. You will receive the result of the operation - * as MPV_EVENT_SET_PROPERTY_REPLY event. The mpv_event.error field will contain - * the result status of the operation. Otherwise, this function is similar to - * mpv_set_property(). - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata see section about asynchronous calls - * @param name The property name. - * @param format see enum mpv_format. - * @param[in] data Option value. The value will be copied by the function. It - * will never be modified by the client API. - * @return error code if sending the request failed - */ -MPV_EXPORT int mpv_set_property_async(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, mpv_format format, void *data); - -/** - * Read the value of the given property. - * - * If the format doesn't match with the internal format of the property, access - * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data - * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 - * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING - * usually invokes a string formatter. - * - * @param name The property name. - * @param format see enum mpv_format. - * @param[out] data Pointer to the variable holding the option value. On - * success, the variable will be set to a copy of the option - * value. For formats that require dynamic memory allocation, - * you can free the value with mpv_free() (strings) or - * mpv_free_node_contents() (MPV_FORMAT_NODE). - * @return error code - */ -MPV_EXPORT int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Return the value of the property with the given name as string. This is - * equivalent to mpv_get_property() with MPV_FORMAT_STRING. - * - * See MPV_FORMAT_STRING for character encoding issues. - * - * On error, NULL is returned. Use mpv_get_property() if you want fine-grained - * error reporting. - * - * @param name The property name. - * @return Property value, or NULL if the property can't be retrieved. Free - * the string with mpv_free(). - */ -MPV_EXPORT char *mpv_get_property_string(mpv_handle *ctx, const char *name); - -/** - * Return the property as "OSD" formatted string. This is the same as - * mpv_get_property_string, but using MPV_FORMAT_OSD_STRING. - * - * @return Property value, or NULL if the property can't be retrieved. Free - * the string with mpv_free(). - */ -MPV_EXPORT char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name); - -/** - * Get a property asynchronously. You will receive the result of the operation - * as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event. - * You should check the mpv_event.error field on the reply event. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata see section about asynchronous calls - * @param name The property name. - * @param format see enum mpv_format. - * @return error code if sending the request failed - */ -MPV_EXPORT int mpv_get_property_async(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, mpv_format format); - -/** - * Get a notification whenever the given property changes. You will receive - * updates as MPV_EVENT_PROPERTY_CHANGE. Note that this is not very precise: - * for some properties, it may not send updates even if the property changed. - * This depends on the property, and it's a valid feature request to ask for - * better update handling of a specific property. (For some properties, like - * ``clock``, which shows the wall clock, this mechanism doesn't make too - * much sense anyway.) - * - * Property changes are coalesced: the change events are returned only once the - * event queue becomes empty (e.g. mpv_wait_event() would block or return - * MPV_EVENT_NONE), and then only one event per changed property is returned. - * - * You always get an initial change notification. This is meant to initialize - * the user's state to the current value of the property. - * - * Normally, change events are sent only if the property value changes according - * to the requested format. mpv_event_property will contain the property value - * as data member. - * - * Warning: if a property is unavailable or retrieving it caused an error, - * MPV_FORMAT_NONE will be set in mpv_event_property, even if the - * format parameter was set to a different value. In this case, the - * mpv_event_property.data field is invalid. - * - * If the property is observed with the format parameter set to MPV_FORMAT_NONE, - * you get low-level notifications whether the property _may_ have changed, and - * the data member in mpv_event_property will be unset. With this mode, you - * will have to determine yourself whether the property really changed. On the - * other hand, this mechanism can be faster and uses less resources. - * - * Observing a property that doesn't exist is allowed. (Although it may still - * cause some sporadic change events.) - * - * Keep in mind that you will get change notifications even if you change a - * property yourself. Try to avoid endless feedback loops, which could happen - * if you react to the change notifications triggered by your own change. - * - * Only the mpv_handle on which this was called will receive the property - * change events, or can unobserve them. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata This will be used for the mpv_event.reply_userdata - * field for the received MPV_EVENT_PROPERTY_CHANGE - * events. (Also see section about asynchronous calls, - * although this function is somewhat different from - * actual asynchronous calls.) - * If you have no use for this, pass 0. - * Also see mpv_unobserve_property(). - * @param name The property name. - * @param format see enum mpv_format. Can be MPV_FORMAT_NONE to omit values - * from the change events. - * @return error code (usually fails only on OOM or unsupported format) - */ -MPV_EXPORT int mpv_observe_property(mpv_handle *mpv, uint64_t reply_userdata, - const char *name, mpv_format format); - -/** - * Undo mpv_observe_property(). This will remove all observed properties for - * which the given number was passed as reply_userdata to mpv_observe_property. - * - * Safe to be called from mpv render API threads. - * - * @param registered_reply_userdata ID that was passed to mpv_observe_property - * @return negative value is an error code, >=0 is number of removed properties - * on success (includes the case when 0 were removed) - */ -MPV_EXPORT int mpv_unobserve_property(mpv_handle *mpv, uint64_t registered_reply_userdata); - -typedef enum mpv_event_id { - /** - * Nothing happened. Happens on timeouts or sporadic wakeups. - */ - MPV_EVENT_NONE = 0, - /** - * Happens when the player quits. The player enters a state where it tries - * to disconnect all clients. Most requests to the player will fail, and - * the client should react to this and quit with mpv_destroy() as soon as - * possible. - */ - MPV_EVENT_SHUTDOWN = 1, - /** - * See mpv_request_log_messages(). - */ - MPV_EVENT_LOG_MESSAGE = 2, - /** - * Reply to a mpv_get_property_async() request. - * See also mpv_event and mpv_event_property. - */ - MPV_EVENT_GET_PROPERTY_REPLY = 3, - /** - * Reply to a mpv_set_property_async() request. - * (Unlike MPV_EVENT_GET_PROPERTY, mpv_event_property is not used.) - */ - MPV_EVENT_SET_PROPERTY_REPLY = 4, - /** - * Reply to a mpv_command_async() or mpv_command_node_async() request. - * See also mpv_event and mpv_event_command. - */ - MPV_EVENT_COMMAND_REPLY = 5, - /** - * Notification before playback start of a file (before the file is loaded). - * See also mpv_event and mpv_event_start_file. - */ - MPV_EVENT_START_FILE = 6, - /** - * Notification after playback end (after the file was unloaded). - * See also mpv_event and mpv_event_end_file. - */ - MPV_EVENT_END_FILE = 7, - /** - * Notification when the file has been loaded (headers were read etc.), and - * decoding starts. - */ - MPV_EVENT_FILE_LOADED = 8, -#if MPV_ENABLE_DEPRECATED - /** - * Idle mode was entered. In this mode, no file is played, and the playback - * core waits for new commands. (The command line player normally quits - * instead of entering idle mode, unless --idle was specified. If mpv - * was started with mpv_create(), idle mode is enabled by default.) - * - * @deprecated This is equivalent to using mpv_observe_property() on the - * "idle-active" property. The event is redundant, and might be - * removed in the far future. As a further warning, this event - * is not necessarily sent at the right point anymore (at the - * start of the program), while the property behaves correctly. - */ - MPV_EVENT_IDLE = 11, - /** - * Sent every time after a video frame is displayed. Note that currently, - * this will be sent in lower frequency if there is no video, or playback - * is paused - but that will be removed in the future, and it will be - * restricted to video frames only. - * - * @deprecated Use mpv_observe_property() with relevant properties instead - * (such as "playback-time"). - */ - MPV_EVENT_TICK = 14, -#endif - /** - * Triggered by the script-message input command. The command uses the - * first argument of the command as client name (see mpv_client_name()) to - * dispatch the message, and passes along all arguments starting from the - * second argument as strings. - * See also mpv_event and mpv_event_client_message. - */ - MPV_EVENT_CLIENT_MESSAGE = 16, - /** - * Happens after video changed in some way. This can happen on resolution - * changes, pixel format changes, or video filter changes. The event is - * sent after the video filters and the VO are reconfigured. Applications - * embedding a mpv window should listen to this event in order to resize - * the window if needed. - * Note that this event can happen sporadically, and you should check - * yourself whether the video parameters really changed before doing - * something expensive. - */ - MPV_EVENT_VIDEO_RECONFIG = 17, - /** - * Similar to MPV_EVENT_VIDEO_RECONFIG. This is relatively uninteresting, - * because there is no such thing as audio output embedding. - */ - MPV_EVENT_AUDIO_RECONFIG = 18, - /** - * Happens when a seek was initiated. Playback stops. Usually it will - * resume with MPV_EVENT_PLAYBACK_RESTART as soon as the seek is finished. - */ - MPV_EVENT_SEEK = 20, - /** - * There was a discontinuity of some sort (like a seek), and playback - * was reinitialized. Usually happens on start of playback and after - * seeking. The main purpose is allowing the client to detect when a seek - * request is finished. - */ - MPV_EVENT_PLAYBACK_RESTART = 21, - /** - * Event sent due to mpv_observe_property(). - * See also mpv_event and mpv_event_property. - */ - MPV_EVENT_PROPERTY_CHANGE = 22, - /** - * Happens if the internal per-mpv_handle ringbuffer overflows, and at - * least 1 event had to be dropped. This can happen if the client doesn't - * read the event queue quickly enough with mpv_wait_event(), or if the - * client makes a very large number of asynchronous calls at once. - * - * Event delivery will continue normally once this event was returned - * (this forces the client to empty the queue completely). - */ - MPV_EVENT_QUEUE_OVERFLOW = 24, - /** - * Triggered if a hook handler was registered with mpv_hook_add(), and the - * hook is invoked. If you receive this, you must handle it, and continue - * the hook with mpv_hook_continue(). - * See also mpv_event and mpv_event_hook. - */ - MPV_EVENT_HOOK = 25, - // Internal note: adjust INTERNAL_EVENT_BASE when adding new events. -} mpv_event_id; - -/** - * Return a string describing the event. For unknown events, NULL is returned. - * - * Note that all events actually returned by the API will also yield a non-NULL - * string with this function. - * - * @param event event ID, see see enum mpv_event_id - * @return A static string giving a short symbolic name of the event. It - * consists of lower-case alphanumeric characters and can include "-" - * characters. This string is suitable for use in e.g. scripting - * interfaces. - * The string is completely static, i.e. doesn't need to be deallocated, - * and is valid forever. - */ -MPV_EXPORT const char *mpv_event_name(mpv_event_id event); - -typedef struct mpv_event_property { - /** - * Name of the property. - */ - const char *name; - /** - * Format of the data field in the same struct. See enum mpv_format. - * This is always the same format as the requested format, except when - * the property could not be retrieved (unavailable, or an error happened), - * in which case the format is MPV_FORMAT_NONE. - */ - mpv_format format; - /** - * Received property value. Depends on the format. This is like the - * pointer argument passed to mpv_get_property(). - * - * For example, for MPV_FORMAT_STRING you get the string with: - * - * char *value = *(char **)(event_property->data); - * - * Note that this is set to NULL if retrieving the property failed (the - * format will be MPV_FORMAT_NONE). - */ - void *data; -} mpv_event_property; - -/** - * Numeric log levels. The lower the number, the more important the message is. - * MPV_LOG_LEVEL_NONE is never used when receiving messages. The string in - * the comment after the value is the name of the log level as used for the - * mpv_request_log_messages() function. - * Unused numeric values are unused, but reserved for future use. - */ -typedef enum mpv_log_level { - MPV_LOG_LEVEL_NONE = 0, /// "no" - disable absolutely all messages - MPV_LOG_LEVEL_FATAL = 10, /// "fatal" - critical/aborting errors - MPV_LOG_LEVEL_ERROR = 20, /// "error" - simple errors - MPV_LOG_LEVEL_WARN = 30, /// "warn" - possible problems - MPV_LOG_LEVEL_INFO = 40, /// "info" - informational message - MPV_LOG_LEVEL_V = 50, /// "v" - noisy informational message - MPV_LOG_LEVEL_DEBUG = 60, /// "debug" - very noisy technical information - MPV_LOG_LEVEL_TRACE = 70, /// "trace" - extremely noisy -} mpv_log_level; - -typedef struct mpv_event_log_message { - /** - * The module prefix, identifies the sender of the message. As a special - * case, if the message buffer overflows, this will be set to the string - * "overflow" (which doesn't appear as prefix otherwise), and the text - * field will contain an informative message. - */ - const char *prefix; - /** - * The log level as string. See mpv_request_log_messages() for possible - * values. The level "no" is never used here. - */ - const char *level; - /** - * The log message. It consists of 1 line of text, and is terminated with - * a newline character. (Before API version 1.6, it could contain multiple - * or partial lines.) - */ - const char *text; - /** - * The same contents as the level field, but as a numeric ID. - * Since API version 1.6. - */ - mpv_log_level log_level; -} mpv_event_log_message; - -/// Since API version 1.9. -typedef enum mpv_end_file_reason { - /** - * The end of file was reached. Sometimes this may also happen on - * incomplete or corrupted files, or if the network connection was - * interrupted when playing a remote file. It also happens if the - * playback range was restricted with --end or --frames or similar. - */ - MPV_END_FILE_REASON_EOF = 0, - /** - * Playback was stopped by an external action (e.g. playlist controls). - */ - MPV_END_FILE_REASON_STOP = 2, - /** - * Playback was stopped by the quit command or player shutdown. - */ - MPV_END_FILE_REASON_QUIT = 3, - /** - * Some kind of error happened that lead to playback abort. Does not - * necessarily happen on incomplete or broken files (in these cases, both - * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). - * - * mpv_event_end_file.error will be set. - */ - MPV_END_FILE_REASON_ERROR = 4, - /** - * The file was a playlist or similar. When the playlist is read, its - * entries will be appended to the playlist after the entry of the current - * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE - * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then - * playback continues with the playlist contents. - * Since API version 1.18. - */ - MPV_END_FILE_REASON_REDIRECT = 5, -} mpv_end_file_reason; - -/// Since API version 1.108. -typedef struct mpv_event_start_file { - /** - * Playlist entry ID of the file being loaded now. - */ - int64_t playlist_entry_id; -} mpv_event_start_file; - -typedef struct mpv_event_end_file { - /** - * Corresponds to the values in enum mpv_end_file_reason. - * - * Unknown values should be treated as unknown. - */ - mpv_end_file_reason reason; - /** - * If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code - * (one of MPV_ERROR_...) giving an approximate reason why playback - * failed. In other cases, this field is 0 (no error). - * Since API version 1.9. - */ - int error; - /** - * Playlist entry ID of the file that was being played or attempted to be - * played. This has the same value as the playlist_entry_id field in the - * corresponding mpv_event_start_file event. - * Since API version 1.108. - */ - int64_t playlist_entry_id; - /** - * If loading ended, because the playlist entry to be played was for example - * a playlist, and the current playlist entry is replaced with a number of - * other entries. This may happen at least with MPV_END_FILE_REASON_REDIRECT - * (other event types may use this for similar but different purposes in the - * future). In this case, playlist_insert_id will be set to the playlist - * entry ID of the first inserted entry, and playlist_insert_num_entries to - * the total number of inserted playlist entries. Note this in this specific - * case, the ID of the last inserted entry is playlist_insert_id+num-1. - * Beware that depending on circumstances, you may observe the new playlist - * entries before seeing the event (e.g. reading the "playlist" property or - * getting a property change notification before receiving the event). - * Since API version 1.108. - */ - int64_t playlist_insert_id; - /** - * See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never - * negative. - * Since API version 1.108. - */ - int playlist_insert_num_entries; -} mpv_event_end_file; - -typedef struct mpv_event_client_message { - /** - * Arbitrary arguments chosen by the sender of the message. If num_args > 0, - * you can access args[0] through args[num_args - 1] (inclusive). What - * these arguments mean is up to the sender and receiver. - * None of the valid items are NULL. - */ - int num_args; - const char **args; -} mpv_event_client_message; - -typedef struct mpv_event_hook { - /** - * The hook name as passed to mpv_hook_add(). - */ - const char *name; - /** - * Internal ID that must be passed to mpv_hook_continue(). - */ - uint64_t id; -} mpv_event_hook; - -// Since API version 1.102. -typedef struct mpv_event_command { - /** - * Result data of the command. Note that success/failure is signaled - * separately via mpv_event.error. This field is only for result data - * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set - * to MPV_FORMAT_NONE on failure. - */ - mpv_node result; -} mpv_event_command; - -typedef struct mpv_event { - /** - * One of mpv_event. Keep in mind that later ABI compatible releases might - * add new event types. These should be ignored by the API user. - */ - mpv_event_id event_id; - /** - * This is mainly used for events that are replies to (asynchronous) - * requests. It contains a status code, which is >= 0 on success, or < 0 - * on error (a mpv_error value). Usually, this will be set if an - * asynchronous request fails. - * Used for: - * MPV_EVENT_GET_PROPERTY_REPLY - * MPV_EVENT_SET_PROPERTY_REPLY - * MPV_EVENT_COMMAND_REPLY - */ - int error; - /** - * If the event is in reply to a request (made with this API and this - * API handle), this is set to the reply_userdata parameter of the request - * call. Otherwise, this field is 0. - * Used for: - * MPV_EVENT_GET_PROPERTY_REPLY - * MPV_EVENT_SET_PROPERTY_REPLY - * MPV_EVENT_COMMAND_REPLY - * MPV_EVENT_PROPERTY_CHANGE - * MPV_EVENT_HOOK - */ - uint64_t reply_userdata; - /** - * The meaning and contents of the data member depend on the event_id: - * MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* - * MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* - * MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* - * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* - * MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) - * MPV_EVENT_END_FILE: mpv_event_end_file* - * MPV_EVENT_HOOK: mpv_event_hook* - * MPV_EVENT_COMMAND_REPLY* mpv_event_command* - * other: NULL - * - * Note: future enhancements might add new event structs for existing or new - * event types. - */ - void *data; -} mpv_event; - -/** - * Convert the given src event to a mpv_node, and set *dst to the result. *dst - * is set to a MPV_FORMAT_NODE_MAP, with fields for corresponding mpv_event and - * mpv_event.data/mpv_event_* fields. - * - * The exact details are not completely documented out of laziness. A start - * is located in the "Events" section of the manpage. - * - * *dst may point to newly allocated memory, or pointers in mpv_event. You must - * copy the entire mpv_node if you want to reference it after mpv_event becomes - * invalid (such as making a new mpv_wait_event() call, or destroying the - * mpv_handle from which it was returned). Call mpv_free_node_contents() to free - * any memory allocations made by this API function. - * - * Safe to be called from mpv render API threads. - * - * @param dst Target. This is not read and fully overwritten. Must be released - * with mpv_free_node_contents(). Do not write to pointers returned - * by it. (On error, this may be left as an empty node.) - * @param src The source event. Not modified (it's not const due to the author's - * prejudice of the C version of const). - * @return error code (MPV_ERROR_NOMEM only, if at all) - */ -MPV_EXPORT int mpv_event_to_node(mpv_node *dst, mpv_event *src); - -/** - * Enable or disable the given event. - * - * Some events are enabled by default. Some events can't be disabled. - * - * (Informational note: currently, all events are enabled by default, except - * MPV_EVENT_TICK.) - * - * Safe to be called from mpv render API threads. - * - * @param event See enum mpv_event_id. - * @param enable 1 to enable receiving this event, 0 to disable it. - * @return error code - */ -MPV_EXPORT int mpv_request_event(mpv_handle *ctx, mpv_event_id event, int enable); - -/** - * Enable or disable receiving of log messages. These are the messages the - * command line player prints to the terminal. This call sets the minimum - * required log level for a message to be received with MPV_EVENT_LOG_MESSAGE. - * - * @param min_level Minimal log level as string. Valid log levels: - * no fatal error warn info v debug trace - * The value "no" disables all messages. This is the default. - * An exception is the value "terminal-default", which uses the - * log level as set by the "--msg-level" option. This works - * even if the terminal is disabled. (Since API version 1.19.) - * Also see mpv_log_level. - * @return error code - */ -MPV_EXPORT int mpv_request_log_messages(mpv_handle *ctx, const char *min_level); - -/** - * Wait for the next event, or until the timeout expires, or if another thread - * makes a call to mpv_wakeup(). Passing 0 as timeout will never wait, and - * is suitable for polling. - * - * The internal event queue has a limited size (per client handle). If you - * don't empty the event queue quickly enough with mpv_wait_event(), it will - * overflow and silently discard further events. If this happens, making - * asynchronous requests will fail as well (with MPV_ERROR_EVENT_QUEUE_FULL). - * - * Only one thread is allowed to call this on the same mpv_handle at a time. - * The API won't complain if more than one thread calls this, but it will cause - * race conditions in the client when accessing the shared mpv_event struct. - * Note that most other API functions are not restricted by this, and no API - * function internally calls mpv_wait_event(). Additionally, concurrent calls - * to different mpv_handles are always safe. - * - * As long as the timeout is 0, this is safe to be called from mpv render API - * threads. - * - * @param timeout Timeout in seconds, after which the function returns even if - * no event was received. A MPV_EVENT_NONE is returned on - * timeout. A value of 0 will disable waiting. Negative values - * will wait with an infinite timeout. - * @return A struct containing the event ID and other data. The pointer (and - * fields in the struct) stay valid until the next mpv_wait_event() - * call, or until the mpv_handle is destroyed. You must not write to - * the struct, and all memory referenced by it will be automatically - * released by the API on the next mpv_wait_event() call, or when the - * context is destroyed. The return value is never NULL. - */ -MPV_EXPORT mpv_event *mpv_wait_event(mpv_handle *ctx, double timeout); - -/** - * Interrupt the current mpv_wait_event() call. This will wake up the thread - * currently waiting in mpv_wait_event(). If no thread is waiting, the next - * mpv_wait_event() call will return immediately (this is to avoid lost - * wakeups). - * - * mpv_wait_event() will receive a MPV_EVENT_NONE if it's woken up due to - * this call. But note that this dummy event might be skipped if there are - * already other events queued. All what counts is that the waiting thread - * is woken up at all. - * - * Safe to be called from mpv render API threads. - */ -MPV_EXPORT void mpv_wakeup(mpv_handle *ctx); - -/** - * Set a custom function that should be called when there are new events. Use - * this if blocking in mpv_wait_event() to wait for new events is not feasible. - * - * Keep in mind that the callback will be called from foreign threads. You - * must not make any assumptions of the environment, and you must return as - * soon as possible (i.e. no long blocking waits). Exiting the callback through - * any other means than a normal return is forbidden (no throwing exceptions, - * no longjmp() calls). You must not change any local thread state (such as - * the C floating point environment). - * - * You are not allowed to call any client API functions inside of the callback. - * In particular, you should not do any processing in the callback, but wake up - * another thread that does all the work. The callback is meant strictly for - * notification only, and is called from arbitrary core parts of the player, - * that make no considerations for reentrant API use or allowing the callee to - * spend a lot of time doing other things. Keep in mind that it's also possible - * that the callback is called from a thread while a mpv API function is called - * (i.e. it can be reentrant). - * - * In general, the client API expects you to call mpv_wait_event() to receive - * notifications, and the wakeup callback is merely a helper utility to make - * this easier in certain situations. Note that it's possible that there's - * only one wakeup callback invocation for multiple events. You should call - * mpv_wait_event() with no timeout until MPV_EVENT_NONE is reached, at which - * point the event queue is empty. - * - * If you actually want to do processing in a callback, spawn a thread that - * does nothing but call mpv_wait_event() in a loop and dispatches the result - * to a callback. - * - * Only one wakeup callback can be set. - * - * @param cb function that should be called if a wakeup is required - * @param d arbitrary userdata passed to cb - */ -MPV_EXPORT void mpv_set_wakeup_callback(mpv_handle *ctx, void (*cb)(void *d), void *d); - -/** - * Block until all asynchronous requests are done. This affects functions like - * mpv_command_async(), which return immediately and return their result as - * events. - * - * This is a helper, and somewhat equivalent to calling mpv_wait_event() in a - * loop until all known asynchronous requests have sent their reply as event, - * except that the event queue is not emptied. - * - * In case you called mpv_suspend() before, this will also forcibly reset the - * suspend counter of the given handle. - */ -MPV_EXPORT void mpv_wait_async_requests(mpv_handle *ctx); - -/** - * A hook is like a synchronous event that blocks the player. You register - * a hook handler with this function. You will get an event, which you need - * to handle, and once things are ready, you can let the player continue with - * mpv_hook_continue(). - * - * Currently, hooks can't be removed explicitly. But they will be implicitly - * removed if the mpv_handle it was registered with is destroyed. This also - * continues the hook if it was being handled by the destroyed mpv_handle (but - * this should be avoided, as it might mess up order of hook execution). - * - * Hook handlers are ordered globally by priority and order of registration. - * Handlers for the same hook with same priority are invoked in order of - * registration (the handler registered first is run first). Handlers with - * lower priority are run first (which seems backward). - * - * See the "Hooks" section in the manpage to see which hooks are currently - * defined. - * - * Some hooks might be reentrant (so you get multiple MPV_EVENT_HOOK for the - * same hook). If this can happen for a specific hook type, it will be - * explicitly documented in the manpage. - * - * Only the mpv_handle on which this was called will receive the hook events, - * or can "continue" them. - * - * @param reply_userdata This will be used for the mpv_event.reply_userdata - * field for the received MPV_EVENT_HOOK events. - * If you have no use for this, pass 0. - * @param name The hook name. This should be one of the documented names. But - * if the name is unknown, the hook event will simply be never - * raised. - * @param priority See remarks above. Use 0 as a neutral default. - * @return error code (usually fails only on OOM) - */ -MPV_EXPORT int mpv_hook_add(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, int priority); - -/** - * Respond to a MPV_EVENT_HOOK event. You must call this after you have handled - * the event. There is no way to "cancel" or "stop" the hook. - * - * Calling this will will typically unblock the player for whatever the hook - * is responsible for (e.g. for the "on_load" hook it lets it continue - * playback). - * - * It is explicitly undefined behavior to call this more than once for each - * MPV_EVENT_HOOK, to pass an incorrect ID, or to call this on a mpv_handle - * different from the one that registered the handler and received the event. - * - * @param id This must be the value of the mpv_event_hook.id field for the - * corresponding MPV_EVENT_HOOK. - * @return error code - */ -MPV_EXPORT int mpv_hook_continue(mpv_handle *ctx, uint64_t id); - -#if MPV_ENABLE_DEPRECATED - -/** - * Return a UNIX file descriptor referring to the read end of a pipe. This - * pipe can be used to wake up a poll() based processing loop. The purpose of - * this function is very similar to mpv_set_wakeup_callback(), and provides - * a primitive mechanism to handle coordinating a foreign event loop and the - * libmpv event loop. The pipe is non-blocking. It's closed when the mpv_handle - * is destroyed. This function always returns the same value (on success). - * - * This is in fact implemented using the same underlying code as for - * mpv_set_wakeup_callback() (though they don't conflict), and it is as if each - * callback invocation writes a single 0 byte to the pipe. When the pipe - * becomes readable, the code calling poll() (or select()) on the pipe should - * read all contents of the pipe and then call mpv_wait_event(c, 0) until - * no new events are returned. The pipe contents do not matter and can just - * be discarded. There is not necessarily one byte per readable event in the - * pipe. For example, the pipes are non-blocking, and mpv won't block if the - * pipe is full. Pipes are normally limited to 4096 bytes, so if there are - * more than 4096 events, the number of readable bytes can not equal the number - * of events queued. Also, it's possible that mpv does not write to the pipe - * once it's guaranteed that the client was already signaled. See the example - * below how to do it correctly. - * - * Example: - * - * int pipefd = mpv_get_wakeup_pipe(mpv); - * if (pipefd < 0) - * error(); - * while (1) { - * struct pollfd pfds[1] = { - * { .fd = pipefd, .events = POLLIN }, - * }; - * // Wait until there are possibly new mpv events. - * poll(pfds, 1, -1); - * if (pfds[0].revents & POLLIN) { - * // Empty the pipe. Doing this before calling mpv_wait_event() - * // ensures that no wakeups are missed. It's not so important to - * // make sure the pipe is really empty (it will just cause some - * // additional wakeups in unlikely corner cases). - * char unused[256]; - * read(pipefd, unused, sizeof(unused)); - * while (1) { - * mpv_event *ev = mpv_wait_event(mpv, 0); - * // If MPV_EVENT_NONE is received, the event queue is empty. - * if (ev->event_id == MPV_EVENT_NONE) - * break; - * // Process the event. - * ... - * } - * } - * } - * - * @deprecated this function will be removed in the future. If you need this - * functionality, use mpv_set_wakeup_callback(), create a pipe - * manually, and call write() on your pipe in the callback. - * - * @return A UNIX FD of the read end of the wakeup pipe, or -1 on error. - * On MS Windows/MinGW, this will always return -1. - */ -MPV_EXPORT int mpv_get_wakeup_pipe(mpv_handle *ctx); - -#endif - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h deleted file mode 100644 index 29f9b91e9..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render.h +++ /dev/null @@ -1,738 +0,0 @@ -/* Copyright (C) 2018 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_RENDER_H_ -#define MPV_CLIENT_API_RENDER_H_ - -#include "client.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Overview - * -------- - * - * This API can be used to make mpv render using supported graphic APIs (such - * as OpenGL). It can be used to handle video display. - * - * The renderer needs to be created with mpv_render_context_create() before - * you start playback (or otherwise cause a VO to be created). Then (with most - * backends) mpv_render_context_render() can be used to explicitly render the - * current video frame. Use mpv_render_context_set_update_callback() to get - * notified when there is a new frame to draw. - * - * Preferably rendering should be done in a separate thread. If you call - * normal libmpv API functions on the renderer thread, deadlocks can result - * (these are made non-fatal with timeouts, but user experience will obviously - * suffer). See "Threading" section below. - * - * You can output and embed video without this API by setting the mpv "wid" - * option to a native window handle (see "Embedding the video window" section - * in the client.h header). In general, using the render API is recommended, - * because window embedding can cause various issues, especially with GUI - * toolkits and certain platforms. - * - * Supported backends - * ------------------ - * - * OpenGL: via MPV_RENDER_API_TYPE_OPENGL, see render_gl.h header. - * Software: via MPV_RENDER_API_TYPE_SW, see section "Software renderer" - * - * Threading - * --------- - * - * You are recommended to do rendering on a separate thread than normal libmpv - * use. - * - * The mpv_render_* functions can be called from any thread, under the - * following conditions: - * - only one of the mpv_render_* functions can be called at the same time - * (unless they belong to different mpv cores created by mpv_create()) - * - never can be called from within the callbacks set with - * mpv_set_wakeup_callback() or mpv_render_context_set_update_callback() - * - if the OpenGL backend is used, for all functions the OpenGL context - * must be "current" in the calling thread, and it must be the same OpenGL - * context as the mpv_render_context was created with. Otherwise, undefined - * behavior will occur. - * - the thread does not call libmpv API functions other than the mpv_render_* - * functions, except APIs which are declared as safe (see below). Likewise, - * there must be no lock or wait dependency from the render thread to a - * thread using other libmpv functions. Basically, the situation that your - * render thread waits for a "not safe" libmpv API function to return must - * not happen. If you ignore this requirement, deadlocks can happen, which - * are made non-fatal with timeouts; then playback quality will be degraded, - * and the message - * mpv_render_context_render() not being called or stuck. - * is logged. If you set MPV_RENDER_PARAM_ADVANCED_CONTROL, you promise that - * this won't happen, and must absolutely guarantee it, or a real deadlock - * will freeze the mpv core thread forever. - * - * libmpv functions which are safe to call from a render thread are: - * - functions marked with "Safe to be called from mpv render API threads." - * - client.h functions which don't have an explicit or implicit mpv_handle - * parameter - * - mpv_render_* functions; but only for the same mpv_render_context pointer. - * If the pointer is different, mpv_render_context_free() is not safe. (The - * reason is that if MPV_RENDER_PARAM_ADVANCED_CONTROL is set, it may have - * to process still queued requests from the core, which it can do only for - * the current context, while requests for other contexts would deadlock. - * Also, it may have to wait and block for the core to terminate the video - * chain to make sure no resources are used after context destruction.) - * - if the mpv_handle parameter refers to a different mpv core than the one - * you're rendering for (very obscure, but allowed) - * - * Note about old libmpv version: - * - * Before API version 1.105 (basically in mpv 0.29.x), simply enabling - * MPV_RENDER_PARAM_ADVANCED_CONTROL could cause deadlock issues. This can - * be worked around by setting the "vd-lavc-dr" option to "no". - * In addition, you were required to call all mpv_render*() API functions - * from the same thread on which mpv_render_context_create() was originally - * run (for the same the mpv_render_context). Not honoring it led to UB - * (deadlocks, use of invalid pthread_t handles), even if you moved your GL - * context to a different thread correctly. - * These problems were addressed in API version 1.105 (mpv 0.30.0). - * - * Context and handle lifecycle - * ---------------------------- - * - * Video initialization will fail if the render context was not initialized yet - * (with mpv_render_context_create()), or it will revert to a VO that creates - * its own window. - * - * Currently, there can be only 1 mpv_render_context at a time per mpv core. - * - * Calling mpv_render_context_free() while a VO is using the render context is - * active will disable video. - * - * You must free the context with mpv_render_context_free() before the mpv core - * is destroyed. If this doesn't happen, undefined behavior will result. - * - * Software renderer - * ----------------- - * - * MPV_RENDER_API_TYPE_SW provides an extremely simple (but slow) renderer to - * memory surfaces. You probably don't want to use this. Use other render API - * types, or other methods of video embedding. - * - * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to - * MPV_RENDER_API_TYPE_SW. - * - * Call mpv_render_context_render() with various MPV_RENDER_PARAM_SW_* fields - * to render the video frame to an in-memory surface. The following fields are - * required: MPV_RENDER_PARAM_SW_SIZE, MPV_RENDER_PARAM_SW_FORMAT, - * MPV_RENDER_PARAM_SW_STRIDE, MPV_RENDER_PARAM_SW_POINTER. - * - * This method of rendering is very slow, because everything, including color - * conversion, scaling, and OSD rendering, is done on the CPU, single-threaded. - * In particular, large video or display sizes, as well as presence of OSD or - * subtitles can make it too slow for realtime. As with other software rendering - * VOs, setting "sw-fast" may help. Enabling or disabling zimg may help, - * depending on the platform. - * - * In addition, certain multimedia job creation measures like HDR may not work - * properly, and will have to be manually handled by for example inserting - * filters. - * - * This API is not really suitable to extract individual frames from video etc. - * (basically non-playback uses) - there are better libraries for this. It can - * be used this way, but it may be clunky and tricky. - * - * Further notes: - * - MPV_RENDER_PARAM_FLIP_Y is currently ignored (unsupported) - * - MPV_RENDER_PARAM_DEPTH is ignored (meaningless) - */ - -/** - * Opaque context, returned by mpv_render_context_create(). - */ -typedef struct mpv_render_context mpv_render_context; - -/** - * Parameters for mpv_render_param (which is used in a few places such as - * mpv_render_context_create(). - * - * Also see mpv_render_param for conventions and how to use it. - */ -typedef enum mpv_render_param_type { - /** - * Not a valid value, but also used to terminate a params array. Its value - * is always guaranteed to be 0 (even if the ABI changes in the future). - */ - MPV_RENDER_PARAM_INVALID = 0, - /** - * The render API to use. Valid for mpv_render_context_create(). - * - * Type: char* - * - * Defined APIs: - * - * MPV_RENDER_API_TYPE_OPENGL: - * OpenGL desktop 2.1 or later (preferably core profile compatible to - * OpenGL 3.2), or OpenGLES 2.0 or later. - * Providing MPV_RENDER_PARAM_OPENGL_INIT_PARAMS is required. - * It is expected that an OpenGL context is valid and "current" when - * calling mpv_render_* functions (unless specified otherwise). It - * must be the same context for the same mpv_render_context. - */ - MPV_RENDER_PARAM_API_TYPE = 1, - /** - * Required parameters for initializing the OpenGL renderer. Valid for - * mpv_render_context_create(). - * Type: mpv_opengl_init_params* - */ - MPV_RENDER_PARAM_OPENGL_INIT_PARAMS = 2, - /** - * Describes a GL render target. Valid for mpv_render_context_render(). - * Type: mpv_opengl_fbo* - */ - MPV_RENDER_PARAM_OPENGL_FBO = 3, - /** - * Control flipped rendering. Valid for mpv_render_context_render(). - * Type: int* - * If the value is set to 0, render normally. Otherwise, render it flipped, - * which is needed e.g. when rendering to an OpenGL default framebuffer - * (which has a flipped coordinate system). - */ - MPV_RENDER_PARAM_FLIP_Y = 4, - /** - * Control surface depth. Valid for mpv_render_context_render(). - * Type: int* - * This implies the depth of the surface passed to the render function in - * bits per channel. If omitted or set to 0, the renderer will assume 8. - * Typically used to control dithering. - */ - MPV_RENDER_PARAM_DEPTH = 5, - /** - * ICC profile blob. Valid for mpv_render_context_set_parameter(). - * Type: mpv_byte_array* - * Set an ICC profile for use with the "icc-profile-auto" option. (If the - * option is not enabled, the ICC data will not be used.) - */ - MPV_RENDER_PARAM_ICC_PROFILE = 6, - /** - * Ambient light in lux. Valid for mpv_render_context_set_parameter(). - * Type: int* - * This can be used for automatic gamma correction. - */ - MPV_RENDER_PARAM_AMBIENT_LIGHT = 7, - /** - * X11 Display, sometimes used for hwdec. Valid for - * mpv_render_context_create(). The Display must stay valid for the lifetime - * of the mpv_render_context. - * Type: Display* - */ - MPV_RENDER_PARAM_X11_DISPLAY = 8, - /** - * Wayland display, sometimes used for hwdec. Valid for - * mpv_render_context_create(). The wl_display must stay valid for the - * lifetime of the mpv_render_context. - * Type: struct wl_display* - */ - MPV_RENDER_PARAM_WL_DISPLAY = 9, - /** - * Better control about rendering and enabling some advanced features. Valid - * for mpv_render_context_create(). - * - * This conflates multiple requirements the API user promises to abide if - * this option is enabled: - * - * - The API user's render thread, which is calling the mpv_render_*() - * functions, never waits for the core. Otherwise deadlocks can happen. - * See "Threading" section. - * - The callback set with mpv_render_context_set_update_callback() can now - * be called even if there is no new frame. The API user should call the - * mpv_render_context_update() function, and interpret the return value - * for whether a new frame should be rendered. - * - Correct functionality is impossible if the update callback is not set, - * or not set soon enough after mpv_render_context_create() (the core can - * block while waiting for you to call mpv_render_context_update(), and - * if the update callback is not correctly set, it will deadlock, or - * block for too long). - * - * In general, setting this option will enable the following features (and - * possibly more): - * - * - "Direct rendering", which means the player decodes directly to a - * texture, which saves a copy per video frame ("vd-lavc-dr" option - * needs to be enabled, and the rendering backend as well as the - * underlying GPU API/driver needs to have support for it). - * - Rendering screenshots with the GPU API if supported by the backend - * (instead of using a suboptimal software fallback via libswscale). - * - * Warning: do not just add this without reading the "Threading" section - * above, and then wondering that deadlocks happen. The - * requirements are tricky. But also note that even if advanced - * control is disabled, not adhering to the rules will lead to - * playback problems. Enabling advanced controls simply makes - * violating these rules fatal. - * - * Type: int*: 0 for disable (default), 1 for enable - */ - MPV_RENDER_PARAM_ADVANCED_CONTROL = 10, - /** - * Return information about the next frame to render. Valid for - * mpv_render_context_get_info(). - * - * Type: mpv_render_frame_info* - * - * It strictly returns information about the _next_ frame. The implication - * is that e.g. mpv_render_context_update()'s return value will have - * MPV_RENDER_UPDATE_FRAME set, and the user is supposed to call - * mpv_render_context_render(). If there is no next frame, then the - * return value will have is_valid set to 0. - */ - MPV_RENDER_PARAM_NEXT_FRAME_INFO = 11, - /** - * Enable or disable video timing. Valid for mpv_render_context_render(). - * - * Type: int*: 0 for disable, 1 for enable (default) - * - * When video is timed to audio, the player attempts to render video a bit - * ahead, and then do a blocking wait until the target display time is - * reached. This blocks mpv_render_context_render() for up to the amount - * specified with the "video-timing-offset" global option. You can set - * this parameter to 0 to disable this kind of waiting. If you do, it's - * recommended to use the target time value in mpv_render_frame_info to - * wait yourself, or to set the "video-timing-offset" to 0 instead. - * - * Disabling this without doing anything in addition will result in A/V sync - * being slightly off. - */ - MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, - /** - * Use to skip rendering in mpv_render_context_render(). - * - * Type: int*: 0 for rendering (default), 1 for skipping - * - * If this is set, you don't need to pass a target surface to the render - * function (and if you do, it's completely ignored). This can still call - * into the lower level APIs (i.e. if you use OpenGL, the OpenGL context - * must be set). - * - * Be aware that the render API will consider this frame as having been - * rendered. All other normal rules also apply, for example about whether - * you have to call mpv_render_context_report_swap(). It also does timing - * in the same way. - */ - MPV_RENDER_PARAM_SKIP_RENDERING = 13, - /** - * Deprecated. Not supported. Use MPV_RENDER_PARAM_DRM_DISPLAY_V2 instead. - * Type : struct mpv_opengl_drm_params* - */ - MPV_RENDER_PARAM_DRM_DISPLAY = 14, - /** - * DRM draw surface size, contains draw surface dimensions. - * Valid for mpv_render_context_create(). - * Type : struct mpv_opengl_drm_draw_surface_size* - */ - MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE = 15, - /** - * DRM display, contains drm display handles. - * Valid for mpv_render_context_create(). - * Type : struct mpv_opengl_drm_params_v2* - */ - MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];) - * - * The video frame is transformed as with other VOs. Typically, this means - * the video gets scaled and black bars are added if the video size or - * aspect ratio mismatches with the target size. - */ - MPV_RENDER_PARAM_SW_SIZE = 17, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: char* (e.g.: char *f = "rgb0"; param.data = f;) - * - * Valid values are: - * "rgb0", "bgr0", "0bgr", "0rgb" - * 4 bytes per pixel RGB, 1 byte (8 bit) per component, component bytes - * with increasing address from left to right (e.g. "rgb0" has r at - * address 0), the "0" component contains uninitialized garbage (often - * the value 0, but not necessarily; the bad naming is inherited from - * FFmpeg) - * Pixel alignment size: 4 bytes - * "rgb24" - * 3 bytes per pixel RGB. This is strongly discouraged because it is - * very slow. - * Pixel alignment size: 1 bytes - * other - * The API may accept other pixel formats, using mpv internal format - * names, as long as it's internally marked as RGB, has exactly 1 - * plane, and is supported as conversion output. It is not a good idea - * to rely on any of these. Their semantics and handling could change. - */ - MPV_RENDER_PARAM_SW_FORMAT = 18, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: size_t* - * - * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the - * target surface. It must be a multiple of the pixel size, and have space - * for the surface width as specified by MPV_RENDER_PARAM_SW_SIZE. - * - * Both stride and pointer value should be a multiple of 64 to facilitate - * fast SIMD operation. Lower alignment might trigger slower code paths, - * and in the worst case, will copy the entire target frame. If mpv is built - * with zimg (and zimg is not disabled), the performance impact might be - * less. - * In either cases, the pointer and stride must be aligned at least to the - * pixel alignment size. Otherwise, crashes and undefined behavior is - * possible on platforms which do not support unaligned accesses (either - * through normal memory access or aligned SIMD memory access instructions). - */ - MPV_RENDER_PARAM_SW_STRIDE = 19, - /* - * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data pointer, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: void* - * - * This points to the first pixel at the left/top corner (0, 0). In - * particular, each line y starts at (pointer + stride * y). Upon rendering, - * all data between pointer and (pointer + stride * h) is overwritten. - * Whether the padding between (w, y) and (0, y + 1) is overwritten is left - * unspecified (it should not be, but unfortunately some scaler backends - * will do it anyway). It is assumed that even the padding after the last - * line (starting at bytepos(w, h) until (pointer + stride * h)) is - * writable. - * - * See MPV_RENDER_PARAM_SW_STRIDE for alignment requirements. - */ - MPV_RENDER_PARAM_SW_POINTER = 20, -} mpv_render_param_type; - -/** - * For backwards compatibility with the old naming of - * MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE - */ -#define MPV_RENDER_PARAM_DRM_OSD_SIZE MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE - -/** - * Used to pass arbitrary parameters to some mpv_render_* functions. The - * meaning of the data parameter is determined by the type, and each - * MPV_RENDER_PARAM_* documents what type the value must point to. - * - * Each value documents the required data type as the pointer you cast to - * void* and set on mpv_render_param.data. For example, if MPV_RENDER_PARAM_FOO - * documents the type as Something* , then the code should look like this: - * - * Something foo = {...}; - * mpv_render_param param; - * param.type = MPV_RENDER_PARAM_FOO; - * param.data = & foo; - * - * Normally, the data field points to exactly 1 object. If the type is char*, - * it points to a 0-terminated string. - * - * In all cases (unless documented otherwise) the pointers need to remain - * valid during the call only. Unless otherwise documented, the API functions - * will not write to the params array or any data pointed to it. - * - * As a convention, parameter arrays are always terminated by type==0. There - * is no specific order of the parameters required. The order of the 2 fields in - * this struct is guaranteed (even after ABI changes). - */ -typedef struct mpv_render_param { - enum mpv_render_param_type type; - void *data; -} mpv_render_param; - - -/** - * Predefined values for MPV_RENDER_PARAM_API_TYPE. - */ -// See render_gl.h -#define MPV_RENDER_API_TYPE_OPENGL "opengl" -// See section "Software renderer" -#define MPV_RENDER_API_TYPE_SW "sw" - -/** - * Flags used in mpv_render_frame_info.flags. Each value represents a bit in it. - */ -typedef enum mpv_render_frame_info_flag { - /** - * Set if there is actually a next frame. If unset, there is no next frame - * yet, and other flags and fields that require a frame to be queued will - * be unset. - * - * This is set for _any_ kind of frame, even for redraw requests. - * - * Note that when this is unset, it simply means no new frame was - * decoded/queued yet, not necessarily that the end of the video was - * reached. A new frame can be queued after some time. - * - * If the return value of mpv_render_context_render() had the - * MPV_RENDER_UPDATE_FRAME flag set, this flag will usually be set as well, - * unless the frame is rendered, or discarded by other asynchronous events. - */ - MPV_RENDER_FRAME_INFO_PRESENT = 1 << 0, - /** - * If set, the frame is not an actual new video frame, but a redraw request. - * For example if the video is paused, and an option that affects video - * rendering was changed (or any other reason), an update request can be - * issued and this flag will be set. - * - * Typically, redraw frames will not be subject to video timing. - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_REDRAW = 1 << 1, - /** - * If set, this is supposed to reproduce the previous frame perfectly. This - * is usually used for certain "video-sync" options ("display-..." modes). - * Typically the renderer will blit the video from a FBO. Unset otherwise. - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, - /** - * If set, the player timing code expects that the user thread blocks on - * vsync (by either delaying the render call, or by making a call to - * mpv_render_context_report_swap() at vsync time). - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, -} mpv_render_frame_info_flag; - -/** - * Information about the next video frame that will be rendered. Can be - * retrieved with MPV_RENDER_PARAM_NEXT_FRAME_INFO. - */ -typedef struct mpv_render_frame_info { - /** - * A bitset of mpv_render_frame_info_flag values (i.e. multiple flags are - * combined with bitwise or). - */ - uint64_t flags; - /** - * Absolute time at which the frame is supposed to be displayed. This is in - * the same unit and base as the time returned by mpv_get_time_us(). For - * frames that are redrawn, or if vsync locked video timing is used (see - * "video-sync" option), then this can be 0. The "video-timing-offset" - * option determines how much "headroom" the render thread gets (but a high - * enough frame rate can reduce it anyway). mpv_render_context_render() will - * normally block until the time is elapsed, unless you pass it - * MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 0. - */ - int64_t target_time; -} mpv_render_frame_info; - -/** - * Initialize the renderer state. Depending on the backend used, this will - * access the underlying GPU API and initialize its own objects. - * - * You must free the context with mpv_render_context_free(). Not doing so before - * the mpv core is destroyed may result in memory leaks or crashes. - * - * Currently, only at most 1 context can exists per mpv core (it represents the - * main video output). - * - * You should pass the following parameters: - * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API. - * - Backend-specific init parameter, like MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. - * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is - * strongly recommended. - * - If you want to use hwdec, possibly hwdec interop resources. - * - * @param res set to the context (on success) or NULL (on failure). The value - * is never read and always overwritten. - * @param mpv handle used to get the core (the mpv_render_context won't depend - * on this specific handle, only the core referenced by it) - * @param params an array of parameters, terminated by type==0. It's left - * unspecified what happens with unknown parameters. At least - * MPV_RENDER_PARAM_API_TYPE is required, and most backends will - * require another backend-specific parameter. - * @return error code, including but not limited to: - * MPV_ERROR_UNSUPPORTED: the OpenGL version is not supported - * (or required extensions are missing) - * MPV_ERROR_NOT_IMPLEMENTED: an unknown API type was provided, or - * support for the requested API was not - * built in the used libmpv binary. - * MPV_ERROR_INVALID_PARAMETER: at least one of the provided parameters was - * not valid. - */ -MPV_EXPORT int mpv_render_context_create(mpv_render_context **res, mpv_handle *mpv, - mpv_render_param *params); - -/** - * Attempt to change a single parameter. Not all backends and parameter types - * support all kinds of changes. - * - * @param ctx a valid render context - * @param param the parameter type and data that should be set - * @return error code. If a parameter could actually be changed, this returns - * success, otherwise an error code depending on the parameter type - * and situation. - */ -MPV_EXPORT int mpv_render_context_set_parameter(mpv_render_context *ctx, - mpv_render_param param); - -/** - * Retrieve information from the render context. This is NOT a counterpart to - * mpv_render_context_set_parameter(), because you generally can't read - * parameters set with it, and this function is not meant for this purpose. - * Instead, this is for communicating information from the renderer back to the - * user. See mpv_render_param_type; entries which support this function - * explicitly mention it, and for other entries you can assume it will fail. - * - * You pass param with param.type set and param.data pointing to a variable - * of the required data type. The function will then overwrite that variable - * with the returned value (at least on success). - * - * @param ctx a valid render context - * @param param the parameter type and data that should be retrieved - * @return error code. If a parameter could actually be retrieved, this returns - * success, otherwise an error code depending on the parameter type - * and situation. MPV_ERROR_NOT_IMPLEMENTED is used for unknown - * param.type, or if retrieving it is not supported. - */ -MPV_EXPORT int mpv_render_context_get_info(mpv_render_context *ctx, - mpv_render_param param); - -typedef void (*mpv_render_update_fn)(void *cb_ctx); - -/** - * Set the callback that notifies you when a new video frame is available, or - * if the video display configuration somehow changed and requires a redraw. - * Similar to mpv_set_wakeup_callback(), you must not call any mpv API from - * the callback, and all the other listed restrictions apply (such as not - * exiting the callback by throwing exceptions). - * - * This can be called from any thread, except from an update callback. In case - * of the OpenGL backend, no OpenGL state or API is accessed. - * - * Calling this will raise an update callback immediately. - * - * @param callback callback(callback_ctx) is called if the frame should be - * redrawn - * @param callback_ctx opaque argument to the callback - */ -MPV_EXPORT void mpv_render_context_set_update_callback(mpv_render_context *ctx, - mpv_render_update_fn callback, - void *callback_ctx); - -/** - * The API user is supposed to call this when the update callback was invoked - * (like all mpv_render_* functions, this has to happen on the render thread, - * and _not_ from the update callback itself). - * - * This is optional if MPV_RENDER_PARAM_ADVANCED_CONTROL was not set (default). - * Otherwise, it's a hard requirement that this is called after each update - * callback. If multiple update callback happened, and the function could not - * be called sooner, it's OK to call it once after the last callback. - * - * If an update callback happens during or after this function, the function - * must be called again at the soonest possible time. - * - * If MPV_RENDER_PARAM_ADVANCED_CONTROL was set, this will do additional work - * such as allocating textures for the video decoder. - * - * @return a bitset of mpv_render_update_flag values (i.e. multiple flags are - * combined with bitwise or). Typically, this will tell the API user - * what should happen next. E.g. if the MPV_RENDER_UPDATE_FRAME flag is - * set, mpv_render_context_render() should be called. If flags unknown - * to the API user are set, or if the return value is 0, nothing needs - * to be done. - */ -MPV_EXPORT uint64_t mpv_render_context_update(mpv_render_context *ctx); - -/** - * Flags returned by mpv_render_context_update(). Each value represents a bit - * in the function's return value. - */ -typedef enum mpv_render_update_flag { - /** - * A new video frame must be rendered. mpv_render_context_render() must be - * called. - */ - MPV_RENDER_UPDATE_FRAME = 1 << 0, -} mpv_render_context_flag; - -/** - * Render video. - * - * Typically renders the video to a target surface provided via mpv_render_param - * (the details depend on the backend in use). Options like "panscan" are - * applied to determine which part of the video should be visible and how the - * video should be scaled. You can change these options at runtime by using the - * mpv property API. - * - * The renderer will reconfigure itself every time the target surface - * configuration (such as size) is changed. - * - * This function implicitly pulls a video frame from the internal queue and - * renders it. If no new frame is available, the previous frame is redrawn. - * The update callback set with mpv_render_context_set_update_callback() - * notifies you when a new frame was added. The details potentially depend on - * the backends and the provided parameters. - * - * Generally, libmpv will invoke your update callback some time before the video - * frame should be shown, and then lets this function block until the supposed - * display time. This will limit your rendering to video FPS. You can prevent - * this by setting the "video-timing-offset" global option to 0. (This applies - * only to "audio" video sync mode.) - * - * You should pass the following parameters: - * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO. - * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y. - * - * @param ctx a valid render context - * @param params an array of parameters, terminated by type==0. Which parameters - * are required depends on the backend. It's left unspecified what - * happens with unknown parameters. - * @return error code - */ -MPV_EXPORT int mpv_render_context_render(mpv_render_context *ctx, mpv_render_param *params); - -/** - * Tell the renderer that a frame was flipped at the given time. This is - * optional, but can help the player to achieve better timing. - * - * Note that calling this at least once informs libmpv that you will use this - * function. If you use it inconsistently, expect bad video playback. - * - * If this is called while no video is initialized, it is ignored. - * - * @param ctx a valid render context - */ -MPV_EXPORT void mpv_render_context_report_swap(mpv_render_context *ctx); - -/** - * Destroy the mpv renderer state. - * - * If video is still active (e.g. a file playing), video will be disabled - * forcefully. - * - * @param ctx a valid render context. After this function returns, this is not - * a valid pointer anymore. NULL is also allowed and does nothing. - */ -MPV_EXPORT void mpv_render_context_free(mpv_render_context *ctx); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h deleted file mode 100644 index a2c31f0c7..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/render_gl.h +++ /dev/null @@ -1,211 +0,0 @@ -/* Copyright (C) 2018 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_RENDER_GL_H_ -#define MPV_CLIENT_API_RENDER_GL_H_ - -#include "render.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * OpenGL backend - * -------------- - * - * This header contains definitions for using OpenGL with the render.h API. - * - * OpenGL interop - * -------------- - * - * The OpenGL backend has some special rules, because OpenGL itself uses - * implicit per-thread contexts, which causes additional API problems. - * - * This assumes the OpenGL context lives on a certain thread controlled by the - * API user. All mpv_render_* APIs have to be assumed to implicitly use the - * OpenGL context if you pass a mpv_render_context using the OpenGL backend, - * unless specified otherwise. - * - * The OpenGL context is indirectly accessed through the OpenGL function - * pointers returned by the get_proc_address callback in mpv_opengl_init_params. - * Generally, mpv will not load the system OpenGL library when using this API. - * - * OpenGL state - * ------------ - * - * OpenGL has a large amount of implicit state. All the mpv functions mentioned - * above expect that the OpenGL state is reasonably set to OpenGL standard - * defaults. Likewise, mpv will attempt to leave the OpenGL context with - * standard defaults. The following state is excluded from this: - * - * - the glViewport state - * - the glScissor state (but GL_SCISSOR_TEST is in its default value) - * - glBlendFuncSeparate() state (but GL_BLEND is in its default value) - * - glClearColor() state - * - mpv may overwrite the callback set with glDebugMessageCallback() - * - mpv always disables GL_DITHER at init - * - * Messing with the state could be avoided by creating shared OpenGL contexts, - * but this is avoided for the sake of compatibility and interoperability. - * - * On OpenGL 2.1, mpv will strictly call functions like glGenTextures() to - * create OpenGL objects. You will have to do the same. This ensures that - * objects created by mpv and the API users don't clash. Also, legacy state - * must be either in its defaults, or not interfere with core state. - * - * API use - * ------- - * - * The mpv_render_* API is used. That API supports multiple backends, and this - * section documents specifics for the OpenGL backend. - * - * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to - * MPV_RENDER_API_TYPE_OPENGL, and MPV_RENDER_PARAM_OPENGL_INIT_PARAMS provided. - * - * Call mpv_render_context_render() with MPV_RENDER_PARAM_OPENGL_FBO to render - * the video frame to an FBO. - * - * Hardware decoding - * ----------------- - * - * Hardware decoding via this API is fully supported, but requires some - * additional setup. (At least if direct hardware decoding modes are wanted, - * instead of copying back surface data from GPU to CPU RAM.) - * - * There may be certain requirements on the OpenGL implementation: - * - * - Windows: ANGLE is required (although in theory GL/DX interop could be used) - * - Intel/Linux: EGL is required, and also the native display resource needs - * to be provided (e.g. MPV_RENDER_PARAM_X11_DISPLAY for X11 and - * MPV_RENDER_PARAM_WL_DISPLAY for Wayland) - * - nVidia/Linux: Both GLX and EGL should work (GLX is required if vdpau is - * used, e.g. due to old drivers.) - * - OSX: CGL is required (CGLGetCurrentContext() returning non-NULL) - * - iOS: EAGL is required (EAGLContext.currentContext returning non-nil) - * - * Once these things are setup, hardware decoding can be enabled/disabled at - * any time by setting the "hwdec" property. - */ - -/** - * For initializing the mpv OpenGL state via MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. - */ -typedef struct mpv_opengl_init_params { - /** - * This retrieves OpenGL function pointers, and will use them in subsequent - * operation. - * Usually, you can simply call the GL context APIs from this callback (e.g. - * glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always - * return pointers for all standard functions (even if present); in this - * case you have to compensate by looking up these functions yourself when - * libmpv wants to resolve them through this callback. - * libmpv will not normally attempt to resolve GL functions on its own, nor - * does it link to GL libraries directly. - */ - void *(*get_proc_address)(void *ctx, const char *name); - /** - * Value passed as ctx parameter to get_proc_address(). - */ - void *get_proc_address_ctx; -} mpv_opengl_init_params; - -/** - * For MPV_RENDER_PARAM_OPENGL_FBO. - */ -typedef struct mpv_opengl_fbo { - /** - * Framebuffer object name. This must be either a valid FBO generated by - * glGenFramebuffers() that is complete and color-renderable, or 0. If the - * value is 0, this refers to the OpenGL default framebuffer. - */ - int fbo; - /** - * Valid dimensions. This must refer to the size of the framebuffer. This - * must always be set. - */ - int w, h; - /** - * Underlying texture internal format (e.g. GL_RGBA8), or 0 if unknown. If - * this is the default framebuffer, this can be an equivalent. - */ - int internal_format; -} mpv_opengl_fbo; - -/** - * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. - */ -typedef struct mpv_opengl_drm_params { - int fd; - int crtc_id; - int connector_id; - struct _drmModeAtomicReq **atomic_request_ptr; - int render_fd; -} mpv_opengl_drm_params; - -/** - * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. - */ -typedef struct mpv_opengl_drm_draw_surface_size { - /** - * size of the draw plane surface in pixels. - */ - int width, height; -} mpv_opengl_drm_draw_surface_size; - -/** - * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. - */ -typedef struct mpv_opengl_drm_params_v2 { - /** - * DRM fd (int). Set to -1 if invalid. - */ - int fd; - - /** - * Currently used crtc id - */ - int crtc_id; - - /** - * Currently used connector id - */ - int connector_id; - - /** - * Pointer to a drmModeAtomicReq pointer that is being used for the renderloop. - * This pointer should hold a pointer to the atomic request pointer - * The atomic request pointer is usually changed at every renderloop. - */ - struct _drmModeAtomicReq **atomic_request_ptr; - - /** - * DRM render node. Used for VAAPI interop. - * Set to -1 if invalid. - */ - int render_fd; -} mpv_opengl_drm_params_v2; - - -/** - * For backwards compatibility with the old naming of mpv_opengl_drm_draw_surface_size - */ -#define mpv_opengl_drm_osd_size mpv_opengl_drm_draw_surface_size - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h b/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h deleted file mode 100644 index 9d1c2cc8d..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h +++ /dev/null @@ -1,240 +0,0 @@ -/* Copyright (C) 2017 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_STREAM_CB_H_ -#define MPV_CLIENT_API_STREAM_CB_H_ - -#include "client.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Warning: this API is not stable yet. - * - * Overview - * -------- - * - * This API can be used to make mpv read from a stream with a custom - * implementation. This interface is inspired by funopen on BSD and - * fopencookie on linux. The stream is backed by user-defined callbacks - * which can implement customized open, read, seek, size and close behaviors. - * - * Usage - * ----- - * - * Register your stream callbacks with the mpv_stream_cb_add_ro() function. You - * have to provide a mpv_stream_cb_open_ro_fn callback to it (open_fn argument). - * - * Once registered, you can `loadfile myprotocol://myfile`. Your open_fn will be - * invoked with the URI and you must fill out the provided mpv_stream_cb_info - * struct. This includes your stream callbacks (like read_fn), and an opaque - * cookie, which will be passed as the first argument to all the remaining - * stream callbacks. - * - * Note that your custom callbacks must not invoke libmpv APIs as that would - * cause a deadlock. (Unless you call a different mpv_handle than the one the - * callback was registered for, and the mpv_handles refer to different mpv - * instances.) - * - * Stream lifetime - * --------------- - * - * A stream remains valid until its close callback has been called. It's up to - * libmpv to call the close callback, and the libmpv user cannot close it - * directly with the stream_cb API. - * - * For example, if you consider your custom stream to become suddenly invalid - * (maybe because the underlying stream died), libmpv will continue using your - * stream. All you can do is returning errors from each callback, until libmpv - * gives up and closes it. - * - * Protocol registration and lifetime - * ---------------------------------- - * - * Protocols remain registered until the mpv instance is terminated. This means - * in particular that it can outlive the mpv_handle that was used to register - * it, but once mpv_terminate_destroy() is called, your registered callbacks - * will not be called again. - * - * Protocol unregistration is finished after the mpv core has been destroyed - * (e.g. after mpv_terminate_destroy() has returned). - * - * If you do not call mpv_terminate_destroy() yourself (e.g. plugin-style code), - * you will have to deal with the registration or even streams outliving your - * code. Here are some possible ways to do this: - * - call mpv_terminate_destroy(), which destroys the core, and will make sure - * all streams are closed once this function returns - * - you refcount all resources your stream "cookies" reference, so that it - * doesn't matter if streams live longer than expected - * - create "cancellation" semantics: after your protocol has been unregistered, - * notify all your streams that are still opened, and make them drop all - * referenced resources - then return errors from the stream callbacks as - * long as the stream is still opened - * - */ - -/** - * Read callback used to implement a custom stream. The semantics of the - * callback match read(2) in blocking mode. Short reads are allowed (you can - * return less bytes than requested, and libmpv will retry reading the rest - * with another call). If no data can be immediately read, the callback must - * block until there is new data. A return of 0 will be interpreted as final - * EOF, although libmpv might retry the read, or seek to a different position. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @param buf buffer to read data into - * @param size of the buffer - * @return number of bytes read into the buffer - * @return 0 on EOF - * @return -1 on error - */ -typedef int64_t (*mpv_stream_cb_read_fn)(void *cookie, char *buf, uint64_t nbytes); - -/** - * Seek callback used to implement a custom stream. - * - * Note that mpv will issue a seek to position 0 immediately after opening. This - * is used to test whether the stream is seekable (since seekability might - * depend on the URI contents, not just the protocol). Return - * MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This - * seek also serves to establish the fact that streams start at position 0. - * - * This callback can be NULL, in which it behaves as if always returning - * MPV_ERROR_UNSUPPORTED. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @param offset target absolute stream position - * @return the resulting offset of the stream - * MPV_ERROR_UNSUPPORTED or MPV_ERROR_GENERIC if the seek failed - */ -typedef int64_t (*mpv_stream_cb_seek_fn)(void *cookie, int64_t offset); - -/** - * Size callback used to implement a custom stream. - * - * Return MPV_ERROR_UNSUPPORTED if no size is known. - * - * This callback can be NULL, in which it behaves as if always returning - * MPV_ERROR_UNSUPPORTED. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @return the total size in bytes of the stream - */ -typedef int64_t (*mpv_stream_cb_size_fn)(void *cookie); - -/** - * Close callback used to implement a custom stream. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - */ -typedef void (*mpv_stream_cb_close_fn)(void *cookie); - -/** - * Cancel callback used to implement a custom stream. - * - * This callback is used to interrupt any current or future read and seek - * operations. It will be called from a separate thread than the demux - * thread, and should not block. - * - * This callback can be NULL. - * - * Available since API 1.106. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - */ -typedef void (*mpv_stream_cb_cancel_fn)(void *cookie); - -/** - * See mpv_stream_cb_open_ro_fn callback. - */ -typedef struct mpv_stream_cb_info { - /** - * Opaque user-provided value, which will be passed to the other callbacks. - * The close callback will be called to release the cookie. It is not - * interpreted by mpv. It doesn't even need to be a valid pointer. - * - * The user sets this in the mpv_stream_cb_open_ro_fn callback. - */ - void *cookie; - - /** - * Callbacks set by the user in the mpv_stream_cb_open_ro_fn callback. Some - * of them are optional, and can be left unset. - * - * The following callbacks are mandatory: read_fn, close_fn - */ - mpv_stream_cb_read_fn read_fn; - mpv_stream_cb_seek_fn seek_fn; - mpv_stream_cb_size_fn size_fn; - mpv_stream_cb_close_fn close_fn; - mpv_stream_cb_cancel_fn cancel_fn; /* since API 1.106 */ -} mpv_stream_cb_info; - -/** - * Open callback used to implement a custom read-only (ro) stream. The user - * must set the callback fields in the passed info struct. The cookie field - * also can be set to store state associated to the stream instance. - * - * Note that the info struct is valid only for the duration of this callback. - * You can't change the callbacks or the pointer to the cookie at a later point. - * - * Each stream instance created by the open callback can have different - * callbacks. - * - * The close_fn callback will terminate the stream instance. The pointers to - * your callbacks and cookie will be discarded, and the callbacks will not be - * called again. - * - * @param user_data opaque user data provided via mpv_stream_cb_add() - * @param uri name of the stream to be opened (with protocol prefix) - * @param info fields which the user should fill - * @return 0 on success, MPV_ERROR_LOADING_FAILED if the URI cannot be opened. - */ -typedef int (*mpv_stream_cb_open_ro_fn)(void *user_data, char *uri, - mpv_stream_cb_info *info); - -/** - * Add a custom stream protocol. This will register a protocol handler under - * the given protocol prefix, and invoke the given callbacks if an URI with the - * matching protocol prefix is opened. - * - * The "ro" is for read-only - only read-only streams can be registered with - * this function. - * - * The callback remains registered until the mpv core is registered. - * - * If a custom stream with the same name is already registered, then the - * MPV_ERROR_INVALID_PARAMETER error is returned. - * - * @param protocol protocol prefix, for example "foo" for "foo://" URIs - * @param user_data opaque pointer passed into the mpv_stream_cb_open_fn - * callback. - * @return error code - */ -MPV_EXPORT int mpv_stream_cb_add_ro(mpv_handle *ctx, const char *protocol, void *user_data, - mpv_stream_cb_open_ro_fn open_fn); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c b/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c deleted file mode 100644 index 9b5faec70..000000000 --- a/media_kit_video/ios/media_kit_video/Sources/Mpv/shim.c +++ /dev/null @@ -1 +0,0 @@ -#include "mpv/client.h" diff --git a/media_kit_video/macos/media_kit_video/Package.swift b/media_kit_video/macos/media_kit_video/Package.swift index 482fffa59..6e7e89ab0 100644 --- a/media_kit_video/macos/media_kit_video/Package.swift +++ b/media_kit_video/macos/media_kit_video/Package.swift @@ -13,17 +13,9 @@ let package = Package( ], dependencies: [], targets: [ - .target( - name: "Mpv", - path: "Sources/Mpv", - sources: ["shim.c"], - publicHeadersPath: "include" - ), .target( name: "media_kit_video", - dependencies: [ - .target(name: "Mpv") - ], + dependencies: [], sources: ["plugin"], resources: [ .process("PrivacyInfo.xcprivacy") diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap deleted file mode 100644 index 7226723bb..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/module.modulemap +++ /dev/null @@ -1,7 +0,0 @@ -module Mpv { - header "mpv/client.h" - header "mpv/render.h" - header "mpv/render_gl.h" - header "mpv/stream_cb.h" - export * -} diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h deleted file mode 100644 index b9697eb74..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/client.h +++ /dev/null @@ -1,1896 +0,0 @@ -/* Copyright (C) 2017 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/* - * Note: the client API is licensed under ISC (see above) to enable - * other wrappers outside of mpv. But keep in mind that the - * mpv core is by default still GPLv2+ - unless built with - * --enable-lgpl, which makes it LGPLv2+. - */ - -#ifndef MPV_CLIENT_API_H_ -#define MPV_CLIENT_API_H_ - -#include -#include - -/* New symbols must still be added to libmpv/mpv.def. */ -#ifdef _WIN32 -#define MPV_EXPORT __declspec(dllexport) -#elif defined(__GNUC__) || defined(__clang__) -#define MPV_EXPORT __attribute__((visibility("default"))) -#else -#define MPV_EXPORT -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Mechanisms provided by this API - * ------------------------------- - * - * This API provides general control over mpv playback. It does not give you - * direct access to individual components of the player, only the whole thing. - * It's somewhat equivalent to MPlayer's slave mode. You can send commands, - * retrieve or set playback status or settings with properties, and receive - * events. - * - * The API can be used in two ways: - * 1) Internally in mpv, to provide additional features to the command line - * player. Lua scripting uses this. (Currently there is no plugin API to - * get a client API handle in external user code. It has to be a fixed - * part of the player at compilation time.) - * 2) Using mpv as a library with mpv_create(). This basically allows embedding - * mpv in other applications. - * - * Documentation - * ------------- - * - * The libmpv C API is documented directly in this header. Note that most - * actual interaction with this player is done through - * options/commands/properties, which can be accessed through this API. - * Essentially everything is done with them, including loading a file, - * retrieving playback progress, and so on. - * - * These are documented elsewhere: - * * http://mpv.io/manual/master/#options - * * http://mpv.io/manual/master/#list-of-input-commands - * * http://mpv.io/manual/master/#properties - * - * You can also look at the examples here: - * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv - * - * Event loop - * ---------- - * - * In general, the API user should run an event loop in order to receive events. - * This event loop should call mpv_wait_event(), which will return once a new - * mpv client API is available. It is also possible to integrate client API - * usage in other event loops (e.g. GUI toolkits) with the - * mpv_set_wakeup_callback() function, and then polling for events by calling - * mpv_wait_event() with a 0 timeout. - * - * Note that the event loop is detached from the actual player. Not calling - * mpv_wait_event() will not stop playback. It will eventually congest the - * event queue of your API handle, though. - * - * Synchronous vs. asynchronous calls - * ---------------------------------- - * - * The API allows both synchronous and asynchronous calls. Synchronous calls - * have to wait until the playback core is ready, which currently can take - * an unbounded time (e.g. if network is slow or unresponsive). Asynchronous - * calls just queue operations as requests, and return the result of the - * operation as events. - * - * Asynchronous calls - * ------------------ - * - * The client API includes asynchronous functions. These allow you to send - * requests instantly, and get replies as events at a later point. The - * requests are made with functions carrying the _async suffix, and replies - * are returned by mpv_wait_event() (interleaved with the normal event stream). - * - * A 64 bit userdata value is used to allow the user to associate requests - * with replies. The value is passed as reply_userdata parameter to the request - * function. The reply to the request will have the reply - * mpv_event->reply_userdata field set to the same value as the - * reply_userdata parameter of the corresponding request. - * - * This userdata value is arbitrary and is never interpreted by the API. Note - * that the userdata value 0 is also allowed, but then the client must be - * careful not accidentally interpret the mpv_event->reply_userdata if an - * event is not a reply. (For non-replies, this field is set to 0.) - * - * Asynchronous calls may be reordered in arbitrarily with other synchronous - * and asynchronous calls. If you want a guaranteed order, you need to wait - * until asynchronous calls report completion before doing the next call. - * - * See also the section "Asynchronous command details" in the manpage. - * - * Multithreading - * -------------- - * - * The client API is generally fully thread-safe, unless otherwise noted. - * Currently, there is no real advantage in using more than 1 thread to access - * the client API, since everything is serialized through a single lock in the - * playback core. - * - * Basic environment requirements - * ------------------------------ - * - * This documents basic requirements on the C environment. This is especially - * important if mpv is used as library with mpv_create(). - * - * - The LC_NUMERIC locale category must be set to "C". If your program calls - * setlocale(), be sure not to use LC_ALL, or if you do, reset LC_NUMERIC - * to its sane default: setlocale(LC_NUMERIC, "C"). - * - If a X11 based VO is used, mpv will set the xlib error handler. This error - * handler is process-wide, and there's no proper way to share it with other - * xlib users within the same process. This might confuse GUI toolkits. - * - mpv uses some other libraries that are not library-safe, such as Fribidi - * (used through libass), ALSA, FFmpeg, and possibly more. - * - The FPU precision must be set at least to double precision. - * - On Windows, mpv will call timeBeginPeriod(1). - * - On memory exhaustion, mpv will kill the process. - * - In certain cases, mpv may start sub processes (such as with the ytdl - * wrapper script). - * - Using UNIX IPC (off by default) will override the SIGPIPE signal handler, - * and set it to SIG_IGN. Some invocations of the "subprocess" command will - * also do that. - * - mpv may start sub processes, so overriding SIGCHLD, or waiting on all PIDs - * (such as calling wait()) by the parent process or any other library within - * the process must be avoided. libmpv itself only waits for its own PIDs. - * - If anything in the process registers signal handlers, they must set the - * SA_RESTART flag. Otherwise you WILL get random failures on signals. - * - * Encoding of filenames - * --------------------- - * - * mpv uses UTF-8 everywhere. - * - * On some platforms (like Linux), filenames actually do not have to be UTF-8; - * for this reason libmpv supports non-UTF-8 strings. libmpv uses what the - * kernel uses and does not recode filenames. At least on Linux, passing a - * string to libmpv is like passing a string to the fopen() function. - * - * On Windows, filenames are always UTF-8, libmpv converts between UTF-8 and - * UTF-16 when using win32 API functions. libmpv never uses or accepts - * filenames in the local 8 bit encoding. It does not use fopen() either; - * it uses _wfopen(). - * - * On OS X, filenames and other strings taken/returned by libmpv can have - * inconsistent unicode normalization. This can sometimes lead to problems. - * You have to hope for the best. - * - * Also see the remarks for MPV_FORMAT_STRING. - * - * Embedding the video window - * -------------------------- - * - * Using the render API (in render.h) is recommended. This API requires - * you to create and maintain an OpenGL context, to which you can render - * video using a specific API call. This API does not include keyboard or mouse - * input directly. - * - * There is an older way to embed the native mpv window into your own. You have - * to get the raw window handle, and set it as "wid" option. This works on X11, - * win32, and OSX only. It's much easier to use than the render API, but - * also has various problems. - * - * Also see client API examples and the mpv manpage. There is an extensive - * discussion here: - * https://github.com/mpv-player/mpv-examples/tree/master/libmpv#methods-of-embedding-the-video-window - * - * Compatibility - * ------------- - * - * mpv development doesn't stand still, and changes to mpv internals as well as - * to its interface can cause compatibility issues to client API users. - * - * The API is versioned (see MPV_CLIENT_API_VERSION), and changes to it are - * documented in DOCS/client-api-changes.rst. The C API itself will probably - * remain compatible for a long time, but the functionality exposed by it - * could change more rapidly. For example, it's possible that options are - * renamed, or change the set of allowed values. - * - * Defensive programming should be used to potentially deal with the fact that - * options, commands, and properties could disappear, change their value range, - * or change the underlying datatypes. It might be a good idea to prefer - * MPV_FORMAT_STRING over other types to decouple your code from potential - * mpv changes. - * - * Also see: DOCS/compatibility.rst - * - * Future changes - * -------------- - * - * This are the planned changes that will most likely be done on the next major - * bump of the library: - * - * - remove all symbols that are marked as deprecated - * - reassign enum numerical values to remove gaps - * - disabling all events by default - */ - -/** - * The version is incremented on each API change. The 16 lower bits form the - * minor version number, and the 16 higher bits the major version number. If - * the API becomes incompatible to previous versions, the major version - * number is incremented. This affects only C part, and not properties and - * options. - * - * Every API bump is described in DOCS/client-api-changes.rst - * - * You can use MPV_MAKE_VERSION() and compare the result with integer - * relational operators (<, >, <=, >=). - */ -#define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) -#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(2, 1) - -/** - * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before - * including any libmpv headers. Then deprecated symbols will be excluded - * from the headers. (Of course, deprecated properties and commands and - * other functionality will still work.) - */ -#ifndef MPV_ENABLE_DEPRECATED -#define MPV_ENABLE_DEPRECATED 1 -#endif - -/** - * Return the MPV_CLIENT_API_VERSION the mpv source has been compiled with. - */ -MPV_EXPORT unsigned long mpv_client_api_version(void); - -/** - * Client context used by the client API. Every client has its own private - * handle. - */ -typedef struct mpv_handle mpv_handle; - -/** - * List of error codes than can be returned by API functions. 0 and positive - * return values always mean success, negative values are always errors. - */ -typedef enum mpv_error { - /** - * No error happened (used to signal successful operation). - * Keep in mind that many API functions returning error codes can also - * return positive values, which also indicate success. API users can - * hardcode the fact that ">= 0" means success. - */ - MPV_ERROR_SUCCESS = 0, - /** - * The event ringbuffer is full. This means the client is choked, and can't - * receive any events. This can happen when too many asynchronous requests - * have been made, but not answered. Probably never happens in practice, - * unless the mpv core is frozen for some reason, and the client keeps - * making asynchronous requests. (Bugs in the client API implementation - * could also trigger this, e.g. if events become "lost".) - */ - MPV_ERROR_EVENT_QUEUE_FULL = -1, - /** - * Memory allocation failed. - */ - MPV_ERROR_NOMEM = -2, - /** - * The mpv core wasn't configured and initialized yet. See the notes in - * mpv_create(). - */ - MPV_ERROR_UNINITIALIZED = -3, - /** - * Generic catch-all error if a parameter is set to an invalid or - * unsupported value. This is used if there is no better error code. - */ - MPV_ERROR_INVALID_PARAMETER = -4, - /** - * Trying to set an option that doesn't exist. - */ - MPV_ERROR_OPTION_NOT_FOUND = -5, - /** - * Trying to set an option using an unsupported MPV_FORMAT. - */ - MPV_ERROR_OPTION_FORMAT = -6, - /** - * Setting the option failed. Typically this happens if the provided option - * value could not be parsed. - */ - MPV_ERROR_OPTION_ERROR = -7, - /** - * The accessed property doesn't exist. - */ - MPV_ERROR_PROPERTY_NOT_FOUND = -8, - /** - * Trying to set or get a property using an unsupported MPV_FORMAT. - */ - MPV_ERROR_PROPERTY_FORMAT = -9, - /** - * The property exists, but is not available. This usually happens when the - * associated subsystem is not active, e.g. querying audio parameters while - * audio is disabled. - */ - MPV_ERROR_PROPERTY_UNAVAILABLE = -10, - /** - * Error setting or getting a property. - */ - MPV_ERROR_PROPERTY_ERROR = -11, - /** - * General error when running a command with mpv_command and similar. - */ - MPV_ERROR_COMMAND = -12, - /** - * Generic error on loading (usually used with mpv_event_end_file.error). - */ - MPV_ERROR_LOADING_FAILED = -13, - /** - * Initializing the audio output failed. - */ - MPV_ERROR_AO_INIT_FAILED = -14, - /** - * Initializing the video output failed. - */ - MPV_ERROR_VO_INIT_FAILED = -15, - /** - * There was no audio or video data to play. This also happens if the - * file was recognized, but did not contain any audio or video streams, - * or no streams were selected. - */ - MPV_ERROR_NOTHING_TO_PLAY = -16, - /** - * When trying to load the file, the file format could not be determined, - * or the file was too broken to open it. - */ - MPV_ERROR_UNKNOWN_FORMAT = -17, - /** - * Generic error for signaling that certain system requirements are not - * fulfilled. - */ - MPV_ERROR_UNSUPPORTED = -18, - /** - * The API function which was called is a stub only. - */ - MPV_ERROR_NOT_IMPLEMENTED = -19, - /** - * Unspecified error. - */ - MPV_ERROR_GENERIC = -20 -} mpv_error; - -/** - * Return a string describing the error. For unknown errors, the string - * "unknown error" is returned. - * - * @param error error number, see enum mpv_error - * @return A static string describing the error. The string is completely - * static, i.e. doesn't need to be deallocated, and is valid forever. - */ -MPV_EXPORT const char *mpv_error_string(int error); - -/** - * General function to deallocate memory returned by some of the API functions. - * Call this only if it's explicitly documented as allowed. Calling this on - * mpv memory not owned by the caller will lead to undefined behavior. - * - * @param data A valid pointer returned by the API, or NULL. - */ -MPV_EXPORT void mpv_free(void *data); - -/** - * Return the name of this client handle. Every client has its own unique - * name, which is mostly used for user interface purposes. - * - * @return The client name. The string is read-only and is valid until the - * mpv_handle is destroyed. - */ -MPV_EXPORT const char *mpv_client_name(mpv_handle *ctx); - -/** - * Return the ID of this client handle. Every client has its own unique ID. This - * ID is never reused by the core, even if the mpv_handle at hand gets destroyed - * and new handles get allocated. - * - * IDs are never 0 or negative. - * - * Some mpv APIs (not necessarily all) accept a name in the form "@" in - * addition of the proper mpv_client_name(), where "" is the ID in decimal - * form (e.g. "@123"). For example, the "script-message-to" command takes the - * client name as first argument, but also accepts the client ID formatted in - * this manner. - * - * @return The client ID. - */ -MPV_EXPORT int64_t mpv_client_id(mpv_handle *ctx); - -/** - * Create a new mpv instance and an associated client API handle to control - * the mpv instance. This instance is in a pre-initialized state, - * and needs to be initialized to be actually used with most other API - * functions. - * - * Some API functions will return MPV_ERROR_UNINITIALIZED in the uninitialized - * state. You can call mpv_set_property() (or mpv_set_property_string() and - * other variants, and before mpv 0.21.0 mpv_set_option() etc.) to set initial - * options. After this, call mpv_initialize() to start the player, and then use - * e.g. mpv_command() to start playback of a file. - * - * The point of separating handle creation and actual initialization is that - * you can configure things which can't be changed during runtime. - * - * Unlike the command line player, this will have initial settings suitable - * for embedding in applications. The following settings are different: - * - stdin/stdout/stderr and the terminal will never be accessed. This is - * equivalent to setting the --no-terminal option. - * (Technically, this also suppresses C signal handling.) - * - No config files will be loaded. This is roughly equivalent to using - * --config=no. Since libmpv 1.15, you can actually re-enable this option, - * which will make libmpv load config files during mpv_initialize(). If you - * do this, you are strongly encouraged to set the "config-dir" option too. - * (Otherwise it will load the mpv command line player's config.) - * For example: - * mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config root - * mpv_set_option_string(mpv, "config", "yes"); // enable config loading - * (call mpv_initialize() _after_ this) - * - Idle mode is enabled, which means the playback core will enter idle mode - * if there are no more files to play on the internal playlist, instead of - * exiting. This is equivalent to the --idle option. - * - Disable parts of input handling. - * - Most of the different settings can be viewed with the command line player - * by running "mpv --show-profile=libmpv". - * - * All this assumes that API users want a mpv instance that is strictly - * isolated from the command line player's configuration, user settings, and - * so on. You can re-enable disabled features by setting the appropriate - * options. - * - * The mpv command line parser is not available through this API, but you can - * set individual options with mpv_set_property(). Files for playback must be - * loaded with mpv_command() or others. - * - * Note that you should avoid doing concurrent accesses on the uninitialized - * client handle. (Whether concurrent access is definitely allowed or not has - * yet to be decided.) - * - * @return a new mpv client API handle. Returns NULL on error. Currently, this - * can happen in the following situations: - * - out of memory - * - LC_NUMERIC is not set to "C" (see general remarks) - */ -MPV_EXPORT mpv_handle *mpv_create(void); - -/** - * Initialize an uninitialized mpv instance. If the mpv instance is already - * running, an error is returned. - * - * This function needs to be called to make full use of the client API if the - * client API handle was created with mpv_create(). - * - * Only the following options are required to be set _before_ mpv_initialize(): - * - options which are only read at initialization time: - * - config - * - config-dir - * - input-conf - * - load-scripts - * - script - * - player-operation-mode - * - input-app-events (OSX) - * - all encoding mode options - * - * @return error code - */ -MPV_EXPORT int mpv_initialize(mpv_handle *ctx); - -/** - * Disconnect and destroy the mpv_handle. ctx will be deallocated with this - * API call. - * - * If the last mpv_handle is detached, the core player is destroyed. In - * addition, if there are only weak mpv_handles (such as created by - * mpv_create_weak_client() or internal scripts), these mpv_handles will - * be sent MPV_EVENT_SHUTDOWN. This function may block until these clients - * have responded to the shutdown event, and the core is finally destroyed. - */ -MPV_EXPORT void mpv_destroy(mpv_handle *ctx); - -/** - * Similar to mpv_destroy(), but brings the player and all clients down - * as well, and waits until all of them are destroyed. This function blocks. The - * advantage over mpv_destroy() is that while mpv_destroy() merely - * detaches the client handle from the player, this function quits the player, - * waits until all other clients are destroyed (i.e. all mpv_handles are - * detached), and also waits for the final termination of the player. - * - * Since mpv_destroy() is called somewhere on the way, it's not safe to - * call other functions concurrently on the same context. - * - * Since mpv client API version 1.29: - * The first call on any mpv_handle will block until the core is destroyed. - * This means it will wait until other mpv_handle have been destroyed. If you - * want asynchronous destruction, just run the "quit" command, and then react - * to the MPV_EVENT_SHUTDOWN event. - * If another mpv_handle already called mpv_terminate_destroy(), this call will - * not actually block. It will destroy the mpv_handle, and exit immediately, - * while other mpv_handles might still be uninitializing. - * - * Before mpv client API version 1.29: - * If this is called on a mpv_handle that was not created with mpv_create(), - * this function will merely send a quit command and then call - * mpv_destroy(), without waiting for the actual shutdown. - */ -MPV_EXPORT void mpv_terminate_destroy(mpv_handle *ctx); - -/** - * Create a new client handle connected to the same player core as ctx. This - * context has its own event queue, its own mpv_request_event() state, its own - * mpv_request_log_messages() state, its own set of observed properties, and - * its own state for asynchronous operations. Otherwise, everything is shared. - * - * This handle should be destroyed with mpv_destroy() if no longer - * needed. The core will live as long as there is at least 1 handle referencing - * it. Any handle can make the core quit, which will result in every handle - * receiving MPV_EVENT_SHUTDOWN. - * - * This function can not be called before the main handle was initialized with - * mpv_initialize(). The new handle is always initialized, unless ctx=NULL was - * passed. - * - * @param ctx Used to get the reference to the mpv core; handle-specific - * settings and parameters are not used. - * If NULL, this function behaves like mpv_create() (ignores name). - * @param name The client name. This will be returned by mpv_client_name(). If - * the name is already in use, or contains non-alphanumeric - * characters (other than '_'), the name is modified to fit. - * If NULL, an arbitrary name is automatically chosen. - * @return a new handle, or NULL on error - */ -MPV_EXPORT mpv_handle *mpv_create_client(mpv_handle *ctx, const char *name); - -/** - * This is the same as mpv_create_client(), but the created mpv_handle is - * treated as a weak reference. If all mpv_handles referencing a core are - * weak references, the core is automatically destroyed. (This still goes - * through normal uninit of course. Effectively, if the last non-weak mpv_handle - * is destroyed, then the weak mpv_handles receive MPV_EVENT_SHUTDOWN and are - * asked to terminate as well.) - * - * Note if you want to use this like refcounting: you have to be aware that - * mpv_terminate_destroy() _and_ mpv_destroy() for the last non-weak - * mpv_handle will block until all weak mpv_handles are destroyed. - */ -MPV_EXPORT mpv_handle *mpv_create_weak_client(mpv_handle *ctx, const char *name); - -/** - * Load a config file. This loads and parses the file, and sets every entry in - * the config file's default section as if mpv_set_option_string() is called. - * - * The filename should be an absolute path. If it isn't, the actual path used - * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the - * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. - * - * If a fatal error happens when parsing a config file, MPV_ERROR_OPTION_ERROR - * is returned. Errors when setting options as well as other types or errors - * are ignored (even if options do not exist). You can still try to capture - * the resulting error messages with mpv_request_log_messages(). Note that it's - * possible that some options were successfully set even if any of these errors - * happen. - * - * @param filename absolute path to the config file on the local filesystem - * @return error code - */ -MPV_EXPORT int mpv_load_config_file(mpv_handle *ctx, const char *filename); - -/** - * Return the internal time in microseconds. This has an arbitrary start offset, - * but will never wrap or go backwards. - * - * Note that this is always the real time, and doesn't necessarily have to do - * with playback time. For example, playback could go faster or slower due to - * playback speed, or due to playback being paused. Use the "time-pos" property - * instead to get the playback status. - * - * Unlike other libmpv APIs, this can be called at absolutely any time (even - * within wakeup callbacks), as long as the context is valid. - * - * Safe to be called from mpv render API threads. - */ -MPV_EXPORT int64_t mpv_get_time_us(mpv_handle *ctx); - -/** - * Data format for options and properties. The API functions to get/set - * properties and options support multiple formats, and this enum describes - * them. - */ -typedef enum mpv_format { - /** - * Invalid. Sometimes used for empty values. This is always defined to 0, - * so a normal 0-init of mpv_format (or e.g. mpv_node) is guaranteed to set - * this it to MPV_FORMAT_NONE (which makes some things saner as consequence). - */ - MPV_FORMAT_NONE = 0, - /** - * The basic type is char*. It returns the raw property string, like - * using ${=property} in input.conf (see input.rst). - * - * NULL isn't an allowed value. - * - * Warning: although the encoding is usually UTF-8, this is not always the - * case. File tags often store strings in some legacy codepage, - * and even filenames don't necessarily have to be in UTF-8 (at - * least on Linux). If you pass the strings to code that requires - * valid UTF-8, you have to sanitize it in some way. - * On Windows, filenames are always UTF-8, and libmpv converts - * between UTF-8 and UTF-16 when using win32 API functions. See - * the "Encoding of filenames" section for details. - * - * Example for reading: - * - * char *result = NULL; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_STRING, &result) < 0) - * goto error; - * printf("%s\n", result); - * mpv_free(result); - * - * Or just use mpv_get_property_string(). - * - * Example for writing: - * - * char *value = "the new value"; - * // yep, you pass the address to the variable - * // (needed for symmetry with other types and mpv_get_property) - * mpv_set_property(ctx, "property", MPV_FORMAT_STRING, &value); - * - * Or just use mpv_set_property_string(). - * - */ - MPV_FORMAT_STRING = 1, - /** - * The basic type is char*. It returns the OSD property string, like - * using ${property} in input.conf (see input.rst). In many cases, this - * is the same as the raw string, but in other cases it's formatted for - * display on OSD. It's intended to be human readable. Do not attempt to - * parse these strings. - * - * Only valid when doing read access. The rest works like MPV_FORMAT_STRING. - */ - MPV_FORMAT_OSD_STRING = 2, - /** - * The basic type is int. The only allowed values are 0 ("no") - * and 1 ("yes"). - * - * Example for reading: - * - * int result; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_FLAG, &result) < 0) - * goto error; - * printf("%s\n", result ? "true" : "false"); - * - * Example for writing: - * - * int flag = 1; - * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); - */ - MPV_FORMAT_FLAG = 3, - /** - * The basic type is int64_t. - */ - MPV_FORMAT_INT64 = 4, - /** - * The basic type is double. - */ - MPV_FORMAT_DOUBLE = 5, - /** - * The type is mpv_node. - * - * For reading, you usually would pass a pointer to a stack-allocated - * mpv_node value to mpv, and when you're done you call - * mpv_free_node_contents(&node). - * You're expected not to write to the data - if you have to, copy it - * first (which you have to do manually). - * - * For writing, you construct your own mpv_node, and pass a pointer to the - * API. The API will never write to your data (and copy it if needed), so - * you're free to use any form of allocation or memory management you like. - * - * Warning: when reading, always check the mpv_node.format member. For - * example, properties might change their type in future versions - * of mpv, or sometimes even during runtime. - * - * Example for reading: - * - * mpv_node result; - * if (mpv_get_property(ctx, "property", MPV_FORMAT_NODE, &result) < 0) - * goto error; - * printf("format=%d\n", (int)result.format); - * mpv_free_node_contents(&result). - * - * Example for writing: - * - * mpv_node value; - * value.format = MPV_FORMAT_STRING; - * value.u.string = "hello"; - * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); - */ - MPV_FORMAT_NODE = 6, - /** - * Used with mpv_node only. Can usually not be used directly. - */ - MPV_FORMAT_NODE_ARRAY = 7, - /** - * See MPV_FORMAT_NODE_ARRAY. - */ - MPV_FORMAT_NODE_MAP = 8, - /** - * A raw, untyped byte array. Only used only with mpv_node, and only in - * some very specific situations. (Some commands use it.) - */ - MPV_FORMAT_BYTE_ARRAY = 9 -} mpv_format; - -/** - * Generic data storage. - * - * If mpv writes this struct (e.g. via mpv_get_property()), you must not change - * the data. In some cases (mpv_get_property()), you have to free it with - * mpv_free_node_contents(). If you fill this struct yourself, you're also - * responsible for freeing it, and you must not call mpv_free_node_contents(). - */ -typedef struct mpv_node { - union { - char *string; /** valid if format==MPV_FORMAT_STRING */ - int flag; /** valid if format==MPV_FORMAT_FLAG */ - int64_t int64; /** valid if format==MPV_FORMAT_INT64 */ - double double_; /** valid if format==MPV_FORMAT_DOUBLE */ - /** - * valid if format==MPV_FORMAT_NODE_ARRAY - * or if format==MPV_FORMAT_NODE_MAP - */ - struct mpv_node_list *list; - /** - * valid if format==MPV_FORMAT_BYTE_ARRAY - */ - struct mpv_byte_array *ba; - } u; - /** - * Type of the data stored in this struct. This value rules what members in - * the given union can be accessed. The following formats are currently - * defined to be allowed in mpv_node: - * - * MPV_FORMAT_STRING (u.string) - * MPV_FORMAT_FLAG (u.flag) - * MPV_FORMAT_INT64 (u.int64) - * MPV_FORMAT_DOUBLE (u.double_) - * MPV_FORMAT_NODE_ARRAY (u.list) - * MPV_FORMAT_NODE_MAP (u.list) - * MPV_FORMAT_BYTE_ARRAY (u.ba) - * MPV_FORMAT_NONE (no member) - * - * If you encounter a value you don't know, you must not make any - * assumptions about the contents of union u. - */ - mpv_format format; -} mpv_node; - -/** - * (see mpv_node) - */ -typedef struct mpv_node_list { - /** - * Number of entries. Negative values are not allowed. - */ - int num; - /** - * MPV_FORMAT_NODE_ARRAY: - * values[N] refers to value of the Nth item - * - * MPV_FORMAT_NODE_MAP: - * values[N] refers to value of the Nth key/value pair - * - * If num > 0, values[0] to values[num-1] (inclusive) are valid. - * Otherwise, this can be NULL. - */ - mpv_node *values; - /** - * MPV_FORMAT_NODE_ARRAY: - * unused (typically NULL), access is not allowed - * - * MPV_FORMAT_NODE_MAP: - * keys[N] refers to key of the Nth key/value pair. If num > 0, keys[0] to - * keys[num-1] (inclusive) are valid. Otherwise, this can be NULL. - * The keys are in random order. The only guarantee is that keys[N] belongs - * to the value values[N]. NULL keys are not allowed. - */ - char **keys; -} mpv_node_list; - -/** - * (see mpv_node) - */ -typedef struct mpv_byte_array { - /** - * Pointer to the data. In what format the data is stored is up to whatever - * uses MPV_FORMAT_BYTE_ARRAY. - */ - void *data; - /** - * Size of the data pointed to by ptr. - */ - size_t size; -} mpv_byte_array; - -/** - * Frees any data referenced by the node. It doesn't free the node itself. - * Call this only if the mpv client API set the node. If you constructed the - * node yourself (manually), you have to free it yourself. - * - * If node->format is MPV_FORMAT_NONE, this call does nothing. Likewise, if - * the client API sets a node with this format, this function doesn't need to - * be called. (This is just a clarification that there's no danger of anything - * strange happening in these cases.) - */ -MPV_EXPORT void mpv_free_node_contents(mpv_node *node); - -/** - * Set an option. Note that you can't normally set options during runtime. It - * works in uninitialized state (see mpv_create()), and in some cases in at - * runtime. - * - * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a - * mpv_node with the given format and data, and passing the mpv_node to this - * function. - * - * Note: this is semi-deprecated. For most purposes, this is not needed anymore. - * Starting with mpv version 0.21.0 (version 1.23) most options can be set - * with mpv_set_property() (and related functions), and even before - * mpv_initialize(). In some obscure corner cases, using this function - * to set options might still be required (see - * "Inconsistencies between options and properties" in the manpage). Once - * these are resolved, the option setting functions might be fully - * deprecated. - * - * @param name Option name. This is the same as on the mpv command line, but - * without the leading "--". - * @param format see enum mpv_format. - * @param[in] data Option value (according to the format). - * @return error code - */ -MPV_EXPORT int mpv_set_option(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Convenience function to set an option to a string value. This is like - * calling mpv_set_option() with MPV_FORMAT_STRING. - * - * @return error code - */ -MPV_EXPORT int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data); - -/** - * Send a command to the player. Commands are the same as those used in - * input.conf, except that this function takes parameters in a pre-split - * form. - * - * The commands and their parameters are documented in input.rst. - * - * Does not use OSD and string expansion by default (unlike mpv_command_string() - * and input.conf). - * - * @param[in] args NULL-terminated list of strings. Usually, the first item - * is the command, and the following items are arguments. - * @return error code - */ -MPV_EXPORT int mpv_command(mpv_handle *ctx, const char **args); - -/** - * Same as mpv_command(), but allows passing structured data in any format. - * In particular, calling mpv_command() is exactly like calling - * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and - * every arg passed in order as MPV_FORMAT_STRING. - * - * Does not use OSD and string expansion by default. - * - * The args argument can have one of the following formats: - * - * MPV_FORMAT_NODE_ARRAY: - * Positional arguments. Each entry is an argument using an arbitrary - * format (the format must be compatible to the used command). Usually, - * the first item is the command name (as MPV_FORMAT_STRING). The order - * of arguments is as documented in each command description. - * - * MPV_FORMAT_NODE_MAP: - * Named arguments. This requires at least an entry with the key "name" - * to be present, which must be a string, and contains the command name. - * The special entry "_flags" is optional, and if present, must be an - * array of strings, each being a command prefix to apply. All other - * entries are interpreted as arguments. They must use the argument names - * as documented in each command description. Some commands do not - * support named arguments at all, and must use MPV_FORMAT_NODE_ARRAY. - * - * @param[in] args mpv_node with format set to one of the values documented - * above (see there for details) - * @param[out] result Optional, pass NULL if unused. If not NULL, and if the - * function succeeds, this is set to command-specific return - * data. You must call mpv_free_node_contents() to free it - * (again, only if the command actually succeeds). - * Not many commands actually use this at all. - * @return error code (the result parameter is not set on error) - */ -MPV_EXPORT int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); - -/** - * This is essentially identical to mpv_command() but it also returns a result. - * - * Does not use OSD and string expansion by default. - * - * @param[in] args NULL-terminated list of strings. Usually, the first item - * is the command, and the following items are arguments. - * @param[out] result Optional, pass NULL if unused. If not NULL, and if the - * function succeeds, this is set to command-specific return - * data. You must call mpv_free_node_contents() to free it - * (again, only if the command actually succeeds). - * Not many commands actually use this at all. - * @return error code (the result parameter is not set on error) - */ -MPV_EXPORT int mpv_command_ret(mpv_handle *ctx, const char **args, mpv_node *result); - -/** - * Same as mpv_command, but use input.conf parsing for splitting arguments. - * This is slightly simpler, but also more error prone, since arguments may - * need quoting/escaping. - * - * This also has OSD and string expansion enabled by default. - */ -MPV_EXPORT int mpv_command_string(mpv_handle *ctx, const char *args); - -/** - * Same as mpv_command, but run the command asynchronously. - * - * Commands are executed asynchronously. You will receive a - * MPV_EVENT_COMMAND_REPLY event. This event will also have an - * error code set if running the command failed. For commands that - * return data, the data is put into mpv_event_command.result. - * - * The only case when you do not receive an event is when the function call - * itself fails. This happens only if parsing the command itself (or otherwise - * validating it) fails, i.e. the return code of the API call is not 0 or - * positive. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata the value mpv_event.reply_userdata of the reply will - * be set to (see section about asynchronous calls) - * @param args NULL-terminated list of strings (see mpv_command()) - * @return error code (if parsing or queuing the command fails) - */ -MPV_EXPORT int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, - const char **args); - -/** - * Same as mpv_command_node(), but run it asynchronously. Basically, this - * function is to mpv_command_node() what mpv_command_async() is to - * mpv_command(). - * - * See mpv_command_async() for details. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata the value mpv_event.reply_userdata of the reply will - * be set to (see section about asynchronous calls) - * @param args as in mpv_command_node() - * @return error code (if parsing or queuing the command fails) - */ -MPV_EXPORT int mpv_command_node_async(mpv_handle *ctx, uint64_t reply_userdata, - mpv_node *args); - -/** - * Signal to all async requests with the matching ID to abort. This affects - * the following API calls: - * - * mpv_command_async - * mpv_command_node_async - * - * All of these functions take a reply_userdata parameter. This API function - * tells all requests with the matching reply_userdata value to try to return - * as soon as possible. If there are multiple requests with matching ID, it - * aborts all of them. - * - * This API function is mostly asynchronous itself. It will not wait until the - * command is aborted. Instead, the command will terminate as usual, but with - * some work not done. How this is signaled depends on the specific command (for - * example, the "subprocess" command will indicate it by "killed_by_us" set to - * true in the result). How long it takes also depends on the situation. The - * aborting process is completely asynchronous. - * - * Not all commands may support this functionality. In this case, this function - * will have no effect. The same is true if the request using the passed - * reply_userdata has already terminated, has not been started yet, or was - * never in use at all. - * - * You have to be careful of race conditions: the time during which the abort - * request will be effective is _after_ e.g. mpv_command_async() has returned, - * and before the command has signaled completion with MPV_EVENT_COMMAND_REPLY. - * - * @param reply_userdata ID of the request to be aborted (see above) - */ -MPV_EXPORT void mpv_abort_async_command(mpv_handle *ctx, uint64_t reply_userdata); - -/** - * Set a property to a given value. Properties are essentially variables which - * can be queried or set at runtime. For example, writing to the pause property - * will actually pause or unpause playback. - * - * If the format doesn't match with the internal format of the property, access - * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data - * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 - * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING - * usually invokes a string parser. The same happens when calling this function - * with MPV_FORMAT_NODE: the underlying format may be converted to another - * type if possible. - * - * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a - * mpv_node with the given format and data, and passing the mpv_node to this - * function. (Before API version 1.21, this was different.) - * - * Note: starting with mpv 0.21.0 (client API version 1.23), this can be used to - * set options in general. It even can be used before mpv_initialize() - * has been called. If called before mpv_initialize(), setting properties - * not backed by options will result in MPV_ERROR_PROPERTY_UNAVAILABLE. - * In some cases, properties and options still conflict. In these cases, - * mpv_set_property() accesses the options before mpv_initialize(), and - * the properties after mpv_initialize(). These conflicts will be removed - * in mpv 0.23.0. See mpv_set_option() for further remarks. - * - * @param name The property name. See input.rst for a list of properties. - * @param format see enum mpv_format. - * @param[in] data Option value. - * @return error code - */ -MPV_EXPORT int mpv_set_property(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Convenience function to set a property to a string value. - * - * This is like calling mpv_set_property() with MPV_FORMAT_STRING. - */ -MPV_EXPORT int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data); - -/** - * Convenience function to delete a property. - * - * This is equivalent to running the command "del [name]". - * - * @param name The property name. See input.rst for a list of properties. - * @return error code - */ -MPV_EXPORT int mpv_del_property(mpv_handle *ctx, const char *name); - -/** - * Set a property asynchronously. You will receive the result of the operation - * as MPV_EVENT_SET_PROPERTY_REPLY event. The mpv_event.error field will contain - * the result status of the operation. Otherwise, this function is similar to - * mpv_set_property(). - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata see section about asynchronous calls - * @param name The property name. - * @param format see enum mpv_format. - * @param[in] data Option value. The value will be copied by the function. It - * will never be modified by the client API. - * @return error code if sending the request failed - */ -MPV_EXPORT int mpv_set_property_async(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, mpv_format format, void *data); - -/** - * Read the value of the given property. - * - * If the format doesn't match with the internal format of the property, access - * usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, the data - * is automatically converted and access succeeds. For example, MPV_FORMAT_INT64 - * is always converted to MPV_FORMAT_DOUBLE, and access using MPV_FORMAT_STRING - * usually invokes a string formatter. - * - * @param name The property name. - * @param format see enum mpv_format. - * @param[out] data Pointer to the variable holding the option value. On - * success, the variable will be set to a copy of the option - * value. For formats that require dynamic memory allocation, - * you can free the value with mpv_free() (strings) or - * mpv_free_node_contents() (MPV_FORMAT_NODE). - * @return error code - */ -MPV_EXPORT int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format, - void *data); - -/** - * Return the value of the property with the given name as string. This is - * equivalent to mpv_get_property() with MPV_FORMAT_STRING. - * - * See MPV_FORMAT_STRING for character encoding issues. - * - * On error, NULL is returned. Use mpv_get_property() if you want fine-grained - * error reporting. - * - * @param name The property name. - * @return Property value, or NULL if the property can't be retrieved. Free - * the string with mpv_free(). - */ -MPV_EXPORT char *mpv_get_property_string(mpv_handle *ctx, const char *name); - -/** - * Return the property as "OSD" formatted string. This is the same as - * mpv_get_property_string, but using MPV_FORMAT_OSD_STRING. - * - * @return Property value, or NULL if the property can't be retrieved. Free - * the string with mpv_free(). - */ -MPV_EXPORT char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name); - -/** - * Get a property asynchronously. You will receive the result of the operation - * as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event. - * You should check the mpv_event.error field on the reply event. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata see section about asynchronous calls - * @param name The property name. - * @param format see enum mpv_format. - * @return error code if sending the request failed - */ -MPV_EXPORT int mpv_get_property_async(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, mpv_format format); - -/** - * Get a notification whenever the given property changes. You will receive - * updates as MPV_EVENT_PROPERTY_CHANGE. Note that this is not very precise: - * for some properties, it may not send updates even if the property changed. - * This depends on the property, and it's a valid feature request to ask for - * better update handling of a specific property. (For some properties, like - * ``clock``, which shows the wall clock, this mechanism doesn't make too - * much sense anyway.) - * - * Property changes are coalesced: the change events are returned only once the - * event queue becomes empty (e.g. mpv_wait_event() would block or return - * MPV_EVENT_NONE), and then only one event per changed property is returned. - * - * You always get an initial change notification. This is meant to initialize - * the user's state to the current value of the property. - * - * Normally, change events are sent only if the property value changes according - * to the requested format. mpv_event_property will contain the property value - * as data member. - * - * Warning: if a property is unavailable or retrieving it caused an error, - * MPV_FORMAT_NONE will be set in mpv_event_property, even if the - * format parameter was set to a different value. In this case, the - * mpv_event_property.data field is invalid. - * - * If the property is observed with the format parameter set to MPV_FORMAT_NONE, - * you get low-level notifications whether the property _may_ have changed, and - * the data member in mpv_event_property will be unset. With this mode, you - * will have to determine yourself whether the property really changed. On the - * other hand, this mechanism can be faster and uses less resources. - * - * Observing a property that doesn't exist is allowed. (Although it may still - * cause some sporadic change events.) - * - * Keep in mind that you will get change notifications even if you change a - * property yourself. Try to avoid endless feedback loops, which could happen - * if you react to the change notifications triggered by your own change. - * - * Only the mpv_handle on which this was called will receive the property - * change events, or can unobserve them. - * - * Safe to be called from mpv render API threads. - * - * @param reply_userdata This will be used for the mpv_event.reply_userdata - * field for the received MPV_EVENT_PROPERTY_CHANGE - * events. (Also see section about asynchronous calls, - * although this function is somewhat different from - * actual asynchronous calls.) - * If you have no use for this, pass 0. - * Also see mpv_unobserve_property(). - * @param name The property name. - * @param format see enum mpv_format. Can be MPV_FORMAT_NONE to omit values - * from the change events. - * @return error code (usually fails only on OOM or unsupported format) - */ -MPV_EXPORT int mpv_observe_property(mpv_handle *mpv, uint64_t reply_userdata, - const char *name, mpv_format format); - -/** - * Undo mpv_observe_property(). This will remove all observed properties for - * which the given number was passed as reply_userdata to mpv_observe_property. - * - * Safe to be called from mpv render API threads. - * - * @param registered_reply_userdata ID that was passed to mpv_observe_property - * @return negative value is an error code, >=0 is number of removed properties - * on success (includes the case when 0 were removed) - */ -MPV_EXPORT int mpv_unobserve_property(mpv_handle *mpv, uint64_t registered_reply_userdata); - -typedef enum mpv_event_id { - /** - * Nothing happened. Happens on timeouts or sporadic wakeups. - */ - MPV_EVENT_NONE = 0, - /** - * Happens when the player quits. The player enters a state where it tries - * to disconnect all clients. Most requests to the player will fail, and - * the client should react to this and quit with mpv_destroy() as soon as - * possible. - */ - MPV_EVENT_SHUTDOWN = 1, - /** - * See mpv_request_log_messages(). - */ - MPV_EVENT_LOG_MESSAGE = 2, - /** - * Reply to a mpv_get_property_async() request. - * See also mpv_event and mpv_event_property. - */ - MPV_EVENT_GET_PROPERTY_REPLY = 3, - /** - * Reply to a mpv_set_property_async() request. - * (Unlike MPV_EVENT_GET_PROPERTY, mpv_event_property is not used.) - */ - MPV_EVENT_SET_PROPERTY_REPLY = 4, - /** - * Reply to a mpv_command_async() or mpv_command_node_async() request. - * See also mpv_event and mpv_event_command. - */ - MPV_EVENT_COMMAND_REPLY = 5, - /** - * Notification before playback start of a file (before the file is loaded). - * See also mpv_event and mpv_event_start_file. - */ - MPV_EVENT_START_FILE = 6, - /** - * Notification after playback end (after the file was unloaded). - * See also mpv_event and mpv_event_end_file. - */ - MPV_EVENT_END_FILE = 7, - /** - * Notification when the file has been loaded (headers were read etc.), and - * decoding starts. - */ - MPV_EVENT_FILE_LOADED = 8, -#if MPV_ENABLE_DEPRECATED - /** - * Idle mode was entered. In this mode, no file is played, and the playback - * core waits for new commands. (The command line player normally quits - * instead of entering idle mode, unless --idle was specified. If mpv - * was started with mpv_create(), idle mode is enabled by default.) - * - * @deprecated This is equivalent to using mpv_observe_property() on the - * "idle-active" property. The event is redundant, and might be - * removed in the far future. As a further warning, this event - * is not necessarily sent at the right point anymore (at the - * start of the program), while the property behaves correctly. - */ - MPV_EVENT_IDLE = 11, - /** - * Sent every time after a video frame is displayed. Note that currently, - * this will be sent in lower frequency if there is no video, or playback - * is paused - but that will be removed in the future, and it will be - * restricted to video frames only. - * - * @deprecated Use mpv_observe_property() with relevant properties instead - * (such as "playback-time"). - */ - MPV_EVENT_TICK = 14, -#endif - /** - * Triggered by the script-message input command. The command uses the - * first argument of the command as client name (see mpv_client_name()) to - * dispatch the message, and passes along all arguments starting from the - * second argument as strings. - * See also mpv_event and mpv_event_client_message. - */ - MPV_EVENT_CLIENT_MESSAGE = 16, - /** - * Happens after video changed in some way. This can happen on resolution - * changes, pixel format changes, or video filter changes. The event is - * sent after the video filters and the VO are reconfigured. Applications - * embedding a mpv window should listen to this event in order to resize - * the window if needed. - * Note that this event can happen sporadically, and you should check - * yourself whether the video parameters really changed before doing - * something expensive. - */ - MPV_EVENT_VIDEO_RECONFIG = 17, - /** - * Similar to MPV_EVENT_VIDEO_RECONFIG. This is relatively uninteresting, - * because there is no such thing as audio output embedding. - */ - MPV_EVENT_AUDIO_RECONFIG = 18, - /** - * Happens when a seek was initiated. Playback stops. Usually it will - * resume with MPV_EVENT_PLAYBACK_RESTART as soon as the seek is finished. - */ - MPV_EVENT_SEEK = 20, - /** - * There was a discontinuity of some sort (like a seek), and playback - * was reinitialized. Usually happens on start of playback and after - * seeking. The main purpose is allowing the client to detect when a seek - * request is finished. - */ - MPV_EVENT_PLAYBACK_RESTART = 21, - /** - * Event sent due to mpv_observe_property(). - * See also mpv_event and mpv_event_property. - */ - MPV_EVENT_PROPERTY_CHANGE = 22, - /** - * Happens if the internal per-mpv_handle ringbuffer overflows, and at - * least 1 event had to be dropped. This can happen if the client doesn't - * read the event queue quickly enough with mpv_wait_event(), or if the - * client makes a very large number of asynchronous calls at once. - * - * Event delivery will continue normally once this event was returned - * (this forces the client to empty the queue completely). - */ - MPV_EVENT_QUEUE_OVERFLOW = 24, - /** - * Triggered if a hook handler was registered with mpv_hook_add(), and the - * hook is invoked. If you receive this, you must handle it, and continue - * the hook with mpv_hook_continue(). - * See also mpv_event and mpv_event_hook. - */ - MPV_EVENT_HOOK = 25, - // Internal note: adjust INTERNAL_EVENT_BASE when adding new events. -} mpv_event_id; - -/** - * Return a string describing the event. For unknown events, NULL is returned. - * - * Note that all events actually returned by the API will also yield a non-NULL - * string with this function. - * - * @param event event ID, see see enum mpv_event_id - * @return A static string giving a short symbolic name of the event. It - * consists of lower-case alphanumeric characters and can include "-" - * characters. This string is suitable for use in e.g. scripting - * interfaces. - * The string is completely static, i.e. doesn't need to be deallocated, - * and is valid forever. - */ -MPV_EXPORT const char *mpv_event_name(mpv_event_id event); - -typedef struct mpv_event_property { - /** - * Name of the property. - */ - const char *name; - /** - * Format of the data field in the same struct. See enum mpv_format. - * This is always the same format as the requested format, except when - * the property could not be retrieved (unavailable, or an error happened), - * in which case the format is MPV_FORMAT_NONE. - */ - mpv_format format; - /** - * Received property value. Depends on the format. This is like the - * pointer argument passed to mpv_get_property(). - * - * For example, for MPV_FORMAT_STRING you get the string with: - * - * char *value = *(char **)(event_property->data); - * - * Note that this is set to NULL if retrieving the property failed (the - * format will be MPV_FORMAT_NONE). - */ - void *data; -} mpv_event_property; - -/** - * Numeric log levels. The lower the number, the more important the message is. - * MPV_LOG_LEVEL_NONE is never used when receiving messages. The string in - * the comment after the value is the name of the log level as used for the - * mpv_request_log_messages() function. - * Unused numeric values are unused, but reserved for future use. - */ -typedef enum mpv_log_level { - MPV_LOG_LEVEL_NONE = 0, /// "no" - disable absolutely all messages - MPV_LOG_LEVEL_FATAL = 10, /// "fatal" - critical/aborting errors - MPV_LOG_LEVEL_ERROR = 20, /// "error" - simple errors - MPV_LOG_LEVEL_WARN = 30, /// "warn" - possible problems - MPV_LOG_LEVEL_INFO = 40, /// "info" - informational message - MPV_LOG_LEVEL_V = 50, /// "v" - noisy informational message - MPV_LOG_LEVEL_DEBUG = 60, /// "debug" - very noisy technical information - MPV_LOG_LEVEL_TRACE = 70, /// "trace" - extremely noisy -} mpv_log_level; - -typedef struct mpv_event_log_message { - /** - * The module prefix, identifies the sender of the message. As a special - * case, if the message buffer overflows, this will be set to the string - * "overflow" (which doesn't appear as prefix otherwise), and the text - * field will contain an informative message. - */ - const char *prefix; - /** - * The log level as string. See mpv_request_log_messages() for possible - * values. The level "no" is never used here. - */ - const char *level; - /** - * The log message. It consists of 1 line of text, and is terminated with - * a newline character. (Before API version 1.6, it could contain multiple - * or partial lines.) - */ - const char *text; - /** - * The same contents as the level field, but as a numeric ID. - * Since API version 1.6. - */ - mpv_log_level log_level; -} mpv_event_log_message; - -/// Since API version 1.9. -typedef enum mpv_end_file_reason { - /** - * The end of file was reached. Sometimes this may also happen on - * incomplete or corrupted files, or if the network connection was - * interrupted when playing a remote file. It also happens if the - * playback range was restricted with --end or --frames or similar. - */ - MPV_END_FILE_REASON_EOF = 0, - /** - * Playback was stopped by an external action (e.g. playlist controls). - */ - MPV_END_FILE_REASON_STOP = 2, - /** - * Playback was stopped by the quit command or player shutdown. - */ - MPV_END_FILE_REASON_QUIT = 3, - /** - * Some kind of error happened that lead to playback abort. Does not - * necessarily happen on incomplete or broken files (in these cases, both - * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). - * - * mpv_event_end_file.error will be set. - */ - MPV_END_FILE_REASON_ERROR = 4, - /** - * The file was a playlist or similar. When the playlist is read, its - * entries will be appended to the playlist after the entry of the current - * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE - * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then - * playback continues with the playlist contents. - * Since API version 1.18. - */ - MPV_END_FILE_REASON_REDIRECT = 5, -} mpv_end_file_reason; - -/// Since API version 1.108. -typedef struct mpv_event_start_file { - /** - * Playlist entry ID of the file being loaded now. - */ - int64_t playlist_entry_id; -} mpv_event_start_file; - -typedef struct mpv_event_end_file { - /** - * Corresponds to the values in enum mpv_end_file_reason. - * - * Unknown values should be treated as unknown. - */ - mpv_end_file_reason reason; - /** - * If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code - * (one of MPV_ERROR_...) giving an approximate reason why playback - * failed. In other cases, this field is 0 (no error). - * Since API version 1.9. - */ - int error; - /** - * Playlist entry ID of the file that was being played or attempted to be - * played. This has the same value as the playlist_entry_id field in the - * corresponding mpv_event_start_file event. - * Since API version 1.108. - */ - int64_t playlist_entry_id; - /** - * If loading ended, because the playlist entry to be played was for example - * a playlist, and the current playlist entry is replaced with a number of - * other entries. This may happen at least with MPV_END_FILE_REASON_REDIRECT - * (other event types may use this for similar but different purposes in the - * future). In this case, playlist_insert_id will be set to the playlist - * entry ID of the first inserted entry, and playlist_insert_num_entries to - * the total number of inserted playlist entries. Note this in this specific - * case, the ID of the last inserted entry is playlist_insert_id+num-1. - * Beware that depending on circumstances, you may observe the new playlist - * entries before seeing the event (e.g. reading the "playlist" property or - * getting a property change notification before receiving the event). - * Since API version 1.108. - */ - int64_t playlist_insert_id; - /** - * See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never - * negative. - * Since API version 1.108. - */ - int playlist_insert_num_entries; -} mpv_event_end_file; - -typedef struct mpv_event_client_message { - /** - * Arbitrary arguments chosen by the sender of the message. If num_args > 0, - * you can access args[0] through args[num_args - 1] (inclusive). What - * these arguments mean is up to the sender and receiver. - * None of the valid items are NULL. - */ - int num_args; - const char **args; -} mpv_event_client_message; - -typedef struct mpv_event_hook { - /** - * The hook name as passed to mpv_hook_add(). - */ - const char *name; - /** - * Internal ID that must be passed to mpv_hook_continue(). - */ - uint64_t id; -} mpv_event_hook; - -// Since API version 1.102. -typedef struct mpv_event_command { - /** - * Result data of the command. Note that success/failure is signaled - * separately via mpv_event.error. This field is only for result data - * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set - * to MPV_FORMAT_NONE on failure. - */ - mpv_node result; -} mpv_event_command; - -typedef struct mpv_event { - /** - * One of mpv_event. Keep in mind that later ABI compatible releases might - * add new event types. These should be ignored by the API user. - */ - mpv_event_id event_id; - /** - * This is mainly used for events that are replies to (asynchronous) - * requests. It contains a status code, which is >= 0 on success, or < 0 - * on error (a mpv_error value). Usually, this will be set if an - * asynchronous request fails. - * Used for: - * MPV_EVENT_GET_PROPERTY_REPLY - * MPV_EVENT_SET_PROPERTY_REPLY - * MPV_EVENT_COMMAND_REPLY - */ - int error; - /** - * If the event is in reply to a request (made with this API and this - * API handle), this is set to the reply_userdata parameter of the request - * call. Otherwise, this field is 0. - * Used for: - * MPV_EVENT_GET_PROPERTY_REPLY - * MPV_EVENT_SET_PROPERTY_REPLY - * MPV_EVENT_COMMAND_REPLY - * MPV_EVENT_PROPERTY_CHANGE - * MPV_EVENT_HOOK - */ - uint64_t reply_userdata; - /** - * The meaning and contents of the data member depend on the event_id: - * MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* - * MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* - * MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* - * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* - * MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) - * MPV_EVENT_END_FILE: mpv_event_end_file* - * MPV_EVENT_HOOK: mpv_event_hook* - * MPV_EVENT_COMMAND_REPLY* mpv_event_command* - * other: NULL - * - * Note: future enhancements might add new event structs for existing or new - * event types. - */ - void *data; -} mpv_event; - -/** - * Convert the given src event to a mpv_node, and set *dst to the result. *dst - * is set to a MPV_FORMAT_NODE_MAP, with fields for corresponding mpv_event and - * mpv_event.data/mpv_event_* fields. - * - * The exact details are not completely documented out of laziness. A start - * is located in the "Events" section of the manpage. - * - * *dst may point to newly allocated memory, or pointers in mpv_event. You must - * copy the entire mpv_node if you want to reference it after mpv_event becomes - * invalid (such as making a new mpv_wait_event() call, or destroying the - * mpv_handle from which it was returned). Call mpv_free_node_contents() to free - * any memory allocations made by this API function. - * - * Safe to be called from mpv render API threads. - * - * @param dst Target. This is not read and fully overwritten. Must be released - * with mpv_free_node_contents(). Do not write to pointers returned - * by it. (On error, this may be left as an empty node.) - * @param src The source event. Not modified (it's not const due to the author's - * prejudice of the C version of const). - * @return error code (MPV_ERROR_NOMEM only, if at all) - */ -MPV_EXPORT int mpv_event_to_node(mpv_node *dst, mpv_event *src); - -/** - * Enable or disable the given event. - * - * Some events are enabled by default. Some events can't be disabled. - * - * (Informational note: currently, all events are enabled by default, except - * MPV_EVENT_TICK.) - * - * Safe to be called from mpv render API threads. - * - * @param event See enum mpv_event_id. - * @param enable 1 to enable receiving this event, 0 to disable it. - * @return error code - */ -MPV_EXPORT int mpv_request_event(mpv_handle *ctx, mpv_event_id event, int enable); - -/** - * Enable or disable receiving of log messages. These are the messages the - * command line player prints to the terminal. This call sets the minimum - * required log level for a message to be received with MPV_EVENT_LOG_MESSAGE. - * - * @param min_level Minimal log level as string. Valid log levels: - * no fatal error warn info v debug trace - * The value "no" disables all messages. This is the default. - * An exception is the value "terminal-default", which uses the - * log level as set by the "--msg-level" option. This works - * even if the terminal is disabled. (Since API version 1.19.) - * Also see mpv_log_level. - * @return error code - */ -MPV_EXPORT int mpv_request_log_messages(mpv_handle *ctx, const char *min_level); - -/** - * Wait for the next event, or until the timeout expires, or if another thread - * makes a call to mpv_wakeup(). Passing 0 as timeout will never wait, and - * is suitable for polling. - * - * The internal event queue has a limited size (per client handle). If you - * don't empty the event queue quickly enough with mpv_wait_event(), it will - * overflow and silently discard further events. If this happens, making - * asynchronous requests will fail as well (with MPV_ERROR_EVENT_QUEUE_FULL). - * - * Only one thread is allowed to call this on the same mpv_handle at a time. - * The API won't complain if more than one thread calls this, but it will cause - * race conditions in the client when accessing the shared mpv_event struct. - * Note that most other API functions are not restricted by this, and no API - * function internally calls mpv_wait_event(). Additionally, concurrent calls - * to different mpv_handles are always safe. - * - * As long as the timeout is 0, this is safe to be called from mpv render API - * threads. - * - * @param timeout Timeout in seconds, after which the function returns even if - * no event was received. A MPV_EVENT_NONE is returned on - * timeout. A value of 0 will disable waiting. Negative values - * will wait with an infinite timeout. - * @return A struct containing the event ID and other data. The pointer (and - * fields in the struct) stay valid until the next mpv_wait_event() - * call, or until the mpv_handle is destroyed. You must not write to - * the struct, and all memory referenced by it will be automatically - * released by the API on the next mpv_wait_event() call, or when the - * context is destroyed. The return value is never NULL. - */ -MPV_EXPORT mpv_event *mpv_wait_event(mpv_handle *ctx, double timeout); - -/** - * Interrupt the current mpv_wait_event() call. This will wake up the thread - * currently waiting in mpv_wait_event(). If no thread is waiting, the next - * mpv_wait_event() call will return immediately (this is to avoid lost - * wakeups). - * - * mpv_wait_event() will receive a MPV_EVENT_NONE if it's woken up due to - * this call. But note that this dummy event might be skipped if there are - * already other events queued. All what counts is that the waiting thread - * is woken up at all. - * - * Safe to be called from mpv render API threads. - */ -MPV_EXPORT void mpv_wakeup(mpv_handle *ctx); - -/** - * Set a custom function that should be called when there are new events. Use - * this if blocking in mpv_wait_event() to wait for new events is not feasible. - * - * Keep in mind that the callback will be called from foreign threads. You - * must not make any assumptions of the environment, and you must return as - * soon as possible (i.e. no long blocking waits). Exiting the callback through - * any other means than a normal return is forbidden (no throwing exceptions, - * no longjmp() calls). You must not change any local thread state (such as - * the C floating point environment). - * - * You are not allowed to call any client API functions inside of the callback. - * In particular, you should not do any processing in the callback, but wake up - * another thread that does all the work. The callback is meant strictly for - * notification only, and is called from arbitrary core parts of the player, - * that make no considerations for reentrant API use or allowing the callee to - * spend a lot of time doing other things. Keep in mind that it's also possible - * that the callback is called from a thread while a mpv API function is called - * (i.e. it can be reentrant). - * - * In general, the client API expects you to call mpv_wait_event() to receive - * notifications, and the wakeup callback is merely a helper utility to make - * this easier in certain situations. Note that it's possible that there's - * only one wakeup callback invocation for multiple events. You should call - * mpv_wait_event() with no timeout until MPV_EVENT_NONE is reached, at which - * point the event queue is empty. - * - * If you actually want to do processing in a callback, spawn a thread that - * does nothing but call mpv_wait_event() in a loop and dispatches the result - * to a callback. - * - * Only one wakeup callback can be set. - * - * @param cb function that should be called if a wakeup is required - * @param d arbitrary userdata passed to cb - */ -MPV_EXPORT void mpv_set_wakeup_callback(mpv_handle *ctx, void (*cb)(void *d), void *d); - -/** - * Block until all asynchronous requests are done. This affects functions like - * mpv_command_async(), which return immediately and return their result as - * events. - * - * This is a helper, and somewhat equivalent to calling mpv_wait_event() in a - * loop until all known asynchronous requests have sent their reply as event, - * except that the event queue is not emptied. - * - * In case you called mpv_suspend() before, this will also forcibly reset the - * suspend counter of the given handle. - */ -MPV_EXPORT void mpv_wait_async_requests(mpv_handle *ctx); - -/** - * A hook is like a synchronous event that blocks the player. You register - * a hook handler with this function. You will get an event, which you need - * to handle, and once things are ready, you can let the player continue with - * mpv_hook_continue(). - * - * Currently, hooks can't be removed explicitly. But they will be implicitly - * removed if the mpv_handle it was registered with is destroyed. This also - * continues the hook if it was being handled by the destroyed mpv_handle (but - * this should be avoided, as it might mess up order of hook execution). - * - * Hook handlers are ordered globally by priority and order of registration. - * Handlers for the same hook with same priority are invoked in order of - * registration (the handler registered first is run first). Handlers with - * lower priority are run first (which seems backward). - * - * See the "Hooks" section in the manpage to see which hooks are currently - * defined. - * - * Some hooks might be reentrant (so you get multiple MPV_EVENT_HOOK for the - * same hook). If this can happen for a specific hook type, it will be - * explicitly documented in the manpage. - * - * Only the mpv_handle on which this was called will receive the hook events, - * or can "continue" them. - * - * @param reply_userdata This will be used for the mpv_event.reply_userdata - * field for the received MPV_EVENT_HOOK events. - * If you have no use for this, pass 0. - * @param name The hook name. This should be one of the documented names. But - * if the name is unknown, the hook event will simply be never - * raised. - * @param priority See remarks above. Use 0 as a neutral default. - * @return error code (usually fails only on OOM) - */ -MPV_EXPORT int mpv_hook_add(mpv_handle *ctx, uint64_t reply_userdata, - const char *name, int priority); - -/** - * Respond to a MPV_EVENT_HOOK event. You must call this after you have handled - * the event. There is no way to "cancel" or "stop" the hook. - * - * Calling this will will typically unblock the player for whatever the hook - * is responsible for (e.g. for the "on_load" hook it lets it continue - * playback). - * - * It is explicitly undefined behavior to call this more than once for each - * MPV_EVENT_HOOK, to pass an incorrect ID, or to call this on a mpv_handle - * different from the one that registered the handler and received the event. - * - * @param id This must be the value of the mpv_event_hook.id field for the - * corresponding MPV_EVENT_HOOK. - * @return error code - */ -MPV_EXPORT int mpv_hook_continue(mpv_handle *ctx, uint64_t id); - -#if MPV_ENABLE_DEPRECATED - -/** - * Return a UNIX file descriptor referring to the read end of a pipe. This - * pipe can be used to wake up a poll() based processing loop. The purpose of - * this function is very similar to mpv_set_wakeup_callback(), and provides - * a primitive mechanism to handle coordinating a foreign event loop and the - * libmpv event loop. The pipe is non-blocking. It's closed when the mpv_handle - * is destroyed. This function always returns the same value (on success). - * - * This is in fact implemented using the same underlying code as for - * mpv_set_wakeup_callback() (though they don't conflict), and it is as if each - * callback invocation writes a single 0 byte to the pipe. When the pipe - * becomes readable, the code calling poll() (or select()) on the pipe should - * read all contents of the pipe and then call mpv_wait_event(c, 0) until - * no new events are returned. The pipe contents do not matter and can just - * be discarded. There is not necessarily one byte per readable event in the - * pipe. For example, the pipes are non-blocking, and mpv won't block if the - * pipe is full. Pipes are normally limited to 4096 bytes, so if there are - * more than 4096 events, the number of readable bytes can not equal the number - * of events queued. Also, it's possible that mpv does not write to the pipe - * once it's guaranteed that the client was already signaled. See the example - * below how to do it correctly. - * - * Example: - * - * int pipefd = mpv_get_wakeup_pipe(mpv); - * if (pipefd < 0) - * error(); - * while (1) { - * struct pollfd pfds[1] = { - * { .fd = pipefd, .events = POLLIN }, - * }; - * // Wait until there are possibly new mpv events. - * poll(pfds, 1, -1); - * if (pfds[0].revents & POLLIN) { - * // Empty the pipe. Doing this before calling mpv_wait_event() - * // ensures that no wakeups are missed. It's not so important to - * // make sure the pipe is really empty (it will just cause some - * // additional wakeups in unlikely corner cases). - * char unused[256]; - * read(pipefd, unused, sizeof(unused)); - * while (1) { - * mpv_event *ev = mpv_wait_event(mpv, 0); - * // If MPV_EVENT_NONE is received, the event queue is empty. - * if (ev->event_id == MPV_EVENT_NONE) - * break; - * // Process the event. - * ... - * } - * } - * } - * - * @deprecated this function will be removed in the future. If you need this - * functionality, use mpv_set_wakeup_callback(), create a pipe - * manually, and call write() on your pipe in the callback. - * - * @return A UNIX FD of the read end of the wakeup pipe, or -1 on error. - * On MS Windows/MinGW, this will always return -1. - */ -MPV_EXPORT int mpv_get_wakeup_pipe(mpv_handle *ctx); - -#endif - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h deleted file mode 100644 index 29f9b91e9..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render.h +++ /dev/null @@ -1,738 +0,0 @@ -/* Copyright (C) 2018 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_RENDER_H_ -#define MPV_CLIENT_API_RENDER_H_ - -#include "client.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Overview - * -------- - * - * This API can be used to make mpv render using supported graphic APIs (such - * as OpenGL). It can be used to handle video display. - * - * The renderer needs to be created with mpv_render_context_create() before - * you start playback (or otherwise cause a VO to be created). Then (with most - * backends) mpv_render_context_render() can be used to explicitly render the - * current video frame. Use mpv_render_context_set_update_callback() to get - * notified when there is a new frame to draw. - * - * Preferably rendering should be done in a separate thread. If you call - * normal libmpv API functions on the renderer thread, deadlocks can result - * (these are made non-fatal with timeouts, but user experience will obviously - * suffer). See "Threading" section below. - * - * You can output and embed video without this API by setting the mpv "wid" - * option to a native window handle (see "Embedding the video window" section - * in the client.h header). In general, using the render API is recommended, - * because window embedding can cause various issues, especially with GUI - * toolkits and certain platforms. - * - * Supported backends - * ------------------ - * - * OpenGL: via MPV_RENDER_API_TYPE_OPENGL, see render_gl.h header. - * Software: via MPV_RENDER_API_TYPE_SW, see section "Software renderer" - * - * Threading - * --------- - * - * You are recommended to do rendering on a separate thread than normal libmpv - * use. - * - * The mpv_render_* functions can be called from any thread, under the - * following conditions: - * - only one of the mpv_render_* functions can be called at the same time - * (unless they belong to different mpv cores created by mpv_create()) - * - never can be called from within the callbacks set with - * mpv_set_wakeup_callback() or mpv_render_context_set_update_callback() - * - if the OpenGL backend is used, for all functions the OpenGL context - * must be "current" in the calling thread, and it must be the same OpenGL - * context as the mpv_render_context was created with. Otherwise, undefined - * behavior will occur. - * - the thread does not call libmpv API functions other than the mpv_render_* - * functions, except APIs which are declared as safe (see below). Likewise, - * there must be no lock or wait dependency from the render thread to a - * thread using other libmpv functions. Basically, the situation that your - * render thread waits for a "not safe" libmpv API function to return must - * not happen. If you ignore this requirement, deadlocks can happen, which - * are made non-fatal with timeouts; then playback quality will be degraded, - * and the message - * mpv_render_context_render() not being called or stuck. - * is logged. If you set MPV_RENDER_PARAM_ADVANCED_CONTROL, you promise that - * this won't happen, and must absolutely guarantee it, or a real deadlock - * will freeze the mpv core thread forever. - * - * libmpv functions which are safe to call from a render thread are: - * - functions marked with "Safe to be called from mpv render API threads." - * - client.h functions which don't have an explicit or implicit mpv_handle - * parameter - * - mpv_render_* functions; but only for the same mpv_render_context pointer. - * If the pointer is different, mpv_render_context_free() is not safe. (The - * reason is that if MPV_RENDER_PARAM_ADVANCED_CONTROL is set, it may have - * to process still queued requests from the core, which it can do only for - * the current context, while requests for other contexts would deadlock. - * Also, it may have to wait and block for the core to terminate the video - * chain to make sure no resources are used after context destruction.) - * - if the mpv_handle parameter refers to a different mpv core than the one - * you're rendering for (very obscure, but allowed) - * - * Note about old libmpv version: - * - * Before API version 1.105 (basically in mpv 0.29.x), simply enabling - * MPV_RENDER_PARAM_ADVANCED_CONTROL could cause deadlock issues. This can - * be worked around by setting the "vd-lavc-dr" option to "no". - * In addition, you were required to call all mpv_render*() API functions - * from the same thread on which mpv_render_context_create() was originally - * run (for the same the mpv_render_context). Not honoring it led to UB - * (deadlocks, use of invalid pthread_t handles), even if you moved your GL - * context to a different thread correctly. - * These problems were addressed in API version 1.105 (mpv 0.30.0). - * - * Context and handle lifecycle - * ---------------------------- - * - * Video initialization will fail if the render context was not initialized yet - * (with mpv_render_context_create()), or it will revert to a VO that creates - * its own window. - * - * Currently, there can be only 1 mpv_render_context at a time per mpv core. - * - * Calling mpv_render_context_free() while a VO is using the render context is - * active will disable video. - * - * You must free the context with mpv_render_context_free() before the mpv core - * is destroyed. If this doesn't happen, undefined behavior will result. - * - * Software renderer - * ----------------- - * - * MPV_RENDER_API_TYPE_SW provides an extremely simple (but slow) renderer to - * memory surfaces. You probably don't want to use this. Use other render API - * types, or other methods of video embedding. - * - * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to - * MPV_RENDER_API_TYPE_SW. - * - * Call mpv_render_context_render() with various MPV_RENDER_PARAM_SW_* fields - * to render the video frame to an in-memory surface. The following fields are - * required: MPV_RENDER_PARAM_SW_SIZE, MPV_RENDER_PARAM_SW_FORMAT, - * MPV_RENDER_PARAM_SW_STRIDE, MPV_RENDER_PARAM_SW_POINTER. - * - * This method of rendering is very slow, because everything, including color - * conversion, scaling, and OSD rendering, is done on the CPU, single-threaded. - * In particular, large video or display sizes, as well as presence of OSD or - * subtitles can make it too slow for realtime. As with other software rendering - * VOs, setting "sw-fast" may help. Enabling or disabling zimg may help, - * depending on the platform. - * - * In addition, certain multimedia job creation measures like HDR may not work - * properly, and will have to be manually handled by for example inserting - * filters. - * - * This API is not really suitable to extract individual frames from video etc. - * (basically non-playback uses) - there are better libraries for this. It can - * be used this way, but it may be clunky and tricky. - * - * Further notes: - * - MPV_RENDER_PARAM_FLIP_Y is currently ignored (unsupported) - * - MPV_RENDER_PARAM_DEPTH is ignored (meaningless) - */ - -/** - * Opaque context, returned by mpv_render_context_create(). - */ -typedef struct mpv_render_context mpv_render_context; - -/** - * Parameters for mpv_render_param (which is used in a few places such as - * mpv_render_context_create(). - * - * Also see mpv_render_param for conventions and how to use it. - */ -typedef enum mpv_render_param_type { - /** - * Not a valid value, but also used to terminate a params array. Its value - * is always guaranteed to be 0 (even if the ABI changes in the future). - */ - MPV_RENDER_PARAM_INVALID = 0, - /** - * The render API to use. Valid for mpv_render_context_create(). - * - * Type: char* - * - * Defined APIs: - * - * MPV_RENDER_API_TYPE_OPENGL: - * OpenGL desktop 2.1 or later (preferably core profile compatible to - * OpenGL 3.2), or OpenGLES 2.0 or later. - * Providing MPV_RENDER_PARAM_OPENGL_INIT_PARAMS is required. - * It is expected that an OpenGL context is valid and "current" when - * calling mpv_render_* functions (unless specified otherwise). It - * must be the same context for the same mpv_render_context. - */ - MPV_RENDER_PARAM_API_TYPE = 1, - /** - * Required parameters for initializing the OpenGL renderer. Valid for - * mpv_render_context_create(). - * Type: mpv_opengl_init_params* - */ - MPV_RENDER_PARAM_OPENGL_INIT_PARAMS = 2, - /** - * Describes a GL render target. Valid for mpv_render_context_render(). - * Type: mpv_opengl_fbo* - */ - MPV_RENDER_PARAM_OPENGL_FBO = 3, - /** - * Control flipped rendering. Valid for mpv_render_context_render(). - * Type: int* - * If the value is set to 0, render normally. Otherwise, render it flipped, - * which is needed e.g. when rendering to an OpenGL default framebuffer - * (which has a flipped coordinate system). - */ - MPV_RENDER_PARAM_FLIP_Y = 4, - /** - * Control surface depth. Valid for mpv_render_context_render(). - * Type: int* - * This implies the depth of the surface passed to the render function in - * bits per channel. If omitted or set to 0, the renderer will assume 8. - * Typically used to control dithering. - */ - MPV_RENDER_PARAM_DEPTH = 5, - /** - * ICC profile blob. Valid for mpv_render_context_set_parameter(). - * Type: mpv_byte_array* - * Set an ICC profile for use with the "icc-profile-auto" option. (If the - * option is not enabled, the ICC data will not be used.) - */ - MPV_RENDER_PARAM_ICC_PROFILE = 6, - /** - * Ambient light in lux. Valid for mpv_render_context_set_parameter(). - * Type: int* - * This can be used for automatic gamma correction. - */ - MPV_RENDER_PARAM_AMBIENT_LIGHT = 7, - /** - * X11 Display, sometimes used for hwdec. Valid for - * mpv_render_context_create(). The Display must stay valid for the lifetime - * of the mpv_render_context. - * Type: Display* - */ - MPV_RENDER_PARAM_X11_DISPLAY = 8, - /** - * Wayland display, sometimes used for hwdec. Valid for - * mpv_render_context_create(). The wl_display must stay valid for the - * lifetime of the mpv_render_context. - * Type: struct wl_display* - */ - MPV_RENDER_PARAM_WL_DISPLAY = 9, - /** - * Better control about rendering and enabling some advanced features. Valid - * for mpv_render_context_create(). - * - * This conflates multiple requirements the API user promises to abide if - * this option is enabled: - * - * - The API user's render thread, which is calling the mpv_render_*() - * functions, never waits for the core. Otherwise deadlocks can happen. - * See "Threading" section. - * - The callback set with mpv_render_context_set_update_callback() can now - * be called even if there is no new frame. The API user should call the - * mpv_render_context_update() function, and interpret the return value - * for whether a new frame should be rendered. - * - Correct functionality is impossible if the update callback is not set, - * or not set soon enough after mpv_render_context_create() (the core can - * block while waiting for you to call mpv_render_context_update(), and - * if the update callback is not correctly set, it will deadlock, or - * block for too long). - * - * In general, setting this option will enable the following features (and - * possibly more): - * - * - "Direct rendering", which means the player decodes directly to a - * texture, which saves a copy per video frame ("vd-lavc-dr" option - * needs to be enabled, and the rendering backend as well as the - * underlying GPU API/driver needs to have support for it). - * - Rendering screenshots with the GPU API if supported by the backend - * (instead of using a suboptimal software fallback via libswscale). - * - * Warning: do not just add this without reading the "Threading" section - * above, and then wondering that deadlocks happen. The - * requirements are tricky. But also note that even if advanced - * control is disabled, not adhering to the rules will lead to - * playback problems. Enabling advanced controls simply makes - * violating these rules fatal. - * - * Type: int*: 0 for disable (default), 1 for enable - */ - MPV_RENDER_PARAM_ADVANCED_CONTROL = 10, - /** - * Return information about the next frame to render. Valid for - * mpv_render_context_get_info(). - * - * Type: mpv_render_frame_info* - * - * It strictly returns information about the _next_ frame. The implication - * is that e.g. mpv_render_context_update()'s return value will have - * MPV_RENDER_UPDATE_FRAME set, and the user is supposed to call - * mpv_render_context_render(). If there is no next frame, then the - * return value will have is_valid set to 0. - */ - MPV_RENDER_PARAM_NEXT_FRAME_INFO = 11, - /** - * Enable or disable video timing. Valid for mpv_render_context_render(). - * - * Type: int*: 0 for disable, 1 for enable (default) - * - * When video is timed to audio, the player attempts to render video a bit - * ahead, and then do a blocking wait until the target display time is - * reached. This blocks mpv_render_context_render() for up to the amount - * specified with the "video-timing-offset" global option. You can set - * this parameter to 0 to disable this kind of waiting. If you do, it's - * recommended to use the target time value in mpv_render_frame_info to - * wait yourself, or to set the "video-timing-offset" to 0 instead. - * - * Disabling this without doing anything in addition will result in A/V sync - * being slightly off. - */ - MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, - /** - * Use to skip rendering in mpv_render_context_render(). - * - * Type: int*: 0 for rendering (default), 1 for skipping - * - * If this is set, you don't need to pass a target surface to the render - * function (and if you do, it's completely ignored). This can still call - * into the lower level APIs (i.e. if you use OpenGL, the OpenGL context - * must be set). - * - * Be aware that the render API will consider this frame as having been - * rendered. All other normal rules also apply, for example about whether - * you have to call mpv_render_context_report_swap(). It also does timing - * in the same way. - */ - MPV_RENDER_PARAM_SKIP_RENDERING = 13, - /** - * Deprecated. Not supported. Use MPV_RENDER_PARAM_DRM_DISPLAY_V2 instead. - * Type : struct mpv_opengl_drm_params* - */ - MPV_RENDER_PARAM_DRM_DISPLAY = 14, - /** - * DRM draw surface size, contains draw surface dimensions. - * Valid for mpv_render_context_create(). - * Type : struct mpv_opengl_drm_draw_surface_size* - */ - MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE = 15, - /** - * DRM display, contains drm display handles. - * Valid for mpv_render_context_create(). - * Type : struct mpv_opengl_drm_params_v2* - */ - MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];) - * - * The video frame is transformed as with other VOs. Typically, this means - * the video gets scaled and black bars are added if the video size or - * aspect ratio mismatches with the target size. - */ - MPV_RENDER_PARAM_SW_SIZE = 17, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: char* (e.g.: char *f = "rgb0"; param.data = f;) - * - * Valid values are: - * "rgb0", "bgr0", "0bgr", "0rgb" - * 4 bytes per pixel RGB, 1 byte (8 bit) per component, component bytes - * with increasing address from left to right (e.g. "rgb0" has r at - * address 0), the "0" component contains uninitialized garbage (often - * the value 0, but not necessarily; the bad naming is inherited from - * FFmpeg) - * Pixel alignment size: 4 bytes - * "rgb24" - * 3 bytes per pixel RGB. This is strongly discouraged because it is - * very slow. - * Pixel alignment size: 1 bytes - * other - * The API may accept other pixel formats, using mpv internal format - * names, as long as it's internally marked as RGB, has exactly 1 - * plane, and is supported as conversion output. It is not a good idea - * to rely on any of these. Their semantics and handling could change. - */ - MPV_RENDER_PARAM_SW_FORMAT = 18, - /** - * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: size_t* - * - * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the - * target surface. It must be a multiple of the pixel size, and have space - * for the surface width as specified by MPV_RENDER_PARAM_SW_SIZE. - * - * Both stride and pointer value should be a multiple of 64 to facilitate - * fast SIMD operation. Lower alignment might trigger slower code paths, - * and in the worst case, will copy the entire target frame. If mpv is built - * with zimg (and zimg is not disabled), the performance impact might be - * less. - * In either cases, the pointer and stride must be aligned at least to the - * pixel alignment size. Otherwise, crashes and undefined behavior is - * possible on platforms which do not support unaligned accesses (either - * through normal memory access or aligned SIMD memory access instructions). - */ - MPV_RENDER_PARAM_SW_STRIDE = 19, - /* - * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data pointer, - * mandatory. - * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). - * Type: void* - * - * This points to the first pixel at the left/top corner (0, 0). In - * particular, each line y starts at (pointer + stride * y). Upon rendering, - * all data between pointer and (pointer + stride * h) is overwritten. - * Whether the padding between (w, y) and (0, y + 1) is overwritten is left - * unspecified (it should not be, but unfortunately some scaler backends - * will do it anyway). It is assumed that even the padding after the last - * line (starting at bytepos(w, h) until (pointer + stride * h)) is - * writable. - * - * See MPV_RENDER_PARAM_SW_STRIDE for alignment requirements. - */ - MPV_RENDER_PARAM_SW_POINTER = 20, -} mpv_render_param_type; - -/** - * For backwards compatibility with the old naming of - * MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE - */ -#define MPV_RENDER_PARAM_DRM_OSD_SIZE MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE - -/** - * Used to pass arbitrary parameters to some mpv_render_* functions. The - * meaning of the data parameter is determined by the type, and each - * MPV_RENDER_PARAM_* documents what type the value must point to. - * - * Each value documents the required data type as the pointer you cast to - * void* and set on mpv_render_param.data. For example, if MPV_RENDER_PARAM_FOO - * documents the type as Something* , then the code should look like this: - * - * Something foo = {...}; - * mpv_render_param param; - * param.type = MPV_RENDER_PARAM_FOO; - * param.data = & foo; - * - * Normally, the data field points to exactly 1 object. If the type is char*, - * it points to a 0-terminated string. - * - * In all cases (unless documented otherwise) the pointers need to remain - * valid during the call only. Unless otherwise documented, the API functions - * will not write to the params array or any data pointed to it. - * - * As a convention, parameter arrays are always terminated by type==0. There - * is no specific order of the parameters required. The order of the 2 fields in - * this struct is guaranteed (even after ABI changes). - */ -typedef struct mpv_render_param { - enum mpv_render_param_type type; - void *data; -} mpv_render_param; - - -/** - * Predefined values for MPV_RENDER_PARAM_API_TYPE. - */ -// See render_gl.h -#define MPV_RENDER_API_TYPE_OPENGL "opengl" -// See section "Software renderer" -#define MPV_RENDER_API_TYPE_SW "sw" - -/** - * Flags used in mpv_render_frame_info.flags. Each value represents a bit in it. - */ -typedef enum mpv_render_frame_info_flag { - /** - * Set if there is actually a next frame. If unset, there is no next frame - * yet, and other flags and fields that require a frame to be queued will - * be unset. - * - * This is set for _any_ kind of frame, even for redraw requests. - * - * Note that when this is unset, it simply means no new frame was - * decoded/queued yet, not necessarily that the end of the video was - * reached. A new frame can be queued after some time. - * - * If the return value of mpv_render_context_render() had the - * MPV_RENDER_UPDATE_FRAME flag set, this flag will usually be set as well, - * unless the frame is rendered, or discarded by other asynchronous events. - */ - MPV_RENDER_FRAME_INFO_PRESENT = 1 << 0, - /** - * If set, the frame is not an actual new video frame, but a redraw request. - * For example if the video is paused, and an option that affects video - * rendering was changed (or any other reason), an update request can be - * issued and this flag will be set. - * - * Typically, redraw frames will not be subject to video timing. - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_REDRAW = 1 << 1, - /** - * If set, this is supposed to reproduce the previous frame perfectly. This - * is usually used for certain "video-sync" options ("display-..." modes). - * Typically the renderer will blit the video from a FBO. Unset otherwise. - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, - /** - * If set, the player timing code expects that the user thread blocks on - * vsync (by either delaying the render call, or by making a call to - * mpv_render_context_report_swap() at vsync time). - * - * Implies MPV_RENDER_FRAME_INFO_PRESENT. - */ - MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, -} mpv_render_frame_info_flag; - -/** - * Information about the next video frame that will be rendered. Can be - * retrieved with MPV_RENDER_PARAM_NEXT_FRAME_INFO. - */ -typedef struct mpv_render_frame_info { - /** - * A bitset of mpv_render_frame_info_flag values (i.e. multiple flags are - * combined with bitwise or). - */ - uint64_t flags; - /** - * Absolute time at which the frame is supposed to be displayed. This is in - * the same unit and base as the time returned by mpv_get_time_us(). For - * frames that are redrawn, or if vsync locked video timing is used (see - * "video-sync" option), then this can be 0. The "video-timing-offset" - * option determines how much "headroom" the render thread gets (but a high - * enough frame rate can reduce it anyway). mpv_render_context_render() will - * normally block until the time is elapsed, unless you pass it - * MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 0. - */ - int64_t target_time; -} mpv_render_frame_info; - -/** - * Initialize the renderer state. Depending on the backend used, this will - * access the underlying GPU API and initialize its own objects. - * - * You must free the context with mpv_render_context_free(). Not doing so before - * the mpv core is destroyed may result in memory leaks or crashes. - * - * Currently, only at most 1 context can exists per mpv core (it represents the - * main video output). - * - * You should pass the following parameters: - * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API. - * - Backend-specific init parameter, like MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. - * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is - * strongly recommended. - * - If you want to use hwdec, possibly hwdec interop resources. - * - * @param res set to the context (on success) or NULL (on failure). The value - * is never read and always overwritten. - * @param mpv handle used to get the core (the mpv_render_context won't depend - * on this specific handle, only the core referenced by it) - * @param params an array of parameters, terminated by type==0. It's left - * unspecified what happens with unknown parameters. At least - * MPV_RENDER_PARAM_API_TYPE is required, and most backends will - * require another backend-specific parameter. - * @return error code, including but not limited to: - * MPV_ERROR_UNSUPPORTED: the OpenGL version is not supported - * (or required extensions are missing) - * MPV_ERROR_NOT_IMPLEMENTED: an unknown API type was provided, or - * support for the requested API was not - * built in the used libmpv binary. - * MPV_ERROR_INVALID_PARAMETER: at least one of the provided parameters was - * not valid. - */ -MPV_EXPORT int mpv_render_context_create(mpv_render_context **res, mpv_handle *mpv, - mpv_render_param *params); - -/** - * Attempt to change a single parameter. Not all backends and parameter types - * support all kinds of changes. - * - * @param ctx a valid render context - * @param param the parameter type and data that should be set - * @return error code. If a parameter could actually be changed, this returns - * success, otherwise an error code depending on the parameter type - * and situation. - */ -MPV_EXPORT int mpv_render_context_set_parameter(mpv_render_context *ctx, - mpv_render_param param); - -/** - * Retrieve information from the render context. This is NOT a counterpart to - * mpv_render_context_set_parameter(), because you generally can't read - * parameters set with it, and this function is not meant for this purpose. - * Instead, this is for communicating information from the renderer back to the - * user. See mpv_render_param_type; entries which support this function - * explicitly mention it, and for other entries you can assume it will fail. - * - * You pass param with param.type set and param.data pointing to a variable - * of the required data type. The function will then overwrite that variable - * with the returned value (at least on success). - * - * @param ctx a valid render context - * @param param the parameter type and data that should be retrieved - * @return error code. If a parameter could actually be retrieved, this returns - * success, otherwise an error code depending on the parameter type - * and situation. MPV_ERROR_NOT_IMPLEMENTED is used for unknown - * param.type, or if retrieving it is not supported. - */ -MPV_EXPORT int mpv_render_context_get_info(mpv_render_context *ctx, - mpv_render_param param); - -typedef void (*mpv_render_update_fn)(void *cb_ctx); - -/** - * Set the callback that notifies you when a new video frame is available, or - * if the video display configuration somehow changed and requires a redraw. - * Similar to mpv_set_wakeup_callback(), you must not call any mpv API from - * the callback, and all the other listed restrictions apply (such as not - * exiting the callback by throwing exceptions). - * - * This can be called from any thread, except from an update callback. In case - * of the OpenGL backend, no OpenGL state or API is accessed. - * - * Calling this will raise an update callback immediately. - * - * @param callback callback(callback_ctx) is called if the frame should be - * redrawn - * @param callback_ctx opaque argument to the callback - */ -MPV_EXPORT void mpv_render_context_set_update_callback(mpv_render_context *ctx, - mpv_render_update_fn callback, - void *callback_ctx); - -/** - * The API user is supposed to call this when the update callback was invoked - * (like all mpv_render_* functions, this has to happen on the render thread, - * and _not_ from the update callback itself). - * - * This is optional if MPV_RENDER_PARAM_ADVANCED_CONTROL was not set (default). - * Otherwise, it's a hard requirement that this is called after each update - * callback. If multiple update callback happened, and the function could not - * be called sooner, it's OK to call it once after the last callback. - * - * If an update callback happens during or after this function, the function - * must be called again at the soonest possible time. - * - * If MPV_RENDER_PARAM_ADVANCED_CONTROL was set, this will do additional work - * such as allocating textures for the video decoder. - * - * @return a bitset of mpv_render_update_flag values (i.e. multiple flags are - * combined with bitwise or). Typically, this will tell the API user - * what should happen next. E.g. if the MPV_RENDER_UPDATE_FRAME flag is - * set, mpv_render_context_render() should be called. If flags unknown - * to the API user are set, or if the return value is 0, nothing needs - * to be done. - */ -MPV_EXPORT uint64_t mpv_render_context_update(mpv_render_context *ctx); - -/** - * Flags returned by mpv_render_context_update(). Each value represents a bit - * in the function's return value. - */ -typedef enum mpv_render_update_flag { - /** - * A new video frame must be rendered. mpv_render_context_render() must be - * called. - */ - MPV_RENDER_UPDATE_FRAME = 1 << 0, -} mpv_render_context_flag; - -/** - * Render video. - * - * Typically renders the video to a target surface provided via mpv_render_param - * (the details depend on the backend in use). Options like "panscan" are - * applied to determine which part of the video should be visible and how the - * video should be scaled. You can change these options at runtime by using the - * mpv property API. - * - * The renderer will reconfigure itself every time the target surface - * configuration (such as size) is changed. - * - * This function implicitly pulls a video frame from the internal queue and - * renders it. If no new frame is available, the previous frame is redrawn. - * The update callback set with mpv_render_context_set_update_callback() - * notifies you when a new frame was added. The details potentially depend on - * the backends and the provided parameters. - * - * Generally, libmpv will invoke your update callback some time before the video - * frame should be shown, and then lets this function block until the supposed - * display time. This will limit your rendering to video FPS. You can prevent - * this by setting the "video-timing-offset" global option to 0. (This applies - * only to "audio" video sync mode.) - * - * You should pass the following parameters: - * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO. - * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y. - * - * @param ctx a valid render context - * @param params an array of parameters, terminated by type==0. Which parameters - * are required depends on the backend. It's left unspecified what - * happens with unknown parameters. - * @return error code - */ -MPV_EXPORT int mpv_render_context_render(mpv_render_context *ctx, mpv_render_param *params); - -/** - * Tell the renderer that a frame was flipped at the given time. This is - * optional, but can help the player to achieve better timing. - * - * Note that calling this at least once informs libmpv that you will use this - * function. If you use it inconsistently, expect bad video playback. - * - * If this is called while no video is initialized, it is ignored. - * - * @param ctx a valid render context - */ -MPV_EXPORT void mpv_render_context_report_swap(mpv_render_context *ctx); - -/** - * Destroy the mpv renderer state. - * - * If video is still active (e.g. a file playing), video will be disabled - * forcefully. - * - * @param ctx a valid render context. After this function returns, this is not - * a valid pointer anymore. NULL is also allowed and does nothing. - */ -MPV_EXPORT void mpv_render_context_free(mpv_render_context *ctx); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h deleted file mode 100644 index a2c31f0c7..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/render_gl.h +++ /dev/null @@ -1,211 +0,0 @@ -/* Copyright (C) 2018 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_RENDER_GL_H_ -#define MPV_CLIENT_API_RENDER_GL_H_ - -#include "render.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * OpenGL backend - * -------------- - * - * This header contains definitions for using OpenGL with the render.h API. - * - * OpenGL interop - * -------------- - * - * The OpenGL backend has some special rules, because OpenGL itself uses - * implicit per-thread contexts, which causes additional API problems. - * - * This assumes the OpenGL context lives on a certain thread controlled by the - * API user. All mpv_render_* APIs have to be assumed to implicitly use the - * OpenGL context if you pass a mpv_render_context using the OpenGL backend, - * unless specified otherwise. - * - * The OpenGL context is indirectly accessed through the OpenGL function - * pointers returned by the get_proc_address callback in mpv_opengl_init_params. - * Generally, mpv will not load the system OpenGL library when using this API. - * - * OpenGL state - * ------------ - * - * OpenGL has a large amount of implicit state. All the mpv functions mentioned - * above expect that the OpenGL state is reasonably set to OpenGL standard - * defaults. Likewise, mpv will attempt to leave the OpenGL context with - * standard defaults. The following state is excluded from this: - * - * - the glViewport state - * - the glScissor state (but GL_SCISSOR_TEST is in its default value) - * - glBlendFuncSeparate() state (but GL_BLEND is in its default value) - * - glClearColor() state - * - mpv may overwrite the callback set with glDebugMessageCallback() - * - mpv always disables GL_DITHER at init - * - * Messing with the state could be avoided by creating shared OpenGL contexts, - * but this is avoided for the sake of compatibility and interoperability. - * - * On OpenGL 2.1, mpv will strictly call functions like glGenTextures() to - * create OpenGL objects. You will have to do the same. This ensures that - * objects created by mpv and the API users don't clash. Also, legacy state - * must be either in its defaults, or not interfere with core state. - * - * API use - * ------- - * - * The mpv_render_* API is used. That API supports multiple backends, and this - * section documents specifics for the OpenGL backend. - * - * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to - * MPV_RENDER_API_TYPE_OPENGL, and MPV_RENDER_PARAM_OPENGL_INIT_PARAMS provided. - * - * Call mpv_render_context_render() with MPV_RENDER_PARAM_OPENGL_FBO to render - * the video frame to an FBO. - * - * Hardware decoding - * ----------------- - * - * Hardware decoding via this API is fully supported, but requires some - * additional setup. (At least if direct hardware decoding modes are wanted, - * instead of copying back surface data from GPU to CPU RAM.) - * - * There may be certain requirements on the OpenGL implementation: - * - * - Windows: ANGLE is required (although in theory GL/DX interop could be used) - * - Intel/Linux: EGL is required, and also the native display resource needs - * to be provided (e.g. MPV_RENDER_PARAM_X11_DISPLAY for X11 and - * MPV_RENDER_PARAM_WL_DISPLAY for Wayland) - * - nVidia/Linux: Both GLX and EGL should work (GLX is required if vdpau is - * used, e.g. due to old drivers.) - * - OSX: CGL is required (CGLGetCurrentContext() returning non-NULL) - * - iOS: EAGL is required (EAGLContext.currentContext returning non-nil) - * - * Once these things are setup, hardware decoding can be enabled/disabled at - * any time by setting the "hwdec" property. - */ - -/** - * For initializing the mpv OpenGL state via MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. - */ -typedef struct mpv_opengl_init_params { - /** - * This retrieves OpenGL function pointers, and will use them in subsequent - * operation. - * Usually, you can simply call the GL context APIs from this callback (e.g. - * glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always - * return pointers for all standard functions (even if present); in this - * case you have to compensate by looking up these functions yourself when - * libmpv wants to resolve them through this callback. - * libmpv will not normally attempt to resolve GL functions on its own, nor - * does it link to GL libraries directly. - */ - void *(*get_proc_address)(void *ctx, const char *name); - /** - * Value passed as ctx parameter to get_proc_address(). - */ - void *get_proc_address_ctx; -} mpv_opengl_init_params; - -/** - * For MPV_RENDER_PARAM_OPENGL_FBO. - */ -typedef struct mpv_opengl_fbo { - /** - * Framebuffer object name. This must be either a valid FBO generated by - * glGenFramebuffers() that is complete and color-renderable, or 0. If the - * value is 0, this refers to the OpenGL default framebuffer. - */ - int fbo; - /** - * Valid dimensions. This must refer to the size of the framebuffer. This - * must always be set. - */ - int w, h; - /** - * Underlying texture internal format (e.g. GL_RGBA8), or 0 if unknown. If - * this is the default framebuffer, this can be an equivalent. - */ - int internal_format; -} mpv_opengl_fbo; - -/** - * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. - */ -typedef struct mpv_opengl_drm_params { - int fd; - int crtc_id; - int connector_id; - struct _drmModeAtomicReq **atomic_request_ptr; - int render_fd; -} mpv_opengl_drm_params; - -/** - * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. - */ -typedef struct mpv_opengl_drm_draw_surface_size { - /** - * size of the draw plane surface in pixels. - */ - int width, height; -} mpv_opengl_drm_draw_surface_size; - -/** - * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. - */ -typedef struct mpv_opengl_drm_params_v2 { - /** - * DRM fd (int). Set to -1 if invalid. - */ - int fd; - - /** - * Currently used crtc id - */ - int crtc_id; - - /** - * Currently used connector id - */ - int connector_id; - - /** - * Pointer to a drmModeAtomicReq pointer that is being used for the renderloop. - * This pointer should hold a pointer to the atomic request pointer - * The atomic request pointer is usually changed at every renderloop. - */ - struct _drmModeAtomicReq **atomic_request_ptr; - - /** - * DRM render node. Used for VAAPI interop. - * Set to -1 if invalid. - */ - int render_fd; -} mpv_opengl_drm_params_v2; - - -/** - * For backwards compatibility with the old naming of mpv_opengl_drm_draw_surface_size - */ -#define mpv_opengl_drm_osd_size mpv_opengl_drm_draw_surface_size - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h b/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h deleted file mode 100644 index 9d1c2cc8d..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/include/mpv/stream_cb.h +++ /dev/null @@ -1,240 +0,0 @@ -/* Copyright (C) 2017 the mpv developers - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -#ifndef MPV_CLIENT_API_STREAM_CB_H_ -#define MPV_CLIENT_API_STREAM_CB_H_ - -#include "client.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Warning: this API is not stable yet. - * - * Overview - * -------- - * - * This API can be used to make mpv read from a stream with a custom - * implementation. This interface is inspired by funopen on BSD and - * fopencookie on linux. The stream is backed by user-defined callbacks - * which can implement customized open, read, seek, size and close behaviors. - * - * Usage - * ----- - * - * Register your stream callbacks with the mpv_stream_cb_add_ro() function. You - * have to provide a mpv_stream_cb_open_ro_fn callback to it (open_fn argument). - * - * Once registered, you can `loadfile myprotocol://myfile`. Your open_fn will be - * invoked with the URI and you must fill out the provided mpv_stream_cb_info - * struct. This includes your stream callbacks (like read_fn), and an opaque - * cookie, which will be passed as the first argument to all the remaining - * stream callbacks. - * - * Note that your custom callbacks must not invoke libmpv APIs as that would - * cause a deadlock. (Unless you call a different mpv_handle than the one the - * callback was registered for, and the mpv_handles refer to different mpv - * instances.) - * - * Stream lifetime - * --------------- - * - * A stream remains valid until its close callback has been called. It's up to - * libmpv to call the close callback, and the libmpv user cannot close it - * directly with the stream_cb API. - * - * For example, if you consider your custom stream to become suddenly invalid - * (maybe because the underlying stream died), libmpv will continue using your - * stream. All you can do is returning errors from each callback, until libmpv - * gives up and closes it. - * - * Protocol registration and lifetime - * ---------------------------------- - * - * Protocols remain registered until the mpv instance is terminated. This means - * in particular that it can outlive the mpv_handle that was used to register - * it, but once mpv_terminate_destroy() is called, your registered callbacks - * will not be called again. - * - * Protocol unregistration is finished after the mpv core has been destroyed - * (e.g. after mpv_terminate_destroy() has returned). - * - * If you do not call mpv_terminate_destroy() yourself (e.g. plugin-style code), - * you will have to deal with the registration or even streams outliving your - * code. Here are some possible ways to do this: - * - call mpv_terminate_destroy(), which destroys the core, and will make sure - * all streams are closed once this function returns - * - you refcount all resources your stream "cookies" reference, so that it - * doesn't matter if streams live longer than expected - * - create "cancellation" semantics: after your protocol has been unregistered, - * notify all your streams that are still opened, and make them drop all - * referenced resources - then return errors from the stream callbacks as - * long as the stream is still opened - * - */ - -/** - * Read callback used to implement a custom stream. The semantics of the - * callback match read(2) in blocking mode. Short reads are allowed (you can - * return less bytes than requested, and libmpv will retry reading the rest - * with another call). If no data can be immediately read, the callback must - * block until there is new data. A return of 0 will be interpreted as final - * EOF, although libmpv might retry the read, or seek to a different position. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @param buf buffer to read data into - * @param size of the buffer - * @return number of bytes read into the buffer - * @return 0 on EOF - * @return -1 on error - */ -typedef int64_t (*mpv_stream_cb_read_fn)(void *cookie, char *buf, uint64_t nbytes); - -/** - * Seek callback used to implement a custom stream. - * - * Note that mpv will issue a seek to position 0 immediately after opening. This - * is used to test whether the stream is seekable (since seekability might - * depend on the URI contents, not just the protocol). Return - * MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This - * seek also serves to establish the fact that streams start at position 0. - * - * This callback can be NULL, in which it behaves as if always returning - * MPV_ERROR_UNSUPPORTED. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @param offset target absolute stream position - * @return the resulting offset of the stream - * MPV_ERROR_UNSUPPORTED or MPV_ERROR_GENERIC if the seek failed - */ -typedef int64_t (*mpv_stream_cb_seek_fn)(void *cookie, int64_t offset); - -/** - * Size callback used to implement a custom stream. - * - * Return MPV_ERROR_UNSUPPORTED if no size is known. - * - * This callback can be NULL, in which it behaves as if always returning - * MPV_ERROR_UNSUPPORTED. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - * @return the total size in bytes of the stream - */ -typedef int64_t (*mpv_stream_cb_size_fn)(void *cookie); - -/** - * Close callback used to implement a custom stream. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - */ -typedef void (*mpv_stream_cb_close_fn)(void *cookie); - -/** - * Cancel callback used to implement a custom stream. - * - * This callback is used to interrupt any current or future read and seek - * operations. It will be called from a separate thread than the demux - * thread, and should not block. - * - * This callback can be NULL. - * - * Available since API 1.106. - * - * @param cookie opaque cookie identifying the stream, - * returned from mpv_stream_cb_open_fn - */ -typedef void (*mpv_stream_cb_cancel_fn)(void *cookie); - -/** - * See mpv_stream_cb_open_ro_fn callback. - */ -typedef struct mpv_stream_cb_info { - /** - * Opaque user-provided value, which will be passed to the other callbacks. - * The close callback will be called to release the cookie. It is not - * interpreted by mpv. It doesn't even need to be a valid pointer. - * - * The user sets this in the mpv_stream_cb_open_ro_fn callback. - */ - void *cookie; - - /** - * Callbacks set by the user in the mpv_stream_cb_open_ro_fn callback. Some - * of them are optional, and can be left unset. - * - * The following callbacks are mandatory: read_fn, close_fn - */ - mpv_stream_cb_read_fn read_fn; - mpv_stream_cb_seek_fn seek_fn; - mpv_stream_cb_size_fn size_fn; - mpv_stream_cb_close_fn close_fn; - mpv_stream_cb_cancel_fn cancel_fn; /* since API 1.106 */ -} mpv_stream_cb_info; - -/** - * Open callback used to implement a custom read-only (ro) stream. The user - * must set the callback fields in the passed info struct. The cookie field - * also can be set to store state associated to the stream instance. - * - * Note that the info struct is valid only for the duration of this callback. - * You can't change the callbacks or the pointer to the cookie at a later point. - * - * Each stream instance created by the open callback can have different - * callbacks. - * - * The close_fn callback will terminate the stream instance. The pointers to - * your callbacks and cookie will be discarded, and the callbacks will not be - * called again. - * - * @param user_data opaque user data provided via mpv_stream_cb_add() - * @param uri name of the stream to be opened (with protocol prefix) - * @param info fields which the user should fill - * @return 0 on success, MPV_ERROR_LOADING_FAILED if the URI cannot be opened. - */ -typedef int (*mpv_stream_cb_open_ro_fn)(void *user_data, char *uri, - mpv_stream_cb_info *info); - -/** - * Add a custom stream protocol. This will register a protocol handler under - * the given protocol prefix, and invoke the given callbacks if an URI with the - * matching protocol prefix is opened. - * - * The "ro" is for read-only - only read-only streams can be registered with - * this function. - * - * The callback remains registered until the mpv core is registered. - * - * If a custom stream with the same name is already registered, then the - * MPV_ERROR_INVALID_PARAMETER error is returned. - * - * @param protocol protocol prefix, for example "foo" for "foo://" URIs - * @param user_data opaque pointer passed into the mpv_stream_cb_open_fn - * callback. - * @return error code - */ -MPV_EXPORT int mpv_stream_cb_add_ro(mpv_handle *ctx, const char *protocol, void *user_data, - mpv_stream_cb_open_ro_fn open_fn); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c b/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c deleted file mode 100644 index 9b5faec70..000000000 --- a/media_kit_video/macos/media_kit_video/Sources/Mpv/shim.c +++ /dev/null @@ -1 +0,0 @@ -#include "mpv/client.h" diff --git a/tool/update_darwin_libmpv_artifacts.sh b/tool/update_darwin_libmpv_artifacts.sh new file mode 100755 index 000000000..c316c4a04 --- /dev/null +++ b/tool/update_darwin_libmpv_artifacts.sh @@ -0,0 +1,271 @@ +#!/usr/bin/env bash +set -euo pipefail + +REPO="media-kit/libmpv-darwin-build" +DRY_RUN=0 +VERSION="v0.7.0" +VERSION_SET=0 + +usage() { + cat <<'EOF' +Usage: + tool/update_darwin_libmpv_artifacts.sh [version] [--dry-run] [--repo=] + +Example: + tool/update_darwin_libmpv_artifacts.sh + tool/update_darwin_libmpv_artifacts.sh v0.7.0 + +The script reads GitHub release asset digests and updates Darwin libmpv artifact +versions/checksums. Existing CocoaPods Makefiles use .tar.gz assets. Future +SwiftPM Package.swift files, when present, use .zip binaryTarget assets. +EOF +} + +for arg in "$@"; do + case "$arg" in + --dry-run) + DRY_RUN=1 + ;; + --repo=*) + REPO="${arg#--repo=}" + ;; + -h|--help) + usage + exit 0 + ;; + v*) + if [[ "$VERSION_SET" -eq 1 ]]; then + usage + exit 64 + fi + VERSION="$arg" + VERSION_SET=1 + ;; + *) + usage + exit 64 + ;; + esac +done + +RELEASE_JSON="$(mktemp "${TMPDIR:-/tmp}/media-kit-release.XXXXXX.json")" +trap 'rm -f "$RELEASE_JSON"' EXIT + +curl -fsSL \ + -H "Accept: application/vnd.github+json" \ + -H "User-Agent: media-kit-artifact-updater" \ + "https://api.github.com/repos/${REPO}/releases/tags/${VERSION}" \ + -o "$RELEASE_JSON" + +digest_for() { + local asset_name="$1" + + RELEASE_JSON="$RELEASE_JSON" ASSET_NAME="$asset_name" ruby -rjson -e ' + release = JSON.parse(File.read(ENV.fetch("RELEASE_JSON"))) + name = ENV.fetch("ASSET_NAME") + asset = release.fetch("assets").find { |item| item["name"] == name } + + abort("Asset #{name} was not found in the release.") unless asset + + digest = asset["digest"] + unless digest.is_a?(String) && digest.start_with?("sha256:") + abort("Asset #{name} does not have a sha256 digest.") + end + + puts digest.sub(/\Asha256:/, "") + ' +} + +update_makefile() { + local path="$1" + local version="$2" + local checksum="$3" + + if [[ "$DRY_RUN" -eq 1 ]]; then + echo "Would update ${path}" + return + fi + + FILE_PATH="$path" VERSION="$version" CHECKSUM="$checksum" ruby -e ' + path = ENV.fetch("FILE_PATH") + version = ENV.fetch("VERSION") + checksum = ENV.fetch("CHECKSUM") + contents = File.read(path) + + unless contents.sub!(/^MPV_XCFRAMEWORKS_VERSION=.*$/, "MPV_XCFRAMEWORKS_VERSION=#{version}") + abort("MPV_XCFRAMEWORKS_VERSION was not found in #{path}") + end + + unless contents.sub!(/^MPV_XCFRAMEWORKS_SHA256SUM=.*$/, "MPV_XCFRAMEWORKS_SHA256SUM=#{checksum}") + abort("MPV_XCFRAMEWORKS_SHA256SUM was not found in #{path}") + end + + File.write(path, contents) + ' +} + +update_package_swift() { + local path="$1" + local platform="$2" + local variant="$3" + local flavor="$4" + shift 4 + local frameworks=("$@") + local artifact_base="https://github.com/${REPO}/releases/download/${VERSION}/libmpv-xcframeworks_${VERSION}_${platform}-universal-${variant}-${flavor}" + + [[ -f "$path" ]] || return + + if [[ "$DRY_RUN" -eq 1 ]]; then + echo "Would update ${path}" + else + FILE_PATH="$path" ARTIFACT_BASE="$artifact_base" ruby -e ' + path = ENV.fetch("FILE_PATH") + artifact_base = ENV.fetch("ARTIFACT_BASE") + contents = File.read(path) + + unless contents.sub!(/^let libmpvArtifactBase = ".*"$/, "let libmpvArtifactBase = \"#{artifact_base}\"") + abort("libmpvArtifactBase was not found in #{path}") + end + + File.write(path, contents) + ' + fi + + for framework in "${frameworks[@]}"; do + local zip_name="libmpv-xcframeworks_${VERSION}_${platform}-universal-${variant}-${flavor}_${framework}.zip" + local checksum + checksum="$(digest_for "$zip_name")" + + if [[ "$DRY_RUN" -eq 1 ]]; then + echo "Would update ${framework}: ${checksum}" + else + FILE_PATH="$path" FRAMEWORK="$framework" CHECKSUM="$checksum" ruby -e ' + path = ENV.fetch("FILE_PATH") + framework = ENV.fetch("FRAMEWORK") + checksum = ENV.fetch("CHECKSUM") + contents = File.read(path) + pattern = /^(\s*"#{Regexp.escape(framework)}":\s*")[^"]+(".*)$/ + + unless contents.sub!(pattern, "\\1#{checksum}\\2") + abort("Checksum for #{framework} was not found in #{path}") + end + + File.write(path, contents) + ' + fi + done +} + +update_artifact() { + local label="$1" + local platform="$2" + local variant="$3" + local flavor="$4" + local makefile_path="$5" + local package_path="$6" + + local tar_name="libmpv-xcframeworks_${VERSION}_${platform}-universal-${variant}-${flavor}.tar.gz" + local tar_checksum + tar_checksum="$(digest_for "$tar_name")" + + update_makefile "$makefile_path" "$VERSION" "$tar_checksum" + + if [[ -f "$package_path" ]]; then + shift 6 + update_package_swift "$package_path" "$platform" "$variant" "$flavor" "$@" + fi + + echo "${label}: ${tar_checksum}" +} + +update_artifact \ + "iOS audio" \ + "ios" \ + "audio" \ + "default" \ + "libs/ios/media_kit_libs_ios_audio/ios/Makefile" \ + "libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift" \ + "Avcodec" \ + "Avfilter" \ + "Avformat" \ + "Avutil" \ + "Mbedcrypto" \ + "Mbedtls" \ + "Mbedx509" \ + "Mpv" \ + "Swresample" \ + "Swscale" + +update_artifact \ + "iOS video" \ + "ios" \ + "video" \ + "default" \ + "libs/ios/media_kit_libs_ios_video/ios/Makefile" \ + "libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift" \ + "Ass" \ + "Avcodec" \ + "Avfilter" \ + "Avformat" \ + "Avutil" \ + "Dav1d" \ + "Freetype" \ + "Fribidi" \ + "Harfbuzz" \ + "Mbedcrypto" \ + "Mbedtls" \ + "Mbedx509" \ + "Mpv" \ + "Png16" \ + "Swresample" \ + "Swscale" \ + "Uchardet" \ + "Xml2" + +update_artifact \ + "macOS audio" \ + "macos" \ + "audio" \ + "full" \ + "libs/macos/media_kit_libs_macos_audio/macos/Makefile" \ + "libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift" \ + "Avcodec" \ + "Avfilter" \ + "Avformat" \ + "Avutil" \ + "Mbedcrypto" \ + "Mbedtls" \ + "Mbedx509" \ + "Mpv" \ + "Swresample" \ + "Swscale" + +update_artifact \ + "macOS video" \ + "macos" \ + "video" \ + "default" \ + "libs/macos/media_kit_libs_macos_video/macos/Makefile" \ + "libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift" \ + "Ass" \ + "Avcodec" \ + "Avfilter" \ + "Avformat" \ + "Avutil" \ + "Dav1d" \ + "Freetype" \ + "Fribidi" \ + "Harfbuzz" \ + "Mbedcrypto" \ + "Mbedtls" \ + "Mbedx509" \ + "Mpv" \ + "Png16" \ + "Swresample" \ + "Swscale" \ + "Uchardet" \ + "Xml2" + +if [[ "$DRY_RUN" -eq 1 ]]; then + echo "Dry run completed. No files were changed." +fi From 49f8d81da45c3d1e6b21822d99a8e35123a3ec82 Mon Sep 17 00:00:00 2001 From: Roman Laptev Date: Fri, 8 May 2026 20:44:36 +0300 Subject: [PATCH 3/7] Update package.swift and checksums --- .../ios/media_kit_libs_ios_audio/ios/Makefile | 2 +- .../media_kit_libs_ios_audio/Package.swift | 22 +++++----- .../ios/media_kit_libs_ios_audio/pubspec.yaml | 4 +- .../media_kit_libs_ios_video/Package.swift | 40 ++++++++++--------- .../ios/media_kit_libs_ios_video/pubspec.yaml | 4 +- .../media_kit_libs_macos_audio/Package.swift | 22 +++++----- .../media_kit_libs_macos_audio/pubspec.yaml | 4 +- .../media_kit_libs_macos_video/Package.swift | 40 ++++++++++--------- .../media_kit_libs_macos_video/pubspec.yaml | 4 +- .../ios/media_kit_video/Package.swift | 8 +++- .../macos/media_kit_video/Package.swift | 8 +++- media_kit_video/pubspec.yaml | 4 +- pubspec.yaml | 2 +- 13 files changed, 88 insertions(+), 76 deletions(-) diff --git a/libs/ios/media_kit_libs_ios_audio/ios/Makefile b/libs/ios/media_kit_libs_ios_audio/ios/Makefile index 3b999d852..e233bf86c 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/Makefile +++ b/libs/ios/media_kit_libs_ios_audio/ios/Makefile @@ -1,7 +1,7 @@ all: Frameworks/*.xcframework Frameworks/.symlinks MPV_XCFRAMEWORKS_VERSION=v0.7.0 -MPV_XCFRAMEWORKS_SHA256SUM=b84ef31ce2431e6a5beb2808d458f8bf5d266bba5bcfc26498b87800986b22a3 +MPV_XCFRAMEWORKS_SHA256SUM=c324bb131d8a375b33531defb580b24c01e57b612deaf0096662891955545807 TAR=tar TAR_WILDCARDS_FLAG := $(shell ${TAR} --version 2>&1 | grep -q 'GNU' && echo "--wildcards" || echo "") diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift index dfe77bf82..808ed3a3a 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift @@ -18,16 +18,16 @@ let libmpvTargets = [ let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_ios-universal-audio-default" let libmpvChecksums = [ - "Avcodec": "fc72195ca32ed023a6230e4e558323fdb14d8e779b7c68cf97ed56ac6d00aebb", - "Avfilter": "e4d71789a98a9f0d60d83de15b7facf6bcf5914f25a6614e8b956296899a99d7", - "Avformat": "4abb7dd215203a22caaabb215b0b2f5e10fd1fe0c8a1ae874908eeea8859eb1e", - "Avutil": "63573305de494575ca29b4bfe328997c0e844132d9e4b6bf8c22ffd4f3cf6273", - "Mbedcrypto": "b016619250601bac48c1b628f958d352d58716bf74fcb6168d7c0ef7b1a78e4d", - "Mbedtls": "457264fdcdaea78ff643c5d3fa184876f955fe202471b7f2b856fb698794269e", - "Mbedx509": "1cde5fa0f6d5308d3a012ce4925551aaad0449e63af82de2ee509970645e96e6", - "Mpv": "0c052ddcb71ab19bd1ae2bbc74514bbfad2ef71eb7b41468c7e71ee9cf7dd2dd", - "Swresample": "5ddbeb5a57a59e87d3b62f33d6340fbcdc35a3dc972064d53c87b9cabf97b4fc", - "Swscale": "302507bbd858e5fc84a88a441ae4b14d577a5a6bd8119ed2e2367468fc9a9dbb" + "Avcodec": "0603092e376ff396bcfb5e93e6af61b047b0f9b50efcf8d53f93f2b347c1d537", + "Avfilter": "9f78b4b9ae03784183b4aeb2c916af7609d3969b0e6845a6a4a0e571982f78d3", + "Avformat": "b2485d949649574c7b98a9fba32e51c26b6aaff3a9cae21c7c30a5e5cd3c4379", + "Avutil": "0c29965740fa1a110a47a8839492de93e305bbba0ccb6602be61f9b396b60d02", + "Mbedcrypto": "ae80a9915a93589aaab373be7428e92e577749a724bff7054550449f3aee7083", + "Mbedtls": "60a7135f9c93d90aa56232255a997e6f699d7d7df9ddab32e97470700216241b", + "Mbedx509": "3eb4221a54c2652b85351a61b6b7f6f5a613dac743120655174c21892faa8eae", + "Mpv": "2d683792d1461307c7a79e57df987dae5d640310f788de595ce3e16f5181a0ad", + "Swresample": "d63bc716105d409b61fd671fb824a1cf8bc3f927d699d75a90e5571af1349f3e", + "Swscale": "368135287a59ae417b9ab1607b046ba3e740bdb4b814fe328e83b6d0fee356eb" ] let package = Package( @@ -36,7 +36,7 @@ let package = Package( .iOS("13.0") ], products: [ - .library(name: "media_kit_libs_ios_audio", targets: ["media_kit_libs_ios_audio"] + libmpvTargets) + .library(name: "media-kit-libs-ios-audio", targets: ["media_kit_libs_ios_audio"] + libmpvTargets) ], dependencies: [], targets: libmpvTargets.map { framework in diff --git a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml index c5dcb6a00..64498d4d7 100644 --- a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.5.0 - flutter: ">=3.24.0" + sdk: ^3.6.0 + flutter: ">=3.27.4" dependencies: flutter: diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift index 9e6bd27a8..1a8a49cb8 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift @@ -26,25 +26,26 @@ let libmpvTargets = [ let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_ios-universal-video-default" let libmpvChecksums = [ - "Ass": "152cebec157ab9a8c0ea7c69709586455174654bb992b6e6a6603bbe3d315b2b", - "Avcodec": "a6baa1a31800d2b589613d767a0725fe1c76b3e9b4530403e26f2aa80ab99af7", - "Avfilter": "93724550b2613d656a9f26be5dcacf5bcead491cf41f1b1da368fa938053c1f2", - "Avformat": "d7ebc5cf298f3a680253a4370259b0b04056197f216aa2f499f764871482e192", - "Avutil": "eb6854669f86977eca3aee104372188a48ef4ca7a1628e1d5843108b97b0fcf9", - "Dav1d": "e3af3deac054737be3adc5505ce73b81d9a865f5d7c3521ef947158af2307246", - "Freetype": "64299703e582c1a7b0954ee513a0a53edaea0807e6afb0b73d71f9441017c156", - "Fribidi": "67532b36791dbb227ba6f526ea96a62c19cf32da1c1661e17c3055e087c705d2", - "Harfbuzz": "8d585274490514ba3832935db718a49e1f3dc7d03470f9a3a8880c1b4f30678e", - "Mbedcrypto": "b016619250601bac48c1b628f958d352d58716bf74fcb6168d7c0ef7b1a78e4d", - "Mbedtls": "457264fdcdaea78ff643c5d3fa184876f955fe202471b7f2b856fb698794269e", - "Mbedx509": "1cde5fa0f6d5308d3a012ce4925551aaad0449e63af82de2ee509970645e96e6", - "Mpv": "9956f3360a16f4284b8d2aaecf7169c46fb5f427fd0e144dc4a959bac16b8f10", - "Png16": "07a73635dac96817136d595c09fe9854590cd0436c24093f60ee50c75705cb43", - "Swresample": "8361e29e94e8ab82b7a7763a51db9c65dcbb23e06fdb2c79f8874bde6a13ff23", - "Swscale": "2eaf89744d0b08e948b5637e643e12f87f6f67bea8eb06db01c012206ba2ba08", - "Uchardet": "82f0117f1dd69cb2b57aaaf3d561a15af21584d9f4b6dc5b821e06468dec09fe", - "Xml2": "370b24ec59970288f81281a6ace234632630b357963b18e9891eb98bca5cc164" + "Ass": "0272e89d672183be70bf5fc2bebf1e89611589aea66a2487d45c0a4116db9d09", + "Avcodec": "12ecfed8835d105b1a797a2fcd064338d16524ec1400cd85dd433dedbe92a43d", + "Avfilter": "b9713a047521a23e0410ed535b4fe3229ba66c43a9a40a106dfc5d7c690bde62", + "Avformat": "6df0fa376a35986edd638555f7783e60db6d72100adc96c33308f2a4d244c044", + "Avutil": "937663c27c24b6f94508e55220220b5f3ae2d8768289ca4b817075f18942ba5e", + "Dav1d": "8d43adc45b4951d0ba09fea1b9c4647b6e6fba738f1aa7be5cc05ab768993d2d", + "Freetype": "3f993ee4fee11cdb5b3b272e4d40765ba772b06cbf7bbdb9ee7132f0555f9799", + "Fribidi": "0902e6067d4b773bb91b6ed1aa4be48d55c21aa3df2b9c81e9070d5d9ccd2243", + "Harfbuzz": "e7d369bf8aff9f41483cca32e441e56411feef8bec6c3fa2292f61fa79df060d", + "Mbedcrypto": "bcedc3439dcbd87de9e2003c0988c4f45c66641d12062ba786f080469ead3400", + "Mbedtls": "85e092445e32a64f31dab3d379a7d8a8d4cd798400dfb24ebbae5e4b2bd49711", + "Mbedx509": "28175d5d55da490ceeabf513e90781bc1aedaf76f7085d1c58baa7a9be322225", + "Mpv": "a180f30b1a3b201734d616c96463fbda21317a772633b5959cf255524996907c", + "Png16": "97ea1d5c2b9d41c0e2bcb084b4e31456fe28d383b2cf89ad1df0d2c9d5717437", + "Swresample": "89ebab241a9a1f908e60868ff597ae06971d7e1b26f3af25cb26e5c1840b97c6", + "Swscale": "dc252e5acd7cd71eebdfe8e007ddf996d68d6bf02b69f9cfef963cab8b88e69d", + "Uchardet": "1e9481c8a3b0546b753aab1348fbf1f80a746ef7cc3a47a90a7c7480dad95edf", + "Xml2": "ccb8bd20971aa54faaa98e77faacb0e24c39cd2fb471edf7236a5d2a41d8287f" ] +let libmpvProductTargets: [String] = ["media_kit_libs_ios_video"] + libmpvTargets let package = Package( name: "media_kit_libs_ios_video", @@ -52,7 +53,8 @@ let package = Package( .iOS("13.0") ], products: [ - .library(name: "media_kit_libs_ios_video", targets: ["media_kit_libs_ios_video"] + libmpvTargets) + .library(name: "media-kit-libs-ios-video", targets: libmpvProductTargets), + .library(name: "Mpv", targets: ["Mpv"]) ], dependencies: [], targets: libmpvTargets.map { framework in diff --git a/libs/ios/media_kit_libs_ios_video/pubspec.yaml b/libs/ios/media_kit_libs_ios_video/pubspec.yaml index 45fcdb510..4de897ea2 100644 --- a/libs/ios/media_kit_libs_ios_video/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.5.0 - flutter: ">=3.24.0" + sdk: ^3.6.0 + flutter: ">=3.27.4" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift index 4d7071869..66c69b242 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift @@ -18,16 +18,16 @@ let libmpvTargets = [ let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_macos-universal-audio-full" let libmpvChecksums = [ - "Avcodec": "1372bdc0fa7f4ded6b565d29023aba08dd0ed9d6b1916bd2f03409c6370f4e1d", - "Avfilter": "8c471be58b680ae3ac60ffef3ea166447adcd40f660b051a6e4f59aecdd45893", - "Avformat": "3bb73535b43a1cc992777c3b017eb5a84bf4d0ae437c9250ff8511a161617a46", - "Avutil": "3d65e0b2bd65cad4c8a639194398753329dc657c2f418a9c7c662ec8947d76d4", - "Mbedcrypto": "1107eef2c02409840b5f51f9333e527e027aef26f2246af5831f489d50eb6ba0", - "Mbedtls": "f9e8b88cf029b1d8c3093fb3c3150ebc8815f05b7ca259950a1c05e31c7ac532", - "Mbedx509": "8697ad3585f41fb8b8806efaabdd6ff1fa617c7b5a05c13aa86152902ae12917", - "Mpv": "6f5d7fe8b31235d28d8a5fb97b801f0cfc3f19ccad7ac2cb9100f699aafb95e3", - "Swresample": "87c53bd728d0406624c782497a0ef971d28226a84f67997c1891db8bc6c2cc12", - "Swscale": "ea7786b057662edc505696bd9dbbb8bc48feadd869eee1d8eaeab8b2da15d9ed" + "Avcodec": "f6e069c6f5cafec22ef627581a060d1023ccf271d8c7b68f06bb0d88c950c004", + "Avfilter": "ff96f16434b31a86abaf449899a00af513c250a5df1a10ca0a54edf44b56813e", + "Avformat": "280f460238ba21a14499a597c0acf3136d91ef76695fbb92baa43cfae77e28a2", + "Avutil": "e1f12d87fdb75cf171ee194732a982a28dd35629ffda19918df7f64a32a8ef33", + "Mbedcrypto": "4d1c8cac9a138f87a027d3693a4e79cefbe93e3a437fc120b12b3ccee7561a1f", + "Mbedtls": "35487e0a17f77aeb90fbe0bda8287a6199e5785329a44236dd07146fcf8241f6", + "Mbedx509": "6fbaf1af7ea11d261565b293fe622d746d3be415e56d8b3b73de40840ec1c501", + "Mpv": "38ba4f85bc035099497ebc95a068f20cd462162dae5b431f7fe64004041474c6", + "Swresample": "86d9f31bc2ca354e45fcfdaf1b8fdd388b3d47d867d6789c688f2f61fd9552eb", + "Swscale": "c0ef85b08ead86e0f968cfbd77b1d6914dc341ecd1e3374870411be6ebbd16f0" ] let package = Package( @@ -36,7 +36,7 @@ let package = Package( .macOS("10.15") ], products: [ - .library(name: "media_kit_libs_macos_audio", targets: ["media_kit_libs_macos_audio"] + libmpvTargets) + .library(name: "media-kit-libs-macos-audio", targets: ["media_kit_libs_macos_audio"] + libmpvTargets) ], dependencies: [], targets: libmpvTargets.map { framework in diff --git a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml index aa642e250..68064db10 100644 --- a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.5.0 - flutter: ">=3.24.0" + sdk: ^3.6.0 + flutter: ">=3.27.4" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift index 487cd60b4..c3150198d 100644 --- a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift @@ -26,25 +26,26 @@ let libmpvTargets = [ let libmpvArtifactBase = "https://github.com/media-kit/libmpv-darwin-build/releases/download/v0.7.0/libmpv-xcframeworks_v0.7.0_macos-universal-video-default" let libmpvChecksums = [ - "Ass": "fd5e0767d9c5646e4be90555f716baf129f4572d5ca63cd7e7402629a5dfd4df", - "Avcodec": "5c7556bcae6c6236e8b2ce13b5cea57efe82117b5254d5d718b6e2e1215ebfce", - "Avfilter": "1a601279068c88268d6402cc1438cc77db96015fe4580550a495303dd523dde5", - "Avformat": "ebcf285d7a991c20bdb79f74e99ab8a43177387c1a408b063b1e34f706586f7d", - "Avutil": "ca43c5ef524c62fec0dba34326b4c4e41f6ecd6dd0a4560ace34e5f05840f3aa", - "Dav1d": "7a7d9d8683f54ac0a60d58cfa6a8e3d8111892ae76e2837c5f1a86327688e09e", - "Freetype": "babdeee15b17fd79ecd11686421a8c7307e6bf54ede4c0780523449c74c9a514", - "Fribidi": "1c71675f70baa0e55e63736b9ba3bc1de26fbe206f6a07dd1ed4ac87d2379225", - "Harfbuzz": "e1676afce4985bda71d79991c4ac422faacf601274e1a2d569bb323bd7eeb419", - "Mbedcrypto": "1107eef2c02409840b5f51f9333e527e027aef26f2246af5831f489d50eb6ba0", - "Mbedtls": "f9e8b88cf029b1d8c3093fb3c3150ebc8815f05b7ca259950a1c05e31c7ac532", - "Mbedx509": "8697ad3585f41fb8b8806efaabdd6ff1fa617c7b5a05c13aa86152902ae12917", - "Mpv": "e127db446f863d18f188736baafce9f12511696c7b2bbaf4ddf3a50b502a03b1", - "Png16": "7d7298dd45acafdbbbfbef062a70c9f39209fb612bf5c3997f5542d97adee62e", - "Swresample": "99023ac41623fba61f9145ddf74bb6660fae974740e28012367e4335643b4cb8", - "Swscale": "587da3b1fdf67b55de3993ccd648d5e61f19fdd567a8772e740483867c4f5f09", - "Uchardet": "312a6958e337571af3002c5eb8a2f856321f6625ddcb3a966d54984cff14e350", - "Xml2": "ed2c252c95e5f0ab2fd74c8d769c614f3b6d93821f349c481fff05047b864ab8" + "Ass": "5766993f7b6626a1943a4572345091b8ead509889fa656b2b9ca1a4ee50036b8", + "Avcodec": "f642641b41bb3227f299b929ebbd253c834495f8aad6672d42161b7f3f1eea9d", + "Avfilter": "151a6c1edf46cb10a7a4ed0912eabb00309f95bd0e142a867a2e742a423d2e8c", + "Avformat": "98982b284b770c55976a95a2ce5e3c0d3b4db384b698977dcd3fb432544f49d4", + "Avutil": "404f58a9ccefa2505ffdc7125839088dabf05dfad59982c44ef260f7cfbfd752", + "Dav1d": "c8ce0efc7fa01ac79f3932e74cb258a51b59d1fd42e8cca4100b42b5c5816ff0", + "Freetype": "71c6290bcb6f2f5e58f0a7fb88d75e5df666c0c35f95a261e8886016bb828ad3", + "Fribidi": "526476cd44edadeacf4995557a4fada4770e0cff596ba7f13878ccf61244faa7", + "Harfbuzz": "09411c1cc7f8f954aeb4467c79d70b9a28a66189c717966835b5ea8b8cb1c24b", + "Mbedcrypto": "4d1c8cac9a138f87a027d3693a4e79cefbe93e3a437fc120b12b3ccee7561a1f", + "Mbedtls": "35487e0a17f77aeb90fbe0bda8287a6199e5785329a44236dd07146fcf8241f6", + "Mbedx509": "6fbaf1af7ea11d261565b293fe622d746d3be415e56d8b3b73de40840ec1c501", + "Mpv": "02b4eb1d5d43f458b626f1a4480a31130d7d8226df898079e02bd9828693296b", + "Png16": "54cc05350a439a72f0b9d2515d832366a542cccf234c0def201c5b83b6a665e6", + "Swresample": "227e182659babff202f41123b27c120efd9903bb32f8982bedb4e5b097b06397", + "Swscale": "3dd30c36e5e9cd0386ea9e78629b2e0d0a43134e7104a11673e2d5ca2f18db67", + "Uchardet": "3731cd02e84a4a5f8424ee10cde7dc3ce13ed2a12b9acc98b3ebf9b59ce37482", + "Xml2": "641e2548c57ef035aab2fd04a8c9ee4f54664ed5a912b3002961d1d4422acfee" ] +let libmpvProductTargets: [String] = ["media_kit_libs_macos_video"] + libmpvTargets let package = Package( name: "media_kit_libs_macos_video", @@ -52,7 +53,8 @@ let package = Package( .macOS("10.15") ], products: [ - .library(name: "media_kit_libs_macos_video", targets: ["media_kit_libs_macos_video"] + libmpvTargets) + .library(name: "media-kit-libs-macos-video", targets: libmpvProductTargets), + .library(name: "Mpv", targets: ["Mpv"]) ], dependencies: [], targets: libmpvTargets.map { framework in diff --git a/libs/macos/media_kit_libs_macos_video/pubspec.yaml b/libs/macos/media_kit_libs_macos_video/pubspec.yaml index fd3a52337..c992cbf69 100644 --- a/libs/macos/media_kit_libs_macos_video/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.5.0 - flutter: ">=3.24.0" + sdk: ^3.6.0 + flutter: ">=3.27.4" dependencies: flutter: diff --git a/media_kit_video/ios/media_kit_video/Package.swift b/media_kit_video/ios/media_kit_video/Package.swift index d8bfcce64..2b3b0a0ad 100644 --- a/media_kit_video/ios/media_kit_video/Package.swift +++ b/media_kit_video/ios/media_kit_video/Package.swift @@ -11,11 +11,15 @@ let package = Package( products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) ], - dependencies: [], + dependencies: [ + .package(name: "media_kit_libs_ios_video", path: "../media_kit_libs_ios_video") + ], targets: [ .target( name: "media_kit_video", - dependencies: [], + dependencies: [ + .product(name: "Mpv", package: "media_kit_libs_ios_video") + ], sources: ["plugin"], resources: [ .process("PrivacyInfo.xcprivacy") diff --git a/media_kit_video/macos/media_kit_video/Package.swift b/media_kit_video/macos/media_kit_video/Package.swift index 6e7e89ab0..1a025d262 100644 --- a/media_kit_video/macos/media_kit_video/Package.swift +++ b/media_kit_video/macos/media_kit_video/Package.swift @@ -11,11 +11,15 @@ let package = Package( products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) ], - dependencies: [], + dependencies: [ + .package(name: "media_kit_libs_macos_video", path: "../media_kit_libs_macos_video") + ], targets: [ .target( name: "media_kit_video", - dependencies: [], + dependencies: [ + .product(name: "Mpv", package: "media_kit_libs_macos_video") + ], sources: ["plugin"], resources: [ .process("PrivacyInfo.xcprivacy") diff --git a/media_kit_video/pubspec.yaml b/media_kit_video/pubspec.yaml index 058e55ff3..3d1b734ed 100644 --- a/media_kit_video/pubspec.yaml +++ b/media_kit_video/pubspec.yaml @@ -12,8 +12,8 @@ topics: - cross-platform environment: - sdk: ^3.5.0 - flutter: ">=3.24.0" + sdk: ^3.6.0 + flutter: ">=3.27.4" dependencies: flutter: diff --git a/pubspec.yaml b/pubspec.yaml index 0a6feac48..291f4122d 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: media_kit_workspace environment: - sdk: '>=3.0.0 <4.0.0' + sdk: ^3.6.0 dev_dependencies: melos: ^6.1.0 From c49077d9ac6f7d132a331c59eb04269ccd60e30e Mon Sep 17 00:00:00 2001 From: birros Date: Fri, 8 May 2026 21:29:16 +0200 Subject: [PATCH 4/7] feat: add Mpv library product to iOS and macOS audio SPM packages --- .../ios/media_kit_libs_ios_audio/Package.swift | 1 + .../macos/media_kit_libs_macos_audio/Package.swift | 1 + 2 files changed, 2 insertions(+) diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift index 808ed3a3a..66da83c1c 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift @@ -37,6 +37,7 @@ let package = Package( ], products: [ .library(name: "media-kit-libs-ios-audio", targets: ["media_kit_libs_ios_audio"] + libmpvTargets) + .library(name: "Mpv", targets: ["Mpv"]) ], dependencies: [], targets: libmpvTargets.map { framework in diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift index 66c69b242..40dcafcc5 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift @@ -37,6 +37,7 @@ let package = Package( ], products: [ .library(name: "media-kit-libs-macos-audio", targets: ["media_kit_libs_macos_audio"] + libmpvTargets) + .library(name: "Mpv", targets: ["Mpv"]) ], dependencies: [], targets: libmpvTargets.map { framework in From 753427344e287e6ed40c5cc8ee8b4442af0f3d28 Mon Sep 17 00:00:00 2001 From: birros Date: Fri, 8 May 2026 22:04:21 +0200 Subject: [PATCH 5/7] chore: restore original minimum OS deployment targets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Revert the deployment target bumps (macOS 10.15→10.9, iOS 13.0→9.0). The lower values match the actual targets encoded in the xcframework binaries from media-kit/libmpv-darwin-build and should be preferred. --- .../ios/media_kit_libs_ios_audio.podspec | 2 +- .../ios/media_kit_libs_ios_audio/Package.swift | 2 +- .../ios/media_kit_libs_ios_video.podspec | 2 +- .../ios/media_kit_libs_ios_video/Package.swift | 2 +- .../macos/media_kit_libs_macos_audio.podspec | 2 +- .../macos/media_kit_libs_macos_audio/Package.swift | 2 +- .../macos/media_kit_libs_macos_video.podspec | 2 +- .../macos/media_kit_libs_macos_video/Package.swift | 2 +- media_kit_video/ios/media_kit_video.podspec | 2 +- media_kit_video/ios/media_kit_video/Package.swift | 2 +- media_kit_video/macos/media_kit_video.podspec | 2 +- media_kit_video/macos/media_kit_video/Package.swift | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec index 456ac8342..79ddd868b 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :ios, '13.0' + s.platform = :ios, '9.0' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', # Flutter.framework does not contain a i386 slice. diff --git a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift index 66da83c1c..c29c568ad 100644 --- a/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift +++ b/libs/ios/media_kit_libs_ios_audio/ios/media_kit_libs_ios_audio/Package.swift @@ -33,7 +33,7 @@ let libmpvChecksums = [ let package = Package( name: "media_kit_libs_ios_audio", platforms: [ - .iOS("13.0") + .iOS("9.0") ], products: [ .library(name: "media-kit-libs-ios-audio", targets: ["media_kit_libs_ios_audio"] + libmpvTargets) diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec index 20c13fa77..74a1dfd25 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :ios, '13.0' + s.platform = :ios, '9.0' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', # Flutter.framework does not contain a i386 slice. diff --git a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift index 1a8a49cb8..95c17e000 100644 --- a/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift +++ b/libs/ios/media_kit_libs_ios_video/ios/media_kit_libs_ios_video/Package.swift @@ -50,7 +50,7 @@ let libmpvProductTargets: [String] = ["media_kit_libs_ios_video"] + libmpvTarget let package = Package( name: "media_kit_libs_ios_video", platforms: [ - .iOS("13.0") + .iOS("9.0") ], products: [ .library(name: "media-kit-libs-ios-video", targets: libmpvProductTargets), diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec index 0a8cc00d4..6cec56461 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :osx, '10.15' + s.platform = :osx, '10.9' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } s.swift_version = '5.0' end diff --git a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift index 40dcafcc5..77ab1907c 100644 --- a/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift +++ b/libs/macos/media_kit_libs_macos_audio/macos/media_kit_libs_macos_audio/Package.swift @@ -33,7 +33,7 @@ let libmpvChecksums = [ let package = Package( name: "media_kit_libs_macos_audio", platforms: [ - .macOS("10.15") + .macOS("10.9") ], products: [ .library(name: "media-kit-libs-macos-audio", targets: ["media_kit_libs_macos_audio"] + libmpvTargets) diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec index 88e264dbc..1673be98b 100644 --- a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video.podspec @@ -24,7 +24,7 @@ Pod::Spec.new do |s| s.vendored_frameworks = 'Frameworks/*.xcframework' - s.platform = :osx, '10.15' + s.platform = :osx, '10.9' s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } s.swift_version = '5.0' end diff --git a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift index c3150198d..79b11338d 100644 --- a/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift +++ b/libs/macos/media_kit_libs_macos_video/macos/media_kit_libs_macos_video/Package.swift @@ -50,7 +50,7 @@ let libmpvProductTargets: [String] = ["media_kit_libs_macos_video"] + libmpvTarg let package = Package( name: "media_kit_libs_macos_video", platforms: [ - .macOS("10.15") + .macOS("10.9") ], products: [ .library(name: "media-kit-libs-macos-video", targets: libmpvProductTargets), diff --git a/media_kit_video/ios/media_kit_video.podspec b/media_kit_video/ios/media_kit_video.podspec index 2a7e653d3..1679528a6 100644 --- a/media_kit_video/ios/media_kit_video.podspec +++ b/media_kit_video/ios/media_kit_video.podspec @@ -23,7 +23,7 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.platform = :ios, '13.0' + s.platform = :ios, '9.0' s.swift_version = '5.0' s.dependency 'Flutter' s.resource_bundles = { diff --git a/media_kit_video/ios/media_kit_video/Package.swift b/media_kit_video/ios/media_kit_video/Package.swift index 2b3b0a0ad..d59b11408 100644 --- a/media_kit_video/ios/media_kit_video/Package.swift +++ b/media_kit_video/ios/media_kit_video/Package.swift @@ -6,7 +6,7 @@ import PackageDescription let package = Package( name: "media_kit_video", platforms: [ - .iOS("13.0") + .iOS("9.0") ], products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) diff --git a/media_kit_video/macos/media_kit_video.podspec b/media_kit_video/macos/media_kit_video.podspec index 1226d1179..9c00f7800 100644 --- a/media_kit_video/macos/media_kit_video.podspec +++ b/media_kit_video/macos/media_kit_video.podspec @@ -23,7 +23,7 @@ Pod::Spec.new do |s| s.author = { 'Hitesh Kumar Saini' => 'saini123hitesh@gmail.com' } s.source = { :path => '.' } - s.platform = :osx, '10.15' + s.platform = :osx, '10.9' s.swift_version = '5.0' s.dependency 'FlutterMacOS' s.resource_bundles = { diff --git a/media_kit_video/macos/media_kit_video/Package.swift b/media_kit_video/macos/media_kit_video/Package.swift index 1a025d262..3775b8e4b 100644 --- a/media_kit_video/macos/media_kit_video/Package.swift +++ b/media_kit_video/macos/media_kit_video/Package.swift @@ -6,7 +6,7 @@ import PackageDescription let package = Package( name: "media_kit_video", platforms: [ - .macOS("10.15") + .macOS("10.9") ], products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) From efedbb677dd323ffbe2e81931021a2ae0b9dfa70 Mon Sep 17 00:00:00 2001 From: birros Date: Fri, 8 May 2026 22:10:09 +0200 Subject: [PATCH 6/7] chore: restore original Flutter/Dart SDK constraints The minimum Flutter version was bumped to 3.27.4 to support Swift Package Manager, but CocoaPods is still supported. There is no reason to force developers onto a recent Flutter version until SPM becomes the only supported option. --- libs/ios/media_kit_libs_ios_audio/pubspec.yaml | 4 ++-- libs/ios/media_kit_libs_ios_video/pubspec.yaml | 4 ++-- libs/macos/media_kit_libs_macos_audio/pubspec.yaml | 4 ++-- libs/macos/media_kit_libs_macos_video/pubspec.yaml | 4 ++-- media_kit_video/pubspec.yaml | 4 ++-- pubspec.yaml | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml index 64498d4d7..a23fda9ee 100644 --- a/libs/ios/media_kit_libs_ios_audio/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.6.0 - flutter: ">=3.27.4" + sdk: ">=2.17.0 <4.0.0" + flutter: ">=3.0.0" dependencies: flutter: diff --git a/libs/ios/media_kit_libs_ios_video/pubspec.yaml b/libs/ios/media_kit_libs_ios_video/pubspec.yaml index 4de897ea2..905f8f95f 100644 --- a/libs/ios/media_kit_libs_ios_video/pubspec.yaml +++ b/libs/ios/media_kit_libs_ios_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.6.0 - flutter: ">=3.27.4" + sdk: ">=2.17.0 <4.0.0" + flutter: ">=3.0.0" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml index 68064db10..93972d8db 100644 --- a/libs/macos/media_kit_libs_macos_audio/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_audio/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.6.0 - flutter: ">=3.27.4" + sdk: ">=2.17.0 <4.0.0" + flutter: ">=3.0.0" dependencies: flutter: diff --git a/libs/macos/media_kit_libs_macos_video/pubspec.yaml b/libs/macos/media_kit_libs_macos_video/pubspec.yaml index c992cbf69..93598472a 100644 --- a/libs/macos/media_kit_libs_macos_video/pubspec.yaml +++ b/libs/macos/media_kit_libs_macos_video/pubspec.yaml @@ -5,8 +5,8 @@ homepage: https://github.com/media-kit/media-kit.git repository: https://github.com/media-kit/media-kit.git environment: - sdk: ^3.6.0 - flutter: ">=3.27.4" + sdk: ">=2.17.0 <4.0.0" + flutter: ">=3.0.0" dependencies: flutter: diff --git a/media_kit_video/pubspec.yaml b/media_kit_video/pubspec.yaml index 3d1b734ed..75c3b13cc 100644 --- a/media_kit_video/pubspec.yaml +++ b/media_kit_video/pubspec.yaml @@ -12,8 +12,8 @@ topics: - cross-platform environment: - sdk: ^3.6.0 - flutter: ">=3.27.4" + sdk: ">=2.17.0 <4.0.0" + flutter: ">=3.7.0" dependencies: flutter: diff --git a/pubspec.yaml b/pubspec.yaml index 291f4122d..0a6feac48 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: media_kit_workspace environment: - sdk: ^3.6.0 + sdk: '>=3.0.0 <4.0.0' dev_dependencies: melos: ^6.1.0 From 7aad695e8afe640edd3cb18f7221e6408be32936 Mon Sep 17 00:00:00 2001 From: birros Date: Sat, 9 May 2026 02:15:54 +0200 Subject: [PATCH 7/7] feat: make native libs dependency optional in SPM manifests Previously, the SPM manifests for iOS and macOS unconditionally declared `media_kit_libs_{ios,macos}_video` as a required dependency, causing the build to fail if the package was not included in the developer's `pubspec.yaml`. The dependency is now resolved dynamically at manifest evaluation time by checking whether the sibling package directory exists in the SPM ephemeral packages directory. If found, `media_kit_video` is linked against it as before; otherwise it falls back to a stub implementation, mirroring the existing CocoaPods behavior in `media_kit_utils.rb`. Note: after adding or removing the libs package from `pubspec.yaml`, the SPM cache must be cleared manually: rm -rf ~/Library/Caches/org.swift.swiftpm/ --- .../ios/media_kit_video/Package.swift | 38 +++++++++++++++---- .../macos/media_kit_video/Package.swift | 38 +++++++++++++++---- 2 files changed, 62 insertions(+), 14 deletions(-) diff --git a/media_kit_video/ios/media_kit_video/Package.swift b/media_kit_video/ios/media_kit_video/Package.swift index d59b11408..aef8098d8 100644 --- a/media_kit_video/ios/media_kit_video/Package.swift +++ b/media_kit_video/ios/media_kit_video/Package.swift @@ -2,6 +2,28 @@ // The swift-tools-version declares the minimum version of Swift required to build this package. import PackageDescription +import Foundation + +/// Checks whether a sibling SPM package exists at the given relative path. +/// +/// Used to determine whether the native media libs package (e.g. `media_kit_libs_ios_video`) +/// has been included by the developer in their `pubspec.yaml`. When found, `media_kit_video` is +/// linked against it; otherwise it falls back to a stub implementation. +/// +/// NOTE: This function is duplicated across iOS and macOS `Package.swift` manifests. +/// +/// WARNING: After adding or removing the libs package from `pubspec.yaml`, the Swift Package +/// Manager cache must be cleared manually for the change to take effect: +/// +/// rm -rf ~/Library/Caches/org.swift.swiftpm/ +func packageExists(at relativePath: String) -> Bool { + let base = URL(fileURLWithPath: #file).deletingLastPathComponent() + let path = base.appendingPathComponent(relativePath).standardized.path + return FileManager.default.fileExists(atPath: path) +} + +let libsPath = "../media_kit_libs_ios_video" +let hasLibs = packageExists(at: libsPath) let package = Package( name: "media_kit_video", @@ -11,16 +33,18 @@ let package = Package( products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) ], - dependencies: [ - .package(name: "media_kit_libs_ios_video", path: "../media_kit_libs_ios_video") - ], + dependencies: hasLibs + ? [.package(name: "media_kit_libs_ios_video", path: libsPath)] + : [], targets: [ .target( name: "media_kit_video", - dependencies: [ - .product(name: "Mpv", package: "media_kit_libs_ios_video") - ], - sources: ["plugin"], + dependencies: hasLibs + ? [.product(name: "Mpv", package: "media_kit_libs_ios_video")] + : [], + sources: hasLibs + ? ["plugin"] + : ["stub"], resources: [ .process("PrivacyInfo.xcprivacy") ] diff --git a/media_kit_video/macos/media_kit_video/Package.swift b/media_kit_video/macos/media_kit_video/Package.swift index 3775b8e4b..c8a2d359a 100644 --- a/media_kit_video/macos/media_kit_video/Package.swift +++ b/media_kit_video/macos/media_kit_video/Package.swift @@ -2,6 +2,28 @@ // The swift-tools-version declares the minimum version of Swift required to build this package. import PackageDescription +import Foundation + +/// Checks whether a sibling SPM package exists at the given relative path. +/// +/// Used to determine whether the native media libs package (e.g. `media_kit_libs_macos_video`) +/// has been included by the developer in their `pubspec.yaml`. When found, `media_kit_video` is +/// linked against it; otherwise it falls back to a stub implementation. +/// +/// NOTE: This function is duplicated across iOS and macOS `Package.swift` manifests. +/// +/// WARNING: After adding or removing the libs package from `pubspec.yaml`, the Swift Package +/// Manager cache must be cleared manually for the change to take effect: +/// +/// rm -rf ~/Library/Caches/org.swift.swiftpm/ +func packageExists(at relativePath: String) -> Bool { + let base = URL(fileURLWithPath: #file).deletingLastPathComponent() + let path = base.appendingPathComponent(relativePath).standardized.path + return FileManager.default.fileExists(atPath: path) +} + +let libsPath = "../media_kit_libs_macos_video" +let hasLibs = packageExists(at: libsPath) let package = Package( name: "media_kit_video", @@ -11,16 +33,18 @@ let package = Package( products: [ .library(name: "media-kit-video", targets: ["media_kit_video"]) ], - dependencies: [ - .package(name: "media_kit_libs_macos_video", path: "../media_kit_libs_macos_video") - ], + dependencies: hasLibs + ? [.package(name: "media_kit_libs_macos_video", path: libsPath)] + : [], targets: [ .target( name: "media_kit_video", - dependencies: [ - .product(name: "Mpv", package: "media_kit_libs_macos_video") - ], - sources: ["plugin"], + dependencies: hasLibs + ? [.product(name: "Mpv", package: "media_kit_libs_macos_video")] + : [], + sources: hasLibs + ? ["plugin"] + : ["stub"], resources: [ .process("PrivacyInfo.xcprivacy") ]