Files
SDL/include/SDL3/SDL_platform_defines.h
Anders Jenbo a8ecd677ed Add DOS platform support (DJGPP) (#15377)
* dos: Some initial work.

* dos: Turn off buffer on stdio SDL_IOStreams.

Seeking breaks otherwise. We might be able to just fflush() before or seeking
instead?

* dos: Audio implementation using the Sound Blaster 16.

* dos: remove audio Pump interface.

Turns out DosBox-X was having trouble with the Sound Blaster or something;
standard DosBox works correctly directly from the interrupt handler, and
without doubling the buffer size.

* dos: just dump and restore the stdio buffer when seeking.

This is MUCH faster than just leaving buffering disabled, and also works
around getting bogus reads after an fseek. SDL_LoadWAV on test/sample.wav
no longer takes several seconds to finish, and comes up with the correct
data.

I wonder if we're triggering this in LoadWAV because we're malloc'ing data
between seeks/reads, and it's causing the djgpp transfer buffer to change. Or
maybe the Fat DS trick is confusing it? I don't know, I haven't had time to
debug it, it might just be a legit libc bug in djgpp too, for all I know.

* dos: Protect audio device "thread" iterations when streams are locked.

This uses an old trick we used in SDL 1.2 for MacOS Classic, which did its
audio callback in a hardware interrupt. If the audio is locked when the
interrupt fires, make a note of it and return immediately. When the lock is
released, if the interrupt has been fired, run the audio device iteration
right then.

Since there isn't a big device lock in SDL3 (available to the app, at least),
this keeps a counter of when any SDL_AudioStream is locked, which is probably
good enough.

* dos: Implemented initial video subsystem.

This uses VESA interfaces to manage the display and works with the software
renderer.

Events aren't hooked up yet, so prepare to close DosBox on each run.  :)

* dos: Whoops, forgot to add these to revision control. Core and Main support.

* dos: Wired up basic filesystem support.

This gets most of the rendering examples, which use SDL_GetBasePath() to
find textures to load, working.

* dos: Fixed compiler warning.

* dos: Initial mouse support!

* dos: Move interrupt hooking code into core/dos.

* dos: Initial keyboard support!

* dos: Use a simple ring buffer for keyboard events.

Of course Quake 1 solved this better, haha. It's smart: less memory, dirt
simple, and you don't even have to worry about synchronizing with the
interrupt handler, because it's safe for both sides no matter when an
interrupt fires.

* ci: add djgpp job

[sdl-ci-filter djgpp]
[sdl-ci-artifacts]

* dos: Fix build issues after rebase onto current main

- SDL_runapp.c: Add SDL_PLATFORM_DOS to the exclusion list so the
  generic
  SDL_RunApp() is disabled when the DOS-specific one is compiled.
- SDL.c: Exclude SDL_Gtk_Quit() on DOS. DJGPP defines __unix__ which
  sets
  SDL_PLATFORM_UNIX, but DOS has no GTK/display server. The GTK source
  is not compiled (CMake UNIX is false for DOS) so this was a link
  error.
- sdlplatform.cmake: Add DOS case to SDL_DetectCMakePlatform so the
  platform is properly detected from CMAKE_SYSTEM_NAME=DOS.
- i586-pc-msdosdjgpp.cmake: Add i386-pc-msdosdjgpp-gcc as a fallback
  compiler name, since some DJGPP toolchain builds use the i386 prefix.

* Add 8-bit palette support to DOS VESA driver

* Add VBE page-flipping, state restore, and robust keyboard handling

- Implement double-buffered page-flipping for VBE modes with >1 image
  page
- Save and restore full VBE state on video init/quit for clean mode
  switching
- Improve DOS keyboard handling: support extended scancodes and Pause
  key
- Lock ISR code/data to prevent page faults during interrupts
- Always vsync when blitting in single-buffered modes to reduce tearing

* Refactor Sound Blaster audio mixing to main loop

Move audio mixing out of IRQ handler to main loop for improved
stability and to avoid reentrancy issues. Add SDL_DOS_PumpAudio
function, update DMA buffer handling, and adjust sample rate to 22050
Hz.
Silence stale DMA buffer halves to prevent stutter during load.

* Add DOS timer support and update build config

* Add support for pre-SB16 8-bit mono Sound Blaster audio

Detect SB version and select 8-bit mono or 16-bit stereo mode.
Handle DMA and DSP setup for both SB16 and pre-SB16 hardware.
Add FORCE_SB_8BIT option for testing in DOSBox.

* Add SB Pro stereo support and simplify IRQ handler

* Add DOS joystick driver support

* Improve DOS hardware handling and clarify memory allocation

- Poll Sound Blaster DSP status instead of fixed delay after speaker-on
- Clarify DPMI conventional memory is always locked; update comments
- Document and justify DMA memory allocation strategy
- Free IRET wrapper after restoring interrupt vector to avoid leaks
- Throttle joystick axis polling to ~60 Hz to reduce BIOS timing loop
  cost
- Always poll joystick buttons directly for responsiveness

* Query and use mouse sensitivity from INT 33h function 0x1B

* Add support for VESA banked framebuffer modes

Implement banked framebuffer access for VBE 1.2+ modes without LFB.
Detect and initialize banked modes, copy framebuffer data using bank
switching, and blank the framebuffer on mode set. Page-flipping is
disabled in banked mode.

* Add optional vsync to page flipping in DOS VESA driver

* Add cooperative threading support for DOS platform

* Move SoundBlaster audio mixing to SDL audio thread

* Fix DOS platform comments and workarounds for DJGPP support

* Fix SoundBlaster IRQ handling and DMA setup for DOS

- Pass IRQ number to DOS_EndOfInterrupt and handle slave PIC EOI
- Validate DMA channel from BLASTER variable
- Correct DMA page register selection for SB16
- Improve BLASTER variable parsing and error messages
- Unmask/mask IRQs on correct PIC in DOS_HookInterrupt
- Rename SDL_dosjoystick.c to SDL_sysjoystick.c
- Include SDL_main_callbacks.h in SDL_sysmain_runapp.c
- Add include guard to SDL_systhread_c.h

* Add DOS platform options and preseed cache for DJGPP

Disable unsupported SDL features when building for DOS. Add
PreseedDOSCache.cmake to pre-populate CMake cache variables for DJGPP.

* cmake: use a 8.3 naming scheme for tests on DOS

* Apply code style

* Update include/SDL3/SDL_platform_defines.h

Co-authored-by: Anonymous Maarten <madebr@users.noreply.github.com>

* Code review clean up

- Split DOS VESA mode-setting into its own file
- Replace magic numbers with named constants
- Update copyright dates to 2026
- Substract time taken by other threads form delays

* Fix DOS bugs and improve compatibility

- Disable fseeko64 for DJGPP due to broken implementation
- Refactor DOS timer delay to always yield and avoid busy-waiting
- Fix animated cursor rendering in DOS VESA backend
- Always set display mode when creating DOS VESA window
- Work around DJGPP allowing invalid file access in testfile.c
- Bump max threads to 16
- Apply workarounds for threading tests

* Add DOS platform documentation and fix a few issues

- Fix fullscreen default resolution
- Improve best mode matching
- Fix builds on GCC older than 7.0
- Fix text input events

* Fix keyboard mapping of "*"

* Fix running, and existing, under PCem

* Apply suggestions from code review

Co-authored-by: Cameron Cawley <ccawley2011@gmail.com>

* Pre-mix audio in ring buffer and copy to DMA via IRQ thread

* Video fixes and optimizations

* DOS: Fix Intel 740 and VGA compatability

* DOS: Update readme

* DOS: Fix thread ID, get GPU name

* DOS: Cap mouse range

* DOS: Map test resources to 8.3 names

* DOS: Skip unsupported WM color modes

* Fix "windowed" resolution selection

* DOS: Hide INDEX8 modes behind SDL_DOS_ALLOW_INDEX8_MODES

* Remove SDL_HINT_DOS_ALLOW_INDEX8_MODES and order modes logically

* Don't convert cursor if dest is not INDEX8

---------

Co-authored-by: Ryan C. Gordon <icculus@icculus.org>
Co-authored-by: Anonymous Maarten <anonymous.maarten@gmail.com>
Co-authored-by: Cameron Cawley <ccawley2011@gmail.com>
Co-authored-by: Gleb Mazovetskiy <glex.spb@gmail.com>
Co-authored-by: Jay Petacat <jay@jayschwa.net>
Tested-by: Cameron Cawley <ccawley2011@gmail.com>
2026-04-23 19:54:49 -04:00

508 lines
12 KiB
C

/*
Simple DirectMedia Layer
Copyright (C) 1997-2026 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/* WIKI CATEGORY: Platform */
/*
* SDL_platform_defines.h tries to get a standard set of platform defines.
*/
#ifndef SDL_platform_defines_h_
#define SDL_platform_defines_h_
#ifdef _AIX
/**
* A preprocessor macro that is only defined if compiling for AIX.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_AIX 1
#endif
#ifdef __HAIKU__
/**
* A preprocessor macro that is only defined if compiling for Haiku OS.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_HAIKU 1
#endif
#if defined(bsdi) || defined(__bsdi) || defined(__bsdi__)
/**
* A preprocessor macro that is only defined if compiling for BSDi
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_BSDI 1
#endif
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
/**
* A preprocessor macro that is only defined if compiling for FreeBSD.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_FREEBSD 1
#endif
#if defined(hpux) || defined(__hpux) || defined(__hpux__)
/**
* A preprocessor macro that is only defined if compiling for HP-UX.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_HPUX 1
#endif
#if defined(sgi) || defined(__sgi) || defined(__sgi__) || defined(_SGI_SOURCE)
/**
* A preprocessor macro that is only defined if compiling for IRIX.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_IRIX 1
#endif
#if (defined(linux) || defined(__linux) || defined(__linux__))
/**
* A preprocessor macro that is only defined if compiling for Linux.
*
* Note that Android, although ostensibly a Linux-based system, will not
* define this. It defines SDL_PLATFORM_ANDROID instead.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_LINUX 1
#endif
#if defined(ANDROID) || defined(__ANDROID__)
/**
* A preprocessor macro that is only defined if compiling for Android.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_ANDROID 1
#undef SDL_PLATFORM_LINUX
#endif
#if defined(__unix__) || defined(__unix) || defined(unix)
/**
* A preprocessor macro that is only defined if compiling for a Unix-like
* system.
*
* Other platforms, like Linux, might define this in addition to their primary
* define.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_UNIX 1
#endif
#ifdef __APPLE__
/**
* A preprocessor macro that is only defined if compiling for Apple platforms.
*
* iOS, macOS, etc will additionally define a more specific platform macro.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_MACOS
* \sa SDL_PLATFORM_IOS
* \sa SDL_PLATFORM_TVOS
* \sa SDL_PLATFORM_VISIONOS
*/
#define SDL_PLATFORM_APPLE 1
/* lets us know what version of macOS we're compiling on */
#include <AvailabilityMacros.h>
#ifndef __has_extension /* Older compilers don't support this */
#define __has_extension(x) 0
#include <TargetConditionals.h>
#undef __has_extension
#else
#include <TargetConditionals.h>
#endif
/* Fix building with older SDKs that don't define these
See this for more information:
https://stackoverflow.com/questions/12132933/preprocessor-macro-for-os-x-targets
*/
#ifndef TARGET_OS_MACCATALYST
#define TARGET_OS_MACCATALYST 0
#endif
#ifndef TARGET_OS_IOS
#define TARGET_OS_IOS 0
#endif
#ifndef TARGET_OS_IPHONE
#define TARGET_OS_IPHONE 0
#endif
#ifndef TARGET_OS_TV
#define TARGET_OS_TV 0
#endif
#ifndef TARGET_OS_SIMULATOR
#define TARGET_OS_SIMULATOR 0
#endif
#ifndef TARGET_OS_VISION
#define TARGET_OS_VISION 0
#endif
#if TARGET_OS_TV
/**
* A preprocessor macro that is only defined if compiling for tvOS.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_APPLE
*/
#define SDL_PLATFORM_TVOS 1
#endif
#if TARGET_OS_VISION
/**
* A preprocessor macro that is only defined if compiling for visionOS.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_APPLE
*/
#define SDL_PLATFORM_VISIONOS 1
#endif
#if TARGET_OS_IPHONE
/**
* A preprocessor macro that is only defined if compiling for iOS or visionOS.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_APPLE
*/
#define SDL_PLATFORM_IOS 1
#else
/**
* A preprocessor macro that is only defined if compiling for macOS.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_APPLE
*/
#define SDL_PLATFORM_MACOS 1
#if MAC_OS_X_VERSION_MIN_REQUIRED < 1070
#error SDL for macOS only supports deploying on 10.7 and above.
#endif /* MAC_OS_X_VERSION_MIN_REQUIRED < 1070 */
#endif /* TARGET_OS_IPHONE */
#endif /* defined(__APPLE__) */
#ifdef __EMSCRIPTEN__
/**
* A preprocessor macro that is only defined if compiling for Emscripten.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_EMSCRIPTEN 1
#endif
#ifdef __NetBSD__
/**
* A preprocessor macro that is only defined if compiling for NetBSD.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_NETBSD 1
#endif
#ifdef __OpenBSD__
/**
* A preprocessor macro that is only defined if compiling for OpenBSD.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_OPENBSD 1
#endif
#if defined(__OS2__) || defined(__EMX__)
/**
* A preprocessor macro that is only defined if compiling for OS/2.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_OS2 1
#endif
#if defined(osf) || defined(__osf) || defined(__osf__) || defined(_OSF_SOURCE)
/**
* A preprocessor macro that is only defined if compiling for Tru64 (OSF/1).
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_OSF 1
#endif
#if defined(__QNXNTO__) || defined(__QNX__)
/**
* A preprocessor macro that is only defined if compiling for QNX Neutrino.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_QNXNTO 1
#endif
#if defined(riscos) || defined(__riscos) || defined(__riscos__)
/**
* A preprocessor macro that is only defined if compiling for RISC OS.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_RISCOS 1
#endif
#if defined(__sun) && defined(__SVR4)
/**
* A preprocessor macro that is only defined if compiling for SunOS/Solaris.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_SOLARIS 1
#endif
#if defined(__CYGWIN__)
/**
* A preprocessor macro that is only defined if compiling for Cygwin.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_CYGWIN 1
#endif
#if (defined(_WIN32) || defined(SDL_PLATFORM_CYGWIN)) && !defined(__NGAGE__)
/**
* A preprocessor macro that is only defined if compiling for Windows.
*
* This also covers several other platforms, like Microsoft GDK, Xbox, WinRT,
* etc. Each will have their own more-specific platform macros, too.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PLATFORM_WIN32
* \sa SDL_PLATFORM_XBOXONE
* \sa SDL_PLATFORM_XBOXSERIES
* \sa SDL_PLATFORM_WINGDK
* \sa SDL_PLATFORM_GDK
*/
#define SDL_PLATFORM_WINDOWS 1
/* Try to find out if we're compiling for WinRT, GDK or non-WinRT/GDK */
#if defined(_MSC_VER) && defined(__has_include)
#if __has_include(<winapifamily.h>)
#define HAVE_WINAPIFAMILY_H 1
#else
#define HAVE_WINAPIFAMILY_H 0
#endif
/* If _USING_V110_SDK71_ is defined it means we are using the Windows XP toolset. */
#elif defined(_MSC_VER) && (_MSC_VER >= 1700 && !_USING_V110_SDK71_) /* _MSC_VER == 1700 for Visual Studio 2012 */
#define HAVE_WINAPIFAMILY_H 1
#else
#define HAVE_WINAPIFAMILY_H 0
#endif
#if HAVE_WINAPIFAMILY_H
#include <winapifamily.h>
#define WINAPI_FAMILY_WINRT (!WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP))
#else
#define WINAPI_FAMILY_WINRT 0
#endif /* HAVE_WINAPIFAMILY_H */
#ifdef SDL_WIKI_DOCUMENTATION_SECTION
/**
* A preprocessor macro that defined to 1 if compiling for Windows Phone.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_WINAPI_FAMILY_PHONE (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
#elif defined(HAVE_WINAPIFAMILY_H) && HAVE_WINAPIFAMILY_H
#define SDL_WINAPI_FAMILY_PHONE (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
#else
#define SDL_WINAPI_FAMILY_PHONE 0
#endif
#if WINAPI_FAMILY_WINRT
#error Windows RT/UWP is no longer supported in SDL
#elif defined(_GAMING_DESKTOP) /* GDK project configuration always defines _GAMING_XXX */
/**
* A preprocessor macro that is only defined if compiling for Microsoft GDK
* for Windows.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_WINGDK 1
#elif defined(_GAMING_XBOX_XBOXONE)
/**
* A preprocessor macro that is only defined if compiling for Xbox One.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_XBOXONE 1
#elif defined(_GAMING_XBOX_SCARLETT)
/**
* A preprocessor macro that is only defined if compiling for Xbox Series.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_XBOXSERIES 1
#else
/**
* A preprocessor macro that is only defined if compiling for desktop Windows.
*
* Despite the "32", this also covers 64-bit Windows; as an informal
* convention, its system layer tends to still be referred to as "the Win32
* API."
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_WIN32 1
#endif
#endif /* defined(_WIN32) || defined(SDL_PLATFORM_CYGWIN) */
/* This is to support generic "any GDK" separate from a platform-specific GDK */
#if defined(SDL_PLATFORM_WINGDK) || defined(SDL_PLATFORM_XBOXONE) || defined(SDL_PLATFORM_XBOXSERIES)
/**
* A preprocessor macro that is only defined if compiling for Microsoft GDK on
* any platform.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_GDK 1
#endif
#if defined(__PSP__) || defined(__psp__)
/**
* A preprocessor macro that is only defined if compiling for Sony PSP.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_PSP 1
#endif
#if defined(__PS2__) || defined(PS2)
/**
* A preprocessor macro that is only defined if compiling for Sony PlayStation
* 2.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_PS2 1
#endif
#if defined(__vita__) || defined(__psp2__)
/**
* A preprocessor macro that is only defined if compiling for Sony Vita.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_VITA 1
#endif
#ifdef __3DS__
/**
* A preprocessor macro that is only defined if compiling for Nintendo 3DS.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_PLATFORM_3DS 1
#endif
#ifdef __NGAGE__
/**
* A preprocessor macro that is only defined if compiling for the Nokia
* N-Gage.
*
* \since This macro is available since SDL 3.4.0.
*/
#define SDL_PLATFORM_NGAGE 1
#endif
#ifdef __MSDOS__
/**
* A preprocessor macro that is only defined if compiling for MS-DOS.
*
* \since This macro is available since SDL 3.6.0.
*/
#define SDL_PLATFORM_DOS 1
#endif
#ifdef __GNU__
/**
* A preprocessor macro that is only defined if compiling for GNU/Hurd.
*
* \since This macro is available since SDL 3.4.0.
*/
#define SDL_PLATFORM_HURD 1
#endif
#endif /* SDL_platform_defines_h_ */