src/lib/subtitle_decoder.h

   1 /*
   2     Copyright (C) 2013-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 #ifndef DCPOMATIC_SUBTITLE_DECODER_H
  22 #define DCPOMATIC_SUBTITLE_DECODER_H
  23
  24 #include "decoder.h"
  25 #include "rect.h"
  26 #include "types.h"
  27 #include "content_subtitle.h"
  28 #include "decoder_part.h"
  29 #include <dcp/subtitle_string.h>
  30 #include <boost/signals2.hpp>
  31
  32 namespace sub {
  33         class Subtitle;
  34 }
  35
  36 class Image;
  37
  38 class SubtitleDecoder : public DecoderPart
  39 {
  40 public:
  41         /** Second parameter to the _during functions is true if we
  42          *  want only subtitles that start during the period,
  43          *  otherwise we want subtitles that overlap the period.
  44          */
  45         SubtitleDecoder (
  46                 Decoder* parent,
  47                 boost::shared_ptr<const SubtitleContent>,
  48                 boost::shared_ptr<Log> log
  49                 );
  50
  51         boost::optional<ContentTime> position () const {
  52                 return _position;
  53         }
  54
  55         void emit_image (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>);
  56         void emit_text (ContentTimePeriod period, std::list<dcp::SubtitleString>);
  57         void emit_text (ContentTimePeriod period, sub::Subtitle const & subtitle);
  58
  59         boost::shared_ptr<const SubtitleContent> content () const {
  60                 return _content;
  61         }
  62
  63         boost::signals2::signal<void (ContentImageSubtitle)> ImageData;
  64         boost::signals2::signal<void (ContentTextSubtitle)> TextData;
  65
  66 private:
  67         boost::shared_ptr<const SubtitleContent> _content;
  68         boost::optional<ContentTime> _position;
  69 };
  70
  71 #endif