OpenTTD Source: src/video/video_driver.hpp Source File

OpenTTD Source 1.11.0-RC1

video_driver.hpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef VIDEO_VIDEO_DRIVER_HPP
11 #define VIDEO_VIDEO_DRIVER_HPP
12
13 #include "../driver.h"
14 #include "../core/geometry_type.hpp"
15 #include "../core/math_func.hpp"
16 #include "../gfx_func.h"
17 #include "../settings_type.h"
18 #include "../zoom_type.h"
19 #include <atomic>
20 #include <chrono>
21 #include <condition_variable>
22 #include <mutex>
23 #include <thread>
24 #include <vector>
25
26 extern std::string _ini_videodriver;
27 extern std::vector<Dimension> _resolutions;
28 extern Dimension _cur_resolution;
29 extern bool _rightclick_emulate;
30 extern bool _video_hw_accel;
31
33 class VideoDriver : public Driver {
34 const uint DEFAULT_WINDOW_WIDTH = 640u;
35 const uint DEFAULT_WINDOW_HEIGHT = 480u;
36
37 public:
38 VideoDriver() : is_game_threaded(true), change_blitter(nullptr) {}
39
47 virtual void MakeDirty(int left, int top, int width, int height) = 0;
48
52 virtual void MainLoop() = 0;
53
60 virtual bool ChangeResolution(int w, int h) = 0;
61
67 virtual bool ToggleFullscreen(bool fullscreen) = 0;
68
73 virtual bool AfterBlitterChange()
74 {
75 return true;
76 }
77
78 virtual bool ClaimMousePointer()
79 {
80 return true;
81 }
82
87 virtual bool UseSystemCursor()
88 {
89 return false;
90 }
91
95 virtual void PopulateSystemSprites() {}
96
100 virtual void ClearSystemSprites() {}
101
110 virtual bool HasGUI() const
111 {
112 return true;
113 }
114
119 virtual bool HasEfficient8Bpp() const
120 {
121 return false;
122 }
123
128 virtual bool HasAnimBuffer()
129 {
130 return false;
131 }
132
137 virtual uint8 *GetAnimBuffer()
138 {
139 return nullptr;
140 }
141
145 virtual void EditBoxLostFocus() {}
146
150 virtual void EditBoxGainedFocus() {}
151
156 virtual std::vector<int> GetListOfMonitorRefreshRates()
157 {
158 return {};
159 }
160
164 virtual ZoomLevel GetSuggestedUIZoom()
165 {
166 float dpi_scale = this->GetDPIScale();
167
168 if (dpi_scale >= 3.0f) return ZOOM_LVL_NORMAL;
169 if (dpi_scale >= 1.5f) return ZOOM_LVL_OUT_2X;
170 return ZOOM_LVL_OUT_4X;
171 }
172
177 void ChangeBlitter(const char *new_blitter)
178 {
179 this->change_blitter = new_blitter;
180 }
181
182 void GameLoopPause();
183
187 static VideoDriver *GetInstance() {
188 return static_cast<VideoDriver*>(*DriverFactoryBase::GetActiveDriver(Driver::DT_VIDEO));
189 }
190
195 struct VideoBufferLocker {
196 VideoBufferLocker()
197 {
198 this->unlock = VideoDriver::GetInstance()->LockVideoBuffer();
199 }
200
201 ~VideoBufferLocker()
202 {
203 if (this->unlock) VideoDriver::GetInstance()->UnlockVideoBuffer();
204 }
205
206 private:
207 bool unlock;
208 };
209
210 protected:
211 const uint ALLOWED_DRIFT = 5;
212
216 virtual Dimension GetScreenSize() const { return { DEFAULT_WINDOW_WIDTH, DEFAULT_WINDOW_HEIGHT }; }
217
222 virtual float GetDPIScale() { return 1.0f; }
223
227 void UpdateAutoResolution()
228 {
229 if (_cur_resolution.width == 0 || _cur_resolution.height == 0) {
230 /* Auto-detect a good resolution. We aim for 75% of the screen size.
231 * Limit width times height times bytes per pixel to fit a 32 bit
232 * integer, This way all internal drawing routines work correctly. */
233 Dimension res = this->GetScreenSize();
234 _cur_resolution.width = ClampU(res.width * 3 / 4, DEFAULT_WINDOW_WIDTH, UINT16_MAX / 2);
235 _cur_resolution.height = ClampU(res.height * 3 / 4, DEFAULT_WINDOW_HEIGHT, UINT16_MAX / 2);
236 }
237 }
238
242 virtual void InputLoop() {}
243
248 virtual bool LockVideoBuffer() {
249 return false;
250 }
251
255 virtual void UnlockVideoBuffer() {}
256
260 virtual void Paint() {}
261
265 virtual void CheckPaletteAnim() {}
266
271 virtual bool PollEvent() { return false; };
272
276 void StartGameThread();
277
281 void StopGameThread();
282
288 void Tick();
289
293 void SleepTillNextTick();
294
295 std::chrono::steady_clock::duration GetGameInterval()
296 {
297 /* If we are paused, run on normal speed. */
298 if (_pause_mode) return std::chrono::milliseconds(MILLISECONDS_PER_TICK);
299 /* Infinite speed, as quickly as you can. */
300 if (_game_speed == 0) return std::chrono::microseconds(0);
301
302 return std::chrono::microseconds(MILLISECONDS_PER_TICK * 1000 * 100 / _game_speed);
303 }
304
305 std::chrono::steady_clock::duration GetDrawInterval()
306 {
307 return std::chrono::microseconds(1000000 / _settings_client.gui.refresh_rate);
308 }
309
310 std::chrono::steady_clock::time_point next_game_tick;
311 std::chrono::steady_clock::time_point next_draw_tick;
312
313 bool fast_forward_key_pressed;
314 bool fast_forward_via_key;
315
316 bool is_game_threaded;
317 std::thread game_thread;
318 std::mutex game_state_mutex;
319 std::mutex game_thread_wait_mutex;
320
321 static void GameThreadThunk(VideoDriver *drv);
322
323 private:
324 void GameLoop();
325 void GameThread();
326 void RealChangeBlitter(const char *repl_blitter);
327
328 const char *change_blitter;
329 };
330
331 #endif /* VIDEO_VIDEO_DRIVER_HPP */
VideoDriver::Tick
void Tick()
Give the video-driver a tick.
Definition: video_driver.cpp:120
GUISettings::refresh_rate
uint16 refresh_rate
How often we refresh the screen (time between draw-ticks).
Definition: settings_type.h:160
VideoDriver::HasAnimBuffer
virtual bool HasAnimBuffer()
Does this video driver support a separate animation buffer in addition to the colour buffer?
Definition: video_driver.hpp:128
ZOOM_LVL_OUT_2X
@ ZOOM_LVL_OUT_2X
Zoomed 2 times out.
Definition: zoom_type.h:25
DriverFactoryBase::GetActiveDriver
static Driver ** GetActiveDriver(Driver::Type type)
Get the active driver for the given type.
Definition: driver.h:86
VideoDriver
The base of all video drivers.
Definition: video_driver.hpp:33
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
VideoDriver::CheckPaletteAnim
virtual void CheckPaletteAnim()
Process any pending palette animation.
Definition: video_driver.hpp:265
VideoDriver::ChangeBlitter
void ChangeBlitter(const char *new_blitter)
Queue a request to change the blitter.
Definition: video_driver.hpp:177
VideoDriver::MakeDirty
virtual void MakeDirty(int left, int top, int width, int height)=0
Mark a particular area dirty.
VideoDriver::ToggleFullscreen
virtual bool ToggleFullscreen(bool fullscreen)=0
Change the full screen setting.
_cur_resolution
Dimension _cur_resolution
The current resolution.
Definition: driver.cpp:25
ClampU
static uint ClampU(const uint a, const uint min, const uint max)
Clamp an unsigned integer between an interval.
Definition: math_func.hpp:122
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:79
VideoDriver::HasGUI
virtual bool HasGUI() const
Whether the driver has a graphical user interface with the end user.
Definition: video_driver.hpp:110
VideoDriver::StartGameThread
void StartGameThread()
Start the loop for game-tick.
Definition: video_driver.cpp:83
VideoDriver::GetSuggestedUIZoom
virtual ZoomLevel GetSuggestedUIZoom()
Get a suggested default GUI zoom taking screen DPI into account.
Definition: video_driver.hpp:164
VideoDriver::ClearSystemSprites
virtual void ClearSystemSprites()
Clear all cached sprites.
Definition: video_driver.hpp:100
VideoDriver::GetDPIScale
virtual float GetDPIScale()
Get DPI scaling factor of the screen OTTD is displayed on.
Definition: video_driver.hpp:222
VideoDriver::DEFAULT_WINDOW_HEIGHT
const uint DEFAULT_WINDOW_HEIGHT
Default window height.
Definition: video_driver.hpp:35
VideoDriver::InputLoop
virtual void InputLoop()
Handle input logic, is CTRL pressed, should we fast-forward, etc.
Definition: video_driver.hpp:242
VideoDriver::GetListOfMonitorRefreshRates
virtual std::vector< int > GetListOfMonitorRefreshRates()
Get a list of refresh rates of each available monitor.
Definition: video_driver.hpp:156
VideoDriver::Paint
virtual void Paint()
Paint the window.
Definition: video_driver.hpp:260
_rightclick_emulate
bool _rightclick_emulate
Whether right clicking is emulated.
Definition: driver.cpp:26
VideoDriver::ALLOWED_DRIFT
const uint ALLOWED_DRIFT
How many times videodriver can miss deadlines without it being overly compensated.
Definition: video_driver.hpp:211
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
VideoDriver::ChangeResolution
virtual bool ChangeResolution(int w, int h)=0
Change the resolution of the window.
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:187
VideoDriver::UnlockVideoBuffer
virtual void UnlockVideoBuffer()
Unlock a previously locked video buffer.
Definition: video_driver.hpp:255
VideoDriver::GetAnimBuffer
virtual uint8 * GetAnimBuffer()
Get a pointer to the animation buffer of the video back-end.
Definition: video_driver.hpp:137
VideoDriver::UseSystemCursor
virtual bool UseSystemCursor()
Get whether the mouse cursor is drawn by the video driver.
Definition: video_driver.hpp:87
VideoDriver::GameLoopPause
void GameLoopPause()
Pause the game-loop for a bit, releasing the game-state lock.
Definition: video_driver.cpp:63
VideoDriver::StopGameThread
void StopGameThread()
Stop the loop for the game-tick.
Definition: video_driver.cpp:92
VideoDriver::PopulateSystemSprites
virtual void PopulateSystemSprites()
Populate all sprites in cache.
Definition: video_driver.hpp:95
VideoDriver::UpdateAutoResolution
void UpdateAutoResolution()
Apply resolution auto-detection and clamp to sensible defaults.
Definition: video_driver.hpp:227
Driver::DT_VIDEO
@ DT_VIDEO
A video driver.
Definition: driver.h:44
VideoDriver::VideoBufferLocker::unlock
bool unlock
Stores if the lock did anything that has to be undone.
Definition: video_driver.hpp:207
_ini_videodriver
std::string _ini_videodriver
The video driver a stored in the configuration file.
Definition: driver.cpp:23
VideoDriver::fast_forward_via_key
bool fast_forward_via_key
The fast-forward was enabled by key press.
Definition: video_driver.hpp:314
_video_hw_accel
bool _video_hw_accel
Whether to consider hardware accelerated video drivers.
Definition: video_driver.cpp:23
MILLISECONDS_PER_TICK
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
Definition: gfx_type.h:310
VideoDriver::SleepTillNextTick
void SleepTillNextTick()
Sleep till the next tick is about to happen.
Definition: video_driver.cpp:184
VideoDriver::MainLoop
virtual void MainLoop()=0
Perform the actual drawing.
VideoDriver::fast_forward_key_pressed
bool fast_forward_key_pressed
The fast-forward key is being pressed.
Definition: video_driver.hpp:313
VideoDriver::HasEfficient8Bpp
virtual bool HasEfficient8Bpp() const
Has this video driver an efficient code path for palette animated 8-bpp sprites?
Definition: video_driver.hpp:119
VideoDriver::change_blitter
const char * change_blitter
Request to change the blitter. nullptr if no pending request.
Definition: video_driver.hpp:328
VideoDriver::LockVideoBuffer
virtual bool LockVideoBuffer()
Make sure the video buffer is ready for drawing.
Definition: video_driver.hpp:248
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:24
VideoDriver::EditBoxLostFocus
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Definition: video_driver.hpp:145
VideoDriver::DEFAULT_WINDOW_WIDTH
const uint DEFAULT_WINDOW_WIDTH
Default window width.
Definition: video_driver.hpp:34
Driver
A driver for communicating with the user.
Definition: driver.h:23
ZOOM_LVL_OUT_4X
@ ZOOM_LVL_OUT_4X
Zoomed 4 times out.
Definition: zoom_type.h:26
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:24
VideoDriver::PollEvent
virtual bool PollEvent()
Process a single system event.
Definition: video_driver.hpp:271
VideoDriver::VideoBufferLocker
Helper struct to ensure the video buffer is locked and ready for drawing.
Definition: video_driver.hpp:195
_game_speed
uint16 _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition: gfx.cpp:37
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:577
VideoDriver::GetScreenSize
virtual Dimension GetScreenSize() const
Get the resolution of the main screen.
Definition: video_driver.hpp:216
VideoDriver::EditBoxGainedFocus
virtual void EditBoxGainedFocus()
An edit box gained the input focus.
Definition: video_driver.hpp:150
VideoDriver::AfterBlitterChange
virtual bool AfterBlitterChange()
Callback invoked after the blitter was changed.
Definition: video_driver.hpp:73