src/lib/text_decoder.h

   1 /*
   2     Copyright (C) 2013-2021 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
  22 #ifndef DCPOMATIC_CAPTION_DECODER_H
  23 #define DCPOMATIC_CAPTION_DECODER_H
  24
  25
  26 #include "content_text.h"
  27 #include "decoder.h"
  28 #include "decoder_part.h"
  29 #include "rect.h"
  30 #include "content_text.h"
  31 #include "types.h"
  32 #include <dcp/subtitle_standard.h>
  33 #include <dcp/subtitle_string.h>
  34 #include <boost/signals2.hpp>
  35
  36
  37 namespace sub {
  38         class Subtitle;
  39 }
  40
  41 class Image;
  42
  43
  44 class TextDecoder : public DecoderPart
  45 {
  46 public:
  47         TextDecoder (Decoder* parent, std::shared_ptr<const TextContent>);
  48
  49         boost::optional<dcpomatic::ContentTime> position (std::shared_ptr<const Film>) const override {
  50                 return _position;
  51         }
  52
  53         void emit_bitmap_start (ContentBitmapText const& bitmap);
  54         void emit_bitmap (dcpomatic::ContentTimePeriod period, std::shared_ptr<const Image> image, dcpomatic::Rect<double> rect);
  55         void emit_plain_start(dcpomatic::ContentTime from, std::vector<dcp::SubtitleString> s, dcp::SubtitleStandard valign_standard);
  56         void emit_plain_start (dcpomatic::ContentTime from, sub::Subtitle const & subtitle);
  57         void emit_plain(dcpomatic::ContentTimePeriod period, std::vector<dcp::SubtitleString> s, dcp::SubtitleStandard valign_standard);
  58         void emit_plain (dcpomatic::ContentTimePeriod period, sub::Subtitle const & subtitle);
  59         void emit_stop (dcpomatic::ContentTime to);
  60
  61         void maybe_set_position (dcpomatic::ContentTime position);
  62
  63         void seek () override;
  64
  65         std::shared_ptr<const TextContent> content () const {
  66                 return _content;
  67         }
  68
  69         static std::string remove_invalid_characters_for_xml(std::string text);
  70
  71         boost::signals2::signal<void (ContentBitmapText)> BitmapStart;
  72         boost::signals2::signal<void (ContentStringText)> PlainStart;
  73         boost::signals2::signal<void (dcpomatic::ContentTime)> Stop;
  74
  75 private:
  76         std::shared_ptr<const TextContent> _content;
  77         boost::optional<dcpomatic::ContentTime> _position;
  78 };
  79
  80
  81 #endif