src/xyz_frame.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/xyz_frame.h
  21  *  @brief XZYFrame class.
  22  */
  23
  24 #include "util.h"
  25 #include <openjpeg.h>
  26
  27 namespace dcp {
  28
  29 /** @class XYZFrame
  30  *  @brief An image in XYZ colour.
  31  *
  32  *  This class is a thin wrapper of libopenjpeg's opj_image_t.
  33  */
  34 class XYZFrame : public boost::noncopyable
  35 {
  36 public:
  37         XYZFrame (opj_image_t *);
  38         XYZFrame (Size);
  39         ~XYZFrame ();
  40
  41         int* data (int) const;
  42         dcp::Size size () const;
  43
  44         /** @return Pointer to opj_image_t struct.  The caller
  45          *  must not delete this.
  46          */
  47         opj_image_t* opj_image () const {
  48                 return _opj_image;
  49         }
  50
  51 private:
  52         opj_image_t* _opj_image; ///< opj_image_t that we are managing
  53 };
  54
  55 }