CCAP doc tweaks.
[dcpomatic.git] / src / lib / subtitle_decoder.h
1 /*
2     Copyright (C) 2013-2017 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         SubtitleDecoder (
42                 Decoder* parent,
43                 boost::shared_ptr<const SubtitleContent>,
44                 boost::shared_ptr<Log> log,
45                 ContentTime first
46                 );
47
48         ContentTime position () const {
49                 return _position;
50         }
51
52         void emit_image_start (ContentTime from, boost::shared_ptr<Image> image, dcpomatic::Rect<double> rect);
53         void emit_text_start (ContentTime from, std::list<dcp::SubtitleString> s);
54         void emit_text_start (ContentTime from, sub::Subtitle const & subtitle);
55         void emit_text (ContentTimePeriod period, std::list<dcp::SubtitleString> s);
56         void emit_text (ContentTimePeriod period, sub::Subtitle const & subtitle);
57         void emit_stop (ContentTime to);
58
59         void seek ();
60
61         boost::shared_ptr<const SubtitleContent> content () const {
62                 return _content;
63         }
64
65         boost::signals2::signal<void (ContentImageSubtitle)> ImageStart;
66         boost::signals2::signal<void (ContentTextSubtitle)> TextStart;
67         boost::signals2::signal<void (ContentTime)> Stop;
68
69 private:
70         boost::shared_ptr<const SubtitleContent> _content;
71         ContentTime _position;
72 };
73
74 #endif