429b46a18c4f1d60191e2b40585f9abdbda04939
[dcpomatic.git] / src / lib / encoder.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 #ifndef DVDOMATIC_ENCODER_H
21 #define DVDOMATIC_ENCODER_H
22
23 /** @file src/encoder.h
24  *  @brief Parent class for classes which can encode video and audio frames.
25  */
26
27 #include <boost/shared_ptr.hpp>
28 #include <boost/thread/mutex.hpp>
29 #include <boost/thread/condition.hpp>
30 #include <boost/thread.hpp>
31 #include <boost/optional.hpp>
32 #include <list>
33 #include <stdint.h>
34 extern "C" {
35 #include <libavutil/samplefmt.h>
36 }
37 #ifdef HAVE_SWRESAMPLE
38 extern "C" {
39 #include <libswresample/swresample.h>
40 }
41 #endif
42 #include "util.h"
43 #include "video_sink.h"
44 #include "audio_sink.h"
45
46 class Image;
47 class Subtitle;
48 class AudioBuffers;
49 class Film;
50 class ServerDescription;
51 class DCPVideoFrame;
52 class EncodedData;
53 class Writer;
54
55 /** @class Encoder
56  *  @brief Encoder to J2K and WAV for DCP.
57  *
58  *  Video is supplied to process_video as YUV frames, and audio
59  *  is supplied as uncompressed PCM in blocks of various sizes.
60  */
61
62 class Encoder : public VideoSink, public AudioSink
63 {
64 public:
65         Encoder (boost::shared_ptr<Film> f);
66         virtual ~Encoder ();
67
68         /** Called to indicate that a processing run is about to begin */
69         virtual void process_begin ();
70
71         /** Call with a frame of video.
72          *  @param i Video frame image.
73          *  @param same true if i is the same as the last time we were called.
74          *  @param s A subtitle that should be on this frame, or 0.
75          */
76         void process_video (boost::shared_ptr<Image> i, bool same, boost::shared_ptr<Subtitle> s);
77
78         /** Call with some audio data */
79         void process_audio (boost::shared_ptr<AudioBuffers>);
80
81         /** Called when a processing run has finished */
82         virtual void process_end ();
83
84         float current_frames_per_second () const;
85         bool skipping () const;
86         int video_frames_out () const;
87
88 private:
89         
90         void frame_done ();
91         void frame_skipped ();
92         
93         void write_audio (boost::shared_ptr<const AudioBuffers> audio);
94
95         void encoder_thread (ServerDescription *);
96         void terminate_worker_threads ();
97
98         /** Film that we are encoding */
99         boost::shared_ptr<Film> _film;
100
101         /** Mutex for _time_history, _just_skipped and _last_frame */
102         mutable boost::mutex _history_mutex;
103         /** List of the times of completion of the last _history_size frames;
104             first is the most recently completed.
105         */
106         std::list<struct timeval> _time_history;
107         /** Number of frames that we should keep history for */
108         static int const _history_size;
109         /** true if the last frame we processed was skipped (because it was already done) */
110         bool _just_skipped;
111
112         /** Number of video frames received so far */
113         SourceFrame _video_frames_in;
114         /** Number of video frames written for the DCP so far */
115         int _video_frames_out;
116
117 #if HAVE_SWRESAMPLE     
118         SwrContext* _swr_context;
119 #endif
120
121         bool _have_a_real_frame;
122         bool _terminate_encoder;
123         std::list<boost::shared_ptr<DCPVideoFrame> > _encode_queue;
124         std::list<boost::thread *> _worker_threads;
125         mutable boost::mutex _worker_mutex;
126         boost::condition _worker_condition;
127
128         boost::shared_ptr<Writer> _writer;
129 };
130
131 #endif