[SDL2] Xcode does not add optional frameworks to dmg

[madebr]

The Create DMG target of SDL2_mixer's Xcode creates a dmg without the optional gme/ogg/opus/wavpack/xmp frameworks.

The dmg of official releases weights around 1.86MB,
whereas a dmg created by xcode weight only 274kB.

SDL3_mixer might have the same issue.

This issue applies to SDL_image as well.

[slouken]

Here are the build.xcconfig files I use for the satellite libraries.

SDL_image 2.0:

//
//  build.xcconfig
//

// Configuration settings file format documentation can be found at:
// https://help.apple.com/xcode/#/dev745c5c974

// Uncomment these lines to enable AVIF support
// If you do this, you should run external/download.sh to download the decode libraries and add avif.framework to your application bundle.
CONFIG_PREPROCESSOR_DEFINITIONS = $(inherited) LOAD_AVIF
CONFIG_FRAMEWORK_LDFLAGS = $(inherited) -weak_framework avif

// Uncomment these lines to enable JPEG-XL support
// If you do this, you should run external/download.sh to download the decode libraries and add jxl.framework to your application bundle.
//CONFIG_PREPROCESSOR_DEFINITIONS = $(inherited) LOAD_JXL
//CONFIG_FRAMEWORK_LDFLAGS = $(inherited) -weak_framework jxl

// Uncomment these lines to enable WebP support
// If you do this, you should run external/download.sh to download the decode libraries and add webp.framework to your application bundle.
CONFIG_PREPROCESSOR_DEFINITIONS = $(inherited) LOAD_WEBP
CONFIG_FRAMEWORK_LDFLAGS = $(inherited) -weak_framework webp

SDL_image 3.0:

//
//  build.xcconfig
//

// Configuration settings file format documentation can be found at:
// https://help.apple.com/xcode/#/dev745c5c974

// Uncomment these lines to enable AVIF support
// If you do this, you should run external/download.sh to download the decode libraries and add avif.framework to your application bundle.
AVIF_PREPROCESSOR_DEFINITIONS = LOAD_AVIF
AVIF_FRAMEWORK_LDFLAGS = -weak_framework avif

// Uncomment these lines to enable JPEG-XL support
// If you do this, you should run external/download.sh to download the decode libraries and add jxl.framework to your application bundle.
JXL_PREPROCESSOR_DEFINITIONS = LOAD_JXL
JXL_FRAMEWORK_LDFLAGS = -weak_framework jxl

// Uncomment these lines to enable WebP support
// If you do this, you should run external/download.sh to download the decode libraries and add webp.framework to your application bundle.
WEBP_PREPROCESSOR_DEFINITIONS = LOAD_WEBP
WEBP_FRAMEWORK_LDFLAGS = -weak_framework webp

SDL_mixer 2.0:

//
//  build.xcconfig
//

// Configuration settings file format documentation can be found at:
// https://help.apple.com/xcode/#/dev745c5c974

// Uncomment these lines to enable native MIDI support on OSX
//MIDI_PREPROCESSOR_DEFINITIONS[sdk=macosx*] = MUSIC_MID_NATIVE

// Uncomment these lines to enable MOD support
// If you do this, you should run external/download.sh to download the decode libraries and add xmp.framework to your application bundle.
MOD_PREPROCESSOR_DEFINITIONS = MUSIC_MOD_XMP LIBXMP_HEADER=\"../external/libxmp/include/xmp.h\"
MOD_FRAMEWORK_LDFLAGS = -weak_framework xmp_lite

// Uncomment these lines to enable Opus support
// If you do this, you should run external/download.sh to download the decode libraries and add opus.framework to your application bundle.
OPUS_PREPROCESSOR_DEFINITIONS = MUSIC_OPUS
OPUS_FRAMEWORK_LDFLAGS = -weak_framework opus

SDL_mixer 3.0:

//
//  build.xcconfig
//

// Configuration settings file format documentation can be found at:
// https://help.apple.com/xcode/#/dev745c5c974

