2 Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #ifdef DCPOMATIC_WINDOWS
26 #include "gl_video_view.h"
27 #include "film_viewer.h"
29 #include "lib/image.h"
30 #include "lib/dcpomatic_assert.h"
31 #include "lib/exceptions.h"
32 #include "lib/cross.h"
33 #include "lib/player_video.h"
34 #include "lib/butler.h"
35 #include <boost/bind/bind.hpp>
39 #define GL_DO_NOT_WARN_IF_MULTI_GL_VERSION_HEADERS_INCLUDED
40 #include <OpenGL/OpenGL.h>
41 #include <OpenGL/gl3.h>
44 #ifdef DCPOMATIC_LINUX
49 #ifdef DCPOMATIC_WINDOWS
51 #include <GL/wglext.h>
56 using std::shared_ptr;
58 using boost::optional;
59 #if BOOST_VERSION >= 106100
60 using namespace boost::placeholders;
65 check_gl_error (char const * last)
67 GLenum const e = glGetError ();
68 if (e != GL_NO_ERROR) {
69 throw GLError (last, e);
74 GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
77 , _have_storage (false)
78 , _vsync_enabled (false)
82 wxGLAttributes attributes;
83 /* We don't need a depth buffer, and indeed there is apparently a bug with Windows/Intel HD 630
84 * which puts green lines over the OpenGL display if you have a non-zero depth buffer size.
85 * https://community.intel.com/t5/Graphics/Request-for-details-on-Intel-HD-630-green-lines-in-OpenGL-apps/m-p/1202179
87 attributes.PlatformDefaults().MinRGBA(8, 8, 8, 8).DoubleBuffer().Depth(0).EndList();
88 _canvas = new wxGLCanvas (
89 parent, attributes, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE
91 _canvas->Bind (wxEVT_PAINT, boost::bind(&GLVideoView::update, this));
92 _canvas->Bind (wxEVT_SIZE, boost::bind(&GLVideoView::size_changed, this, _1));
94 _canvas->Bind (wxEVT_TIMER, boost::bind(&GLVideoView::check_for_butler_errors, this));
95 _timer.reset (new wxTimer(_canvas));
101 GLVideoView::size_changed (wxSizeEvent const& ev)
103 _canvas_size = ev.GetSize ();
109 GLVideoView::~GLVideoView ()
111 boost::this_thread::disable_interruption dis;
114 _thread.interrupt ();
120 GLVideoView::check_for_butler_errors ()
122 if (!_viewer->butler()) {
127 _viewer->butler()->rethrow ();
128 } catch (DecodeError& e) {
129 error_dialog (get(), e.what());
130 } catch (dcp::ReadError& e) {
131 error_dialog (get(), wxString::Format(_("Could not read DCP: %s"), std_to_wx(e.what())));
136 /** Called from the UI thread */
138 GLVideoView::update ()
140 if (!_canvas->IsShownOnScreen()) {
144 /* It appears important to do this from the GUI thread; if we do it from the GL thread
145 * on Linux we get strange failures to create the context for any version of GL higher
151 /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
152 if (!_setup_shaders_done) {
154 _setup_shaders_done = true;
158 if (!_thread.joinable()) {
159 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
168 static constexpr char vertex_source[] =
169 "#version 330 core\n"
171 "layout (location = 0) in vec3 in_pos;\n"
172 "layout (location = 1) in vec2 in_tex_coord;\n"
174 "out vec2 TexCoord;\n"
178 " gl_Position = vec4(in_pos, 1.0);\n"
179 " TexCoord = in_tex_coord;\n"
183 /* Bicubic interpolation stolen from https://stackoverflow.com/questions/13501081/efficient-bicubic-filtering-code-in-glsl */
184 static constexpr char fragment_source[] =
185 "#version 330 core\n"
187 "in vec2 TexCoord;\n"
189 "uniform sampler2D texture_sampler;\n"
190 /* type = 0: draw border
191 * type = 1: draw XYZ image
192 * type = 2: draw RGB image
194 "uniform int type = 0;\n"
195 "uniform vec4 border_colour;\n"
196 "uniform mat4 colour_conversion;\n"
198 "out vec4 FragColor;\n"
200 "vec4 cubic(float x)\n"
202 "#define IN_GAMMA 2.2\n"
203 "#define OUT_GAMMA 0.384615385\n" // 1 / 2.6
204 "#define DCI_COEFFICIENT 0.91655528\n" // 48 / 53.37
207 " float x2 = x * x;\n"
208 " float x3 = x2 * x;\n"
210 " w.x = -x3 + 3 * x2 - 3 * x + 1;\n"
211 " w.y = 3 * x3 - 6 * x2 + 4;\n"
212 " w.z = -3 * x3 + 3 * x2 + 3 * x + 1;\n"
217 "vec4 texture_bicubic(sampler2D sampler, vec2 tex_coords)\n"
219 " vec2 tex_size = textureSize(sampler, 0);\n"
220 " vec2 inv_tex_size = 1.0 / tex_size;\n"
222 " tex_coords = tex_coords * tex_size - 0.5;\n"
224 " vec2 fxy = fract(tex_coords);\n"
225 " tex_coords -= fxy;\n"
227 " vec4 xcubic = cubic(fxy.x);\n"
228 " vec4 ycubic = cubic(fxy.y);\n"
230 " vec4 c = tex_coords.xxyy + vec2 (-0.5, +1.5).xyxy;\n"
232 " vec4 s = vec4(xcubic.xz + xcubic.yw, ycubic.xz + ycubic.yw);\n"
233 " vec4 offset = c + vec4 (xcubic.yw, ycubic.yw) / s;\n"
235 " offset *= inv_tex_size.xxyy;\n"
237 " vec4 sample0 = texture(sampler, offset.xz);\n"
238 " vec4 sample1 = texture(sampler, offset.yz);\n"
239 " vec4 sample2 = texture(sampler, offset.xw);\n"
240 " vec4 sample3 = texture(sampler, offset.yw);\n"
242 " float sx = s.x / (s.x + s.y);\n"
243 " float sy = s.z / (s.z + s.w);\n"
246 " mix(sample3, sample2, sx), mix(sample1, sample0, sx)\n"
254 " FragColor = border_colour;\n"
257 " FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
258 " FragColor.x = pow(FragColor.x, IN_GAMMA) / DCI_COEFFICIENT;\n"
259 " FragColor.y = pow(FragColor.y, IN_GAMMA) / DCI_COEFFICIENT;\n"
260 " FragColor.z = pow(FragColor.z, IN_GAMMA) / DCI_COEFFICIENT;\n"
261 " FragColor = colour_conversion * FragColor;\n"
262 " FragColor.x = pow(FragColor.x, OUT_GAMMA);\n"
263 " FragColor.y = pow(FragColor.y, OUT_GAMMA);\n"
264 " FragColor.z = pow(FragColor.z, OUT_GAMMA);\n"
267 " FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
274 GLVideoView::ensure_context ()
277 wxGLContextAttrs attrs;
278 attrs.PlatformDefaults().CoreProfile().OGLVersion(4, 1).EndList();
279 _context = new wxGLContext (_canvas, nullptr, &attrs);
280 if (!_context->IsOK()) {
281 throw GLError ("Making GL context", -1);
287 /* Offset of video texture triangles in indices */
288 static constexpr int indices_video_texture = 0;
289 /* Offset of border lines in indices */
290 static constexpr int indices_border = 6;
292 static constexpr unsigned int indices[] = {
293 0, 1, 3, // video texture triangle #1
294 1, 2, 3, // video texture triangle #2
295 4, 5, // border line #1
296 5, 6, // border line #2
297 6, 7, // border line #3
298 7, 4, // border line #4
303 GLVideoView::setup_shaders ()
305 DCPOMATIC_ASSERT (_canvas);
306 DCPOMATIC_ASSERT (_context);
307 auto r = _canvas->SetCurrent (*_context);
308 DCPOMATIC_ASSERT (r);
310 #ifdef DCPOMATIC_WINDOWS
313 throw GLError(reinterpret_cast<char const*>(glewGetErrorString(r)));
317 auto get_information = [this](GLenum name) {
318 auto s = glGetString (name);
320 _information[name] = std::string (reinterpret_cast<char const *>(s));
324 get_information (GL_VENDOR);
325 get_information (GL_RENDERER);
326 get_information (GL_VERSION);
327 get_information (GL_SHADING_LANGUAGE_VERSION);
329 glGenVertexArrays(1, &_vao);
330 check_gl_error ("glGenVertexArrays");
332 glGenBuffers(1, &vbo);
333 check_gl_error ("glGenBuffers");
335 glGenBuffers(1, &ebo);
336 check_gl_error ("glGenBuffers");
338 glBindVertexArray(_vao);
339 check_gl_error ("glBindVertexArray");
341 glBindBuffer(GL_ARRAY_BUFFER, vbo);
342 check_gl_error ("glBindBuffer");
344 glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ebo);
345 check_gl_error ("glBindBuffer");
346 glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(indices), indices, GL_STATIC_DRAW);
347 check_gl_error ("glBufferData");
349 /* position attribute to vertex shader (location = 0) */
350 glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5 * sizeof(float), nullptr);
351 glEnableVertexAttribArray(0);
352 /* texture coord attribute to vertex shader (location = 1) */
353 glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5 * sizeof(float), reinterpret_cast<void*>(3 * sizeof(float)));
354 glEnableVertexAttribArray(1);
355 check_gl_error ("glEnableVertexAttribArray");
357 auto compile = [](GLenum type, char const* source) -> GLuint {
358 auto shader = glCreateShader(type);
359 DCPOMATIC_ASSERT (shader);
360 GLchar const * src[] = { static_cast<GLchar const *>(source) };
361 glShaderSource(shader, 1, src, nullptr);
362 check_gl_error ("glShaderSource");
363 glCompileShader(shader);
364 check_gl_error ("glCompileShader");
366 glGetShaderiv(shader, GL_COMPILE_STATUS, &ok);
369 glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &log_length);
371 if (log_length > 0) {
372 char* log_char = new char[log_length];
373 glGetShaderInfoLog(shader, log_length, nullptr, log_char);
374 log = string(log_char);
377 glDeleteShader(shader);
378 throw GLError(String::compose("Could not compile shader (%1)", log).c_str(), -1);
383 auto vertex_shader = compile (GL_VERTEX_SHADER, vertex_source);
384 auto fragment_shader = compile (GL_FRAGMENT_SHADER, fragment_source);
386 auto program = glCreateProgram();
387 check_gl_error ("glCreateProgram");
388 glAttachShader (program, vertex_shader);
389 check_gl_error ("glAttachShader");
390 glAttachShader (program, fragment_shader);
391 check_gl_error ("glAttachShader");
392 glLinkProgram (program);
393 check_gl_error ("glLinkProgram");
395 glGetProgramiv (program, GL_LINK_STATUS, &ok);
398 glGetProgramiv(program, GL_INFO_LOG_LENGTH, &log_length);
400 if (log_length > 0) {
401 char* log_char = new char[log_length];
402 glGetProgramInfoLog(program, log_length, nullptr, log_char);
403 log = string(log_char);
406 glDeleteProgram (program);
407 throw GLError(String::compose("Could not link shader (%1)", log).c_str(), -1);
409 glDeleteShader (vertex_shader);
410 glDeleteShader (fragment_shader);
412 glUseProgram (program);
414 _fragment_type = glGetUniformLocation (program, "type");
415 check_gl_error ("glGetUniformLocation");
416 set_border_colour (program);
418 auto conversion = dcp::ColourConversion::rec709_to_xyz();
419 boost::numeric::ublas::matrix<double> matrix = conversion.xyz_to_rgb ();
420 GLfloat gl_matrix[] = {
421 static_cast<float>(matrix(0, 0)), static_cast<float>(matrix(0, 1)), static_cast<float>(matrix(0, 2)), 0.0f,
422 static_cast<float>(matrix(1, 0)), static_cast<float>(matrix(1, 1)), static_cast<float>(matrix(1, 2)), 0.0f,
423 static_cast<float>(matrix(2, 0)), static_cast<float>(matrix(2, 1)), static_cast<float>(matrix(2, 2)), 0.0f,
424 0.0f, 0.0f, 0.0f, 1.0f
427 auto colour_conversion = glGetUniformLocation (program, "colour_conversion");
428 check_gl_error ("glGetUniformLocation");
429 glUniformMatrix4fv (colour_conversion, 1, GL_TRUE, gl_matrix);
436 GLVideoView::set_border_colour (GLuint program)
438 auto uniform = glGetUniformLocation (program, "border_colour");
439 check_gl_error ("glGetUniformLocation");
440 auto colour = outline_content_colour ();
441 glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
442 check_gl_error ("glUniform4f");
447 GLVideoView::draw (Position<int>, dcp::Size)
449 auto pad = pad_colour();
450 glClearColor(pad.Red() / 255.0, pad.Green() / 255.0, pad.Blue() / 255.0, 1.0);
451 glClear (GL_COLOR_BUFFER_BIT);
452 check_gl_error ("glClear");
454 auto const size = _canvas_size.load();
455 int const width = size.GetWidth();
456 int const height = size.GetHeight();
458 if (width < 64 || height < 0) {
462 glViewport (0, 0, width, height);
463 check_gl_error ("glViewport");
465 glBindVertexArray(_vao);
466 check_gl_error ("glBindVertexArray");
467 glUniform1i(_fragment_type, _optimise_for_j2k ? 1 : 2);
468 glDrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_video_texture));
469 if (_viewer->outline_content()) {
470 glUniform1i(_fragment_type, 1);
471 glDrawElements (GL_LINES, 8, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_border * sizeof(int)));
472 check_gl_error ("glDrawElements");
476 check_gl_error ("glFlush");
478 _canvas->SwapBuffers();
483 GLVideoView::set_image (shared_ptr<const PlayerVideo> pv)
485 auto image = _optimise_for_j2k ? pv->raw_image() : pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true);
487 DCPOMATIC_ASSERT (!image->aligned());
489 /** If _optimise_for_j2k is true we render a XYZ image, doing the colourspace
490 * conversion, scaling and video range conversion in the GL shader.
491 * Othewise we render a RGB image without any shader-side processing.
494 /* XXX: video range conversion */
497 if (image->size() != _video_size) {
498 _have_storage = false;
501 _video_size = image->size ();
502 glPixelStorei (GL_UNPACK_ALIGNMENT, _optimise_for_j2k ? 2 : 1);
503 check_gl_error ("glPixelStorei");
505 auto const format = _optimise_for_j2k ? GL_UNSIGNED_SHORT : GL_UNSIGNED_BYTE;
508 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _video_size->width, _video_size->height, GL_RGB, format, image->data()[0]);
509 check_gl_error ("glTexSubImage2D");
511 glTexImage2D (GL_TEXTURE_2D, 0, _optimise_for_j2k ? GL_RGBA12 : GL_RGBA8, _video_size->width, _video_size->height, 0, GL_RGB, format, image->data()[0]);
512 check_gl_error ("glTexImage2D");
514 auto const canvas_size = _canvas_size.load();
515 int const canvas_width = canvas_size.GetWidth();
516 int const canvas_height = canvas_size.GetHeight();
518 float const image_x = float(_video_size->width) / canvas_width;
519 float const image_y = float(_video_size->height) / canvas_height;
521 auto x_pixels_to_gl = [canvas_width](int x) {
522 return (x * 2.0f / canvas_width) - 1.0f;
525 auto y_pixels_to_gl = [canvas_height](int y) {
526 return (y * 2.0f / canvas_height) - 1.0f;
529 auto inter_position = player_video().first->inter_position();
530 auto inter_size = player_video().first->inter_size();
532 float const border_x1 = x_pixels_to_gl (inter_position.x) + 1.0f - image_x;
533 float const border_y1 = y_pixels_to_gl (inter_position.y) + 1.0f - image_y;
534 float const border_x2 = x_pixels_to_gl (inter_position.x + inter_size.width) + 1.0f - image_x;
535 float const border_y2 = y_pixels_to_gl (inter_position.y + inter_size.height) + 1.0f - image_y;
538 // positions // texture coords
539 image_x, image_y, 0.0f, 1.0f, 0.0f, // video texture top right (index 0)
540 image_x, -image_y, 0.0f, 1.0f, 1.0f, // video texture bottom right (index 1)
541 -image_x, -image_y, 0.0f, 0.0f, 1.0f, // video texture bottom left (index 2)
542 -image_x, image_y, 0.0f, 0.0f, 0.0f, // video texture top left (index 3)
543 border_x1, border_y1, 0.0f, 0.0f, 0.0f, // border bottom left (index 4)
544 border_x1, border_y2, 0.0f, 0.0f, 0.0f, // border top left (index 5)
545 border_x2, border_y2, 0.0f, 0.0f, 0.0f, // border top right (index 6)
546 border_x2, border_y1, 0.0f, 0.0f, 0.0f, // border bottom right (index 7)
549 /* Set the vertex shader's input data (GL_ARRAY_BUFFER) */
550 glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
551 check_gl_error ("glBufferData");
553 _have_storage = true;
556 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
557 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
558 check_gl_error ("glTexParameteri");
560 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
561 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
562 check_gl_error ("glTexParameterf");
567 GLVideoView::start ()
571 boost::mutex::scoped_lock lm (_playing_mutex);
573 _thread_work_condition.notify_all ();
579 boost::mutex::scoped_lock lm (_playing_mutex);
585 GLVideoView::thread_playing ()
587 if (length() != dcpomatic::DCPTime()) {
588 auto const next = position() + one_video_frame();
590 if (next >= length()) {
591 _viewer->finished ();
595 get_next_frame (false);
596 set_image_and_draw ();
600 optional<int> n = time_until_next_frame();
604 get_next_frame (true);
611 GLVideoView::set_image_and_draw ()
613 auto pv = player_video().first;
616 draw (pv->inter_position(), pv->inter_size());
617 _viewer->image_changed (pv);
623 GLVideoView::thread ()
626 start_of_thread ("GLVideoView");
628 #if defined(DCPOMATIC_OSX)
629 /* Without this we see errors like
630 * ../src/osx/cocoa/glcanvas.mm(194): assert ""context"" failed in SwapBuffers(): should have current context [in thread 700006970000]
632 WXGLSetCurrentContext (_context->GetWXGLContext());
634 if (!_setup_shaders_done) {
636 _setup_shaders_done = true;
640 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
641 if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
643 Display* dpy = wxGetX11Display();
644 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
645 _vsync_enabled = true;
649 #ifdef DCPOMATIC_WINDOWS
650 if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
652 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
655 _vsync_enabled = true;
663 GLint swapInterval = 1;
664 CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
665 _vsync_enabled = true;
668 _video_texture.reset(new Texture());
669 _video_texture->bind();
672 boost::mutex::scoped_lock lm (_playing_mutex);
673 while (!_playing && !_one_shot) {
674 _thread_work_condition.wait (lm);
680 } else if (_one_shot) {
682 set_image_and_draw ();
685 boost::this_thread::interruption_point ();
686 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
689 /* XXX: leaks _context, but that seems preferable to deleting it here
690 * without also deleting the wxGLCanvas.
699 VideoView::NextFrameResult
700 GLVideoView::display_next_frame (bool non_blocking)
702 NextFrameResult const r = get_next_frame (non_blocking);
709 GLVideoView::request_one_shot ()
711 boost::mutex::scoped_lock lm (_playing_mutex);
713 _thread_work_condition.notify_all ();
719 glGenTextures (1, &_name);
720 check_gl_error ("glGenTextures");
726 glDeleteTextures (1, &_name);
733 glBindTexture(GL_TEXTURE_2D, _name);
734 check_gl_error ("glBindTexture");