Rename Subtitle -> Text
[dcpomatic.git] / src / lib / decoder.h
1 /*
2     Copyright (C) 2012-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 /** @file  src/decoder.h
22  *  @brief Decoder class.
23  */
24
25 #ifndef DCPOMATIC_DECODER_H
26 #define DCPOMATIC_DECODER_H
27
28 #include "types.h"
29 #include "dcpomatic_time.h"
30 #include <boost/utility.hpp>
31
32 class Decoded;
33 class VideoDecoder;
34 class AudioDecoder;
35 class TextDecoder;
36 class DecoderPart;
37
38 /** @class Decoder.
39  *  @brief Parent class for decoders of content.
40  */
41 class Decoder : public boost::noncopyable
42 {
43 public:
44         virtual ~Decoder () {}
45
46         boost::shared_ptr<VideoDecoder> video;
47         boost::shared_ptr<AudioDecoder> audio;
48         boost::shared_ptr<TextDecoder> subtitle;
49
50         /** Do some decoding and perhaps emit video, audio or subtitle data.
51          *  @return true if this decoder will emit no more data unless a seek() happens.
52          */
53         virtual bool pass () = 0;
54         virtual void seek (ContentTime time, bool accurate);
55
56         ContentTime position () const;
57 };
58
59 #endif