Skip to content

Add multi-threaded versions of sdl2_image and sdl2_ttf #22946

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

Merged
merged 1 commit into from
Nov 18, 2024
+26 −11
Merged

Add multi-threaded versions of sdl2_image and sdl2_ttf #22946

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
2 changes: 1 addition & 1 deletion test/test_sanity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@ def test_embuilder_wildcards(self):
def test_embuilder_with_use_port_syntax(self):
restore_and_set_up()
self.run_process([EMBUILDER, 'build', 'sdl2_image:formats=png,jpg', '--force'])
self.assertExists(os.path.join(config.CACHE, 'sysroot', 'lib', 'wasm32-emscripten', 'libSDL2_image_jpg-png.a'))
self.assertExists(os.path.join(config.CACHE, 'sysroot', 'lib', 'wasm32-emscripten', 'libSDL2_image-jpg-png.a'))
Copy link
Member

@kripken kripken Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the _ => - change needed, or for aesthetics? If it isn't needed then maybe it isn't worth it, as users might have hardcoded CI commands about it.

Copy link
Collaborator Author

@sbc100 sbc100 Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tend to use - for all our variants (not _) so this is just for consistency.

The precise names of these variants should not be hardcoded anywhere.. if it were I think that would be a bug.

Copy link
Member

@kripken kripken Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just worry about a user that has

cp libSDL2_image_jpg-png.a $OUT_DIR

in their CI workflow. This change would make them need to rename.

But if you are confident that is unlikely, and we haven't had issues with such changes in the past, sgtm as is.

Copy link
Collaborator Author

@sbc100 sbc100 Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that would be very unlikely yes. The consider those derived names (not the basename, but the extended name containing the variants) to be an internal detail that should not be relied on.

self.assertContained('error building port `sdl2_image:formats=invalid` | invalid is not a supported format', self.do([EMBUILDER, 'build', 'sdl2_image:formats=invalid', '--force']))

def test_embuilder_external_ports(self):
Expand Down
23 changes: 15 additions & 8 deletions tools/ports/sdl2_image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@

deps = ['sdl2']
variants = {
'sdl2_image_jpg': {'SDL2_IMAGE_FORMATS': ["jpg"]},
'sdl2_image_png': {'SDL2_IMAGE_FORMATS': ["png"]},
'sdl2_image-jpg': {'SDL2_IMAGE_FORMATS': ["jpg"]},
'sdl2_image-png': {'SDL2_IMAGE_FORMATS': ["png"]},
'sdl2_image-jpg-mt': {'SDL2_IMAGE_FORMATS': ["jpg"], 'PTHREADS': 1},
'sdl2_image-png-mt': {'SDL2_IMAGE_FORMATS': ["png"], 'PTHREADS': 1},
}

OPTIONS = {
Expand Down Expand Up @@ -41,7 +43,9 @@ def get_lib_name(settings):

libname = 'libSDL2_image'
if formats != '':
libname += '_' + formats
libname += '-' + formats
if settings.PTHREADS:
libname += '-mt'
return libname + '.a'


Expand All @@ -58,20 +62,23 @@ def create(final):
IMG_tif.c IMG_xcf.c IMG_xpm.c IMG_xv.c IMG_webp.c IMG_ImageIO.m
IMG_avif.c IMG_jxl.c IMG_svg.c IMG_qoi.c'''.split()

defs = ['-O2', '-sUSE_SDL=2', '-Wno-format-security']
flags = ['-O2', '-sUSE_SDL=2', '-Wno-format-security']

formats = get_formats(settings)

for fmt in formats:
defs.append('-DLOAD_' + fmt.upper())
flags.append('-DLOAD_' + fmt.upper())

if 'png' in formats:
defs += ['-sUSE_LIBPNG']
flags += ['-sUSE_LIBPNG']

if 'jpg' in formats:
defs += ['-sUSE_LIBJPEG']
flags += ['-sUSE_LIBJPEG']

ports.build_port(src_dir, final, 'sdl2_image', flags=defs, srcs=srcs)
if settings.PTHREADS:
flags += ['-pthread']

ports.build_port(src_dir, final, 'sdl2_image', flags=flags, srcs=srcs)

return [shared.cache.get_lib(libname, create, what='port')]

Expand Down
12 changes: 10 additions & 2 deletions tools/ports/sdl2_ttf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,33 @@

deps = ['freetype', 'sdl2', 'harfbuzz']

variants = {'sdl2_ttf-mt': {'PTHREADS': 1}}


def needed(settings):
return settings.USE_SDL_TTF == 2


def get_lib_name(settings):
return 'libSDL2_ttf' + ('-mt' if settings.PTHREADS else '') + '.a'


def get(ports, settings, shared):
ports.fetch_project('sdl2_ttf', f'https://github.com/libsdl-org/SDL_ttf/archive/{TAG}.zip', sha512hash=HASH)

def create(final):
src_root = ports.get_dir('sdl2_ttf', 'SDL_ttf-' + TAG)
ports.install_headers(src_root, target='SDL2')
flags = ['-DTTF_USE_HARFBUZZ=1', '-sUSE_SDL=2', '-sUSE_FREETYPE', '-sUSE_HARFBUZZ']
if settings.PTHREADS:
flags += ['-pthread']
ports.build_port(src_root, final, 'sdl2_ttf', flags=flags, srcs=['SDL_ttf.c'])

return [shared.cache.get_lib('libSDL2_ttf.a', create, what='port')]
return [shared.cache.get_lib(get_lib_name(settings), create, what='port')]


def clear(ports, settings, shared):
shared.cache.erase_lib('libSDL2_ttf.a')
shared.cache.erase_lib(get_lib_name(settings))


def process_dependencies(settings):
Expand Down
Loading