src/mono_picture_frame.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/mono_picture_frame.h
  36  *  @brief MonoPictureFrame class
  37  */
  38
  39
  40 #ifndef LIBDCP_MONO_PICTURE_FRAME_H
  41 #define LIBDCP_MONO_PICTURE_FRAME_H
  42
  43
  44 #include "asset_reader.h"
  45 #include "types.h"
  46 #include <boost/filesystem.hpp>
  47 #include <boost/optional.hpp>
  48 #include <memory>
  49 #include <stdint.h>
  50 #include <string>
  51
  52
  53 namespace ASDCP {
  54         namespace JP2K {
  55                 class FrameBuffer;
  56                 class MXFReader;
  57         }
  58         class AESDecContext;
  59 }
  60
  61
  62 namespace dcp {
  63
  64
  65 class OpenJPEGImage;
  66
  67
  68 /** @class MonoPictureFrame
  69  *  @brief A single frame of a 2D (monoscopic) picture asset
  70  */
  71 class MonoPictureFrame : public Data
  72 {
  73 public:
  74         /** Make a picture frame from a JPEG2000 file.
  75          *  @param path Path to JPEG2000 file.
  76          */
  77         explicit MonoPictureFrame (boost::filesystem::path path);
  78         MonoPictureFrame (uint8_t const * data, int size);
  79
  80         MonoPictureFrame (MonoPictureFrame const&) = delete;
  81         MonoPictureFrame& operator= (MonoPictureFrame const&) = delete;
  82
  83         /** @param reduce a factor by which to reduce the resolution
  84          *  of the image, expressed as a power of two (pass 0 for no
  85          *  reduction).
  86          */
  87         std::shared_ptr<OpenJPEGImage> xyz_image (int reduce = 0) const;
  88
  89         /** @return Pointer to JPEG2000 data */
  90         uint8_t const * data () const;
  91
  92         /** @return Pointer to JPEG2000 data */
  93         uint8_t* data ();
  94
  95         /** @return Size of JPEG2000 data in bytes */
  96         int size () const;
  97
  98 private:
  99         /* XXX: this is a bit of a shame, but I tried friend MonoPictureAssetReader and it's
 100            rejected by some (seemingly older) GCCs.
 101         */
 102         friend class AssetReader<ASDCP::JP2K::MXFReader, MonoPictureFrame>;
 103
 104         MonoPictureFrame (ASDCP::JP2K::MXFReader* reader, int n, std::shared_ptr<DecryptionContext>);
 105
 106         std::shared_ptr<ASDCP::JP2K::FrameBuffer> _buffer;
 107 };
 108
 109 }
 110
 111 #endif