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.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 boost::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         , _have_storage (false)
  72         , _vsync_enabled (false)
  73         , _playing (false)
  74         , _one_shot (false)
  75 {
  76         _canvas = new wxGLCanvas (parent, wxID_ANY, 0, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE);
  77         _canvas->Bind (wxEVT_PAINT, boost::bind(&GLVideoView::update, this));
  78         _canvas->Bind (wxEVT_SIZE, boost::bind(boost::ref(Sized)));
  79
  80         _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
  81         _timer.reset (new wxTimer(_canvas));
  82         _timer->Start (2000);
  83 }
  84
  85 GLVideoView::~GLVideoView ()
  86 {
  87         boost::this_thread::disable_interruption dis;
  88
  89         try {
  90                 _thread.interrupt ();
  91                 _thread.join ();
  92         } catch (...) {}
  93
  94         glDeleteTextures (1, &_id);
  95 }
  96
  97 void
  98 GLVideoView::check_for_butler_errors ()
  99 {
 100         if (!_viewer->butler()) {
 101                 return;
 102         }
 103
 104         try {
 105                 _viewer->butler()->rethrow ();
 106         } catch (DecodeError& e) {
 107                 error_dialog (get(), e.what());
 108         }
 109 }
 110
 111
 112 void
 113 GLVideoView::update ()
 114 {
 115         if (!_thread.joinable()) {
 116                 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
 117         }
 118
 119         {
 120                 boost::mutex::scoped_lock lm (_canvas_mutex);
 121                 if (!_canvas->IsShownOnScreen()) {
 122                         return;
 123                 }
 124         }
 125         request_one_shot ();
 126 }
 127
 128 void
 129 GLVideoView::draw (Position<int> inter_position, dcp::Size inter_size)
 130 {
 131         glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 132         check_gl_error ("glClear");
 133
 134         glClearColor (0.0f, 0.0f, 0.0f, 1.0f);
 135         check_gl_error ("glClearColor");
 136         glEnable (GL_TEXTURE_2D);
 137         check_gl_error ("glEnable GL_TEXTURE_2D");
 138         glEnable (GL_BLEND);
 139         check_gl_error ("glEnable GL_BLEND");
 140         glDisable (GL_DEPTH_TEST);
 141         check_gl_error ("glDisable GL_DEPTH_TEST");
 142         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 143
 144         wxSize canvas_size;
 145         {
 146                 boost::mutex::scoped_lock lm (_canvas_mutex);
 147                 canvas_size = _canvas->GetSize ();
 148         }
 149
 150         if (canvas_size.GetWidth() < 64 || canvas_size.GetHeight() < 0) {
 151                 return;
 152         }
 153
 154         glViewport (0, 0, canvas_size.GetWidth(), canvas_size.GetHeight());
 155         check_gl_error ("glViewport");
 156         glMatrixMode (GL_PROJECTION);
 157         glLoadIdentity ();
 158
 159 DCPOMATIC_DISABLE_WARNINGS
 160         gluOrtho2D (0, canvas_size.GetWidth(), canvas_size.GetHeight(), 0);
 161 DCPOMATIC_ENABLE_WARNINGS
 162         check_gl_error ("gluOrtho2d");
 163         glMatrixMode (GL_MODELVIEW);
 164         glLoadIdentity ();
 165
 166         glTranslatef (0, 0, 0);
 167
 168         dcp::Size const out_size = _viewer->out_size ();
 169
 170         if (_size) {
 171                 /* Render our image (texture) */
 172                 glBegin (GL_QUADS);
 173                 glTexCoord2f (0, 1);
 174                 glVertex2f (0, _size->height);
 175                 glTexCoord2f (1, 1);
 176                 glVertex2f (_size->width, _size->height);
 177                 glTexCoord2f (1, 0);
 178                 glVertex2f (_size->width, 0);
 179                 glTexCoord2f (0, 0);
 180                 glVertex2f (0, 0);
 181                 glEnd ();
 182         } else {
 183                 /* No image, so just fill with black */
 184                 glBegin (GL_QUADS);
 185                 glColor3ub (0, 0, 0);
 186                 glVertex2f (0, 0);
 187                 glVertex2f (out_size.width, 0);
 188                 glVertex2f (out_size.width, out_size.height);
 189                 glVertex2f (0, out_size.height);
 190                 glVertex2f (0, 0);
 191                 glEnd ();
 192         }
 193
 194         if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
 195                 glBegin (GL_QUADS);
 196                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
 197                 glColor3ub (240, 240, 240);
 198                 glVertex2f (out_size.width, 0);
 199                 glVertex2f (canvas_size.GetWidth(), 0);
 200                 glVertex2f (canvas_size.GetWidth(), canvas_size.GetHeight());
 201                 glVertex2f (out_size.width, canvas_size.GetHeight());
 202                 glEnd ();
 203                 glColor3ub (255, 255, 255);
 204         }
 205
 206         if (!_viewer->pad_black() && out_size.height < canvas_size.GetHeight()) {
 207                 glColor3ub (240, 240, 240);
 208                 int const gap = (canvas_size.GetHeight() - out_size.height) / 2;
 209                 glBegin (GL_QUADS);
 210                 glVertex2f (0, 0);
 211                 glVertex2f (canvas_size.GetWidth(), 0);
 212                 glVertex2f (canvas_size.GetWidth(), gap);
 213                 glVertex2f (0, gap);
 214                 glEnd ();
 215                 glBegin (GL_QUADS);
 216                 glVertex2f (0, gap + out_size.height + 1);
 217                 glVertex2f (canvas_size.GetWidth(), gap + out_size.height + 1);
 218                 glVertex2f (canvas_size.GetWidth(), 2 * gap + out_size.height + 2);
 219                 glVertex2f (0, 2 * gap + out_size.height + 2);
 220                 glEnd ();
 221                 glColor3ub (255, 255, 255);
 222         }
 223
 224         if (_viewer->outline_content()) {
 225                 glColor3ub (255, 0, 0);
 226                 glBegin (GL_LINE_LOOP);
 227                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
 228                 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
 229                 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 230                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 231                 glEnd ();
 232                 glColor3ub (255, 255, 255);
 233         }
 234
 235         glFlush();
 236         check_gl_error ("glFlush");
 237
 238         boost::mutex::scoped_lock lm (_canvas_mutex);
 239         _canvas->SwapBuffers();
 240 }
 241
 242 void
 243 GLVideoView::set_image (shared_ptr<const Image> image)
 244 {
 245         if (!image) {
 246                 _size = optional<dcp::Size>();
 247                 return;
 248         }
 249
 250         DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
 251         DCPOMATIC_ASSERT (!image->aligned());
 252
 253         if (image->size() != _size) {
 254                 _have_storage = false;
 255         }
 256
 257         _size = image->size ();
 258         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 259         check_gl_error ("glPixelStorei");
 260         if (_have_storage) {
 261                 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _size->width, _size->height, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
 262                 check_gl_error ("glTexSubImage2D");
 263         } else {
 264                 glTexImage2D (GL_TEXTURE_2D, 0, GL_RGB8, _size->width, _size->height, 0, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
 265                 _have_storage = true;
 266                 check_gl_error ("glTexImage2D");
 267         }
 268
 269         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 270         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 271         check_gl_error ("glTexParameteri");
 272
 273         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
 274         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
 275         check_gl_error ("glTexParameterf");
 276 }
 277
 278 void
 279 GLVideoView::start ()
 280 {
 281         VideoView::start ();
 282
 283         boost::mutex::scoped_lock lm (_playing_mutex);
 284         _playing = true;
 285         _thread_work_condition.notify_all ();
 286 }
 287
 288 void
 289 GLVideoView::stop ()
 290 {
 291         boost::mutex::scoped_lock lm (_playing_mutex);
 292         _playing = false;
 293 }
 294
 295
 296 void
 297 GLVideoView::thread_playing ()
 298 {
 299         if (length() != dcpomatic::DCPTime()) {
 300                 dcpomatic::DCPTime const next = position() + one_video_frame();
 301
 302                 if (next >= length()) {
 303                         _viewer->finished ();
 304                         return;
 305                 }
 306
 307                 get_next_frame (false);
 308                 set_image_and_draw ();
 309         }
 310
 311         while (true) {
 312                 optional<int> n = time_until_next_frame();
 313                 if (!n || *n > 5) {
 314                         break;
 315                 }
 316                 get_next_frame (true);
 317                 add_dropped ();
 318         }
 319 }
 320
 321
 322 void
 323 GLVideoView::set_image_and_draw ()
 324 {
 325         shared_ptr<PlayerVideo> pv = player_video().first;
 326         if (pv) {
 327                 set_image (pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 328                 draw (pv->inter_position(), pv->inter_size());
 329         }
 330 }
 331
 332
 333 void
 334 GLVideoView::thread ()
 335 try
 336 {
 337         {
 338                 boost::mutex::scoped_lock lm (_canvas_mutex);
 339                 _context = new wxGLContext (_canvas);
 340                 _canvas->SetCurrent (*_context);
 341         }
 342
 343
 344 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
 345         if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
 346                 /* Enable vsync */
 347                 Display* dpy = wxGetX11Display();
 348                 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
 349                 _vsync_enabled = true;
 350         }
 351 #endif
 352
 353 #ifdef DCPOMATIC_WINDOWS
 354         if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
 355                 /* Enable vsync */
 356                 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
 357                 if (swap) {
 358                         swap (1);
 359                         _vsync_enabled = true;
 360                 }
 361         }
 362
 363 #endif
 364
 365 #ifdef DCPOMATIC_OSX
 366         /* Enable vsync */
 367         GLint swapInterval = 1;
 368         CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
 369         _vsync_enabled = true;
 370 #endif
 371
 372         glGenTextures (1, &_id);
 373         check_gl_error ("glGenTextures");
 374         glBindTexture (GL_TEXTURE_2D, _id);
 375         check_gl_error ("glBindTexture");
 376         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 377         check_gl_error ("glPixelStorei");
 378
 379         while (true) {
 380                 boost::mutex::scoped_lock lm (_playing_mutex);
 381                 while (!_playing && !_one_shot) {
 382                         _thread_work_condition.wait (lm);
 383                 }
 384                 lm.unlock ();
 385
 386                 if (_playing) {
 387                         thread_playing ();
 388                 } else if (_one_shot) {
 389                         _one_shot = false;
 390                         set_image_and_draw ();
 391                 }
 392
 393                 boost::this_thread::interruption_point ();
 394                 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
 395         }
 396
 397         /* XXX: leaks _context, but that seems preferable to deleting it here
 398          * without also deleting the wxGLCanvas.
 399          */
 400 }
 401 catch (boost::thread_interrupted& e)
 402 {
 403         store_current ();
 404 }
 405
 406 bool
 407 GLVideoView::display_next_frame (bool non_blocking)
 408 {
 409         bool const r = get_next_frame (non_blocking);
 410         request_one_shot ();
 411         return r;
 412 }
 413
 414 void
 415 GLVideoView::request_one_shot ()
 416 {
 417         boost::mutex::scoped_lock lm (_playing_mutex);
 418         _one_shot = true;
 419         _thread_work_condition.notify_all ();
 420 }
 421