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         } catch (dcp::ReadError& e) {
 110                 error_dialog (get(), wxString::Format(_("Could not read DCP: %s"), std_to_wx(e.what())));
 111         }
 112 }
 113
 114
 115 void
 116 GLVideoView::update ()
 117 {
 118         {
 119                 boost::mutex::scoped_lock lm (_canvas_mutex);
 120                 if (!_canvas->IsShownOnScreen()) {
 121                         return;
 122                 }
 123
 124 #ifdef DCPOMATIC_OSX
 125                 /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
 126                 ensure_context ();
 127 #endif
 128         }
 129
 130         if (!_thread.joinable()) {
 131                 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
 132         }
 133
 134         request_one_shot ();
 135 }
 136
 137
 138 void
 139 GLVideoView::ensure_context ()
 140 {
 141         if (!_context) {
 142                 _context = new wxGLContext (_canvas);
 143                 _canvas->SetCurrent (*_context);
 144         }
 145 }
 146
 147 void
 148 GLVideoView::draw (Position<int> inter_position, dcp::Size inter_size)
 149 {
 150         glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 151         check_gl_error ("glClear");
 152
 153         glClearColor (0.0f, 0.0f, 0.0f, 1.0f);
 154         check_gl_error ("glClearColor");
 155         glEnable (GL_TEXTURE_2D);
 156         check_gl_error ("glEnable GL_TEXTURE_2D");
 157         glEnable (GL_BLEND);
 158         check_gl_error ("glEnable GL_BLEND");
 159         glDisable (GL_DEPTH_TEST);
 160         check_gl_error ("glDisable GL_DEPTH_TEST");
 161         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 162
 163         wxSize canvas_size;
 164         {
 165                 boost::mutex::scoped_lock lm (_canvas_mutex);
 166                 if (_canvas) {
 167                         canvas_size = _canvas->GetSize ();
 168                 }
 169         }
 170
 171         if (canvas_size.GetWidth() < 64 || canvas_size.GetHeight() < 0) {
 172                 return;
 173         }
 174
 175         glViewport (0, 0, canvas_size.GetWidth(), canvas_size.GetHeight());
 176         check_gl_error ("glViewport");
 177         glMatrixMode (GL_PROJECTION);
 178         glLoadIdentity ();
 179
 180 DCPOMATIC_DISABLE_WARNINGS
 181         gluOrtho2D (0, canvas_size.GetWidth(), canvas_size.GetHeight(), 0);
 182 DCPOMATIC_ENABLE_WARNINGS
 183         check_gl_error ("gluOrtho2d");
 184         glMatrixMode (GL_MODELVIEW);
 185         glLoadIdentity ();
 186
 187         glTranslatef (0, 0, 0);
 188
 189         dcp::Size const out_size = _viewer->out_size ();
 190
 191         if (_size) {
 192                 /* Render our image (texture) */
 193                 glBegin (GL_QUADS);
 194                 glTexCoord2f (0, 1);
 195                 glVertex2f (0, _size->height);
 196                 glTexCoord2f (1, 1);
 197                 glVertex2f (_size->width, _size->height);
 198                 glTexCoord2f (1, 0);
 199                 glVertex2f (_size->width, 0);
 200                 glTexCoord2f (0, 0);
 201                 glVertex2f (0, 0);
 202                 glEnd ();
 203         } else {
 204                 /* No image, so just fill with black */
 205                 glBegin (GL_QUADS);
 206                 glColor3ub (0, 0, 0);
 207                 glVertex2f (0, 0);
 208                 glVertex2f (out_size.width, 0);
 209                 glVertex2f (out_size.width, out_size.height);
 210                 glVertex2f (0, out_size.height);
 211                 glVertex2f (0, 0);
 212                 glEnd ();
 213         }
 214
 215         if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
 216                 glBegin (GL_QUADS);
 217                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
 218                 glColor3ub (240, 240, 240);
 219                 glVertex2f (out_size.width, 0);
 220                 glVertex2f (canvas_size.GetWidth(), 0);
 221                 glVertex2f (canvas_size.GetWidth(), canvas_size.GetHeight());
 222                 glVertex2f (out_size.width, canvas_size.GetHeight());
 223                 glEnd ();
 224                 glColor3ub (255, 255, 255);
 225         }
 226
 227         if (!_viewer->pad_black() && out_size.height < canvas_size.GetHeight()) {
 228                 glColor3ub (240, 240, 240);
 229                 int const gap = (canvas_size.GetHeight() - out_size.height) / 2;
 230                 glBegin (GL_QUADS);
 231                 glVertex2f (0, 0);
 232                 glVertex2f (canvas_size.GetWidth(), 0);
 233                 glVertex2f (canvas_size.GetWidth(), gap);
 234                 glVertex2f (0, gap);
 235                 glEnd ();
 236                 glBegin (GL_QUADS);
 237                 glVertex2f (0, gap + out_size.height + 1);
 238                 glVertex2f (canvas_size.GetWidth(), gap + out_size.height + 1);
 239                 glVertex2f (canvas_size.GetWidth(), 2 * gap + out_size.height + 2);
 240                 glVertex2f (0, 2 * gap + out_size.height + 2);
 241                 glEnd ();
 242                 glColor3ub (255, 255, 255);
 243         }
 244
 245         if (_viewer->outline_content()) {
 246                 glColor3ub (255, 0, 0);
 247                 glBegin (GL_LINE_LOOP);
 248                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
 249                 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
 250                 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 251                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 252                 glEnd ();
 253                 glColor3ub (255, 255, 255);
 254         }
 255
 256         glFlush();
 257         check_gl_error ("glFlush");
 258
 259         boost::mutex::scoped_lock lm (_canvas_mutex);
 260         _canvas->SwapBuffers();
 261 }
 262
 263 void
 264 GLVideoView::set_image (shared_ptr<const Image> image)
 265 {
 266         if (!image) {
 267                 _size = optional<dcp::Size>();
 268                 return;
 269         }
 270
 271         DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
 272         DCPOMATIC_ASSERT (!image->aligned());
 273
 274         if (image->size() != _size) {
 275                 _have_storage = false;
 276         }
 277
 278         _size = image->size ();
 279         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 280         check_gl_error ("glPixelStorei");
 281         if (_have_storage) {
 282                 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _size->width, _size->height, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
 283                 check_gl_error ("glTexSubImage2D");
 284         } else {
 285                 glTexImage2D (GL_TEXTURE_2D, 0, GL_RGB8, _size->width, _size->height, 0, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
 286                 _have_storage = true;
 287                 check_gl_error ("glTexImage2D");
 288         }
 289
 290         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 291         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 292         check_gl_error ("glTexParameteri");
 293
 294         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
 295         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
 296         check_gl_error ("glTexParameterf");
 297 }
 298
 299 void
 300 GLVideoView::start ()
 301 {
 302         VideoView::start ();
 303
 304         boost::mutex::scoped_lock lm (_playing_mutex);
 305         _playing = true;
 306         _thread_work_condition.notify_all ();
 307 }
 308
 309 void
 310 GLVideoView::stop ()
 311 {
 312         boost::mutex::scoped_lock lm (_playing_mutex);
 313         _playing = false;
 314 }
 315
 316
 317 void
 318 GLVideoView::thread_playing ()
 319 {
 320         if (length() != dcpomatic::DCPTime()) {
 321                 dcpomatic::DCPTime const next = position() + one_video_frame();
 322
 323                 if (next >= length()) {
 324                         _viewer->finished ();
 325                         return;
 326                 }
 327
 328                 get_next_frame (false);
 329                 set_image_and_draw ();
 330         }
 331
 332         while (true) {
 333                 optional<int> n = time_until_next_frame();
 334                 if (!n || *n > 5) {
 335                         break;
 336                 }
 337                 get_next_frame (true);
 338                 add_dropped ();
 339         }
 340 }
 341
 342
 343 void
 344 GLVideoView::set_image_and_draw ()
 345 {
 346         shared_ptr<PlayerVideo> pv = player_video().first;
 347         if (pv) {
 348                 set_image (pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true));
 349                 draw (pv->inter_position(), pv->inter_size());
 350                 _viewer->image_changed (pv);
 351         }
 352 }
 353
 354
 355 void
 356 GLVideoView::thread ()
 357 try
 358 {
 359         start_of_thread ("GLVideoView");
 360
 361         {
 362                 boost::mutex::scoped_lock lm (_canvas_mutex);
 363
 364 #if defined(DCPOMATIC_OSX)
 365                 /* Without this we see errors like
 366                  * ../src/osx/cocoa/glcanvas.mm(194): assert ""context"" failed in SwapBuffers(): should have current context [in thread 700006970000]
 367                  */
 368                 WXGLSetCurrentContext (_context->GetWXGLContext());
 369 #else
 370                 /* We must call this here on Linux otherwise we get no image (for reasons
 371                  * that aren't clear).  However, doing ensure_context() from this thread
 372                  * on macOS gives
 373                  * "[NSOpenGLContext setView:] must be called from the main thread".
 374                  */
 375                 ensure_context ();
 376 #endif
 377         }
 378
 379 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
 380         if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
 381                 /* Enable vsync */
 382                 Display* dpy = wxGetX11Display();
 383                 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
 384                 _vsync_enabled = true;
 385         }
 386 #endif
 387
 388 #ifdef DCPOMATIC_WINDOWS
 389         if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
 390                 /* Enable vsync */
 391                 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
 392                 if (swap) {
 393                         swap (1);
 394                         _vsync_enabled = true;
 395                 }
 396         }
 397
 398 #endif
 399
 400 #ifdef DCPOMATIC_OSX
 401         /* Enable vsync */
 402         GLint swapInterval = 1;
 403         CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
 404         _vsync_enabled = true;
 405 #endif
 406
 407         glGenTextures (1, &_id);
 408         check_gl_error ("glGenTextures");
 409         glBindTexture (GL_TEXTURE_2D, _id);
 410         check_gl_error ("glBindTexture");
 411         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 412         check_gl_error ("glPixelStorei");
 413
 414         while (true) {
 415                 boost::mutex::scoped_lock lm (_playing_mutex);
 416                 while (!_playing && !_one_shot) {
 417                         _thread_work_condition.wait (lm);
 418                 }
 419                 lm.unlock ();
 420
 421                 if (_playing) {
 422                         thread_playing ();
 423                 } else if (_one_shot) {
 424                         _one_shot = false;
 425                         set_image_and_draw ();
 426                 }
 427
 428                 boost::this_thread::interruption_point ();
 429                 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
 430         }
 431
 432         /* XXX: leaks _context, but that seems preferable to deleting it here
 433          * without also deleting the wxGLCanvas.
 434          */
 435 }
 436 catch (boost::thread_interrupted& e)
 437 {
 438         store_current ();
 439 }
 440
 441
 442 VideoView::NextFrameResult
 443 GLVideoView::display_next_frame (bool non_blocking)
 444 {
 445         NextFrameResult const r = get_next_frame (non_blocking);
 446         request_one_shot ();
 447         return r;
 448 }
 449
 450
 451 void
 452 GLVideoView::request_one_shot ()
 453 {
 454         boost::mutex::scoped_lock lm (_playing_mutex);
 455         _one_shot = true;
 456         _thread_work_condition.notify_all ();
 457 }
 458