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 ();
118 glDeleteTextures (1, &_texture);
122 GLVideoView::check_for_butler_errors ()
124 if (!_viewer->butler()) {
129 _viewer->butler()->rethrow ();
130 } catch (DecodeError& e) {
131 error_dialog (get(), e.what());
132 } catch (dcp::ReadError& e) {
133 error_dialog (get(), wxString::Format(_("Could not read DCP: %s"), std_to_wx(e.what())));
138 /** Called from the UI thread */
140 GLVideoView::update ()
142 if (!_canvas->IsShownOnScreen()) {
146 /* It appears important to do this from the GUI thread; if we do it from the GL thread
147 * on Linux we get strange failures to create the context for any version of GL higher
153 /* macOS gives errors if we don't do this (and therefore [NSOpenGLContext setView:]) from the main thread */
154 if (!_setup_shaders_done) {
156 _setup_shaders_done = true;
160 if (!_thread.joinable()) {
161 _thread = boost::thread (boost::bind(&GLVideoView::thread, this));
170 static constexpr char vertex_source[] =
171 "#version 330 core\n"
173 "layout (location = 0) in vec3 in_pos;\n"
174 "layout (location = 1) in vec2 in_tex_coord;\n"
176 "out vec2 TexCoord;\n"
180 " gl_Position = vec4(in_pos, 1.0);\n"
181 " TexCoord = in_tex_coord;\n"
185 /* Bicubic interpolation stolen from https://stackoverflow.com/questions/13501081/efficient-bicubic-filtering-code-in-glsl */
186 static constexpr char fragment_source[] =
187 "#version 330 core\n"
189 "in vec2 TexCoord;\n"
191 "uniform sampler2D texture_sampler;\n"
192 "uniform int draw_border;\n"
193 "uniform vec4 border_colour;\n"
195 "out vec4 FragColor;\n"
197 "vec4 cubic(float x)\n"
199 " float x2 = x * x;\n"
200 " float x3 = x2 * x;\n"
202 " w.x = -x3 + 3 * x2 - 3 * x + 1;\n"
203 " w.y = 3 * x3 - 6 * x2 + 4;\n"
204 " w.z = -3 * x3 + 3 * x2 + 3 * x + 1;\n"
209 "vec4 texture_bicubic(sampler2D sampler, vec2 tex_coords)\n"
211 " vec2 tex_size = textureSize(sampler, 0);\n"
212 " vec2 inv_tex_size = 1.0 / tex_size;\n"
214 " tex_coords = tex_coords * tex_size - 0.5;\n"
216 " vec2 fxy = fract(tex_coords);\n"
217 " tex_coords -= fxy;\n"
219 " vec4 xcubic = cubic(fxy.x);\n"
220 " vec4 ycubic = cubic(fxy.y);\n"
222 " vec4 c = tex_coords.xxyy + vec2 (-0.5, +1.5).xyxy;\n"
224 " vec4 s = vec4(xcubic.xz + xcubic.yw, ycubic.xz + ycubic.yw);\n"
225 " vec4 offset = c + vec4 (xcubic.yw, ycubic.yw) / s;\n"
227 " offset *= inv_tex_size.xxyy;\n"
229 " vec4 sample0 = texture(sampler, offset.xz);\n"
230 " vec4 sample1 = texture(sampler, offset.yz);\n"
231 " vec4 sample2 = texture(sampler, offset.xw);\n"
232 " vec4 sample3 = texture(sampler, offset.yw);\n"
234 " float sx = s.x / (s.x + s.y);\n"
235 " float sy = s.z / (s.z + s.w);\n"
238 " mix(sample3, sample2, sx), mix(sample1, sample0, sx)\n"
244 " if (draw_border == 1) {\n"
245 " FragColor = border_colour;\n"
247 " FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
253 GLVideoView::ensure_context ()
256 wxGLContextAttrs attrs;
257 attrs.PlatformDefaults().CoreProfile().OGLVersion(4, 1).EndList();
258 _context = new wxGLContext (_canvas, nullptr, &attrs);
259 if (!_context->IsOK()) {
260 throw GLError ("Making GL context", -1);
266 GLVideoView::setup_shaders ()
268 DCPOMATIC_ASSERT (_canvas);
269 DCPOMATIC_ASSERT (_context);
270 auto r = _canvas->SetCurrent (*_context);
271 DCPOMATIC_ASSERT (r);
273 #ifdef DCPOMATIC_WINDOWS
276 throw GLError(reinterpret_cast<char const*>(glewGetErrorString(r)));
280 auto get_information = [this](GLenum name) {
281 auto s = glGetString (name);
283 _information[name] = std::string (reinterpret_cast<char const *>(s));
287 get_information (GL_VENDOR);
288 get_information (GL_RENDERER);
289 get_information (GL_VERSION);
290 get_information (GL_SHADING_LANGUAGE_VERSION);
292 unsigned int indices[] = {
293 0, 1, 3, // texture triangle #1
294 1, 2, 3, // 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
301 glGenVertexArrays(1, &_vao);
302 check_gl_error ("glGenVertexArrays");
304 glGenBuffers(1, &vbo);
305 check_gl_error ("glGenBuffers");
307 glGenBuffers(1, &ebo);
308 check_gl_error ("glGenBuffers");
310 glBindVertexArray(_vao);
311 check_gl_error ("glBindVertexArray");
313 glBindBuffer(GL_ARRAY_BUFFER, vbo);
314 check_gl_error ("glBindBuffer");
316 glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ebo);
317 check_gl_error ("glBindBuffer");
318 glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(indices), indices, GL_STATIC_DRAW);
319 check_gl_error ("glBufferData");
321 /* position attribute to vertex shader (location = 0) */
322 glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5 * sizeof(float), nullptr);
323 glEnableVertexAttribArray(0);
324 /* texture coord attribute to vertex shader (location = 1) */
325 glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5 * sizeof(float), reinterpret_cast<void*>(3 * sizeof(float)));
326 glEnableVertexAttribArray(1);
327 check_gl_error ("glEnableVertexAttribArray");
329 auto compile = [](GLenum type, char const* source) -> GLuint {
330 auto shader = glCreateShader(type);
331 DCPOMATIC_ASSERT (shader);
332 GLchar const * src[] = { static_cast<GLchar const *>(source) };
333 glShaderSource(shader, 1, src, nullptr);
334 check_gl_error ("glShaderSource");
335 glCompileShader(shader);
336 check_gl_error ("glCompileShader");
338 glGetShaderiv(shader, GL_COMPILE_STATUS, &ok);
341 glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &log_length);
343 if (log_length > 0) {
344 char* log_char = new char[log_length];
345 glGetShaderInfoLog(shader, log_length, nullptr, log_char);
346 log = string(log_char);
349 glDeleteShader(shader);
350 throw GLError(String::compose("Could not compile shader (%1)", log).c_str(), -1);
355 auto vertex_shader = compile (GL_VERTEX_SHADER, vertex_source);
356 auto fragment_shader = compile (GL_FRAGMENT_SHADER, fragment_source);
358 auto program = glCreateProgram();
359 check_gl_error ("glCreateProgram");
360 glAttachShader (program, vertex_shader);
361 check_gl_error ("glAttachShader");
362 glAttachShader (program, fragment_shader);
363 check_gl_error ("glAttachShader");
364 glLinkProgram (program);
365 check_gl_error ("glLinkProgram");
367 glGetProgramiv (program, GL_LINK_STATUS, &ok);
370 glGetProgramiv(program, GL_INFO_LOG_LENGTH, &log_length);
372 if (log_length > 0) {
373 char* log_char = new char[log_length];
374 glGetProgramInfoLog(program, log_length, nullptr, log_char);
375 log = string(log_char);
378 glDeleteProgram (program);
379 throw GLError(String::compose("Could not link shader (%1)", log).c_str(), -1);
381 glDeleteShader (vertex_shader);
382 glDeleteShader (fragment_shader);
384 glUseProgram (program);
386 _draw_border = glGetUniformLocation (program, "draw_border");
387 check_gl_error ("glGetUniformLocation");
388 set_border_colour (program);
395 GLVideoView::set_border_colour (GLuint program)
397 auto uniform = glGetUniformLocation (program, "border_colour");
398 check_gl_error ("glGetUniformLocation");
399 auto colour = outline_content_colour ();
400 glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
401 check_gl_error ("glUniform4f");
406 GLVideoView::draw (Position<int>, dcp::Size)
408 auto pad = pad_colour();
409 glClearColor(pad.Red() / 255.0, pad.Green() / 255.0, pad.Blue() / 255.0, 1.0);
410 glClear (GL_COLOR_BUFFER_BIT);
411 check_gl_error ("glClear");
413 auto const size = _canvas_size.load();
414 int const width = size.GetWidth();
415 int const height = size.GetHeight();
417 if (width < 64 || height < 0) {
421 glViewport (0, 0, width, height);
422 check_gl_error ("glViewport");
424 glBindTexture(GL_TEXTURE_2D, _texture);
425 glBindVertexArray(_vao);
426 check_gl_error ("glBindVertexArray");
427 glUniform1i(_draw_border, 0);
428 glDrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_INT, 0);
429 if (_viewer->outline_content()) {
430 glUniform1i(_draw_border, 1);
431 glDrawElements (GL_LINES, 8, GL_UNSIGNED_INT, reinterpret_cast<void*>(6 * sizeof(int)));
432 check_gl_error ("glDrawElements");
436 check_gl_error ("glFlush");
438 _canvas->SwapBuffers();
443 GLVideoView::set_image (shared_ptr<const Image> image)
446 _size = optional<dcp::Size>();
451 DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_RGB24);
452 DCPOMATIC_ASSERT (!image->aligned());
454 if (image->size() != _size) {
455 _have_storage = false;
458 _size = image->size ();
459 glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
460 check_gl_error ("glPixelStorei");
463 glTexSubImage2D (GL_TEXTURE_2D, 0, 0, 0, _size->width, _size->height, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
464 check_gl_error ("glTexSubImage2D");
466 glTexImage2D (GL_TEXTURE_2D, 0, GL_RGBA8, _size->width, _size->height, 0, GL_RGB, GL_UNSIGNED_BYTE, image->data()[0]);
467 check_gl_error ("glTexImage2D");
469 auto const canvas_size = _canvas_size.load();
470 int const canvas_width = canvas_size.GetWidth();
471 int const canvas_height = canvas_size.GetHeight();
473 float const image_x = float(_size->width) / canvas_width;
474 float const image_y = float(_size->height) / canvas_height;
476 auto x_pixels_to_gl = [canvas_width](int x) {
477 return (x * 2.0f / canvas_width) - 1.0f;
480 auto y_pixels_to_gl = [canvas_height](int y) {
481 return (y * 2.0f / canvas_height) - 1.0f;
484 auto inter_position = player_video().first->inter_position();
485 auto inter_size = player_video().first->inter_size();
487 float const border_x1 = x_pixels_to_gl (inter_position.x) + 1.0f - image_x;
488 float const border_y1 = y_pixels_to_gl (inter_position.y) + 1.0f - image_y;
489 float const border_x2 = x_pixels_to_gl (inter_position.x + inter_size.width) + 1.0f - image_x;
490 float const border_y2 = y_pixels_to_gl (inter_position.y + inter_size.height) + 1.0f - image_y;
493 // positions // texture coords
494 image_x, image_y, 0.0f, 1.0f, 0.0f, // top right (index 0)
495 image_x, -image_y, 0.0f, 1.0f, 1.0f, // bottom right (index 1)
496 -image_x, -image_y, 0.0f, 0.0f, 1.0f, // bottom left (index 2)
497 -image_x, image_y, 0.0f, 0.0f, 0.0f, // top left (index 3)
498 border_x1, border_y1, 0.0f, 0.0f, 0.0f, // border bottom left (index 4)
499 border_x1, border_y2, 0.0f, 0.0f, 0.0f, // border top left (index 5)
500 border_x2, border_y2, 0.0f, 0.0f, 0.0f, // border top right (index 6)
501 border_x2, border_y1, 0.0f, 0.0f, 0.0f, // border bottom right (index 7)
504 /* Set the vertex shader's input data (GL_ARRAY_BUFFER) */
505 glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
506 check_gl_error ("glBufferData");
508 _have_storage = true;
511 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
512 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
513 check_gl_error ("glTexParameteri");
515 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
516 glTexParameterf (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
517 check_gl_error ("glTexParameterf");
521 GLVideoView::start ()
525 boost::mutex::scoped_lock lm (_playing_mutex);
527 _thread_work_condition.notify_all ();
533 boost::mutex::scoped_lock lm (_playing_mutex);
539 GLVideoView::thread_playing ()
541 if (length() != dcpomatic::DCPTime()) {
542 auto const next = position() + one_video_frame();
544 if (next >= length()) {
545 _viewer->finished ();
549 get_next_frame (false);
550 set_image_and_draw ();
554 optional<int> n = time_until_next_frame();
558 get_next_frame (true);
565 GLVideoView::set_image_and_draw ()
567 auto pv = player_video().first;
569 set_image (pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true));
570 draw (pv->inter_position(), pv->inter_size());
571 _viewer->image_changed (pv);
577 GLVideoView::thread ()
580 start_of_thread ("GLVideoView");
582 #if defined(DCPOMATIC_OSX)
583 /* Without this we see errors like
584 * ../src/osx/cocoa/glcanvas.mm(194): assert ""context"" failed in SwapBuffers(): should have current context [in thread 700006970000]
586 WXGLSetCurrentContext (_context->GetWXGLContext());
588 if (!_setup_shaders_done) {
590 _setup_shaders_done = true;
594 #if defined(DCPOMATIC_LINUX) && defined(DCPOMATIC_HAVE_GLX_SWAP_INTERVAL_EXT)
595 if (_canvas->IsExtensionSupported("GLX_EXT_swap_control")) {
597 Display* dpy = wxGetX11Display();
598 glXSwapIntervalEXT (dpy, DefaultScreen(dpy), 1);
599 _vsync_enabled = true;
603 #ifdef DCPOMATIC_WINDOWS
604 if (_canvas->IsExtensionSupported("WGL_EXT_swap_control")) {
606 PFNWGLSWAPINTERVALEXTPROC swap = (PFNWGLSWAPINTERVALEXTPROC) wglGetProcAddress("wglSwapIntervalEXT");
609 _vsync_enabled = true;
617 GLint swapInterval = 1;
618 CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &swapInterval);
619 _vsync_enabled = true;
622 glGenTextures (1, &_texture);
623 check_gl_error ("glGenTextures");
624 glBindTexture (GL_TEXTURE_2D, _texture);
625 check_gl_error ("glBindTexture");
628 boost::mutex::scoped_lock lm (_playing_mutex);
629 while (!_playing && !_one_shot) {
630 _thread_work_condition.wait (lm);
636 } else if (_one_shot) {
638 set_image_and_draw ();
641 boost::this_thread::interruption_point ();
642 dcpomatic_sleep_milliseconds (time_until_next_frame().get_value_or(0));
645 /* XXX: leaks _context, but that seems preferable to deleting it here
646 * without also deleting the wxGLCanvas.
655 VideoView::NextFrameResult
656 GLVideoView::display_next_frame (bool non_blocking)
658 NextFrameResult const r = get_next_frame (non_blocking);
665 GLVideoView::request_one_shot ()
667 boost::mutex::scoped_lock lm (_playing_mutex);
669 _thread_work_condition.notify_all ();