src/mxf_writer.h

   1 /*
   2     Copyright (C) 2012-2014 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/mxf_writer.h
  21  *  @brief MXFWriter class.
  22  */
  23
  24 #ifndef LIBDCP_MXF_WRITER_H
  25 #define LIBDCP_MXF_WRITER_H
  26
  27 #include <boost/filesystem.hpp>
  28
  29 namespace dcp {
  30
  31 class MXF;
  32
  33 /** @class MXFWriter
  34  *  @brief Parent class for classes which can write MXF files.
  35  *
  36  *  The MXFWriter lasts for the duration of the write and is then discarded.
  37  *  They can only be created by calling start_write() on an MXF object.
  38  */
  39 class MXFWriter : public boost::noncopyable
  40 {
  41 public:
  42         virtual ~MXFWriter ();
  43         virtual void finalize ();
  44
  45 protected:
  46         MXFWriter (MXF* mxf, boost::filesystem::path file);
  47
  48         /** MXF that we are writing */
  49         MXF* _mxf;
  50         /** File that we are writing to */
  51         boost::filesystem::path _file;
  52         /** Number of `frames' written so far; the definition of a frame
  53          *  varies depending on the subclass.
  54          */
  55         int64_t _frames_written;
  56         /** true if finalize() has been called on this object */
  57         bool _finalized;
  58 };
  59
  60 }
  61
  62 #endif