src/picture_asset_writer.h

   1 /*
   2     Copyright (C) 2012-2013 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 #include <stdint.h>
  21 #include <string>
  22 #include <fstream>
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/utility.hpp>
  25 #include "metadata.h"
  26 #include "types.h"
  27
  28 namespace libdcp {
  29
  30 class PictureAsset;
  31
  32 struct FrameInfo
  33 {
  34         FrameInfo (uint64_t o, uint64_t s, std::string h)
  35                 : offset (o)
  36                 , size (s)
  37                 , hash (h)
  38         {}
  39
  40         FrameInfo (std::istream& s);
  41
  42         void write (std::ostream& s);
  43
  44         uint64_t offset;
  45         uint64_t size;
  46         std::string hash;
  47 };
  48
  49 class PictureAssetWriter : public boost::noncopyable
  50 {
  51 public:
  52         virtual ~PictureAssetWriter () {}
  53         virtual FrameInfo write (uint8_t *, int) = 0;
  54         virtual void finalize () = 0;
  55         virtual void fake_write (int) = 0;
  56
  57 protected:
  58         template <class P, class Q>
  59         friend void start (PictureAssetWriter *, boost::shared_ptr<P>, Q *, uint8_t *, int);
  60
  61         PictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
  62
  63         PictureAsset* _asset;
  64
  65         /** Number of picture frames written to the asset so far.  For stereo assets
  66          *  this will be incremented for each eye (i.e. there will be twice the number
  67          *  of frames as in a mono asset).
  68          */
  69         int _frames_written;
  70         bool _started;
  71         /** true if finalize() has been called */
  72         bool _finalized;
  73         bool _overwrite;
  74         MXFMetadata _metadata;
  75 };
  76
  77 /** A helper class for writing to MonoPictureAssets progressively (i.e. writing frame-by-frame,
  78  *  rather than giving libdcp all the frames in one go).
  79  *
  80  *  Objects of this class can only be created with MonoPictureAsset::start_write().
  81  *
  82  *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
  83  *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
  84  *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
  85  *  throw an exception.
  86  */
  87 class MonoPictureAssetWriter : public PictureAssetWriter
  88 {
  89 public:
  90         FrameInfo write (uint8_t *, int);
  91         void fake_write (int size);
  92         void finalize ();
  93
  94 private:
  95         friend class MonoPictureAsset;
  96
  97         MonoPictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
  98         void start (uint8_t *, int);
  99
 100         /* do this with an opaque pointer so we don't have to include
 101            ASDCP headers
 102         */
 103
 104         struct MonoASDCPState;
 105         boost::shared_ptr<MonoASDCPState> _state;
 106 };
 107
 108 /** A helper class for writing to StereoPictureAssets progressively (i.e. writing frame-by-frame,
 109  *  rather than giving libdcp all the frames in one go).
 110  *
 111  *  Objects of this class can only be created with StereoPictureAsset::start_write().
 112  *
 113  *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
 114  *  (a verbatim .j2c file).  finalize() must be called after the last frame has been written.
 115  *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
 116  *  throw an exception.
 117  */
 118 class StereoPictureAssetWriter : public PictureAssetWriter
 119 {
 120 public:
 121         FrameInfo write (uint8_t *, int);
 122         void fake_write (int size);
 123         void finalize ();
 124
 125 private:
 126         friend class StereoPictureAsset;
 127
 128         StereoPictureAssetWriter (PictureAsset *, bool, MXFMetadata const &);
 129         void start (uint8_t *, int);
 130
 131         /* do this with an opaque pointer so we don't have to include
 132            ASDCP headers
 133         */
 134
 135         struct StereoASDCPState;
 136         boost::shared_ptr<StereoASDCPState> _state;
 137
 138         libdcp::Eye _next_eye;
 139 };
 140
 141 }