src/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/asset_writer.h
  36  *  @brief AssetWriter class
  37  */
  38
  39
  40 #ifndef LIBDCP_ASSET_WRITER_H
  41 #define LIBDCP_ASSET_WRITER_H
  42
  43
  44 #include "types.h"
  45 #include "crypto_context.h"
  46 #include <boost/filesystem.hpp>
  47
  48
  49 namespace dcp {
  50
  51
  52 class MXF;
  53
  54
  55 /** @class AssetWriter
  56  *  @brief Parent class for classes which can write MXF-based assets.
  57  *
  58  *  The AssetWriter lasts for the duration of the write and is then discarded.
  59  *  They can only be created by calling start_write() on an appropriate Asset object.
  60  */
  61 class AssetWriter
  62 {
  63 public:
  64         AssetWriter (AssetWriter const&) = delete;
  65         AssetWriter& operator= (AssetWriter const&) = delete;
  66
  67         virtual ~AssetWriter () {}
  68
  69         /** @return true if anything was written by this writer */
  70         virtual bool finalize ();
  71
  72         int64_t frames_written () const {
  73                 return _frames_written;
  74         }
  75
  76 protected:
  77         AssetWriter (MXF* mxf, boost::filesystem::path file);
  78
  79         /** MXF that we are writing */
  80         MXF* _mxf = nullptr;
  81         /** File that we are writing to */
  82         boost::filesystem::path _file;
  83         /** Number of `frames' written so far; the definition of a frame
  84          *  varies depending on the subclass.
  85          */
  86         int64_t _frames_written = 0;
  87         /** true if finalize() has been called on this object */
  88         bool _finalized = false;
  89         /** true if something has been written to this asset */
  90         bool _started = false;
  91         std::shared_ptr<EncryptionContext> _crypto_context;
  92 };
  93
  94 }
  95
  96 #endif