Use dcp::file_to_string().
[dcpomatic.git] / src / lib / encoder.h
index 20ec8fb162b04f04e0a0ef2496134bc7d9377520..19c1120b360f789fd8af1ef76ccf85a97e494337 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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 "player_text.h"
+#include "types.h"
+#include <boost/signals2.hpp>
+
 
-#include <boost/shared_ptr.hpp>
-#include <boost/thread/mutex.hpp>
-#include <list>
-#include <stdint.h>
-extern "C" {
-#include <libavutil/samplefmt.h>
-}
-#include "util.h"
-
-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.
+ *  @brief Parent class for something that can encode a film into some format
  */
-
 class Encoder
 {
 public:
-       Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
+       Encoder (std::shared_ptr<const Film> film, std::weak_ptr<Job> job);
        virtual ~Encoder () {}
 
-       /** Called to indicate that a processing run is about to begin */
-       virtual void process_begin (int64_t audio_channel_layout) = 0;
+       Encoder (Encoder const&) = delete;
+       Encoder& operator= (Encoder const&) = delete;
 
-       /** Call with a frame of video.
-        *  @param i Video frame image.
-        *  @param f Frame number within the film's source.
-        *  @param s A subtitle that should be on this frame, or 0.
-        */
-       void process_video (boost::shared_ptr<const Image> i, SourceFrame f, boost::shared_ptr<Subtitle> s);
+       virtual void go () = 0;
 
-       /** Call with some audio data */
-       void process_audio (boost::shared_ptr<const AudioBuffers>, int64_t);
+       /** @return the current frame rate over the last short while */
+       virtual boost::optional<float> current_rate () const {
+               return {};
+       }
 
-       /** Called when a processing run has finished */
-       virtual void process_end () = 0;
-
-       float current_frames_per_second () const;
-       bool skipping () const;
-       SourceFrame last_frame () const;
+       /** @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 f Frame number within the film's source.
-        *  @param s A subtitle that should be on this frame, or 0.
-        */
-       virtual void do_process_video (boost::shared_ptr<const Image> i, SourceFrame f, boost::shared_ptr<Subtitle> s) = 0;
-       
-       /** Called with some audio data */
-       virtual void do_process_audio (boost::shared_ptr<const AudioBuffers>) = 0;
-       
-       void frame_done (SourceFrame n);
-       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;
-       /** Source index of the last frame to be processed */
-       SourceFrame _last_frame;
+       std::shared_ptr<const Film> _film;
+       std::weak_ptr<Job> _job;
+       std::shared_ptr<Player> _player;
 };
 
+
 #endif