libavutil/imgutils.c
e7bd48a6
 /*
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * misc image utilities
  */
 
1d9c2dc8
 #include "common.h"
e7bd48a6
 #include "imgutils.h"
ed5d30d9
 #include "internal.h"
e6674e46
 #include "intreadwrite.h"
abc78a5a
 #include "log.h"
dc25d79f
 #include "pixdesc.h"
e7bd48a6
 
9b7269e3
 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
0f146263
                                 const AVPixFmtDescriptor *pixdesc)
 {
     int i;
     memset(max_pixsteps, 0, 4*sizeof(max_pixsteps[0]));
     if (max_pixstep_comps)
         memset(max_pixstep_comps, 0, 4*sizeof(max_pixstep_comps[0]));
 
     for (i = 0; i < 4; i++) {
         const AVComponentDescriptor *comp = &(pixdesc->comp[i]);
         if ((comp->step_minus1+1) > max_pixsteps[comp->plane]) {
             max_pixsteps[comp->plane] = comp->step_minus1+1;
             if (max_pixstep_comps)
                 max_pixstep_comps[comp->plane] = i;
         }
     }
 }
 
c0170d09
 static inline
 int image_get_linesize(int width, int plane,
                        int max_step, int max_step_comp,
                        const AVPixFmtDescriptor *desc)
 {
     int s, shifted_w, linesize;
 
     if (width < 0)
         return AVERROR(EINVAL);
     s = (max_step_comp == 1 || max_step_comp == 2) ? desc->log2_chroma_w : 0;
     shifted_w = ((width + (1 << s) - 1)) >> s;
     if (shifted_w && max_step > INT_MAX / shifted_w)
         return AVERROR(EINVAL);
     linesize = max_step * shifted_w;
     if (desc->flags & PIX_FMT_BITSTREAM)
         linesize = (linesize + 7) >> 3;
     return linesize;
 }
 
9b7269e3
 int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane)
7906e2b9
 {
     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
     int max_step     [4];       /* max pixel step for each plane */
     int max_step_comp[4];       /* the component for each plane which has the max pixel step */
 
0d73227c
     if ((unsigned)pix_fmt >= PIX_FMT_NB || desc->flags & PIX_FMT_HWACCEL)
         return AVERROR(EINVAL);
 
9b7269e3
     av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
c0170d09
     return image_get_linesize(width, plane, max_step[plane], max_step_comp[plane], desc);
7906e2b9
 }
 
9b7269e3
 int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width)
e7bd48a6
 {
c0170d09
     int i, ret;
e7bd48a6
     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
7860b436
     int max_step     [4];       /* max pixel step for each plane */
     int max_step_comp[4];       /* the component for each plane which has the max pixel step */
e7bd48a6
 
ecc7bfe3
     memset(linesizes, 0, 4*sizeof(linesizes[0]));
e7bd48a6
 
6950cca9
     if ((unsigned)pix_fmt >= PIX_FMT_NB || desc->flags & PIX_FMT_HWACCEL)
46b1d17a
         return AVERROR(EINVAL);
e7bd48a6
 
9b7269e3
     av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
e7bd48a6
     for (i = 0; i < 4; i++) {
c0170d09
         if ((ret = image_get_linesize(width, i, max_step[i], max_step_comp[i], desc)) < 0)
             return ret;
         linesizes[i] = ret;
e7bd48a6
     }
 
     return 0;
 }
 
9b7269e3
 int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
7d8d18de
                            uint8_t *ptr, const int linesizes[4])
