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 "position.h"
  28 #include "position_image.h"
  29 #include "types.h"
  30 #include <dcp/colour_conversion.h>
  31 extern "C" {
  32 #include <libavcodec/avcodec.h>
  33 #include <libavfilter/avfilter.h>
  34 }
  35 #include <boost/shared_ptr.hpp>
  36 #include <boost/function.hpp>
  37 #include <string>
  38
  39 class Socket;
  40
  41 class Image
  42 {
  43 public:
  44         Image (AVPixelFormat, dcp::Size, bool);
  45         Image (AVFrame *);
  46         Image (Image const &);
  47         Image (boost::shared_ptr<const Image>, bool);
  48         Image& operator= (Image const &);
  49         ~Image ();
  50
  51         uint8_t * const * data () const;
  52         int * line_size () const;
  53         int const * stride () const;
  54         dcp::Size size () const;
  55         bool aligned () const;
  56
  57         int components () const;
  58         int line_factor (int) const;
  59         int lines (int) const;
  60
  61         boost::shared_ptr<Image> scale (dcp::Size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat, bool aligned) const;
  62         boost::shared_ptr<Image> crop (Crop c, bool aligned) const;
  63         boost::shared_ptr<Image> crop_scale_window (Crop c, dcp::Size, dcp::Size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat, bool aligned) const;
  64
  65         void make_black ();
  66         void make_transparent ();
  67         void alpha_blend (boost::shared_ptr<const Image> image, Position<int> pos);
  68         void copy (boost::shared_ptr<const Image> image, Position<int> pos);
  69         void fade (float);
  70
  71         void read_from_socket (boost::shared_ptr<Socket>);
  72         void write_to_socket (boost::shared_ptr<Socket>) const;
  73
  74         AVPixelFormat pixel_format () const {
  75                 return _pixel_format;
  76         }
  77
  78 private:
  79         friend struct pixel_formats_test;
  80
  81         void allocate ();
  82         void swap (Image &);
  83         float bytes_per_pixel (int) const;
  84         void yuv_16_black (uint16_t, bool);
  85         static uint16_t swap_16 (uint16_t);
  86
  87         dcp::Size _size;
  88         AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
  89         uint8_t** _data; ///< array of pointers to components
  90         int* _line_size; ///< array of sizes of the data in each line, in pixels (without any alignment padding bytes)
  91         int* _stride; ///< array of strides for each line (including any alignment padding bytes)
  92         bool _aligned;
  93 };
  94
  95 extern PositionImage merge (std::list<PositionImage> images);
  96 extern bool operator== (Image const & a, Image const & b);
  97
  98 #endif