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