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 > max_pixsteps[comp->plane]) {
45  max_pixsteps[comp->plane] = comp->step;
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 {
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;
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  data[1] = ptr + size[0]; /* palette is stored here as 256 32 bits words */
129  return size[0] + 256 * 4;
130  }
131 
132  for (i = 0; i < 4; i++)
133  has_plane[desc->comp[i].plane] = 1;
134 
135  total_size = size[0];
136  for (i = 1; i < 4 && has_plane[i]; i++) {
137  int h, s = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
138  data[i] = data[i-1] + size[i-1];
139  h = (height + (1 << s) - 1) >> s;
140  if (linesizes[i] > INT_MAX / h)
141  return AVERROR(EINVAL);
142  size[i] = h * linesizes[i];
143  if (total_size > INT_MAX - size[i])
144  return AVERROR(EINVAL);
145  total_size += size[i];
146  }
147 
148  return total_size;
149 }
150 
152 {
153  int i;
154 
155  for (i = 0; i < 256; i++) {
156  int r, g, b;
157 
158  switch (pix_fmt) {
159  case AV_PIX_FMT_RGB8:
160  r = (i>>5 )*36;
161  g = ((i>>2)&7)*36;
162  b = (i&3 )*85;
163  break;
164  case AV_PIX_FMT_BGR8:
165  b = (i>>6 )*85;
166  g = ((i>>3)&7)*36;
167  r = (i&7 )*36;
168  break;
170  r = (i>>3 )*255;
171  g = ((i>>1)&3)*85;
172  b = (i&1 )*255;
173  break;
175  b = (i>>3 )*255;
176  g = ((i>>1)&3)*85;
177  r = (i&1 )*255;
178  break;
179  case AV_PIX_FMT_GRAY8:
180  r = b = g = i;
181  break;
182  default:
183  return AVERROR(EINVAL);
184  }
185  pal[i] = b + (g << 8) + (r << 16) + (0xFFU << 24);
186  }
187 
188  return 0;
189 }
190 
191 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
192  int w, int h, enum AVPixelFormat pix_fmt, int align)
193 {
194  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
195  int i, ret;
196  uint8_t *buf;
197 
198  if (!desc)
199  return AVERROR(EINVAL);
200 
201  if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
202  return ret;
203  if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, align>7 ? FFALIGN(w, 8) : w)) < 0)
204  return ret;
205 
206  for (i = 0; i < 4; i++)
207  linesizes[i] = FFALIGN(linesizes[i], align);
208 
209  if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, NULL, linesizes)) < 0)
210  return ret;
211  buf = av_malloc(ret + align);
212  if (!buf)
213  return AVERROR(ENOMEM);
214  if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
215  av_free(buf);
216  return ret;
217  }
218  if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
219  avpriv_set_systematic_pal2((uint32_t*)pointers[1], pix_fmt);
220  if (align < 4) {
221  av_log(NULL, AV_LOG_ERROR, "Formats with a palette require a minimum alignment of 4\n");
222  return AVERROR(EINVAL);
223  }
224  }
225 
226  if ((desc->flags & AV_PIX_FMT_FLAG_PAL ||
227  desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) &&
228  pointers[1] - pointers[0] > linesizes[0] * h) {
229  /* zero-initialize the padding before the palette */
230  memset(pointers[0] + linesizes[0] * h, 0,
231  pointers[1] - pointers[0] - linesizes[0] * h);
232  }
233 
234  return ret;
235 }
236 
237 typedef struct ImgUtils {
238  const AVClass *class;
240  void *log_ctx;
241 } ImgUtils;
242 
243 static const AVClass imgutils_class = {
244  .class_name = "IMGUTILS",
245  .item_name = av_default_item_name,
246  .version = LIBAVUTIL_VERSION_INT,
247  .log_level_offset_offset = offsetof(ImgUtils, log_offset),
248  .parent_log_context_offset = offsetof(ImgUtils, log_ctx),
249 };
250 
251 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
252 {
253  ImgUtils imgutils = {
254  .class = &imgutils_class,
255  .log_offset = log_offset,
256  .log_ctx = log_ctx,
257  };
258 
259  if ((int)w>0 && (int)h>0 && (w+128)*(uint64_t)(h+128) < INT_MAX/8)
260  return 0;
261 
262  av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
263  return AVERROR(EINVAL);
264 }
265 
266 int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
267 {
268  int64_t scaled_dim;
269 
270  if (sar.den <= 0 || sar.num < 0)
271  return AVERROR(EINVAL);
272 
273  if (!sar.num || sar.num == sar.den)
274  return 0;
275 
276  if (sar.num < sar.den)
277  scaled_dim = av_rescale_rnd(w, sar.num, sar.den, AV_ROUND_ZERO);
278  else
279  scaled_dim = av_rescale_rnd(h, sar.den, sar.num, AV_ROUND_ZERO);
280 
281  if (scaled_dim > 0)
282  return 0;
283 
284  return AVERROR(EINVAL);
285 }
286 
287 void av_image_copy_plane(uint8_t *dst, int dst_linesize,
288  const uint8_t *src, int src_linesize,
289  int bytewidth, int height)
290 {
291  if (!dst || !src)
292  return;
293  av_assert0(abs(src_linesize) >= bytewidth);
294  av_assert0(abs(dst_linesize) >= bytewidth);
295  for (;height > 0; height--) {
296  memcpy(dst, src, bytewidth);
297  dst += dst_linesize;
298  src += src_linesize;
299  }
300 }
301 
302 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
303  const uint8_t *src_data[4], const int src_linesizes[4],
304  enum AVPixelFormat pix_fmt, int width, int height)
305 {
306  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
307 
308  if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
309  return;
310 
311  if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
313  av_image_copy_plane(dst_data[0], dst_linesizes[0],
314  src_data[0], src_linesizes[0],
315  width, height);
316  /* copy the palette */
317  memcpy(dst_data[1], src_data[1], 4*256);
318  } else {
319  int i, planes_nb = 0;
320 
321  for (i = 0; i < desc->nb_components; i++)
322  planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
323 
324  for (i = 0; i < planes_nb; i++) {
325  int h = height;
326  int bwidth = av_image_get_linesize(pix_fmt, width, i);
327  if (bwidth < 0) {
328  av_log(NULL, AV_LOG_ERROR, "av_image_get_linesize failed\n");
329  return;
330  }
331  if (i == 1 || i == 2) {
332  h = AV_CEIL_RSHIFT(height, desc->log2_chroma_h);
333  }
334  av_image_copy_plane(dst_data[i], dst_linesizes[i],
335  src_data[i], src_linesizes[i],
336  bwidth, h);
337  }
338  }
339 }
340 
341 int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
342  const uint8_t *src, enum AVPixelFormat pix_fmt,
343  int width, int height, int align)
344 {
345  int ret, i;
346 
347  ret = av_image_check_size(width, height, 0, NULL);
348  if (ret < 0)
349  return ret;
350 
351  ret = av_image_fill_linesizes(dst_linesize, pix_fmt, width);
352  if (ret < 0)
353  return ret;
354 
355  for (i = 0; i < 4; i++)
356  dst_linesize[i] = FFALIGN(dst_linesize[i], align);
357 
358  return av_image_fill_pointers(dst_data, pix_fmt, height, (uint8_t *)src, dst_linesize);
359 }
360 
362  int width, int height, int align)
363 {
364  uint8_t *data[4];
365  int linesize[4];
366  int ret;
367  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
368  if (!desc)
369  return AVERROR(EINVAL);
370 
371  ret = av_image_check_size(width, height, 0, NULL);
372  if (ret < 0)
373  return ret;
374 
375  // do not include palette for these pseudo-paletted formats
376  if (desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL)
377  return FFALIGN(width, align) * height;
378 
379  return av_image_fill_arrays(data, linesize, NULL, pix_fmt,
380  width, height, align);
381 }
382 
383 int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
384  const uint8_t * const src_data[4],
385  const int src_linesize[4],
386  enum AVPixelFormat pix_fmt,
387  int width, int height, int align)
388 {
389  int i, j, nb_planes = 0, linesize[4];
390  int size = av_image_get_buffer_size(pix_fmt, width, height, align);
391  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
392  int ret;
393 
394  if (size > dst_size || size < 0 || !desc)
395  return AVERROR(EINVAL);
396 
397  for (i = 0; i < desc->nb_components; i++)
398  nb_planes = FFMAX(desc->comp[i].plane, nb_planes);
399 
400  nb_planes++;
401 
402  ret = av_image_fill_linesizes(linesize, pix_fmt, width);
403  av_assert0(ret >= 0); // was checked previously
404 
405  for (i = 0; i < nb_planes; i++) {
406  int h, shift = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
407  const uint8_t *src = src_data[i];
408  h = (height + (1 << shift) - 1) >> shift;
409 
410  for (j = 0; j < h; j++) {
411  memcpy(dst, src, linesize[i]);
412  dst += FFALIGN(linesize[i], align);
413  src += src_linesize[i];
414  }
415  }
416 
417  if (desc->flags & AV_PIX_FMT_FLAG_PAL) {
418  uint32_t *d32 = (uint32_t *)dst;
419 
420  for (i = 0; i<256; i++)
421  AV_WL32(d32 + i, AV_RN32(src_data[1] + 4*i));
422  }
423 
424  return size;
425 }
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:132
int plane
Definition: avisynth_c.h:291
int plane
Which of the 4 planes contains the component.
Definition: pixdesc.h:35
#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:2263
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:383
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:58
misc image utilities
#define LIBAVUTIL_VERSION_INT
Definition: version.h:70
const char * g
Definition: vf_curves.c:112
const char * desc
Definition: nvenc.c:89
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:191
int num
numerator
Definition: rational.h:44
static const AVClass imgutils_class
Definition: imgutils.c:243
const char * b
Definition: vf_curves.c:113
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:341
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:92
packed RGB 1:2:1, 8bpp, (msb)1B 2G 1R(lsb)
Definition: pixfmt.h:86
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
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
#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:117
uint8_t
#define av_malloc(s)
int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt)
Definition: imgutils.c:151
void * log_ctx
Definition: imgutils.c:240
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:266
#define height
ptrdiff_t size
Definition: opengl_enc.c:101
#define FFALIGN(x, a)
Definition: macros.h:48
#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:361
#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:101
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
const char * r
Definition: vf_curves.c:111
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:140
simple assert() macros that are a bit more flexible than ISO C assert().
#define FFMAX(a, b)
Definition: common.h:94
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:302
common internal API header
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
Definition: pixdesc.h:106
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:251
uint8_t nb_components
The number of components each pixel has, (1-4)
Definition: pixdesc.h:83
packed RGB 1:2:1, 8bpp, (msb)1R 2G 1B(lsb)
Definition: pixfmt.h:89
Round toward zero.
Definition: mathematics.h:71
#define width
#define AV_PIX_FMT_FLAG_PSEUDOPAL
The pixel format is "pseudo-paletted".
Definition: pixdesc.h:158
static int image_get_linesize(int width, int plane, int max_step, int max_step_comp, const AVPixFmtDescriptor *desc)
Definition: imgutils.c:53
#define src
Definition: vp9dsp.c:530
const AVClass * class
Definition: imgutils.c:238
const AVS_VideoInfo int align
Definition: avisynth_c.h:658
int log_offset
Definition: imgutils.c:239
packed RGB 3:3:2, 8bpp, (msb)2B 3G 3R(lsb)
Definition: pixfmt.h:84
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
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
void * buf
Definition: avisynth_c.h:553
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:493
#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:136
Y , 8bpp.
Definition: pixfmt.h:70
common internal and external API header
rational numbers
packed RGB 3:3:2, 8bpp, (msb)2R 3G 3B(lsb)
Definition: pixfmt.h:87
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:287
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
for(j=16;j >0;--j)
int step
Number of elements between 2 horizontally consecutive pixels.
Definition: pixdesc.h:41
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58