2 Copyright (C) 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 "closed_captions_dialog.h"
22 #include "lib/string_text.h"
23 #include "lib/butler.h"
24 #include <boost/bind.hpp>
31 using boost::shared_ptr;
32 using boost::weak_ptr;
33 using boost::optional;
35 ClosedCaptionsDialog::ClosedCaptionsDialog (wxWindow* parent)
36 /* XXX: empirical and probably unhelpful default size here; needs to be related to font metrics */
37 : wxDialog (parent, wxID_ANY, _("Closed captions"), wxDefaultPosition, wxSize(640, (640 / 10) + 64),
39 /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
40 the window above all others (and not just our own) it's better than nothing for now.
42 wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
44 wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
47 , _current_in_lines (false)
49 _lines.resize (CLOSED_CAPTION_LINES);
50 Bind (wxEVT_PAINT, boost::bind (&ClosedCaptionsDialog::paint, this));
54 ClosedCaptionsDialog::paint ()
57 dc.SetBackground (*wxBLACK_BRUSH);
59 dc.SetTextForeground (*wxWHITE);
61 /* Choose a font which fits vertically */
62 int const line_height = max (8, dc.GetSize().GetHeight() / CLOSED_CAPTION_LINES);
63 wxFont font (*wxNORMAL_FONT);
64 font.SetPixelSize (wxSize (0, line_height * 0.8));
67 for (int i = 0; i < CLOSED_CAPTION_LINES; ++i) {
68 wxString const good = _lines[i].Left (CLOSED_CAPTION_LENGTH);
69 dc.DrawText (good, 8, line_height * i);
70 if (_lines[i].Length() > CLOSED_CAPTION_LENGTH) {
71 wxString const bad = _lines[i].Right (_lines[i].Length() - CLOSED_CAPTION_LENGTH);
72 wxSize size = dc.GetTextExtent (good);
73 dc.SetTextForeground (*wxRED);
74 dc.DrawText (bad, 8 + size.GetWidth(), line_height * i);
75 dc.SetTextForeground (*wxWHITE);
80 class ClosedCaptionSorter
83 bool operator() (StringText const & a, StringText const & b)
85 return from_top(a) < from_top(b);
89 float from_top (StringText const & c) const
91 switch (c.v_align()) {
93 return c.v_position();
94 case dcp::VALIGN_CENTER:
95 return c.v_position() + 0.5;
96 case dcp::VALIGN_BOTTOM:
97 return 1.0 - c.v_position();
99 DCPOMATIC_ASSERT (false);
105 ClosedCaptionsDialog::update (DCPTime time)
107 if (_current_in_lines && _current->second.to > time) {
108 /* Current one is fine */
112 if (_current && _current->second.to < time) {
113 /* Current one has finished; clear out */
114 for (int j = 0; j < CLOSED_CAPTION_LINES; ++j) {
118 _current = optional<pair<PlayerText, DCPTimePeriod> >();
122 /* We have no current one: get another */
123 shared_ptr<Butler> butler = _butler.lock ();
124 DCPOMATIC_ASSERT (butler);
125 _current = butler->get_closed_caption ();
126 _current_in_lines = false;
129 if (_current && _current->second.contains(time)) {
130 /* We need to set this new one up */
132 list<StringText> to_show = _current->first.string;
134 for (int j = 0; j < CLOSED_CAPTION_LINES; ++j) {
138 to_show.sort (ClosedCaptionSorter());
140 list<StringText>::const_iterator j = to_show.begin();
142 while (j != to_show.end() && k < CLOSED_CAPTION_LINES) {
143 _lines[k] = j->text();
149 _current_in_lines = true;
154 ClosedCaptionsDialog::clear ()
156 _current = optional<pair<PlayerText, DCPTimePeriod> >();
157 _current_in_lines = false;
162 ClosedCaptionsDialog::set_butler (weak_ptr<Butler> butler)