View source for SDL Wii

{{Infobox development tools
| image       = [[File:SDL logo.png|120px]]
| title       = SDL Wii
| type        = framework library
| author      = Numerous
| maintainer  = [[User:Tantric|Tantric]]
| download    = http://code.google.com/p/sdl-wii/downloads/list
| source      = https://github.com/dborth/sdl-wii
}}

'''Simple DirectMedia Layer''' ('''SDL''') is a cross-platform multimedia library designed to provide low level access to audio, keyboard, mouse, joystick, and video. It is used by MPEG playback software, emulators, and many popular games. SDL is written in C, but works with C++ natively.

SDL support on Wii is currently incomplete. Although SDL is useable, '''you will likely experience problems''' until this is rectified. Please contribute any improvements you make to the [http://code.google.com/p/sdl-wii/source/checkout SDL Wii SVN].


== Usage ==

* Grab the latest [[devkitPro|devkitPPC]] and [[libogc]]
* Download and copy the PPC [http://sourceforge.net/projects/devkitpro/files/portlibs ported libraries] to your portlibs folder (on Windows this is c:\devkitPro\portlibs\ppc)
* Copy all of the [http://code.google.com/p/sdl-wii/downloads/list SDL files] to the libogc folder (on Windows by default this is c:\devkitPro\libogc).

Remember to link the libraries in the right order:

 LIBS	:=	-lSDL_net -lSDL_ttf -lSDL_gfx -lSDL_mixer -lSDL_image -lsmpeg \
                 -lSDL -ljpeg -lpng -lfreetype -lvorbisidec \
                 -lz -lfat -lwiiuse -lbte -lwiikeyboard -logc -lm



Use your friend google to learn how to use SDL.

There is also additional [[/installation help|installation help]] available.

== Tutorial ==
A simple but currently incomplete tutorial can be found [[/tutorial|here]]. Made by [[User:GabberNL|GabberNL]].

An input testing source code and binaries can be found [[/Inputs|here]]. Made by [[User:TheDrev|TheDrev]].

Very simple application that simulates plasma fireworks is [[Fire]].

== Using SDL ==

SDL has graphics, sound, and input all in one.  SDL is a very popular library used in many open source programs.  It is most commonly used in games, but it is also used in emulators and media players.  SDL is very easy to use and it is very easy to port apps that use it.

SDL Wii supports 640X480 and 320X240 framebuffer resolution. The default bitdepth is 16 with RGB565 color space but better immage quality can be obtained with 24 bits (i.e. using SDL_SetVideoMode(width, height, 24, flags)).

Power buttons are handled by SDL. Power switches off the Wii. Reset returns to Homebrew channel.

The library also inits the Wii video console.

=== SDL joystick mapping ===

The Wii controllers are mapped as SDL joysticks 0-3.
The gamecube controller ports are mapped as SDL joysticks 4-7.

The sticks and axes are mapped this way:

{| class="wikitable"
|-
! SDL axis !! {{Nunchuk}} !! {{ClassicController}} !!  {{GCNController}} !! Comments
|-
| 0 (horizontal) ||  {{NunchuckControlStick}} || {{ClassicLControlStick}} || {{GCControlStick}} ||Only one Wii expansion can be connected
|-
| 1 (vertical) ||  {{NunchuckControlStick}}  ||{{ClassicLControlStick}} || {{GCControlStick}}
|-
| 2 (horizontal) || || {{ClassicRControlStick}} || {{GCControlStickC}}
|-
| 3 (vertical) || || {{ClassicRControlStick}} || {{GCControlStickC}}
|-
| 4 (horizontal) || || {{ClassicRTrigger}} || {{GCLTrigger}}
|-
| 5 (vertical) || || {{ClassicLTrigger}} || {{GCRTrigger}}
|}

Axis 6,7 and 8 are the wiimote itself axis' orientation.

Triggers give only positive values (0-32678). 


=== SDL joystick button mapping ===

The D-pads on the Wii Remote, the Classic Controller and Gamecube controller are mapped as a [http://www.libsdl.org/cgi/docwiki.cgi/SDL_JoystickGetHat joystick hat]. 

For Wii, only one hat is reported per joystick, so when Classic Controller is plugged in, the D-pad on the Wii Remote is ignored. As far as orientation, SDL_HAT_UP is the up button on the Wii Remote's D-pad when it's held in horizontal position (with D-pad to the left).

The wiimote and gamecube conntroller buttons are mapped this way in SDL:

{| class="wikitable"
|-
! SDL joystick<br />button index !! {{WiimoteHorizontal}} !! {{Nunchuk}} !! {{ClassicController}} !!  {{GCNController}}
|-
| 0 || {{WiimoteAButton}} || || || {{GCAButton}} 
|-
| 1 || {{WiimoteBButton}} || || || {{GCBButton}}
|-
| 2 || {{Wiimote1Button}} || || || {{GCXButton}}
|-
| 3 || {{Wiimote2Button}} || || || {{GCYButton}}
|-
| 4 || {{WiimoteMinusButton}} || || || {{GCZButton}}
|-
| 5 || {{WiimotePlusButton}} || || || {{GCRTrigger}}
|-
| 6 || {{WiimoteHomeButton}} || || || {{GCLTrigger}}
|-
| 7 || || {{NunchuckZButton}} || || {{GCStartButton}}
|-
| 8 || || {{NunchuckCButton}} ||
|-
| 9 || || || {{ClassicAButton}}
|-
|10 || || || {{ClassicBButton}}
|-
|11 || || || {{ClassicXButton}}
|-
|12 || || || {{ClassicYButton}}
|-
|13 || || || {{ClassicLTrigger}}
|-
|14 || || || {{ClassicRTrigger}}
|-
|15 || || ||  {{ClassicZLButton}}
|-
|16 || || || {{ClassicZRButton}}
|-
|17 || || || {{ClassicMinusButton}}
|-
|18 || || || {{ClassicPlusButton}}
|-
|19 || || || {{WiimoteHomeButton}}
|}


=== SDL mouse mapping ===

Mouse movements are emulated by IR pointer of Wiimote 1 or/and a mouse connected in the USB port.

=== SDL mouse button mapping ===

{| class="wikitable"
|-
! SDL mouse<br />button index !! {{WiimoteHorizontal}} !! {{USBMouse}}
|-
| Left button || {{WiimoteAButton}} || Left button
|-
| Right button || {{WiimoteBButton}} || Right button
|}

You have to point the Wiimote towards the screen to use the Wiimote buttons as mouse buttons.

== Bugs ==

* SDL_gfx eats up memory and can cause code dumps. If you get code dumps then try removing SDL_gfx.
* See [http://code.google.com/p/sdl-wii/issues/list Issues] for bugs reporting.

== Source ==

Many authors have contributed to the SDL Wii port over the years. The original source is from [http://www.libsdl.org libSDL]. A GameCube version was found in the devkitPro CVS repository. Mindcry made the port compatible with the Wii and added on sound, SDL_mixer and SDL_image. Devildante recompiled a version of SDL_image with libjpeg support, and added SDL_gfx and SDL_ttf with FreeType. Numerous changes were also made by Yohannes (threading, audio, etc), and David Hudson updated to the latest SDL SVN. Tantric has also rewritten portions, including the file access, audio, and video systems.

== Tips ==
* SDL_Init must include the SDL_INIT_JOYSTICK flag set for any input events to work, and SDL_JoystickOpen(0) must be called. When you point the Wiimote towards the screen, Wiimote events come as SDL_MOUSBUTTON and SDL_MOUSEMOTION as well as SDL_JOYBUTTON events. To enable this, for all wiimote events (both joystick and mouse), you must set the joystick event processing state with SDL_JoystickEventState. If you are not handling the wiimote via the event queue then you must explicitly request a joystick update by calling SDL_JoystickUpdate.

* If you're going to be doing file I/O operations, call fatInitDefault() before any calls to SDL. Lockups can occur if you call that after SDL and do some big writes to the SD card.

* The audio framebuffer lenght is fixed.

* No more then 12 user threads can be created.

== See Also ==

* [[SDL Wii/installation help]]
* [[:Category:Homebrew using SDL libraries|Homebrew using SDL libraries]]
* [[SDL_draw]]