2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
34 /** @file src/asset_writer.h
35 * @brief AssetWriter class.
38 #ifndef LIBDCP_ASSET_WRITER_H
39 #define LIBDCP_ASSET_WRITER_H
42 #include "crypto_context.h"
43 #include <boost/filesystem.hpp>
44 #include <boost/noncopyable.hpp>
50 /** @class AssetWriter
51 * @brief Parent class for classes which can write MXF-based assets.
53 * The AssetWriter lasts for the duration of the write and is then discarded.
54 * They can only be created by calling start_write() on an appropriate Asset object.
56 class AssetWriter : public boost::noncopyable
59 virtual ~AssetWriter () {}
60 virtual bool finalize ();
62 int64_t frames_written () const {
63 return _frames_written;
67 AssetWriter (MXF* mxf, boost::filesystem::path file);
69 /** MXF that we are writing */
71 /** File that we are writing to */
72 boost::filesystem::path _file;
73 /** Number of `frames' written so far; the definition of a frame
74 * varies depending on the subclass.
76 int64_t _frames_written;
77 /** true if finalize() has been called on this object */
79 /** true if something has been written to this asset */
81 boost::shared_ptr<EncryptionContext> _crypto_context;