Tidying.
[libdcp.git] / src / stereo_picture_asset_writer.h
1 /*
2     Copyright (C) 2012-2021 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     In addition, as a special exception, the copyright holders give
20     permission to link the code of portions of this program with the
21     OpenSSL library under certain conditions as described in each
22     individual source file, and distribute linked combinations
23     including the two.
24
25     You must obey the GNU General Public License in all respects
26     for all of the code used other than OpenSSL.  If you modify
27     file(s) with this exception, you may extend this exception to your
28     version of the file(s), but you are not obligated to do so.  If you
29     do not wish to do so, delete this exception statement from your
30     version.  If you delete this exception statement from all source
31     files in the program, then also delete it here.
32 */
33
34
35 /** @file  src/stereo_picture_asset_writer.h
36  *  @brief StereoPictureAssetWriter class
37  */
38
39
40 #include "picture_asset_writer.h"
41 #include "types.h"
42 #include <memory>
43 #include <stdint.h>
44 #include <string>
45
46
47 namespace dcp {
48
49
50 /** @class StereoPictureAssetWriter
51  *  @brief A helper class for writing to StereoPictureAssets.
52  *
53  *  Objects of this class can only be created with StereoPictureAsset::start_write().
54  *
55  *  Frames can be written to the StereoPictureAsset by calling write() with a JPEG2000 image
56  *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
57  *  The action of finalize() can't be done in StereoPictureAssetWriter's destructor as it may
58  *  throw an exception.
59  */
60 class StereoPictureAssetWriter : public PictureAssetWriter
61 {
62 public:
63         /** Write a frame for one eye.  Frames must be written left, then right, then left etc.
64          *  @param data JPEG2000 data.
65          *  @param size Size of data.
66          */
67         FrameInfo write (uint8_t const * data, int size);
68         void fake_write (int size);
69         bool finalize ();
70
71 private:
72         friend class StereoPictureAsset;
73
74         StereoPictureAssetWriter (PictureAsset *, boost::filesystem::path file, bool);
75         void start (uint8_t const *, int);
76
77         /* do this with an opaque pointer so we don't have to include
78            ASDCP headers
79         */
80
81         struct ASDCPState;
82         std::shared_ptr<ASDCPState> _state;
83
84         dcp::Eye _next_eye = Eye::LEFT;
85 };
86
87
88 }