src/argb_frame.h

   1 /*
   2     Copyright (C) 2012 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/argb_frame.h
  21  *  @brief Container for a single image from a picture asset.
  22  */
  23
  24 #include <stdint.h>
  25
  26 namespace libdcp
  27 {
  28
  29 /** @class ARGBFrame
  30  *  @brief A single frame of picture data held in an ARGB buffer.
  31  *
  32  *  The format of the data is:
  33  *
  34  *  <pre>
  35  *  Byte   /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
  36  *         |(0, 0) Blue|(0, 0) Red  |(0, 0) Blue |(0, 0) Alpha|(0, 1) Blue |(0, 1) Red  | ...
  37  *  </pre>
  38  *
  39  *  So that the first byte is the blue component of the pixel at x=0, y=0, the second
  40  *  is the red component, and so on.
  41  *
  42  *  Lines are packed so that the second row directly follows the first.
  43  */
  44 class ARGBFrame
  45 {
  46 public:
  47         ARGBFrame (int width, int height);
  48         ~ARGBFrame ();
  49
  50         uint8_t* data () const {
  51                 return _data;
  52         }
  53
  54         /** Length of one picture row in bytes */
  55         int stride () const;
  56
  57 private:
  58         int _width;
  59         int _height;
  60         uint8_t* _data;
  61 };
  62
  63 }