include/SDL_config_win32.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 29 Feb 2008 13:55:44 +0000
branchSDL-1.2
changeset 4139 568c9b3c0167
parent 3974 42578e98a295
child 4159 a1b03ba2fcd0
permissions -rw-r--r--
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
* Use XResetScreenSaver() instead of disabling screensaver entirely.

Full discussion summary from Erik on the SDL mailing list:

Current behaviour
=================

SDL changes the user's display power management settings without
permission from the user and without telling the user.

The interface that it uses to do so is DPMSDisable/DPMSEnable, which
should only ever be used by configuration utilities like KControl, never
by normal application programs, let alone by the libraries that they
use. Using an interface that is not at all intended for what SDL tries
to achieve means that it will not work as it should. Firstly, the power
management is completely disabled during the whole lifetime of the SDL
program, not only when it should be. Secondly, it makes SDL
non-reentrant, meaning that things will break when multiple SDL programs
are clients of the same X server simultaneously. Thirdly, no cleanup
mechanism ensures that the setting is restored if the client does not do
that (for example if it crashes).

In addition to that, this interface is broken on xorg,
[http://bugs.freedesktop.org/show_bug.cgi?id=13962], so what SDL tries
to do does not work at all on that implementation of the X Window
System. (The reason that the DPMSEnable works in KControl is that it
calls DPMSSetTimeout immediately after,
[http://websvn.kde.org/tags/KDE/3.5.9/kdebase/kcontrol/energy/energy.cpp?annotate=774532#l343]).


The problems that the current behaviour causes
==============================================
1. Information leak. When the user is away, someone might see what the
user has on the display when the user counts on the screensaver
preventing this. This does not even require physical access to the
workstation, it is enough to see it from a distance.
2. Draining battery. An SDL program that runs on a laptop will quickly
drain the battery while the user is away. The system will soon shut down
and require recharging before being usable again, while it should in
fact have consumed very little energy if the user's settings would have
been obeyed.
3. Wasting energy. Even if battery issues are not considered, energy as
such is wasted.
4. Display wear. The display may be worn out.


The problems that the current behaviour tries to solve
======================================================

1. Preventing screensaver while playing movies.
Many SDL applications are media players. They have reasons to prevent
screensavers from being activated while a movie is being played. When a
user clicks on the play button it can be interpreted as saying "play
this movie, but do not turn off the display while playing it, because I
will watch it even though I do not interact with the system".

2. Preventing screensaver when some input bypasses X.
Sometimes SDL uses input from another source than the X server, so
that the X server is bypassed. This obviously breaks the screensaver
handling. SDL tries to work around that.

3. Preventing screensaver when all input bypasses X.
There is something called Direct Graphics Access mode, where a
program takes control of both the display and the input devices from the
X server. This obviously means that the X server can not handle the
screensaver alone, since screensaver handling depends on input handling.
SDL does not do what it should to help the X server to handle the
screensaver. Nor does SDL take care of screeensaver handling itself. SDL
simply disables the screensaver completely.


How the problems should be solved
=================================

The correct way for an application program to prevent the screensaver
under X is to call XResetScreenSaver. This was recently discovered and
implemented by the mplayer developers,
[http://svn.mplayerhq.hu/mplayer?view=rev&revision=25637]. SDL needs to
wrap this in an API call (SDL_ResetScreenSaver) and implement it for the
other video targets (if they do not have a corresponding call, SDL
should do what it takes on that particular target, for example sending
fake key events).

1. When a movie is played, the player should reset the screensaver when
the animation is advanced to a new frame. The same applies to anything
similar, like slideshows.

2. When the X server is handling input, it must handle all input
(keyboards, mice, gamepads, ...). This is necessary, not only to be able
to handle the screensaver, but also so that it can send the events to
the correct (the currently active) client. If there is an input device
that the X server can not handle for some reason (such as lack of Plug
and Play capability), the program that handles the device as a
workaround must simulate what would happen if the X server would have
handled the device, by calling XResetScreenSaver when input is received
from the device.

3. When the X server is not handling the input, it depends on the
program that does to call XResetScreenSaver whenever an input event
occurs. Alternatively the program must handle the screensaver countdown
internally and call XActivateScreenSaver.
slouken@1422
     1
/*
slouken@1422
     2
    SDL - Simple DirectMedia Layer
slouken@1422
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@1422
     4
slouken@1422
     5
    This library is free software; you can redistribute it and/or
slouken@1422
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1422
     7
    License as published by the Free Software Foundation; either
slouken@1422
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1422
     9
slouken@1422
    10
    This library is distributed in the hope that it will be useful,
slouken@1422
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1422
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1422
    13
    Lesser General Public License for more details.
slouken@1422
    14
slouken@1422
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1422
    16
    License along with this library; if not, write to the Free Software
slouken@1422
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1422
    18
slouken@1422
    19
    Sam Lantinga
slouken@1422
    20
    slouken@libsdl.org
slouken@1422
    21
*/
slouken@1422
    22
slouken@1422
    23
#ifndef _SDL_config_win32_h
slouken@1422
    24
#define _SDL_config_win32_h
slouken@1608
    25
slouken@1608
    26
#include "SDL_platform.h"
slouken@1422
    27
slouken@1422
    28
/* This is a set of defines to configure the SDL features */
slouken@1422
    29
icculus@3911
    30
#if defined(__GNUC__) || defined(__DMC__)
slouken@1885
    31
#define HAVE_STDINT_H	1
slouken@1885
    32
#elif defined(_MSC_VER)
slouken@1465
    33
typedef signed __int8		int8_t;
slouken@1423
    34
typedef unsigned __int8		uint8_t;
slouken@1465
    35
typedef signed __int16		int16_t;
slouken@1423
    36
typedef unsigned __int16	uint16_t;
slouken@1465
    37
typedef signed __int32		int32_t;
slouken@1423
    38
typedef unsigned __int32	uint32_t;
slouken@1465
    39
typedef signed __int64		int64_t;
slouken@1423
    40
typedef unsigned __int64	uint64_t;
slouken@1465
    41
#ifndef _UINTPTR_T_DEFINED
slouken@1465
    42
#ifdef  _WIN64
slouken@1465
    43
typedef unsigned __int64    uintptr_t;
slouken@1465
    44
#else
slouken@1465
    45
typedef unsigned int   uintptr_t;
slouken@1465
    46
#endif
slouken@1465
    47
#define _UINTPTR_T_DEFINED
slouken@1465
    48
#endif
icculus@3973
    49
/* Older Visual C++ headers don't have the Win64-compatible typedefs... */
icculus@3973
    50
#if ((_MSC_VER <= 1200) && (!defined(DWORD_PTR)))
icculus@3973
    51
#define DWORD_PTR DWORD
icculus@3973
    52
#endif
icculus@3973
    53
#if ((_MSC_VER <= 1200) && (!defined(LONG_PTR)))
icculus@3973
    54
#define LONG_PTR LONG
icculus@3973
    55
#endif
slouken@1885
    56
#else	/* !__GNUC__ && !_MSC_VER */
slouken@1465
    57
typedef signed char int8_t;
slouken@1465
    58
typedef unsigned char uint8_t;
slouken@1465
    59
typedef signed short int16_t;
slouken@1465
    60
typedef unsigned short uint16_t;
slouken@1465
    61
typedef signed int int32_t;
slouken@1465
    62
typedef unsigned int uint32_t;
slouken@1465
    63
typedef signed long long int64_t;
slouken@1465
    64
typedef unsigned long long uint64_t;
slouken@1471
    65
#ifndef _SIZE_T_DEFINED_
slouken@1471
    66
#define _SIZE_T_DEFINED_
slouken@1465
    67
typedef unsigned int size_t;
slouken@1471
    68
#endif
slouken@1470
    69
typedef unsigned int uintptr_t;
slouken@1885
    70
#endif /* __GNUC__ || _MSC_VER */
slouken@1422
    71
#define SDL_HAS_64BIT_TYPE	1
slouken@1422
    72
slouken@1471
    73
/* Enabled for SDL 1.2 (binary compatibility) */
slouken@1473
    74
#define HAVE_LIBC	1
slouken@1626
    75
#ifdef HAVE_LIBC
slouken@1422
    76
/* Useful headers */
slouken@1471
    77
#define HAVE_STDIO_H 1
slouken@1471
    78
#define STDC_HEADERS 1
slouken@1471
    79
#define HAVE_STRING_H 1
slouken@1471
    80
#define HAVE_CTYPE_H 1
slouken@1471
    81
#define HAVE_MATH_H 1
slouken@1471
    82
#ifndef _WIN32_WCE
slouken@1471
    83
#define HAVE_SIGNAL_H 1
slouken@1471
    84
#endif
slouken@1471
    85
slouken@1471
    86
/* C library functions */
slouken@1471
    87
#define HAVE_MALLOC 1
slouken@1471
    88
#define HAVE_CALLOC 1
slouken@1471
    89
#define HAVE_REALLOC 1
slouken@1471
    90
#define HAVE_FREE 1
slouken@1471
    91
#define HAVE_ALLOCA 1
slouken@1471
    92
#define HAVE_QSORT 1
slouken@1471
    93
#define HAVE_ABS 1
slouken@1471
    94
#define HAVE_MEMSET 1
slouken@1471
    95
#define HAVE_MEMCPY 1
slouken@1471
    96
#define HAVE_MEMMOVE 1
slouken@1471
    97
#define HAVE_MEMCMP 1
slouken@1471
    98
#define HAVE_STRLEN 1
slouken@1471
    99
#define HAVE__STRREV 1
slouken@1471
   100
#define HAVE__STRUPR 1
slouken@1471
   101
#define HAVE__STRLWR 1
slouken@1471
   102
#define HAVE_STRCHR 1
slouken@1471
   103
#define HAVE_STRRCHR 1
slouken@1471
   104
#define HAVE_STRSTR 1
slouken@1471
   105
#define HAVE_ITOA 1
slouken@1471
   106
#define HAVE__LTOA 1
slouken@1471
   107
#define HAVE__ULTOA 1
slouken@1471
   108
#define HAVE_STRTOL 1
slouken@1471
   109
#define HAVE_STRTOUL 1
slouken@1471
   110
#define HAVE_STRTOLL 1
slouken@1471
   111
#define HAVE_STRTOD 1
slouken@1471
   112
#define HAVE_ATOI 1
slouken@1471
   113
#define HAVE_ATOF 1
slouken@1471
   114
#define HAVE_STRCMP 1
slouken@1471
   115
#define HAVE_STRNCMP 1
slouken@1510
   116
#define HAVE__STRICMP 1
slouken@1512
   117
#define HAVE__STRNICMP 1
slouken@1471
   118
#define HAVE_SSCANF 1
slouken@1471
   119
#else
slouken@1422
   120
#define HAVE_STDARG_H	1
slouken@1422
   121
#define HAVE_STDDEF_H	1
slouken@1471
   122
#endif
slouken@1422
   123
slouken@1422
   124
/* Enable various audio drivers */
slouken@1422
   125
#ifndef _WIN32_WCE
slouken@1422
   126
#define SDL_AUDIO_DRIVER_DSOUND	1
slouken@1422
   127
#endif
slouken@1422
   128
#define SDL_AUDIO_DRIVER_WAVEOUT	1
icculus@1532
   129
#define SDL_AUDIO_DRIVER_DISK	1
icculus@1532
   130
#define SDL_AUDIO_DRIVER_DUMMY	1
slouken@1422
   131
slouken@1422
   132
/* Enable various cdrom drivers */
slouken@1497
   133
#ifdef _WIN32_WCE
slouken@1497
   134
#define SDL_CDROM_DISABLED      1
slouken@1497
   135
#else
slouken@1497
   136
#define SDL_CDROM_WIN32		1
slouken@1497
   137
#endif
slouken@1422
   138
slouken@1422
   139
/* Enable various input drivers */
slouken@1497
   140
#ifdef _WIN32_WCE
slouken@1497
   141
#define SDL_JOYSTICK_DISABLED   1
slouken@1497
   142
#else
slouken@1855
   143
#define SDL_JOYSTICK_WINMM	1
slouken@1497
   144
#endif
slouken@1422
   145
slouken@1422
   146
/* Enable various shared object loading systems */
slouken@1422
   147
#define SDL_LOADSO_WIN32	1
slouken@1422
   148
slouken@1422
   149
/* Enable various threading systems */
slouken@1422
   150
#define SDL_THREAD_WIN32	1
slouken@1422
   151
slouken@1422
   152
/* Enable various timer systems */
slouken@1422
   153
#ifdef _WIN32_WCE
slouken@1422
   154
#define SDL_TIMER_WINCE	1
slouken@1422
   155
#else
slouken@1422
   156
#define SDL_TIMER_WIN32	1
slouken@1422
   157
#endif
slouken@1422
   158
slouken@1422
   159
/* Enable various video drivers */
slouken@1497
   160
#ifdef _WIN32_WCE
slouken@1497
   161
#define SDL_VIDEO_DRIVER_GAPI	1
slouken@1497
   162
#endif
slouken@1422
   163
#ifndef _WIN32_WCE
slouken@1422
   164
#define SDL_VIDEO_DRIVER_DDRAW	1
slouken@1422
   165
#endif
slouken@1533
   166
#define SDL_VIDEO_DRIVER_DUMMY	1
slouken@1422
   167
#define SDL_VIDEO_DRIVER_WINDIB	1
slouken@1422
   168
slouken@1422
   169
/* Enable OpenGL support */
slouken@1465
   170
#ifndef _WIN32_WCE
slouken@1422
   171
#define SDL_VIDEO_OPENGL	1
slouken@1422
   172
#define SDL_VIDEO_OPENGL_WGL	1
slouken@1465
   173
#endif
slouken@1422
   174
slouken@4139
   175
/* Disable screensaver */
slouken@4139
   176
#define SDL_VIDEO_DISABLE_SCREENSAVER	1
slouken@4139
   177
slouken@1480
   178
/* Enable assembly routines (Win64 doesn't have inline asm) */
slouken@1480
   179
#ifndef _WIN64
slouken@1422
   180
#define SDL_ASSEMBLY_ROUTINES	1
slouken@1480
   181
#endif
slouken@1422
   182
slouken@1422
   183
#endif /* _SDL_config_win32_h */