README.OS2
author Sam Lantinga <slouken@libsdl.org>
Sun, 26 Feb 2006 19:30:21 +0000
changeset 1442 e3242177fe4a
parent 1190 173c063d4f55
child 1659 14717b52abc0
permissions -rw-r--r--
Updated OS/2 build, yay!
     1 
     2 ===========
     3 SDL on OS/2
     4 ===========
     5 
     6 Last updated on Feb. 26, 2006.
     7 
     8 
     9 1. How to compile?
    10 ------------------
    11 
    12 To compile this, you'll need the followings installed:
    13 - The OS/2 Developer's Toolkit
    14 - The OpenWatcom compiler 
    15   (http://www.openwatcom.org)
    16 - The FSLib library
    17   (ftp://ftp.netlabs.org/pub/SDL)
    18 
    19 First of all, you have to put the OS/2-specific Watcom makefiles into the
    20 source code tree by unzipping the file Watcom-OS2.zip here.  This will
    21 result in a Watcom.mif and a setvars.cmd file in this folder, and several
    22 Makefile.wat files in the src\ folder and in some of its subfolders.
    23 
    24 Please edit the second, fourth and fifth lines of setvars.cmd file
    25 to set the folders where the toolkit, the OW compiler and the FSLib are. 
    26 You won't need NASM yet (The Netwide Assembler), you can leave that line.
    27 Run setvars.cmd, and you should get a shell in which you can
    28 compile SDL.
    29 
    30 Check the "Watcom.mif" file. This is the file which is included by all the
    31 Watcom makefiles, so changes here will affect the whole build process.
    32 There is a line in there which determines if the resulting SDL.DLL will be
    33 a 'debug' or a 'release' build. The 'debug' version is full of printf()'s,
    34 so if something goes wrong, its output can help a lot for debugging.
    35 
    36 Then go to the 'src' folder, and run "wmake -f makefile.wat".
    37 This should create the SDL.DLL and the corresponding SDL.LIB file there.
    38 
    39 To test applications, it's a good idea to use the 'debug' build of SDL, and
    40 redirect the standard output and standard error output to files, to see what
    41 happens internally in SDL.
    42 (like: testsprite >stdout.txt 2>stderr.txt)
    43 
    44 To rebuild SDL, use the following commands in 'src' folder:
    45 wmake -f makefile.wat clean
    46 wmake -f makefile.wat
    47 
    48 
    49 
    50 2. How to compile the testapps?
    51 -------------------------------
    52 
    53 Once you have SDL.DLL compiled, navigate into the 'test' folder, copy in there
    54 the newly built SDL.DLL, and copy in there FSLib.DLL.
    55 
    56 Then run "wmake -f makefile.wat" in there to compile some of the testapps.
    57 
    58 
    59 
    60 3. What is missing?
    61 -------------------
    62 
    63 The following things are missing from this SDL implementation:
    64 - MMX, SSE and 3DNOW! optimized video blitters?
    65 - HW Video surfaces
    66 - OpenGL support
    67 
    68 
    69 
    70 4. Special Keys / Full-Screen support
    71 -------------------------------------
    72 
    73 There are two special hot-keys implemented:
    74 - Alt+Home switches between fullscreen and windowed mode
    75 - Alt+End simulates closing the window (can be used as a Panic key)
    76 Only the LEFT Alt key will work.
    77 
    78 
    79 
    80 5. Joysticks on SDL/2
    81 ---------------------
    82 
    83 The Joystick detection only works for standard joysticks (2 buttons, 2 axes
    84 and the like). Therefore, if you use a non-standard joystick, you should
    85 specify its features in the SDL_OS2_JOYSTICK environment variable in a batch
    86 file or CONFIG.SYS, so SDL applications can provide full capability to your
    87 device. The syntax is:
    88 
    89 SET SDL_OS2_JOYSTICK=[JOYSTICK_NAME] [AXES] [BUTTONS] [HATS] [BALLS]
    90 
    91 So, it you have a Gravis GamePad with 4 axes, 2 buttons, 2 hats and 0 balls,
    92 the line should be:
    93 
    94 SET SDL_OS2_JOYSTICK=Gravis_GamePad 4 2 2 0
    95 
    96 If you want to add spaces in your joystick name, just surround it with
    97 quotes or double-quotes:
    98 
    99 SET SDL_OS2_JOYSTICK='Gravis GamePad' 4 2 2 0
   100 
   101 or
   102 
   103 SET SDL_OS2_JOYSTICK="Gravis GamePad" 4 2 2 0
   104 
   105    Notive However that Balls and Hats are not supported under OS/2, and the
   106 value will be ignored... but it is wise to define these correctly because 
   107 in the future those can be supported.
   108    Also the number of buttons is limited to 2 when using two joysticks,
   109 4 when using one joystick with 4 axes, 6 when using a joystick with 3 axes
   110 and 8 when using a joystick with 2 axes. Notice however these are limitations 
   111 of the Joystick Port hardware, not OS/2.
   112 
   113 
   114 
   115 6. Proportional windows
   116 -----------------------
   117 
   118 For some SDL applications it can be handy to have proportional windows, so
   119 the windows will keep their aspect ratio when resized.
   120 This can be achieved in two ways:
   121 
   122 - Before starting the given SDL application, set the
   123   SDL_USE_PROPORTIONAL_WINDOW environment variable to something, e.g.:
   124 
   125   SET SDL_USE_PROPORTIONAL_WINDOW=1
   126   dosbox.exe
   127 
   128 - If you have a HOME environment variable set, then SDL will look for a file
   129   in there called ".sdl.proportionals". If that file contains the name of the
   130   currently running SDL executable, then that process will have proportional
   131   windows automatically.
   132 
   133   Please note that this file is created automatically with default values
   134   at the first run.
   135 
   136 
   137 
   138 7. Audio in SDL applications
   139 ----------------------------
   140 
   141 Audio effects are one of the most important features in games. Creating audio
   142 effects in sync with the game and without hickups and pauses in the audio are
   143 very important things.
   144 
   145 However there are multithreaded SDL applications that have tight loops as their
   146 main logic loop. This kills performance in OS/2, and takes too much CPU from
   147 other threads in the same process, for example from the thread to create the 
   148 sound effects.
   149 
   150 For this reason, the OS/2 port of SDL can be instructed to run the audio thread
   151 in high priority, which makes sure that there will be enough time for the 
   152 processing of the audio data.
   153 
   154 At default, SDL/2 runs the audio thread at ForegroundServer+0 priority. Well 
   155 written and well behaving SDL applications should work well in this mode.
   156 For other applications, you can tell SDL/2 to run the audio thread at 
   157 TimeCritical priority by setting an env.variable before starting the SDL app:
   158 
   159     SET SDL_USE_TIMECRITICAL_AUDIO=1
   160 
   161 Please note that this is a bit risky, because if the SDL application runs a
   162 tight infinite loop in this thread, this will make the whole system 
   163 unresponsive, so use it with care, and only for applications that need it!
   164 
   165 
   166 
   167 8. Next steps...
   168 ----------------
   169 
   170 Things to do:
   171 - Implement missing stuffs (look for 'TODO' string in source code!)
   172 - Finish video driver (the 'wincommon' can be a good example for missing
   173   things like application icon and so on...)
   174 - Enable MMX/SSE/SSE2 acceleration functions
   175 - Rewrite CDROM support using DOS Ioctl for better support.
   176 
   177 
   178 
   179 9. Contacts
   180 -----------
   181 
   182    You can contact the developers for bugs:
   183 
   184    Area					Developer		email
   185    General (Audio/Video/System)		Doodle			doodle@scenergy.dfmk.hu
   186    CDROM and Joystick			Caetano			daniel@caetano.eng.br
   187 
   188    Notice however that SDL/2 is 'in development' stage so ... if you want to help,
   189 please, be our guest and contact us!
   190 
   191 
   192 
   193 10. Changelog of the OS/2 port
   194 ------------------------------
   195 
   196 Version 1.2 - 2006-02-26  - Doodle
   197  - Updated the official SDL version with the OS/2 specific changes.
   198  - Added support for real unicode keycode conversion.
   199 
   200 Version 1.2.7 - 2006-01-20  - Doodle
   201  - Added support for selectively using timecritical priority for
   202    audio threads by SDL_USE_TIMECRITICAL_AUDIO environment variable.
   203    (e.g.: 
   204     SET SDL_USE_TIMECRITICAL_AUDIO=1
   205     dosbox.exe
   206    )
   207 
   208 Version 1.2.7 - 2005-12-22  - Doodle
   209  - Added support for proportional SDL windows.
   210    There are two ways to have proportional (aspect-keeping) windows for
   211    a given SDL application: Either set the SDL_USE_PROPORTIONAL_WINDOW
   212    environment variable to something before starting the application
   213    (e.g.: 
   214     SET SDL_USE_PROPORTIONAL_WINDOW=1
   215     dosbox.exe
   216    )
   217    or, if you have the HOME environment variable set, then SDL.DLL will
   218    create a file in that directory called .sdl.proportionals, and you can
   219    put there the name of executable files that will be automatically made
   220    proportional.
   221 
   222 Version 1.2.7 - 2005-10-14  - Doodle
   223  - Enabled Exception handler code in FSLib to be able to restore original
   224    desktop video mode in case the application crashes.
   225  - Added the missing FSLib_Uninitialize() call into SDL.
   226    (The lack of it did not cause problems, but it's cleaner this way.)
   227  - Fixed a mouse problem in Fullscreen mode where any mouse click
   228    re-centered the mouse.
   229 
   230 Version 1.2.7 - 2005-10-09  - Doodle
   231  - Implemented window icon support
   232 
   233 Version 1.2.7 - 2005-10-03  - Doodle
   234  - Reworked semaphore support again
   235  - Tuned thread priorities
   236 
   237 Version 1.2.7 - 2005-10-02  - Doodle
   238  - Added support for custom mouse pointers
   239  - Fixed WM_CLOSE processing: give a chance to SDL app to ask user...
   240  - Added support for MMX-accelerated audio mixers
   241  - Other small fixes
   242 
   243 Version 1.2.7 - 2005-09-12  - Doodle
   244  - Small fixes for DosBox incorporated into public release
   245  - Fixed semaphore support (SDL_syssem.c)
   246  - Fixed FSLib to have good clipping in scaled window mode,
   247    and to prevent occasional desktop freezes.
   248 
   249 Version 1.2.7 - 2004-09-08a - Caetano
   250 	- Improved joystick support (general verifications about hardware).
   251 	- Added support up to 8 buttons in 2 axes joysticks and 6 buttons in 3 axes joysticks.
   252 	- Added support to environment variable SDL_OS2_JOYSTICK to specify a joystick.
   253 	- Improved Joystick test to handle every type of joystick and display only relevant information.
   254 	- Merged with Doodle 2004-09-08
   255 	- Little tid up in README.OS2
   256 	- Added explanation about SDL_OS2_JOYSTICK environment variable on README.OS2
   257 
   258 Version 1.2.7 - 2004-09-07 - Caetano
   259 	- Merged with changes in headers for GCC compiling.
   260 	- Added Joystick support using basic IBM GAME$ support, allowing it to work with all joystick drivers since OS/2 2.1.
   261 	- Improved joystick detection (hacked!). OS/2 do not allow real joystick detection, so... 
   262 	- Modified makefile in test to compile "testjoystick". Anyway, it's useless, since it seems to cause a lot of trouble in OS/2 (because os video routines, not Joystick support).
   263 	- Created separated Joystick test program to test only joystick functions.
   264 	- Improved joystick auto-centering.
   265 	- Improved the coordinate correction routine to use two scale factors for each axis.
   266 
   267 Version 1.2.7 - 2004-07-05 - Caetano
   268 	- Corrected the time returned by status in CDROM support (it was incorrect)
   269 	- Added the testcdrom.c and corrected the linking directive (it was causing an error)
   270 
   271 Version 1.2.7 - 2004-07-02a - Caetano
   272 	- Corrected a little problem in a comment at SDL-1.2.7\test\torturethread.c, line 18 (missing */, nested comment)
   273 	- Added CDROM support to tree (SDL-1.2.7\src\cdrom\os2\SDL_syscdrom.c)
   274 	- Modified makefile (SDL-1.2.7\src\makefiles.wat and SDL-1.2.7\watcom.mif) to build with CDROM support
   275 	- Added the "extra" SDL_types.h forgotten in 2004-07-02 version.
   276 
   277 <End-Of-File>