1

/* $Id$ */

     2

     3

/** @file sdl_v.cpp Implementation of the SDL video driver. */

     4

     5

#ifdef WITH_SDL

     6

     7

#include "../stdafx.h"

     8

#include "../openttd.h"

     9

#include "../debug.h"

    10

#include "../gfx_func.h"

    11

#include "../sdl.h"

    12

#include "../variables.h"

    13

#include "../rev.h"

    14

#include "../blitter/factory.hpp"

    15

#include "../network/network.h"

    16

#include "../core/math_func.hpp"

    17

#include "../core/random_func.hpp"

    18

#include "../functions.h"

    19

#include "../texteff.hpp"

    20

#include "sdl_v.h"

    21

#include <SDL.h>

    22

    23

static FVideoDriver_SDL iFVideoDriver_SDL;

    24

    25

static SDL_Surface *_sdl_screen;

    26

static bool _all_modes;

    27

    28

#define MAX_DIRTY_RECTS 100

    29

static SDL_Rect _dirty_rects[MAX_DIRTY_RECTS];

    30

static int _num_dirty_rects;

    31

    32

void VideoDriver_SDL::MakeDirty(int left, int top, int width, int height)

    33

{

    34

	if (_num_dirty_rects < MAX_DIRTY_RECTS) {

    35

		_dirty_rects[_num_dirty_rects].x = left;

    36

		_dirty_rects[_num_dirty_rects].y = top;

    37

		_dirty_rects[_num_dirty_rects].w = width;

    38

		_dirty_rects[_num_dirty_rects].h = height;

    39

	}

    40

	_num_dirty_rects++;

    41

}

    42

    43

static void UpdatePalette(uint start, uint count)

    44

{

    45

	SDL_Color pal[256];

    46

	uint i;

    47

    48

	for (i = 0; i != count; i++) {

    49

		pal[i].r = _cur_palette[start + i].r;

    50

		pal[i].g = _cur_palette[start + i].g;

    51

		pal[i].b = _cur_palette[start + i].b;

    52

		pal[i].unused = 0;

    53

	}

    54

    55

	SDL_CALL SDL_SetColors(_sdl_screen, pal, start, count);

    56

}

    57

    58

static void InitPalette()

    59

{

    60

	UpdatePalette(0, 256);

    61

}

    62

    63

static void CheckPaletteAnim()

    64

{

    65

	if (_pal_count_dirty != 0) {

    66

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    67

    68

		switch (blitter->UsePaletteAnimation()) {

    69

			case Blitter::PALETTE_ANIMATION_VIDEO_BACKEND:

    70

				UpdatePalette(_pal_first_dirty, _pal_count_dirty);

    71

				break;

    72

    73

			case Blitter::PALETTE_ANIMATION_BLITTER:

    74

				blitter->PaletteAnimate(_pal_first_dirty, _pal_count_dirty);

    75

				break;

    76

    77

			case Blitter::PALETTE_ANIMATION_NONE:

    78

				break;

    79

    80

			default:

    81

				NOT_REACHED();

    82

		}

    83

		_pal_count_dirty = 0;

    84

	}

    85

}

    86

    87

static void DrawSurfaceToScreen()

    88

{

    89

	int n = _num_dirty_rects;

    90

	if (n != 0) {

    91

		_num_dirty_rects = 0;

    92

		if (n > MAX_DIRTY_RECTS)

    93

			SDL_CALL SDL_UpdateRect(_sdl_screen, 0, 0, 0, 0);

    94

		else

    95

			SDL_CALL SDL_UpdateRects(_sdl_screen, n, _dirty_rects);

    96

	}

    97

}

    98

    99

static const Dimension default_resolutions[] = {

   100

	{ 640,  480},

   101

	{ 800,  600},

   102

	{1024,  768},

   103

	{1152,  864},

   104

	{1280,  800},

   105

	{1280,  960},

   106

	{1280, 1024},

   107

	{1400, 1050},

   108

	{1600, 1200},

   109

	{1680, 1050},

   110

	{1920, 1200}

   111

};

   112

   113

static void GetVideoModes()

   114

