Cleanup: use an enum rather than a magic value.
[dcpomatic.git] / src / wx / gl_video_view.cc
index 6288a24a3e1e7b350cbd94b593781b5d575ca786..e912ae924df23f7555c43190bdb8545dbd78d6d2 100644 (file)
 #endif
 
 #include "gl_video_view.h"
+
+/* This will only build on an new-enough wxWidgets: see the comment in gl_video_view.h */
+#if wxCHECK_VERSION(3,1,0)
+
 #include "film_viewer.h"
 #include "wx_util.h"
-#include "lib/image.h"
+#include "lib/butler.h"
+#include "lib/cross.h"
 #include "lib/dcpomatic_assert.h"
+#include "lib/dcpomatic_log.h"
 #include "lib/exceptions.h"
-#include "lib/cross.h"
+#include "lib/image.h"
 #include "lib/player_video.h"
-#include "lib/butler.h"
 #include <boost/bind/bind.hpp>
 #include <iostream>
 
@@ -99,12 +104,15 @@ GLVideoView::GLVideoView (FilmViewer* viewer, wxWindow *parent)
 void
 GLVideoView::size_changed (wxSizeEvent const& ev)
 {
-       _canvas_size = ev.GetSize ();
+       auto const scale = _canvas->GetDPIScaleFactor();
+       int const width = std::round(ev.GetSize().GetWidth() * scale);
+       int const height = std::round(ev.GetSize().GetHeight() * scale);
+       _canvas_size = { width, height };
+       LOG_GENERAL("GLVideoView canvas size changed to %1x%2", width, height);
        Sized ();
 }
 
 
