src/lib/image.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/image.h
  21  *  @brief A set of classes to describe video images.
  22  */
  23
  24 #ifndef DCPOMATIC_IMAGE_H
  25 #define DCPOMATIC_IMAGE_H
  26
  27 #include <string>
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/function.hpp>
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libavfilter/avfilter.h>
  33 }
  34 #include "util.h"
  35
  36 class Scaler;
  37 class SimpleImage;
  38
  39 /** @class Image
  40  *  @brief Parent class for wrappers of some image, in some format, that
  41  *  can present a set of components and a size in pixels.
  42  *
  43  *  This class also has some conversion / processing methods.
  44  *
  45  *  The main point of this class (and its subclasses) is to abstract
  46  *  details of FFmpeg's memory management and varying data formats.
  47  */
  48 class Image
  49 {
  50 public:
  51         Image (AVPixelFormat p)
  52                 : _pixel_format (p)
  53         {}
  54
  55         virtual ~Image () {}
  56
  57         /** @return Array of pointers to arrays of the component data */
  58         virtual uint8_t ** data () const = 0;
  59
  60         /** @return Array of sizes of the data in each line, in bytes (without any alignment padding bytes) */
  61         virtual int * line_size () const = 0;
  62
  63         /** @return Array of strides for each line (including any alignment padding bytes) */
  64         virtual int * stride () const = 0;
  65
  66         /** @return Size of the image, in pixels */
  67         virtual libdcp::Size size () const = 0;
  68
  69         virtual bool aligned () const = 0;
  70
  71         int components () const;
  72         int lines (int) const;
  73
  74         boost::shared_ptr<Image> scale_and_convert_to_rgb (libdcp::Size out_size, int padding, Scaler const * scaler, bool aligned) const;
  75         boost::shared_ptr<Image> scale (libdcp::Size, Scaler const *, bool aligned) const;
  76         boost::shared_ptr<Image> post_process (std::string, bool aligned) const;
  77         void alpha_blend (boost::shared_ptr<const Image> image, Position pos);
  78         boost::shared_ptr<Image> crop (Crop c, bool aligned) const;
  79
  80         void make_black ();
  81
  82         void read_from_socket (boost::shared_ptr<Socket>);
  83         void write_to_socket (boost::shared_ptr<Socket>) const;
  84
  85         AVPixelFormat pixel_format () const {
  86                 return _pixel_format;
  87         }
  88
  89 protected:
  90         virtual void swap (Image &);
  91         float bytes_per_pixel (int) const;
  92
  93         friend class pixel_formats_test;
  94
  95 private:
  96         void yuv_16_black (uint16_t);
  97         static uint16_t swap_16 (uint16_t);
  98
  99         AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
 100 };
 101
 102 /** @class SimpleImage
 103  *  @brief An Image for which memory is allocated using a `simple' av_malloc().
 104  */
 105 class SimpleImage : public Image
 106 {
 107 public:
 108         SimpleImage (AVPixelFormat, libdcp::Size, bool);
 109         SimpleImage (AVFrame *);
 110         SimpleImage (SimpleImage const &);
 111         SimpleImage (boost::shared_ptr<const Image>);
 112         SimpleImage& operator= (SimpleImage const &);
 113         ~SimpleImage ();
 114
 115         uint8_t ** data () const;
 116         int * line_size () const;
 117         int * stride () const;
 118         libdcp::Size size () const;
 119         bool aligned () const;
 120
 121 protected:
 122         void allocate ();
 123         void swap (SimpleImage &);
 124
 125 private:
 126         libdcp::Size _size; ///< size in pixels
 127         uint8_t** _data; ///< array of pointers to components
 128         int* _line_size; ///< array of sizes of the data in each line, in pixels (without any alignment padding bytes)
 129         int* _stride; ///< array of strides for each line (including any alignment padding bytes)
 130         bool _aligned;
 131 };
 132
 133 class RGBPlusAlphaImage : public SimpleImage
 134 {
 135 public:
 136         RGBPlusAlphaImage (boost::shared_ptr<const Image>);
 137         ~RGBPlusAlphaImage ();
 138
 139         uint8_t* alpha () const {
 140                 return _alpha;
 141         }
 142
 143 private:
 144         uint8_t* _alpha;
 145 };
 146
 147 #endif