Scroll to navigation

SDL_HINT_WAVE_RIFF_CHUNK_SIZE(3) SDL3 FUNCTIONS SDL_HINT_WAVE_RIFF_CHUNK_SIZE(3)

NAME

SDL_HINT_WAVE_RIFF_CHUNK_SIZE - A variable controlling how the size of the RIFF chunk affects the loading of a WAVE file.

HEADER FILE

Defined in SDL3/SDL_hints.h

SYNOPSIS

#include "SDL3/SDL.h"
#define SDL_HINT_WAVE_RIFF_CHUNK_SIZE   SDL_WAVE_RIFF_CHUNK_SIZE"

DESCRIPTION

The size of the RIFF chunk (which includes all the sub-chunks of the WAVE file) is not always reliable. In case the size is wrong, it's possible to just ignore it and step through the chunks until a fixed limit is reached.

Note that files that have trailing data unrelated to the WAVE file or corrupt files may slow down the loading process without a reliable boundary. By default, SDL stops after 10000 chunks to prevent wasting time. Use the environment variable SDL_WAVE_CHUNK_LIMIT

to adjust this value.

The variable can be set to the following values:

• "force" - Always use the RIFF chunk size as a boundary for the chunk
search.

• "ignorezero" - Like "force", but a zero size searches up to 4 GiB.
(default)

• "ignore" - Ignore the RIFF chunk size and always search up to 4 GiB.

• "maximum" - Search for chunks until the end of file. (not recommended)

This hint should be set before calling SDL_LoadWAV () or

SDL_LoadWAV_IO ()

AVAILABILITY

This hint is available since SDL 3.0.0.

SDL 3.1.2 Simple Directmedia Layer