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
28 #include "intreadwrite.h"
30 #include "mathematics.h"
34 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
35 const AVPixFmtDescriptor *pixdesc)
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]));
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;
53 int image_get_linesize(int width, int plane,
54 int max_step, int max_step_comp,
55 const AVPixFmtDescriptor *desc)
57 int s, shifted_w, linesize;
60 return AVERROR(EINVAL);
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;
70 if (desc->flags & AV_PIX_FMT_FLAG_BITSTREAM)
71 linesize = (linesize + 7) >> 3;
75 int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane)
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 */
81 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
82 return AVERROR(EINVAL);
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);
88 int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
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 */
95 memset(linesizes, 0, 4*sizeof(linesizes[0]));
97 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
98 return AVERROR(EINVAL);
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)
110 int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height,
111 uint8_t *ptr, const int linesizes[4])
113 int i, total_size, size[4] = { 0 }, has_plane[4] = { 0 };
115 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
116 memset(data , 0, sizeof(data[0])*4);
118 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
119 return AVERROR(EINVAL);
122 if (linesizes[0] > (INT_MAX - 1024) / height)
123 return AVERROR(EINVAL);
124 size[0] = linesizes[0] * height;
126 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
127 desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
128 data[1] = ptr + size[0]; /* palette is stored here as 256 32 bits words */
129 return size[0] + 256 * 4;
132 for (i = 0; i < 4; i++)
133 has_plane[desc->comp[i].plane] = 1;
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];
151 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt)
155 for (i = 0; i < 256; i++) {
159 case AV_PIX_FMT_RGB8:
164 case AV_PIX_FMT_BGR8:
169 case AV_PIX_FMT_RGB4_BYTE:
174 case AV_PIX_FMT_BGR4_BYTE:
179 case AV_PIX_FMT_GRAY8:
183 return AVERROR(EINVAL);
185 pal[i] = b + (g << 8) + (r << 16) + (0xFFU << 24);
191 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
192 int w, int h, enum AVPixelFormat pix_fmt, int align)
194 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
199 return AVERROR(EINVAL);
201 if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
203 if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, align>7 ? FFALIGN(w, 8) : w)) < 0)
206 for (i = 0; i < 4; i++)
207 linesizes[i] = FFALIGN(linesizes[i], align);
209 if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, NULL, linesizes)) < 0)
211 buf = av_malloc(ret + align);
213 return AVERROR(ENOMEM);
214 if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
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);
221 av_log(NULL, AV_LOG_ERROR, "Formats with a palette require a minimum alignment of 4\n");
222 return AVERROR(EINVAL);
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);
237 typedef struct ImgUtils {
238 const AVClass *class;
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),
251 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
253 ImgUtils imgutils = {
254 .class = &imgutils_class,
255 .log_offset = log_offset,
259 if ((int)w>0 && (int)h>0 && (w+128)*(uint64_t)(h+128) < INT_MAX/8)
262 av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
263 return AVERROR(EINVAL);
266 int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
270 if (sar.den <= 0 || sar.num < 0)
271 return AVERROR(EINVAL);
273 if (!sar.num || sar.num == sar.den)
276 if (sar.num < sar.den)
277 scaled_dim = av_rescale_rnd(w, sar.num, sar.den, AV_ROUND_ZERO);
279 scaled_dim = av_rescale_rnd(h, sar.den, sar.num, AV_ROUND_ZERO);
284 return AVERROR(EINVAL);
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)
293 av_assert0(abs(src_linesize) >= bytewidth);
294 av_assert0(abs(dst_linesize) >= bytewidth);
295 for (;height > 0; height--) {
296 memcpy(dst, src, bytewidth);
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)
306 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
308 if (!desc || desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
311 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
312 desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
313 av_image_copy_plane(dst_data[0], dst_linesizes[0],
314 src_data[0], src_linesizes[0],
316 /* copy the palette */
317 memcpy(dst_data[1], src_data[1], 4*256);
319 int i, planes_nb = 0;
321 for (i = 0; i < desc->nb_components; i++)
322 planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
324 for (i = 0; i < planes_nb; i++) {
326 int bwidth = av_image_get_linesize(pix_fmt, width, i);
328 av_log(NULL, AV_LOG_ERROR, "av_image_get_linesize failed\n");
331 if (i == 1 || i == 2) {
332 h = AV_CEIL_RSHIFT(height, desc->log2_chroma_h);
334 av_image_copy_plane(dst_data[i], dst_linesizes[i],
335 src_data[i], src_linesizes[i],
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)
347 ret = av_image_check_size(width, height, 0, NULL);
351 ret = av_image_fill_linesizes(dst_linesize, pix_fmt, width);
355 for (i = 0; i < 4; i++)
356 dst_linesize[i] = FFALIGN(dst_linesize[i], align);
358 return av_image_fill_pointers(dst_data, pix_fmt, height, (uint8_t *)src, dst_linesize);
361 int av_image_get_buffer_size(enum AVPixelFormat pix_fmt,
362 int width, int height, int align)
367 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
369 return AVERROR(EINVAL);
371 ret = av_image_check_size(width, height, 0, NULL);
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;
379 return av_image_fill_arrays(data, linesize, NULL, pix_fmt,
380 width, height, align);
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)
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);
394 if (size > dst_size || size < 0 || !desc)
395 return AVERROR(EINVAL);
397 for (i = 0; i < desc->nb_components; i++)
398 nb_planes = FFMAX(desc->comp[i].plane, nb_planes);
402 ret = av_image_fill_linesizes(linesize, pix_fmt, width);
403 av_assert0(ret >= 0); // was checked previously
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;
410 for (j = 0; j < h; j++) {
411 memcpy(dst, src, linesize[i]);
412 dst += FFALIGN(linesize[i], align);
413 src += src_linesize[i];
417 if (desc->flags & AV_PIX_FMT_FLAG_PAL) {
418 uint32_t *d32 = (uint32_t *)dst;
420 for (i = 0; i<256; i++)
421 AV_WL32(d32 + i, AV_RN32(src_data[1] + 4*i));