src/lib/subtitle_decoder.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_SUBTITLE_DECODER_H
  21 #define DCPOMATIC_SUBTITLE_DECODER_H
  22
  23 #include "decoder.h"
  24 #include "rect.h"
  25 #include "types.h"
  26 #include "content_subtitle.h"
  27 #include <dcp/subtitle_string.h>
  28
  29 class Image;
  30
  31 class SubtitleDecoder
  32 {
  33 public:
  34         /** Second parameter to the _during functions is true if we
  35          *  want only subtitles that start during the period,
  36          *  otherwise we want subtitles that overlap the period.
  37          */
  38         SubtitleDecoder (
  39                 Decoder* parent,
  40                 boost::shared_ptr<const SubtitleContent>,
  41                 boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> image_during,
  42                 boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> text_during
  43                 );
  44
  45         std::list<ContentImageSubtitle> get_image (ContentTimePeriod period, bool starting, bool accurate);
  46         std::list<ContentTextSubtitle> get_text (ContentTimePeriod period, bool starting, bool accurate);
  47
  48         void seek (ContentTime, bool);
  49
  50         void give_image (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>);
  51         void give_text (ContentTimePeriod period, std::list<dcp::SubtitleString>);
  52
  53         boost::shared_ptr<const SubtitleContent> content () const {
  54                 return _content;
  55         }
  56
  57 private:
  58         Decoder* _parent;
  59         std::list<ContentImageSubtitle> _decoded_image;
  60         std::list<ContentTextSubtitle> _decoded_text;
  61         boost::shared_ptr<const SubtitleContent> _content;
  62
  63         template <class T>
  64         std::list<T> get (std::list<T> const & subs, std::list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting, bool accurate);
  65
  66         boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> _image_during;
  67         boost::function<std::list<ContentTimePeriod> (ContentTimePeriod, bool)> _text_during;
  68 };
  69
  70 #endif