No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / encoder.h
index 590b8aaa9a25e8189102d5105fbefc6a599507bc..7e6fc4f308c226b767f3dcac42154d7b415a0d00 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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
+#ifndef DCPOMATIC_ENCODER_H
+#define DCPOMATIC_ENCODER_H
 
-/** @file src/encoder.h
- *  @brief Parent class for classes which can encode video and audio frames.
+/** @file  src/encoder.h
+ *  @brief Encoder class.
  */
 
+#include "util.h"
+#include "cross.h"
+#include "exception_store.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/thread/mutex.hpp>
+#include <boost/thread/condition.hpp>
+#include <boost/thread.hpp>
+#include <boost/optional.hpp>
+#include <boost/signals2.hpp>
 #include <list>
 #include <stdint.h>
-extern "C" {
-#include <libavutil/samplefmt.h>
-}
-
-class Options;
-class Image;
-class Subtitle;
-class AudioBuffers;
+
 class Film;
+class EncodeServerDescription;
+class DCPVideo;
+class Writer;
+class Job;
+class PlayerVideo;
 
 /** @class Encoder
- *  @brief Parent class for classes which can encode video and audio frames.
+ *  @brief Class to manage encoding to JPEG2000.
  *
- *  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.
+ *  This class keeps a queue of frames to be encoded and distributes
+ *  the work around threads and encoding servers.
  */
 
-class Encoder
+class Encoder : public boost::noncopyable, public ExceptionStore
 {
 public:
-       Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
+       Encoder (boost::shared_ptr<const Film>, boost::shared_ptr<Writer>);
+       virtual ~Encoder ();
 
        /** Called to indicate that a processing run is about to begin */
-       virtual void process_begin (int64_t audio_channel_layout) = 0;
-
-       /** Called with a frame of video.
-        *  @param i Video frame image.
-        *  @param f Frame number within the film.
-        *  @param s A subtitle that should be on this frame, or 0.
-        */
-       virtual void process_video (boost::shared_ptr<const Image> i, int f, boost::shared_ptr<Subtitle> s) = 0;
+       void begin ();
 
-       /** Called with some audio data.
-        *  @param d Array of pointers to floating point sample data for each channel.
-        *  @param s Number of frames (ie number of samples in each channel)
+       /** Called to pass in zero or more bits of video to be encoded
+        *  as the next DCP frame.
         */
-       virtual void process_audio (boost::shared_ptr<const AudioBuffers>) = 0;
+       void encode (std::list<boost::shared_ptr<PlayerVideo> > f);
 
        /** Called when a processing run has finished */
-       virtual void process_end () = 0;
+       void end ();
+
+       float current_encoding_rate () const;
+       int video_frames_out () const;
+
+private:
+
+       void enqueue (boost::shared_ptr<PlayerVideo> f);
+       void frame_done ();
 
-       float current_frames_per_second () const;
-       bool skipping () const;
-       int last_frame () const;
+       void encoder_thread (boost::optional<EncodeServerDescription>);
+       void terminate_threads ();
+       void servers_list_changed ();
 
-protected:
-       void frame_done (int 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;
+       /** Mutex for _time_history and _video_frames_enqueued */
+       mutable boost::mutex _state_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;
-       /** Index of the last frame to be processed */
-       int _last_frame;
+       /** Current DCP frame index */
+       Frame _position;
+
+       /* XXX: probably should be atomic */
+       bool _terminate_enqueue;
+       bool _terminate_encoding;
+       /** Mutex for _threads */
+       mutable boost::mutex _threads_mutex;
+       std::list<boost::thread *> _threads;
+       mutable boost::mutex _queue_mutex;
+       std::list<boost::shared_ptr<DCPVideo> > _queue;
+       /** condition to manage thread wakeups when we have nothing to do */
+       boost::condition _empty_condition;
+       /** condition to manage thread wakeups when we have too much to do */
+       boost::condition _full_condition;
+
+       boost::shared_ptr<Writer> _writer;
+       Waker _waker;
+
+       boost::shared_ptr<PlayerVideo> _last_player_video;
+
+       boost::signals2::scoped_connection _server_found_connection;
 };
 
 #endif