Tidying.
[libdcp.git] / src / picture_asset_writer.h
index 6f33d3b693cf40c563595a2489d504b176b09b45..2fcd2de1036273f9e537cfe193de9d941eb27d39 100644 (file)
 /*
-    Copyright (C) 2012-2013 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 libdcp.
+
+    libdcp 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,
+    libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
-#include <stdint.h>
-#include <string>
-#include <fstream>
-#include <boost/shared_ptr.hpp>
-#include <boost/utility.hpp>
+
+/** @file  src/picture_asset_writer.h
+ *  @brief PictureAssetWriter and FrameInfo classes.
+ */
+
+
+#ifndef LIBDCP_PICTURE_ASSET_WRITER_H
+#define LIBDCP_PICTURE_ASSET_WRITER_H
+
+
 #include "metadata.h"
 #include "types.h"
+#include "asset_writer.h"
+#include <memory>
+#include <boost/utility.hpp>
+#include <stdint.h>
+#include <string>
 
-namespace libdcp {
 
-class PictureAsset;    
+namespace dcp {
 
+
+class PictureAsset;
+
+
+/** @class FrameInfo
+ *  @brief Information about a single frame (either a monoscopic frame or a left *or* right eye stereoscopic frame)
+ */
 struct FrameInfo
 {
+       FrameInfo () {}
+
        FrameInfo (uint64_t o, uint64_t s, std::string h)
                : offset (o)
                , size (s)
                , hash (h)
        {}
 
-       FrameInfo (std::istream& s);
-
-       void write (std::ostream& s);
-       
-       uint64_t offset;
-       uint64_t size;
+       uint64_t offset = 0;
+       uint64_t size = 0;
        std::string hash;
 };
 
-class PictureAssetWriter : public boost::noncopyable
+
+/** @class PictureAssetWriter
+ *  @brief Parent class for classes which write picture assets.
+ */
+class PictureAssetWriter : public AssetWriter
 {
 public:
-       virtual ~PictureAssetWriter () {}
-       virtual FrameInfo write (uint8_t *, int) = 0;
-       virtual void finalize () = 0;
+       virtual FrameInfo write (uint8_t const *, int) = 0;
        virtual void fake_write (int) = 0;
-       
+
 protected:
        template <class P, class Q>
-       friend void start (PictureAssetWriter *, boost::shared_ptr<P>, Q *, uint8_t *, int);
-
-       PictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
-
-       PictureAsset* _asset;
-       
-       /** Number of picture frames written to the asset so far.  For stereo assets
-        *  this will be incremented for each eye (i.e. there will be twice the number
-        *  of frames as in a mono asset).
-        */
-       int _frames_written;
-       bool _started;
-       /** true if finalize() has been called */
-       bool _finalized;
-       bool _overwrite;
-       MXFMetadata _metadata;
-};
-
-/** A helper class for writing to MonoPictureAssets progressively (i.e. writing frame-by-frame,
- *  rather than giving libdcp all the frames in one go).
- *
- *  Objects of this class can only be created with MonoPictureAsset::start_write().
- *
- *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
- *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
- *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
- *  throw an exception.
- */
-class MonoPictureAssetWriter : public PictureAssetWriter
-{
-public:
-       FrameInfo write (uint8_t *, int);
-       void fake_write (int size);
-       void finalize ();
-
-private:
-       friend class MonoPictureAsset;
-
-       MonoPictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
-       void start (uint8_t *, int);
-
-       /* do this with an opaque pointer so we don't have to include
-          ASDCP headers
-       */
-          
-       struct MonoASDCPState;
-       boost::shared_ptr<MonoASDCPState> _state;
-};
+       friend void start (PictureAssetWriter *, std::shared_ptr<P>, Q *, uint8_t const *, int);
 
-/** A helper class for writing to StereoPictureAssets progressively (i.e. writing frame-by-frame,
- *  rather than giving libdcp all the frames in one go).
- *
- *  Objects of this class can only be created with StereoPictureAsset::start_write().
- *
- *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
- *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
- *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
- *  throw an exception.
- */
-class StereoPictureAssetWriter : public PictureAssetWriter
-{
-public:
-       FrameInfo write (uint8_t *, int);
-       void fake_write (int size);
-       void finalize ();
+       PictureAssetWriter (PictureAsset *, boost::filesystem::path, bool);
 
-private:
-       friend class StereoPictureAsset;
+       PictureAsset* _picture_asset;
+       bool _overwrite = false;
+};
 
-       StereoPictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
-       void start (uint8_t *, int);
 
-       /* do this with an opaque pointer so we don't have to include
-          ASDCP headers
-       */
-          
-       struct StereoASDCPState;
-       boost::shared_ptr<StereoASDCPState> _state;
+}
 
-       libdcp::Eye _next_eye;
-};
 
-}
+#endif