// Uncomment these lines to enable Game_Music_Emu support
// If you do this, you should run external/download.sh to download the decode libraries and add gme.framework to your application bundle.
GME_PREPROCESSOR_DEFINITIONS = MUSIC_GME
GME_FRAMEWORK_LDFLAGS = -weak_framework gme

// Uncomment these lines to enable native MIDI support on OSX
MIDI_PREPROCESSOR_DEFINITIONS[sdk=macosx*] = MUSIC_MID_NATIVE

// Uncomment these lines to enable MOD support
// If you do this, you should run external/download.sh to download the decode libraries and add xmp.framework to your application bundle.
MOD_PREPROCESSOR_DEFINITIONS = MUSIC_MOD_XMP LIBXMP_HEADER=\"../external/libxmp/include/xmp.h\"
MOD_FRAMEWORK_LDFLAGS = -weak_framework xmp

// Uncomment these lines to enable Opus support
// If you do this, you should run external/download.sh to download the decode libraries and add opus.framework to your application bundle.
OPUS_PREPROCESSOR_DEFINITIONS = MUSIC_OPUS
OPUS_FRAMEWORK_LDFLAGS = -weak_framework opus

// Uncomment these lines to enable WavPack support
// If you do this, you should run external/download.sh to download the decode libraries and add wavpack.framework to your application bundle.
WAVPACK_PREPROCESSOR_DEFINITIONS = MUSIC_WAVPACK MUSIC_WAVPACK_DSD
WAVPACK_FRAMEWORK_LDFLAGS = -weak_framework wavpack

[madebr]

Is this build procedure correct?

1. Build the xcode projects of the 3rd party libraries
2. Move this build.xcconfig file to the SDL_mixer xcode project, into the Xcode folder next to config.xcconfig
3. Build the Create DMG target of the SDL_mixer xcode project

[slouken]

Is this build procedure correct?

1. Build the xcode projects of the 3rd party libraries
2. Move this build.xcconfig file to the SDL_mixer xcode project, into the Xcode folder next to config.xcconfig
3. Build the Create DMG target of the SDL_mixer xcode project

I think you can skip step 1, if you've already downloaded the code to the external directory, Xcode will see the dependencies and build them.

[madebr]

I think you can skip step 1, if you've already downloaded the code to the external directory, Xcode will see the dependencies and build them.

You're right.
I'd like to add these file to the repo, e.g. as Xcode/pkg-support/build.xcconfig.
Is that okay for the xcode project? It won't be used accidentally when put in that location?

[slouken]

I think you can skip step 1, if you've already downloaded the code to the external directory, Xcode will see the dependencies and build them.

You're right. I'd like to add these file to the repo, e.g. as Xcode/pkg-support/build.xcconfig. Is that okay for the xcode project? It won't be used accidentally when put in that location?

Yep, that's fine.

[madebr]

Is the Xcode project of SDL3_image up-to-date or does it need other/extra arguments?
Or perhaps we need to do things to enable the various platforms?

Running it with the arguments:

['xcodebuild', 'ONLY_ACTIVE_ARCH=NO', '-project', 'SDL3_image-3.0.0/Xcode/SDL_image.xcodeproj', '-scheme', 'SDL3_image.dmg', '-configuration', 'Release']

fails catastrophically like this.

(After copying build.xcconfig of above to the Xcode folder)

[slouken]

I'm not seeing the build error in that massive spew?

[madebr]

That's the thing. I don't know what's going wrong :)

[slouken]

Okay, this is necessary to build the projects, and I have a couple more fixes coming:
git submodule update --init --recursive

[slouken]

Okay, I pushed avif build fixes, try now?

[madebr]

Yes! It successfully builds! Great job!
https://github.com/madebr/SDL_image/actions/runs/11227263662/job/31209209996
It is around 23MB big.

[madebr]

How do I build only the core SDL3_image dmg archive without the external modules?
I tried not copying the build.xcconfig and not checking out the submodules, but it fails somewhere.
https://github.com/madebr/SDL_image/actions/runs/11227660619/job/31210262783#step:7:3752

I'd like to build a lean SDL3_image.dmg to test the CMake scripts with quick feedback.

[slouken]

You do need SDL, but the other external modules are optional.