Mercurial > sdl-ios-xcode
annotate src/video/dga/SDL_dgavideo.h @ 4139:568c9b3c0167 SDL-1.2
* 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.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 29 Feb 2008 13:55:44 +0000 |
parents | 6f7af895ab02 |
children | 904defc0792e |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
5 This library is free software; you can redistribute it and/or | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
0 | 7 License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
10 This library is distributed in the hope that it will be useful, | |
11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
13 Lesser General Public License for more details. |
0 | 14 |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
19 Sam Lantinga | |
252
e8157fcb3114
Updated the source with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
105
diff
changeset
|
20 slouken@libsdl.org |
0 | 21 */ |
1402
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1361
diff
changeset
|
22 #include "SDL_config.h" |
0 | 23 |
24 #ifndef _SDL_dgavideo_h | |
25 #define _SDL_dgavideo_h | |
26 | |
27 #include <X11/Xlib.h> | |
4056
6f7af895ab02
A better fix for building DGA code on Solaris 8, inspired by the NetBSD pkgsrc patch.
Sam Lantinga <slouken@libsdl.org>
parents:
1792
diff
changeset
|
28 #include <X11/Xlibint.h> |
1792
409974dedf2e
More compile fixes for systems without the DPMS extension
Sam Lantinga <slouken@libsdl.org>
parents:
1784
diff
changeset
|
29 #include <X11/Xproto.h> |
0 | 30 |
31 #include "SDL_mouse.h" | |
32 #include "SDL_mutex.h" | |
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
33 #include "../SDL_sysvideo.h" |
0 | 34 |
35 /* Hidden "this" pointer for the video functions */ | |
36 #define _THIS SDL_VideoDevice *this | |
37 | |
101
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
38 /* Define this if you need the DGA driver to be thread-safe */ |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
39 #define LOCK_DGA_DISPLAY |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
40 #ifdef LOCK_DGA_DISPLAY |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
41 #define LOCK_DISPLAY() SDL_mutexP(event_lock) |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
42 #define UNLOCK_DISPLAY() SDL_mutexV(event_lock) |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
43 #else |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
44 #define LOCK_DISPLAY() |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
45 #define UNLOCK_DISPLAY() |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
46 #endif |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
47 |
0 | 48 |
49 /* This is the structure we use to keep track of video memory */ | |
50 typedef struct vidmem_bucket { | |
51 struct vidmem_bucket *prev; | |
101
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
52 int used; |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
53 int dirty; |
0 | 54 Uint8 *base; |
55 unsigned int size; | |
56 struct vidmem_bucket *next; | |
57 } vidmem_bucket; | |
58 | |
59 /* Private display data */ | |
60 struct SDL_PrivateVideoData { | |
61 Display *DGA_Display; | |
62 Colormap DGA_colormap; | |
63 int visualClass; | |
64 | |
65 #define NUM_MODELISTS 4 /* 8, 16, 24, and 32 bits-per-pixel */ | |
66 int SDL_nummodes[NUM_MODELISTS]; | |
67 SDL_Rect **SDL_modelist[NUM_MODELISTS]; | |
68 | |
69 /* Information for the video surface */ | |
70 Uint8 *memory_base; | |
71 int memory_pitch; | |
72 SDL_mutex *hw_lock; | |
73 int sync_needed; | |
74 int was_flipped; | |
75 | |
76 /* Information for hardware surfaces */ | |
77 vidmem_bucket surfaces; | |
78 int surfaces_memtotal; | |
79 int surfaces_memleft; | |
80 | |
81 /* Information for double-buffering */ | |
82 int flip_page; | |
83 int flip_yoffset[2]; | |
84 Uint8 *flip_address[2]; | |
85 | |
86 /* Used to handle DGA events */ | |
87 int event_base; | |
101
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
88 #ifdef LOCK_DGA_DISPLAY |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
89 SDL_mutex *event_lock; |
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
90 #endif |
1784
45669d4efd02
Disable the screensaver in DGA mode, which is even more important than X11...
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
91 |
45669d4efd02
Disable the screensaver in DGA mode, which is even more important than X11...
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
92 /* Screensaver settings */ |
4139
568c9b3c0167
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
Sam Lantinga <slouken@libsdl.org>
parents:
4056
diff
changeset
|
93 int allow_screensaver; |
0 | 94 }; |
4139
568c9b3c0167
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
Sam Lantinga <slouken@libsdl.org>
parents:
4056
diff
changeset
|
95 |
0 | 96 /* Old variable names */ |
97 #define DGA_Display (this->hidden->DGA_Display) | |
98 #define DGA_Screen DefaultScreen(DGA_Display) | |
99 #define DGA_colormap (this->hidden->DGA_colormap) | |
100 #define DGA_visualClass (this->hidden->visualClass) | |
101 #define memory_base (this->hidden->memory_base) | |
102 #define memory_pitch (this->hidden->memory_pitch) | |
103 #define flip_page (this->hidden->flip_page) | |
104 #define flip_yoffset (this->hidden->flip_yoffset) | |
105 #define flip_address (this->hidden->flip_address) | |
106 #define sync_needed (this->hidden->sync_needed) | |
107 #define was_flipped (this->hidden->was_flipped) | |
108 #define SDL_nummodes (this->hidden->SDL_nummodes) | |
109 #define SDL_modelist (this->hidden->SDL_modelist) | |
110 #define surfaces (this->hidden->surfaces) | |
111 #define surfaces_memtotal (this->hidden->surfaces_memtotal) | |
112 #define surfaces_memleft (this->hidden->surfaces_memleft) | |
113 #define hw_lock (this->hidden->hw_lock) | |
114 #define DGA_event_base (this->hidden->event_base) | |
101
825b2fa28e2e
DGA video driver is now thread-safe
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
115 #define event_lock (this->hidden->event_lock) |
4139
568c9b3c0167
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
Sam Lantinga <slouken@libsdl.org>
parents:
4056
diff
changeset
|
116 #define allow_screensaver (this->hidden->allow_screensaver) |
0 | 117 |
118 #endif /* _SDL_dgavideo_h */ |