{

   115

	int i;

   116

	SDL_Rect **modes;

   117

   118

	modes = SDL_CALL SDL_ListModes(NULL, SDL_SWSURFACE + (_fullscreen ? SDL_FULLSCREEN : 0));

   119

   120

	if (modes == NULL)

   121

		usererror("sdl: no modes available");

   122

   123

	_all_modes = (modes == (void*)-1);

   124

   125

	if (_all_modes) {

   126

		// all modes available, put some default ones here

   127

		memcpy(_resolutions, default_resolutions, sizeof(default_resolutions));

   128

		_num_resolutions = lengthof(default_resolutions);

   129

	} else {

   130

		int n = 0;

   131

		for (i = 0; modes[i]; i++) {

   132

			int w = modes[i]->w;

   133

			int h = modes[i]->h;

   134

			if (w >= 640 && h >= 480) {

   135

				int j;

   136

				for (j = 0; j < n; j++) {

   137

					if (_resolutions[j].width == w && _resolutions[j].height == h) break;

   138

				}

   139

   140

				if (j == n) {

   141

					_resolutions[j].width  = w;

   142

					_resolutions[j].height = h;

   143

					if (++n == lengthof(_resolutions)) break;

   144

				}

   145

			}

   146

		}

   147

		_num_resolutions = n;

   148

		SortResolutions(_num_resolutions);

   149

	}

   150

}

   151

   152

static void GetAvailableVideoMode(int *w, int *h)

   153

{

   154

	int i;

   155

	int best;

   156

	uint delta;

   157

   158

	// all modes available?

   160

   161

	// is the wanted mode among the available modes?

   162

	for (i = 0; i != _num_resolutions; i++) {

   163

		if (*w == _resolutions[i].width && *h == _resolutions[i].height) return;

   164

	}

   165

   166

	// use the closest possible resolution

   167

	best = 0;

   168

	delta = abs((_resolutions[0].width - *w) * (_resolutions[0].height - *h));

   169

	for (i = 1; i != _num_resolutions; ++i) {

   170

		uint newdelta = abs((_resolutions[i].width - *w) * (_resolutions[i].height - *h));

   171

		if (newdelta < delta) {

   172

			best = i;

   173

			delta = newdelta;

   174

		}

   175

	}

   176

	*w = _resolutions[best].width;

   177

	*h = _resolutions[best].height;

   178

}

   179

   180

#ifndef ICON_DIR

   181

#define ICON_DIR "media"

   182

#endif

   183

   184

#ifdef WIN32

   185

/* Let's redefine the LoadBMP macro with because we are dynamically

   186

 * loading SDL and need to 'SDL_CALL' all functions */

   187

#undef SDL_LoadBMP

   188

#define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_CALL SDL_RWFromFile(file, "rb"), 1)

   189

#endif

   190

   191

static bool CreateMainSurface(int w, int h)

   192

{

   193

	SDL_Surface *newscreen, *icon;

   194

	char caption[50];

   195

	int bpp = BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth();

   196

   197

	GetAvailableVideoMode(&w, &h);

   198

   199

	DEBUG(driver, 1, "SDL: using mode %dx%dx%d", w, h, bpp);

   200

   201

	if (bpp == 0) usererror("Can't use a blitter that blits 0 bpp for normal visuals");

   202

   203

	/* Give the application an icon */

   204

	icon = SDL_CALL SDL_LoadBMP(ICON_DIR PATHSEP "openttd.32.bmp");

   205

	if (icon != NULL) {

   206

		/* Get the colourkey, which will be magenta */

   207

		uint32 rgbmap = SDL_CALL SDL_MapRGB(icon->format, 255, 0, 255);

   208

   209

		SDL_CALL SDL_SetColorKey(icon, SDL_SRCCOLORKEY, rgbmap);

   210

		SDL_CALL SDL_WM_SetIcon(icon, NULL);

   211

		SDL_CALL SDL_FreeSurface(icon);

   212

	}

   213

   214

	// DO NOT CHANGE TO HWSURFACE, IT DOES NOT WORK

   215

	newscreen = SDL_CALL SDL_SetVideoMode(w, h, bpp, SDL_SWSURFACE | SDL_HWPALETTE | (_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE));

   218

		return false;

   220

   221

	_screen.width = newscreen->w;

   222

	_screen.height = newscreen->h;

   223

	_screen.pitch = newscreen->pitch / (bpp / 8);

   224

	_sdl_screen = newscreen;

   225

	InitPalette();

   226

   227

	snprintf(caption, sizeof(caption), "OpenTTD %s", _openttd_revision);

   228

	SDL_CALL SDL_WM_SetCaption(caption, caption);

   229

	SDL_CALL SDL_ShowCursor(0);

   230

   231

	GameSizeChanged();

   232

   233

	return true;

   234

}

   235

   236

