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 <dcp/subtitle_string.h>
  29
  30 class Image;
  31
  32 class SubtitleDecoder
  33 {
  34 public:
  35         /** Second parameter to the _during functions is true if we
  36          *  want only subtitles that start during the period,
  37          *  otherwise we want subtitles that overlap the period.
  38          */
  39         SubtitleDecoder (
  40                 Decoder* parent,
  41                 boost::shared_ptr<const SubtitleContent>,
  42                 boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
  43                 boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
  44                 );
  45
  46         std::list<ContentImageSubtitle> get_image (ContentTimePeriod period, bool starting, bool accurate);
  47         std::list<ContentTextSubtitle> get_text (ContentTimePeriod period, bool starting, bool accurate);
  48
  49         void seek (ContentTime, bool);
  50
  51         void give_image (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>);
  52         void give_text (ContentTimePeriod period, std::list<dcp::SubtitleString>);
  53
  54         boost::shared_ptr<const SubtitleContent> content () const {
  55                 return _content;
  56         }
  57
  58 private:
  59         Decoder* _parent;
  60         std::list<ContentImageSubtitle> _decoded_image;
  61         std::list<ContentTextSubtitle> _decoded_text;
  62         boost::shared_ptr<const SubtitleContent> _content;
  63
  64         template <class T>
  65         std::list<T> get (std::list<T> const & subs, std::list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate);
  66
  67         boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> _image_during;
  68         boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> _text_during;
  69 };
  70
  71 #endif