Merge branch '1.0' of ssh://main.carlh.net/home/carl/git/libdcp into 1.0

[libdcp.git] / src / picture_asset_writer.h

diff --git a/src/picture_asset_writer.h b/src/picture_asset_writer.h
index c6c00d87b7a72c2496ab133470bb2dc24269c5b2..e263d479f1bb67435f59afefeae06655d4deb668 100644 (file)
--- a/src/picture_asset_writer.h
+++ b/src/picture_asset_writer.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,62 +17,68 @@
 
 */
 
+/** @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 <boost/shared_ptr.hpp>
+#include <boost/utility.hpp>
 #include <stdint.h>
 #include <string>
 #include <fstream>
-#include <boost/shared_ptr.hpp>
-#include <boost/utility.hpp>
-#include "metadata.h"
-#include "types.h"
 
 namespace dcp {
 
-class PictureAsset;    
+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 ()
+               : offset (0)
+               , size (0)
+       {}
+
        FrameInfo (uint64_t o, uint64_t s, std::string h)
                : offset (o)
                , size (s)
                , hash (h)
        {}
 
-       FrameInfo (std::istream& s);
-       FrameInfo (FILE *);
-
-       void write (std::ostream& s) const;
-       void write (FILE *) const;
-       
        uint64_t offset;
        uint64_t size;
        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 void fake_write (int) = 0;
-       
+
 protected:
        template <class P, class Q>
-       friend void start (PictureAssetWriter *, boost::shared_ptr<P>, Q *, uint8_t *, int);
+       friend void start (PictureAssetWriter *, boost::shared_ptr<P>, Standard, Q *, uint8_t *, int);
 
-       PictureAssetWriter (PictureAsset *, bool);
+       PictureAssetWriter (PictureAsset *, boost::filesystem::path, Standard standard, bool);
 
-       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;
+       PictureAsset* _picture_asset;
        bool _started;
-       /** true if finalize() has been called */
-       bool _finalized;
+       Standard _standard;
        bool _overwrite;
 };
 
 }
+
+#endif