diff options
Diffstat (limited to 'backends/platform/sdl/raspberrypi')
| -rw-r--r-- | backends/platform/sdl/raspberrypi/README.RASPBERRYPI | 106 | ||||
| -rw-r--r-- | backends/platform/sdl/raspberrypi/raspberrypi-main.cpp | 51 | ||||
| -rw-r--r-- | backends/platform/sdl/raspberrypi/raspberrypi.cpp | 42 | ||||
| -rw-r--r-- | backends/platform/sdl/raspberrypi/raspberrypi.h | 35 |
4 files changed, 234 insertions, 0 deletions
diff --git a/backends/platform/sdl/raspberrypi/README.RASPBERRYPI b/backends/platform/sdl/raspberrypi/README.RASPBERRYPI new file mode 100644 index 0000000000..f8d872b519 --- /dev/null +++ b/backends/platform/sdl/raspberrypi/README.RASPBERRYPI @@ -0,0 +1,106 @@ +ScummVM-RASPBERRYPI README +============================================================================== + +Notes +============ + +This version of ScummVM is specially tailored to use DispmanX, the native 2D +API on the Raspberry Pi. The idea is that scaling and drawing on a double +buffer with a non-blocking vsync wait is all done using the on-board VideoCore +hardware, thus using only a small fraction of the CPU ScummVM uses when ran +on a clunky, software-scaled and desynced X11 environment using the X11 API. +Thus, running this version under an X11 session is not supported. + +Requirements +============ +- Raspberry Pi 1 or 2 microcomputer. +- Raspbian (Debian) installed on SD card. Other distros may be supported if + they include the VideoCore runtime libraries that Raspbian includes. +-An attached keyboard and mouse, or alternatively joystick. + +Controls +============ + +The standard ScummVM keyboard and mouse controls are used as in any other +GNU/Linux based system. +Use the --joystick parameter if you want to use a joystick instead of the +intended mouse for playing the games (not recommended). + +Installation from binaries +============================== + +We have at least three methods to get the binaries into the Raspbian SD: + +1) Since Debian (Raspbian) includes an ssh service by default, I recommend +keeping the SD card on the Raspberry Pi, and using scp to copy the package over +to your home directory in the Debian filesystem. + +scp scummvm-rpi_<version>.zip pi@<raspberrypi_ip>:/home/pi + +2) If your RaspberryPi has internet access, you can simply use wget to +download the package to your home folder: + +cd ~/ +wget <package_link> + +3) You could also connect the Raspbian SD card to your main PC and, after +mounting it (or being automounted as it would be in most desktop GNU/Linux +systems), copy the package file manually to your home directory. +How to mount an SD and copy files to it is beyond the scope of this README. + +Once we have the package file in our home directory using one of the three +aforementioned methods, we would need to uncompress it: + +unzip scummvm-rpi_<version>.zip + +As a result, a directory containing the scummvm along with this README will be +created. +We can run it by simply changing to our scummvm directory and executing the +scummvm file. + +cd scummvm-rpi +./scummvm + +I recommend copying the games to /home/pi/scummvm-rpi. Adding the games via the menu +works as in any other system ScummVM runs on. + +Building from sources +============================== + +We have two options to build once we have the sources in our main GNU/Linux desktop +class PC or in our Raspberry Pi: + +1) Building on the Raspberry Pi itself, although possible, is an SLOW task for the +little computer unless you use distributed gcc (or distcc for short). + +Local compilation would simply consist of the "standard" GNU/Linux building process: + +cd <sources_dir> + +./configure --enable-dispmanx -disable-debug --enable-release +--enable-optimizations --disable-mt32emu --disable-flac --disable-mad --disable-vorbis +--disable-tremor --disable-fluidsynth --disable-taskbar --disable-timidity --disable-alsa +--disable-scalers --disable-hq-scalers --disable-savegame-timestamp --disable-eventrecorder + +make + +As you can see, we're manually disabling scalers because we prefer dispmanx for that, which +makes scalers unnecessary on a CPU limited platform like this, timestamps because most people +doesn't have an RTC on the Raspberry Pi, and event recorder to save SD card write cycles. +All these are automatically disabled when we crosscompile by passing "--host=raspberrypi", +which is not the case. + +¡¡It will be an SLOW process, taking several hours to complete, unless you +are running distcc against a fast compilation server!! + +2) If we want to build by cross-compiling on a GNU/Linux X86-based computer, +we can find concise instructions for this can be found on the ScummVM wiki: + +http://wiki.scummvm.org/index.php/Compiling_ScummVM/RPI + +NOTE: Distcc is my preferred method as it does cross-compiling totally transparent +(we build ON the Pi but the actual CPU-intensive compilation is made on an external +server), but it involves building a custom gcc version on the compilation server and +configuring a server and client in both the Raspberry Pi and the server. + +Enjoy! diff --git a/backends/platform/sdl/raspberrypi/raspberrypi-main.cpp b/backends/platform/sdl/raspberrypi/raspberrypi-main.cpp new file mode 100644 index 0000000000..cddbcb7ec4 --- /dev/null +++ b/backends/platform/sdl/raspberrypi/raspberrypi-main.cpp @@ -0,0 +1,51 @@ +/* ScummVM - Graphic Adventure Engine + * + * ScummVM is the legal property of its developers, whose names + * are too numerous to list here. Please refer to the COPYRIGHT + * file distributed with this source distribution. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +#include "backends/platform/sdl/raspberrypi/raspberrypi.h" +#include "backends/plugins/sdl/sdl-provider.h" +#include "common/scummsys.h" +#include "base/main.h" + +#if defined(DISPMANX) +int main(int argc, char* argv[]) { + + // Create our OSystem instance + g_system = new OSystem_SDL_RaspberryPi(); + assert(g_system); + + // Pre initialize the backend + ((OSystem_SDL_RaspberryPi *)g_system)->init(); + +#ifdef DYNAMIC_MODULES + PluginManager::instance().addPluginProvider(new SDLPluginProvider()); +#endif + + // Invoke the actual ScummVM main entry point: + int res = scummvm_main(argc, argv); + + // Free OSystem + delete (OSystem_SDL_RaspberryPi *)g_system; + + return res; +} + +#endif diff --git a/backends/platform/sdl/raspberrypi/raspberrypi.cpp b/backends/platform/sdl/raspberrypi/raspberrypi.cpp new file mode 100644 index 0000000000..206203d82e --- /dev/null +++ b/backends/platform/sdl/raspberrypi/raspberrypi.cpp @@ -0,0 +1,42 @@ +/* ScummVM - Graphic Adventure Engine + * + * ScummVM is the legal property of its developers, whose names + * are too numerous to list here. Please refer to the COPYRIGHT + * file distributed with this source distribution. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +#if defined(DISPMANX) + +#include "backends/platform/sdl/raspberrypi/raspberrypi.h" +#include "backends/graphics/dispmanxsdl/dispmanxsdl-graphics.h" + +void OSystem_SDL_RaspberryPi::initBackend() { + // Create the events manager + if (_eventSource == 0) + _eventSource = new SdlEventSource(); + + // Create the graphics manager + if (_graphicsManager == 0) { + _graphicsManager = new DispmanXSdlGraphicsManager(_eventSource, _window); + } + + // Call parent implementation of this method + OSystem_POSIX::initBackend(); +} + +#endif diff --git a/backends/platform/sdl/raspberrypi/raspberrypi.h b/backends/platform/sdl/raspberrypi/raspberrypi.h new file mode 100644 index 0000000000..45e2c505f6 --- /dev/null +++ b/backends/platform/sdl/raspberrypi/raspberrypi.h @@ -0,0 +1,35 @@ +/* ScummVM - Graphic Adventure Engine + * + * ScummVM is the legal property of its developers, whose names + * are too numerous to list here. Please refer to the COPYRIGHT + * file distributed with this source distribution. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +#ifndef SDL_DISPMANX_COMMON_H +#define SDL_DISPMANX_COMMON_H + +#if defined(DISPMANX) +#include "backends/platform/sdl/posix/posix.h" + +class OSystem_SDL_RaspberryPi : public OSystem_POSIX { +public: + void initBackend(); +}; + +#endif /* DISPMANX */ +#endif /* SDL_DISPMANX_COMMON_H */ |