src/argb_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/argb_frame.h
  21  *  @brief ARGBFrame class.
  22  */
  23
  24 #include "util.h"
  25 #include <stdint.h>
  26
  27 namespace dcp
  28 {
  29
  30 /** @class ARGBFrame
  31  *  @brief A single frame of picture data held in an ARGB buffer.
  32  *
  33  *  The format of the data is:
  34  *
  35  *  <pre>
  36  *  Byte   /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
  37  *         |(0, 0) Blue|(0, 0)Green |(0, 0) Red  |(0, 0) Alpha|(0, 1) Blue |(0, 1) Green| ...
  38  *  </pre>
  39  *
  40  *  So that the first byte is the blue component of the pixel at x=0, y=0, the second
  41  *  is the green component, and so on.
  42  *
  43  *  Lines are packed so that the second row directly follows the first.
  44  */
  45 class ARGBFrame : boost::noncopyable
  46 {
  47 public:
  48         ARGBFrame (Size size);
  49         ~ARGBFrame ();
  50
  51         /** @return pointer to the image data */
  52         uint8_t* data () const {
  53                 return _data;
  54         }
  55
  56         /** @return length of one picture row in bytes */
  57         int stride () const;
  58
  59         /** @return size of the picture in pixels */
  60         Size size () const {
  61                 return _size;
  62         }
  63
  64 private:
  65         Size _size;     ///< frame size in pixels
  66         uint8_t* _data; ///< pointer to image data
  67 };
  68
  69 }