Skip to content
Permalink
Browse files

Date: Fri, 25 Jun 2004 13:29:15 +0100

From: "alan buckley"
Subject: Modification for RISC OS version of SDL

Ive attached a zip file with the changes to this email, it contains the
following:

The file sdldiff.txt is the output from cvs diff u.  .
The directory thread/riscos contains all the new files to support threading.

Readme.riscos is a new readme file to add.
  • Loading branch information
slouken committed Sep 17, 2004
1 parent 1752cce commit 5726169e35124748ae2a147ad2a79454eae6f493
@@ -0,0 +1,112 @@
Readme for RISC OS port of SDL
==============================

This document last updated on 25th June 2004

This is a RISC OS port of the Simple Direct Media Layer (SDL) by Alan Buckley.

Details of the SDL can be found at http://www.libsdl.org.

The source code including the RISC OS version can be obtained from http://www.libsdl.org.

RISC OS makefiles, pre built libraries and many games and applications compiled for RISC OS using this library can be downloaded from The Unix Porting Project at http://www.chocky.org/unix/index.html.

This is released under the LGPL see the file COPYING for details.


RISCOS port of SDL runtime information
======================================

Runtime requirements
--------------------

This library currently needs a minimum of RISCOS 3.6. The source code for the library (and a lot of the programs built with it) also need long file names.

To use the audio you also need 16 bit sound and to have installed the Digital Render module by Andreas Dehmel version 0.51 available from his web site:
http://home.t-online.de/~zarquon

Note: As most programs ported from other OS's use high resolution graphics and a memory back buffer a machine with a StrongARM processor and 1 or 2MB of VRAM (or a better machine) is recomended.


RISCOS runtime parameters
-------------------------

