Skip to content

chore: refactor mimalloc import #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TheOneWithTheBraid wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: refactor mimalloc import #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions libs/linux/media_kit_libs_linux/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 1.2.0

- chore: refactor mimalloc import

## 1.1.3

- feat: improve compile-time failure handling
Expand Down
166 changes: 91 additions & 75 deletions libs/linux/media_kit_libs_linux/linux/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,104 +4,120 @@
# All rights reserved.
# Use of this source code is governed by MIT license that can be found in the LICENSE file.

cmake_minimum_required(VERSION 3.10)
cmake_minimum_required(VERSION 3.13)

# This option is read by the other packages which are part of package:media_kit.
option(MEDIA_KIT_LIBS_AVAILABLE "package:media_kit libraries are available." ON)

# This is the public option enabling dynamic linking on request of applications.
option(MIMALLOC_USE_STATIC_LIBS "Whether to prefer linking to mimalloc statically" ON)

set(PROJECT_NAME "media_kit_libs_linux")
project(${PROJECT_NAME} LANGUAGES CXX)

# We use the mimalloc's object file (mimalloc.o) & link the final executable with it.
# This ensures that the standard malloc interface resolves to the mimalloc library.
#
# Refer to "Static Override" section in mimalloc's documentation:
# https://github.com/microsoft/mimalloc#static-override
function(download_and_verify url md5 locationForArchive)
# Check if the archive exists.
if(EXISTS "${locationForArchive}")
file(MD5 "${locationForArchive}" ARCHIVE_MD5)

# If MD5 doesn't match, delete the archive to download again.
if(NOT md5 STREQUAL ARCHIVE_MD5)
file(REMOVE "${locationForArchive}")
message(STATUS "MD5 mismatch. File deleted.")
if(MIMALLOC_USE_STATIC_LIBS)

# We use the mimalloc's object file (mimalloc.o) & link the final executable with it.
# This ensures that the standard malloc interface resolves to the mimalloc library.
#
# Refer to "Static Override" section in mimalloc's documentation:
# https://github.com/microsoft/mimalloc#static-override
function(download_and_verify url md5 locationForArchive)
# Check if the archive exists.
if(EXISTS "${locationForArchive}")
file(MD5 "${locationForArchive}" ARCHIVE_MD5)

# If MD5 doesn't match, delete the archive to download again.
if(NOT md5 STREQUAL ARCHIVE_MD5)
file(REMOVE "${locationForArchive}")
message(STATUS "MD5 mismatch. File deleted.")
endif()
endif()
endif()

# Download the archive if it doesn't exist.
if(NOT EXISTS "${locationForArchive}")
message(STATUS "Downloading archive from ${url}...")
file(DOWNLOAD "${url}" "${locationForArchive}")
message(STATUS "Downloaded archive to ${locationForArchive}.")
# Download the archive if it doesn't exist.
if(NOT EXISTS "${locationForArchive}")
message(STATUS "Downloading archive from ${url}...")
file(DOWNLOAD "${url}" "${locationForArchive}")
message(STATUS "Downloaded archive to ${locationForArchive}.")

# Verify MD5 of the newly downloaded file.
file(MD5 "${locationForArchive}" ARCHIVE_MD5)
# Verify MD5 of the newly downloaded file.
file(MD5 "${locationForArchive}" ARCHIVE_MD5)

if(md5 STREQUAL ARCHIVE_MD5)
message(STATUS "${locationForArchive} Verification successful.")
else()
message(FATAL_ERROR "${locationForArchive} Integrity check failed, please try to rebuild project again.")
if(md5 STREQUAL ARCHIVE_MD5)
message(STATUS "${locationForArchive} Verification successful.")
else()
message(FATAL_ERROR "${locationForArchive} Integrity check failed, please try to rebuild project again.")
endif()
endif()
endif()
endfunction()

# ------------------------------------------------------------------------------
set(MIMALLOC "mimalloc-2.1.2.tar.gz")
endfunction()

set(MIMALLOC_URL "https://github.com/microsoft/mimalloc/archive/refs/tags/v2.1.2.tar.gz")
set(MIMALLOC_MD5 "5179c8f5cf1237d2300e2d8559a7bc55")
# ------------------------------------------------------------------------------
set(MIMALLOC "mimalloc-2.1.2.tar.gz")

set(MIMALLOC_ARCHIVE "${CMAKE_BINARY_DIR}/${MIMALLOC}")
set(MIMALLOC_SRC "${CMAKE_BINARY_DIR}/mimalloc")
set(MIMALLOC_URL "https://github.com/microsoft/mimalloc/archive/refs/tags/v2.1.2.tar.gz")
set(MIMALLOC_MD5 "5179c8f5cf1237d2300e2d8559a7bc55")

download_and_verify(
${MIMALLOC_URL}
${MIMALLOC_MD5}
${MIMALLOC_ARCHIVE}
)
set(MIMALLOC_ARCHIVE "${CMAKE_BINARY_DIR}/${MIMALLOC}")
set(MIMALLOC_SRC "${CMAKE_BINARY_DIR}/mimalloc")

function(check_directory_exists_and_not_empty dir result_var)
# Check if the directory exists
if(EXISTS "${dir}")
# Check if the directory is not empty
file(GLOB dir_contents "${dir}/*")
download_and_verify(
${MIMALLOC_URL}
${MIMALLOC_MD5}
${MIMALLOC_ARCHIVE}
)

