src/wx/gl_video_view.cc

   1 /*
   2     Copyright (C) 2018-2021 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
  22 #ifdef DCPOMATIC_WINDOWS
  23 #include <GL/glew.h>
  24 #endif
  25
  26 #include "gl_video_view.h"
  27
  28 /* This will only build on an new-enough wxWidgets: see the comment in gl_video_view.h */
  29 #if wxCHECK_VERSION(3,1,0)
  30
  31 #include "film_viewer.h"
  32 #include "wx_util.h"
  33 #include "lib/butler.h"
  34 #include "lib/cross.h"
  35 #include "lib/dcpomatic_assert.h"
  36 #include "lib/dcpomatic_log.h"
  37 #include "lib/exceptions.h"
  38 #include "lib/image.h"
  39 #include "lib/player_video.h"
  40 #include <boost/bind/bind.hpp>
  41 #include <iostream>
  42
  43 #ifdef DCPOMATIC_OSX
  44 #define GL_DO_NOT_WARN_IF_MULTI_GL_VERSION_HEADERS_INCLUDED
  45 #include <OpenGL/OpenGL.h>
  46 #include <OpenGL/gl3.h>
  47 #endif
  48
  49 #ifdef DCPOMATIC_LINUX
  50 #include <GL/glu.h>
  51 #include <GL/glext.h>
  52 #endif
  53
  54 #ifdef DCPOMATIC_WINDOWS
  55 #include <GL/glu.h>
  56 #include <GL/wglext.h>
  57 #endif
  58
  59
  60 using std::cout;
  61 using std::shared_ptr;
  62 using std::string;
  63 using boost::optional;
  64 #if BOOST_VERSION >= 106100
  65 using namespace boost::placeholders;
  66 #endif
  67
  68
  69 static void
  70 check_gl_error (char const * last)
  71 {
  72         GLenum const e = glGetError ();
  73         if (e != GL_NO_ERROR) {
  74                 throw GLError (last, e);
  75         }
  76 }
  77
  78
  79 GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
  80         : VideoView (viewer)
  81         , _context (nullptr)
  82         , _vsync_enabled (false)
  83         , _playing (false)
  84         , _one_shot (false)
  85 {
  86         wxGLAttributes attributes;
  87         /* We don't need a depth buffer, and indeed there is apparently a bug with Windows/Intel HD 630
  88          * which puts green lines over the OpenGL display if you have a non-zero depth buffer size.
  89          * https://community.intel.com/t5/Graphics/Request-for-details-on-Intel-HD-630-green-lines-in-OpenGL-apps/m-p/1202179
  90          */
  91         attributes.PlatformDefaults().MinRGBA(8, 8, 8, 8).DoubleBuffer().Depth(0).EndList();
  92         _canvas = new wxGLCanvas (
  93                 parent, attributes, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE
  94         );
  95         _canvas->Bind (wxEVT_PAINT, boost::bind(&GLVideoView::update, this));
  96         _canvas->Bind (wxEVT_SIZE, boost::bind(&GLVideoView::size_changed, this, _1));
  97
  98         _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
  99         _timer.reset (new wxTimer(_canvas));
 100         _timer->Start (2000);
 101 }
 102
 103
 104 void
 105 GLVideoView::size_changed (wxSizeEvent const& ev)
 106 {
 107         auto const scale = _canvas->GetDPIScaleFactor();
 108         int const width = std::round(ev.GetSize().GetWidth() * scale);
 109         int const height = std::round(ev.GetSize().GetHeight() * scale);
 110         _canvas_size = { width, height };
 111         LOG_GENERAL("GLVideoView canvas size changed to %1x%2", width, height);
 112         Sized ();
 113 }
 114
 115
 116 GLVideoView::~GLVideoView ()
 117 {
 118         boost::this_thread::disable_interruption dis;
 119
 120         try {
 121                 _thread.interrupt ();
 122                 _thread.join ();
 123         } catch (...) {}
 124 }
 125
 126 void
 127 GLVideoView::check_for_butler_errors ()
 128 {
 129         if (!_viewer->butler()) {
 130                 return;
 131         }
 132
 133         try {
 134                 _viewer->butler()->rethrow ();
 135         } catch (DecodeError& e) {
 136                 error_dialog (get(), e.what());
 137         } catch (dcp::ReadError& e) {
 138                 error_dialog (get(), wxString::Format(_("Could not read DCP: %s"), std_to_wx(e.what())));
 139         }
 140 }
 141
 142
 143 /** Called from the UI thread */
 144 void
 145 GLVideoView::update ()
 146 {
 147         if (!_canvas->IsShownOnScreen()) {
 148                 return;
 149         }
 150
 151         /* It appears important to do this from the GUI thread; if we do it from the GL thread
 152          * on Linux we get strange failures to create the context for any version of GL higher
 153          * than 3.2.
 154          */
 155         ensure_context ();
 156
 157 #ifdef DCPOMATIC_OSX
 158         /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
 159         if (!_setup_shaders_done) {
 160                 setup_shaders ();
 161                 _setup_shaders_done = true;
 162         }
 163 #endif
 164
 165         if (!_thread.joinable()) {
 166                 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
 167         }
 168
 169         request_one_shot ();
 170
 171         rethrow ();
 172 }
 173
 174
 175 static constexpr char vertex_source[] =
 176 "#version 330 core\n"
 177 "\n"
 178 "layout (location = 0) in vec3 in_pos;\n"
 179 "layout (location = 1) in vec2 in_tex_coord;\n"
 180 "\n"
 181 "out vec2 TexCoord;\n"
 182 "\n"
 183 "void main()\n"
 184 "{\n"
 185 "       gl_Position = vec4(in_pos, 1.0);\n"
 186 "       TexCoord = in_tex_coord;\n"
 187 "}\n";
 188
 189
 190 /* Bicubic interpolation stolen from https://stackoverflow.com/questions/13501081/efficient-bicubic-filtering-code-in-glsl */
 191 static constexpr char fragment_source[] =
 192 "#version 330 core\n"
 193 "\n"
 194 "in vec2 TexCoord;\n"
 195 "\n"
 196 "uniform sampler2D texture_sampler;\n"
 197 /* type = 0: draw outline content rectangle
 198  * type = 1: draw crop guess rectangle
 199  * type = 2: draw XYZ image
 200  * type = 3: draw RGB image
 201  * See FragmentType enum below.
 202  */
 203 "uniform int type = 0;\n"
 204 "uniform vec4 outline_content_colour;\n"
 205 "uniform vec4 crop_guess_colour;\n"
 206 "uniform mat4 xyz_rec709_colour_conversion;\n"
 207 "\n"
 208 "out vec4 FragColor;\n"
 209 "\n"
 210 "vec4 cubic(float x)\n"
 211 "\n"
 212 "#define IN_GAMMA 2.6\n"
 213 "#define OUT_GAMMA 0.454545455\n"       //  1 /  2.2
 214 "#define DCI_COEFFICIENT 0.91655528\n"  // 48 / 53.37
 215 "\n"
 216 "{\n"
 217 "    float x2 = x * x;\n"
 218 "    float x3 = x2 * x;\n"
 219 "    vec4 w;\n"
 220 "    w.x =     -x3 + 3 * x2 - 3 * x + 1;\n"
 221 "    w.y =  3 * x3 - 6 * x2         + 4;\n"
 222 "    w.z = -3 * x3 + 3 * x2 + 3 * x + 1;\n"
 223 "    w.w =  x3;\n"
 224 "    return w / 6.f;\n"
 225 "}\n"
 226 "\n"
 227 "vec4 texture_bicubic(sampler2D sampler, vec2 tex_coords)\n"
 228 "{\n"
 229 "   vec2 tex_size = textureSize(sampler, 0);\n"
 230 "   vec2 inv_tex_size = 1.0 / tex_size;\n"
 231 "\n"
 232 "   tex_coords = tex_coords * tex_size - 0.5;\n"
 233 "\n"
 234 "   vec2 fxy = fract(tex_coords);\n"
 235 "   tex_coords -= fxy;\n"
 236 "\n"
 237 "   vec4 xcubic = cubic(fxy.x);\n"
 238 "   vec4 ycubic = cubic(fxy.y);\n"
 239 "\n"
 240 "   vec4 c = tex_coords.xxyy + vec2 (-0.5, +1.5).xyxy;\n"
 241 "\n"
 242 "   vec4 s = vec4(xcubic.xz + xcubic.yw, ycubic.xz + ycubic.yw);\n"
 243 "   vec4 offset = c + vec4 (xcubic.yw, ycubic.yw) / s;\n"
 244 "\n"
 245 "   offset *= inv_tex_size.xxyy;\n"
 246 "\n"
 247 "   vec4 sample0 = texture(sampler, offset.xz);\n"
 248 "   vec4 sample1 = texture(sampler, offset.yz);\n"
 249 "   vec4 sample2 = texture(sampler, offset.xw);\n"
 250 "   vec4 sample3 = texture(sampler, offset.yw);\n"
 251 "\n"
 252 "   float sx = s.x / (s.x + s.y);\n"
 253 "   float sy = s.z / (s.z + s.w);\n"
 254 "\n"
 255 "   return mix(\n"
 256 "          mix(sample3, sample2, sx), mix(sample1, sample0, sx)\n"
 257 "          , sy);\n"
 258 "}\n"
 259 "\n"
 260 "void main()\n"
 261 "{\n"
 262 "       switch (type) {\n"
 263 "               case 0:\n"
 264 "                       FragColor = outline_content_colour;\n"
 265 "                       break;\n"
 266 "               case 1:\n"
 267 "                       FragColor = crop_guess_colour;\n"
 268 "                       break;\n"
 269 "               case 2:\n"
 270 "                       FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
 271 "                       FragColor.x = pow(FragColor.x, IN_GAMMA) / DCI_COEFFICIENT;\n"
 272 "                       FragColor.y = pow(FragColor.y, IN_GAMMA) / DCI_COEFFICIENT;\n"
 273 "                       FragColor.z = pow(FragColor.z, IN_GAMMA) / DCI_COEFFICIENT;\n"
 274 "                       FragColor = xyz_rec709_colour_conversion * FragColor;\n"
 275 "                       FragColor.x = pow(FragColor.x, OUT_GAMMA);\n"
 276 "                       FragColor.y = pow(FragColor.y, OUT_GAMMA);\n"
 277 "                       FragColor.z = pow(FragColor.z, OUT_GAMMA);\n"
 278 "                       break;\n"
 279 "               case 3:\n"
 280 "                       FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
 281 "                       break;\n"
 282 "       }\n"
 283 "}\n";
 284
 285
 286 enum class FragmentType
 287 {
 288         OUTLINE_CONTENT = 0,
 289         CROP_GUESS = 1,
 290         XYZ_IMAGE = 2,
 291         RGB_IMAGE = 3,
 292 };
 293
 294
 295 void
 296 GLVideoView::ensure_context ()
 297 {
 298         if (!_context) {
 299                 wxGLContextAttrs attrs;
 300                 attrs.PlatformDefaults().CoreProfile().OGLVersion(4, 1).EndList();
 301                 _context = new wxGLContext (_canvas, nullptr, &attrs);
 302                 if (!_context->IsOK()) {
 303                         throw GLError ("Making GL context", -1);
 304                 }
 305         }
 306 }
 307
 308
 309 /* Offset and number of indices for the things in the indices array below */
 310 static constexpr int indices_video_texture_offset = 0;
 311 static constexpr int indices_video_texture_number = 6;
 312 static constexpr int indices_subtitle_texture_offset = indices_video_texture_offset + indices_video_texture_number;
 313 static constexpr int indices_subtitle_texture_number = 6;
 314 static constexpr int indices_outline_content_offset = indices_subtitle_texture_offset + indices_subtitle_texture_number;
 315 static constexpr int indices_outline_content_number = 8;
 316 static constexpr int indices_crop_guess_offset = indices_outline_content_offset + indices_outline_content_number;
 317 static constexpr int indices_crop_guess_number = 8;
 318
 319 static constexpr unsigned int indices[] = {
 320         0, 1, 3, // video texture triangle #1
 321         1, 2, 3, // video texture triangle #2
 322         4, 5, 7, // subtitle texture triangle #1
 323         5, 6, 7, // subtitle texture triangle #2
 324         8, 9,    // outline content line #1
 325         9, 10,   // outline content line #2
 326         10, 11,  // outline content line #3
 327         11, 8,   // outline content line #4
 328         12, 13,  // crop guess line #1
 329         13, 14,  // crop guess line #2
 330         14, 15,  // crop guess line #3
 331         15, 12,  // crop guess line #4
 332 };
 333
 334 /* Offsets of things in the GL_ARRAY_BUFFER */
 335 static constexpr int array_buffer_video_offset = 0;
 336 static constexpr int array_buffer_subtitle_offset = array_buffer_video_offset + 4 * 5 * sizeof(float);
 337 static constexpr int array_buffer_outline_content_offset = array_buffer_subtitle_offset + 4 * 5 * sizeof(float);
 338 static constexpr int array_buffer_crop_guess_offset = array_buffer_outline_content_offset + 4 * 5 * sizeof(float);
 339
 340
 341 void
 342 GLVideoView::setup_shaders ()
 343 {
 344         DCPOMATIC_ASSERT (_canvas);
 345         DCPOMATIC_ASSERT (_context);
 346         auto r = _canvas->SetCurrent (*_context);
 347         DCPOMATIC_ASSERT (r);
 348
 349 #ifdef DCPOMATIC_WINDOWS
 350         r = glewInit();
 351         if (r != GLEW_OK) {
 352                 throw GLError(reinterpret_cast<char const*>(glewGetErrorString(r)));
 353         }
 354 #endif
 355
 356         auto get_information = [this](GLenum name) {
 357                 auto s = glGetString (name);
 358                 if (s) {
 359                         _information[name] = std::string (reinterpret_cast<char const *>(s));
 360                 }
 361         };
 362
 363         get_information (GL_VENDOR);
 364         get_information (GL_RENDERER);
 365         get_information (GL_VERSION);
 366         get_information (GL_SHADING_LANGUAGE_VERSION);
 367
 368         glGenVertexArrays(1, &_vao);
 369         check_gl_error ("glGenVertexArrays");
 370         GLuint vbo;
 371         glGenBuffers(1, &vbo);
 372         check_gl_error ("glGenBuffers");
 373         GLuint ebo;
 374         glGenBuffers(1, &ebo);
 375         check_gl_error ("glGenBuffers");
 376
 377         glBindVertexArray(_vao);
 378         check_gl_error ("glBindVertexArray");
 379
 380         glBindBuffer(GL_ARRAY_BUFFER, vbo);
 381         check_gl_error ("glBindBuffer");
 382
 383         glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ebo);
 384         check_gl_error ("glBindBuffer");
 385         glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(indices), indices, GL_STATIC_DRAW);
 386         check_gl_error ("glBufferData");
 387
 388         /* position attribute to vertex shader (location = 0) */
 389         glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5 * sizeof(float), nullptr);
 390         glEnableVertexAttribArray(0);
 391         /* texture coord attribute to vertex shader (location = 1) */
 392         glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5 * sizeof(float), reinterpret_cast<void*>(3 * sizeof(float)));
 393         glEnableVertexAttribArray(1);
 394         check_gl_error ("glEnableVertexAttribArray");
 395
 396         auto compile = [](GLenum type, char const* source) -> GLuint {
 397                 auto shader = glCreateShader(type);
 398                 DCPOMATIC_ASSERT (shader);
 399                 GLchar const * src[] = { static_cast<GLchar const *>(source) };
 400                 glShaderSource(shader, 1, src, nullptr);
 401                 check_gl_error ("glShaderSource");
 402                 glCompileShader(shader);
 403                 check_gl_error ("glCompileShader");
 404                 GLint ok;
 405                 glGetShaderiv(shader, GL_COMPILE_STATUS, &ok);
 406                 if (!ok) {
 407                         GLint log_length;
 408                         glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &log_length);
 409                         string log;
 410                         if (log_length > 0) {
 411                                 std::vector<char> log_char(log_length);
 412                                 glGetShaderInfoLog(shader, log_length, nullptr, log_char.data());
 413                                 log = string(log_char.data());
 414                         }
 415                         glDeleteShader(shader);
 416                         throw GLError(String::compose("Could not compile shader (%1)", log).c_str(), -1);
 417                 }
 418                 return shader;
 419         };
 420
 421         auto vertex_shader = compile (GL_VERTEX_SHADER, vertex_source);
 422         auto fragment_shader = compile (GL_FRAGMENT_SHADER, fragment_source);
 423
 424         auto program = glCreateProgram();
 425         check_gl_error ("glCreateProgram");
 426         glAttachShader (program, vertex_shader);
 427         check_gl_error ("glAttachShader");
 428         glAttachShader (program, fragment_shader);
 429         check_gl_error ("glAttachShader");
 430         glLinkProgram (program);
 431         check_gl_error ("glLinkProgram");
 432         GLint ok;
 433         glGetProgramiv (program, GL_LINK_STATUS, &ok);
 434         if (!ok) {
 435                 GLint log_length;
 436                 glGetProgramiv(program, GL_INFO_LOG_LENGTH, &log_length);
 437                 string log;
 438                 if (log_length > 0) {
 439                         std::vector<char> log_char(log_length);
 440                         glGetProgramInfoLog(program, log_length, nullptr, log_char.data());
 441                         log = string(log_char.data());
 442                 }
 443                 glDeleteProgram (program);
 444                 throw GLError(String::compose("Could not link shader (%1)", log).c_str(), -1);
 445         }
 446         glDeleteShader (vertex_shader);
 447         glDeleteShader (fragment_shader);
 448
 449         glUseProgram (program);
 450
 451         _fragment_type = glGetUniformLocation (program, "type");
 452         check_gl_error ("glGetUniformLocation");
 453         set_outline_content_colour (program);
 454         set_crop_guess_colour (program);
 455
 456         auto ublas_to_gl = [](boost::numeric::ublas::matrix<double> const& ublas, GLfloat* gl) {
 457                 gl[0] = static_cast<float>(ublas(0, 0));
 458                 gl[1] = static_cast<float>(ublas(0, 1));
 459                 gl[2] = static_cast<float>(ublas(0, 2));
 460                 gl[3] = 0.0f;
 461                 gl[4] = static_cast<float>(ublas(1, 0));
 462                 gl[5] = static_cast<float>(ublas(1, 1));
 463                 gl[6] = static_cast<float>(ublas(1, 2));
 464                 gl[7] = 0.0f;
 465                 gl[8] = static_cast<float>(ublas(2, 0));
 466                 gl[9] = static_cast<float>(ublas(2, 1));
 467                 gl[10] = static_cast<float>(ublas(2, 2));
 468                 gl[11] = 0.0f;
 469                 gl[12] = 0.0f;
 470                 gl[13] = 0.0f;
 471                 gl[14] = 0.0f;
 472                 gl[15] = 1.0f;
 473         };
 474
 475         auto conversion = dcp::ColourConversion::rec709_to_xyz();
 476         boost::numeric::ublas::matrix<double> matrix = conversion.xyz_to_rgb ();
 477         GLfloat gl_matrix[16];
 478         ublas_to_gl(matrix, gl_matrix);
 479
 480         auto xyz_rec709_colour_conversion = glGetUniformLocation(program, "xyz_rec709_colour_conversion");
 481         check_gl_error ("glGetUniformLocation");
 482         glUniformMatrix4fv(xyz_rec709_colour_conversion, 1, GL_TRUE, gl_matrix);
 483
 484         glLineWidth (1.0f);
 485         check_gl_error ("glLineWidth");
 486         glEnable (GL_BLEND);
 487         check_gl_error ("glEnable");
 488         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 489         check_gl_error ("glBlendFunc");
 490
 491         /* Reserve space for the GL_ARRAY_BUFFER */
 492         glBufferData(GL_ARRAY_BUFFER, 16 * 5 * sizeof(float), nullptr, GL_STATIC_DRAW);
 493         check_gl_error ("glBufferData");
 494 }
 495
 496
 497 void
 498 GLVideoView::set_outline_content_colour (GLuint program)
 499 {
 500         auto uniform = glGetUniformLocation (program, "outline_content_colour");
 501         check_gl_error ("glGetUniformLocation");
 502         auto colour = outline_content_colour ();
 503         glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
 504         check_gl_error ("glUniform4f");
 505 }
 506
 507
 508 void
 509 GLVideoView::set_crop_guess_colour (GLuint program)
 510 {
 511         auto uniform = glGetUniformLocation (program, "crop_guess_colour");
 512         check_gl_error ("glGetUniformLocation");
 513         auto colour = crop_guess_colour ();
 514         glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
 515         check_gl_error ("glUniform4f");
 516 }
 517
 518
 519 void
 520 GLVideoView::draw ()
 521 {
 522         auto pad = pad_colour();
 523         glClearColor(pad.Red() / 255.0, pad.Green() / 255.0, pad.Blue() / 255.0, 1.0);
 524         glClear (GL_COLOR_BUFFER_BIT);
 525         check_gl_error ("glClear");
 526
 527         auto const size = _canvas_size.load();
 528         int const width = size.GetWidth();
 529         int const height = size.GetHeight();
 530
 531         if (width < 64 || height < 0) {
 532                 return;
 533         }
 534
 535         glViewport (0, 0, width, height);
 536         check_gl_error ("glViewport");
 537
 538         glBindVertexArray(_vao);
 539         check_gl_error ("glBindVertexArray");
 540         glUniform1i(_fragment_type, static_cast<GLint>(_optimise_for_j2k ? FragmentType::XYZ_IMAGE : FragmentType::RGB_IMAGE));
 541         _video_texture->bind();
 542         glDrawElements (GL_TRIANGLES, indices_video_texture_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_video_texture_offset * sizeof(int)));
 543         if (_have_subtitle_to_render) {
 544                 glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::RGB_IMAGE));
 545                 _subtitle_texture->bind();
 546                 glDrawElements (GL_TRIANGLES, indices_subtitle_texture_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_subtitle_texture_offset * sizeof(int)));
 547         }
 548         if (_viewer->outline_content()) {
 549                 glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::OUTLINE_CONTENT));
 550                 glDrawElements (GL_LINES, indices_outline_content_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_outline_content_offset * sizeof(int)));
 551                 check_gl_error ("glDrawElements");
 552         }
 553         if (auto guess = _viewer->crop_guess()) {
 554                 glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::CROP_GUESS));
 555                 glDrawElements (GL_LINES, indices_crop_guess_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_crop_guess_offset * sizeof(int)));
 556                 check_gl_error ("glDrawElements");
 557         }
 558
 559         glFlush();
 560         check_gl_error ("glFlush");
 561
 562         _canvas->SwapBuffers();
 563 }
 564
 565
 566 void
 567 GLVideoView::set_image (shared_ptr<const PlayerVideo> pv)
 568 {
 569         shared_ptr<const Image> video = _optimise_for_j2k ? pv->raw_image() : pv->image(boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, true);
 570
 571         /* Only the player's black frames should be aligned at this stage, so this should
 572          * almost always have no work to do.
 573          */
 574         video = Image::ensure_alignment (video, Image::Alignment::COMPACT);
 575
 576         /** If _optimise_for_j2k is true we render a XYZ image, doing the colourspace
 577          *  conversion, scaling and video range conversion in the GL shader.
 578          *  Otherwise we render a RGB image without any shader-side processing.
 579          */
 580
 581         _video_texture->set (video);
 582
 583         auto const text = pv->text();
 584         _have_subtitle_to_render = static_cast<bool>(text) && _optimise_for_j2k;
 585         if (_have_subtitle_to_render) {
 586                 /* opt: only do this if it's a new subtitle? */
 587                 DCPOMATIC_ASSERT (text->image->alignment() == Image::Alignment::COMPACT);
 588                 _subtitle_texture->set (text->image);
 589         }
 590
 591
 592         auto const canvas_size = _canvas_size.load();
 593         int const canvas_width = canvas_size.GetWidth();
 594         int const canvas_height = canvas_size.GetHeight();
 595         auto const inter_position = player_video().first->inter_position();
 596         auto const inter_size = player_video().first->inter_size();
 597         auto const out_size = player_video().first->out_size();
 598         auto const crop_guess = _viewer->crop_guess();
 599
 600         auto x_offset = std::max(0, (canvas_width - out_size.width) / 2);
 601         auto y_offset = std::max(0, (canvas_height - out_size.height) / 2);
 602
 603         _last_canvas_size.set_next (canvas_size);
 604         _last_video_size.set_next (video->size());
 605         _last_inter_position.set_next (inter_position);
 606         _last_inter_size.set_next (inter_size);
 607         _last_out_size.set_next (out_size);
 608         _last_crop_guess.set_next (crop_guess);
 609
 610         class Rectangle
 611         {
 612         public:
 613                 Rectangle (wxSize canvas_size, float x, float y, dcp::Size size)
 614                         : _canvas_size (canvas_size)
 615                 {
 616                         auto const x1 = x_pixels_to_gl(x);
 617                         auto const y1 = y_pixels_to_gl(y);
 618                         auto const x2 = x_pixels_to_gl(x + size.width);
 619                         auto const y2 = y_pixels_to_gl(y + size.height);
 620
 621                         /* The texture coordinates here have to account for the fact that when we put images into the texture OpenGL
 622                          * expected us to start at the lower left but we actually started at the top left.  So although the
 623                          * top of the texture is at 1.0 we pretend it's the other way round.
 624                          */
 625
 626                         // bottom right
 627                         _vertices[0] = x2;
 628                         _vertices[1] = y2;
 629                         _vertices[2] = 0.0f;
 630                         _vertices[3] = 1.0f;
 631                         _vertices[4] = 1.0f;
 632
 633                         // top right
 634                         _vertices[5] = x2;
 635                         _vertices[6] = y1;
 636                         _vertices[7] = 0.0f;
 637                         _vertices[8] = 1.0f;
 638                         _vertices[9] = 0.0f;
 639
 640                         // top left
 641                         _vertices[10] = x1;
 642                         _vertices[11] = y1;
 643                         _vertices[12] = 0.0f;
 644                         _vertices[13] = 0.0f;
 645                         _vertices[14] = 0.0f;
 646
 647                         // bottom left
 648                         _vertices[15] = x1;
 649                         _vertices[16] = y2;
 650                         _vertices[17] = 0.0f;
 651                         _vertices[18] = 0.0f;
 652                         _vertices[19] = 1.0f;
 653                 }
 654
 655                 float const * vertices () const {
 656                         return _vertices;
 657                 }
 658
 659                 int const size () const {
 660                         return sizeof(_vertices);
 661                 }
 662
 663         private:
 664                 /* @param x x position in pixels where 0 is left and canvas_width is right on screen */
 665                 float x_pixels_to_gl(int x) const {
 666                         return (x * 2.0f / _canvas_size.GetWidth()) - 1.0f;
 667                 }
 668
 669                 /* @param y y position in pixels where 0 is top and canvas_height is bottom on screen */
 670                 float y_pixels_to_gl(int y) const {
 671                         return 1.0f - (y * 2.0f / _canvas_size.GetHeight());
 672                 }
 673
 674                 wxSize _canvas_size;
 675                 float _vertices[20];
 676         };
 677
 678         auto const sizing_changed = _last_canvas_size.changed() || _last_inter_position.changed() || _last_inter_size.changed() || _last_out_size.changed();
 679
 680         if (sizing_changed) {
 681                 const auto video = _optimise_for_j2k ?
 682                         Rectangle(canvas_size, inter_position.x + x_offset, inter_position.y + y_offset, inter_size)
 683                         : Rectangle(canvas_size, x_offset, y_offset, out_size);
 684
 685                 glBufferSubData (GL_ARRAY_BUFFER, array_buffer_video_offset, video.size(), video.vertices());
 686                 check_gl_error ("glBufferSubData (video)");
 687
 688                 const auto outline_content = Rectangle(canvas_size, inter_position.x + x_offset, inter_position.y + y_offset, inter_size);
 689                 glBufferSubData (GL_ARRAY_BUFFER, array_buffer_outline_content_offset, outline_content.size(), outline_content.vertices());
 690                 check_gl_error ("glBufferSubData (outline_content)");
 691         }
 692
 693         if ((sizing_changed || _last_crop_guess.changed()) && crop_guess) {
 694                 auto const crop_guess_rectangle = Rectangle(
 695                         canvas_size,
 696                         inter_position.x + x_offset + inter_size.width * crop_guess->x,
 697                         inter_position.y + y_offset + inter_size.height * crop_guess->y,
 698                         dcp::Size(inter_size.width * crop_guess->width, inter_size.height * crop_guess->height)
 699                         );
 700                 glBufferSubData (GL_ARRAY_BUFFER, array_buffer_crop_guess_offset, crop_guess_rectangle.size(), crop_guess_rectangle.vertices());
 701                 check_gl_error ("glBufferSubData (crop_guess_rectangle)");
 702         }
 703
 704         if (_have_subtitle_to_render) {
 705                 const auto subtitle = Rectangle(canvas_size, inter_position.x + x_offset + text->position.x, inter_position.y + y_offset + text->position.y, text->image->size());
 706                 glBufferSubData (GL_ARRAY_BUFFER, array_buffer_subtitle_offset, subtitle.size(), subtitle.vertices());
 707                 check_gl_error ("glBufferSubData (subtitle)");
 708         }
 709
 710         /* opt: where should these go? */
 711
 712         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 713         glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 714         check_gl_error ("glTexParameteri");
 715
 716         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
 717         glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
 718         check_gl_error ("glTexParameterf");
 719 }
 720
 721
 722 void
 723 GLVideoView::start ()
 724 {
 725         VideoView::start ();
 726
 727         boost::mutex::scoped_lock lm (_playing_mutex);
 728         _playing = true;
 729         _thread_work_condition.notify_all ();
 730 }
 731
 732 void
 733 GLVideoView::stop ()
 734 {
 735         boost::mutex::scoped_lock lm (_playing_mutex);
 736         _playing = false;
 737 }
 738
 739
 740 void
 741 GLVideoView::thread_playing ()
 742 {
 743         if (length() != dcpomatic::DCPTime()) {
 744                 auto const next = position() + one_video_frame();
 745
 746                 if (next >= length()) {
 747                         _viewer->finished ();
 748                         return;
 749                 }
 750
 751                 get_next_frame (false);
 752                 set_image_and_draw ();
 753         }
 754
 755         while (true) {
 756                 optional<int> n = time_until_next_frame();
 757                 if (!n || *n > 5) {
 758                         break;
 759                 }
 760                 get_next_frame (true);
 761                 add_dropped ();
 762         }
 763 }
 764
 765
 766 void
 767 GLVideoView::set_image_and_draw ()
 768 {
 769         auto pv = player_video().first;
 770         if (pv) {
 771                 set_image (pv);
 772         }
 773
 774         draw ();
 775
 776         if (pv) {
 777                 _viewer->image_changed (pv);
 778         }
 779 }
 780
 781
 782 void
 783 GLVideoView::thread ()
 784 try
 785 {
 786         start_of_thread ("GLVideoView");
 787
 788 #if defined(DCPOMATIC_OSX)
 789         /* Without this we see errors like
 790          * ../src/osx/cocoa/glcanvas.mm(194): assert ""context"" failed in SwapBuffers(): should have current context [in thread 700006970000]
 791          */
 792         WXGLSetCurrentContext (_context->GetWXGLContext());
 793 #else
 794         if (!_setup_shaders_done) {
 795                 setup_shaders ();
 796                 _setup_shaders_done = true;
 797         }
 798 #endif
 799
 800 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
 801         if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
 802                 /* Enable vsync */
 803                 Display* dpy = wxGetX11Display();
 804                 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
 805                 _vsync_enabled = true;
 806         }
 807 #endif
 808
 809 #ifdef DCPOMATIC_WINDOWS
 810         if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
 811                 /* Enable vsync */
 812                 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
 813                 if (swap) {
 814                         swap (1);
 815                         _vsync_enabled = true;
 816                 }
 817         }
 818
 819 #endif
 820
 821 #ifdef DCPOMATIC_OSX
 822         /* Enable vsync */
 823         GLint swapInterval = 1;
 824         CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
 825         _vsync_enabled = true;
 826 #endif
 827
 828         _video_texture.reset(new Texture(_optimise_for_j2k ? 2 : 1));
 829         _subtitle_texture.reset(new Texture(1));
 830
 831         while (true) {
 832                 boost::mutex::scoped_lock lm (_playing_mutex);
 833                 while (!_playing && !_one_shot) {
 834                         _thread_work_condition.wait (lm);
 835                 }
 836                 lm.unlock ();
 837
 838                 if (_playing) {
 839                         thread_playing ();
 840                 } else if (_one_shot) {
 841                         _one_shot = false;
 842                         set_image_and_draw ();
 843                 }
 844
 845                 boost::this_thread::interruption_point ();
 846                 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
 847         }
 848
 849         /* XXX: leaks _context, but that seems preferable to deleting it here
 850          * without also deleting the wxGLCanvas.
 851          */
 852 }
 853 catch (...)
 854 {
 855         store_current ();
 856 }
 857
 858
 859 VideoView::NextFrameResult
 860 GLVideoView::display_next_frame (bool non_blocking)
 861 {
 862         NextFrameResult const r = get_next_frame (non_blocking);
 863         request_one_shot ();
 864         return r;
 865 }
 866
 867
 868 void
 869 GLVideoView::request_one_shot ()
 870 {
 871         boost::mutex::scoped_lock lm (_playing_mutex);
 872         _one_shot = true;
 873         _thread_work_condition.notify_all ();
 874 }
 875
 876
 877 Texture::Texture (GLint unpack_alignment)
 878         : _unpack_alignment (unpack_alignment)
 879 {
 880         glGenTextures (1, &_name);
 881         check_gl_error ("glGenTextures");
 882 }
 883
 884
 885 Texture::~Texture ()
 886 {
 887         glDeleteTextures (1, &_name);
 888 }
 889
 890
 891 void
 892 Texture::bind ()
 893 {
 894         glBindTexture(GL_TEXTURE_2D, _name);
 895         check_gl_error ("glBindTexture");
 896 }
 897
 898
 899 void
 900 Texture::set (shared_ptr<const Image> image)
 901 {
 902         auto const create = !_size || image->size() != _size;
 903         _size = image->size();
 904
 905         glPixelStorei (GL_UNPACK_ALIGNMENT, _unpack_alignment);
 906         check_gl_error ("glPixelStorei");
 907
 908         DCPOMATIC_ASSERT (image->alignment() == Image::Alignment::COMPACT);
 909
 910         GLint internal_format;
 911         GLenum format;
 912         GLenum type;
 913
 914         switch (image->pixel_format()) {
 915         case AV_PIX_FMT_BGRA:
 916                 internal_format = GL_RGBA8;
 917                 format = GL_BGRA;
 918                 type = GL_UNSIGNED_BYTE;
 919                 break;
 920         case AV_PIX_FMT_RGBA:
 921                 internal_format = GL_RGBA8;
 922                 format = GL_RGBA;
 923                 type = GL_UNSIGNED_BYTE;
 924                 break;
 925         case AV_PIX_FMT_RGB24:
 926                 internal_format = GL_RGBA8;
 927                 format = GL_RGB;
 928                 type = GL_UNSIGNED_BYTE;
 929                 break;
 930         case AV_PIX_FMT_XYZ12:
 931                 internal_format = GL_RGBA12;
 932                 format = GL_RGB;
 933                 type = GL_UNSIGNED_SHORT;
 934                 break;
 935         default:
 936                 throw PixelFormatError ("Texture::set", image->pixel_format());
 937         }
 938
 939         bind ();
 940
 941         if (create) {
 942                 glTexImage2D (GL_TEXTURE_2D, 0, internal_format, _size->width, _size->height, 0, format, type, image->data()[0]);
 943                 check_gl_error ("glTexImage2D");
 944         } else {
 945                 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _size->width, _size->height, format, type, image->data()[0]);
 946                 check_gl_error ("glTexSubImage2D");
 947         }
 948 }
 949
 950 #endif