FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
imgutils.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg 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 GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * misc image utilities
22  */
23 
24 #include "avassert.h"
25 #include "common.h"
26 #include "imgutils.h"
27 #include "internal.h"
28 #include "intreadwrite.h"
29 #include "log.h"
30 #include "mathematics.h"
31 #include "pixdesc.h"
32 #include "rational.h"
33 
34 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
35  const AVPixFmtDescriptor *pixdesc)
36 {
37  int i;
38  memset(max_pixsteps, 0, 4*sizeof(max_pixsteps[0]));
39  if (max_pixstep_comps)
40  memset(max_pixstep_comps, 0, 4*sizeof(max_pixstep_comps[0]));
41 
42  for (i = 0; i < 4; i++) {
43  const AVComponentDescriptor *comp = &(pixdesc->comp[i]);
44  if ((comp->step_minus1+1) > max_pixsteps[comp->plane]) {
45  max_pixsteps[comp->plane] = comp->step_minus1+1;
46  if (max_pixstep_comps)
47  max_pixstep_comps[comp->plane] = i;
48  }
49  }
50 }
51 
52 static inline
54  int max_step, int max_step_comp,
55  const AVPixFmtDescriptor *desc)
56 {
57  int s, shifted_w, linesize;
58 
59  if (!desc)
60  return AVERROR(EINVAL);
61 
62  if (width < 0)
63  return AVERROR(EINVAL);
64  s = (max_step_comp == 1 || max_step_comp == 2) ? desc->log2_chroma_w : 0;
65  shifted_w = ((width + (1 << s) - 1)) >> s;
66  if (shifted_w && max_step > INT_MAX / shifted_w)
67  return AVERROR(EINVAL);
68  linesize = max_step * shifted_w;
69 
70  if (desc->flags & AV_PIX_FMT_FLAG_BITSTREAM)
71  linesize = (linesize + 7) >> 3;
72  return linesize;
73 }
74 
76 {
77  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
78  int max_step [4]; /* max pixel step for each plane */
79  int max_step_comp[4]; /* the component for each plane which has the max pixel step */
80 
81  if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
82  return AVERROR(EINVAL);
83 
84  av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
85  return image_get_linesize(width, plane, max_step[plane], max_step_comp[plane], desc);
86 }
87 
88 int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
89 {
90  int i, ret;
91  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
92  int max_step [4]; /* max pixel step for each plane */
93  int max_step_comp[4]; /* the component for each plane which has the max pixel step */
94 
95  memset(linesizes, 0, 4*sizeof(linesizes[0]));
96 
97  if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
98  return AVERROR(EINVAL);
99 
100  av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
101  for (i = 0; i < 4; i++) {
102  if ((ret = image_get_linesize(width, i, max_step[i], max_step_comp[i], desc)) < 0)
103  return ret;
104  linesizes[i] = ret;
105  }
106 
107  return 0;
108 }
109 
111  uint8_t *ptr, const int linesizes[4])
112 {
113  int i, total_size, size[4] = { 0 }, has_plane[4] = { 0 };
114 
115  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
116  memset(data , 0, sizeof(data[0])*4);
117 
118  if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
119  return AVERROR(EINVAL);
120 
121  data[0] = ptr;
122  if (linesizes[0] > (INT_MAX - 1024) / height)
123  return AVERROR(EINVAL);
124  size[0] = linesizes[0] * height;
125 
126  if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
128  size[0] = (size[0] + 3) & ~3;
129  data[1] = ptr + size[0]; /* palette is stored here as 256 32 bits words */
130  return size[0] + 256 * 4;
131  }
132 
133  for (i = 0; i < 4; i++)
134  has_plane[desc->comp[i].plane] = 1;
135 
136  total_size = size[0];
137  for (i = 1; i < 4 && has_plane[i]; i++) {
138  int h, s = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
139  data[i] = data[i-1] + size[i-1];
140  h = (height + (1 << s) - 1) >> s;
141  if (linesizes[i] > INT_MAX / h)
142  return AVERROR(EINVAL);
143  size[i] = h * linesizes[i];
144  if (total_size > INT_MAX - size[i])
145  return AVERROR(EINVAL);
146  total_size += size[i];
147  }
148 
149  return total_size;
150 }
151 
153 {
154  int i;
155 
156  for (i = 0; i < 256; i++) {
157  int r, g, b;
158 
159  switch (pix_fmt) {
160  case AV_PIX_FMT_RGB8:
161  r = (i>>5 )*36;
162  g = ((i>>2)&7)*36;
163  b = (i&3 )*85;
164  break;
165  case AV_PIX_FMT_BGR8:
166  b = (i>>6 )*85;
167  g = ((i>>3)&7)*36;
168  r = (i&7 )*36;
169  break;
171  r = (i>>3 )*255;
172  g = ((i>>1)&3)*85;
173  b = (i&1 )*255;
174  break;
176  b = (i>>3 )*255;
177  g = ((i>>1)&3)*85;
178  r = (i&1 )*255;
179  break;
180  case AV_PIX_FMT_GRAY8:
181  r = b = g = i;
182  break;
183  default:
184  return AVERROR(EINVAL);
185  }
186  pal[i] = b + (g << 8) + (r << 16) + (0xFFU << 24);
187  }
188 
189  return 0;
190 }
191 
192 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
193  int w, int h, enum AVPixelFormat pix_fmt, int align)
194 {
195  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
196  int i, ret;
197  uint8_t *buf;
198 
199  if (!desc)
200  return AVERROR(EINVAL);
201 
202  if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
203  return ret;
204  if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, align>7 ? FFALIGN(w, 8) : w)) < 0)
205  return ret;
206 
207  for (i = 0; i < 4; i++)
208  linesizes[i] = FFALIGN(linesizes[i], align);
209 
210  if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, NULL, linesizes)) < 0)
211  return ret;
212  buf = av_malloc(ret + align);
213  if (!buf)
214  return AVERROR(ENOMEM);
215  if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
216  av_free(buf);
217  return ret;
218  }
220  avpriv_set_systematic_pal2((uint32_t*)pointers[1], pix_fmt);
221 
222  if ((desc->flags & AV_PIX_FMT_FLAG_PAL ||
223  desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) &&
224  pointers[1] - pointers[0] > linesizes[0] * h) {
225  /* zero-initialize the padding before the palette */
226  memset(pointers[0] + linesizes[0] * h, 0,
227  pointers[1] - pointers[0] - linesizes[0] * h);
228  }
229 
230  return ret;
231 }
232 
233 typedef struct ImgUtils {
234  const AVClass *class;
236  void *log_ctx;
237 } ImgUtils;
238 
239 static const AVClass imgutils_class = { "IMGUTILS", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(ImgUtils, log_offset), offsetof(ImgUtils, log_ctx) };
240 
241 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
242 {
243  ImgUtils imgutils = { &imgutils_class, log_offset, log_ctx };
244 
245  if ((int)w>0 && (int)h>0 && (w+128)*(uint64_t)(h+128) < INT_MAX/8)
246  return 0;
247 
248  av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
249  return AVERROR(EINVAL);
250 }
251 
252 int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
253 {
254  int64_t scaled_dim;
255 
256  if (sar.den <= 0 || sar.num < 0)
257  return AVERROR(EINVAL);
258 
259  if (!sar.num || sar.num == sar.den)
260  return 0;
261 
262  if (sar.num < sar.den)
263  scaled_dim = av_rescale_rnd(w, sar.num, sar.den, AV_ROUND_ZERO);
264  else
265  scaled_dim = av_rescale_rnd(h, sar.den, sar.num, AV_ROUND_ZERO);
266 
267  if (scaled_dim > 0)
268  return 0;
269 
270  return AVERROR(EINVAL);
271 }
272 
273 void av_image_copy_plane(uint8_t *dst, int dst_linesize,
274  const uint8_t *src, int src_linesize,
275  int bytewidth, int height)
276 {
277  if (!dst || !src)
278  return;
279  av_assert0(abs(src_linesize) >= bytewidth);
280  av_assert0(abs(dst_linesize) >= bytewidth);
281  for (;height > 0; height--) {
282  memcpy(dst, src, bytewidth);
283  dst += dst_linesize;
284  src += src_linesize;
285  }
286 }
287 
288 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
289  const uint8_t *src_data[4], const int src_linesizes[4],
290  enum AVPixelFormat pix_fmt, int width, int height)
291 {
292  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
293 
294  if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
295  return;
296 
297  if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
299  av_image_copy_plane(dst_data[0], dst_linesizes[0],
300  src_data[0], src_linesizes[0],
301  width, height);
302  /* copy the palette */
303  memcpy(dst_data[1], src_data[1], 4*256);
304  } else {
305  int i, planes_nb = 0;
306 
307  for (i = 0; i < desc->nb_components; i++)
308  planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
309 
310  for (i = 0; i < planes_nb; i++) {
311  int h = height;
312  int bwidth = av_image_get_linesize(pix_fmt, width, i);
313  if (bwidth < 0) {
314  av_log(NULL, AV_LOG_ERROR, "av_image_get_linesize failed\n");
315  return;
316  }
317  if (i == 1 || i == 2) {
318  h = FF_CEIL_RSHIFT(height, desc->log2_chroma_h);
319  }
320  av_image_copy_plane(dst_data[i], dst_linesizes[i],
321  src_data[i], src_linesizes[i],
322  bwidth, h);
323  }
324  }
325 }
326 
327 int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
328  const uint8_t *src, enum AVPixelFormat pix_fmt,
329  int width, int height, int align)
330 {
331  int ret, i;
332 
333  ret = av_image_check_size(width, height, 0, NULL);
334  if (ret < 0)
335  return ret;
336 
337  ret = av_image_fill_linesizes(dst_linesize, pix_fmt, width);
338  if (ret < 0)
339  return ret;
340 
341  for (i = 0; i < 4; i++)
342  dst_linesize[i] = FFALIGN(dst_linesize[i], align);
343 
344  return av_image_fill_pointers(dst_data, pix_fmt, height, (uint8_t *)src, dst_linesize);
345 }
346 
348  int width, int height, int align)
349 {
350  uint8_t *data[4];
351  int linesize[4];
352  int ret;
353  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
354  if (!desc)
355  return AVERROR(EINVAL);
356 
357  ret = av_image_check_size(width, height, 0, NULL);
358  if (ret < 0)
359  return ret;
360 
361  // do not include palette for these pseudo-paletted formats
362  if (desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL)
363  return width * height;
364 
365  return av_image_fill_arrays(data, linesize, NULL, pix_fmt,
366  width, height, align);
367 }
368 
369 int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
370  const uint8_t * const src_data[4],
371  const int src_linesize[4],
372  enum AVPixelFormat pix_fmt,
373  int width, int height, int align)
374 {
375  int i, j, nb_planes = 0, linesize[4];
376  int size = av_image_get_buffer_size(pix_fmt, width, height, align);
377  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
378 
379  if (size > dst_size || size < 0 || !desc)
380  return AVERROR(EINVAL);
381 
382  for (i = 0; i < desc->nb_components; i++)
383  nb_planes = FFMAX(desc->comp[i].plane, nb_planes);
384 
385  nb_planes++;
386 
387  av_image_fill_linesizes(linesize, pix_fmt, width);
388  for (i = 0; i < nb_planes; i++) {
389  int h, shift = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
390  const uint8_t *src = src_data[i];
391  h = (height + (1 << shift) - 1) >> shift;
392 
393  for (j = 0; j < h; j++) {
394  memcpy(dst, src, linesize[i]);
395  dst += FFALIGN(linesize[i], align);
396  src += src_linesize[i];
397  }
398  }
399 
400  if (desc->flags & AV_PIX_FMT_FLAG_PAL) {
401  uint32_t *d32 = (uint32_t *)(((size_t)dst + 3) & ~3);
402  for (i = 0; i<256; i++)
403  AV_WL32(d32 + i, AV_RN32(src_data[1] + 4*i));
404  }
405 
406  return size;
407 }
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:115
int plane
Definition: avisynth_c.h:291
#define NULL
Definition: coverity.c:32
int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane)
Compute the size of an image line with format pix_fmt and width width for the plane plane...
Definition: imgutils.c:75
const char * s
Definition: avisynth_c.h:631
static enum AVPixelFormat pix_fmt
static int shift(int a, int b)
Definition: sonic.c:82
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2120
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
int av_image_copy_to_buffer(uint8_t *dst, int dst_size, const uint8_t *const src_data[4], const int src_linesize[4], enum AVPixelFormat pix_fmt, int width, int height, int align)
Copy image data from an image into a buffer.
Definition: imgutils.c:369
int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding rnd)
Rescale a 64-bit integer with specified rounding.
Definition: mathematics.c:63
misc image utilities
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
const char * g
Definition: vf_curves.c:108
int av_image_alloc(uint8_t *pointers[4], int linesizes[4], int w, int h, enum AVPixelFormat pix_fmt, int align)
Allocate an image with size w and h and pixel format pix_fmt, and fill pointers and linesizes accordi...
Definition: imgutils.c:192
int num
numerator
Definition: rational.h:44
static const AVClass imgutils_class
Definition: imgutils.c:239
const char * b
Definition: vf_curves.c:109
int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], const uint8_t *src, enum AVPixelFormat pix_fmt, int width, int height, int align)
Setup the data pointers and linesizes based on the specified image parameters and the provided array...
Definition: imgutils.c:327
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
#define FFALIGN(x, a)
Definition: common.h:71
packed RGB 1:2:1, 8bpp, (msb)1B 2G 1R(lsb)
Definition: pixfmt.h:87
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc)
Compute the max pixel step for each plane of an image with a format described by pixdesc.
Definition: imgutils.c:34
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
Definition: pixdesc.h:100
uint8_t
#define av_malloc(s)
int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt)
Definition: imgutils.c:152
void * log_ctx
Definition: imgutils.c:236
int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
Check if the given sample aspect ratio of an image is valid.
Definition: imgutils.c:252
ptrdiff_t size
Definition: opengl_enc.c:101
#define av_log(a,...)
#define U(x)
Definition: vp56_arith.h:37
int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align)
Return the size in bytes of the amount of data required to store an image with the given parameters...
Definition: imgutils.c:347
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:89
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
const char * r
Definition: vf_curves.c:107
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:123
simple assert() macros that are a bit more flexible than ISO C assert().
#define FFMAX(a, b)
Definition: common.h:64
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image in src_data to dst_data.
Definition: imgutils.c:288
common internal API header
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:241
uint8_t nb_components
The number of components each pixel has, (1-4)
Definition: pixdesc.h:71
packed RGB 1:2:1, 8bpp, (msb)1R 2G 1B(lsb)
Definition: pixfmt.h:90
Round toward zero.
Definition: mathematics.h:71
ret
Definition: avfilter.c:974
#define FF_CEIL_RSHIFT(a, b)
Definition: common.h:57
#define AV_PIX_FMT_FLAG_PSEUDOPAL
The pixel format is "pseudo-paletted".
Definition: pixdesc.h:141
static int image_get_linesize(int width, int plane, int max_step, int max_step_comp, const AVPixFmtDescriptor *desc)
Definition: imgutils.c:53
const AVS_VideoInfo int align
Definition: avisynth_c.h:658
int log_offset
Definition: imgutils.c:235
packed RGB 3:3:2, 8bpp, (msb)2B 3G 3R(lsb)
Definition: pixfmt.h:85
AVS_Value src
Definition: avisynth_c.h:482
int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height, uint8_t *ptr, const int linesizes[4])
Fill plane data pointers for an image with pixel format pix_fmt and height height.
Definition: imgutils.c:110
uint8_t flags
Definition: pixdesc.h:90
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
void * buf
Definition: avisynth_c.h:553
BYTE int const BYTE int int int height
Definition: avisynth_c.h:676
Describe the class of an AVClass context structure.
Definition: log.h:67
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
Fill plane linesizes for an image with pixel format pix_fmt and width width.
Definition: imgutils.c:88
rational number numerator/denominator
Definition: rational.h:43
const uint8_t * d32
Definition: yuv2rgb.c:479
uint16_t step_minus1
Number of elements between 2 horizontally consecutive pixels minus 1.
Definition: pixdesc.h:40
#define AV_RN32(p)
Definition: intreadwrite.h:364
#define AV_PIX_FMT_FLAG_BITSTREAM
All values of a component are bit-wise packed end to end.
Definition: pixdesc.h:119
uint16_t plane
Which of the 4 planes contains the component.
Definition: pixdesc.h:34
Y , 8bpp.
Definition: pixfmt.h:71
common internal and external API header
rational numbers
packed RGB 3:3:2, 8bpp, (msb)2R 3G 3B(lsb)
Definition: pixfmt.h:88
int den
denominator
Definition: rational.h:45
#define av_free(p)
static void comp(unsigned char *dst, int dst_stride, unsigned char *src, int src_stride, int add)
Definition: eamad.c:83
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:273
AVPixelFormat
Pixel format.
Definition: pixfmt.h:61
for(j=16;j >0;--j)
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
static int width