More licence fixups.
[libdcp.git] / src / mono_picture_asset_writer.h
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     libdcp is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 /** @file  src/mono_picture_asset_writer.h
21  *  @brief MonoPictureAssetWriter class
22  */
23
24 #ifndef LIBDCP_MONO_PICTURE_ASSET_WRITER_H
25 #define LIBDCP_MONO_PICTURE_ASSET_WRITER_H
26
27 #include "picture_asset_writer.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/utility.hpp>
30 #include <stdint.h>
31 #include <string>
32 #include <fstream>
33
34 namespace dcp {
35
36 /** @class MonoPictureAssetWriter
37  *  @brief A helper class for writing to MonoPictureAssets
38  *
39  *  Objects of this class can only be created with MonoPictureAsset::start_write().
40  *
41  *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
42  *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
43  *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
44  *  throw an exception.
45  */
46 class MonoPictureAssetWriter : public PictureAssetWriter
47 {
48 public:
49         FrameInfo write (uint8_t *, int);
50         void fake_write (int size);
51         bool finalize ();
52
53 private:
54         friend class MonoPictureAsset;
55
56         MonoPictureAssetWriter (PictureAsset *, boost::filesystem::path file, Standard standard, bool);
57         void start (uint8_t *, int);
58
59         /* do this with an opaque pointer so we don't have to include
60            ASDCP headers
61         */
62
63         struct ASDCPState;
64         boost::shared_ptr<ASDCPState> _state;
65 };
66
67 }
68
69 #endif