imgutils: generalize linesize computation for bitstream formats
[ffmpeg.git] / libavutil / imgutils.c
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 "imgutils.h"
25 #include "internal.h"
26 #include "libavutil/pixdesc.h"
27
28 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
29                                 const AVPixFmtDescriptor *pixdesc)
30 {
31     int i;
32     memset(max_pixsteps, 0, 4*sizeof(max_pixsteps[0]));
33     if (max_pixstep_comps)
34         memset(max_pixstep_comps, 0, 4*sizeof(max_pixstep_comps[0]));
35
36     for (i = 0; i < 4; i++) {
37         const AVComponentDescriptor *comp = &(pixdesc->comp[i]);
38         if ((comp->step_minus1+1) > max_pixsteps[comp->plane]) {
39             max_pixsteps[comp->plane] = comp->step_minus1+1;
40             if (max_pixstep_comps)
41                 max_pixstep_comps[comp->plane] = i;
42         }
43     }
44 }
45
46 int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane)
47 {
48     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
49     int max_step     [4];       /* max pixel step for each plane */
50     int max_step_comp[4];       /* the component for each plane which has the max pixel step */
51     int s, linesize;
52
53     av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
54     s = (max_step_comp[plane] == 1 || max_step_comp[plane] == 2) ? desc->log2_chroma_w : 0;
55     linesize = max_step[plane] * (((width + (1 << s) - 1)) >> s);
56     if (desc->flags & PIX_FMT_BITSTREAM)
57         linesize = (linesize + 7) >> 3;
58     return linesize;
59 }
60
61 int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width)
62 {
63     int i;
64     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
65     int max_step     [4];       /* max pixel step for each plane */
66     int max_step_comp[4];       /* the component for each plane which has the max pixel step */
67
68     memset(linesizes, 0, 4*sizeof(linesizes[0]));
69
70     if ((unsigned)pix_fmt >= PIX_FMT_NB || desc->flags & PIX_FMT_HWACCEL)
71         return AVERROR(EINVAL);
72
73     av_image_fill_max_pixsteps(max_step, max_step_comp, desc);
74     for (i = 0; i < 4; i++) {
75         int s = (max_step_comp[i] == 1 || max_step_comp[i] == 2) ? desc->log2_chroma_w : 0;
76         int shifted_w = ((width + (1 << s) - 1)) >> s;
77         if (max_step[i] > INT_MAX / shifted_w)
78             return AVERROR(EINVAL);
79         linesizes[i] = max_step[i] * shifted_w;
80         if (desc->flags & PIX_FMT_BITSTREAM)
81             linesizes[i] = (linesizes[i] + 7) >> 3;
82     }
83
84     return 0;
85 }
86
87 int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
88                            uint8_t *ptr, const int linesizes[4])
89 {
90     int i, total_size, size[4], has_plane[4];
91
92     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
93     memset(data     , 0, sizeof(data[0])*4);
94     memset(size     , 0, sizeof(size));
95     memset(has_plane, 0, sizeof(has_plane));
96
97     if ((unsigned)pix_fmt >= PIX_FMT_NB || desc->flags & PIX_FMT_HWACCEL)
98         return AVERROR(EINVAL);
99
100     data[0] = ptr;
101     if (linesizes[0] > (INT_MAX - 1024) / height)
102         return AVERROR(EINVAL);
103     size[0] = linesizes[0] * height;
104
105     if (desc->flags & PIX_FMT_PAL) {
106         size[0] = (size[0] + 3) & ~3;
107         data[1] = ptr + size[0]; /* palette is stored here as 256 32 bits words */
108         return size[0] + 256 * 4;
109     }
110
111     for (i = 0; i < 4; i++)
112         has_plane[desc->comp[i].plane] = 1;
113
114     total_size = size[0];
115     for (i = 1; has_plane[i] && i < 4; i++) {
116         int h, s = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
117         data[i] = data[i-1] + size[i-1];
118         h = (height + (1 << s) - 1) >> s;
119         if (linesizes[i] > INT_MAX / h)
120             return AVERROR(EINVAL);
121         size[i] = h * linesizes[i];
122         if (total_size > INT_MAX - size[i])
123             return AVERROR(EINVAL);
124         total_size += size[i];
125     }
126
127     return total_size;
128 }
129
130 int ff_set_systematic_pal2(uint32_t pal[256], enum PixelFormat pix_fmt)
131 {
132     int i;
133
134     for (i = 0; i < 256; i++) {
135         int r, g, b;
136
137         switch (pix_fmt) {
138         case PIX_FMT_RGB8:
139             r = (i>>5    )*36;
140             g = ((i>>2)&7)*36;
141             b = (i&3     )*85;
142             break;
143         case PIX_FMT_BGR8:
144             b = (i>>6    )*85;
145             g = ((i>>3)&7)*36;
146             r = (i&7     )*36;
147             break;
148         case PIX_FMT_RGB4_BYTE:
149             r = (i>>3    )*255;
150             g = ((i>>1)&3)*85;
151             b = (i&1     )*255;
152             break;
153         case PIX_FMT_BGR4_BYTE:
154             b = (i>>3    )*255;
155             g = ((i>>1)&3)*85;
156             r = (i&1     )*255;
157             break;
158         case PIX_FMT_GRAY8:
159             r = b = g = i;
160             break;
161         default:
162             return AVERROR(EINVAL);
163         }
164         pal[i] = b + (g<<8) + (r<<16);
165     }
166
167     return 0;
168 }
169
170 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
171                    int w, int h, enum PixelFormat pix_fmt, int align)
172 {
173     int i, ret;
174     uint8_t *buf;
175
176     if ((ret = av_image_check_size(w, h, 0, NULL)) < 0)
177         return ret;
178     if ((ret = av_image_fill_linesizes(linesizes, pix_fmt, w)) < 0)
179         return ret;
180
181     for (i = 0; i < 4; i++)
182         linesizes[i] = FFALIGN(linesizes[i], align);
183
184     if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, NULL, linesizes)) < 0)
185         return ret;
186     buf = av_malloc(ret + align);
187     if (!buf)
188         return AVERROR(ENOMEM);
189     if ((ret = av_image_fill_pointers(pointers, pix_fmt, h, buf, linesizes)) < 0) {
190         av_free(buf);
191         return ret;
192     }
193     if (av_pix_fmt_descriptors[pix_fmt].flags & PIX_FMT_PAL)
194         ff_set_systematic_pal2((uint32_t*)pointers[1], pix_fmt);
195
196     return ret;
197 }
198
199 typedef struct ImgUtils {
200     const AVClass *class;
201     int   log_offset;
202     void *log_ctx;
203 } ImgUtils;
204
205 static const AVClass imgutils_class = { "IMGUTILS", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(ImgUtils, log_offset), offsetof(ImgUtils, log_ctx) };
206
207 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
208 {
209     ImgUtils imgutils = { &imgutils_class, log_offset, log_ctx };
210
211     if ((int)w>0 && (int)h>0 && (w+128)*(uint64_t)(h+128) < INT_MAX/8)
212         return 0;
213
214     av_log(&imgutils, AV_LOG_ERROR, "Picture size %ux%u is invalid\n", w, h);
215     return AVERROR(EINVAL);
216 }
217
218 void av_image_copy_plane(uint8_t       *dst, int dst_linesize,
219                          const uint8_t *src, int src_linesize,
220                          int bytewidth, int height)
221 {
222     if (!dst || !src)
223         return;
224     for (;height > 0; height--) {
225         memcpy(dst, src, bytewidth);
226         dst += dst_linesize;
227         src += src_linesize;
228     }
229 }
230
231 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
232                    const uint8_t *src_data[4], const int src_linesizes[4],
233                    enum PixelFormat pix_fmt, int width, int height)
234 {
235     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[pix_fmt];
236
237     if (desc->flags & PIX_FMT_HWACCEL)
238         return;
239
240     if (desc->flags & PIX_FMT_PAL) {
241         av_image_copy_plane(dst_data[0], dst_linesizes[0],
242                             src_data[0], src_linesizes[0],
243                             width, height);
244         /* copy the palette */
245         memcpy(dst_data[1], src_data[1], 4*256);
246     } else {
247         int i, planes_nb = 0;
248
249         for (i = 0; i < desc->nb_components; i++)
250             planes_nb = FFMAX(planes_nb, desc->comp[i].plane + 1);
251
252         for (i = 0; i < planes_nb; i++) {
253             int h = height;
254             int bwidth = av_image_get_linesize(pix_fmt, width, i);
255             if (i == 1 || i == 2) {
256                 h= -((-height)>>desc->log2_chroma_h);
257             }
258             av_image_copy_plane(dst_data[i], dst_linesizes[i],
259                                 src_data[i], src_linesizes[i],
260                                 bwidth, h);
261         }
262     }
263 }