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