struct VkMapping {

   237

	uint16 vk_from;

   238

	byte vk_count;

   239

	byte map_to;

   240

};

   241

   242

#define AS(x, z) {x, 0, z}

   243

#define AM(x, y, z, w) {x, y - x, z}

   244

   245

static const VkMapping _vk_mapping[] = {

   246

	/* Pageup stuff + up/down */

   247

	AM(SDLK_PAGEUP, SDLK_PAGEDOWN, WKC_PAGEUP, WKC_PAGEDOWN),

   248

	AS(SDLK_UP,     WKC_UP),

   249

	AS(SDLK_DOWN,   WKC_DOWN),

   250

	AS(SDLK_LEFT,   WKC_LEFT),

   251

	AS(SDLK_RIGHT,  WKC_RIGHT),

   252

   253

	AS(SDLK_HOME,   WKC_HOME),

   254

	AS(SDLK_END,    WKC_END),

   255

   256

	AS(SDLK_INSERT, WKC_INSERT),

   257

	AS(SDLK_DELETE, WKC_DELETE),

   258

   259

	/* Map letters & digits */

   260

	AM(SDLK_a, SDLK_z, 'A', 'Z'),

   261

	AM(SDLK_0, SDLK_9, '0', '9'),

   262

   263

	AS(SDLK_ESCAPE,    WKC_ESC),

   264

	AS(SDLK_PAUSE,     WKC_PAUSE),

   265

	AS(SDLK_BACKSPACE, WKC_BACKSPACE),

   266

   267

	AS(SDLK_SPACE,     WKC_SPACE),

   268

	AS(SDLK_RETURN,    WKC_RETURN),

   269

	AS(SDLK_TAB,       WKC_TAB),

   270

   271

	/* Function keys */

   272

	AM(SDLK_F1, SDLK_F12, WKC_F1, WKC_F12),

   273

   274

	/* Numeric part. */

   275

	AM(SDLK_KP0, SDLK_KP9, '0', '9'),

   276

	AS(SDLK_KP_DIVIDE,   WKC_NUM_DIV),

   277

	AS(SDLK_KP_MULTIPLY, WKC_NUM_MUL),

   278

	AS(SDLK_KP_MINUS,    WKC_NUM_MINUS),

   279

	AS(SDLK_KP_PLUS,     WKC_NUM_PLUS),

   280

	AS(SDLK_KP_ENTER,    WKC_NUM_ENTER),

   281

	AS(SDLK_KP_PERIOD,   WKC_NUM_DECIMAL),

   282

   283

	/* Other non-letter keys */

   284

	AS(SDLK_SLASH,        WKC_SLASH),

   285

	AS(SDLK_SEMICOLON,    WKC_SEMICOLON),

   286

	AS(SDLK_EQUALS,       WKC_EQUALS),

   287

	AS(SDLK_LEFTBRACKET,  WKC_L_BRACKET),

   288

	AS(SDLK_BACKSLASH,    WKC_BACKSLASH),

   289

	AS(SDLK_RIGHTBRACKET, WKC_R_BRACKET),

   290

   291

	AS(SDLK_QUOTE,   WKC_SINGLEQUOTE),

   292

	AS(SDLK_COMMA,   WKC_COMMA),

   293

	AS(SDLK_MINUS,   WKC_MINUS),

   294

	AS(SDLK_PERIOD,  WKC_PERIOD)

   295

};

   296

   297

static uint32 ConvertSdlKeyIntoMy(SDL_keysym *sym)

   298

