src/wx/timing_panel.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "timing_panel.h"
  21 #include "wx_util.h"
  22 #include "film_viewer.h"
  23 #include "timecode.h"
  24 #include "content_panel.h"
  25 #include "lib/content.h"
  26 #include "lib/image_content.h"
  27 #include "lib/raw_convert.h"
  28 #include "lib/subtitle_content.h"
  29 #include "lib/dcp_subtitle_content.h"
  30 #include "lib/subrip_content.h"
  31 #include <boost/foreach.hpp>
  32 #include <set>
  33 #include <iostream>
  34
  35 using std::cout;
  36 using std::string;
  37 using std::set;
  38 using boost::shared_ptr;
  39 using boost::dynamic_pointer_cast;
  40 using boost::optional;
  41
  42 TimingPanel::TimingPanel (ContentPanel* p, FilmViewer* viewer)
  43         /* horrid hack for apparent lack of context support with wxWidgets i18n code */
  44         : ContentSubPanel (p, S_("Timing|Timing"))
  45         , _viewer (viewer)
  46 {
  47         wxFlexGridSizer* grid = new wxFlexGridSizer (2, 4, 4);
  48         _sizer->Add (grid, 0, wxALL, 8);
  49
  50         wxSize size = TimecodeBase::size (this);
  51
  52         wxSizer* labels = new wxBoxSizer (wxHORIZONTAL);
  53         //// TRANSLATORS: this is an abbreviation for "hours"
  54         wxStaticText* t = new wxStaticText (this, wxID_ANY, _("h"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
  55 #ifdef DCPOMATIC_LINUX
  56         /* Hack to work around failure to centre text on GTK */
  57         gtk_label_set_line_wrap (GTK_LABEL (t->GetHandle()), FALSE);
  58 #endif
  59         labels->Add (t, 1, wxEXPAND);
  60         add_label_to_sizer (labels, this, wxT (":"), false);
  61         //// TRANSLATORS: this is an abbreviation for "minutes"
  62         t = new wxStaticText (this, wxID_ANY, _("m"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
  63 #ifdef DCPOMATIC_LINUX
  64         gtk_label_set_line_wrap (GTK_LABEL (t->GetHandle()), FALSE);
  65 #endif
  66         labels->Add (t, 1, wxEXPAND);
  67         add_label_to_sizer (labels, this, wxT (":"), false);
  68         //// TRANSLATORS: this is an abbreviation for "seconds"
  69         t = new wxStaticText (this, wxID_ANY, _("s"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
  70 #ifdef DCPOMATIC_LINUX
  71         gtk_label_set_line_wrap (GTK_LABEL (t->GetHandle()), FALSE);
  72 #endif
  73         labels->Add (t, 1, wxEXPAND);
  74         add_label_to_sizer (labels, this, wxT (":"), false);
  75         //// TRANSLATORS: this is an abbreviation for "frames"
  76         t = new wxStaticText (this, wxID_ANY, _("f"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
  77 #ifdef DCPOMATIC_LINUX
  78         gtk_label_set_line_wrap (GTK_LABEL (t->GetHandle()), FALSE);
  79 #endif
  80         labels->Add (t, 1, wxEXPAND);
  81         grid->Add (new wxStaticText (this, wxID_ANY, wxT ("")));
  82         grid->Add (labels);
  83
  84         add_label_to_sizer (grid, this, _("Position"), true);
  85         _position = new Timecode<DCPTime> (this);
  86         grid->Add (_position);
  87         add_label_to_sizer (grid, this, _("Full length"), true);
  88         _full_length = new Timecode<DCPTime> (this);
  89         grid->Add (_full_length);
  90         add_label_to_sizer (grid, this, _("Trim from start"), true);
  91         _trim_start = new Timecode<ContentTime> (this);
  92         grid->Add (_trim_start);
  93         _trim_start_to_playhead = new wxButton (this, wxID_ANY, _("Trim up to current position"));
  94         grid->AddSpacer (0);
  95         grid->Add (_trim_start_to_playhead);
  96         add_label_to_sizer (grid, this, _("Trim from end"), true);
  97         _trim_end = new Timecode<ContentTime> (this);
  98         grid->Add (_trim_end);
  99         _trim_end_to_playhead = new wxButton (this, wxID_ANY, _("Trim after current position"));
 100         grid->AddSpacer (0);
 101         grid->Add (_trim_end_to_playhead);
 102         add_label_to_sizer (grid, this, _("Play length"), true);
 103         _play_length = new Timecode<DCPTime> (this);
 104         grid->Add (_play_length);
 105
 106         {
 107                 add_label_to_sizer (grid, this, _("Video frame rate"), true);
 108                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 109                 _video_frame_rate = new wxTextCtrl (this, wxID_ANY);
 110                 s->Add (_video_frame_rate, 1, wxEXPAND);
 111                 _set_video_frame_rate = new wxButton (this, wxID_ANY, _("Set"));
 112                 _set_video_frame_rate->Enable (false);
 113                 s->Add (_set_video_frame_rate, 0, wxLEFT | wxRIGHT, 8);
 114                 grid->Add (s, 1, wxEXPAND);
 115         }
 116
 117         grid->AddSpacer (0);
 118
 119         /* We can't use Wrap() here as it doesn't work with markup:
 120          * http://trac.wxwidgets.org/ticket/13389
 121          */
 122
 123         wxString in = _("<i>Only change this if it the content's frame rate has been read incorrectly.</i>");
 124         wxString out;
 125         int const width = 20;
 126         int current = 0;
 127         for (size_t i = 0; i < in.Length(); ++i) {
 128                 if (in[i] == ' ' && current >= width) {
 129                         out += '\n';
 130                         current = 0;
 131                 } else {
 132                         out += in[i];
 133                         ++current;
 134                 }
 135         }
 136
 137         t = new wxStaticText (this, wxID_ANY, wxT (""));
 138         t->SetLabelMarkup (out);
 139         grid->Add (t, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, 6);
 140
 141         _position->Changed.connect    (boost::bind (&TimingPanel::position_changed, this));
 142         _full_length->Changed.connect (boost::bind (&TimingPanel::full_length_changed, this));
 143         _trim_start->Changed.connect  (boost::bind (&TimingPanel::trim_start_changed, this));
 144         _trim_start_to_playhead->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&TimingPanel::trim_start_to_playhead_clicked, this));
 145         _trim_end->Changed.connect    (boost::bind (&TimingPanel::trim_end_changed, this));
 146         _trim_end_to_playhead->Bind   (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&TimingPanel::trim_end_to_playhead_clicked, this));
 147         _play_length->Changed.connect (boost::bind (&TimingPanel::play_length_changed, this));
 148         _video_frame_rate->Bind       (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&TimingPanel::video_frame_rate_changed, this));
 149         _set_video_frame_rate->Bind   (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&TimingPanel::set_video_frame_rate, this));
 150
 151         _viewer->ImageChanged.connect (boost::bind (&TimingPanel::setup_sensitivity, this));
 152
 153         setup_sensitivity ();
 154 }
 155
 156 void
 157 TimingPanel::update_full_length ()
 158 {
 159         set<DCPTime> check;
 160         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 161                 check.insert (i->full_length ());
 162         }
 163
 164         if (check.size() == 1) {
 165                 _full_length->set (_parent->selected().front()->full_length (), _parent->film()->video_frame_rate ());
 166         } else {
 167                 _full_length->clear ();
 168         }
 169 }
 170
 171 void
 172 TimingPanel::update_play_length ()
 173 {
 174         set<DCPTime> check;
 175         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 176                 check.insert (i->length_after_trim ());
 177         }
 178
 179         if (check.size() == 1) {
 180                 _play_length->set (_parent->selected().front()->length_after_trim (), _parent->film()->video_frame_rate ());
 181         } else {
 182                 _play_length->clear ();
 183         }
 184 }
 185
 186 void
 187 TimingPanel::film_content_changed (int property)
 188 {
 189         int const film_video_frame_rate = _parent->film()->video_frame_rate ();
 190
 191         /* Here we check to see if we have exactly one different value of various
 192            properties, and fill the controls with that value if so.
 193         */
 194
 195         if (property == ContentProperty::POSITION) {
 196
 197                 set<DCPTime> check;
 198                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 199                         check.insert (i->position ());
 200                 }
 201
 202                 if (check.size() == 1) {
 203                         _position->set (_parent->selected().front()->position(), film_video_frame_rate);
 204                 } else {
 205                         _position->clear ();
 206                 }
 207
 208         } else if (
 209                 property == ContentProperty::LENGTH ||
 210                 property == VideoContentProperty::VIDEO_FRAME_RATE ||
 211                 property == VideoContentProperty::VIDEO_FRAME_TYPE ||
 212                 property == SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE
 213                 ) {
 214
 215                 update_full_length ();
 216
 217         } else if (property == ContentProperty::TRIM_START) {
 218
 219                 set<ContentTime> check;
 220                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 221                         check.insert (i->trim_start ());
 222                 }
 223
 224                 if (check.size() == 1) {
 225                         _trim_start->set (_parent->selected().front()->trim_start (), film_video_frame_rate);
 226                 } else {
 227                         _trim_start->clear ();
 228                 }
 229
 230         } else if (property == ContentProperty::TRIM_END) {
 231
 232                 set<ContentTime> check;
 233                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 234                         check.insert (i->trim_end ());
 235                 }
 236
 237                 if (check.size() == 1) {
 238                         _trim_end->set (_parent->selected().front()->trim_end (), film_video_frame_rate);
 239                 } else {
 240                         _trim_end->clear ();
 241                 }
 242         }
 243
 244         if (
 245                 property == ContentProperty::LENGTH ||
 246                 property == ContentProperty::TRIM_START ||
 247                 property == ContentProperty::TRIM_END ||
 248                 property == VideoContentProperty::VIDEO_FRAME_RATE ||
 249                 property == VideoContentProperty::VIDEO_FRAME_TYPE ||
 250                 property == SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE
 251                 ) {
 252
 253                 update_play_length ();
 254         }
 255
 256         if (property == VideoContentProperty::VIDEO_FRAME_RATE || property == SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE) {
 257                 set<double> check_vc;
 258                 shared_ptr<const VideoContent> vc;
 259                 int count_sc = 0;
 260                 shared_ptr<const SubtitleContent> sc;
 261                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 262                         shared_ptr<const VideoContent> vt = dynamic_pointer_cast<const VideoContent> (i);
 263                         if (vt) {
 264                                 check_vc.insert (vt->video_frame_rate ());
 265                                 vc = vt;
 266                         }
 267                         shared_ptr<const SubtitleContent> st = dynamic_pointer_cast<const SubtitleContent> (i);
 268                         if (st) {
 269                                 ++count_sc;
 270                                 sc = st;
 271                         }
 272
 273                 }
 274
 275                 bool const single_frame_image_content = vc && dynamic_pointer_cast<const ImageContent> (vc) && vc->number_of_paths() == 1;
 276
 277                 if ((check_vc.size() == 1 || count_sc == 1) && !single_frame_image_content) {
 278                         if (vc) {
 279                                 checked_set (_video_frame_rate, raw_convert<string> (vc->video_frame_rate (), 5));
 280                         } else if (sc) {
 281                                 checked_set (_video_frame_rate, raw_convert<string> (sc->subtitle_video_frame_rate (), 5));
 282                         }
 283                         _video_frame_rate->Enable (true);
 284                 } else {
 285                         checked_set (_video_frame_rate, wxT (""));
 286                         _video_frame_rate->Enable (false);
 287                 }
 288         }
 289
 290         bool have_still = false;
 291         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 292                 shared_ptr<const ImageContent> ic = dynamic_pointer_cast<const ImageContent> (i);
 293                 if (ic && ic->still ()) {
 294                         have_still = true;
 295                 }
 296         }
 297
 298         _full_length->set_editable (have_still);
 299         _play_length->set_editable (!have_still);
 300         _set_video_frame_rate->Enable (false);
 301         setup_sensitivity ();
 302 }
 303
 304 void
 305 TimingPanel::position_changed ()
 306 {
 307         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 308                 i->set_position (_position->get (_parent->film()->video_frame_rate ()));
 309         }
 310 }
 311
 312 void
 313 TimingPanel::full_length_changed ()
 314 {
 315         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 316                 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
 317                 if (ic && ic->still ()) {
 318                         int const vfr = _parent->film()->video_frame_rate ();
 319                         ic->set_video_length (_full_length->get (vfr).frames_round (vfr));
 320                 }
 321         }
 322 }
 323
 324 void
 325 TimingPanel::trim_start_changed ()
 326 {
 327         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 328                 i->set_trim_start (_trim_start->get (_parent->film()->video_frame_rate ()));
 329         }
 330 }
 331
 332 void
 333 TimingPanel::trim_end_changed ()
 334 {
 335         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 336                 i->set_trim_end (_trim_end->get (_parent->film()->video_frame_rate ()));
 337         }
 338 }
 339
 340 void
 341 TimingPanel::play_length_changed ()
 342 {
 343         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 344                 FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
 345                 i->set_trim_end (
 346                         ContentTime (i->full_length() - _play_length->get (_parent->film()->video_frame_rate()), frc)
 347                         - i->trim_start ()
 348                         );
 349         }
 350 }
 351
 352 void
 353 TimingPanel::video_frame_rate_changed ()
 354 {
 355         _set_video_frame_rate->Enable (true);
 356 }
 357
 358 void
 359 TimingPanel::set_video_frame_rate ()
 360 {
 361         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 362                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
 363                 shared_ptr<DCPSubtitleContent> dsc = dynamic_pointer_cast<DCPSubtitleContent> (i);
 364                 shared_ptr<SubRipContent> ssc = dynamic_pointer_cast<SubRipContent> (i);
 365                 if (vc) {
 366                         vc->set_video_frame_rate (raw_convert<double> (wx_to_std (_video_frame_rate->GetValue ())));
 367                 } else if (dsc) {
 368                         dsc->set_subtitle_video_frame_rate (raw_convert<double> (wx_to_std (_video_frame_rate->GetValue ())));
 369                 } else if (ssc) {
 370                         ssc->set_subtitle_video_frame_rate (raw_convert<double> (wx_to_std (_video_frame_rate->GetValue ())));
 371                 }
 372                 _set_video_frame_rate->Enable (false);
 373         }
 374 }
 375
 376 void
 377 TimingPanel::content_selection_changed ()
 378 {
 379         setup_sensitivity ();
 380
 381         film_content_changed (ContentProperty::POSITION);
 382         film_content_changed (ContentProperty::LENGTH);
 383         film_content_changed (ContentProperty::TRIM_START);
 384         film_content_changed (ContentProperty::TRIM_END);
 385         film_content_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 386         film_content_changed (SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE);
 387 }
 388
 389 void
 390 TimingPanel::film_changed (Film::Property p)
 391 {
 392         if (p == Film::VIDEO_FRAME_RATE) {
 393                 update_full_length ();
 394                 update_play_length ();
 395         }
 396 }
 397
 398 void
 399 TimingPanel::trim_start_to_playhead_clicked ()
 400 {
 401         DCPTime const ph = _viewer->position ();
 402         optional<DCPTime> new_ph;
 403
 404         _viewer->set_ignore_player_changes (true);
 405
 406         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 407                 if (i->position() < ph && ph < i->end ()) {
 408                         FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
 409                         i->set_trim_start (i->trim_start() + ContentTime (ph - i->position (), frc));
 410                         new_ph = i->position ();
 411                 }
 412         }
 413
 414         _viewer->set_ignore_player_changes (false);
 415
 416         if (new_ph) {
 417                 _viewer->set_position (new_ph.get());
 418         }
 419 }
 420
 421 void
 422 TimingPanel::trim_end_to_playhead_clicked ()
 423 {
 424         DCPTime const ph = _viewer->position ();
 425         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
 426                 if (i->position() < ph && ph < i->end ()) {
 427                         FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
 428                         i->set_trim_end (ContentTime (i->position() + i->full_length() - ph - DCPTime::from_frames (1, frc.dcp), frc) - i->trim_start());
 429                 }
 430         }
 431 }
 432
 433 void
 434 TimingPanel::setup_sensitivity ()
 435 {
 436         bool const e = !_parent->selected().empty ();
 437
 438         _position->Enable (e);
 439         _full_length->Enable (e);
 440         _trim_start->Enable (e);
 441         _trim_end->Enable (e);
 442         _play_length->Enable (e);
 443         _video_frame_rate->Enable (e);
 444
 445         DCPTime const ph = _viewer->position ();
 446         bool any_over_ph = false;
 447         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
 448                 if (i->position() <= ph && ph < i->end()) {
 449                         any_over_ph = true;
 450                 }
 451         }
 452
 453         _trim_start_to_playhead->Enable (any_over_ph);
 454         _trim_end_to_playhead->Enable (any_over_ph);
 455 }