e7bd48a6
 {
a92be9b8
     int i, total_size, size[4] = { 0 }, has_plane[4] = { 0 };
7d8d18de
 
e7bd48a6
     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
7d8d18de
     memset(data     , 0, sizeof(data[0])*4);
 
6950cca9
     if ((unsigned)pix_fmt >= PIX_FMT_NB || desc->flags & PIX_FMT_HWACCEL)
7d8d18de
         return AVERROR(EINVAL);
 
     data[0] = ptr;
9398024c
     if (linesizes[0] > (INT_MAX - 1024) / height)
         return AVERROR(EINVAL);
7d8d18de
     size[0] = linesizes[0] * height;
e7bd48a6
 
38d55332
     if (desc->flags & PIX_FMT_PAL ||
         desc->flags & PIX_FMT_PSEUDOPAL) {
7d8d18de
         size[0] = (size[0] + 3) & ~3;
         data[1] = ptr + size[0]; /* palette is stored here as 256 32 bits words */
         return size[0] + 256 * 4;
e7bd48a6
     }
7d8d18de
 
     for (i = 0; i < 4; i++)
         has_plane[desc->comp[i].plane] = 1;
 
     total_size = size[0];
c693aa6f
     for (i = 1; i < 4 && has_plane[i]; i++) {
7d8d18de
         int h, s = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
         data[i] = data[i-1] + size[i-1];
         h = (height + (1 << s) - 1) >> s;
9398024c
         if (linesizes[i] > INT_MAX / h)
             return AVERROR(EINVAL);
7d8d18de
         size[i] = h * linesizes[i];
9398024c
         if (total_size > INT_MAX - size[i])
             return AVERROR(EINVAL);
7d8d18de
         total_size += size[i];
     }
 
     return total_size;
e7bd48a6
 }
bf176f58
 
ed5d30d9
 int ff_set_systematic_pal2(uint32_t pal[256], enum PixelFormat pix_fmt)
 {
     int i;
 
     for (i = 0; i < 256; i++) {
         int r, g, b;
 
         switch (pix_fmt) {
         case PIX_FMT_RGB8:
             r = (i>>5    )*36;
             g = ((i>>2)&7)*36;
             b = (i&3     )*85;
             break;
         case PIX_FMT_BGR8:
             b = (i>>6    )*85;
             g = ((i>>3)&7)*36;
             r = (i&7     )*36;
             break;
         case PIX_FMT_RGB4_BYTE:
             r = (i>>3    )*255;
             g = ((i>>1)&3)*85;
             b = (i&1     )*255;
             break;
         case PIX_FMT_BGR4_BYTE:
             b = (i>>3    )*255;
             g = ((i>>1)&3)*85;
             r = (i&1     )*255;
             break;
         case PIX_FMT_GRAY8:
             r = b = g = i;
             break;
         default:
             return AVERROR(EINVAL);
         }
c25c7ba8
         pal[i] = b + (g<<8) + (r<<16) + (0xFF<<24);
ed5d30d9
     }
 
     return 0;
 }
 
4da12e3b
 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
                    int w, int h, enum PixelFormat pix_fmt, int align)
 {
     int i, ret;
     uint8_t *buf;
 
     if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
         return ret;
62e5ef95
     if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, align>7 ? FFALIGN(w, 8) : w)) < 0)
4da12e3b
         return ret;
 
     for (i = 0; i < 4; i++)
         linesizes[i] = FFALIGN(linesizes[i], align);
 
     if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, NULL, linesizes)) < 0)
         return ret;
     buf = av_malloc(ret + align);
     if (!buf)
         return AVERROR(ENOMEM);
     if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
         av_free(buf);
         return ret;
     }
38d55332
     if (av_pix_fmt_descriptors[pix_fmt].flags & PIX_FMT_PAL ||
         av_pix_fmt_descriptors[pix_fmt].flags & PIX_FMT_PSEUDOPAL)
4da12e3b
         ff_set_systematic_pal2((uint32_t*)pointers[1], pix_fmt);
 
     return ret;
 }
 
bf176f58
 typedef struct ImgUtils {
     const AVClass *class;
     int   log_offset;
     void *log_ctx;
 } ImgUtils;
 
 static const AVClass imgutils_class = { "IMGUTILS", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(ImgUtils, log_offset), offsetof(ImgUtils, log_ctx) };
 
9b7269e3
 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
bf176f58
 {
     ImgUtils imgutils = { &imgutils_class, log_offset, log_ctx };
 
be7110cd
     if ((int)w>0 && (int)h>0 && (w+128)*(uint64_t)(h+128) < INT_MAX/8)
bf176f58
         return 0;
 
899a507f
     av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
bf176f58
     return AVERROR(EINVAL);
 }
9b7269e3
 