{

   299

	const VkMapping *map;

   300

	uint key = 0;

   301

   302

	for (map = _vk_mapping; map != endof(_vk_mapping); ++map) {

   303

		if ((uint)(sym->sym - map->vk_from) <= map->vk_count) {

   304

			key = sym->sym - map->vk_from + map->map_to;

   305

			break;

   306

		}

   307

	}

   308

   309

	// check scancode for BACKQUOTE key, because we want the key left of "1", not anything else (on non-US keyboards)

   310

#if defined(WIN32) || defined(__OS2__)

   311

	if (sym->scancode == 41) key = WKC_BACKQUOTE;

   312

#elif defined(__APPLE__)

   313

	if (sym->scancode == 10) key = WKC_BACKQUOTE;

   314

#elif defined(__MORPHOS__)

   315

	if (sym->scancode == 0)  key = WKC_BACKQUOTE;  // yes, that key is code '0' under MorphOS :)

   316

#elif defined(__BEOS__)

   317

	if (sym->scancode == 17) key = WKC_BACKQUOTE;

   318

#elif defined(__SVR4) && defined(__sun)

   319

	if (sym->scancode == 60) key = WKC_BACKQUOTE;

   320

	if (sym->scancode == 49) key = WKC_BACKSPACE;

   321

#elif defined(__sgi__)

   322

	if (sym->scancode == 22) key = WKC_BACKQUOTE;

   323

#else

   324

	if (sym->scancode == 49) key = WKC_BACKQUOTE;

   325

#endif

   326

   327

	// META are the command keys on mac

   328

	if (sym->mod & KMOD_META)  key |= WKC_META;

   329

	if (sym->mod & KMOD_SHIFT) key |= WKC_SHIFT;

   330

	if (sym->mod & KMOD_CTRL)  key |= WKC_CTRL;

   331

	if (sym->mod & KMOD_ALT)   key |= WKC_ALT;

   332

	// these two lines really help porting hotkey combos. Uncomment to use -- Bjarni

   333

#if 0

   334

	DEBUG(driver, 0, "Scancode character pressed %u", sym->scancode);

   335

	DEBUG(driver, 0, "Unicode character pressed %u", sym->unicode);

   336

#endif

   337

	return (key << 16) + sym->unicode;

   338

}

   339

   340

static int PollEvent()

   341

{

   342

	SDL_Event ev;

   343

   344

	if (!SDL_CALL SDL_PollEvent(&ev)) return -2;

   345

   346

	switch (ev.type) {

   347

		case SDL_MOUSEMOTION:

   348

			if (_cursor.fix_at) {

   349

				int dx = ev.motion.x - _cursor.pos.x;

   350

				int dy = ev.motion.y - _cursor.pos.y;

   351

				if (dx != 0 || dy != 0) {

   352

					_cursor.delta.x += dx;

   353

					_cursor.delta.y += dy;

   354

					SDL_CALL SDL_WarpMouse(_cursor.pos.x, _cursor.pos.y);

   355

				}

   356

			} else {

   357

				_cursor.delta.x = ev.motion.x - _cursor.pos.x;

   358

				_cursor.delta.y = ev.motion.y - _cursor.pos.y;

   359

				_cursor.pos.x = ev.motion.x;

   360

				_cursor.pos.y = ev.motion.y;

   361

				_cursor.dirty = true;

   362

			}

   363

			HandleMouseEvents();

   364

			break;

   365

   366

		case SDL_MOUSEBUTTONDOWN:

   367

			if (_rightclick_emulate && SDL_CALL SDL_GetModState() & KMOD_CTRL) {

   368

				ev.button.button = SDL_BUTTON_RIGHT;

   369

			}

   370

   371

			switch (ev.button.button) {

   372

				case SDL_BUTTON_LEFT:

   373

					_left_button_down = true;

   374

					break;

   375

   376

				case SDL_BUTTON_RIGHT:

   377

					_right_button_down = true;

   378

					_right_button_clicked = true;

   379

					break;

   380

   381

				case SDL_BUTTON_WHEELUP:   _cursor.wheel--; break;

   382

				case SDL_BUTTON_WHEELDOWN: _cursor.wheel++; break;

   383

   384

				default: break;

   385

			}

   386

			HandleMouseEvents();

   387

			break;

   388

   389

		case SDL_MOUSEBUTTONUP:

   390

			if (_rightclick_emulate) {

   391

				_right_button_down = false;

   392

				_left_button_down = false;

   393

				_left_button_clicked = false;

   394

			} else if (ev.button.button == SDL_BUTTON_LEFT) {

   395

				_left_button_down = false;

   396

				_left_button_clicked = false;

   397

			} else if (ev.button.button == SDL_BUTTON_RIGHT) {

   398

				_right_button_down = false;

   399

			}

   400

			HandleMouseEvents();

   401

			break;

   402

   403

		case SDL_ACTIVEEVENT:

   404

			if (!(ev.active.state & SDL_APPMOUSEFOCUS)) break;

   405

   406

			if (ev.active.gain) { // mouse entered the window, enable cursor

   407

				_cursor.in_window = true;

   408

			} else {

   409

				UndrawMouseCursor(); // mouse left the window, undraw cursor

   410

				_cursor.in_window = false;

   411

			}

   412

			break;

   413

   414

		case SDL_QUIT: HandleExitGameRequest(); break;

   415

   416

		case SDL_KEYDOWN: /* Toggle full-screen on ALT + ENTER/F */

   417

			if ((ev.key.keysym.mod & (KMOD_ALT | KMOD_META)) &&

   418

					(ev.key.keysym.sym == SDLK_RETURN || ev.key.keysym.sym == SDLK_f)) {

   419

				ToggleFullScreen(!_fullscreen);

   420

			} else {

   421

				HandleKeypress(ConvertSdlKeyIntoMy(&ev.key.keysym));

   422

			}

   423

			break;

   424

   425

		case SDL_VIDEORESIZE: {

   426

			int w = max(ev.resize.w, 64);

   427

			int h = max(ev.resize.h, 64);

   428

			ChangeResInGame(w, h);

   429

			break;

   430

		}

   431

	}

   432

	return -1;

   433

}

   434

   435

