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                 wxImage frame (out_size.width, out_size.height, _image->data()[0], true);
  73                 wxBitmap frame_bitmap (frame);
  74                 dc.DrawBitmap (frame_bitmap, 0, max(0, (panel_size.GetHeight() - out_size.height) / 2));
  75         }
  76
  77         auto pad_colour = wxColour(240, 240, 240);
  78         if (_viewer->pad_black()) {
  79                 pad_colour = wxColour(0, 0, 0);
  80         } else if (gui_is_dark()) {
  81                 pad_colour = wxColour(50, 50, 50);
  82         }
  83
  84         if (out_size.width < panel_size.GetWidth()) {
  85                 wxPen   p (pad_colour);
  86                 wxBrush b (pad_colour);
  87                 dc.SetPen (p);
  88                 dc.SetBrush (b);
  89                 dc.DrawRectangle (out_size.width, 0, panel_size.GetWidth() - out_size.width, panel_size.GetHeight());
  90         }
  91
  92         if (out_size.height < panel_size.GetHeight()) {
  93                 wxPen   p (pad_colour);
  94                 wxBrush b (pad_colour);
  95                 dc.SetPen (p);
  96                 dc.SetBrush (b);
  97                 int const gap = (panel_size.GetHeight() - out_size.height) / 2;
  98                 dc.DrawRectangle (0, 0, panel_size.GetWidth(), gap);
  99                 dc.DrawRectangle (0, gap + out_size.height + 1, panel_size.GetWidth(), gap + 1);
 100         }
 101
 102         if (_viewer->outline_content()) {
 103                 wxPen p (wxColour (255, 0, 0), 2);
 104                 dc.SetPen (p);
 105                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 106                 dc.DrawRectangle (_inter_position.x, _inter_position.y + (panel_size.GetHeight() - out_size.height) / 2, _inter_size.width, _inter_size.height);
 107         }
 108
 109         auto subs = _viewer->outline_subtitles();
 110         if (subs) {
 111                 wxPen p (wxColour(0, 255, 0), 2);
 112                 dc.SetPen (p);
 113                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 114                 dc.DrawRectangle (subs->x * out_size.width, subs->y * out_size.height, subs->width * out_size.width, subs->height * out_size.height);
 115         }
 116
 117         _state_timer.unset();
 118 }
 119
 120 void
 121 SimpleVideoView::refresh_panel ()
 122 {
 123         _state_timer.set ("refresh-panel");
 124         _panel->Refresh ();
 125         _panel->Update ();
 126         _state_timer.unset ();
 127 }
 128
 129 void
 130 SimpleVideoView::timer ()
 131 {
 132         if (!_viewer->playing()) {
 133                 return;
 134         }
 135
 136         display_next_frame (false);
 137         auto const next = position() + _viewer->one_video_frame();
 138
 139         if (next >= length()) {
 140                 _viewer->finished ();
 141                 return;
 142         }
 143
 144         LOG_DEBUG_VIDEO_VIEW("%1 -> %2; delay %3", next.seconds(), _viewer->time().seconds(), max((next.seconds() - _viewer->time().seconds()) * 1000, 1.0));
 145         _timer.Start (max(1, time_until_next_frame().get_value_or(0)), wxTIMER_ONE_SHOT);
 146
 147         if (_viewer->butler()) {
 148                 _viewer->butler()->rethrow ();
 149         }
 150 }
 151
 152 void
 153 SimpleVideoView::start ()
 154 {
 155         VideoView::start ();
 156         timer ();
 157 }
 158
 159 /** Try to get a frame from the butler and display it.
 160  *  @param non_blocking true to return false quickly if no video is available quickly (i.e. we are waiting for the butler).
 161  *  false to ask the butler to block until it has video (unless it is suspended).
 162  *  @return true on success, false if we did nothing because it would have taken too long.
 163  */
 164 VideoView::NextFrameResult
 165 SimpleVideoView::display_next_frame (bool non_blocking)
 166 {
 167         auto const r = get_next_frame (non_blocking);
 168         if (r != SUCCESS) {
 169                 return r;
 170         }
 171
 172         update ();
 173
 174         try {
 175                 _viewer->butler()->rethrow ();
 176         } catch (DecodeError& e) {
 177                 error_dialog (get(), e.what());
 178         }
 179
 180         return SUCCESS;
 181 }
 182
 183 void
 184 SimpleVideoView::update ()
 185 {
 186         if (!player_video().first) {
 187                 set_image (shared_ptr<Image>());
 188                 refresh_panel ();
 189                 return;
 190         }
 191
 192         if (_viewer->playing() && (_viewer->time() - player_video().second) > one_video_frame()) {
 193                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 194                    part if this frame is J2K).
 195                 */
 196                 add_dropped ();
 197                 return;
 198         }
 199
 200         /* In an ideal world, what we would do here is:
 201          *
 202          * 1. convert to XYZ exactly as we do in the DCP creation path.
 203          * 2. convert back to RGB for the preview display, compensating
 204          *    for the monitor etc. etc.
 205          *
 206          * but this is inefficient if the source is RGB.  Since we don't
 207          * (currently) care too much about the precise accuracy of the preview's
 208          * colour mapping (and we care more about its speed) we try to short-
 209          * circuit this "ideal" situation in some cases.
 210          *
 211          * The content's specified colour conversion indicates the colourspace
 212          * which the content is in (according to the user).
 213          *
 214          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 215          * image and convert it (from whatever the user has said it is) to RGB.
 216          */
 217
 218         _state_timer.set ("get image");
 219
 220         set_image (
 221                 player_video().first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), VideoRange::FULL, false, true)
 222                 );
 223
 224         _state_timer.set ("ImageChanged");
 225         _viewer->image_changed (player_video().first);
 226         _state_timer.unset ();
 227
 228         _inter_position = player_video().first->inter_position ();
 229         _inter_size = player_video().first->inter_size ();
 230
 231         refresh_panel ();
 232 }