src/lib/image.h

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file src/image.h
  22  *  @brief A set of classes to describe video images.
  23  */
  24
  25 #ifndef DCPOMATIC_IMAGE_H
  26 #define DCPOMATIC_IMAGE_H
  27
  28
  29 #include "crop.h"
  30 #include "position.h"
  31 #include "position_image.h"
  32 #include "video_range.h"
  33 extern "C" {
  34 #include <libavutil/pixfmt.h>
  35 }
  36 #include <dcp/array_data.h>
  37 #include <dcp/colour_conversion.h>
  38
  39
  40 struct AVFrame;
  41 class Socket;
  42
  43
  44 class Image : public std::enable_shared_from_this<Image>
  45 {
  46 public:
  47         enum class Alignment {
  48                 COMPACT,
  49                 PADDED
  50         };
  51
  52         Image (AVPixelFormat p, dcp::Size s, Alignment alignment);
  53         explicit Image (AVFrame const *, Alignment alignment);
  54         explicit Image (Image const &);
  55         Image (std::shared_ptr<const Image>, Alignment alignment);
  56         Image& operator= (Image const &);
  57         ~Image ();
  58
  59         uint8_t * const * data () const;
  60         /** @return array of sizes of the data in each line, in bytes (not including any alignment padding) */
  61         int const * line_size () const;
  62         /** @return array of sizes of the data in each line, in bytes (including any alignment padding) */
  63         int const * stride () const;
  64         dcp::Size size () const;
  65         Alignment alignment () const;
  66
  67         int planes () const;
  68         int vertical_factor (int) const;
  69         int horizontal_factor (int) const;
  70         dcp::Size sample_size (int) const;
  71         float bytes_per_pixel (int) const;
  72
  73         std::shared_ptr<Image> convert_pixel_format (dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, Alignment alignment, bool fast) const;
  74         std::shared_ptr<Image> scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, Alignment alignment, bool fast) const;
  75         std::shared_ptr<Image> crop_scale_window (
  76                 Crop crop,
  77                 dcp::Size inter_size,
  78                 dcp::Size out_size,
  79                 dcp::YUVToRGB yuv_to_rgb,
  80                 VideoRange video_range,
  81                 AVPixelFormat out_format,
  82                 VideoRange out_video_range,
  83                 Alignment alignment,
  84                 bool fast
  85                 ) const;
  86
  87         void make_black ();
  88         void make_transparent ();
  89         void alpha_blend (std::shared_ptr<const Image> image, Position<int> pos);
  90         void copy (std::shared_ptr<const Image> image, Position<int> pos);
  91         void fade (float);
  92
  93         void read_from_socket (std::shared_ptr<Socket>);
  94         void write_to_socket (std::shared_ptr<Socket>) const;
  95
  96         AVPixelFormat pixel_format () const {
  97                 return _pixel_format;
  98         }
  99
 100         size_t memory_used () const;
 101
 102         static std::shared_ptr<const Image> ensure_alignment (std::shared_ptr<const Image> image, Alignment alignment);
 103
 104 private:
 105         friend struct pixel_formats_test;
 106         friend struct make_part_black_test;
 107
 108         void allocate ();
 109         void swap (Image &);
 110         void make_part_black (int x, int w);
 111         void yuv_16_black (uint16_t, bool);
 112         static uint16_t swap_16 (uint16_t);
 113         void video_range_to_full_range ();
 114
 115         dcp::Size _size;
 116         AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
 117         uint8_t** _data; ///< array of pointers to components
 118         int* _line_size; ///< array of sizes of the data in each line, in bytes (without any alignment padding bytes)
 119         int* _stride; ///< array of strides for each line, in bytes (including any alignment padding bytes)
 120         Alignment _alignment;
 121 };
 122
 123 extern PositionImage merge (std::list<PositionImage> images, Image::Alignment alignment);
 124 extern bool operator== (Image const & a, Image const & b);
 125
 126 #endif