CCAP doc tweaks.

[dcpomatic.git] / src / lib / subtitle_decoder.h

diff --git a/src/lib/subtitle_decoder.h b/src/lib/subtitle_decoder.h
index c25edad493a578160af52ec261214cbcaf0653aa..c1f171b1fbb799ebe0a128ff606b1932df5f0e68 100644 (file)
--- a/src/lib/subtitle_decoder.h
+++ b/src/lib/subtitle_decoder.h
@@ -1,59 +1,74 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #ifndef DCPOMATIC_SUBTITLE_DECODER_H
 #define DCPOMATIC_SUBTITLE_DECODER_H
 
-#include <dcp/subtitle_string.h>
 #include "decoder.h"
 #include "rect.h"
 #include "types.h"
 #include "content_subtitle.h"
+#include "decoder_part.h"
+#include <dcp/subtitle_string.h>
+#include <boost/signals2.hpp>
+
+namespace sub {
+       class Subtitle;
+}
 
-class Film;
-class DCPTimedSubtitle;
 class Image;
 
-class SubtitleDecoder : public virtual Decoder
+class SubtitleDecoder : public DecoderPart
 {
 public:
-       SubtitleDecoder (boost::shared_ptr<const SubtitleContent>);
+       SubtitleDecoder (
+               Decoder* parent,
+               boost::shared_ptr<const SubtitleContent>,
+               boost::shared_ptr<Log> log,
+               ContentTime first
+               );
 
-       std::list<boost::shared_ptr<ContentImageSubtitle> > get_image_subtitles (ContentTimePeriod period);
-       std::list<boost::shared_ptr<ContentTextSubtitle> > get_text_subtitles (ContentTimePeriod period);
+       ContentTime position () const {
+               return _position;
+       }
 
-protected:
-       void seek (ContentTime, bool);
-       
-       void image_subtitle (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>);
-       void text_subtitle (std::list<dcp::SubtitleString>);
+       void emit_image_start (ContentTime from, boost::shared_ptr<Image> image, dcpomatic::Rect<double> rect);
+       void emit_text_start (ContentTime from, std::list<dcp::SubtitleString> s);
+       void emit_text_start (ContentTime from, sub::Subtitle const & subtitle);
+       void emit_text (ContentTimePeriod period, std::list<dcp::SubtitleString> s);
+       void emit_text (ContentTimePeriod period, sub::Subtitle const & subtitle);
+       void emit_stop (ContentTime to);
 
-       std::list<boost::shared_ptr<ContentImageSubtitle> > _decoded_image_subtitles;
-       std::list<boost::shared_ptr<ContentTextSubtitle> > _decoded_text_subtitles;
+       void seek ();
 
-private:
-       template <class T>
-       std::list<boost::shared_ptr<T> > get (std::list<boost::shared_ptr<T> > const & subs, ContentTimePeriod period);
+       boost::shared_ptr<const SubtitleContent> content () const {
+               return _content;
+       }
+
+       boost::signals2::signal<void (ContentImageSubtitle)> ImageStart;
+       boost::signals2::signal<void (ContentTextSubtitle)> TextStart;
+       boost::signals2::signal<void (ContentTime)> Stop;
 
-       virtual bool has_subtitle_during (ContentTimePeriod) const = 0;
-       
-       boost::shared_ptr<const SubtitleContent> _subtitle_content;
+private:
+       boost::shared_ptr<const SubtitleContent> _content;
+       ContentTime _position;
 };
 
 #endif