Comment.
[libdcp.git] / src / picture_asset_writer.h
1 /*
2     Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <stdint.h>
21 #include <string>
22 #include <fstream>
23 #include <boost/shared_ptr.hpp>
24 #include <boost/utility.hpp>
25 #include "metadata.h"
26 #include "types.h"
27
28 namespace libdcp {
29
30 class PictureAsset;     
31
32 /** Information about a single frame (either a monoscopic frame or a left *or* right eye stereoscopic frame) */ 
33 struct FrameInfo
34 {
35         FrameInfo (uint64_t o, uint64_t s, std::string h)
36                 : offset (o)
37                 , size (s)
38                 , hash (h)
39         {}
40
41         FrameInfo (std::istream& s);
42         FrameInfo (FILE *);
43
44         void write (std::ostream& s) const;
45         void write (FILE *) const;
46         
47         uint64_t offset;
48         uint64_t size;
49         std::string hash;
50 };
51
52 class PictureAssetWriter : public boost::noncopyable
53 {
54 public:
55         virtual ~PictureAssetWriter () {}
56         virtual FrameInfo write (uint8_t *, int) = 0;
57         virtual void finalize () = 0;
58         virtual void fake_write (int) = 0;
59         
60 protected:
61         template <class P, class Q>
62         friend void start (PictureAssetWriter *, boost::shared_ptr<P>, Q *, uint8_t *, int);
63
64         PictureAssetWriter (PictureAsset *, bool);
65
66         PictureAsset* _asset;
67         
68         /** Number of picture frames written to the asset so far.  For stereo assets
69          *  this will be incremented for each eye (i.e. there will be twice the number
70          *  of frames as in a mono asset).
71          */
72         int _frames_written;
73         bool _started;
74         /** true if finalize() has been called */
75         bool _finalized;
76         bool _overwrite;
77 };
78
79 }