-
 GLVideoView::~GLVideoView ()
 {
        boost::this_thread::disable_interruption dis;
@@ -186,12 +194,15 @@ static constexpr char fragment_source[] =
 "in vec2 TexCoord;\n"
 "\n"
 "uniform sampler2D texture_sampler;\n"
-/* type = 0: draw border
- * type = 1: draw XYZ image
- * type = 2: draw RGB image
+/* type = 0: draw outline content rectangle
+ * type = 1: draw crop guess rectangle
+ * type = 2: draw XYZ image
+ * type = 3: draw RGB image
+ * See FragmentType enum below.
  */
 "uniform int type = 0;\n"
-"uniform vec4 border_colour;\n"
+"uniform vec4 outline_content_colour;\n"
+"uniform vec4 crop_guess_colour;\n"
 "uniform mat4 colour_conversion;\n"
 "\n"
 "out vec4 FragColor;\n"
@@ -250,9 +261,12 @@ static constexpr char fragment_source[] =
 "{\n"
 "      switch (type) {\n"
 "              case 0:\n"
-"                      FragColor = border_colour;\n"
+"                      FragColor = outline_content_colour;\n"
 "                      break;\n"
 "              case 1:\n"
+"                       FragColor = crop_guess_colour;\n"
+"                       break;\n"
+"              case 2:\n"
 "                      FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
 "                      FragColor.x = pow(FragColor.x, IN_GAMMA) / DCI_COEFFICIENT;\n"
 "                      FragColor.y = pow(FragColor.y, IN_GAMMA) / DCI_COEFFICIENT;\n"
@@ -262,13 +276,22 @@ static constexpr char fragment_source[] =
 "                      FragColor.y = pow(FragColor.y, OUT_GAMMA);\n"
 "                      FragColor.z = pow(FragColor.z, OUT_GAMMA);\n"
 "                      break;\n"
-"              case 2:\n"
+"              case 3:\n"
 "                      FragColor = texture_bicubic(texture_sampler, TexCoord);\n"
 "                      break;\n"
 "      }\n"
 "}\n";
 
 
+enum class FragmentType
+{
+       OUTLINE_CONTENT = 0,
+       CROP_GUESS = 1,
+       XYZ_IMAGE = 2,
+       RGB_IMAGE = 3,
+};
+
+
 void
 GLVideoView::ensure_context ()
 {
@@ -283,24 +306,37 @@ GLVideoView::ensure_context ()
 }
 
 
-/* Offset of video texture triangles in indices */
-static constexpr int indices_video_texture = 0;
-/* Offset of subtitle texture triangles in indices */
-static constexpr int indices_subtitle_texture = 6;
-/* Offset of border lines in indices */
-static constexpr int indices_border = 12;
+/* Offset and number of indices for the things in the indices array below */
+static constexpr int indices_video_texture_offset = 0;
+static constexpr int indices_video_texture_number = 6;
+static constexpr int indices_subtitle_texture_offset = indices_video_texture_offset + indices_video_texture_number;
+static constexpr int indices_subtitle_texture_number = 6;
+static constexpr int indices_outline_content_offset = indices_subtitle_texture_offset + indices_subtitle_texture_number;
+static constexpr int indices_outline_content_number = 8;
+static constexpr int indices_crop_guess_offset = indices_outline_content_offset + indices_outline_content_number;
+static constexpr int indices_crop_guess_number = 8;
 
 static constexpr unsigned int indices[] = {
        0, 1, 3, // video texture triangle #1
        1, 2, 3, // video texture triangle #2
        4, 5, 7, // subtitle texture triangle #1
        5, 6, 7, // subtitle texture triangle #2
-       8, 9,    // border line #1
-       9, 10,   // border line #2
-       10, 11,  // border line #3
-       11, 8,   // border line #4
+       8, 9,    // outline content line #1
+       9, 10,   // outline content line #2
+       10, 11,  // outline content line #3
+       11, 8,   // outline content line #4
+       12, 13,  // crop guess line #1
+       13, 14,  // crop guess line #2
+       14, 15,  // crop guess line #3
+       15, 12,  // crop guess line #4
 };
 
+/* Offsets of things in the GL_ARRAY_BUFFER */
+static constexpr int array_buffer_video_offset = 0;
+static constexpr int array_buffer_subtitle_offset = array_buffer_video_offset + 4 * 5 * sizeof(float);
+static constexpr int array_buffer_outline_content_offset = array_buffer_subtitle_offset + 4 * 5 * sizeof(float);
+static constexpr int array_buffer_crop_guess_offset = array_buffer_outline_content_offset + 4 * 5 * sizeof(float);
+
 
 void
 GLVideoView::setup_shaders ()
@@ -372,10 +408,9 @@ GLVideoView::setup_shaders ()
                        glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &log_length);
                        string log;
                        if (log_length > 0) {
-                               char* log_char = new char[log_length];
-                               glGetShaderInfoLog(shader, log_length, nullptr, log_char);
-                               log = string(log_char);
-                               delete[] log_char;
+                               std::vector<char> log_char(log_length);
+                               glGetShaderInfoLog(shader, log_length, nullptr, log_char.data());
+                               log = string(log_char.data());
                        }
                        glDeleteShader(shader);
                        throw GLError(String::compose("Could not compile shader (%1)", log).c_str(), -1);
@@ -401,10 +436,9 @@ GLVideoView::setup_shaders ()
                glGetProgramiv(program, GL_INFO_LOG_LENGTH, &log_length);
                string log;
                if (log_length > 0) {
-                       char* log_char = new char[log_length];
-                       glGetProgramInfoLog(program, log_length, nullptr, log_char);
-                       log = string(log_char);
-                       delete[] log_char;
+                       std::vector<char> log_char(log_length);
+                       glGetProgramInfoLog(program, log_length, nullptr, log_char.data());
+                       log = string(log_char.data());
                }
                glDeleteProgram (program);
                throw GLError(String::compose("Could not link shader (%1)", log).c_str(), -1);
@@ -416,7 +450,8 @@ GLVideoView::setup_shaders ()
 
        _fragment_type = glGetUniformLocation (program, "type");
        check_gl_error ("glGetUniformLocation");
