Various thread cleanups.
[dcpomatic.git] / src / lib / writer.h
index 0e17f998dfcc1013187b934be38d49aa457a9716..d304133dcb98f2c3d380e191fda78d0d0eef61b1 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 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/>.
 
 */
 
@@ -22,8 +23,9 @@
  */
 
 #include "types.h"
-#include "player_subtitles.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>
@@ -34,10 +36,13 @@ namespace dcp {
        class Data;
 }
 
+namespace dcpomatic {
+       class Font;
+}
+
 class Film;
 class AudioBuffers;
 class Job;
-class Font;
 class ReferencedReelAsset;
 class ReelWriter;
 
@@ -46,6 +51,9 @@ struct QueueItem
 public:
        QueueItem ()
                : size (0)
+               , reel (0)
+               , frame (0)
+               , eyes (EYES_BOTH)
        {}
 
        enum Type {
@@ -81,7 +89,7 @@ bool operator== (QueueItem const & a, QueueItem const & b);
  *  or AudioBuffers objects (containing image or sound data respectively)
  *  and writes them to the assets.
  *
- *  ::write() for Data (picture) 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.
  */
 
@@ -99,9 +107,9 @@ public:
        void fake_write (Frame, Eyes);
        bool can_repeat (Frame) const;
        void repeat (Frame, Eyes);
-       void write (boost::shared_ptr<const AudioBuffers>);
-       void write (PlayerSubtitles subs);
-       void write (std::list<boost::shared_ptr<Font> > fonts);
+       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 ();
 
@@ -112,6 +120,8 @@ private:
        void terminate_thread (bool);
        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;
@@ -119,9 +129,10 @@ private:
        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 */
@@ -138,6 +149,7 @@ private:
         *  ordering
         */
        int _maximum_frames_in_memory;
+       unsigned int _maximum_queue_size;
 
        /** number of FULL written frames */
        int _full_written;
@@ -149,7 +161,10 @@ private:
        */
        int _pushed_to_disk;
 
+       boost::mutex _digest_progresses_mutex;
+       std::map<boost::thread::id, float> _digest_progresses;
+
        std::list<ReferencedReelAsset> _reel_assets;
 
-       std::list<boost::shared_ptr<Font> > _fonts;
+       std::list<boost::shared_ptr<dcpomatic::Font> > _fonts;
 };