Comments / tweaks.
[libdcp.git] / src / picture_mxf_writer.h
1 /*
2     Copyright (C) 2012-2014 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 /** @file  src/picture_mxf_writer.h
21  *  @brief PictureMXFWriter and FrameInfo classes.
22  */
23
24 #ifndef LIBDCP_PICTURE_MXF_WRITER_H
25 #define LIBDCP_PICTURE_MXF_WRITER_H
26
27 #include "metadata.h"
28 #include "types.h"
29 #include "mxf_writer.h"
30 #include <boost/shared_ptr.hpp>
31 #include <boost/utility.hpp>
32 #include <stdint.h>
33 #include <string>
34 #include <fstream>
35
36 namespace dcp {
37
38 class PictureMXF;       
39
40 /** @class FrameInfo
41  *  @brief Information about a single frame (either a monoscopic frame or a left *or* right eye stereoscopic frame)
42  */
43 struct FrameInfo
44 {
45         FrameInfo (uint64_t o, uint64_t s, std::string h)
46                 : offset (o)
47                 , size (s)
48                 , hash (h)
49         {}
50
51         FrameInfo (std::istream& s);
52         FrameInfo (FILE *);
53
54         void write (std::ostream& s) const;
55         void write (FILE *) const;
56         
57         uint64_t offset;
58         uint64_t size;
59         std::string hash;
60 };
61
62 /** @class PictureMXFWriter
63  *  @brief Parent class for classes which write picture MXF files.
64  */
65 class PictureMXFWriter : public MXFWriter
66 {
67 public:
68         virtual FrameInfo write (uint8_t *, int) = 0;
69         virtual void fake_write (int) = 0;
70
71 protected:
72         template <class P, class Q>
73         friend void start (PictureMXFWriter *, boost::shared_ptr<P>, Standard, Q *, uint8_t *, int);
74
75         PictureMXFWriter (PictureMXF *, boost::filesystem::path, Standard standard, bool);
76
77         PictureMXF* _picture_mxf;
78         bool _started;
79         Standard _standard;
80         bool _overwrite;
81 };
82
83 }
84
85 #endif