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