Repository navigation
Expand file tree
/
Copy pathScreen.cpp
More file actions
641 lines (584 loc) · 16.4 KB
/
Copy pathScreen.cpp
File metadata and controls
641 lines (584 loc) · 16.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
/*
* Copyright 2010-2016 OpenXcom Developers.
*
* This file is part of OpenXcom.
*
* OpenXcom 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 3 of the License, or
* (at your option) any later version.
*
* OpenXcom 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 OpenXcom. If not, see <http://www.gnu.org/licenses/>.
*/
#include "Screen.h"
#include <algorithm>
#include <sstream>
#include <cmath>
#include <iomanip>
#include <climits>
#include "../lodepng.h"
#include "Exception.h"
#include "Surface.h"
#include "Logger.h"
#include "Action.h"
#include "Options.h"
#include "CrossPlatform.h"
#include "FileMap.h"
#include "Zoom.h"
#include "Timer.h"
#include <SDL.h>
namespace OpenXcom
{
const int Screen::ORIGINAL_WIDTH = 320;
const int Screen::ORIGINAL_HEIGHT = 200;
/**
* Sets up all the internal display flags depending on
* the current video settings.
*/
void Screen::makeVideoFlags()
{
_flags = SDL_HWSURFACE|SDL_DOUBLEBUF|SDL_HWPALETTE;
if (Options::asyncBlit)
{
_flags |= SDL_ASYNCBLIT;
}
if (isOpenGLEnabled())
{
_flags = SDL_OPENGL;
SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
}
if (Options::allowResize)
{
_flags |= SDL_RESIZABLE;
}
// Handle window positioning
if (!Options::fullscreen && Options::rootWindowedMode)
{
std::ostringstream ss;
ss << "SDL_VIDEO_WINDOW_POS=" << std::dec << Options::windowedModePositionX << "," << Options::windowedModePositionY;
SDL_putenv(const_cast<char*>(ss.str().c_str()));
SDL_putenv(const_cast<char*>("SDL_VIDEO_CENTERED="));
}
else if (Options::borderless)
{
SDL_putenv(const_cast<char*>("SDL_VIDEO_WINDOW_POS="));
SDL_putenv(const_cast<char*>("SDL_VIDEO_CENTERED=center"));
}
else
{
SDL_putenv(const_cast<char*>("SDL_VIDEO_WINDOW_POS="));
SDL_putenv(const_cast<char*>("SDL_VIDEO_CENTERED="));
}
// Handle display mode
if (Options::fullscreen)
{
_flags |= SDL_FULLSCREEN;
}
if (Options::borderless)
{
_flags |= SDL_NOFRAME;
}
_bpp = (is32bitEnabled() || isOpenGLEnabled()) ? 32 : 8;
_baseWidth = Options::baseXResolution;
_baseHeight = Options::baseYResolution;
}
/**
* Initializes a new display screen for the game to render contents to.
* The screen is set up based on the current options.
*/
Screen::Screen() : _baseWidth(ORIGINAL_WIDTH), _baseHeight(ORIGINAL_HEIGHT), _scaleX(1.0), _scaleY(1.0), _flags(0), _numColors(0), _firstColor(0), _pushPalette(false), _surface(0)
{
resetDisplay();
memset(deferredPalette, 0, 256*sizeof(SDL_Color));
}
/**
* Deletes the buffer from memory. The display screen itself
* is automatically freed once SDL shuts down.
*/
Screen::~Screen()
{
delete _surface;
}
/**
* Returns the screen's internal buffer surface. Any
* contents that need to be shown will be blitted to this.
* @return Pointer to the buffer surface.
*/
Surface *Screen::getSurface()
{
_pushPalette = true;
return _surface;
}
/**
* Handles screen key shortcuts.
* @param action Pointer to an action.
*/
void Screen::handle(Action *action)
{
if (Options::debug)
{
if (action->getDetails()->type == SDL_KEYDOWN && action->getDetails()->key.keysym.sym == SDLK_F8)
{
switch(Timer::gameSlowSpeed)
{
case 1: Timer::gameSlowSpeed = 5; break;
case 5: Timer::gameSlowSpeed = 15; break;
default: Timer::gameSlowSpeed = 1; break;
}
}
}
if (action->getDetails()->type == SDL_KEYDOWN && action->getDetails()->key.keysym.sym == SDLK_RETURN && (SDL_GetModState() & KMOD_ALT) != 0)
{
Options::fullscreen = !Options::fullscreen;
resetDisplay();
}
else if (action->getDetails()->type == SDL_KEYDOWN && action->getDetails()->key.keysym.sym == Options::keyScreenshot)
{
std::ostringstream ss;
int i = 0;
do
{
ss.str("");
ss << Options::getMasterUserFolder() << "screen" << std::setfill('0') << std::setw(3) << i << ".png";
i++;
}
while (CrossPlatform::fileExists(ss.str()));
screenshot(ss.str());
return;
}
}
/**
* Renders the buffer's contents onto the screen, applying
* any necessary filters or conversions in the process.
* If the scaling factor is bigger than 1, the entire contents
* of the buffer are resized by that factor (eg. 2 = doubled)
* before being put on screen.
*/
void Screen::flip()
{
if (getWidth() != _baseWidth || getHeight() != _baseHeight || isOpenGLEnabled())
{
Zoom::flipWithZoom(_surface->getSurface(), _screen, _topBlackBand, _bottomBlackBand, _leftBlackBand, _rightBlackBand, &glOutput);
}
else
{
SDL_BlitSurface(_surface->getSurface(), 0, _screen, 0);
}
// perform any requested palette update
if (_pushPalette && _numColors && _screen->format->BitsPerPixel == 8)
{
if (_screen->format->BitsPerPixel == 8 && SDL_SetColors(_screen, &(deferredPalette[_firstColor]), _firstColor, _numColors) == 0)
{
Log(LOG_DEBUG) << "Display palette doesn't match requested palette";
}
_numColors = 0;
_pushPalette = false;
}
if (SDL_Flip(_screen) == -1)
{
throw Exception(SDL_GetError());
}
}
/**
* Clears all the contents out of the internal buffer.
*/
void Screen::clear()
{
_surface->clear();
if (_screen->flags & SDL_SWSURFACE) memset(_screen->pixels, 0, _screen->h*_screen->pitch);
else SDL_FillRect(_screen, &_clear, 0);
}
/**
* Changes the 8bpp palette used to render the screen's contents.
* @param colors Pointer to the set of colors.
* @param firstcolor Offset of the first color to replace.
* @param ncolors Amount of colors to replace.
* @param immediately Apply palette changes immediately, otherwise wait for next blit.
*/
void Screen::setPalette(SDL_Color* colors, int firstcolor, int ncolors, bool immediately)
{
if (_numColors && (_numColors != ncolors) && (_firstColor != firstcolor))
{
// an initial palette setup has not been committed to the screen yet
// just update it with whatever colors are being sent now
memmove(&(deferredPalette[firstcolor]), colors, sizeof(SDL_Color)*ncolors);
_numColors = 256; // all the use cases are just a full palette with 16-color follow-ups
_firstColor = 0;
} else
{
memmove(&(deferredPalette[firstcolor]), colors, sizeof(SDL_Color) * ncolors);
_numColors = ncolors;
_firstColor = firstcolor;
}
_surface->setPalette(colors, firstcolor, ncolors);
// defer actual update of screen until SDL_Flip()
if (immediately && _screen->format->BitsPerPixel == 8 && SDL_SetColors(_screen, colors, firstcolor, ncolors) == 0)
{
Log(LOG_DEBUG) << "Display palette doesn't match requested palette";
}
// Sanity check
/*
SDL_Color *newcolors = _screen->format->palette->colors;
for (int i = firstcolor, j = 0; i < firstcolor + ncolors; i++, j++)
{
Log(LOG_DEBUG) << (int)newcolors[i].r << " - " << (int)newcolors[i].g << " - " << (int)newcolors[i].b;
Log(LOG_DEBUG) << (int)colors[j].r << " + " << (int)colors[j].g << " + " << (int)colors[j].b;
if (newcolors[i].r != colors[j].r ||
newcolors[i].g != colors[j].g ||
newcolors[i].b != colors[j].b)
{
Log(LOG_ERROR) << "Display palette doesn't match requested palette";
break;
}
}
*/
}
/**
* Returns the screen's 8bpp palette.
* @return Pointer to the palette's colors.
*/
SDL_Color *Screen::getPalette() const
{
return (SDL_Color*)deferredPalette;
}
/**
* Returns the width of the screen.
* @return Width in pixels.
*/
int Screen::getWidth() const
{
return _screen->w;
}
/**
* Returns the height of the screen.
* @return Height in pixels
*/
int Screen::getHeight() const
{
return _screen->h;
}
/**
* Resets the screen surfaces based on the current display options,
* as they don't automatically take effect.
* @param resetVideo Reset display surface.
*/
void Screen::resetDisplay(bool resetVideo)
{
int width = Options::displayWidth;
int height = Options::displayHeight;
#ifdef __linux__
Uint32 oldFlags = _flags;
#endif
makeVideoFlags();
if (!_surface || (_surface->getSurface()->format->BitsPerPixel != _bpp ||
_surface->getSurface()->w != _baseWidth ||
_surface->getSurface()->h != _baseHeight)) // don't reallocate _surface if not necessary, it's a waste of CPU cycles
{
if (_surface) delete _surface;
_surface = new Surface(_baseWidth, _baseHeight, 0, 0, Screen::is32bitEnabled() ? 32 : 8); // only HQX needs 32bpp for this surface; the OpenGL class has its own 32bpp buffer
if (_surface->getSurface()->format->BitsPerPixel == 8) _surface->setPalette(deferredPalette);
}
SDL_SetColorKey(_surface->getSurface(), 0, 0); // turn off color key!
if (resetVideo || _screen->format->BitsPerPixel != _bpp)
{
#ifdef __linux__
// Workaround for segfault when switching to opengl
if (!(oldFlags & SDL_OPENGL) && (_flags & SDL_OPENGL))
{
Uint8 cursor = 0;
char *_oldtitle = 0;
SDL_WM_GetCaption(&_oldtitle, NULL);
std::string title(_oldtitle);
SDL_QuitSubSystem(SDL_INIT_VIDEO);
SDL_InitSubSystem(SDL_INIT_VIDEO);
SDL_ShowCursor(SDL_ENABLE);
SDL_EnableUNICODE(1);
SDL_WM_SetCaption(title.c_str(), 0);
SDL_SetCursor(SDL_CreateCursor(&cursor, &cursor, 1,1,0,0));
}
#endif
Log(LOG_INFO) << "Attempting to set display to " << width << "x" << height << "x" << _bpp << "...";
_screen = SDL_SetVideoMode(width, height, _bpp, _flags);
if (_screen == 0)
{
Log(LOG_ERROR) << SDL_GetError();
Log(LOG_INFO) << "Attempting to set display to default resolution...";
_screen = SDL_SetVideoMode(640, 400, _bpp, _flags);
if (_screen == 0)
{
throw Exception(SDL_GetError());
}
}
Log(LOG_INFO) << "Display set to " << getWidth() << "x" << getHeight() << "x" << (int)_screen->format->BitsPerPixel << ".";
}
else
{
clear();
}
Options::displayWidth = getWidth();
Options::displayHeight = getHeight();
_scaleX = getWidth() / (double)_baseWidth;
_scaleY = getHeight() / (double)_baseHeight;
_clear.x = 0;
_clear.y = 0;
_clear.w = getWidth();
_clear.h = getHeight();
double pixelRatioY = 1.0;
if (Options::nonSquarePixelRatio && !Options::allowResize)
{
pixelRatioY = 1.2;
}
bool cursorInBlackBands;
if (!Options::keepAspectRatio)
{
cursorInBlackBands = false;
}
else if (Options::fullscreen)
{
cursorInBlackBands = Options::cursorInBlackBandsInFullscreen;
}
else if (!Options::borderless)
{
cursorInBlackBands = Options::cursorInBlackBandsInWindow;
}
else
{
cursorInBlackBands = Options::cursorInBlackBandsInBorderlessWindow;
}
if (_scaleX > _scaleY && Options::keepAspectRatio)
{
int targetWidth = (int)floor(_scaleY * (double)_baseWidth);
_topBlackBand = _bottomBlackBand = 0;
_leftBlackBand = (getWidth() - targetWidth) / 2;
if (_leftBlackBand < 0)
{
_leftBlackBand = 0;
}
_rightBlackBand = getWidth() - targetWidth - _leftBlackBand;
_cursorTopBlackBand = 0;
if (cursorInBlackBands)
{
_scaleX = _scaleY;
_cursorLeftBlackBand = _leftBlackBand;
}
else
{
_cursorLeftBlackBand = 0;
}
}
else if (_scaleY > _scaleX && Options::keepAspectRatio)
{
int targetHeight = (int)floor(_scaleX * (double)_baseHeight * pixelRatioY);
_topBlackBand = (getHeight() - targetHeight) / 2;
if (_topBlackBand < 0)
{
_topBlackBand = 0;
}
_bottomBlackBand = getHeight() - targetHeight - _topBlackBand;
if (_bottomBlackBand < 0)
{
_bottomBlackBand = 0;
}
_leftBlackBand = _rightBlackBand = 0;
_cursorLeftBlackBand = 0;
if (cursorInBlackBands)
{
_scaleY = _scaleX;
_cursorTopBlackBand = _topBlackBand;
}
else
{
_cursorTopBlackBand = 0;
}
}
else
{
_topBlackBand = _bottomBlackBand = _leftBlackBand = _rightBlackBand = _cursorTopBlackBand = _cursorLeftBlackBand = 0;
}
if (isOpenGLEnabled())
{
#ifndef __NO_OPENGL
glOutput.init(_baseWidth, _baseHeight);
glOutput.linear = Options::useOpenGLSmoothing; // setting from shader file will override this, though
if (!FileMap::isResourcesEmpty())
{
glOutput.set_shader(FileMap::getFilePath(Options::useOpenGLShader).c_str());
}
glOutput.setVSync(Options::vSyncForOpenGL);
OpenGL::checkErrors = Options::checkOpenGLErrors;
#endif
}
if (_screen->format->BitsPerPixel == 8)
{
setPalette(getPalette());
}
}
/**
* Returns the screen's X scale.
* @return Scale factor.
*/
double Screen::getXScale() const
{
return _scaleX;
}
/**
* Returns the screen's Y scale.
* @return Scale factor.
*/
double Screen::getYScale() const
{
return _scaleY;
}
/**
* Returns the screen's top black forbidden to cursor band's height.
* @return Height in pixel.
*/
int Screen::getCursorTopBlackBand() const
{
return _cursorTopBlackBand;
}
/**
* Returns the screen's left black forbidden to cursor band's width.
* @return Width in pixel.
*/
int Screen::getCursorLeftBlackBand() const
{
return _cursorLeftBlackBand;
}
/**
* Saves a screenshot of the screen's contents.
* @param filename Filename of the PNG file.
*/
void Screen::screenshot(const std::string &filename) const
{
SDL_Surface *screenshot = SDL_AllocSurface(0, getWidth() - getWidth()%4, getHeight(), 24, 0xff, 0xff00, 0xff0000, 0);
if (isOpenGLEnabled())
{
#ifndef __NO_OPENGL
GLenum format = GL_RGB;
for (int y = 0; y < getHeight(); ++y)
{
glReadPixels(0, getHeight()-(y+1), getWidth() - getWidth()%4, 1, format, GL_UNSIGNED_BYTE, ((Uint8*)screenshot->pixels) + y*screenshot->pitch);
}
glErrorCheck();
#endif
}
else
{
SDL_BlitSurface(_screen, 0, screenshot, 0);
}
unsigned error = lodepng::encode(filename, (const unsigned char *)(screenshot->pixels), getWidth() - getWidth()%4, getHeight(), LCT_RGB);
if (error)
{
Log(LOG_ERROR) << "Saving to PNG failed: " << lodepng_error_text(error);
}
SDL_FreeSurface(screenshot);
}
/**
* Check whether a 32bpp scaler has been selected.
* @return if it is enabled with a compatible resolution.
*/
bool Screen::is32bitEnabled()
{
int w = Options::displayWidth;
int h = Options::displayHeight;
int baseW = Options::baseXResolution;
int baseH = Options::baseYResolution;
return ((Options::useHQXFilter || Options::useXBRZFilter) && (
(w == baseW * 2 && h == baseH * 2) ||
(w == baseW * 3 && h == baseH * 3) ||
(w == baseW * 4 && h == baseH * 4) ||
(w == baseW * 5 && h == baseH * 5 && Options::useXBRZFilter)));
}
/**
* Check if OpenGL is enabled.
* @return if it is enabled.
*/
bool Screen::isOpenGLEnabled()
{
#ifdef __NO_OPENGL
return false;
#else
return Options::useOpenGL;
#endif
}
/**
* Gets the Horizontal offset from the mid-point of the screen, in pixels.
* @return the horizontal offset.
*/
int Screen::getDX() const
{
return (_baseWidth - ORIGINAL_WIDTH) / 2;
}
/**
* Gets the Vertical offset from the mid-point of the screen, in pixels.
* @return the vertical offset.
*/
int Screen::getDY() const
{
return (_baseHeight - ORIGINAL_HEIGHT) / 2;
}
/**
* Changes a given scale, and if necessary, switch the current base resolution.
* @param type reference to which scale option we are using, battlescape or geoscape.
* @param selection the new scale level.
* @param width reference to which x scale to adjust.
* @param height reference to which y scale to adjust.
* @param change should we change the current scale.
*/
void Screen::updateScale(int &type, int selection, int &width, int &height, bool change)
{
double pixelRatioY = 1.0;
if (Options::nonSquarePixelRatio)
{
pixelRatioY = 1.2;
}
type = selection;
switch (type)
{
case SCALE_15X:
width = Screen::ORIGINAL_WIDTH * 1.5;
height = Screen::ORIGINAL_HEIGHT * 1.5;
break;
case SCALE_2X:
width = Screen::ORIGINAL_WIDTH * 2;
height = Screen::ORIGINAL_HEIGHT * 2;
break;
case SCALE_SCREEN_DIV_3:
width = Options::displayWidth / 3;
height = Options::displayHeight / pixelRatioY / 3;
break;
case SCALE_SCREEN_DIV_2:
width = Options::displayWidth / 2;
height = Options::displayHeight / pixelRatioY / 2.0;
break;
case SCALE_SCREEN:
width = Options::displayWidth;
height = Options::displayHeight / pixelRatioY;
break;
case SCALE_ORIGINAL:
default:
width = Screen::ORIGINAL_WIDTH;
height = Screen::ORIGINAL_HEIGHT;
break;
}
// don't go under minimum resolution... it's bad, mmkay?
width = std::max(width, Screen::ORIGINAL_WIDTH);
height = std::max(height, Screen::ORIGINAL_HEIGHT);
if (change && (Options::baseXResolution != width || Options::baseYResolution != height))
{
Options::baseXResolution = width;
Options::baseYResolution = height;
}
}
}