const char *VideoDriver_SDL::Start(const char * const *parm)

   436

{

   437

	char buf[30];

   438

   439

	const char *s = SdlOpen(SDL_INIT_VIDEO);

   440

	if (s != NULL) return s;

   441

   442

	SDL_CALL SDL_VideoDriverName(buf, 30);

   443

	DEBUG(driver, 1, "SDL: using driver '%s'", buf);

   444

   445

	GetVideoModes();

   446

	CreateMainSurface(_cur_resolution.width, _cur_resolution.height);

   447

	MarkWholeScreenDirty();

   448

   449

	SDL_CALL SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);

   450

	SDL_CALL SDL_EnableUNICODE(1);

   451

	return NULL;

   452

}

   453

   454

void VideoDriver_SDL::Stop()

   455

{

   456

	SdlClose(SDL_INIT_VIDEO);

   457

}

   458

   459

void VideoDriver_SDL::MainLoop()

   460

{

   461

	uint32 cur_ticks = SDL_CALL SDL_GetTicks();

   462

	uint32 last_cur_ticks = cur_ticks;

   463

	uint32 next_tick = cur_ticks + 30;

   464

	uint32 pal_tick = 0;

   465

	uint32 mod;

   466

	int numkeys;

   467

	Uint8 *keys;

   468

   469

	for (;;) {

   470

		uint32 prev_cur_ticks = cur_ticks; // to check for wrapping

   471

		InteractiveRandom(); // randomness

   472

   473

		while (PollEvent() == -1) {}

   474

		if (_exit_game) return;

   475

   476

		mod = SDL_CALL SDL_GetModState();

   477

		keys = SDL_CALL SDL_GetKeyState(&numkeys);

   478

#if defined(_DEBUG)

   479

		if (_shift_pressed)

   480

#else

   481

		/* Speedup when pressing tab, except when using ALT+TAB

   482

		 * to switch to another application */

   483

		if (keys[SDLK_TAB] && (mod & KMOD_ALT) == 0)

   484

#endif

   485

		{

   486

			if (!_networking && _game_mode != GM_MENU) _fast_forward |= 2;

   487

		} else if (_fast_forward & 2) {

   488

			_fast_forward = 0;

   489

		}

   490

   491

		cur_ticks = SDL_CALL SDL_GetTicks();

   492

		if (cur_ticks >= next_tick || (_fast_forward && !_pause_game) || cur_ticks < prev_cur_ticks) {

   493

			_realtime_tick += cur_ticks - last_cur_ticks;

   494

			last_cur_ticks = cur_ticks;

   495

			next_tick = cur_ticks + 30;

   496

   497

			bool old_ctrl_pressed = _ctrl_pressed;

   498

   499

			_ctrl_pressed  = !!(mod & KMOD_CTRL);

   500

			_shift_pressed = !!(mod & KMOD_SHIFT);