Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / writer.h
index 2ddf70380181534d8f49b1326479dc5270b61f7a..d09b062649f94ea55f74ad563847f54118330772 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 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/>.
 
 */
 
  *  @brief Writer class.
  */
 
-#include <list>
+#include "types.h"
+#include "player_text.h"
+#include "exception_store.h"
+#include "dcp_text_track.h"
 #include <boost/shared_ptr.hpp>
+#include <boost/weak_ptr.hpp>
 #include <boost/thread.hpp>
 #include <boost/thread/condition.hpp>
-#include "exceptions.h"
-#include "types.h"
+#include <list>
+
+namespace dcp {
+       class Data;
+}
+
+namespace dcpomatic {
+       class Font;
+}
 
 class Film;
-class EncodedData;
 class AudioBuffers;
 class Job;
-
-namespace dcp {
-       class MonoPictureMXF;
-       class MonoPictureMXFWriter;
-       class StereoPictureMXF;
-       class StereoPictureMXFWriter;
-       class PictureMXF;
-       class PictureMXFWriter;
-       class SoundMXF;
-       class SoundMXFWriter;
-}
+class ReferencedReelAsset;
+class ReelWriter;
 
 struct QueueItem
 {
 public:
+       QueueItem ()
+               : size (0)
+               , reel (0)
+               , frame (0)
+               , eyes (EYES_BOTH)
+       {}
+
        enum Type {
                /** a normal frame with some JPEG200 data */
                FULL,
@@ -55,14 +64,18 @@ public:
                    state but we use the data that is already on disk.
                */
                FAKE,
+               REPEAT,
        } type;
 
        /** encoded data for FULL */
-       boost::shared_ptr<const EncodedData> encoded;
+       boost::optional<dcp::Data> encoded;
        /** size of data for FAKE */
        int size;
-       /** frame index */
+       /** reel index */
+       size_t reel;
+       /** frame index within the reel */
        int frame;
+       /** eyes for FULL, FAKE and REPEAT */
        Eyes eyes;
 };
 
@@ -70,13 +83,13 @@ bool operator< (QueueItem const & a, QueueItem const & b);
 bool operator== (QueueItem const & a, QueueItem const & b);
 
 /** @class Writer
- *  @brief Class to manage writing JPEG2000 and audio data to MXFs on disk.
+ *  @brief Class to manage writing JPEG2000 and audio data to assets on disk.
  *
- *  This class creates sound and picture MXFs, then takes EncodedData
+ *  This class creates sound and picture assets, then takes Data
  *  or AudioBuffers objects (containing image or sound data respectively)
- *  and writes them to the MXFs.
+ *  and writes them to the assets.
  *
- *  ::write() for EncodedData can be called out of order, and the Writer
+ *  write() for Data (picture) can be called out of order, and the Writer
  *  will sort it out.  write() for AudioBuffers must be called in order.
  */
 
@@ -86,30 +99,40 @@ public:
        Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
        ~Writer ();
 
-       bool can_fake_write (int) const;
-       
-       void write (boost::shared_ptr<const EncodedData>, int, Eyes);
-       void fake_write (int, Eyes);
-       void write (boost::shared_ptr<const AudioBuffers>);
-       void repeat (int f, Eyes);
+       void start ();
+
+       bool can_fake_write (Frame) const;
+
+       void write (dcp::Data, Frame, Eyes);
+       void fake_write (Frame, Eyes);
+       bool can_repeat (Frame) const;
+       void repeat (Frame, Eyes);
+       void write (boost::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
+       void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
+       void write (std::list<boost::shared_ptr<dcpomatic::Font> > fonts);
+       void write (ReferencedReelAsset asset);
        void finish ();
 
-private:
+       void set_encoder_threads (int threads);
 
+private:
        void thread ();
        void terminate_thread (bool);
-       void check_existing_picture_mxf ();
-       bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
        bool have_sequenced_image_at_queue_head ();
+       size_t video_reel (int frame) const;
+       void set_digest_progress (Job* job, float progress);
+       void write_cover_sheet ();
 
        /** our Film */
        boost::shared_ptr<const Film> _film;
        boost::weak_ptr<Job> _job;
-       /** the first frame index that does not already exist in our MXF */
-       int _first_nonexistant_frame;
+       std::vector<ReelWriter> _reels;
+       std::vector<ReelWriter>::iterator _audio_reel;
+       std::vector<ReelWriter>::iterator _subtitle_reel;
+       std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
 
-       /** our thread, or 0 */
-       boost::thread* _thread;
+       /** our thread */
+       boost::thread _thread;
        /** true if our thread should finish */
        bool _finish;
        /** queue of things to write to disk */
@@ -117,32 +140,55 @@ private:
        /** number of FULL frames whose JPEG200 data is currently held in RAM */
        int _queued_full_in_memory;
        /** mutex for thread state */
-       mutable boost::mutex _mutex;
+       mutable boost::mutex _state_mutex;
        /** 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;
-       /** the data of the last written frame, or 0 if there isn't one */
-       boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
-       /** the index of the last written frame */
-       int _last_written_frame;
-       Eyes _last_written_eyes;
        /** maximum number of frames to hold in memory, for when we are managing
-           ordering
-       */
-       static const int _maximum_frames_in_memory;
+        *  ordering
+        */
+       int _maximum_frames_in_memory;
+       unsigned int _maximum_queue_size;
+
+       class LastWritten
+       {
+       public:
+               LastWritten()
+                       : _frame(-1)
+                       , _eyes(EYES_RIGHT)
+               {}
+
+               /** @return true if qi is the next item after this one */
+               bool next (QueueItem qi) const;
+               void update (QueueItem qi);
+
+               int frame () const {
+                       return _frame;
+               }
+
+       private:
+               int _frame;
+               Eyes _eyes;
+       };
+
+       /** The last frame written to each reel */
+       std::vector<LastWritten> _last_written;
 
        /** number of FULL written frames */
        int _full_written;
        /** number of FAKE written frames */
        int _fake_written;
+       int _repeat_written;
        /** number of frames pushed to disk and then recovered
            due to the limit of frames to be held in memory.
        */
        int _pushed_to_disk;
-       
-       boost::shared_ptr<dcp::PictureMXF> _picture_mxf;
-       boost::shared_ptr<dcp::PictureMXFWriter> _picture_mxf_writer;
-       boost::shared_ptr<dcp::SoundMXF> _sound_mxf;
-       boost::shared_ptr<dcp::SoundMXFWriter> _sound_mxf_writer;
+
+       boost::mutex _digest_progresses_mutex;
+       std::map<boost::thread::id, float> _digest_progresses;
+
+       std::list<ReferencedReelAsset> _reel_assets;
+
+       std::list<boost::shared_ptr<dcpomatic::Font> > _fonts;
 };