src/picture_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/picture_asset_writer.h
  36  *  @brief PictureAssetWriter and FrameInfo classes.
  37  */
  38
  39
  40 #ifndef LIBDCP_PICTURE_ASSET_WRITER_H
  41 #define LIBDCP_PICTURE_ASSET_WRITER_H
  42
  43
  44 #include "metadata.h"
  45 #include "types.h"
  46 #include "asset_writer.h"
  47 #include <memory>
  48 #include <boost/utility.hpp>
  49 #include <stdint.h>
  50 #include <string>
  51
  52
  53 namespace dcp {
  54
  55
  56 class PictureAsset;
  57
  58
  59 /** @class FrameInfo
  60  *  @brief Information about a single frame (either a monoscopic frame or a left *or* right eye stereoscopic frame)
  61  */
  62 struct FrameInfo
  63 {
  64         FrameInfo () {}
  65
  66         FrameInfo (uint64_t o, uint64_t s, std::string h)
  67                 : offset (o)
  68                 , size (s)
  69                 , hash (h)
  70         {}
  71
  72         uint64_t offset = 0;
  73         uint64_t size = 0;
  74         std::string hash;
  75 };
  76
  77
  78 /** @class PictureAssetWriter
  79  *  @brief Parent class for classes which write picture assets.
  80  */
  81 class PictureAssetWriter : public AssetWriter
  82 {
  83 public:
  84         virtual FrameInfo write (uint8_t const *, int) = 0;
  85         virtual void fake_write (int) = 0;
  86
  87 protected:
  88         template <class P, class Q>
  89         friend void start (PictureAssetWriter *, std::shared_ptr<P>, Q *, uint8_t const *, int);
  90
  91         PictureAssetWriter (PictureAsset *, boost::filesystem::path, bool);
  92
  93         PictureAsset* _picture_asset;
  94         bool _overwrite = false;
  95 };
  96
  97
  98 }
  99
 100
 101 #endif