9686abb8
 void av_image_copy_plane(uint8_t       *dst, int dst_linesize,
                          const uint8_t *src, int src_linesize,
                          int bytewidth, int height)
 {
     if (!dst || !src)
         return;
     for (;height > 0; height--) {
         memcpy(dst, src, bytewidth);
         dst += dst_linesize;
         src += src_linesize;
     }
 }
 
2b3cd04d
 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
                    const uint8_t *src_data[4], const int src_linesizes[4],
34017fd9
                    enum PixelFormat pix_fmt, int width, int height)
 {
     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
 
     if (desc->flags & PIX_FMT_HWACCEL)
         return;
 
38d55332
     if (desc->flags & PIX_FMT_PAL ||
         desc->flags & PIX_FMT_PSEUDOPAL) {
2b3cd04d
         av_image_copy_plane(dst_data[0], dst_linesizes[0],
                             src_data[0], src_linesizes[0],
34017fd9
                             width, height);
         /* copy the palette */
         memcpy(dst_data[1], src_data[1], 4*256);
     } else {
         int i, planes_nb = 0;
 
         for (i = 0; i < desc->nb_components; i++)
             planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
 
         for (i = 0; i < planes_nb; i++) {
             int h = height;
             int bwidth = av_image_get_linesize(pix_fmt, width, i);
             if (i == 1 || i == 2) {
                 h= -((-height)>>desc->log2_chroma_h);
             }
2b3cd04d
             av_image_copy_plane(dst_data[i], dst_linesizes[i],
                                 src_data[i], src_linesizes[i],
34017fd9
                                 bwidth, h);
         }
     }
 }
e6674e46
 
 int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
                          const uint8_t *src,
                          enum PixelFormat pix_fmt, int width, int height, int align)
 {
     int ret, i;
 
     if ((ret = av_image_check_size(width, height, 0, NULL)) < 0)
         return ret;
 
     if ((ret = av_image_fill_linesizes(dst_linesize, pix_fmt, width)) < 0)
         return ret;
 
     for (i = 0; i < 4; i++)
         dst_linesize[i] = FFALIGN(dst_linesize[i], align);
 
     if ((ret = av_image_fill_pointers(dst_data, pix_fmt, width, NULL, dst_linesize)) < 0)
         return ret;
 
94c3e11a
     return av_image_fill_pointers(dst_data, pix_fmt, height, (uint8_t *)src, dst_linesize);
e6674e46
 }
 
 int av_image_get_buffer_size(enum PixelFormat pix_fmt, int width, int height, int align)
 {
     uint8_t *data[4];
     int linesize[4];
     if (av_image_check_size(width, height, 0, NULL) < 0)
         return AVERROR(EINVAL);
     if (av_pix_fmt_descriptors[pix_fmt].flags & PIX_FMT_PSEUDOPAL)
         // do not include palette for these pseudo-paletted formats
         return width * height;
     return av_image_fill_arrays(data, linesize, NULL, pix_fmt, width, height, align);
 }
 
 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 PixelFormat pix_fmt, int width, int height, int align)
 {
     int i, j, nb_planes = 0, linesize[4];
     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
     int size = av_image_get_buffer_size(pix_fmt, width, height, align);
 
     if (size > dst_size || size < 0)
         return AVERROR(EINVAL);
 
     for (i = 0; i < desc->nb_components; i++)
         nb_planes = FFMAX(desc->comp[i].plane, nb_planes);
     nb_planes++;
 
     av_image_fill_linesizes(linesize, pix_fmt, width);
     for (i = 0; i < nb_planes; i++) {
         int h, shift = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
         const uint8_t *src = src_data[i];
         h = (height + (1 << shift) - 1) >> shift;
 
         for (j = 0; j < h; j++) {
             memcpy(dst, src, linesize[i]);
             dst += FFALIGN(linesize[i], align);
             src += src_linesize[i];
         }
     }
 
     if (desc->flags & PIX_FMT_PAL) {
94c3e11a
         uint32_t *d32 = (uint32_t *)(((size_t)dst + 3) & ~3);
e6674e46
         for (i = 0; i<256; i++)
             AV_WL32(d32 + i, AV_RN32(src_data[1] + 4*i));
     }
 
     return size;
 }