src/lib/text_subtitle_decoder.cc

   1 /*
   2     Copyright (C) 2014-2016 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 "text_subtitle_decoder.h"
  22 #include "text_subtitle_content.h"
  23 #include "subtitle_content.h"
  24 #include <dcp/subtitle_string.h>
  25 #include <boost/foreach.hpp>
  26 #include <iostream>
  27
  28 using std::list;
  29 using std::vector;
  30 using std::string;
  31 using std::cout;
  32 using std::max;
  33 using boost::shared_ptr;
  34 using boost::optional;
  35 using boost::dynamic_pointer_cast;
  36
  37 TextSubtitleDecoder::TextSubtitleDecoder (shared_ptr<const TextSubtitleContent> content)
  38         : TextSubtitle (content)
  39         , _next (0)
  40 {
  41         subtitle.reset (
  42                 new SubtitleDecoder (
  43                         this,
  44                         content->subtitle,
  45                         bind (&TextSubtitleDecoder::image_subtitles_during, this, _1, _2),
  46                         bind (&TextSubtitleDecoder::text_subtitles_during, this, _1, _2)
  47                         )
  48                 );
  49 }
  50
  51 void
  52 TextSubtitleDecoder::seek (ContentTime time, bool accurate)
  53 {
  54         subtitle->seek (time, accurate);
  55
  56         _next = 0;
  57         while (_next < _subtitles.size() && ContentTime::from_seconds (_subtitles[_next].from.all_as_seconds ()) < time) {
  58                 ++_next;
  59         }
  60 }
  61
  62 bool
  63 TextSubtitleDecoder::pass (PassReason, bool)
  64 {
  65         if (_next >= _subtitles.size ()) {
  66                 return true;
  67         }
  68
  69         list<dcp::SubtitleString> out;
  70
  71         /* See if our next subtitle needs to be placed on screen by us */
  72         bool needs_placement = false;
  73         BOOST_FOREACH (sub::Line i, _subtitles[_next].lines) {
  74                 if (!i.vertical_position.reference && i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
  75                         needs_placement = true;
  76                 }
  77         }
  78
  79         /* Highest line index in this subtitle */
  80         int highest = 0;
  81         BOOST_FOREACH (sub::Line i, _subtitles[_next].lines) {
  82                 DCPOMATIC_ASSERT (i.vertical_position.reference && i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE);
  83                 DCPOMATIC_ASSERT (i.vertical_position.line);
  84                 highest = max (highest, i.vertical_position.line.get());
  85         }
  86
  87         BOOST_FOREACH (sub::Line i, _subtitles[_next].lines) {
  88                 BOOST_FOREACH (sub::Block j, i.blocks) {
  89
  90                         float v_position;
  91                         dcp::VAlign v_align;
  92                         if (needs_placement) {
  93                                 DCPOMATIC_ASSERT (i.vertical_position.line);
  94                                 /* This 0.878 is an arbitrary value to lift the bottom sub off the bottom
  95                                    of the screen a bit to a pleasing degree.
  96                                 */
  97                                 v_position = 0.878 + i.vertical_position.line.get() * 1.5 / 22;
  98                                 v_align = dcp::VALIGN_BOTTOM;
  99                         } else {
 100                                 DCPOMATIC_ASSERT (i.vertical_position.proportional);
 101                                 DCPOMATIC_ASSERT (i.vertical_position.reference);
 102                                 v_position = i.vertical_position.proportional.get();
 103                                 switch (i.vertical_position.reference.get()) {
 104                                 case sub::TOP_OF_SCREEN:
 105                                         v_align = dcp::VALIGN_TOP;
 106                                         break;
 107                                 case sub::CENTRE_OF_SCREEN:
 108                                         v_align = dcp::VALIGN_CENTER;
 109                                         break;
 110                                 case sub::BOTTOM_OF_SCREEN:
 111                                         v_align = dcp::VALIGN_BOTTOM;
 112                                         break;
 113                                 default:
 114                                         v_align = dcp::VALIGN_TOP;
 115                                         break;
 116                                 }
 117                         }
 118
 119                         out.push_back (
 120                                 dcp::SubtitleString (
 121                                         TextSubtitleContent::font_id,
 122                                         j.italic,
 123                                         j.bold,
 124                                         /* force the colour to whatever is configured */
 125                                         subtitle->content()->colour(),
 126                                         j.font_size.points (72 * 11),
 127                                         1.0,
 128                                         dcp::Time (_subtitles[_next].from.all_as_seconds(), 1000),
 129                                         dcp::Time (_subtitles[_next].to.all_as_seconds(), 1000),
 130                                         0,
 131                                         dcp::HALIGN_CENTER,
 132                                         v_position,
 133                                         v_align,
 134                                         dcp::DIRECTION_LTR,
 135                                         j.text,
 136                                         subtitle->content()->outline() ? dcp::BORDER : dcp::NONE,
 137                                         subtitle->content()->outline_colour(),
 138                                         dcp::Time (0, 1000),
 139                                         dcp::Time (0, 1000)
 140                                         )
 141                                 );
 142                 }
 143         }
 144
 145         subtitle->give_text (content_time_period (_subtitles[_next]), out);
 146
 147         ++_next;
 148         return false;
 149 }
 150
 151 list<ContentTimePeriod>
 152 TextSubtitleDecoder::image_subtitles_during (ContentTimePeriod, bool) const
 153 {
 154         return list<ContentTimePeriod> ();
 155 }
 156
 157 list<ContentTimePeriod>
 158 TextSubtitleDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
 159 {
 160         /* XXX: inefficient */
 161
 162         list<ContentTimePeriod> d;
 163
 164         for (vector<sub::Subtitle>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
 165                 ContentTimePeriod t = content_time_period (*i);
 166                 if ((starting && p.contains (t.from)) || (!starting && p.overlaps (t))) {
 167                         d.push_back (t);
 168                 }
 169         }
 170
 171         return d;
 172 }
 173
 174 ContentTimePeriod
 175 TextSubtitleDecoder::content_time_period (sub::Subtitle s) const
 176 {
 177         return ContentTimePeriod (
 178                 ContentTime::from_seconds (s.from.all_as_seconds()),
 179                 ContentTime::from_seconds (s.to.all_as_seconds())
 180                 );
 181 }