kmx git

Commit	Date	Message
e4411505	2021-07-29T19:04:39	Don't pack SDL_AudioCVT on CHERI architectures This is needed to support CHERI, and thus Arm's experimental Morello prototype, where pointers are implemented using unforgeable capabilities that include bounds and permissions metadata to provide fine-grained spatial and referential memory safety, as well as revocation by sweeping memory to provide heap temporal memory safety. The referential safety is enforced through the use of tagged memory, and there is only a single tag bit per capability-sized word, meaning it is impossible to store capabilities at unaligned locations, either getting a trap on load/store or the validity tag being stripped when round-tripepd through memory. Since this is a new ABI for which SDL has never been compiled before, we do not need to be concerned with this compatibility measure, so just don't pack the struct for CHERI architectures. This code is inherently rather dubious anyway; if MSVC and GCC disagree on struct layout when targeting Windows then that is a bug in GCC, but likely extends from the bogus #pragma pack directives for MSVC in begin_code.h, which will force types to be underaligned (and is attempting to work around something that is fundamentally a broken idea to be doing). In particular 8-byte-aligned types will be underaligned to 4 bytes, but only on MSVC. Since that code is not used for GCC that is probably the cause of the struct layout discrepancy, and there are likely other instances of that throughout SDL. Moreover, the supposed fix here is not in fact a fix, as now GCC will think SDL_AudioCVT is only 1-byte-aligned but MSVC will think it's 4-byte or 8-byte-aligned, meaning ABI incomatibility is introduced by this change. However, removing it would break ABI compatibility for purely-GCC-compiled code (as old binaries would see the struct as 1-byte-aligned and new binaries would see the struct as 8-byte-aligned) so SDL is stuck with this until it bumps its ABI.
c88eb7a8	2021-07-14T17:07:04	Sync wiki -> header.
f8c1fc49	2021-07-14T14:15:30	doxygen: Fix all the "\returns" so they work as part of complete sentences.
17b4a67a	2021-07-14T11:45:06	doxygen: We use "\returns" as part of the sentence.
95e5f058	2021-04-03T13:24:10	audio: make SDL_OpenAudioDevice declaration look less squashed.
c486959e	2021-03-24T10:47:03	headers: Fix up bullet lists, now that wikiheaders.pl can handle them.
3f40396d	2021-03-21T14:18:39	First shot at merging the wiki documentation into the headers.
67e8522d	2021-02-27T17:37:25	Add SDL_GetAudioDeviceSpec. This API is supported by pipewire, pulseaudio, coreaudio, wasapi, and disk.
9130f7c3	2021-01-02T10:25:38	Updated copyright for 2021
a8780c6a	2020-01-16T20:49:25	Updated copyright date for 2020
990e166a	2019-06-08T19:02:42	Fixed bug 3894 - Fuzzing crashes for SDL_LoadWAV Simon Hug I had a look at this and made some additions to SDL_wave.c. The attached patch adds many checks and error messages. For some reason I also added A-law and ?-law decoders. Forgot exactly why... but hey, they're small. The WAVE format is seriously underspecified (at least by the documents that are publicly available on the internet) and it's a shame Microsoft never put something better out there. The language used in them is so loose at times, it's not surprising the encoders and decoders behave very differently. The Windows Media Player doesn't even support MS ADPCM correctly. The patch also adds some hints to make the decoder more strict at the cost of compatibility with weird WAVE files. I still think it needs a bit of cleaning up (Not happy with the MultiplySize function. Don't like the name and other SDL code may want to use something like this too.) and some duplicated code may be folded together. It does work in this state and I have thrown all kinds of WAVE files at it. The AFL files also pass with it and some even play (obviously just noise). Crafty little fuzzer. Any critique would be welcome. I have a fork of SDL with a audio-loadwav branch over here if someone wants to use the commenting feature of Bitbucket: https://bitbucket.org/ChliHug/SDL I also cobbled some Lua scripts together to create WAVE test files: https://bitbucket.org/ChliHug/gendat
5e13087b	2019-01-04T22:01:14	Updated copyright for 2019
b2518761	2018-10-01T09:47:10	commit c6b28f46b8116552ec2b38d1d3c8535df28ba7a1 Author: Anthony Pesch <inolen@gmail.com> Date: Fri May 4 20:21:21 2018 -0400 Added SDL_AUDIO_ALLOW_SAMPLES_CHANGE flag enabling users of SDL_OpenAudioDevice to get the sample size of the actual hardware buffer vs having a stream created to handle the delta
e3cc5b2c	2018-01-03T10:03:25	Updated copyright for 2018
dbce1341	2017-12-09T03:24:01	audio: fixed typo in Doxygen comment.
fe2b5fec	2017-10-20T14:48:10	Document the SDL audio channel mapping
7a6cf53a	2017-10-20T10:45:38	Added SDL_AudioStreamFlush() to the list of new audio stream functions
72932906	2017-10-19T18:05:42	audio: Added SDL_AudioStreamFlush().
80f8464d	2017-10-18T15:54:05	Added audio stream conversion functions: SDL_NewAudioStream SDL_AudioStreamPut SDL_AudioStreamGet SDL_AudioStreamAvailable SDL_AudioStreamClear SDL_FreeAudioStream
629f8aba	2017-08-29T09:02:04	Updated documentation, you don't need to initialize the audio subsystem to do in-place format conversion. (Thanks Simon Hug!)
e3e6b4fd	2017-08-18T16:52:19	audio: better docs on conversion APIs, error if not init'd (thanks, Simon!). Fixes Bugzilla #3662.
553b3286	2017-06-12T16:39:15	Fixed bug 3668 - Overflow of SDL_AudioCVT.filters with some downmixes Simon Hug There's a chance that an audio conversion from many channels to a few can use more than 9 audio filters. SDL_AudioCVT has 10 SDL_AudioFilter pointers of which one has to be the terminating NULL pointer. The SDL code has no checks for this limit. If it overflows there can be stack or heap corruption or a call to 0xa. Attached patch adds a function that checks for this limit and throws an error if it is reached. Also adds some documentation. Test parameters that trigger this issue: AUDIO_U16MSB with 224 channels at 46359 Hz V AUDIO_S16MSB with 6 channels at 27463 Hz The fuzzer program I uploaded in bug 3667 has more of them.
1066bcc8	2017-02-27T10:11:40	audio: clarified what SDL_AudioSpec::samples is, removed note about power of 2. These don't have to be power-of-2 sizes anymore because of SDL_AudioStream, and the new resampler, but also, many platforms don't give you power-of-2 DMA buffer in the first place!
073ff7de	2017-01-24T00:55:41	Added a note about aligning SDL_AudioCVT data.
45b774e3	2017-01-01T18:33:28	Updated copyright for 2017
36156335	2016-11-20T21:34:54	Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain
73153901	2016-08-06T02:47:27	audio: Implemented buffer queueing for capture devices (SDL_DequeueAudio()).
42065e78	2016-01-02T10:10:34	Updated copyright to 2016
0e45984f	2015-06-21T17:33:46	Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2c4a6ea0	2015-05-26T06:27:46	Updated the copyright year to 2015
b72938c8	2015-04-20T12:22:44	Windows: Always set the system timer resolution to 1ms by default. An existing hint lets apps that don't need the timer resolution changed avoid this, to save battery, etc, but this fixes several problems in timing, audio callbacks not firing fast enough, etc. Fixes Bugzilla #2944.
fe6c797c	2015-04-10T23:30:31	Fixed an iOS view orientation issue when SDL_GL_CreateContext or SDL_CreateRenderer is called.
b88ca1b4	2015-02-10T16:28:56	the last parameter of XChangeProperty is the number of elements.. and when the element format is 32.. the element is "long" so we have 5 long elements here. Yes this seems confusing as on mac+linux Long is either 32 or 64bits depending on the architecture, but this is how the X11 protocol is defined. Thus 5 is the correct value for the nelts here. Not 5 or 10 depending on the architecture. More info on the confusion https://bugs.freedesktop.org/show_bug.cgi?id=16802
b48e54aa	2015-01-26T22:00:29	Fixed bug 2802 - [patch] Fix android build compiling in wrong filesystem implementation Jonas Kulla The configure script didn't differentiate between Linux and Android, unconditionally compiling in the unix implementation of SDL_sysfilesystem.c. I'm probably one of the very few people building SDL for android using classic configure + standalone toolchain, so this has gone undetected all along.
70438be2	2014-12-03T10:55:23	WinRT: fixed bug whereby SDL would override an app's default orientation WinRT apps can set a default, preferred orientation via a .appxmanifest file. SDL was overriding this on app startup, and making the app use all possible orientations (landscape and portrait). Thanks to Eric Wing for the heads up on this!
9c398852	2014-11-22T22:20:40	Corrected header file documentation comment.
24c86b55	2014-09-11T19:24:42	[X11] Reconcile logical keyboard state with physical state on FocusIn since the window system doesn't do it for us like other platforms. This prevents sticky keys and missed keys when going in and out of focus, for example Alt would appear to stick if switching away from an SDL app with Alt-Tab and had to be pressed again. CR: Sam
f30e120a	2014-07-22T21:41:49	Added audio device buffer queueing API.
3dcb451f	2014-04-09T21:29:19	Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad.
58edac3e	2014-02-02T00:53:27	Fixed bug 2374 - Update copyright for 2014... Is it that time already??
f848adff	2013-11-29T10:06:08	Improve Android pause/resume behavior.
1e49b1ed	2013-08-21T09:47:10	OCD fixes: Adds a space after /* (glory to regular expressions!)
695344d1	2013-08-21T09:43:09	OCD fixes: Adds a space before */
dad42067	2013-08-12T11:13:50	Fixes #2022, do not resume on Android when surfaceChanged If the app is in landscape mode and the user presses the power button, a pause is followed immediately by a surfaceChanged event because the lock screen is shown in portrait mode. This triggers a "false" resume. So, we just pause and resume following the onWindowFocusChanged events. Also, wait for SDL_APP_WILLENTERBACKGROUND and SDL_APP_DIDENTERBACKGROUND before blocking the event pump.
1ad936eb	2013-08-11T19:56:43	Fixed bug 2027 - Full-screen appears to be broken - hang in SDL_DestroyWindow() Rainer Deyke I'm running Linux Mint 15 with the Cinnamon window manager. SDL_DestroyWindow consistently locks up for me when the window if fullscreen.

e4411505

2021-07-29T19:04:39

Don't pack SDL_AudioCVT on CHERI architectures This is needed to support CHERI, and thus Arm's experimental Morello prototype, where pointers are implemented using unforgeable capabilities that include bounds and permissions metadata to provide fine-grained spatial and referential memory safety, as well as revocation by sweeping memory to provide heap temporal memory safety. The referential safety is enforced through the use of tagged memory, and there is only a single tag bit per capability-sized word, meaning it is impossible to store capabilities at unaligned locations, either getting a trap on load/store or the validity tag being stripped when round-tripepd through memory. Since this is a new ABI for which SDL has never been compiled before, we do not need to be concerned with this compatibility measure, so just don't pack the struct for CHERI architectures. This code is inherently rather dubious anyway; if MSVC and GCC disagree on struct layout when targeting Windows then that is a bug in GCC, but likely extends from the bogus #pragma pack directives for MSVC in begin_code.h, which will force types to be *underaligned* (and is attempting to work around something that is fundamentally a broken idea to be doing). In particular 8-byte-aligned types will be underaligned to 4 bytes, but only on MSVC. Since that code is not used for GCC that is probably the cause of the struct layout discrepancy, and there are likely other instances of that throughout SDL. Moreover, the supposed fix here is not in fact a fix, as now GCC will think SDL_AudioCVT is only 1-byte-aligned but MSVC will think it's 4-byte or 8-byte-aligned, meaning ABI incomatibility is introduced by this change. However, removing it would break ABI compatibility for purely-GCC-compiled code (as old binaries would see the struct as 1-byte-aligned and new binaries would see the struct as 8-byte-aligned) so SDL is stuck with this until it bumps its ABI.

c88eb7a8

2021-07-14T17:07:04

Sync wiki -> header.

f8c1fc49

2021-07-14T14:15:30

doxygen: Fix all the "\returns" so they work as part of complete sentences.

17b4a67a

2021-07-14T11:45:06

doxygen: We use "\returns" as part of the sentence.

95e5f058

2021-04-03T13:24:10

audio: make SDL_OpenAudioDevice declaration look less squashed.

c486959e

2021-03-24T10:47:03

headers: Fix up bullet lists, now that wikiheaders.pl can handle them.

3f40396d

2021-03-21T14:18:39

First shot at merging the wiki documentation into the headers.

67e8522d

2021-02-27T17:37:25

Add SDL_GetAudioDeviceSpec. This API is supported by pipewire, pulseaudio, coreaudio, wasapi, and disk.

9130f7c3

2021-01-02T10:25:38

Updated copyright for 2021

a8780c6a

2020-01-16T20:49:25

Updated copyright date for 2020

990e166a

2019-06-08T19:02:42

Fixed bug 3894 - Fuzzing crashes for SDL_LoadWAV Simon Hug I had a look at this and made some additions to SDL_wave.c. The attached patch adds many checks and error messages. For some reason I also added A-law and ?-law decoders. Forgot exactly why... but hey, they're small. The WAVE format is seriously underspecified (at least by the documents that are publicly available on the internet) and it's a shame Microsoft never put something better out there. The language used in them is so loose at times, it's not surprising the encoders and decoders behave very differently. The Windows Media Player doesn't even support MS ADPCM correctly. The patch also adds some hints to make the decoder more strict at the cost of compatibility with weird WAVE files. I still think it needs a bit of cleaning up (Not happy with the MultiplySize function. Don't like the name and other SDL code may want to use something like this too.) and some duplicated code may be folded together. It does work in this state and I have thrown all kinds of WAVE files at it. The AFL files also pass with it and some even play (obviously just noise). Crafty little fuzzer. Any critique would be welcome. I have a fork of SDL with a audio-loadwav branch over here if someone wants to use the commenting feature of Bitbucket: https://bitbucket.org/ChliHug/SDL I also cobbled some Lua scripts together to create WAVE test files: https://bitbucket.org/ChliHug/gendat

5e13087b

2019-01-04T22:01:14

Updated copyright for 2019

b2518761

2018-10-01T09:47:10

commit c6b28f46b8116552ec2b38d1d3c8535df28ba7a1 Author: Anthony Pesch <inolen@gmail.com> Date: Fri May 4 20:21:21 2018 -0400 Added SDL_AUDIO_ALLOW_SAMPLES_CHANGE flag enabling users of SDL_OpenAudioDevice to get the sample size of the actual hardware buffer vs having a stream created to handle the delta

e3cc5b2c

2018-01-03T10:03:25

Updated copyright for 2018

dbce1341

2017-12-09T03:24:01

audio: fixed typo in Doxygen comment.

fe2b5fec

2017-10-20T14:48:10

Document the SDL audio channel mapping

7a6cf53a

2017-10-20T10:45:38

Added SDL_AudioStreamFlush() to the list of new audio stream functions

72932906

2017-10-19T18:05:42

audio: Added SDL_AudioStreamFlush().

80f8464d

2017-10-18T15:54:05

Added audio stream conversion functions: SDL_NewAudioStream SDL_AudioStreamPut SDL_AudioStreamGet SDL_AudioStreamAvailable SDL_AudioStreamClear SDL_FreeAudioStream

629f8aba

2017-08-29T09:02:04

Updated documentation, you don't need to initialize the audio subsystem to do in-place format conversion. (Thanks Simon Hug!)

e3e6b4fd

2017-08-18T16:52:19

audio: better docs on conversion APIs, error if not init'd (thanks, Simon!). Fixes Bugzilla #3662.

553b3286

2017-06-12T16:39:15

Fixed bug 3668 - Overflow of SDL_AudioCVT.filters with some downmixes Simon Hug There's a chance that an audio conversion from many channels to a few can use more than 9 audio filters. SDL_AudioCVT has 10 SDL_AudioFilter pointers of which one has to be the terminating NULL pointer. The SDL code has no checks for this limit. If it overflows there can be stack or heap corruption or a call to 0xa. Attached patch adds a function that checks for this limit and throws an error if it is reached. Also adds some documentation. Test parameters that trigger this issue: AUDIO_U16MSB with 224 channels at 46359 Hz V AUDIO_S16MSB with 6 channels at 27463 Hz The fuzzer program I uploaded in bug 3667 has more of them.

1066bcc8

2017-02-27T10:11:40

audio: clarified what SDL_AudioSpec::samples is, removed note about power of 2. These don't have to be power-of-2 sizes anymore because of SDL_AudioStream, and the new resampler, but also, many platforms don't give you power-of-2 DMA buffer in the first place!

073ff7de

2017-01-24T00:55:41

Added a note about aligning SDL_AudioCVT data.

45b774e3

2017-01-01T18:33:28

Updated copyright for 2017

36156335

2016-11-20T21:34:54

Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain

73153901

2016-08-06T02:47:27

audio: Implemented buffer queueing for capture devices (SDL_DequeueAudio()).

42065e78

2016-01-02T10:10:34

Updated copyright to 2016

0e45984f

2015-06-21T17:33:46

Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().

2c4a6ea0

2015-05-26T06:27:46

Updated the copyright year to 2015

b72938c8

2015-04-20T12:22:44

Windows: Always set the system timer resolution to 1ms by default. An existing hint lets apps that don't need the timer resolution changed avoid this, to save battery, etc, but this fixes several problems in timing, audio callbacks not firing fast enough, etc. Fixes Bugzilla #2944.

fe6c797c

2015-04-10T23:30:31

Fixed an iOS view orientation issue when SDL_GL_CreateContext or SDL_CreateRenderer is called.

b88ca1b4

2015-02-10T16:28:56

the last parameter of XChangeProperty is the number of elements.. and when the element format is 32.. the element is "long" so we have 5 long elements here. Yes this seems confusing as on mac+linux Long is either 32 or 64bits depending on the architecture, but this is how the X11 protocol is defined. Thus 5 is the correct value for the nelts here. Not 5 or 10 depending on the architecture. More info on the confusion https://bugs.freedesktop.org/show_bug.cgi?id=16802

b48e54aa

2015-01-26T22:00:29

Fixed bug 2802 - [patch] Fix android build compiling in wrong filesystem implementation Jonas Kulla The configure script didn't differentiate between Linux and Android, unconditionally compiling in the unix implementation of SDL_sysfilesystem.c. I'm probably one of the very few people building SDL for android using classic configure + standalone toolchain, so this has gone undetected all along.

70438be2

2014-12-03T10:55:23

WinRT: fixed bug whereby SDL would override an app's default orientation WinRT apps can set a default, preferred orientation via a .appxmanifest file. SDL was overriding this on app startup, and making the app use all possible orientations (landscape and portrait). Thanks to Eric Wing for the heads up on this!

9c398852

2014-11-22T22:20:40

Corrected header file documentation comment.

24c86b55

2014-09-11T19:24:42

[X11] Reconcile logical keyboard state with physical state on FocusIn since the window system doesn't do it for us like other platforms. This prevents sticky keys and missed keys when going in and out of focus, for example Alt would appear to stick if switching away from an SDL app with Alt-Tab and had to be pressed again. CR: Sam

f30e120a

2014-07-22T21:41:49

Added audio device buffer queueing API.

3dcb451f

2014-04-09T21:29:19

Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad.

58edac3e

2014-02-02T00:53:27

f848adff

2013-11-29T10:06:08

Improve Android pause/resume behavior.

1e49b1ed

2013-08-21T09:47:10

OCD fixes: Adds a space after /* (glory to regular expressions!)

695344d1

2013-08-21T09:43:09

OCD fixes: Adds a space before */

dad42067

2013-08-12T11:13:50

Fixes #2022, do not resume on Android when surfaceChanged If the app is in landscape mode and the user presses the power button, a pause is followed immediately by a surfaceChanged event because the lock screen is shown in portrait mode. This triggers a "false" resume. So, we just pause and resume following the onWindowFocusChanged events. Also, wait for SDL_APP_WILLENTERBACKGROUND and SDL_APP_DIDENTERBACKGROUND before blocking the event pump.

1ad936eb

2013-08-11T19:56:43

Fixed bug 2027 - Full-screen appears to be broken - hang in SDL_DestroyWindow() Rainer Deyke I'm running Linux Mint 15 with the Cinnamon window manager. SDL_DestroyWindow consistently locks up for me when the window if fullscreen.

kc3-lang/SDL/include/SDL_audio.h

include/SDL_audio.h

Log