src/wx/simple_video_view.cc

   1 /*
   2     Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "simple_video_view.h"
  22 #include "film_viewer.h"
  23 #include "wx_util.h"
  24 #include "closed_captions_dialog.h"
  25 #include "lib/image.h"
  26 #include "lib/dcpomatic_log.h"
  27 #include "lib/butler.h"
  28 #include <dcp/util.h>
  29 #include <wx/wx.h>
  30 #include <boost/bind/bind.hpp>
  31
  32 using std::max;
  33 using std::string;
  34 using boost::optional;
  35 using std::shared_ptr;
  36 #if BOOST_VERSION >= 106100
  37 using namespace boost::placeholders;
  38 #endif
  39 using namespace dcpomatic;
  40
  41
  42 SimpleVideoView::SimpleVideoView (FilmViewer* viewer, wxWindow* parent)
  43         : VideoView (viewer)
  44 {
  45         _panel = new wxPanel (parent);
  46
  47 #ifndef __WXOSX__
  48         _panel->SetDoubleBuffered (true);
  49 #endif
  50
  51         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  52         _panel->SetBackgroundColour (*wxBLACK);
  53
  54         _panel->Bind (wxEVT_PAINT, boost::bind (&SimpleVideoView::paint, this));
  55         _panel->Bind (wxEVT_SIZE, boost::bind(boost::ref(Sized)));
  56
  57         _timer.Bind (wxEVT_TIMER, boost::bind(&SimpleVideoView::timer, this));
  58 }
  59
  60 void
  61 SimpleVideoView::paint ()
  62 {
  63         _state_timer.set("paint-panel");
  64         wxPaintDC dc (_panel);
  65
  66         dcp::Size const out_size = _viewer->out_size ();
  67         wxSize const panel_size = _panel->GetSize ();
  68
  69         if (!out_size.width || !out_size.height || !_image || out_size != _image->size()) {
  70                 dc.Clear ();
  71         } else {
  72
  73                 wxImage frame (out_size.width, out_size.height, _image->data()[0], true);
  74                 wxBitmap frame_bitmap (frame);
  75                 dc.DrawBitmap (frame_bitmap, 0, max(0, (panel_size.GetHeight() - out_size.height) / 2));
  76         }
  77
  78         if (out_size.width < panel_size.GetWidth()) {
  79                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
  80                 wxPen   p (_viewer->pad_black() ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
  81                 wxBrush b (_viewer->pad_black() ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
  82                 dc.SetPen (p);
  83                 dc.SetBrush (b);
  84                 dc.DrawRectangle (out_size.width, 0, panel_size.GetWidth() - out_size.width, panel_size.GetHeight());
  85         }
  86
  87         if (out_size.height < panel_size.GetHeight()) {
  88                 wxPen   p (_viewer->pad_black() ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
  89                 wxBrush b (_viewer->pad_black() ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
  90                 dc.SetPen (p);
  91                 dc.SetBrush (b);
  92                 int const gap = (panel_size.GetHeight() - out_size.height) / 2;
  93                 dc.DrawRectangle (0, 0, panel_size.GetWidth(), gap);
  94                 dc.DrawRectangle (0, gap + out_size.height + 1, panel_size.GetWidth(), gap + 1);
  95         }
  96
  97         if (_viewer->outline_content()) {
  98                 wxPen p (wxColour (255, 0, 0), 2);
  99                 dc.SetPen (p);
 100                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 101                 dc.DrawRectangle (_inter_position.x, _inter_position.y + (panel_size.GetHeight() - out_size.height) / 2, _inter_size.width, _inter_size.height);
 102         }
 103
 104         optional<dcpomatic::Rect<double> > subs = _viewer->outline_subtitles();
 105         if (subs) {
 106                 wxPen p (wxColour(0, 255, 0), 2);
 107                 dc.SetPen (p);
 108                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 109                 dc.DrawRectangle (subs->x * out_size.width, subs->y * out_size.height, subs->width * out_size.width, subs->height * out_size.height);
 110         }
 111
 112         _state_timer.unset();
 113 }
 114
 115 void
 116 SimpleVideoView::refresh_panel ()
 117 {
 118         _state_timer.set ("refresh-panel");
 119         _panel->Refresh ();
 120         _panel->Update ();
 121         _state_timer.unset ();
 122 }
 123
 124 void
 125 SimpleVideoView::timer ()
 126 {
 127         if (!_viewer->playing()) {
 128                 return;
 129         }
 130
 131         display_next_frame (false);
 132         DCPTime const next = position() + _viewer->one_video_frame();
 133
 134         if (next >= length()) {
 135                 _viewer->finished ();
 136                 return;
 137         }
 138
 139         LOG_DEBUG_VIDEO_VIEW("%1 -> %2; delay %3", next.seconds(), _viewer->time().seconds(), max((next.seconds() - _viewer->time().seconds()) * 1000, 1.0));
 140         _timer.Start (max(1, time_until_next_frame().get_value_or(0)), wxTIMER_ONE_SHOT);
 141
 142         if (_viewer->butler()) {
 143                 _viewer->butler()->rethrow ();
 144         }
 145 }
 146
 147 void
 148 SimpleVideoView::start ()
 149 {
 150         VideoView::start ();
 151         timer ();
 152 }
 153
 154 /** Try to get a frame from the butler and display it.
 155  *  @param non_blocking true to return false quickly if no video is available quickly (i.e. we are waiting for the butler).
 156  *  false to ask the butler to block until it has video (unless it is suspended).
 157  *  @return true on success, false if we did nothing because it would have taken too long.
 158  */
 159 VideoView::NextFrameResult
 160 SimpleVideoView::display_next_frame (bool non_blocking)
 161 {
 162         NextFrameResult const r = get_next_frame (non_blocking);
 163         if (r != SUCCESS) {
 164                 return r;
 165         }
 166
 167         update ();
 168
 169         try {
 170                 _viewer->butler()->rethrow ();
 171         } catch (DecodeError& e) {
 172                 error_dialog (get(), e.what());
 173         }
 174
 175         return SUCCESS;
 176 }
 177
 178 void
 179 SimpleVideoView::update ()
 180 {
 181         if (!player_video().first) {
 182                 set_image (shared_ptr<Image>());
 183                 refresh_panel ();
 184                 return;
 185         }
 186
 187         if (_viewer->playing() && (_viewer->time() - player_video().second) > one_video_frame()) {
 188                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 189                    part if this frame is J2K).
 190                 */
 191                 add_dropped ();
 192                 return;
 193         }
 194
 195         /* In an ideal world, what we would do here is:
 196          *
 197          * 1. convert to XYZ exactly as we do in the DCP creation path.
 198          * 2. convert back to RGB for the preview display, compensating
 199          *    for the monitor etc. etc.
 200          *
 201          * but this is inefficient if the source is RGB.  Since we don't
 202          * (currently) care too much about the precise accuracy of the preview's
 203          * colour mapping (and we care more about its speed) we try to short-
 204          * circuit this "ideal" situation in some cases.
 205          *
 206          * The content's specified colour conversion indicates the colourspace
 207          * which the content is in (according to the user).
 208          *
 209          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 210          * image and convert it (from whatever the user has said it is) to RGB.
 211          */
 212
 213         _state_timer.set ("get image");
 214
 215         set_image (
 216                 player_video().first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VIDEO_RANGE_FULL, false, true)
 217                 );
 218
 219         _state_timer.set ("ImageChanged");
 220         _viewer->image_changed (player_video().first);
 221         _state_timer.unset ();
 222
 223         _inter_position = player_video().first->inter_position ();
 224         _inter_size = player_video().first->inter_size ();
 225
 226         refresh_panel ();
 227 }