Reword again: Text -> Caption and Plain -> Text.

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

diff --git a/src/lib/encoder.h b/src/lib/encoder.h
index 68a5f6139311ef81672dde9f7237fc77bfac23a4..27fa0745f928b36ace4196d737ec0bede71fdf8d 100644 (file)
--- a/src/lib/encoder.h
+++ b/src/lib/encoder.h
@@ -1,114 +1,57 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-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 DVDOMATIC_ENCODER_H
-#define DVDOMATIC_ENCODER_H
-
-/** @file src/encoder.h
- *  @brief Parent class for classes which can encode video and audio frames.
- */
+#ifndef DCPOMATIC_ENCODER_H
+#define DCPOMATIC_ENCODER_H
 
-#include <boost/shared_ptr.hpp>
-#include <boost/thread/mutex.hpp>
-#include <list>
-#include <stdint.h>
-extern "C" {
-#include <libavutil/samplefmt.h>
-}
-#include "util.h"
-#include "video_sink.h"
-#include "audio_sink.h"
+#include "types.h"
+#include "player_caption.h"
+#include <boost/weak_ptr.hpp>
+#include <boost/signals2.hpp>
 
-class Options;
-class Image;
-class Subtitle;
-class AudioBuffers;
 class Film;
+class Encoder;
+class Player;
+class Job;
+class PlayerVideo;
+class AudioBuffers;
 
-/** @class Encoder
- *  @brief Parent class for classes which can encode video and audio frames.
- *
- *  Video is supplied to process_video as YUV frames, and audio
- *  is supplied as uncompressed PCM in blocks of various sizes.
- *
- *  The subclass is expected to encode the video and/or audio in
- *  some way and write it to disk.
- */
-
-class Encoder : public VideoSink, public AudioSink
+/** @class Encoder */
+class Encoder : public boost::noncopyable
 {
 public:
-       Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
-
-       /** Called to indicate that a processing run is about to begin */
-       virtual void process_begin () {}
+       Encoder (boost::shared_ptr<const Film> film, boost::weak_ptr<Job> job);
+       virtual ~Encoder () {}
 
-       /** Call with a frame of video.
-        *  @param i Video frame image.
-        *  @param s A subtitle that should be on this frame, or 0.
-        */
-       void process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s);
+       virtual void go () = 0;
 
-       /** Call with some audio data */
-       void process_audio (boost::shared_ptr<AudioBuffers>);
-
-       /** Called when a processing run has finished */
-       virtual void process_end () {}
-
-       float current_frames_per_second () const;
-       bool skipping () const;
-       SourceFrame video_frame () const;
+       /** @return the current frame rate over the last short while */
+       virtual float current_rate () const = 0;
+       /** @return the number of frames that are done */
+       virtual Frame frames_done () const = 0;
+       virtual bool finishing () const = 0;
 
 protected:
-
-       /** Called with a frame of video.
-        *  @param i Video frame image.
-        *  @param s A subtitle that should be on this frame, or 0.
-        */
-       virtual void do_process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s) = 0;
-       
-       /** Called with some audio data */
-       virtual void do_process_audio (boost::shared_ptr<AudioBuffers>) = 0;
-       
-       void frame_done ();
-       void frame_skipped ();
-       
-       /** Film that we are encoding */
        boost::shared_ptr<const Film> _film;
-       /** Options */
-       boost::shared_ptr<const Options> _opt;
-
-       /** Mutex for _time_history, _just_skipped and _last_frame */
-       mutable boost::mutex _history_mutex;
-       /** List of the times of completion of the last _history_size frames;
-           first is the most recently completed.
-       */
-       std::list<struct timeval> _time_history;
-       /** Number of frames that we should keep history for */
-       static int const _history_size;
-       /** true if the last frame we processed was skipped (because it was already done) */
-       bool _just_skipped;
-
-       /** Number of video frames received so far */
-       SourceFrame _video_frame;
-       /** Number of audio frames received so far */
-       int64_t _audio_frame;
+       boost::weak_ptr<Job> _job;
+       boost::shared_ptr<Player> _player;
 };
 
 #endif