Remove unused Processor::process_begin; some docs.
[dcpomatic.git] / src / lib / transcoder.h
1 /*
2     Copyright (C) 2012 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 /** @file  src/transcoder.h
21  *  @brief A class which takes a FilmState and some Options, then uses those to transcode a Film.
22  *
23  *  A decoder is selected according to the content type, and the encoder can be specified
24  *  as a parameter to the constructor.
25  */
26
27 class Film;
28 class Job;
29 class Encoder;
30 class FilmState;
31 class Matcher;
32 class VideoFilter;
33 class Gain;
34 class VideoDecoder;
35 class AudioDecoder;
36 class DelayLine;
37 class Options;
38
39 /** @class Transcoder
40  *  @brief A class which takes a FilmState and some Options, then uses those to transcode a Film.
41  *
42  *  A decoder is selected according to the content type, and the encoder can be specified
43  *  as a parameter to the constructor.
44  */
45 class Transcoder
46 {
47 public:
48         Transcoder (boost::shared_ptr<Film> f, boost::shared_ptr<const Options> o, Job* j, boost::shared_ptr<Encoder> e);
49
50         void go ();
51
52 protected:
53         /** A Job that is running this Transcoder, or 0 */
54         Job* _job;
55         /** The encoder that we will use */
56         boost::shared_ptr<Encoder> _encoder;
57         /** The decoders that we will use */
58         std::pair<boost::shared_ptr<VideoDecoder>, boost::shared_ptr<AudioDecoder> > _decoders;
59         boost::shared_ptr<Matcher> _matcher;
60         boost::shared_ptr<DelayLine> _delay_line;
61         boost::shared_ptr<Gain> _gain;
62 };