src/openjpeg_image.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/openjpeg_image.h
  36  *  @brief OpenJPEGImage class
  37  */
  38
  39
  40 #include "util.h"
  41
  42
  43 struct opj_image;
  44 typedef struct opj_image opj_image_t;
  45
  46
  47 namespace dcp {
  48
  49
  50 /** @class OpenJPEGImage
  51  *  @brief A wrapper of libopenjpeg's opj_image_t
  52  */
  53 class OpenJPEGImage
  54 {
  55 public:
  56         /** Construct an OpenJPEGImage, taking ownership of the opj_image_t */
  57         explicit OpenJPEGImage (opj_image_t *);
  58
  59         explicit OpenJPEGImage (OpenJPEGImage const & other);
  60
  61         /** Construct a new OpenJPEGImage with undefined contents
  62          *  @param size Size for the frame in pixels
  63          */
  64         explicit OpenJPEGImage (Size);
  65
  66         /** @param data_16 XYZ/RGB image data in packed 16:16:16, 48bpp with
  67          *  the 2-byte value for each component stored as little-endian
  68          */
  69         OpenJPEGImage (uint8_t const * in_16, dcp::Size size, int stride);
  70
  71         ~OpenJPEGImage ();
  72
  73         /** @param c Component index (0, 1 or 2)
  74          *  @return Pointer to the data for component c.
  75          */
  76         int* data (int) const;
  77
  78         /** @return Size of the image in pixels */
  79         Size size () const;
  80
  81         int precision (int component) const;
  82         bool srgb () const;
  83         int factor (int component) const;
  84
  85         /** @return Pointer to opj_image_t struct.  The caller
  86          *  must not delete this.
  87          */
  88         opj_image_t* opj_image () const {
  89                 return _opj_image;
  90         }
  91
  92 private:
  93         void create (Size size);
  94
  95         opj_image_t* _opj_image = nullptr; ///< opj_image_t that we are managing
  96 };
  97
  98
  99 }