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         , _vsync_enabled (false)
  59         , _thread (0)
  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::paint, 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         _thread->interrupt ();
 108         _thread->join ();
 109         delete _thread;
 110
 111         glDeleteTextures (1, &_id);
 112 }
 113
 114 void
 115 GLVideoView::check_for_butler_errors ()
 116 {
 117         try {
 118                 _viewer->butler()->rethrow ();
 119         } catch (DecodeError& e) {
 120                 error_dialog (get(), e.what());
 121         }
 122 }
 123
 124 static void
 125 check_gl_error (char const * last)
 126 {
 127         GLenum const e = glGetError ();
 128         if (e != GL_NO_ERROR) {
 129                 throw GLError (last, e);
 130         }
 131 }
 132
 133 void
 134 GLVideoView::paint ()
 135 {
 136         request_one_shot ();
 137 }
 138
 139 void
 140 GLVideoView::update ()
 141 {
 142         if (!_canvas->IsShownOnScreen()) {
 143                 return;
 144         }
 145         /* XXX_b */
 146 //      wxClientDC dc (_canvas);
 147 //      draw ();
 148 }
 149
 150 void
 151 GLVideoView::draw ()
 152 {
 153         glClear (GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 154         check_gl_error ("glClear");
 155
 156         glClearColor (0.0f, 0.0f, 0.0f, 1.0f);
 157         check_gl_error ("glClearColor");
 158         glEnable (GL_TEXTURE_2D);
 159         check_gl_error ("glEnable GL_TEXTURE_2D");
 160         glEnable (GL_BLEND);
 161         check_gl_error ("glEnable GL_BLEND");
 162         glDisable (GL_DEPTH_TEST);
 163         check_gl_error ("glDisable GL_DEPTH_TEST");
 164         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 165
 166         if (_canvas->GetSize().x < 64 || _canvas->GetSize().y < 0) {
 167                 return;
 168         }
 169
 170         glViewport (0, 0, _canvas->GetSize().x, _canvas->GetSize().y);
 171         check_gl_error ("glViewport");
 172         glMatrixMode (GL_PROJECTION);
 173         glLoadIdentity ();
 174
 175         gluOrtho2D (0, _canvas->GetSize().x, _canvas->GetSize().y, 0);
 176         check_gl_error ("gluOrtho2d");
 177         glMatrixMode (GL_MODELVIEW);
 178         glLoadIdentity ();
 179
 180         glTranslatef (0, 0, 0);
 181
 182         dcp::Size const out_size = _viewer->out_size ();
 183
 184         if (_size) {
 185                 /* Render our image (texture) */
 186                 glBegin (GL_QUADS);
 187                 glTexCoord2f (0, 1);
 188                 glVertex2f (0, _size->height);
 189                 glTexCoord2f (1, 1);
 190                 glVertex2f (_size->width, _size->height);
 191                 glTexCoord2f (1, 0);
 192                 glVertex2f (_size->width, 0);
 193                 glTexCoord2f (0, 0);
 194                 glVertex2f (0, 0);
 195                 glEnd ();
 196         } else {
 197                 /* No image, so just fill with black */
 198                 glBegin (GL_QUADS);
 199                 glColor3ub (0, 0, 0);
 200                 glVertex2f (0, 0);
 201                 glVertex2f (out_size.width, 0);
 202                 glVertex2f (out_size.width, out_size.height);
 203                 glVertex2f (0, out_size.height);
 204                 glVertex2f (0, 0);
 205                 glEnd ();
 206         }
 207
 208         wxSize const canvas_size = _canvas->GetSize ();
 209
 210         if (!_viewer->pad_black() && out_size.width < canvas_size.GetWidth()) {
 211                 glBegin (GL_QUADS);
 212                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
 213                 glColor3ub (240, 240, 240);
 214                 glVertex2f (out_size.width, 0);
 215                 glVertex2f (canvas_size.GetWidth(), 0);
 216                 glVertex2f (canvas_size.GetWidth(), canvas_size.GetHeight());
 217                 glVertex2f (out_size.width, canvas_size.GetHeight());
 218                 glEnd ();
 219                 glColor3ub (255, 255, 255);
 220         }
 221
 222         if (!_viewer->pad_black() && out_size.height < canvas_size.GetHeight()) {
 223                 glColor3ub (240, 240, 240);
 224                 int const gap = (canvas_size.GetHeight() - out_size.height) / 2;
 225                 glBegin (GL_QUADS);
 226                 glVertex2f (0, 0);
 227                 glVertex2f (canvas_size.GetWidth(), 0);
 228                 glVertex2f (canvas_size.GetWidth(), gap);
 229                 glVertex2f (0, gap);
 230                 glEnd ();
 231                 glBegin (GL_QUADS);
 232                 glVertex2f (0, gap + out_size.height + 1);
 233                 glVertex2f (canvas_size.GetWidth(), gap + out_size.height + 1);
 234                 glVertex2f (canvas_size.GetWidth(), 2 * gap + out_size.height + 2);
 235                 glVertex2f (0, 2 * gap + out_size.height + 2);
 236                 glEnd ();
 237                 glColor3ub (255, 255, 255);
 238         }
 239
 240         if (_viewer->outline_content()) {
 241                 glColor3ub (255, 0, 0);
 242                 glBegin (GL_LINE_LOOP);
 243                 Position<int> inter_position = _viewer->inter_position ();
 244                 dcp::Size inter_size = _viewer->inter_size ();
 245                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2);
 246                 glVertex2f (inter_position.x + inter_size.width, 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 + inter_size.height);
 248                 glVertex2f (inter_position.x, inter_position.y + (canvas_size.GetHeight() - out_size.height) / 2 + inter_size.height);
 249                 glEnd ();
 250                 glColor3ub (255, 255, 255);
 251         }
 252
 253         glFlush();
 254         _canvas->SwapBuffers();
 255 }
 256
 257 void
 258 GLVideoView::set_image (shared_ptr<const Image> image)
 259 {
 260         if (!image) {
 261                 _size = optional<dcp::Size>();
 262                 return;
 263         }
 264
 265         DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
 266         DCPOMATIC_ASSERT (!image->aligned());
 267
 268         _size = image->size ();
 269         glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
 270         check_gl_error ("glPixelStorei");
 271         glTexImage2D (GL_TEXTURE_2D, 0, GL_RGB8, _size->width, _size->height, 0, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
 272         check_gl_error ("glTexImage2D");
 273
 274         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 275         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 276         check_gl_error ("glTexParameteri");
 277
 278         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
 279         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
 280         check_gl_error ("glTexParameterf");
 281 }
 282
 283 void
 284 GLVideoView::start ()
 285 {
 286         boost::mutex::scoped_lock lm (_playing_mutex);
 287         _playing = true;
 288         _playing_condition.notify_all ();
 289 }
 290
 291 void
 292 GLVideoView::stop ()
 293 {
 294         boost::mutex::scoped_lock lm (_playing_mutex);
 295         _playing = false;
 296 }
 297
 298 void
 299 GLVideoView::thread ()
 300 try
 301 {
 302         /* XXX_b: check all calls and signal emissions in this method & protect them if necessary */
 303         _context = new wxGLContext (_canvas);
 304         _canvas->SetCurrent (*_context);
 305
 306         while (true) {
 307                 boost::mutex::scoped_lock lm (_playing_mutex);
 308                 while (!_playing && !_one_shot) {
 309                         _playing_condition.wait (lm);
 310                 }
 311                 _one_shot = false;
 312                 lm.unlock ();
 313
 314                 if (length() != dcpomatic::DCPTime()) {
 315                         dcpomatic::DCPTime const next = position() + one_video_frame();
 316
 317                         if (next >= length()) {
 318                                 _viewer->stop ();
 319                                 _viewer->emit_finished ();
 320                                 continue;
 321                         }
 322
 323                         get_next_frame (false);
 324                         set_image (player_video().first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 325                 }
 326                 draw ();
 327
 328                 while (time_until_next_frame() < 5) {
 329                         get_next_frame (true);
 330                 }
 331
 332                 boost::this_thread::interruption_point ();
 333                 dcpomatic_sleep_milliseconds (time_until_next_frame());
 334         }
 335
 336         delete _context;
 337 }
 338 catch (boost::thread_interrupted& e)
 339 {
 340         /* XXX_b: store exceptions here */
 341         delete _context;
 342         return;
 343 }
 344
 345 bool
 346 GLVideoView::display_next_frame (bool non_blocking)
 347 {
 348         bool const r = get_next_frame (non_blocking);
 349         request_one_shot ();
 350         return r;
 351 }
 352
 353 void
 354 GLVideoView::request_one_shot ()
 355 {
 356         boost::mutex::scoped_lock lm (_playing_mutex);
 357         _one_shot = true;
 358         _playing_condition.notify_all ();
 359 }
 360
 361 void
 362 GLVideoView::create ()
 363 {
 364         if (!_thread) {
 365                 _thread = new boost::thread (boost::bind(&GLVideoView::thread, this));
 366         }
 367 }