Add frames_written().
[libdcp.git] / src / asset_writer.h
1 /*
2     Copyright (C) 2012-2015 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/asset_writer.h
21  *  @brief AssetWriter class.
22  */
23
24 #ifndef LIBDCP_ASSET_WRITER_H
25 #define LIBDCP_ASSET_WRITER_H
26
27 #include <boost/filesystem.hpp>
28
29 namespace ASDCP {
30         class AESEncContext;
31 }
32
33 namespace dcp {
34
35 class MXF;
36
37 /** @class AssetWriter
38  *  @brief Parent class for classes which can write MXF-based assets.
39  *
40  *  The AssetWriter lasts for the duration of the write and is then discarded.
41  *  They can only be created by calling start_write() on an appropriate Asset object.
42  */
43 class AssetWriter : public boost::noncopyable
44 {
45 public:
46         virtual ~AssetWriter ();
47         virtual bool finalize ();
48
49         int64_t frames_written () const {
50                 return _frames_written;
51         }
52
53 protected:
54         AssetWriter (MXF* mxf, boost::filesystem::path file);
55
56         /** MXF that we are writing */
57         MXF* _mxf;
58         /** File that we are writing to */
59         boost::filesystem::path _file;
60         /** Number of `frames' written so far; the definition of a frame
61          *  varies depending on the subclass.
62          */
63         int64_t _frames_written;
64         /** true if finalize() has been called on this object */
65         bool _finalized;
66         /** true if something has been written to this asset */
67         bool _started;
68         ASDCP::AESEncContext* _encryption_context;
69 };
70
71 }
72
73 #endif