2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "timing_panel.h"
23 #include "film_viewer.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>
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;
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"))
58 , _film_content_changed_suspender (boost::bind(&TimingPanel::film_content_changed, this, _1))
60 wxSize size = TimecodeBase::size (this);
62 for (int i = 0; i < 3; ++i) {
63 _colon[i] = create_label (this, wxT(":"), false);
66 //// TRANSLATORS: this is an abbreviation for "hours"
67 _h_label = new StaticText (this, _("h"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
68 #ifdef DCPOMATIC_LINUX
69 /* Hack to work around failure to centre text on GTK */
70 gtk_label_set_line_wrap (GTK_LABEL(_h_label->GetHandle()), FALSE);
72 //// TRANSLATORS: this is an abbreviation for "minutes"
73 _m_label = new StaticText (this, _("m"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
74 #ifdef DCPOMATIC_LINUX
75 gtk_label_set_line_wrap (GTK_LABEL (_m_label->GetHandle()), FALSE);
77 //// TRANSLATORS: this is an abbreviation for "seconds"
78 _s_label = new StaticText (this, _("s"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
79 #ifdef DCPOMATIC_LINUX
80 gtk_label_set_line_wrap (GTK_LABEL(_s_label->GetHandle()), FALSE);
82 //// TRANSLATORS: this is an abbreviation for "frames"
83 _f_label = new StaticText (this, _("f"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
84 #ifdef DCPOMATIC_LINUX
85 gtk_label_set_line_wrap (GTK_LABEL(_f_label->GetHandle()), FALSE);
88 _position_label = create_label (this, _("Position"), true);
89 _position = new Timecode<DCPTime> (this);
90 _move_to_start_of_reel = new Button (this, _("Move to start of reel"));
91 _full_length_label = create_label (this, _("Full length"), true);
92 _full_length = new Timecode<DCPTime> (this);
93 _trim_start_label = create_label (this, _("Trim from start"), true);
94 _trim_start = new Timecode<ContentTime> (this);
95 _trim_start_to_playhead = new Button (this, _("Trim up to current position"));
96 _trim_end_label = create_label (this, _("Trim from end"), true);
97 _trim_end = new Timecode<ContentTime> (this);
98 _trim_end_to_playhead = new Button (this, _("Trim after current position"));
99 _play_length_label = create_label (this, _("Play length"), true);
100 _play_length = new Timecode<DCPTime> (this);
102 _video_frame_rate_label = create_label (this, _("Video frame rate"), true);
103 _video_frame_rate = new wxTextCtrl (this, wxID_ANY);
104 _set_video_frame_rate = new Button (this, _("Set"));
105 _set_video_frame_rate->Enable (false);
107 /* We can't use Wrap() here as it doesn't work with markup:
108 * http://trac.wxwidgets.org/ticket/13389
111 wxString in = _("<i>Only change this if the content's frame rate has been read incorrectly.</i>");
113 int const width = 20;
115 for (size_t i = 0; i < in.Length(); ++i) {
116 if (in[i] == ' ' && current >= width) {
125 _tip = new StaticText (this, wxT (""));
126 _tip->SetLabelMarkup (out);
128 /* Hack to stop hidden text on some versions of OS X */
129 _tip->SetMinSize (wxSize (-1, 256));
132 _position->Changed.connect (boost::bind (&TimingPanel::position_changed, this));
133 _move_to_start_of_reel->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::move_to_start_of_reel_clicked, this));
134 _full_length->Changed.connect (boost::bind (&TimingPanel::full_length_changed, this));
135 _trim_start->Changed.connect (boost::bind (&TimingPanel::trim_start_changed, this));
136 _trim_start_to_playhead->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_start_to_playhead_clicked, this));
137 _trim_end->Changed.connect (boost::bind (&TimingPanel::trim_end_changed, this));
138 _trim_end_to_playhead->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_end_to_playhead_clicked, this));
139 _play_length->Changed.connect (boost::bind (&TimingPanel::play_length_changed, this));
140 _video_frame_rate->Bind (wxEVT_TEXT, boost::bind (&TimingPanel::video_frame_rate_changed, this));
141 _set_video_frame_rate->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::set_video_frame_rate, this));
143 shared_ptr<FilmViewer> fv = _viewer.lock ();
144 DCPOMATIC_ASSERT (fv);
145 fv->ImageChanged.connect (boost::bind (&TimingPanel::setup_sensitivity, this));
147 setup_sensitivity ();
152 TimingPanel::add_to_grid ()
154 bool const full = Config::instance()->interface_complexity() == Config::INTERFACE_FULL;
158 wxSizer* labels = new wxBoxSizer (wxHORIZONTAL);
159 labels->Add (_h_label, 1, wxEXPAND);
160 add_label_to_sizer (labels, _colon[0], false);
161 labels->Add (_m_label, 1, wxEXPAND);
162 add_label_to_sizer (labels, _colon[1], false);
163 labels->Add (_s_label, 1, wxEXPAND);
164 add_label_to_sizer (labels, _colon[2], false);
165 labels->Add (_f_label, 1, wxEXPAND);
166 _grid->Add (labels, wxGBPosition(r, 1));
169 add_label_to_sizer (_grid, _position_label, true, wxGBPosition(r, 0));
170 _grid->Add (_position, wxGBPosition(r, 1));
173 _move_to_start_of_reel->Show (full);
174 _full_length_label->Show (full);
175 _full_length->Show (full);
176 _play_length_label->Show (full);
177 _play_length->Show (full);
178 _video_frame_rate_label->Show (full);
179 _video_frame_rate->Show (full);
180 _set_video_frame_rate->Show (full);
184 _grid->Add (_move_to_start_of_reel, wxGBPosition(r, 1));
187 add_label_to_sizer (_grid, _full_length_label, true, wxGBPosition(r, 0));
188 _grid->Add (_full_length, wxGBPosition(r, 1));
192 add_label_to_sizer (_grid, _trim_start_label, true, wxGBPosition(r, 0));
193 _grid->Add (_trim_start, wxGBPosition(r, 1));
196 _grid->Add (_trim_start_to_playhead, wxGBPosition(r, 1));
199 add_label_to_sizer (_grid, _trim_end_label, true, wxGBPosition(r, 0));
200 _grid->Add (_trim_end, wxGBPosition(r, 1));
203 _grid->Add (_trim_end_to_playhead, wxGBPosition(r, 1));
207 add_label_to_sizer (_grid, _play_length_label, true, wxGBPosition(r, 0));
208 _grid->Add (_play_length, wxGBPosition(r, 1));
212 add_label_to_sizer (_grid, _video_frame_rate_label, true, wxGBPosition(r, 0));
213 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
214 s->Add (_video_frame_rate, 1, wxEXPAND);
215 s->Add (_set_video_frame_rate, 0, wxLEFT | wxRIGHT, 8);
216 _grid->Add (s, wxGBPosition(r, 1), wxGBSpan(1, 2));
220 _grid->Add (_tip, wxGBPosition(r, 1), wxGBSpan(1, 2));
223 /* Completely speculative fix for #891 */
228 TimingPanel::update_full_length ()
231 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
232 check.insert (i->full_length(_parent->film()));
235 if (check.size() == 1) {
236 _full_length->set (_parent->selected().front()->full_length(_parent->film()), _parent->film()->video_frame_rate());
238 _full_length->clear ();
243 TimingPanel::update_play_length ()
246 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
247 check.insert (i->length_after_trim(_parent->film()));
250 if (check.size() == 1) {
251 _play_length->set (_parent->selected().front()->length_after_trim(_parent->film()), _parent->film()->video_frame_rate());
253 _play_length->clear ();
258 TimingPanel::film_content_changed (int property)
260 if (_film_content_changed_suspender.check(property)) {
264 int const film_video_frame_rate = _parent->film()->video_frame_rate ();
266 /* Here we check to see if we have exactly one different value of various
267 properties, and fill the controls with that value if so.
270 if (property == ContentProperty::POSITION) {
273 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
274 check.insert (i->position ());
277 if (check.size() == 1) {
278 _position->set (_parent->selected().front()->position(), film_video_frame_rate);
284 property == ContentProperty::LENGTH ||
285 property == ContentProperty::VIDEO_FRAME_RATE ||
286 property == VideoContentProperty::FRAME_TYPE
289 update_full_length ();
291 } else if (property == ContentProperty::TRIM_START) {
293 set<ContentTime> check;
294 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
295 check.insert (i->trim_start ());
298 if (check.size() == 1) {
299 _trim_start->set (_parent->selected().front()->trim_start (), film_video_frame_rate);
301 _trim_start->clear ();
304 } else if (property == ContentProperty::TRIM_END) {
306 set<ContentTime> check;
307 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
308 check.insert (i->trim_end ());
311 if (check.size() == 1) {
312 _trim_end->set (_parent->selected().front()->trim_end (), film_video_frame_rate);
319 property == ContentProperty::LENGTH ||
320 property == ContentProperty::TRIM_START ||
321 property == ContentProperty::TRIM_END ||
322 property == ContentProperty::VIDEO_FRAME_RATE ||
323 property == VideoContentProperty::FRAME_TYPE
326 update_play_length ();
329 if (property == ContentProperty::VIDEO_FRAME_RATE) {
330 set<double> check_vc;
331 shared_ptr<const Content> content;
334 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
335 if (i->video && i->video_frame_rate()) {
336 check_vc.insert (i->video_frame_rate().get());
339 if (i->audio && i->video_frame_rate()) {
343 if (!i->text.empty() && i->video_frame_rate()) {
350 bool const single_frame_image_content = content && dynamic_pointer_cast<const ImageContent> (content) && content->number_of_paths() == 1;
352 if ((check_vc.size() == 1 || count_ac == 1 || count_sc == 1) && !single_frame_image_content) {
353 checked_set (_video_frame_rate, locale_convert<string> (content->video_frame_rate().get(), 5));
354 _video_frame_rate->Enable (true);
356 checked_set (_video_frame_rate, wxT (""));
357 _video_frame_rate->Enable (false);
361 bool have_still = false;
362 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
363 shared_ptr<const ImageContent> ic = dynamic_pointer_cast<const ImageContent> (i);
364 if (ic && ic->still ()) {
369 _full_length->set_editable (have_still);
370 _play_length->set_editable (!have_still);
371 _set_video_frame_rate->Enable (false);
372 setup_sensitivity ();
376 TimingPanel::position_changed ()
378 DCPTime const pos = _position->get (_parent->film()->video_frame_rate ());
379 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
380 i->set_position (_parent->film(), pos);
385 TimingPanel::full_length_changed ()
387 int const vfr = _parent->film()->video_frame_rate ();
388 Frame const len = _full_length->get (vfr).frames_round (vfr);
389 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
390 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
391 if (ic && ic->still ()) {
392 ic->video->set_length (len);
398 TimingPanel::trim_start_changed ()
400 shared_ptr<FilmViewer> fv = _viewer.lock ();
405 DCPTime const ph = fv->position ();
407 fv->set_coalesce_player_changes (true);
409 shared_ptr<Content> ref;
410 optional<FrameRateChange> ref_frc;
411 optional<DCPTime> ref_ph;
413 Suspender::Block bl = _film_content_changed_suspender.block ();
414 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
415 if (i->position() <= ph && ph < i->end(_parent->film())) {
416 /* The playhead is in i. Use it as a reference to work out
417 where to put the playhead post-trim; we're trying to keep the playhead
418 at the same frame of content that we're looking at pre-trim.
421 ref_frc = _parent->film()->active_frame_rate_change (i->position ());
422 ref_ph = ph - i->position() + DCPTime (i->trim_start(), ref_frc.get());
425 ContentTime const trim = _trim_start->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
426 i->set_trim_start (trim);
430 fv->seek (max(DCPTime(), ref_ph.get() + ref->position() - DCPTime(ref->trim_start(), ref_frc.get())), true);
433 fv->set_coalesce_player_changes (false);
437 TimingPanel::trim_end_changed ()
439 shared_ptr<FilmViewer> fv = _viewer.lock ();
444 fv->set_coalesce_player_changes (true);
446 Suspender::Block bl = _film_content_changed_suspender.block ();
447 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
448 ContentTime const trim = _trim_end->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
449 i->set_trim_end (trim);
452 /* XXX: maybe playhead-off-the-end-of-the-film should be handled elsewhere */
453 if (fv->position() >= _parent->film()->length()) {
454 fv->seek (_parent->film()->length() - DCPTime::from_frames(1, _parent->film()->video_frame_rate()), true);
457 fv->set_coalesce_player_changes (false);
461 TimingPanel::play_length_changed ()
463 DCPTime const play_length = _play_length->get (_parent->film()->video_frame_rate());
464 Suspender::Block bl = _film_content_changed_suspender.block ();
465 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
466 FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
468 ContentTime (max(DCPTime(), i->full_length(_parent->film()) - play_length), frc) - i->trim_start()
474 TimingPanel::video_frame_rate_changed ()
477 if (_video_frame_rate->GetValue() == wxT("")) {
478 /* No frame rate has been entered; if the user clicks "set" now it would unset the video
479 frame rate in the selected content. This can't be allowed for some content types.
481 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
483 dynamic_pointer_cast<DCPContent>(i) ||
484 dynamic_pointer_cast<FFmpegContent>(i)
491 _set_video_frame_rate->Enable (enable);
495 TimingPanel::set_video_frame_rate ()
498 if (_video_frame_rate->GetValue() != wxT("")) {
499 fr = locale_convert<double> (wx_to_std (_video_frame_rate->GetValue ()));
501 Suspender::Block bl = _film_content_changed_suspender.block ();
502 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
504 i->set_video_frame_rate (*fr);
506 i->unset_video_frame_rate ();
510 _set_video_frame_rate->Enable (false);
514 TimingPanel::content_selection_changed ()
516 setup_sensitivity ();
518 film_content_changed (ContentProperty::POSITION);
519 film_content_changed (ContentProperty::LENGTH);
520 film_content_changed (ContentProperty::TRIM_START);
521 film_content_changed (ContentProperty::TRIM_END);
522 film_content_changed (ContentProperty::VIDEO_FRAME_RATE);
526 TimingPanel::film_changed (Film::Property p)
528 if (p == Film::VIDEO_FRAME_RATE) {
529 update_full_length ();
530 update_play_length ();
535 TimingPanel::trim_start_to_playhead_clicked ()
537 shared_ptr<FilmViewer> fv = _viewer.lock ();
542 shared_ptr<const Film> film = _parent->film ();
543 DCPTime const ph = fv->position().floor (film->video_frame_rate ());
544 optional<DCPTime> new_ph;
546 fv->set_coalesce_player_changes (true);
548 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
549 if (i->position() < ph && ph < i->end(film)) {
550 FrameRateChange const frc = film->active_frame_rate_change (i->position());
551 i->set_trim_start (i->trim_start() + ContentTime (ph - i->position(), frc));
552 new_ph = i->position ();
557 fv->seek (new_ph.get(), true);
560 fv->set_coalesce_player_changes (false);
564 TimingPanel::trim_end_to_playhead_clicked ()
566 shared_ptr<FilmViewer> fv = _viewer.lock ();
571 shared_ptr<const Film> film = _parent->film ();
572 DCPTime const ph = fv->position().floor (film->video_frame_rate ());
573 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
574 if (i->position() < ph && ph < i->end(film)) {
575 FrameRateChange const frc = film->active_frame_rate_change (i->position ());
576 i->set_trim_end (ContentTime(i->position() + i->full_length(film) - ph - DCPTime::from_frames(1, frc.dcp), frc) - i->trim_start());
582 TimingPanel::setup_sensitivity ()
584 bool const e = !_parent->selected().empty ();
586 _position->Enable (e);
587 _move_to_start_of_reel->Enable (e);
588 _full_length->Enable (e);
589 _trim_start->Enable (e);
590 _trim_end->Enable (e);
591 _play_length->Enable (e);
592 _video_frame_rate->Enable (e);
594 shared_ptr<FilmViewer> fv = _viewer.lock ();
595 DCPOMATIC_ASSERT (fv);
596 DCPTime const ph = fv->position ();
597 bool any_over_ph = false;
598 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
599 if (i->position() <= ph && ph < i->end(_parent->film())) {
604 _trim_start_to_playhead->Enable (any_over_ph);
605 _trim_end_to_playhead->Enable (any_over_ph);
609 TimingPanel::move_to_start_of_reel_clicked ()
611 /* Find common position of all selected content, if it exists */
613 optional<DCPTime> position;
614 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
616 position = i->position();
618 if (position.get() != i->position()) {
625 MoveToDialog* d = new MoveToDialog (this, position, _parent->film());
627 if (d->ShowModal() == wxID_OK) {
628 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
629 i->set_position (_parent->film(), d->position());