Fix typo causing failures to update the preview after changing
[dcpomatic.git] / src / wx / timing_panel.cc
1 /*
2     Copyright (C) 2012-2018 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 "timing_panel.h"
22 #include "wx_util.h"
23 #include "film_viewer.h"
24 #include "timecode.h"
25 #include "content_panel.h"
26 #include "move_to_dialog.h"
27 #include "static_text.h"
28 #include "dcpomatic_button.h"
29 #include "lib/content.h"
30 #include "lib/image_content.h"
31 #include "lib/text_content.h"
32 #include "lib/dcp_subtitle_content.h"
33 #include "lib/audio_content.h"
34 #include "lib/string_text_file_content.h"
35 #include "lib/video_content.h"
36 #include "lib/dcp_content.h"
37 #include "lib/ffmpeg_content.h"
38 #include <dcp/locale_convert.h>
39 #include <boost/foreach.hpp>
40 #include <set>
41 #include <iostream>
42
43 using std::cout;
44 using std::string;
45 using std::set;
46 using boost::shared_ptr;
47 using boost::weak_ptr;
48 using boost::dynamic_pointer_cast;
49 using boost::optional;
50 using dcp::locale_convert;
51 using namespace dcpomatic;
52
53 TimingPanel::TimingPanel (ContentPanel* p, weak_ptr<FilmViewer> viewer)
54         /* horrid hack for apparent lack of context support with wxWidgets i18n code */
55         /// TRANSLATORS: translate the word "Timing" here; do not include the "Timing|" prefix
56         : ContentSubPanel (p, S_("Timing|Timing"))
57         , _viewer (viewer)
58 {
59         wxSize size = TimecodeBase::size (this);
60
61         for (int i = 0; i < 3; ++i) {
62                 _colon[i] = create_label (this, wxT(":"), false);
63         }
64
65         //// TRANSLATORS: this is an abbreviation for "hours"
66         _h_label = new StaticText (this, _("h"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
67 #ifdef DCPOMATIC_LINUX
68         /* Hack to work around failure to centre text on GTK */
69         gtk_label_set_line_wrap (GTK_LABEL(_h_label->GetHandle()), FALSE);
70 #endif
71         //// TRANSLATORS: this is an abbreviation for "minutes"
72         _m_label = new StaticText (this, _("m"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
73 #ifdef DCPOMATIC_LINUX
74         gtk_label_set_line_wrap (GTK_LABEL (_m_label->GetHandle()), FALSE);
75 #endif
76         //// TRANSLATORS: this is an abbreviation for "seconds"
77         _s_label = new StaticText (this, _("s"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
78 #ifdef DCPOMATIC_LINUX
79         gtk_label_set_line_wrap (GTK_LABEL(_s_label->GetHandle()), FALSE);
80 #endif
81         //// TRANSLATORS: this is an abbreviation for "frames"
82         _f_label = new StaticText (this, _("f"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
83 #ifdef DCPOMATIC_LINUX
84         gtk_label_set_line_wrap (GTK_LABEL(_f_label->GetHandle()), FALSE);
85 #endif
86
87         _position_label = create_label (this, _("Position"), true);
88         _position = new Timecode<DCPTime> (this);
89         _move_to_start_of_reel = new Button (this, _("Move to start of reel"));
90         _full_length_label = create_label (this, _("Full length"), true);
91         _full_length = new Timecode<DCPTime> (this);
92         _trim_start_label = create_label (this, _("Trim from start"), true);
93         _trim_start = new Timecode<ContentTime> (this);
94         _trim_start_to_playhead = new Button (this, _("Trim up to current position"));
95         _trim_end_label = create_label (this, _("Trim from end"), true);
96         _trim_end = new Timecode<ContentTime> (this);
97         _trim_end_to_playhead = new Button (this, _("Trim after current position"));
98         _play_length_label = create_label (this, _("Play length"), true);
99         _play_length = new Timecode<DCPTime> (this);
100
101         _video_frame_rate_label = create_label (this, _("Video frame rate"), true);
102         _video_frame_rate = new wxTextCtrl (this, wxID_ANY);
103         _set_video_frame_rate = new Button (this, _("Set"));
104         _set_video_frame_rate->Enable (false);
105
106         /* We can't use Wrap() here as it doesn't work with markup:
107          * http://trac.wxwidgets.org/ticket/13389
108          */
109
110         wxString in = _("<i>Only change this if the content's frame rate has been read incorrectly.</i>");
111         wxString out;
112         int const width = 20;
113         int current = 0;
114         for (size_t i = 0; i < in.Length(); ++i) {
115                 if (in[i] == ' ' && current >= width) {
116                         out += '\n';
117                         current = 0;
118                 } else {
119                         out += in[i];
120                         ++current;
121                 }
122         }
123
124         _tip = new StaticText (this, wxT (""));
125         _tip->SetLabelMarkup (out);
126 #ifdef DCPOMATIC_OSX
127         /* Hack to stop hidden text on some versions of OS X */
128         _tip->SetMinSize (wxSize (-1, 256));
129 #endif
130
131         _position->Changed.connect    (boost::bind (&TimingPanel::position_changed, this));
132         _move_to_start_of_reel->Bind  (wxEVT_BUTTON, boost::bind (&TimingPanel::move_to_start_of_reel_clicked, this));
133         _full_length->Changed.connect (boost::bind (&TimingPanel::full_length_changed, this));
134         _trim_start->Changed.connect  (boost::bind (&TimingPanel::trim_start_changed, this));
135         _trim_start_to_playhead->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_start_to_playhead_clicked, this));
136         _trim_end->Changed.connect    (boost::bind (&TimingPanel::trim_end_changed, this));
137         _trim_end_to_playhead->Bind   (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_end_to_playhead_clicked, this));
138         _play_length->Changed.connect (boost::bind (&TimingPanel::play_length_changed, this));
139         _video_frame_rate->Bind       (wxEVT_TEXT, boost::bind (&TimingPanel::video_frame_rate_changed, this));
140         _set_video_frame_rate->Bind   (wxEVT_BUTTON, boost::bind (&TimingPanel::set_video_frame_rate, this));
141
142         shared_ptr<FilmViewer> fv = _viewer.lock ();
143         DCPOMATIC_ASSERT (fv);
144         fv->ImageChanged.connect (boost::bind (&TimingPanel::setup_sensitivity, this));
145
146         setup_sensitivity ();
147         add_to_grid ();
148 }
149
150 void
151 TimingPanel::add_to_grid ()
152 {
153         bool const full = Config::instance()->interface_complexity() == Config::INTERFACE_FULL;
154
155         int r = 0;
156
157         wxSizer* labels = new wxBoxSizer (wxHORIZONTAL);
158         labels->Add (_h_label, 1, wxEXPAND);
159         add_label_to_sizer (labels, _colon[0], false);
160         labels->Add (_m_label, 1, wxEXPAND);
161         add_label_to_sizer (labels, _colon[1], false);
162         labels->Add (_s_label, 1, wxEXPAND);
163         add_label_to_sizer (labels, _colon[2], false);
164         labels->Add (_f_label, 1, wxEXPAND);
165         _grid->Add (labels, wxGBPosition(r, 1));
166         ++r;
167
168         add_label_to_sizer (_grid, _position_label, true, wxGBPosition(r, 0));
169         _grid->Add (_position, wxGBPosition(r, 1));
170         ++r;
171
172         _move_to_start_of_reel->Show (full);
173         _full_length_label->Show (full);
174         _full_length->Show (full);
175         _play_length_label->Show (full);
176         _play_length->Show (full);
177         _video_frame_rate_label->Show (full);
178         _video_frame_rate->Show (full);
179         _set_video_frame_rate->Show (full);
180         _tip->Show (full);
181
182         if (full) {
183                 _grid->Add (_move_to_start_of_reel, wxGBPosition(r, 1));
184                 ++r;
185
186                 add_label_to_sizer (_grid, _full_length_label, true, wxGBPosition(r, 0));
187                 _grid->Add (_full_length, wxGBPosition(r, 1));
188                 ++r;
189         }
190
191         add_label_to_sizer (_grid, _trim_start_label, true, wxGBPosition(r, 0));
192         _grid->Add (_trim_start, wxGBPosition(r, 1));
193         ++r;
194
195         _grid->Add (_trim_start_to_playhead, wxGBPosition(r, 1));
196         ++r;
197
198         add_label_to_sizer (_grid, _trim_end_label, true, wxGBPosition(r, 0));
199         _grid->Add (_trim_end, wxGBPosition(r, 1));
200         ++r;
201
202         _grid->Add (_trim_end_to_playhead, wxGBPosition(r, 1));
203         ++r;
204
205         if (full) {
206                 add_label_to_sizer (_grid, _play_length_label, true, wxGBPosition(r, 0));
207                 _grid->Add (_play_length, wxGBPosition(r, 1));
208                 ++r;
209
210                 {
211                         add_label_to_sizer (_grid, _video_frame_rate_label, true, wxGBPosition(r, 0));
212                         wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
213                         s->Add (_video_frame_rate, 1, wxEXPAND);
214                         s->Add (_set_video_frame_rate, 0, wxLEFT | wxRIGHT, 8);
215                         _grid->Add (s, wxGBPosition(r, 1), wxGBSpan(1, 2));
216                 }
217                 ++r;
218
219                 _grid->Add (_tip, wxGBPosition(r, 1), wxGBSpan(1, 2));
220         }
221
222         /* Completely speculative fix for #891 */
223         _grid->Layout ();
224 }
225
226 void
227 TimingPanel::update_full_length ()
228 {
229         set<DCPTime> check;
230         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
231                 check.insert (i->full_length(_parent->film()));
232         }
233
234         if (check.size() == 1) {
235                 _full_length->set (_parent->selected().front()->full_length(_parent->film()), _parent->film()->video_frame_rate());
236         } else {
237                 _full_length->clear ();
238         }
239 }
240
241 void
242 TimingPanel::update_play_length ()
243 {
244         set<DCPTime> check;
245         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
246                 check.insert (i->length_after_trim(_parent->film()));
247         }
248
249         if (check.size() == 1) {
250                 _play_length->set (_parent->selected().front()->length_after_trim(_parent->film()), _parent->film()->video_frame_rate());
251         } else {
252                 _play_length->clear ();
253         }
254 }
255
256 void
257 TimingPanel::film_content_changed (int property)
258 {
259         int const film_video_frame_rate = _parent->film()->video_frame_rate ();
260
261         /* Here we check to see if we have exactly one different value of various
262            properties, and fill the controls with that value if so.
263         */
264
265         if (property == ContentProperty::POSITION) {
266
267                 set<DCPTime> check;
268                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
269                         check.insert (i->position ());
270                 }
271
272                 if (check.size() == 1) {
273                         _position->set (_parent->selected().front()->position(), film_video_frame_rate);
274                 } else {
275                         _position->clear ();
276                 }
277
278         } else if (
279                 property == ContentProperty::LENGTH ||
280                 property == ContentProperty::VIDEO_FRAME_RATE ||
281                 property == VideoContentProperty::FRAME_TYPE
282                 ) {
283
284                 update_full_length ();
285
286         } else if (property == ContentProperty::TRIM_START) {
287
288                 set<ContentTime> check;
289                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
290                         check.insert (i->trim_start ());
291                 }
292
293                 if (check.size() == 1) {
294                         _trim_start->set (_parent->selected().front()->trim_start (), film_video_frame_rate);
295                 } else {
296                         _trim_start->clear ();
297                 }
298
299         } else if (property == ContentProperty::TRIM_END) {
300
301                 set<ContentTime> check;
302                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
303                         check.insert (i->trim_end ());
304                 }
305
306                 if (check.size() == 1) {
307                         _trim_end->set (_parent->selected().front()->trim_end (), film_video_frame_rate);
308                 } else {
309                         _trim_end->clear ();
310                 }
311         }
312
313         if (
314                 property == ContentProperty::LENGTH ||
315                 property == ContentProperty::TRIM_START ||
316                 property == ContentProperty::TRIM_END ||
317                 property == ContentProperty::VIDEO_FRAME_RATE ||
318                 property == VideoContentProperty::FRAME_TYPE
319                 ) {
320
321                 update_play_length ();
322         }
323
324         if (property == ContentProperty::VIDEO_FRAME_RATE) {
325                 set<double> check_vc;
326                 shared_ptr<const Content> content;
327                 int count_ac = 0;
328                 int count_sc = 0;
329                 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
330                         if (i->video && i->video_frame_rate()) {
331                                 check_vc.insert (i->video_frame_rate().get());
332                                 content = i;
333                         }
334                         if (i->audio && i->video_frame_rate()) {
335                                 ++count_ac;
336                                 content = i;
337                         }
338                         if (!i->text.empty() && i->video_frame_rate()) {
339                                 ++count_sc;
340                                 content = i;
341                         }
342
343                 }
344
345                 bool const single_frame_image_content = content && dynamic_pointer_cast<const ImageContent> (content) && content->number_of_paths() == 1;
346
347                 if ((check_vc.size() == 1 || count_ac == 1 || count_sc == 1) && !single_frame_image_content) {
348                         checked_set (_video_frame_rate, locale_convert<string> (content->video_frame_rate().get(), 5));
349                         _video_frame_rate->Enable (true);
350                 } else {
351                         checked_set (_video_frame_rate, wxT (""));
352                         _video_frame_rate->Enable (false);
353                 }
354         }
355
356         bool have_still = false;
357         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
358                 shared_ptr<const ImageContent> ic = dynamic_pointer_cast<const ImageContent> (i);
359                 if (ic && ic->still ()) {
360                         have_still = true;
361                 }
362         }
363
364         _full_length->set_editable (have_still);
365         _play_length->set_editable (!have_still);
366         _set_video_frame_rate->Enable (false);
367         setup_sensitivity ();
368 }
369
370 void
371 TimingPanel::position_changed ()
372 {
373         DCPTime const pos = _position->get (_parent->film()->video_frame_rate ());
374         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
375                 i->set_position (_parent->film(), pos);
376         }
377 }
378
379 void
380 TimingPanel::full_length_changed ()
381 {
382         int const vfr = _parent->film()->video_frame_rate ();
383         Frame const len = _full_length->get (vfr).frames_round (vfr);
384         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
385                 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
386                 if (ic && ic->still ()) {
387                         ic->video->set_length (len);
388                 }
389         }
390 }
391
392 void
393 TimingPanel::trim_start_changed ()
394 {
395         shared_ptr<FilmViewer> fv = _viewer.lock ();
396         if (!fv) {
397                 return;
398         }
399
400         DCPTime const ph = fv->position ();
401
402         fv->set_coalesce_player_changes (true);
403
404         shared_ptr<Content> ref;
405         optional<FrameRateChange> ref_frc;
406         optional<DCPTime> ref_ph;
407
408
409         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
410                 if (i->position() <= ph && ph < i->end(_parent->film())) {
411                         /* The playhead is in i.  Use it as a reference to work out
412                            where to put the playhead post-trim; we're trying to keep the playhead
413                            at the same frame of content that we're looking at pre-trim.
414                         */
415                         ref = i;
416                         ref_frc = _parent->film()->active_frame_rate_change (i->position ());
417                         ref_ph = ph - i->position() + DCPTime (i->trim_start(), ref_frc.get());
418                 }
419
420                 ContentTime const trim = _trim_start->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
421                 i->set_trim_start (trim);
422         }
423
424         if (ref) {
425                 fv->seek (max(DCPTime(), ref_ph.get() + ref->position() - DCPTime(ref->trim_start(), ref_frc.get())), true);
426         }
427
428         fv->set_coalesce_player_changes (false);
429 }
430
431 void
432 TimingPanel::trim_end_changed ()
433 {
434         shared_ptr<FilmViewer> fv = _viewer.lock ();
435         if (!fv) {
436                 return;
437         }
438
439         fv->set_coalesce_player_changes (true);
440
441         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
442                 ContentTime const trim = _trim_end->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
443                 i->set_trim_end (trim);
444         }
445
446         /* XXX: maybe playhead-off-the-end-of-the-film should be handled elsewhere */
447         if (fv->position() >= _parent->film()->length()) {
448                 fv->seek (_parent->film()->length() - DCPTime::from_frames(1, _parent->film()->video_frame_rate()), true);
449         }
450
451         fv->set_coalesce_player_changes (false);
452 }
453
454 void
455 TimingPanel::play_length_changed ()
456 {
457         DCPTime const play_length = _play_length->get (_parent->film()->video_frame_rate());
458         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
459                 FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
460                 i->set_trim_end (
461                         ContentTime (max(DCPTime(), i->full_length(_parent->film()) - play_length), frc) - i->trim_start()
462                         );
463         }
464 }
465
466 void
467 TimingPanel::video_frame_rate_changed ()
468 {
469         bool enable = true;
470         if (_video_frame_rate->GetValue() == wxT("")) {
471                 /* No frame rate has been entered; if the user clicks "set" now it would unset the video
472                    frame rate in the selected content.  This can't be allowed for some content types.
473                 */
474                 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
475                         if (
476                                 dynamic_pointer_cast<DCPContent>(i) ||
477                                 dynamic_pointer_cast<FFmpegContent>(i)
478                                 ) {
479                                 enable = false;
480                         }
481                 }
482         }
483
484         _set_video_frame_rate->Enable (enable);
485 }
486
487 void
488 TimingPanel::set_video_frame_rate ()
489 {
490         optional<double> fr;
491         if (_video_frame_rate->GetValue() != wxT("")) {
492                 fr = locale_convert<double> (wx_to_std (_video_frame_rate->GetValue ()));
493         }
494         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
495                 if (fr) {
496                         i->set_video_frame_rate (*fr);
497                 } else {
498                         i->unset_video_frame_rate ();
499                 }
500         }
501
502         _set_video_frame_rate->Enable (false);
503 }
504
505 void
506 TimingPanel::content_selection_changed ()
507 {
508         setup_sensitivity ();
509
510         film_content_changed (ContentProperty::POSITION);
511         film_content_changed (ContentProperty::LENGTH);
512         film_content_changed (ContentProperty::TRIM_START);
513         film_content_changed (ContentProperty::TRIM_END);
514         film_content_changed (ContentProperty::VIDEO_FRAME_RATE);
515 }
516
517 void
518 TimingPanel::film_changed (Film::Property p)
519 {
520         if (p == Film::VIDEO_FRAME_RATE) {
521                 update_full_length ();
522                 update_play_length ();
523         }
524 }
525
526 void
527 TimingPanel::trim_start_to_playhead_clicked ()
528 {
529         shared_ptr<FilmViewer> fv = _viewer.lock ();
530         if (!fv) {
531                 return;
532         }
533
534         shared_ptr<const Film> film = _parent->film ();
535         DCPTime const ph = fv->position().floor (film->video_frame_rate ());
536         optional<DCPTime> new_ph;
537
538         fv->set_coalesce_player_changes (true);
539
540         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
541                 if (i->position() < ph && ph < i->end(film)) {
542                         FrameRateChange const frc = film->active_frame_rate_change (i->position());
543                         i->set_trim_start (i->trim_start() + ContentTime (ph - i->position(), frc));
544                         new_ph = i->position ();
545                 }
546         }
547
548         if (new_ph) {
549                 fv->seek (new_ph.get(), true);
550         }
551
552         fv->set_coalesce_player_changes (false);
553 }
554
555 void
556 TimingPanel::trim_end_to_playhead_clicked ()
557 {
558         shared_ptr<FilmViewer> fv = _viewer.lock ();
559         if (!fv) {
560                 return;
561         }
562
563         shared_ptr<const Film> film = _parent->film ();
564         DCPTime const ph = fv->position().floor (film->video_frame_rate ());
565         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
566                 if (i->position() < ph && ph < i->end(film)) {
567                         FrameRateChange const frc = film->active_frame_rate_change (i->position ());
568                         i->set_trim_end (ContentTime(i->position() + i->full_length(film) - ph - DCPTime::from_frames(1, frc.dcp), frc) - i->trim_start());
569                 }
570         }
571 }
572
573 void
574 TimingPanel::setup_sensitivity ()
575 {
576         bool const e = !_parent->selected().empty ();
577
578         _position->Enable (e);
579         _move_to_start_of_reel->Enable (e);
580         _full_length->Enable (e);
581         _trim_start->Enable (e);
582         _trim_end->Enable (e);
583         _play_length->Enable (e);
584         _video_frame_rate->Enable (e);
585
586         shared_ptr<FilmViewer> fv = _viewer.lock ();
587         DCPOMATIC_ASSERT (fv);
588         DCPTime const ph = fv->position ();
589         bool any_over_ph = false;
590         BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
591                 if (i->position() <= ph && ph < i->end(_parent->film())) {
592                         any_over_ph = true;
593                 }
594         }
595
596         _trim_start_to_playhead->Enable (any_over_ph);
597         _trim_end_to_playhead->Enable (any_over_ph);
598 }
599
600 void
601 TimingPanel::move_to_start_of_reel_clicked ()
602 {
603         /* Find common position of all selected content, if it exists */
604
605         optional<DCPTime> position;
606         BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
607                 if (!position) {
608                         position = i->position();
609                 } else {
610                         if (position.get() != i->position()) {
611                                 position.reset ();
612                                 break;
613                         }
614                 }
615         }
616
617         MoveToDialog* d = new MoveToDialog (this, position, _parent->film());
618
619         if (d->ShowModal() == wxID_OK) {
620                 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
621                         i->set_position (_parent->film(), d->position());
622                 }
623         }
624         d->Destroy ();
625 }