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 #include <GL/glxext.h>
  44 #endif
  45
  46 #ifdef DCPOMATIC_WINDOWS
  47 #include <GL/glu.h>
  48 #include <GL/glext.h>
  49 #include <GL/wglext.h>
  50 #endif
  51
  52 using std::cout;
  53 using boost::shared_ptr;
  54 using boost::optional;
  55
  56 GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
  57         : VideoView (viewer)
  58         , _have_storage (false)
  59         , _vsync_enabled (false)
  60         , _playing (false)
  61         , _one_shot (false)
  62 {
  63         _canvas = new wxGLCanvas (parent, wxID_ANY, 0, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE);
  64         _canvas->Bind (wxEVT_PAINT, boost::bind(&GLVideoView::update, this));
  65         _canvas->Bind (wxEVT_SIZE, boost::bind(boost::ref(Sized)));
  66         _canvas->Bind (wxEVT_CREATE, boost::bind(&GLVideoView::create, this));
  67
  68         _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
  69         _timer.reset (new wxTimer(_canvas));
  70         _timer->Start (2000);
  71
  72 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
  73         if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
  74                 /* Enable vsync */
  75                 Display* dpy = wxGetX11Display();
  76                 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
  77                 _vsync_enabled = true;
  78         }
  79 #endif
  80
  81 #ifdef DCPOMATIC_WINDOWS
  82         if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
  83                 /* Enable vsync */
  84                 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
  85                 if (swap) {
  86                         swap (1);
  87                         _vsync_enabled = true;
  88                 }
  89         }
  90
  91 #endif
  92
  93 #ifdef DCPOMATIC_OSX
  94         /* Enable vsync */
  95         GLint swapInterval = 1;
  96         CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
  97         _vsync_enabled = true;
  98 #endif
  99
 100         glGenTextures (1, &_id);
 101         glBindTexture (GL_TEXTURE_2D, _id);
 102         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 103 }
 104
 105 GLVideoView::~GLVideoView ()
 106 {
 107         try {
 108                 _thread.interrupt ();
 109                 _thread.join ();
 110         } catch (...) {
 111
 112         }
 113
 114         glDeleteTextures (1, &_id);
 115 }
 116
 117 void
 118 GLVideoView::check_for_butler_errors ()
 119 {
 120         if (!_viewer->butler()) {
 121                 return;
 122         }
 123
 124         try {
 125                 _viewer->butler()->rethrow ();
 126         } catch (DecodeError& e) {
 127                 error_dialog (get(), e.what());
 128         }
 129 }
 130
 131 static void
 132 check_gl_error (char const * last)
 133 {
 134         GLenum const e = glGetError ();
 135         if (e != GL_NO_ERROR) {
 136                 throw GLError (last, e);
 137         }
 138 }
 139
 140 void
 141 GLVideoView::update ()
 142 {
 143         {
 144                 boost::mutex::scoped_lock lm (_canvas_mutex);
 145                 if (!_canvas->IsShownOnScreen()) {
 146                         return;
 147                 }
 148         }
 149         request_one_shot ();
 150 }
 151
 152 void
 153 GLVideoView::draw (Position<int> inter_position, dcp::Size inter_size)
 154 {
 155         glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 156         check_gl_error ("glClear");
 157
 158         glClearColor (0.0f, 0.0f, 0.0f, 1.0f);
 159         check_gl_error ("glClearColor");
 160         glEnable (GL_TEXTURE_2D);
 161         check_gl_error ("glEnable GL_TEXTURE_2D");
 162         glEnable (GL_BLEND);
 163         check_gl_error ("glEnable GL_BLEND");
 164         glDisable (GL_DEPTH_TEST);
 165         check_gl_error ("glDisable GL_DEPTH_TEST");
 166         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 167
 168         wxSize canvas_size;
 169         {
 170                 boost::mutex::scoped_lock lm (_canvas_mutex);
 171                 canvas_size = _canvas->GetSize ();
 172         }
 173
 174         if (canvas_size.GetWidth() < 64 || canvas_size.GetHeight() < 0) {
 175                 return;
 176         }
 177
 178         glViewport (0, 0, canvas_size.GetWidth(), canvas_size.GetHeight());
 179         check_gl_error ("glViewport");
 180         glMatrixMode (GL_PROJECTION);
 181         glLoadIdentity ();
 182
 183         gluOrtho2D (0, canvas_size.GetWidth(), canvas_size.GetHeight(), 0);
 184         check_gl_error ("gluOrtho2d");
 185         glMatrixMode (GL_MODELVIEW);
 186         glLoadIdentity ();
 187
 188         glTranslatef (0, 0, 0);
 189
 190         dcp::Size const out_size = _viewer->out_size ();
 191
 192         if (_size) {
 193                 /* Render our image (texture) */
 194                 glBegin (GL_QUADS);
 195                 glTexCoord2f (0, 1);
 196                 glVertex2f (0, _size->height);
 197                 glTexCoord2f (1, 1);
 198                 glVertex2f (_size->width, _size->height);
 199                 glTexCoord2f (1, 0);
 200                 glVertex2f (_size->width, 0);
 201                 glTexCoord2f (0, 0);
 202                 glVertex2f (0, 0);
 203                 glEnd ();
 204         } else {
 205                 /* No image, so just fill with black */
 206                 glBegin (GL_QUADS);
 207                 glColor3ub (0, 0, 0);
 208                 glVertex2f (0, 0);
 209                 glVertex2f (out_size.width, 0);
 210                 glVertex2f (out_size.width, out_size.height);
 211                 glVertex2f (0, out_size.height);
 212                 glVertex2f (0, 0);
 213                 glEnd ();
 214         }
 215
 216         if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
 217                 glBegin (GL_QUADS);
 218                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
 219                 glColor3ub (240, 240, 240);
 220                 glVertex2f (out_size.width, 0);
 221                 glVertex2f (canvas_size.GetWidth(), 0);
 222                 glVertex2f (canvas_size.GetWidth(), canvas_size.GetHeight());
 223                 glVertex2f (out_size.width, canvas_size.GetHeight());
 224                 glEnd ();
 225                 glColor3ub (255, 255, 255);
 226         }
 227
 228         if (!_viewer->pad_black() && out_size.height < canvas_size.GetHeight()) {
 229                 glColor3ub (240, 240, 240);
 230                 int const gap = (canvas_size.GetHeight() - out_size.height) / 2;
 231                 glBegin (GL_QUADS);
 232                 glVertex2f (0, 0);
 233                 glVertex2f (canvas_size.GetWidth(), 0);
 234                 glVertex2f (canvas_size.GetWidth(), gap);
 235                 glVertex2f (0, gap);
 236                 glEnd ();
 237                 glBegin (GL_QUADS);
 238                 glVertex2f (0, gap + out_size.height + 1);
 239                 glVertex2f (canvas_size.GetWidth(), gap + out_size.height + 1);
 240                 glVertex2f (canvas_size.GetWidth(), 2 * gap + out_size.height + 2);
 241                 glVertex2f (0, 2 * gap + out_size.height + 2);
 242                 glEnd ();
 243                 glColor3ub (255, 255, 255);
 244         }
 245
 246         if (_viewer->outline_content()) {
 247                 glColor3ub (255, 0, 0);
 248                 glBegin (GL_LINE_LOOP);
 249                 glVertex2f (inter_position.x, 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);
 251                 glVertex2f (inter_position.x + inter_size.width, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 252                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 253                 glEnd ();
 254                 glColor3ub (255, 255, 255);
 255         }
 256
 257         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         _playing_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 void
 317 GLVideoView::thread ()
 318 try
 319 {
 320         {
 321                 boost::mutex::scoped_lock lm (_canvas_mutex);
 322                 _context = new wxGLContext (_canvas); //local
 323                 _canvas->SetCurrent (*_context);
 324         }
 325
 326         while (true) {
 327                 boost::mutex::scoped_lock lm (_playing_mutex);
 328                 while (!_playing && !_one_shot) {
 329                         _playing_condition.wait (lm);
 330                 }
 331                 _one_shot = false;
 332                 lm.unlock ();
 333
 334                 Position<int> inter_position;
 335                 dcp::Size inter_size;
 336                 if (length() != dcpomatic::DCPTime()) {
 337                         dcpomatic::DCPTime const next = position() + one_video_frame();
 338
 339                         if (next >= length()) {
 340                                 _viewer->finished ();
 341                                 continue;
 342                         }
 343
 344                         get_next_frame (false);
 345                         shared_ptr<PlayerVideo> pv = player_video().first;
 346                         if (pv) {
 347                                 set_image (pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 348                                 inter_position = pv->inter_position();
 349                                 inter_size = pv->inter_size();
 350                         }
 351                 }
 352                 draw (inter_position, inter_size);
 353
 354                 while (true) {
 355                         optional<int> n = time_until_next_frame();
 356                         if (!n || *n > 5) {
 357                                 break;
 358                         }
 359                         get_next_frame (true);
 360                         add_dropped ();
 361                 }
 362
 363                 boost::this_thread::interruption_point ();
 364                 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
 365         }
 366
 367         /* XXX: leaks _context, but that seems preferable to deleting it here
 368          * without also deleting the wxGLCanvas.
 369          */
 370 }
 371 catch (boost::thread_interrupted& e)
 372 {
 373         store_current ();
 374 }
 375
 376 bool
 377 GLVideoView::display_next_frame (bool non_blocking)
 378 {
 379         bool const r = get_next_frame (non_blocking);
 380         request_one_shot ();
 381         return r;
 382 }
 383
 384 void
 385 GLVideoView::request_one_shot ()
 386 {
 387         boost::mutex::scoped_lock lm (_playing_mutex);
 388         _one_shot = true;
 389         _playing_condition.notify_all ();
 390 }
 391
 392 void
 393 GLVideoView::create ()
 394 {
 395         if (!_thread.joinable()) {
 396                 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
 397         }
 398 }