Several environmental variables have been defined to make porting programs easier (i.e. By setting these variable you do not need to have source code differences between OS's).

They are all defined on an application basis.

The <appname> used below is found as follows:
1. Use the name of the program unless it is !RunImage
2. Check the folder specification for the folder !RunImage is run from. If it is a folder name use that name, otherwise if it is an environmental variable of the form <XXX$Dir> use the value of XXX.

The variables are:

SDL$<appname>$TaskName - The name of the task for RISCOS. If omitted then <appname> is used for the task name,

SDL$<appname>$BackBuffer - set to 1 to use a system memory back buffer for the screen in full screen mode. Some programs on other systems assume their is always a back buffer even though the SDL specification specifies this is not the case. The current RISCOS implementation uses direct writes to the screen if a hardware fullscreen is requested.

SDL$<appname>$CloseAction - set the action for the close icon. Again as programs don't match the specification you can set this to 0 to remove the close icon from the main window for applications where this does not affect the program.

SDL$<appname>$AudioBuffer - set the minimum size of the audio buffer in samples in steps of 512. If this is less than the minimum calculated from the parameters requested in the program by SDL_OpenAudio these will be used instead. If this parameter is not used or set to 0 the buffer size will be calculated to buffer 10 centisecond of sound. The time buffered can be calculated as specified size/frequency in seconds. The larger the buffer the more audio data that will be buffered, but this can lead to a lag between a sound being requested and it being heard, so the size should be kept to a minimum. You should only set this parameter if the sound is being missed out.



RISCOS SDL port API notes
=========================

Current level of implementation
-------------------------------

The following list is an overview of how much of the SDL is implemented. The areas match the main areas of the SDL.

video - Mostly done. Doesn't cover gamma, YUV-overlay or open gl.
Window Manager - Mostly done. SetIcon/IconifyWindow not implemented.
Events - Mostly done. Resize and some joystick events missing.
Joystick - Currently assumes a single joystick with 4 buttons.
Audio - Requires Digital Renderer module.
CDROM - Not implemented.
Threads - Done
Timers - Done

Thread support can be removed by defining DISABLE_THREADS and recompiling the library.

SDL API notes
-------------

This section contains additional notes on some specific commands.

SDL_SetVideoMode
On RISCOS a fullscreen mode directly accesses the screen. This can be modified by the environmental variable (SDL$<appname>$BackBuffer) or by using the SDL_SWSURFACE flag to write to an offscreen buffer that is updated using SDL_UpdateRects.
Open GL is not supported so SDL_OPENGL and SDL_OPENGLBLIT flags fail.
SDL_RESIZEABLE and SDL_NOFRAME flags are not supported.

SDL_SetColors
In a wimp mode the screen colours are not changed for a hardware palette instead the RISCOS sprite colour mapping is used to get the best matching colours.

SDL_CreateCursor
Inverted colour is not supported.

SDL_WM_ToggleFullScreen
Currently this won't work if the application starts up in Fullscreen mode.
Toggling to fullscreen will only work if the monitor is set up to support the exact screen size requested.

SDL_EnableUNICODE
Unicode translation used here is only really accurate for 7 bit characters.

SDL_NumJoysticks/JoystickName etc.
Hardcoded to expect only 1 joystick with 4 buttons if the Joystick module is loaded.

SDL_GetTicks
Timer used has only a centisecond accuracy. This applies to other time related functions.

SDL_Delay
Modified to poll keyboard/mouse during the delay on the event thread.


Notes on current implementation
-------------------------------

Keyboard and mouse are polled so if too long a time is spent between a call to SDL_PumpEvents, functions that use it, or SDL_Delay events can be missed.

The sound is sent to the digital renderer player in a seperate thread. If there is too long a delay between this thread being processed (possibly if a lot else is running in the Wimp) the sound may sound incorrect or dissappear.

@@ -2605,20 +2605,45 @@ case "$target" in
;;
*-*-riscos)
ARCH=riscos
JOYSTICK_SUBDIRS="$JOYSTICK_SUBDIRS riscos"
JOYSTICK_DRIVERS="$JOYSTICK_DRIVERS riscos/libjoystick_riscos.la"
COPY_ARCH_SRC(src/timer, riscos, SDL_systimer.c)
VIDEO_SUBDIRS="$VIDEO_SUBDIRS riscos"
VIDEO_DRIVERS="$VIDEO_DRIVERS riscos/libvideo_riscos.la"
AUDIO_SUBDIRS="$AUDIO_SUBDIRS riscos"
AUDIO_DRIVERS="$AUDIO_DRIVERS riscos/libaudio_riscos.la"

# Set up files for the video library
if test x$enable_video = xyes; then
VIDEO_SUBDIRS="$VIDEO_SUBDIRS riscos"
VIDEO_DRIVERS="$VIDEO_DRIVERS riscos/libvideo_riscos.la"
fi
# Set up files for the audio library
if test x$enable_audio = xyes; then
AUDIO_SUBDIRS="$AUDIO_SUBDIRS riscos"
AUDIO_DRIVERS="$AUDIO_DRIVERS riscos/libaudio_riscos.la"
fi
# Set up files for the joystick library
if test x$enable_joystick = xyes; then
JOYSTICK_SUBDIRS="$JOYSTICK_SUBDIRS riscos"
JOYSTICK_DRIVERS="$JOYSTICK_DRIVERS riscos/libjoystick_riscos.la"
fi
# Set up files for the cdrom library
if test x$enable_cdrom = xyes; then
CDROM_SUBDIRS="$CDROM_SUBDIRS dummy"
CDROM_DRIVERS="$CDROM_DRIVERS dummy/libcdrom_dummy.la"
fi
# Set up files for the thread library
if test x$enable_threads = xyes; then
COPY_ARCH_SRC(src/thread, riscos, SDL_systhread.c)
COPY_ARCH_SRC(src/thread, riscos, SDL_systhread_c.h)
COPY_ARCH_SRC(src/thread, riscos, SDL_sysmutex.c)
COPY_ARCH_SRC(src/thread, riscos, SDL_sysmutex_c.h)
COPY_ARCH_SRC(src/thread, riscos, SDL_syssem.c)
COPY_ARCH_SRC(src/thread, generic, SDL_syssem_c.h)
COPY_ARCH_SRC(src/thread, riscos, SDL_syscond.c)
COPY_ARCH_SRC(src/thread, generic, SDL_syscond_c.h)
else
CFLAGS="$CFLAGS -DDISABLE_THREADS"
fi
# Set up files for the timer library
if test x$enable_timers = xyes; then
COPY_ARCH_SRC(src/timer, riscos, SDL_systimer.c)
fi