-       set_border_colour (program);
+       set_outline_content_colour (program);
+       set_crop_guess_colour (program);
 
        auto conversion = dcp::ColourConversion::rec709_to_xyz();
        boost::numeric::ublas::matrix<double> matrix = conversion.xyz_to_rgb ();
@@ -432,19 +467,22 @@ GLVideoView::setup_shaders ()
        glUniformMatrix4fv (colour_conversion, 1, GL_TRUE, gl_matrix);
 
        glLineWidth (2.0f);
+       check_gl_error ("glLineWidth");
        glEnable (GL_BLEND);
+       check_gl_error ("glEnable");
        glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
+       check_gl_error ("glBlendFunc");
 
        /* Reserve space for the GL_ARRAY_BUFFER */
-       glBufferData(GL_ARRAY_BUFFER, 12 * 5 * sizeof(float), nullptr, GL_STATIC_DRAW);
+       glBufferData(GL_ARRAY_BUFFER, 16 * 5 * sizeof(float), nullptr, GL_STATIC_DRAW);
        check_gl_error ("glBufferData");
 }
 
 
 void
-GLVideoView::set_border_colour (GLuint program)
+GLVideoView::set_outline_content_colour (GLuint program)
 {
-       auto uniform = glGetUniformLocation (program, "border_colour");
+       auto uniform = glGetUniformLocation (program, "outline_content_colour");
        check_gl_error ("glGetUniformLocation");
        auto colour = outline_content_colour ();
        glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
@@ -453,7 +491,18 @@ GLVideoView::set_border_colour (GLuint program)
 
 
 void
-GLVideoView::draw (Position<int>, dcp::Size)
+GLVideoView::set_crop_guess_colour (GLuint program)
+{
+       auto uniform = glGetUniformLocation (program, "crop_guess_colour");
+       check_gl_error ("glGetUniformLocation");
+       auto colour = crop_guess_colour ();
+       glUniform4f (uniform, colour.Red() / 255.0f, colour.Green() / 255.0f, colour.Blue() / 255.0f, 1.0f);
+       check_gl_error ("glUniform4f");
+}
+
+
+void
+GLVideoView::draw ()
 {
        auto pad = pad_colour();
        glClearColor(pad.Red() / 255.0, pad.Green() / 255.0, pad.Blue() / 255.0, 1.0);
@@ -473,17 +522,22 @@ GLVideoView::draw (Position<int>, dcp::Size)
 
        glBindVertexArray(_vao);
        check_gl_error ("glBindVertexArray");
-       glUniform1i(_fragment_type, _optimise_for_j2k ? 1 : 2);
+       glUniform1i(_fragment_type, static_cast<GLint>(_optimise_for_j2k ? FragmentType::XYZ_IMAGE : FragmentType::RGB_IMAGE));
        _video_texture->bind();
-       glDrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_video_texture * sizeof(int)));
+       glDrawElements (GL_TRIANGLES, indices_video_texture_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_video_texture_offset * sizeof(int)));
        if (_have_subtitle_to_render) {
-               glUniform1i(_fragment_type, 2);
+               glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::RGB_IMAGE));
                _subtitle_texture->bind();
-               glDrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_subtitle_texture * sizeof(int)));
+               glDrawElements (GL_TRIANGLES, indices_subtitle_texture_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_subtitle_texture_offset * sizeof(int)));
        }
        if (_viewer->outline_content()) {
-               glUniform1i(_fragment_type, 0);
-               glDrawElements (GL_LINES, 8, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_border * sizeof(int)));
+               glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::OUTLINE_CONTENT));
+               glDrawElements (GL_LINES, indices_outline_content_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_outline_content_offset * sizeof(int)));
+               check_gl_error ("glDrawElements");
+       }
+       if (auto guess = _viewer->crop_guess()) {
+               glUniform1i(_fragment_type, static_cast<GLint>(FragmentType::CROP_GUESS));
+               glDrawElements (GL_LINES, indices_crop_guess_number, GL_UNSIGNED_INT, reinterpret_cast<void*>(indices_crop_guess_offset * sizeof(int)));
                check_gl_error ("glDrawElements");
        }
 
