src/wx/gl_video_view.cc

   1 /*
   2     Copyright (C) 2018-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "gl_video_view.h"
  22 #include "film_viewer.h"
  23 #include "wx_util.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>
  31 #include <iostream>
  32
  33 #ifdef DCPOMATIC_OSX
  34 #include <OpenGL/glu.h>
  35 #include <OpenGL/glext.h>
  36 #include <OpenGL/CGLTypes.h>
  37 #include <OpenGL/OpenGL.h>
  38 #endif
  39
  40 #ifdef DCPOMATIC_LINUX
  41 #include <GL/glu.h>
  42 #include <GL/glext.h>
  43 #endif
  44
  45 #ifdef DCPOMATIC_WINDOWS
  46 #include <GL/glu.h>
  47 #include <GL/glext.h>
  48 #include <GL/wglext.h>
  49 #endif
  50
  51 using std::cout;
  52 using std::shared_ptr;
  53 using boost::optional;
  54 #if BOOST_VERSION >= 106100
  55 using namespace boost::placeholders;
  56 #endif
  57
  58
  59 static void
  60 check_gl_error (char const * last)
  61 {
  62         GLenum const e = glGetError ();
  63         if (e != GL_NO_ERROR) {
  64                 throw GLError (last, e);
  65         }
  66 }
  67
  68
  69 GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
  70         : VideoView (viewer)
  71         , _context (nullptr)
  72         , _have_storage (false)
  73         , _vsync_enabled (false)
  74         , _playing (false)
  75         , _one_shot (false)
  76 {
  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)));
  80
  81         _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
  82         _timer.reset (new wxTimer(_canvas));
  83         _timer->Start (2000);
  84 }
  85
  86 GLVideoView::~GLVideoView ()
  87 {
  88         boost::this_thread::disable_interruption dis;
  89
  90         try {
  91                 _thread.interrupt ();
  92                 _thread.join ();
  93         } catch (...) {}
  94
  95         glDeleteTextures (1, &_id);
  96 }
  97
  98 void
  99 GLVideoView::check_for_butler_errors ()
 100 {
 101         if (!_viewer->butler()) {
 102                 return;
 103         }
 104
 105         try {
 106                 _viewer->butler()->rethrow ();
 107         } catch (DecodeError& e) {
 108                 error_dialog (get(), e.what());
 109         }
 110 }
 111
 112
 113 void
 114 GLVideoView::update ()
 115 {
 116         {
 117                 boost::mutex::scoped_lock lm (_canvas_mutex);
 118                 if (!_canvas->IsShownOnScreen()) {
 119                         return;
 120                 }
 121
 122 #ifdef DCPOMATIC_OSX
 123                 /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
 124                 ensure_context ();
 125 #endif
 126         }
 127
 128         if (!_thread.joinable()) {
 129                 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
 130         }
 131
 132         request_one_shot ();
 133 }
 134
 135
 136 void
 137 GLVideoView::ensure_context ()
 138 {
 139         if (!_context) {
 140                 _context = new wxGLContext (_canvas);
 141                 _canvas->SetCurrent (*_context);
 142         }
 143 }
 144
 145 void
 146 GLVideoView::draw (Position<int> inter_position, dcp::Size inter_size)
 147 {
 148         glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 149         check_gl_error ("glClear");
 150
 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");
 155         glEnable (GL_BLEND);
 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);
 160
 161         wxSize canvas_size;
 162         {
 163                 boost::mutex::scoped_lock lm (_canvas_mutex);
 164                 if (_canvas) {
 165                         canvas_size = _canvas->GetSize ();
 166                 }
 167         }
 168
 169         if (canvas_size.GetWidth() < 64 || canvas_size.GetHeight() < 0) {
 170                 return;
 171         }
 172
 173         glViewport (0, 0, canvas_size.GetWidth(), canvas_size.GetHeight());
 174         check_gl_error ("glViewport");
 175         glMatrixMode (GL_PROJECTION);
 176         glLoadIdentity ();
 177
 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);
 183         glLoadIdentity ();
 184
 185         glTranslatef (0, 0, 0);
 186
 187         dcp::Size const out_size = _viewer->out_size ();
 188
 189         if (_size) {
 190                 /* Render our image (texture) */
 191                 glBegin (GL_QUADS);
 192                 glTexCoord2f (0, 1);
 193                 glVertex2f (0, _size->height);
 194                 glTexCoord2f (1, 1);
 195                 glVertex2f (_size->width, _size->height);
 196                 glTexCoord2f (1, 0);
 197                 glVertex2f (_size->width, 0);
 198                 glTexCoord2f (0, 0);
 199                 glVertex2f (0, 0);
 200                 glEnd ();
 201         } else {
 202                 /* No image, so just fill with black */
 203                 glBegin (GL_QUADS);
 204                 glColor3ub (0, 0, 0);
 205                 glVertex2f (0, 0);
 206                 glVertex2f (out_size.width, 0);
 207                 glVertex2f (out_size.width, out_size.height);
 208                 glVertex2f (0, out_size.height);
 209                 glVertex2f (0, 0);
 210                 glEnd ();
 211         }
 212
 213         if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
 214                 glBegin (GL_QUADS);
 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());
 221                 glEnd ();
 222                 glColor3ub (255, 255, 255);
 223         }
 224
 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;
 228                 glBegin (GL_QUADS);
 229                 glVertex2f (0, 0);
 230                 glVertex2f (canvas_size.GetWidth(), 0);
 231                 glVertex2f (canvas_size.GetWidth(), gap);
 232                 glVertex2f (0, gap);
 233                 glEnd ();
 234                 glBegin (GL_QUADS);
 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);
 239                 glEnd ();
 240                 glColor3ub (255, 255, 255);
 241         }
 242
 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);
 250                 glEnd ();
 251                 glColor3ub (255, 255, 255);
 252         }
 253
 254         glFlush();
 255         check_gl_error ("glFlush");
 256
 257         boost::mutex::scoped_lock lm (_canvas_mutex);
 258         _canvas->SwapBuffers();
 259 }
 260
 261 void
 262 GLVideoView::set_image (shared_ptr<const Image> image)
 263 {
 264         if (!image) {
 265                 _size = optional<dcp::Size>();
 266                 return;
 267         }
 268
 269         DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
 270         DCPOMATIC_ASSERT (!image->aligned());
 271
 272         if (image->size() != _size) {
 273                 _have_storage = false;
 274         }
 275
 276         _size = image->size ();
 277         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 278         check_gl_error ("glPixelStorei");
 279         if (_have_storage) {
 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");
 282         } else {
 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");
 286         }
 287
 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");
 291
 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");
 295 }
 296
 297 void
 298 GLVideoView::start ()
 299 {
 300         VideoView::start ();
 301
 302         boost::mutex::scoped_lock lm (_playing_mutex);
 303         _playing = true;
 304         _thread_work_condition.notify_all ();
 305 }
 306
 307 void
 308 GLVideoView::stop ()
 309 {
 310         boost::mutex::scoped_lock lm (_playing_mutex);
 311         _playing = false;
 312 }
 313
 314
 315 void
 316 GLVideoView::thread_playing ()
 317 {
 318         if (length() != dcpomatic::DCPTime()) {
 319                 dcpomatic::DCPTime const next = position() + one_video_frame();
 320
 321                 if (next >= length()) {
 322                         _viewer->finished ();
 323                         return;
 324                 }
 325
 326                 get_next_frame (false);
 327                 set_image_and_draw ();
 328         }
 329
 330         while (true) {
 331                 optional<int> n = time_until_next_frame();
 332                 if (!n || *n > 5) {
 333                         break;
 334                 }
 335                 get_next_frame (true);
 336                 add_dropped ();
 337         }
 338 }
 339
 340
 341 void
 342 GLVideoView::set_image_and_draw ()
 343 {
 344         shared_ptr<PlayerVideo> pv = player_video().first;
 345         if (pv) {
 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);
 349         }
 350 }
 351
 352
 353 void
 354 GLVideoView::thread ()
 355 try
 356 {
 357         {
 358                 boost::mutex::scoped_lock lm (_canvas_mutex);
 359
 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]
 363                  */
 364                 WXGLSetCurrentContext (_context->GetWXGLContext());
 365 #else
 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
 368                  * on macOS gives
 369                  * "[NSOpenGLContext setView:] must be called from the main thread".
 370                  */
 371                 ensure_context ();
 372 #endif
 373         }
 374
 375 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
 376         if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
 377                 /* Enable vsync */
 378                 Display* dpy = wxGetX11Display();
 379                 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
 380                 _vsync_enabled = true;
 381         }
 382 #endif
 383
 384 #ifdef DCPOMATIC_WINDOWS
 385         if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
 386                 /* Enable vsync */
 387                 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
 388                 if (swap) {
 389                         swap (1);
 390                         _vsync_enabled = true;
 391                 }
 392         }
 393
 394 #endif
 395
 396 #ifdef DCPOMATIC_OSX
 397         /* Enable vsync */
 398         GLint swapInterval = 1;
 399         CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
 400         _vsync_enabled = true;
 401 #endif
 402
 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");
 409
 410         while (true) {
 411                 boost::mutex::scoped_lock lm (_playing_mutex);
 412                 while (!_playing && !_one_shot) {
 413                         _thread_work_condition.wait (lm);
 414                 }
 415                 lm.unlock ();
 416
 417                 if (_playing) {
 418                         thread_playing ();
 419                 } else if (_one_shot) {
 420                         _one_shot = false;
 421                         set_image_and_draw ();
 422                 }
 423
 424                 boost::this_thread::interruption_point ();
 425                 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
 426         }
 427
 428         /* XXX: leaks _context, but that seems preferable to deleting it here
 429          * without also deleting the wxGLCanvas.
 430          */
 431 }
 432 catch (boost::thread_interrupted& e)
 433 {
 434         store_current ();
 435 }
 436
 437
 438 VideoView::NextFrameResult
 439 GLVideoView::display_next_frame (bool non_blocking)
 440 {
 441         NextFrameResult const r = get_next_frame (non_blocking);
 442         request_one_shot ();
 443         return r;
 444 }
 445
 446
 447 void
 448 GLVideoView::request_one_shot ()
 449 {
 450         boost::mutex::scoped_lock lm (_playing_mutex);
 451         _one_shot = true;
 452         _thread_work_condition.notify_all ();
 453 }
 454