2 Copyright (C) 2016-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/>.
22 #ifndef DCPOMATIC_STRING_TEXT_H
23 #define DCPOMATIC_STRING_TEXT_H
27 #include <dcp/subtitle_string.h>
30 /** A wrapper for SubtitleString which allows us to:
32 * - include settings that are not applicable to true DCP subtitles.
33 * For example, we can set outline width for burn-in but this cannot be specified in DCP XML.
35 * - include details of how v_align should be interpreted
37 * - specify the font by referring to a Font object from the content we came from, rather than
38 * having to use a DCP ID like in dcp::SubtitleString.
40 class StringText : public dcp::SubtitleString
43 StringText(dcp::SubtitleString dcp_, int outline_width_, std::shared_ptr<dcpomatic::Font> font_, dcp::Standard valign_standard_)
44 : dcp::SubtitleString (dcp_)
45 , outline_width (outline_width_)
47 , valign_standard (valign_standard_)
51 std::shared_ptr<dcpomatic::Font> font;
52 /** Interop and SMPTE use the same VAlign choices (top, center, bottom) but give them different
53 * meanings. This is the standard which should be used to interpret v_align() in this subtitle;
54 * valign_standard == SMPTE means:
55 * top - top of screen to top of subtitle
56 * center - centre of screen to center of subtitle
57 * bottom - bottom of screen to bottom of subtitle
58 * valign_standard == Interop means:
59 * top - top of screen to baseline of subtitle
60 * center - centre of screen to baseline of subtitle
61 * bottom - bottom of screen to baseline of subtitle
63 dcp::Standard valign_standard;