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 extern "C" {
  30 #include <libavcodec/avcodec.h>
  31 #include <libavfilter/avfilter.h>
  32 }
  33 #include "util.h"
  34
  35 class Scaler;
  36 class RGBFrameImage;
  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 (PixelFormat 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 each line, in pixels */
  61         virtual int * line_size () const = 0;
  62
  63         /** @return Size of the image, in pixels */
  64         virtual Size size () const = 0;
  65
  66         int components () const;
  67         int lines (int) const;
  68         boost::shared_ptr<RGBFrameImage> scale_and_convert_to_rgb (Size, int, Scaler const *) const;
  69         boost::shared_ptr<Image> scale (Size, Scaler const *) const;
  70         boost::shared_ptr<SimpleImage> post_process (std::string) const;
  71
  72         void make_black ();
  73
  74         PixelFormat pixel_format () const {
  75                 return _pixel_format;
  76         }
  77
  78 private:
  79         PixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
  80 };
  81
  82 /** @class FilterBufferImage
  83  *  @brief An Image that is held in an AVFilterBufferRef.
  84  */
  85 class FilterBufferImage : public Image
  86 {
  87 public:
  88         FilterBufferImage (PixelFormat, AVFilterBufferRef *);
  89         ~FilterBufferImage ();
  90
  91         uint8_t ** data () const;
  92         int * line_size () const;
  93         Size size () const;
  94
  95 private:
  96         AVFilterBufferRef* _buffer;
  97 };
  98
  99 /** @class SimpleImage
 100  *  @brief An Image for which memory is allocated using a `simple' av_malloc().
 101  */
 102 class SimpleImage : public Image
 103 {
 104 public:
 105         SimpleImage (PixelFormat, Size);
 106         ~SimpleImage ();
 107
 108         uint8_t ** data () const;
 109         int * line_size () const;
 110         Size size () const;
 111
 112 private:
 113         Size _size; ///< size in pixels
 114         uint8_t** _data; ///< array of pointers to components
 115         int* _line_size; ///< array of widths of each line, in bytes
 116 };
 117
 118 /** @class RGBFrameImage
 119  *  @brief An RGB image that is held within an AVFrame.
 120  */
 121 class RGBFrameImage : public Image
 122 {
 123 public:
 124         RGBFrameImage (Size);
 125         ~RGBFrameImage ();
 126
 127         uint8_t ** data () const;
 128         int * line_size () const;
 129         Size size () const;
 130         AVFrame * frame () const {
 131                 return _frame;
 132         }
 133
 134 private:
 135         Size _size;
 136         AVFrame* _frame;
 137         uint8_t* _data;
 138 };
 139
 140 #endif