@@ -497,16 +551,16 @@ GLVideoView::draw (Position<int>, dcp::Size)
 void
 GLVideoView::set_image (shared_ptr<const PlayerVideo> pv)
 {
-       shared_ptr<const Image> video = _optimise_for_j2k ? pv->raw_image() : pv->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true);
+       shared_ptr<const Image> video = _optimise_for_j2k ? pv->raw_image() : pv->image(boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, true);
 
        /* Only the player's black frames should be aligned at this stage, so this should
         * almost always have no work to do.
         */
-       video = Image::ensure_aligned (video, false);
+       video = Image::ensure_alignment (video, Image::Alignment::COMPACT);
 
        /** If _optimise_for_j2k is true we render a XYZ image, doing the colourspace
         *  conversion, scaling and video range conversion in the GL shader.
-        *  Othewise we render a RGB image without any shader-side processing.
+        *  Otherwise we render a RGB image without any shader-side processing.
         */
 
        /* XXX: video range conversion */
@@ -517,7 +571,7 @@ GLVideoView::set_image (shared_ptr<const PlayerVideo> pv)
        _have_subtitle_to_render = static_cast<bool>(text) && _optimise_for_j2k;
        if (_have_subtitle_to_render) {
                /* opt: only do this if it's a new subtitle? */
-               DCPOMATIC_ASSERT (!text->image->aligned());
+               DCPOMATIC_ASSERT (text->image->alignment() == Image::Alignment::COMPACT);
                _subtitle_texture->set (text->image);
        }
 
@@ -525,72 +579,118 @@ GLVideoView::set_image (shared_ptr<const PlayerVideo> pv)
        auto const canvas_size = _canvas_size.load();
        int const canvas_width = canvas_size.GetWidth();
        int const canvas_height = canvas_size.GetHeight();
-       auto inter_position = player_video().first->inter_position();
-       auto inter_size = player_video().first->inter_size();
-       auto out_size = player_video().first->out_size();
+       auto const inter_position = player_video().first->inter_position();
+       auto const inter_size = player_video().first->inter_size();
+       auto const out_size = player_video().first->out_size();
+       auto const crop_guess = _viewer->crop_guess();
+
+       auto x_offset = std::max(0, (canvas_width - out_size.width) / 2);
+       auto y_offset = std::max(0, (canvas_height - out_size.height) / 2);
 
        _last_canvas_size.set_next (canvas_size);
        _last_video_size.set_next (video->size());
        _last_inter_position.set_next (inter_position);
        _last_inter_size.set_next (inter_size);
        _last_out_size.set_next (out_size);