CFLAGS="$CFLAGS -DDISABLE_THREADS -DENABLE_RISCOS -DDRENDERER_SUPPORT"
CFLAGS="$CFLAGS -DENABLE_RISCOS -DDRENDERER_SUPPORT"

SYSTEM_LIBS="$SYSTEM_LIBS -ljpeg -ltiff -lpng -lz"
;;
@@ -399,7 +399,7 @@ int SDL_OpenAudio(SDL_AudioSpec *desired, SDL_AudioSpec *obtained)
return(-1);
}

#if defined(macintosh) || defined(__riscos__)
#if defined(macintosh) || (defined(__riscos__) && !defined(DISABLE_THREADS))
/* FIXME: Need to implement PPC interrupt asm for SDL_LockAudio() */
#else
#if defined(__MINT__) && !defined(ENABLE_THREADS)
@@ -35,6 +35,10 @@
#include "SDL_sysaudio.h"
#include "SDL_drenderer.h"

#ifndef DISABLE_THREADS
#include <pthread.h>
#endif

#define DigitalRenderer_Activate 0x4F700
#define DigitalRenderer_Deactivate 0x4F701
#define DigitalRenderer_ReadState 0x4F705
@@ -57,6 +61,12 @@ extern int riscos_audiobuffer; /* Override for audio buffer size */
static void DRenderer_CloseAudio(_THIS);
static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec);

#ifndef DISABLE_THREADS
static void DRenderer_WaitAudio(_THIS);
static Uint8 *DRenderer_GetAudioBuf(_THIS);
static void DRenderer_PlayAudio(_THIS);
#endif

/* Audio driver bootstrap functions */

/* Define following to dump stats to stdout */
@@ -104,6 +114,11 @@ static SDL_AudioDevice *Audio_CreateDevice(int devindex)
/* Set the function pointers */
this->OpenAudio = DRenderer_OpenAudio;
this->CloseAudio = DRenderer_CloseAudio;
#ifndef DISABLE_THREADS
this->GetAudioBuf = DRenderer_GetAudioBuf;
this->PlayAudio = DRenderer_PlayAudio;
this->WaitAudio = DRenderer_WaitAudio;
#endif
this->free = Audio_DeleteDevice;

return this;
@@ -117,6 +132,9 @@ AudioBootStrap DRENDERER_bootstrap = {
/* Routine called to check and fill audio buffers if necessary */
static Uint8 *buffer = NULL;

#ifdef DISABLE_THREADS

/* Buffer fill routine called during polling */
void DRenderer_FillBuffers()
{
SDL_AudioDevice *audio = current_audio;
@@ -182,15 +200,33 @@ void DRenderer_FillBuffers()
}
}

#endif

/* Size of DMA buffer to use */
#define DRENDERER_BUFFER_SIZE 512

/* Number of centiseconds of sound to buffer.
Hopefully more than the maximum time between calls to the
FillBuffers routine above
FillBuffers routine above (non-threaded) or the PlayAudio
routine below (threaded).
*/

#define DRENDERER_CSEC_TO_BUFFER 10

static void DeactivateAudio()
{
_kernel_swi_regs regs;

/* Close down the digital renderer */
_kernel_swi(DigitalRenderer_Deactivate, &regs, &regs);

if (buffer != NULL)
{
free(buffer);
buffer = NULL;
}
}

