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>
36 #include <boost/shared_ptr.hpp>
37 #include <boost/enable_shared_from_this.hpp>
42 class Image : public boost::enable_shared_from_this<Image>
45 Image (AVPixelFormat p, dcp::Size s, bool aligned);
46 explicit Image (AVFrame *);
47 explicit Image (Image const &);
48 Image (boost::shared_ptr<const Image>, bool);
49 Image& operator= (Image const &);
52 uint8_t * const * data () const;
53 /** @return array of sizes of the data in each line, in bytes (not including any alignment padding) */
54 int const * line_size () const;
55 /** @return array of sizes of the data in each line, in bytes (including any alignment padding) */
56 int const * stride () const;
57 dcp::Size size () const;
58 bool aligned () const;
61 int vertical_factor (int) const;
62 int horizontal_factor (int) const;
63 dcp::Size sample_size (int) const;
64 float bytes_per_pixel (int) const;
66 boost::shared_ptr<Image> convert_pixel_format (dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast) const;
67 boost::shared_ptr<Image> scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast) const;
68 boost::shared_ptr<Image> crop_scale_window (
72 dcp::YUVToRGB yuv_to_rgb,
73 VideoRange video_range,
74 AVPixelFormat out_format,
75 VideoRange out_video_range,
81 void make_transparent ();
82 void alpha_blend (boost::shared_ptr<const Image> image, Position<int> pos);
83 void copy (boost::shared_ptr<const Image> image, Position<int> pos);
85 void video_range_to_full_range ();
87 void read_from_socket (boost::shared_ptr<Socket>);
88 void write_to_socket (boost::shared_ptr<Socket>) const;
90 AVPixelFormat pixel_format () const {
94 size_t memory_used () const;
96 dcp::ArrayData as_png () const;
98 void png_error (char const * message);
100 static boost::shared_ptr<const Image> ensure_aligned (boost::shared_ptr<const Image> image);
103 friend struct pixel_formats_test;
107 void make_part_black (int x, int w);
108 void yuv_16_black (uint16_t, bool);
109 static uint16_t swap_16 (uint16_t);
112 AVPixelFormat _pixel_format; ///< FFmpeg's way of describing the pixel format of this Image
113 uint8_t** _data; ///< array of pointers to components
114 int* _line_size; ///< array of sizes of the data in each line, in bytes (without any alignment padding bytes)
115 int* _stride; ///< array of strides for each line, in bytes (including any alignment padding bytes)
119 extern PositionImage merge (std::list<PositionImage> images);
120 extern bool operator== (Image const & a, Image const & b);