+       _last_crop_guess.set_next (crop_guess);
+
+       class Rectangle
+       {
+       public:
+               Rectangle (wxSize canvas_size, float x, float y, dcp::Size size)
+                       : _canvas_size (canvas_size)
+               {
+                       auto const x1 = x_pixels_to_gl(x);
+                       auto const y1 = y_pixels_to_gl(y);
+                       auto const x2 = x_pixels_to_gl(x + size.width);
+                       auto const y2 = y_pixels_to_gl(y + size.height);
+
+                       /* The texture coordinates here have to account for the fact that when we put images into the texture OpenGL
+                        * expected us to start at the lower left but we actually started at the top left.  So although the
+                        * top of the texture is at 1.0 we pretend it's the other way round.
+                        */
+
+                       // bottom right
+                       _vertices[0] = x2;
+                       _vertices[1] = y2;
+                       _vertices[2] = 0.0f;
+                       _vertices[3] = 1.0f;
+                       _vertices[4] = 1.0f;
+
+                       // top right
+                       _vertices[5] = x2;
+                       _vertices[6] = y1;
+                       _vertices[7] = 0.0f;
+                       _vertices[8] = 1.0f;
+                       _vertices[9] = 0.0f;
+
+                       // top left
+                       _vertices[10] = x1;
+                       _vertices[11] = y1;
+                       _vertices[12] = 0.0f;
+                       _vertices[13] = 0.0f;
+                       _vertices[14] = 0.0f;
+
+                       // bottom left
+                       _vertices[15] = x1;
+                       _vertices[16] = y2;
+                       _vertices[17] = 0.0f;
+                       _vertices[18] = 0.0f;
+                       _vertices[19] = 1.0f;
+               }
 
-       auto x_pixels_to_gl = [canvas_width](int x) {
-               return (x * 2.0f / canvas_width) - 1.0f;
-       };
+               float const * vertices () const {
+                       return _vertices;
+               }
+
+               int const size () const {
+                       return sizeof(_vertices);
+               }
+
+       private:
+               /* @param x x position in pixels where 0 is left and canvas_width is right on screen */
+               float x_pixels_to_gl(int x) const {
+                       return (x * 2.0f / _canvas_size.GetWidth()) - 1.0f;
+               }
+
+               /* @param y y position in pixels where 0 is top and canvas_height is bottom on screen */
+               float y_pixels_to_gl(int y) const {
+                       return 1.0f - (y * 2.0f / _canvas_size.GetHeight());
+               }
 
-       auto y_pixels_to_gl = [canvas_height](int y) {
-               return (y * 2.0f / canvas_height) - 1.0f;
+               wxSize _canvas_size;
+               float _vertices[20];
        };
 
-       if (_last_canvas_size.changed() || _last_inter_position.changed() || _last_inter_size.changed() || _last_out_size.changed()) {
-               float const video_x1 = x_pixels_to_gl(_optimise_for_j2k ? inter_position.x : 0);
-               float const video_x2 = x_pixels_to_gl(_optimise_for_j2k ? (inter_position.x + inter_size.width) : out_size.width);
-               float const video_y1 = y_pixels_to_gl(_optimise_for_j2k ? inter_position.y : 0);
-               float const video_y2 = y_pixels_to_gl(_optimise_for_j2k ? (inter_position.y + inter_size.height) : out_size.height);
-               float video_vertices[] = {
-                        // positions              // texture coords
-                       video_x2, video_y2, 0.0f,  1.0f, 0.0f,   // video texture top right       (index 0)
-                       video_x2, video_y1, 0.0f,  1.0f, 1.0f,   // video texture bottom right    (index 1)
-                       video_x1, video_y1, 0.0f,  0.0f, 1.0f,   // video texture bottom left     (index 2)
-                       video_x1, video_y2, 0.0f,  0.0f, 0.0f,   // video texture top left        (index 3)
-               };
+       auto const sizing_changed = _last_canvas_size.changed() || _last_inter_position.changed() || _last_inter_size.changed() || _last_out_size.changed();
+
+       if (sizing_changed) {
+               const auto video = _optimise_for_j2k ?
+                       Rectangle(canvas_size, inter_position.x + x_offset, inter_position.y + y_offset, inter_size)
+                       : Rectangle(canvas_size, x_offset, y_offset, out_size);
 
-               glBufferSubData (GL_ARRAY_BUFFER, 0, sizeof(video_vertices), video_vertices);
+               glBufferSubData (GL_ARRAY_BUFFER, array_buffer_video_offset, video.size(), video.vertices());
                check_gl_error ("glBufferSubData (video)");
 
-               float const border_x1 = x_pixels_to_gl(inter_position.x);
-               float const border_y1 = y_pixels_to_gl(inter_position.y);
-               float const border_x2 = x_pixels_to_gl(inter_position.x + inter_size.width);
-               float const border_y2 = y_pixels_to_gl(inter_position.y + inter_size.height);
-
-               float border_vertices[] = {
-                        // positions                 // texture coords
-                        border_x1, border_y1, 0.0f,  0.0f, 0.0f,   // border bottom left         (index 4)
-                        border_x1, border_y2, 0.0f,  0.0f, 0.0f,   // border top left            (index 5)
-                        border_x2, border_y2, 0.0f,  0.0f, 0.0f,   // border top right           (index 6)
-                        border_x2, border_y1, 0.0f,  0.0f, 0.0f,   // border bottom right        (index 7)
-               };
+               const auto outline_content = Rectangle(canvas_size, inter_position.x + x_offset, inter_position.y + y_offset, inter_size);
+               glBufferSubData (GL_ARRAY_BUFFER, array_buffer_outline_content_offset, outline_content.size(), outline_content.vertices());
+               check_gl_error ("glBufferSubData (outline_content)");
+       }
 
-               glBufferSubData (GL_ARRAY_BUFFER, 8 * 5 * sizeof(float), sizeof(border_vertices), border_vertices);
-               check_gl_error ("glBufferSubData (border)");
+       if ((sizing_changed || _last_crop_guess.changed()) && crop_guess) {
+               auto const crop_guess_rectangle = Rectangle(
+                       canvas_size,
+                       inter_position.x + x_offset + inter_size.width * crop_guess->x,
+                       inter_position.y + y_offset + inter_size.height * crop_guess->y,
+                       dcp::Size(inter_size.width * crop_guess->width, inter_size.height * crop_guess->height)
+                       );
+               glBufferSubData (GL_ARRAY_BUFFER, array_buffer_crop_guess_offset, crop_guess_rectangle.size(), crop_guess_rectangle.vertices());
+               check_gl_error ("glBufferSubData (crop_guess_rectangle)");
        }
 
        if (_have_subtitle_to_render) {
-               float const subtitle_x1 = x_pixels_to_gl(inter_position.x + text->position.x);
-               float const subtitle_x2 = x_pixels_to_gl(inter_position.x + text->position.x + text->image->size().width);
-               float const subtitle_y1 = y_pixels_to_gl(inter_position.y + text->position.y + text->image->size().height);
-               float const subtitle_y2 = y_pixels_to_gl(inter_position.y + text->position.y);
-
-               float vertices[] = {
-                        // positions                     // texture coords
-                        subtitle_x2, subtitle_y1, 0.0f,  1.0f, 0.0f,   // subtitle texture top right    (index 4)
-                        subtitle_x2, subtitle_y2, 0.0f,  1.0f, 1.0f,   // subtitle texture bottom right (index 5)
-                        subtitle_x1, subtitle_y2, 0.0f,  0.0f, 1.0f,   // subtitle texture bottom left  (index 6)
-                        subtitle_x1, subtitle_y1, 0.0f,  0.0f, 0.0f,   // subtitle texture top left     (index 7)
-               };
-
-               glBufferSubData (GL_ARRAY_BUFFER, 4 * 5 * sizeof(float), sizeof(vertices), vertices);
+               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());
+               glBufferSubData (GL_ARRAY_BUFFER, array_buffer_subtitle_offset, subtitle.size(), subtitle.vertices());
                check_gl_error ("glBufferSubData (subtitle)");
        }
 
@@ -656,7 +756,11 @@ GLVideoView::set_image_and_draw ()
        auto pv = player_video().first;
        if (pv) {
                set_image (pv);
-               draw (pv->inter_position(), pv->inter_size());
+       }
+
+       draw ();
+
+       if (pv) {
                _viewer->image_changed (pv);
        }
 }
@@ -788,7 +892,7 @@ Texture::set (shared_ptr<const Image> image)
        glPixelStorei (GL_UNPACK_ALIGNMENT, _unpack_alignment);
        check_gl_error ("glPixelStorei");
 
-       DCPOMATIC_ASSERT (!image->aligned());
+       DCPOMATIC_ASSERT (image->alignment() == Image::Alignment::COMPACT);
 
        GLint internal_format;
        GLenum format;
@@ -830,3 +934,4 @@ Texture::set (shared_ptr<const Image> image)
        }
 }
 
+#endif