mahozad
commented
1 year ago I embedded the VLC in my Compose Multiplatform app (only for Windows). Wanted to share it here. In the end it just became about 10 MB of VLC files that needed to be embedded in the app (still a lot but tolerable). With this, there will be no need for the VLC to have been installed on the system.
First, downloaded and installed latest version of the VLC media player (v3.0.18) on the system (made sure to select the x64 version from the dropdown): https://www.videolan.org/vlc/download-windows.html
My case is that I need to play only MPEG-TS files with these abilities:
- Play/pause
- Progress and seek (forward and rewind)
- Changing audio volume (and mute/unmute)
- Changing playback speed
- Taking screenshot
So, the following is the minimum required .dll files from VLC for the above use case (added ⚠️ comments for some of them):
📂 <VLC_INSTALLTION_DIRCTORY>
├─── libvlc.dll
├─── libvlccore.dll
└─── 📂 plugins
├─── 📂 access
│ └─── libfilesystem_plugin.dll
├─── 📂 audio_filter
│ ├─── libnormvol_plugin.dll (⚠️ Along with audio_output/libmmdevice_plugin.dll, normalizes audio loudness)
│ ├─── libscaletempo_pitch_plugin.dll (⚠️ For human voice to not distort when changing the speed)
│ └─── libscaletempo_plugin.dll (⚠️ For audio when changing the speed)
├─── 📂 audio_output
│ └─── libdirectsound_plugin.dll
│ └─── libmmdevice_plugin.dll (⚠️ Along with audio_filter/libnormvol_plugin.dll, normalizes audio loudness)
├─── 📂 codec
│ └─── libavcodec_plugin.dll (⚠️ When almost all other DLLs were available (not deleted) I deleted this file and the player still worked but the video flickered (when paused and sometimes during playback))
├─── 📂 demux
│ └─── libts_plugin.dll (⚠️ For MPEG-TS files)
├─── 📂 packetizer
│ ├─── libpacketizer_mpeg4audio_plugin.dll
│ └─── libpacketizer_mpeg4video_plugin.dll
├─── 📂 stream_filter
│ └─── libcache_read_plugin.dll (⚠️ For speedup of live-stream video to work correctly and smoothly; speedup of finished videos works without this)
├─── 📂 text_renderer (⚠️ Can delete this to hide the text overlay (save path) when taking a screenshot)
│ └─── libfreetype_plugin.dll
├─── 📂 video_chroma
│ └─── libswscale_plugin.dll
├─── 📂 video_filter
│ └─── libdeinterlace_plugin.dll (⚠️ To de-interlace the video playback; otherwise, not needed)
└─── 📂 video_output
├─── libdirect3d9_plugin.dll (⚠️ On my system, video was black without this file)
├─── libdirect3d11_plugin.dll (⚠️ On my system, video was black without this file)
├─── libdirectdraw_plugin.dll
└─── libdrawable_plugin.dllCopied the contents of <VLC_INSTALLTION_DIRCTORY> (preserving the directory structure and names) into <compose_project_directory>/assets/windows/vlc/.
Then downloaded the UPX program to reduce the size of VLC .dll files (to about 50% of their original size!):
cd <compose_project_directory>/assets/windows/vlc/
find -type f -name *.dll | xargs -n1 path/to/upx.exeThen modified the app root build.gradle.kts file to add the assets/ as the compose multiplatform custom resources directory:
compose.desktop {
application {
mainClass = // ...
nativeDistributions {
// ...
appResourcesRootDir = (project.rootDir.toPath() / "assets").toFile()
}
}
}Finally, updated the video player:
// ...
val assetsPath = System
.getProperty("compose.application.resources.dir")
?.let(::Path)
?: error("The compose.application.resources.dir is not set. Make sure to execute the app using Gradle tasks named `run...`")
val vlcPath = (assetsPath / "vlc").absolutePathString()
NativeDiscovery(object : NativeDiscoveryStrategy {
override fun discover() = vlcPath
override fun supported() = true
override fun onFound(path: String) = true
override fun onSetPluginPath(path: String) = true
}).discover()
if (isMacOS()) {
CallbackMediaPlayerComponent()
} else {
EmbeddedMediaPlayerComponent()
}
// ...I tried to also do this in Ubuntu with VLC .so files but the app started with the error failed to get a new native library instance probably because, as the author of vlcj library said in https://stackoverflow.com/a/23897920 , the .so files are not relocatable.
avently
okushnikov
(from https://github.com/JetBrains/compose-jb/pull/1088#issuecomment-903090784)
theapache64machine.until I installed VLC:
I think we need to bundle VLC as a part of VideoPlayer. The separate issue