2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 * @brief A set of classes to describe video images.
25 #ifndef DCPOMATIC_IMAGE_H
26 #define DCPOMATIC_IMAGE_H
29 #include "position_image.h"
32 #include <libavutil/pixfmt.h>
34 #include <dcp/array_data.h>
35 #include <dcp/colour_conversion.h>
40 class Image : public std::enable_shared_from_this<Image>
43 Image (AVPixelFormat p, dcp::Size s, bool aligned);
44 explicit Image (AVFrame const *);
45 explicit Image (Image const &);
46 Image (std::shared_ptr<const Image>, bool);
47 Image& operator= (Image const &);
50 uint8_t * const * data () const;
51 /** @return array of sizes of the data in each line, in bytes (not including any alignment padding) */
52 int const * line_size () const;
53 /** @return array of sizes of the data in each line, in bytes (including any alignment padding) */
54 int const * stride () const;
55 dcp::Size size () const;
56 bool aligned () const;
59 int vertical_factor (int) const;
60 int horizontal_factor (int) const;
61 dcp::Size sample_size (int) const;
62 float bytes_per_pixel (int) const;
64 std::shared_ptr<Image> convert_pixel_format (dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast) const;
65 std::shared_ptr<Image> scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast) const;
66 std::shared_ptr<Image> crop_scale_window (
70 dcp::YUVToRGB yuv_to_rgb,
71 VideoRange video_range,
72 AVPixelFormat out_format,
73 VideoRange out_video_range,
79 void make_transparent ();
80 void alpha_blend (std::shared_ptr<const Image> image, Position<int> pos);
81 void copy (std::shared_ptr<const Image> image, Position<int> pos);
84 void read_from_socket (std::shared_ptr<Socket>);
85 void write_to_socket (std::shared_ptr<Socket>) const;
87 AVPixelFormat pixel_format () const {
91 size_t memory_used () const;
93 dcp::ArrayData as_png () const;
95 void png_error (char const * message);
97 static std::shared_ptr<const Image> ensure_aligned (std::shared_ptr<const Image> image);
100 friend struct pixel_formats_test;
101 friend struct make_part_black_test;
105 void make_part_black (int x, int w);
106 void yuv_16_black (uint16_t, bool);
107 static uint16_t swap_16 (uint16_t);
108 void video_range_to_full_range ();
111 AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
112 uint8_t** _data; ///< array of pointers to components
113 int* _line_size; ///< array of sizes of the data in each line, in bytes (without any alignment padding bytes)
114 int* _stride; ///< array of strides for each line, in bytes (including any alignment padding bytes)
118 extern PositionImage merge (std::list<PositionImage> images);
119 extern bool operator== (Image const & a, Image const & b);