2 Copyright (C) 2018-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "gl_video_view.h"
22 #include "film_viewer.h"
24 #include "lib/image.h"
25 #include "lib/dcpomatic_assert.h"
26 #include "lib/exceptions.h"
27 #include "lib/cross.h"
28 #include "lib/player_video.h"
29 #include "lib/butler.h"
30 #include <boost/bind/bind.hpp>
34 #include <OpenGL/glu.h>
35 #include <OpenGL/glext.h>
36 #include <OpenGL/CGLTypes.h>
37 #include <OpenGL/OpenGL.h>
40 #ifdef DCPOMATIC_LINUX
45 #ifdef DCPOMATIC_WINDOWS
48 #include <GL/wglext.h>
52 using std::shared_ptr;
53 using boost::optional;
54 #if BOOST_VERSION >= 106100
55 using namespace boost::placeholders;
60 check_gl_error (char const * last)
62 GLenum const e = glGetError ();
63 if (e != GL_NO_ERROR) {
64 throw GLError (last, e);
69 GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
72 , _have_storage (false)
73 , _vsync_enabled (false)
77 _canvas = new wxGLCanvas (parent, wxID_ANY, 0, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE);
78 _canvas->Bind (wxEVT_PAINT, boost::bind(&GLVideoView::update, this));
79 _canvas->Bind (wxEVT_SIZE, boost::bind(boost::ref(Sized)));
81 _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
82 _timer.reset (new wxTimer(_canvas));
86 GLVideoView::~GLVideoView ()
88 boost::this_thread::disable_interruption dis;
95 glDeleteTextures (1, &_id);
99 GLVideoView::check_for_butler_errors ()
101 if (!_viewer->butler()) {
106 _viewer->butler()->rethrow ();
107 } catch (DecodeError& e) {
108 error_dialog (get(), e.what());
114 GLVideoView::update ()
117 boost::mutex::scoped_lock lm (_canvas_mutex);
118 if (!_canvas->IsShownOnScreen()) {
123 /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
128 if (!_thread.joinable()) {
129 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
137 GLVideoView::ensure_context ()
140 _context = new wxGLContext (_canvas);
141 _canvas->SetCurrent (*_context);
146 GLVideoView::draw (Position<int> inter_position, dcp::Size inter_size)
148 glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
149 check_gl_error ("glClear");
151 glClearColor (0.0f, 0.0f, 0.0f, 1.0f);
152 check_gl_error ("glClearColor");
153 glEnable (GL_TEXTURE_2D);
154 check_gl_error ("glEnable GL_TEXTURE_2D");
156 check_gl_error ("glEnable GL_BLEND");
157 glDisable (GL_DEPTH_TEST);
158 check_gl_error ("glDisable GL_DEPTH_TEST");
159 glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
163 boost::mutex::scoped_lock lm (_canvas_mutex);
165 canvas_size = _canvas->GetSize ();
169 if (canvas_size.GetWidth() < 64 || canvas_size.GetHeight() < 0) {
173 glViewport (0, 0, canvas_size.GetWidth(), canvas_size.GetHeight());
174 check_gl_error ("glViewport");
175 glMatrixMode (GL_PROJECTION);
178 DCPOMATIC_DISABLE_WARNINGS
179 gluOrtho2D (0, canvas_size.GetWidth(), canvas_size.GetHeight(), 0);
180 DCPOMATIC_ENABLE_WARNINGS
181 check_gl_error ("gluOrtho2d");
182 glMatrixMode (GL_MODELVIEW);
185 glTranslatef (0, 0, 0);
187 dcp::Size const out_size = _viewer->out_size ();
190 /* Render our image (texture) */
193 glVertex2f (0, _size->height);
195 glVertex2f (_size->width, _size->height);
197 glVertex2f (_size->width, 0);
202 /* No image, so just fill with black */
204 glColor3ub (0, 0, 0);
206 glVertex2f (out_size.width, 0);
207 glVertex2f (out_size.width, out_size.height);
208 glVertex2f (0, out_size.height);
213 if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
215 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
216 glColor3ub (240, 240, 240);
217 glVertex2f (out_size.width, 0);
218 glVertex2f (canvas_size.GetWidth(), 0);
219 glVertex2f (canvas_size.GetWidth(), canvas_size.GetHeight());
220 glVertex2f (out_size.width, canvas_size.GetHeight());
222 glColor3ub (255, 255, 255);
225 if (!_viewer->pad_black() && out_size.height < canvas_size.GetHeight()) {
226 glColor3ub (240, 240, 240);
227 int const gap = (canvas_size.GetHeight() - out_size.height) / 2;
230 glVertex2f (canvas_size.GetWidth(), 0);
231 glVertex2f (canvas_size.GetWidth(), gap);
235 glVertex2f (0, gap + out_size.height + 1);
236 glVertex2f (canvas_size.GetWidth(), gap + out_size.height + 1);
237 glVertex2f (canvas_size.GetWidth(), 2 * gap + out_size.height + 2);
238 glVertex2f (0, 2 * gap + out_size.height + 2);
240 glColor3ub (255, 255, 255);
243 if (_viewer->outline_content()) {
244 glColor3ub (255, 0, 0);
245 glBegin (GL_LINE_LOOP);
246 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
247 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
248 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
249 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
251 glColor3ub (255, 255, 255);
255 check_gl_error ("glFlush");
257 boost::mutex::scoped_lock lm (_canvas_mutex);
258 _canvas->SwapBuffers();
262 GLVideoView::set_image (shared_ptr<const Image> image)
265 _size = optional<dcp::Size>();
269 DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
270 DCPOMATIC_ASSERT (!image->aligned());
272 if (image->size() != _size) {
273 _have_storage = false;
276 _size = image->size ();
277 glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
278 check_gl_error ("glPixelStorei");
280 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _size->width, _size->height, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
281 check_gl_error ("glTexSubImage2D");
283 glTexImage2D (GL_TEXTURE_2D, 0, GL_RGB8, _size->width, _size->height, 0, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
284 _have_storage = true;
285 check_gl_error ("glTexImage2D");
288 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
289 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
290 check_gl_error ("glTexParameteri");
292 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
293 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
294 check_gl_error ("glTexParameterf");
298 GLVideoView::start ()
302 boost::mutex::scoped_lock lm (_playing_mutex);
304 _thread_work_condition.notify_all ();
310 boost::mutex::scoped_lock lm (_playing_mutex);
316 GLVideoView::thread_playing ()
318 if (length() != dcpomatic::DCPTime()) {
319 dcpomatic::DCPTime const next = position() + one_video_frame();
321 if (next >= length()) {
322 _viewer->finished ();
326 get_next_frame (false);
327 set_image_and_draw ();
331 optional<int> n = time_until_next_frame();
335 get_next_frame (true);
342 GLVideoView::set_image_and_draw ()
344 shared_ptr<PlayerVideo> pv = player_video().first;
346 set_image (pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true));
347 draw (pv->inter_position(), pv->inter_size());
348 _viewer->image_changed (pv);
354 GLVideoView::thread ()
358 boost::mutex::scoped_lock lm (_canvas_mutex);
360 #if defined(DCPOMATIC_OSX)
361 /* Without this we see errors like
362 * ../src/osx/cocoa/glcanvas.mm(194): assert ""context"" failed in SwapBuffers(): should have current context [in thread 700006970000]
364 WXGLSetCurrentContext (_context->GetWXGLContext());
366 /* We must call this here on Linux otherwise we get no image (for reasons
367 * that aren't clear). However, doing ensure_context() from this thread
369 * "[NSOpenGLContext setView:] must be called from the main thread".
375 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
376 if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
378 Display* dpy = wxGetX11Display();
379 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
380 _vsync_enabled = true;
384 #ifdef DCPOMATIC_WINDOWS
385 if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
387 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
390 _vsync_enabled = true;
398 GLint swapInterval = 1;
399 CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
400 _vsync_enabled = true;
403 glGenTextures (1, &_id);
404 check_gl_error ("glGenTextures");
405 glBindTexture (GL_TEXTURE_2D, _id);
406 check_gl_error ("glBindTexture");
407 glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
408 check_gl_error ("glPixelStorei");
411 boost::mutex::scoped_lock lm (_playing_mutex);
412 while (!_playing && !_one_shot) {
413 _thread_work_condition.wait (lm);
419 } else if (_one_shot) {
421 set_image_and_draw ();
424 boost::this_thread::interruption_point ();
425 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
428 /* XXX: leaks _context, but that seems preferable to deleting it here
429 * without also deleting the wxGLCanvas.
432 catch (boost::thread_interrupted& e)
438 VideoView::NextFrameResult
439 GLVideoView::display_next_frame (bool non_blocking)
441 NextFrameResult const r = get_next_frame (non_blocking);
448 GLVideoView::request_one_shot ()
450 boost::mutex::scoped_lock lm (_playing_mutex);
452 _thread_work_condition.notify_all ();