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 DVDOMATIC_IMAGE_H
  25 #define DVDOMATIC_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 #include "ffmpeg_compatibility.h"
  36
  37 class Scaler;
  38 class RGBFrameImage;
  39 class SimpleImage;
  40
  41 /** @class Image
  42  *  @brief Parent class for wrappers of some image, in some format, that
  43  *  can present a set of components and a size in pixels.
  44  *
  45  *  This class also has some conversion / processing methods.
  46  *
  47  *  The main point of this class (and its subclasses) is to abstract
  48  *  details of FFmpeg's memory management and varying data formats.
  49  */
  50 class Image
  51 {
  52 public:
  53         Image (AVPixelFormat p)
  54                 : _pixel_format (p)
  55         {}
  56
  57         virtual ~Image () {}
  58
  59         /** @return Array of pointers to arrays of the component data */
  60         virtual uint8_t ** data () const = 0;
  61
  62         /** @return Array of sizes of the data in each line, in bytes (without any alignment padding bytes) */
  63         virtual int * line_size () const = 0;
  64
  65         /** @return Array of strides for each line (including any alignment padding bytes) */
  66         virtual int * stride () const = 0;
  67
  68         /** @return Size of the image, in pixels */
  69         virtual libdcp::Size size () const = 0;
  70
  71         virtual bool aligned () const = 0;
  72
  73         int components () const;
  74         int lines (int) const;
  75
  76         boost::shared_ptr<Image> scale_and_convert_to_rgb (libdcp::Size out_size, int padding, Scaler const * scaler, bool aligned) const;
  77         boost::shared_ptr<Image> scale (libdcp::Size, Scaler const *, bool aligned) const;
  78         boost::shared_ptr<Image> post_process (std::string, bool aligned) const;
  79         void alpha_blend (boost::shared_ptr<const Image> image, Position pos);
  80         boost::shared_ptr<Image> crop (Crop c, bool aligned) const;
  81
  82         void make_black ();
  83
  84         void read_from_socket (boost::shared_ptr<Socket>);
  85         void write_to_socket (boost::shared_ptr<Socket>) const;
  86
  87         AVPixelFormat pixel_format () const {
  88                 return _pixel_format;
  89         }
  90
  91 protected:
  92         virtual void swap (Image &);
  93         float bytes_per_pixel (int) const;
  94
  95 private:
  96         AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
  97 };
  98
  99 /** @class FilterBufferImage
 100  *  @brief An Image that is held in an AVFilterBufferRef.
 101  */
 102 class FilterBufferImage : public Image
 103 {
 104 public:
 105         FilterBufferImage (AVPixelFormat, AVFilterBufferRef *);
 106         ~FilterBufferImage ();
 107
 108         uint8_t ** data () const;
 109         int * line_size () const;
 110         int * stride () const;
 111         libdcp::Size size () const;
 112         bool aligned () const;
 113
 114 private:
 115         /* Not allowed */
 116         FilterBufferImage (FilterBufferImage const &);
 117         FilterBufferImage& operator= (FilterBufferImage const &);
 118
 119         AVFilterBufferRef* _buffer;
 120 };
 121
 122 /** @class SimpleImage
 123  *  @brief An Image for which memory is allocated using a `simple' av_malloc().
 124  */
 125 class SimpleImage : public Image
 126 {
 127 public:
 128         SimpleImage (AVPixelFormat, libdcp::Size, bool);
 129         SimpleImage (SimpleImage const &);
 130         SimpleImage& operator= (SimpleImage const &);
 131         ~SimpleImage ();
 132
 133         uint8_t ** data () const;
 134         int * line_size () const;
 135         int * stride () const;
 136         libdcp::Size size () const;
 137         bool aligned () const;
 138
 139 protected:
 140         void allocate ();
 141         void swap (SimpleImage &);
 142
 143 private:
 144         libdcp::Size _size; ///< size in pixels
 145         uint8_t** _data; ///< array of pointers to components
 146         int* _line_size; ///< array of sizes of the data in each line, in pixels (without any alignment padding bytes)
 147         int* _stride; ///< array of strides for each line (including any alignment padding bytes)
 148         bool _aligned;
 149 };
 150
 151 class RGBPlusAlphaImage : public SimpleImage
 152 {
 153 public:
 154         RGBPlusAlphaImage (boost::shared_ptr<const Image>);
 155         ~RGBPlusAlphaImage ();
 156
 157         uint8_t* alpha () const {
 158                 return _alpha;
 159         }
 160
 161 private:
 162         uint8_t* _alpha;
 163 };
 164
 165 #endif