static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec)
{
_kernel_swi_regs regs;
@@ -200,23 +236,22 @@ static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec)
printf("Request format %d\n", spec->format);
printf("Request freq %d\n", spec->freq);
printf("Samples %d\n", spec->samples);
printf("Channels %d\n", spec->channels);
#endif

/* Only support signed 16bit format */
spec->format = AUDIO_S16LSB;

if (spec->samples < DRENDERER_BUFFER_SIZE) spec->samples = DRENDERER_BUFFER_SIZE;

SDL_CalculateAudioSpec(spec);


buffers_per_sample = spec->samples / DRENDERER_BUFFER_SIZE;

if ((spec->samples % DRENDERER_BUFFER_SIZE) != 0)
{
buffers_per_sample++;
spec->samples = buffers_per_sample * DRENDERER_BUFFER_SIZE;
}


/* Set number of buffers to use - the following should give enough
data between calls to the sound polling.
@@ -227,7 +262,19 @@ static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec)
FillBuffer = (int)((double)DRENDERER_CSEC_TO_BUFFER / ((double)DRENDERER_BUFFER_SIZE * 100.0 / (double)spec->freq)) + 1;
} else FillBuffer = riscos_audiobuffer/DRENDERER_BUFFER_SIZE - buffers_per_sample;

if (FillBuffer < buffers_per_sample) FillBuffer = buffers_per_sample;
if (FillBuffer < buffers_per_sample) FillBuffer = buffers_per_sample;
#ifndef DISABLE_THREADS
if (buffers_per_sample < FillBuffer)
{
/* For the threaded version we are only called once per cycle
so the callback needs to give us the full data we need in
one go, rather than multiple calls as it the case for the
non threaded version */
buffers_per_sample = FillBuffer;
spec->samples = buffers_per_sample * DRENDERER_BUFFER_SIZE;
}
#endif
SDL_CalculateAudioSpec(spec);
regs.r[0] = FillBuffer + buffers_per_sample;

#ifdef DUMP_AUDIO
@@ -259,6 +306,9 @@ static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec)
spec->freq = regs.r[0];
}

/* Ensure sound is deactivated if we exit without calling SDL_Quit */
atexit(DeactivateAudio);

#ifdef DUMP_AUDIO
printf("Got format %d\n", spec->format);
printf("Frequency %d\n", spec->freq);
@@ -277,17 +327,56 @@ static int DRenderer_OpenAudio(_THIS, SDL_AudioSpec *spec)
return -1;
}

#ifdef DISABLE_THREADS
/* Hopefully returning 2 will show success, but not start up an audio thread */
return 2;
#else
/* Success and start audio thread */
return 0;
#endif
}

static void DRenderer_CloseAudio(_THIS)
{
_kernel_swi_regs regs;
DeactivateAudio();
}

/* Close down the digital renderer */
_kernel_swi(DigitalRenderer_Deactivate, &regs, &regs);
#ifndef DISABLE_THREADS

/* Routines for threaded version of audio */

if (buffer != NULL) free(buffer);
void DRenderer_WaitAudio(_THIS)
{
_kernel_swi_regs regs;
int waiting = 1;

while (waiting)
{
/* Check filled buffers count */
_kernel_swi(DigitalRenderer_StreamStatistics, &regs, &regs);
#if 0
if (regs.r[0] <= FillBuffer)
{
printf("Buffers in use %d\n", regs.r[0]);
}
#endif
if (regs.r[0] <= FillBuffer) waiting = 0;
else pthread_yield();
}
}

Uint8 *DRenderer_GetAudioBuf(_THIS)
{
return buffer;
}

void DRenderer_PlayAudio(_THIS)
{
_kernel_swi_regs regs;

regs.r[0] = (int)buffer;
regs.r[1] = current_audio->spec.samples * current_audio->spec.channels;
_kernel_swi(DigitalRenderer_Stream16BitSamples, &regs, &regs);
}

#endif

0 comments on commit 5726169

Please sign in to comment.