2 * This file is part of FFmpeg.
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.
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.
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
21 * misc image utilities
27 #include "imgutils_internal.h"
29 #include "intreadwrite.h"
31 #include "mathematics.h"
35 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
36 const AVPixFmtDescriptor *pixdesc)
39 memset(max_pixsteps, 0, 4*sizeof(max_pixsteps[0]));
40 if (max_pixstep_comps)
41 memset(max_pixstep_comps, 0, 4*sizeof(max_pixstep_comps[0]));
43 for (i = 0; i < 4; i++) {
44 const AVComponentDescriptor *comp = &(pixdesc->comp[i]);
45 if (comp->step > max_pixsteps[comp->plane]) {
46 max_pixsteps[comp->plane] = comp->step;
47 if (max_pixstep_comps)
48 max_pixstep_comps[comp->plane] = i;
54 int image_get_linesize(int width, int plane,
55 int max_step, int max_step_comp,
56 const AVPixFmtDescriptor *desc)
58 int s, shifted_w, linesize;
61 return AVERROR(EINVAL);
64 return AVERROR(EINVAL);
65 s = (max_step_comp == 1 || max_step_comp == 2) ? desc->log2_chroma_w : 0;
66 shifted_w = ((width + (1 << s) - 1)) >> s;
67 if (shifted_w && max_step > INT_MAX / shifted_w)
68 return AVERROR(EINVAL);
69 linesize = max_step * shifted_w;
71 if (desc->flags & AV_PIX_FMT_FLAG_BITSTREAM)
72 linesize = (linesize + 7) >> 3;
76 int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane)
78 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
79 int max_step [4]; /* max pixel step for each plane */
80 int max_step_comp[4]; /* the component for each plane which has the max pixel step */
82 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
83 return AVERROR(EINVAL);
85 av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
86 return image_get_linesize(width, plane, max_step[plane], max_step_comp[plane], desc);
89 int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
92 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
93 int max_step [4]; /* max pixel step for each plane */
94 int max_step_comp[4]; /* the component for each plane which has the max pixel step */
96 memset(linesizes, 0, 4*sizeof(linesizes[0]));
98 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
99 return AVERROR(EINVAL);
101 av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
102 for (i = 0; i < 4; i++) {
103 if ((ret = image_get_linesize(width, i, max_step[i], max_step_comp[i], desc)) < 0)
111 int av_image_fill_plane_sizes(size_t sizes[4], enum AVPixelFormat pix_fmt,
112 int height, const ptrdiff_t linesizes[4])
114 int i, has_plane[4] = { 0 };
116 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
117 memset(sizes , 0, sizeof(sizes[0])*4);
119 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
120 return AVERROR(EINVAL);
122 if (linesizes[0] > SIZE_MAX / height)
123 return AVERROR(EINVAL);
124 sizes[0] = linesizes[0] * (size_t)height;
126 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
127 desc->flags & FF_PSEUDOPAL) {
128 sizes[1] = 256 * 4; /* palette is stored here as 256 32 bits words */
132 for (i = 0; i < 4; i++)
133 has_plane[desc->comp[i].plane] = 1;
135 for (i = 1; i < 4 && has_plane[i]; i++) {
136 int h, s = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
137 h = (height + (1 << s) - 1) >> s;
138 if (linesizes[i] > SIZE_MAX / h)
139 return AVERROR(EINVAL);
140 sizes[i] = (size_t)h * linesizes[i];
146 int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height,
147 uint8_t *ptr, const int linesizes[4])
150 ptrdiff_t linesizes1[4];
153 memset(data , 0, sizeof(data[0])*4);
155 for (i = 0; i < 4; i++)
156 linesizes1[i] = linesizes[i];
158 ret = av_image_fill_plane_sizes(sizes, pix_fmt, height, linesizes1);
163 for (i = 0; i < 4; i++) {
164 if (sizes[i] > INT_MAX - ret)
165 return AVERROR(EINVAL);
170 for (i = 1; i < 4 && sizes[i]; i++)
171 data[i] = data[i - 1] + sizes[i - 1];
176 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt)
180 for (i = 0; i < 256; i++) {
184 case AV_PIX_FMT_RGB8:
189 case AV_PIX_FMT_BGR8:
194 case AV_PIX_FMT_RGB4_BYTE:
199 case AV_PIX_FMT_BGR4_BYTE:
204 case AV_PIX_FMT_GRAY8:
208 return AVERROR(EINVAL);
210 pal[i] = b + (g << 8) + (r << 16) + (0xFFU << 24);
216 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
217 int w, int h, enum AVPixelFormat pix_fmt, int align)
219 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
221 ptrdiff_t linesizes1[4];
222 size_t total_size, sizes[4];
226 return AVERROR(EINVAL);
228 if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
230 if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, align>7 ? FFALIGN(w, 8) : w)) < 0)
233 for (i = 0; i < 4; i++) {
234 linesizes[i] = FFALIGN(linesizes[i], align);
235 linesizes1[i] = linesizes[i];
238 if ((ret = av_image_fill_plane_sizes(sizes, pix_fmt, h, linesizes1)) < 0)
241 for (i = 0; i < 4; i++) {
242 if (total_size > SIZE_MAX - sizes[i])
243 return AVERROR(EINVAL);
244 total_size += sizes[i];
246 buf = av_malloc(total_size);
248 return AVERROR(ENOMEM);
249 if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
253 if (desc->flags & AV_PIX_FMT_FLAG_PAL || (desc->flags & FF_PSEUDOPAL && pointers[1])) {
254 avpriv_set_systematic_pal2((uint32_t*)pointers[1], pix_fmt);
256 av_log(NULL, AV_LOG_ERROR, "Formats with a palette require a minimum alignment of 4\n");
258 return AVERROR(EINVAL);
262 if ((desc->flags & AV_PIX_FMT_FLAG_PAL ||
263 desc->flags & FF_PSEUDOPAL) && pointers[1] &&
264 pointers[1] - pointers[0] > linesizes[0] * h) {
265 /* zero-initialize the padding before the palette */
266 memset(pointers[0] + linesizes[0] * h, 0,
267 pointers[1] - pointers[0] - linesizes[0] * h);
273 typedef struct ImgUtils {
274 const AVClass *class;
279 static const AVClass imgutils_class = {
280 .class_name = "IMGUTILS",
281 .item_name = av_default_item_name,
283 .version = LIBAVUTIL_VERSION_INT,
284 .log_level_offset_offset = offsetof(ImgUtils, log_offset),
285 .parent_log_context_offset = offsetof(ImgUtils, log_ctx),
288 int av_image_check_size2(unsigned int w, unsigned int h, int64_t max_pixels, enum AVPixelFormat pix_fmt, int log_offset, void *log_ctx)
290 ImgUtils imgutils = {
291 .class = &imgutils_class,
292 .log_offset = log_offset,
295 int64_t stride = av_image_get_linesize(pix_fmt, w, 0);
300 if ((int)w<=0 || (int)h<=0 || stride >= INT_MAX || stride*(uint64_t)(h+128) >= INT_MAX) {
301 av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
302 return AVERROR(EINVAL);
305 if (max_pixels < INT64_MAX) {
306 if (w*(int64_t)h > max_pixels) {
307 av_log(&imgutils, AV_LOG_ERROR,
308 "Picture size %ux%u exceeds specified max pixel count %"PRId64", see the documentation if you wish to increase it\n",
310 return AVERROR(EINVAL);
317 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
319 return av_image_check_size2(w, h, INT64_MAX, AV_PIX_FMT_NONE, log_offset, log_ctx);
322 int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
326 if (sar.den <= 0 || sar.num < 0)
327 return AVERROR(EINVAL);
329 if (!sar.num || sar.num == sar.den)
332 if (sar.num < sar.den)
333 scaled_dim = av_rescale_rnd(w, sar.num, sar.den, AV_ROUND_ZERO);
335 scaled_dim = av_rescale_rnd(h, sar.den, sar.num, AV_ROUND_ZERO);
340 return AVERROR(EINVAL);
343 static void image_copy_plane(uint8_t *dst, ptrdiff_t dst_linesize,
344 const uint8_t *src, ptrdiff_t src_linesize,
345 ptrdiff_t bytewidth, int height)
349 av_assert0(FFABS(src_linesize) >= bytewidth);
350 av_assert0(FFABS(dst_linesize) >= bytewidth);
351 for (;height > 0; height--) {
352 memcpy(dst, src, bytewidth);
358 static void image_copy_plane_uc_from(uint8_t *dst, ptrdiff_t dst_linesize,
359 const uint8_t *src, ptrdiff_t src_linesize,
360 ptrdiff_t bytewidth, int height)
365 ret = ff_image_copy_plane_uc_from_x86(dst, dst_linesize, src, src_linesize,
370 image_copy_plane(dst, dst_linesize, src, src_linesize, bytewidth, height);
373 void av_image_copy_plane(uint8_t *dst, int dst_linesize,
374 const uint8_t *src, int src_linesize,
375 int bytewidth, int height)
377 image_copy_plane(dst, dst_linesize, src, src_linesize, bytewidth, height);
380 static void image_copy(uint8_t *dst_data[4], const ptrdiff_t dst_linesizes[4],
381 const uint8_t *src_data[4], const ptrdiff_t src_linesizes[4],
382 enum AVPixelFormat pix_fmt, int width, int height,
383 void (*copy_plane)(uint8_t *, ptrdiff_t, const uint8_t *,
384 ptrdiff_t, ptrdiff_t, int))
386 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
388 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
391 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
392 desc->flags & FF_PSEUDOPAL) {
393 copy_plane(dst_data[0], dst_linesizes[0],
394 src_data[0], src_linesizes[0],
396 /* copy the palette */
397 if ((desc->flags & AV_PIX_FMT_FLAG_PAL) || (dst_data[1] && src_data[1]))
398 memcpy(dst_data[1], src_data[1], 4*256);
400 int i, planes_nb = 0;
402 for (i = 0; i < desc->nb_components; i++)
403 planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
405 for (i = 0; i < planes_nb; i++) {
407 ptrdiff_t bwidth = av_image_get_linesize(pix_fmt, width, i);
409 av_log(NULL, AV_LOG_ERROR, "av_image_get_linesize failed\n");
412 if (i == 1 || i == 2) {
413 h = AV_CEIL_RSHIFT(height, desc->log2_chroma_h);
415 copy_plane(dst_data[i], dst_linesizes[i],
416 src_data[i], src_linesizes[i],
422 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
423 const uint8_t *src_data[4], const int src_linesizes[4],
424 enum AVPixelFormat pix_fmt, int width, int height)
426 ptrdiff_t dst_linesizes1[4], src_linesizes1[4];
429 for (i = 0; i < 4; i++) {
430 dst_linesizes1[i] = dst_linesizes[i];
431 src_linesizes1[i] = src_linesizes[i];
434 image_copy(dst_data, dst_linesizes1, src_data, src_linesizes1, pix_fmt,
435 width, height, image_copy_plane);
438 void av_image_copy_uc_from(uint8_t *dst_data[4], const ptrdiff_t dst_linesizes[4],
439 const uint8_t *src_data[4], const ptrdiff_t src_linesizes[4],
440 enum AVPixelFormat pix_fmt, int width, int height)
442 image_copy(dst_data, dst_linesizes, src_data, src_linesizes, pix_fmt,
443 width, height, image_copy_plane_uc_from);
446 int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
447 const uint8_t *src, enum AVPixelFormat pix_fmt,
448 int width, int height, int align)
452 ret = av_image_check_size(width, height, 0, NULL);
456 ret = av_image_fill_linesizes(dst_linesize, pix_fmt, width);
460 for (i = 0; i < 4; i++)
461 dst_linesize[i] = FFALIGN(dst_linesize[i], align);
463 return av_image_fill_pointers(dst_data, pix_fmt, height, (uint8_t *)src, dst_linesize);
466 int av_image_get_buffer_size(enum AVPixelFormat pix_fmt,
467 int width, int height, int align)
471 ptrdiff_t aligned_linesize[4];
473 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
475 return AVERROR(EINVAL);
477 ret = av_image_check_size(width, height, 0, NULL);
481 // do not include palette for these pseudo-paletted formats
482 if (desc->flags & FF_PSEUDOPAL)
483 return FFALIGN(width, align) * height;
485 ret = av_image_fill_linesizes(linesize, pix_fmt, width);
489 for (i = 0; i < 4; i++)
490 aligned_linesize[i] = FFALIGN(linesize[i], align);
492 ret = av_image_fill_plane_sizes(sizes, pix_fmt, height, aligned_linesize);
497 for (i = 0; i < 4; i++) {
498 if (sizes[i] > INT_MAX - ret)
499 return AVERROR(EINVAL);
505 int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
506 const uint8_t * const src_data[4],
507 const int src_linesize[4],
508 enum AVPixelFormat pix_fmt,
509 int width, int height, int align)
511 int i, j, nb_planes = 0, linesize[4];
512 int size = av_image_get_buffer_size(pix_fmt, width, height, align);
513 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
516 if (size > dst_size || size < 0 || !desc)
517 return AVERROR(EINVAL);
519 for (i = 0; i < desc->nb_components; i++)
520 nb_planes = FFMAX(desc->comp[i].plane, nb_planes);
524 ret = av_image_fill_linesizes(linesize, pix_fmt, width);
525 av_assert0(ret >= 0); // was checked previously
527 for (i = 0; i < nb_planes; i++) {
528 int h, shift = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
529 const uint8_t *src = src_data[i];
530 h = (height + (1 << shift) - 1) >> shift;
532 for (j = 0; j < h; j++) {
533 memcpy(dst, src, linesize[i]);
534 dst += FFALIGN(linesize[i], align);
535 src += src_linesize[i];
539 if (desc->flags & AV_PIX_FMT_FLAG_PAL) {
540 uint32_t *d32 = (uint32_t *)dst;
542 for (i = 0; i<256; i++)
543 AV_WL32(d32 + i, AV_RN32(src_data[1] + 4*i));
549 // Fill dst[0..dst_size] with the bytes in clear[0..clear_size]. The clear
550 // bytes are repeated until dst_size is reached. If dst_size is unaligned (i.e.
551 // dst_size%clear_size!=0), the remaining data will be filled with the beginning
552 // of the clear data only.
553 static void memset_bytes(uint8_t *dst, size_t dst_size, uint8_t *clear,
562 // Reduce to memset() if possible.
563 for (i = 0; i < clear_size; i++) {
564 if (clear[i] != clear[0]) {
572 if (clear_size == 1) {
573 memset(dst, clear[0], dst_size);
575 if (clear_size > dst_size)
576 clear_size = dst_size;
577 memcpy(dst, clear, clear_size);
578 av_memcpy_backptr(dst + clear_size, clear_size, dst_size - clear_size);
582 // Maximum size in bytes of a plane element (usually a pixel, or multiple pixels
583 // if it's a subsampled packed format).
584 #define MAX_BLOCK_SIZE 32
586 int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4],
587 enum AVPixelFormat pix_fmt, enum AVColorRange range,
588 int width, int height)
590 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
591 int nb_planes = av_pix_fmt_count_planes(pix_fmt);
592 // A pixel or a group of pixels on each plane, with a value that represents black.
593 // Consider e.g. AV_PIX_FMT_UYVY422 for non-trivial cases.
594 uint8_t clear_block[4][MAX_BLOCK_SIZE] = {{0}}; // clear padding with 0
595 int clear_block_size[4] = {0};
596 ptrdiff_t plane_line_bytes[4] = {0};
600 if (!desc || nb_planes < 1 || nb_planes > 4 || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
601 return AVERROR(EINVAL);
603 rgb = !!(desc->flags & AV_PIX_FMT_FLAG_RGB);
604 limited = !rgb && range != AVCOL_RANGE_JPEG;
606 if (desc->flags & AV_PIX_FMT_FLAG_BITSTREAM) {
607 ptrdiff_t bytewidth = av_image_get_linesize(pix_fmt, width, 0);
609 int mono = pix_fmt == AV_PIX_FMT_MONOWHITE || pix_fmt == AV_PIX_FMT_MONOBLACK;
610 int fill = pix_fmt == AV_PIX_FMT_MONOWHITE ? 0xFF : 0;
611 if (nb_planes != 1 || !(rgb || mono) || bytewidth < 1)
612 return AVERROR(EINVAL);
619 // (Bitstream + alpha will be handled incorrectly - it'll remain transparent.)
620 for (;height > 0; height--) {
621 memset(data, fill, bytewidth);
622 data += dst_linesize[0];
627 for (c = 0; c < desc->nb_components; c++) {
628 const AVComponentDescriptor comp = desc->comp[c];
630 // We try to operate on entire non-subsampled pixel groups (for
631 // AV_PIX_FMT_UYVY422 this would mean two consecutive pixels).
632 clear_block_size[comp.plane] = FFMAX(clear_block_size[comp.plane], comp.step);
634 if (clear_block_size[comp.plane] > MAX_BLOCK_SIZE)
635 return AVERROR(EINVAL);
638 // Create a byte array for clearing 1 pixel (sometimes several pixels).
639 for (c = 0; c < desc->nb_components; c++) {
640 const AVComponentDescriptor comp = desc->comp[c];
641 // (Multiple pixels happen e.g. with AV_PIX_FMT_UYVY422.)
642 int w = clear_block_size[comp.plane] / comp.step;
644 const int c_linesize[4] = {0};
645 uint16_t src_array[MAX_BLOCK_SIZE];
650 return AVERROR(EINVAL);
651 if (!rgb && comp.depth < 8)
652 return AVERROR(EINVAL);
654 return AVERROR(EINVAL);
656 if (c == 0 && limited) {
657 src = 16 << (comp.depth - 8);
658 } else if ((c == 1 || c == 2) && !rgb) {
659 src = 128 << (comp.depth - 8);
661 // (Assume even limited YUV uses full range alpha.)
662 src = (1 << comp.depth) - 1;
665 for (x = 0; x < w; x++)
668 for (x = 0; x < 4; x++)
669 c_data[x] = &clear_block[x][0];
671 av_write_image_line(src_array, c_data, c_linesize, desc, 0, 0, c, w);
674 for (plane = 0; plane < nb_planes; plane++) {
675 plane_line_bytes[plane] = av_image_get_linesize(pix_fmt, width, plane);
676 if (plane_line_bytes[plane] < 0)
677 return AVERROR(EINVAL);
683 for (plane = 0; plane < nb_planes; plane++) {
684 size_t bytewidth = plane_line_bytes[plane];
685 uint8_t *data = dst_data[plane];
686 int chroma_div = plane == 1 || plane == 2 ? desc->log2_chroma_h : 0;
687 int plane_h = ((height + ( 1 << chroma_div) - 1)) >> chroma_div;
689 for (; plane_h > 0; plane_h--) {
690 memset_bytes(data, bytewidth, &clear_block[plane][0], clear_block_size[plane]);
691 data += dst_linesize[plane];