if(dir_contents)
set(${result_var} TRUE PARENT_SCOPE)
function(check_directory_exists_and_not_empty dir result_var)
# Check if the directory exists
if(EXISTS "${dir}")
# Check if the directory is not empty
file(GLOB dir_contents "${dir}/*")

if(dir_contents)
set(${result_var} TRUE PARENT_SCOPE)
else()
set(${result_var} FALSE PARENT_SCOPE)
message(STATUS "Directory ${dir} exists but is empty!")
endif()
else()
set(${result_var} FALSE PARENT_SCOPE)
message(STATUS "Directory ${dir} exists but is empty!")
message(STATUS "Directory ${dir} does not exist!")
endif()
else()
set(${result_var} FALSE PARENT_SCOPE)
message(STATUS "Directory ${dir} does not exist!")
endfunction()

# Extract
# https://stackoverflow.com/a/19859882/12825435
set(MIMALLOC_LIB "${MIMALLOC_SRC}/out/release/mimalloc.o" CACHE INTERNAL "")

check_directory_exists_and_not_empty(${MIMALLOC_SRC} MIMALLOC_VALID)

if(NOT MIMALLOC_VALID)
message(STATUS "Extracting ${MIMALLOC}...")
make_directory("${MIMALLOC_SRC}")
add_custom_command(
OUTPUT ${MIMALLOC_LIB}
COMMAND "${CMAKE_COMMAND}" -E tar xzf "${MIMALLOC_ARCHIVE}"

# add_subdirectory() is too much work. Alternatively building it through command line.
COMMAND "mkdir" "-p" "out/release"
COMMAND "cd" "out/release"
COMMAND "${CMAKE_COMMAND}" "../../mimalloc-2.1.2"
COMMAND "make"
WORKING_DIRECTORY "${MIMALLOC_SRC}"
)
endif()
endfunction()

# Extract
# https://stackoverflow.com/a/19859882/12825435
set(MIMALLOC_LIB "${MIMALLOC_SRC}/out/release/mimalloc.o" CACHE INTERNAL "")

check_directory_exists_and_not_empty(${MIMALLOC_SRC} MIMALLOC_VALID)

if(NOT MIMALLOC_VALID)
message(STATUS "Extracting ${MIMALLOC}...")
make_directory("${MIMALLOC_SRC}")
add_custom_command(
OUTPUT ${MIMALLOC_LIB}
COMMAND "${CMAKE_COMMAND}" -E tar xzf "${MIMALLOC_ARCHIVE}"

# add_subdirectory() is too much work. Alternatively building it through command line.
COMMAND "mkdir" "-p" "out/release"
COMMAND "cd" "out/release"
COMMAND "${CMAKE_COMMAND}" "../../mimalloc-2.1.2"
COMMAND "make"
WORKING_DIRECTORY "${MIMALLOC_SRC}"
)

add_custom_target("MIMALLOC_TARGET" ALL DEPENDS ${MIMALLOC_LIB})

else()

find_library(MIMALLOC_PATH "libmimalloc.so")
if(MIMALLOC_PATH)
set(MIMALLOC_LIB "${MIMALLOC_PATH}" CACHE INTERNAL "")
endif()

endif()

add_custom_target("MIMALLOC_TARGET" ALL DEPENDS ${MIMALLOC_LIB})
unset(MIMALLOC_USE_STATIC_LIBS CACHE)

# ------------------------------------------------------------------------------
set(PLUGIN_NAME "media_kit_libs_linux_plugin")
Expand Down
2 changes: 1 addition & 1 deletion libs/linux/media_kit_libs_linux/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: media_kit_libs_linux
description: GNU/Linux dependency package for package:media_kit. Necessary for initialization.
version: 1.1.3
version: 1.2.0
homepage: https://github.com/media-kit/media-kit.git
repository: https://github.com/media-kit/media-kit.git

Expand Down
16 changes: 16 additions & 0 deletions media_kit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1664,6 +1664,7 @@ There are other ways to bundle these within your app package e.g. within Snap or
- [Celluloid](https://github.com/celluloid-player/celluloid/blob/master/flatpak/io.github.celluloid_player.Celluloid.json)
- [VidCutter](https://github.com/ozmartian/vidcutter/tree/master/_packaging)


#### Utilize [mimalloc](https://github.com/microsoft/mimalloc)

You should consider replacing the default memory allocator with [mimalloc](https://github.com/microsoft/mimalloc) for [avoiding memory leaks](https://github.com/media-kit/media-kit/issues/68).
Expand All @@ -1674,6 +1675,21 @@ This is as simple as [adding one line to `linux/CMakeLists.txt`](https://github.
target_link_libraries(${BINARY_NAME} PRIVATE ${MIMALLOC_LIB})
```

In case you prefer dynamic linking of mimalloc, you can additionally add the following line to your `linux/CMakeLists.txt`:

```cmake
# use dynamically linked mimalloc
set(MIMALLOC_USE_STATIC_LIBS OFF)
```

In this case, please ensure you install `libmimalloc-dev` at compile time and `libmimalloc2.0` as runtime dependencies.

#### Ubuntu/Debian

```bash
sudo apt install libmimalloc-dev libmimalloc2.0
```

### Web

On the web, **libmpv is not used**. Video & audio playback is handled by embedding [HTML `<video>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video). The format support depends upon the web browser. It happens to be extremely limited as compared to native platforms.
Expand Down