Handle vertical alignment of subs correctly wrt the difference between Interop and...
[dcpomatic.git] / src / lib / dcp_subtitle_decoder.cc
index 23f5dd52992e224f1ef8fbf0b6b1978fc367040b..cbfe6fdbe29866302a1ee7218e55c4f4d1ed253b 100644 (file)
@@ -1,62 +1,79 @@
 /*
-    Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include "dcp_subtitle_decoder.h"
+
 #include "dcp_subtitle_content.h"
+#include "dcp_subtitle_decoder.h"
+#include "font.h"
+#include "text_content.h"
 #include <dcp/interop_subtitle_asset.h>
-#include <iostream>
+#include <dcp/load_font_node.h>
 
+
+using std::dynamic_pointer_cast;
 using std::list;
-using std::cout;
-using boost::shared_ptr;
-using boost::bind;
+using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using std::vector;
+using boost::optional;
+using namespace dcpomatic;
+
 
-DCPSubtitleDecoder::DCPSubtitleDecoder (shared_ptr<const DCPSubtitleContent> content)
+DCPSubtitleDecoder::DCPSubtitleDecoder (shared_ptr<const Film> film, shared_ptr<const DCPSubtitleContent> content)
+       : Decoder (film)
 {
-       subtitle.reset (
-               new SubtitleDecoder (
-                       this,
-                       content->subtitle,
-                       bind (&DCPSubtitleDecoder::image_subtitles_during, this, _1, _2),
-                       bind (&DCPSubtitleDecoder::text_subtitles_during, this, _1, _2)
-                       )
-               );
-
-       shared_ptr<dcp::SubtitleAsset> c (load (content->path (0)));
-       _subtitles = c->subtitles ();
+       /* Load the XML or MXF file */
+       auto const asset = load (content->path(0));
+       asset->fix_empty_font_ids ();
+       _subtitles = asset->subtitles ();
        _next = _subtitles.begin ();
+
+       if (dynamic_pointer_cast<dcp::InteropSubtitleAsset>(asset)) {
+               _standard = dcp::Standard::INTEROP;
+       } else {
+               _standard = dcp::Standard::SMPTE;
+       }
+
+       text.push_back (make_shared<TextDecoder>(this, content->only_text()));
+       update_position();
 }
 
+
 void
 DCPSubtitleDecoder::seek (ContentTime time, bool accurate)
 {
-       subtitle->seek (time, accurate);
+       Decoder::seek (time, accurate);
 
        _next = _subtitles.begin ();
-       list<dcp::SubtitleString>::const_iterator i = _subtitles.begin ();
-       while (i != _subtitles.end() && ContentTime::from_seconds (_next->in().as_seconds()) < time) {
+       auto i = _subtitles.begin ();
+       while (i != _subtitles.end() && ContentTime::from_seconds ((*_next)->in().as_seconds()) < time) {
                ++i;
        }
+
+       update_position();
 }
 
+
 bool
-DCPSubtitleDecoder::pass (PassReason, bool)
+DCPSubtitleDecoder::pass ()
 {
        if (_next == _subtitles.end ()) {
                return true;
@@ -64,52 +81,70 @@ DCPSubtitleDecoder::pass (PassReason, bool)
 
        /* Gather all subtitles with the same time period that are next
           on the list.  We must emit all subtitles for the same time
-          period with the same text_subtitle() call otherwise the
-          SubtitleDecoder will assume there is nothing else at the
-          time of emit the first.
+          period with the same emit*() call otherwise the
+          TextDecoder will assume there is nothing else at the
+          time of emitting the first.
        */
 
-       list<dcp::SubtitleString> s;
-       ContentTimePeriod const p = content_time_period (*_next);
+       vector<dcp::SubtitleString> s;
+       vector<dcp::SubtitleImage> i;
+       auto const p = content_time_period (*_next);
 
        while (_next != _subtitles.end () && content_time_period (*_next) == p) {
-               s.push_back (*_next);
-               ++_next;
+               auto ns = dynamic_pointer_cast<const dcp::SubtitleString>(*_next);
+               if (ns) {
+                       s.push_back (*ns);
+                       ++_next;
+               } else {
+                       /* XXX: perhaps these image subs should also be collected together like the string ones are;
+                          this would need to be done both here and in DCPDecoder.
+                       */
+
+                       auto ni = dynamic_pointer_cast<const dcp::SubtitleImage>(*_next);
+                       if (ni) {
+                               emit_subtitle_image (p, *ni, film()->frame_size(), only_text());
+                               ++_next;
+                       }
+               }
        }
 
-       subtitle->text_subtitle (p, s);
+       only_text()->emit_plain(p, s, _standard);
+
+       update_position();
 
        return false;
 }
 
-list<ContentTimePeriod>
-DCPSubtitleDecoder::image_subtitles_during (ContentTimePeriod, bool) const
-{
-       return list<ContentTimePeriod> ();
-}
 
-list<ContentTimePeriod>
-DCPSubtitleDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
+ContentTimePeriod
+DCPSubtitleDecoder::content_time_period (shared_ptr<const dcp::Subtitle> s) const
 {
-       /* XXX: inefficient */
+       return {
+               ContentTime::from_seconds(s->in().as_seconds()),
+               ContentTime::from_seconds(s->out().as_seconds())
+       };
+}
 
-       list<ContentTimePeriod> d;
 
-       for (list<dcp::SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
-               ContentTimePeriod period = content_time_period (*i);
-               if ((starting && p.contains (period.from)) || (!starting && p.overlaps (period))) {
-                       d.push_back (period);
-               }
+/** @return time of first subtitle, if there is one */
+optional<ContentTime>
+DCPSubtitleDecoder::first () const
+{
+       if (_subtitles.empty()) {
+               return {};
        }
 
-       return d;
+       return ContentTime::from_seconds(_subtitles[0]->in().as_seconds());
 }
 
-ContentTimePeriod
-DCPSubtitleDecoder::content_time_period (dcp::SubtitleString s) const
+
+void
+DCPSubtitleDecoder::update_position()
 {
-       return ContentTimePeriod (
-               ContentTime::from_seconds (s.in().as_seconds ()),
-               ContentTime::from_seconds (s.out().as_seconds ())
-               );
+       if (_next != _subtitles.end()) {
+               only_text()->maybe_set_position(
+                       ContentTime::from_seconds((*_next)->in().as_seconds())
+                       );
+       }
 }
+