src/lib/subtitle_decoder.h

   1 /*
   2     Copyright (C) 2013 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 : public virtual Decoder
  32 {
  33 public:
  34         SubtitleDecoder (boost::shared_ptr<const SubtitleContent>);
  35
  36         std::list<ContentImageSubtitle> get_image_subtitles (ContentTimePeriod period, bool starting);
  37         std::list<ContentTextSubtitle> get_text_subtitles (ContentTimePeriod period, bool starting);
  38
  39 protected:
  40         void seek (ContentTime, bool);
  41
  42         void image_subtitle (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>);
  43         void text_subtitle (ContentTimePeriod period, std::list<dcp::SubtitleString>);
  44
  45         std::list<ContentImageSubtitle> _decoded_image_subtitles;
  46         std::list<ContentTextSubtitle> _decoded_text_subtitles;
  47
  48 private:
  49         template <class T>
  50         std::list<T> get (std::list<T> const & subs, std::list<ContentTimePeriod> const & sp, ContentTimePeriod period, bool starting);
  51
  52         /** @param starting true if we want only subtitles that start during the period, otherwise
  53          *  we want subtitles that overlap the period.
  54          */
  55         virtual std::list<ContentTimePeriod> image_subtitles_during (ContentTimePeriod period, bool starting) const = 0;
  56         virtual std::list<ContentTimePeriod> text_subtitles_during (ContentTimePeriod period, bool starting) const = 0;
  57
  58         boost::shared_ptr<const SubtitleContent> _subtitle_content;
  59 };
  60
  61 #endif