lavc: add ff_bprint_to_extradata() helper and use it.
[ffmpeg.git] / libavcodec / dvdsubenc.c
1 /*
2  * DVD subtitle encoding
3  * Copyright (c) 2005 Wolfram Gloger
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #include "avcodec.h"
22 #include "bytestream.h"
23 #include "internal.h"
24 #include "libavutil/avassert.h"
25 #include "libavutil/bprint.h"
26 #include "libavutil/imgutils.h"
27
28 typedef struct {
29     uint32_t global_palette[16];
30 } DVDSubtitleContext;
31
32 // ncnt is the nibble counter
33 #define PUTNIBBLE(val)\
34 do {\
35     if (ncnt++ & 1)\
36         *q++ = bitbuf | ((val) & 0x0f);\
37     else\
38         bitbuf = (val) << 4;\
39 } while(0)
40
41 static void dvd_encode_rle(uint8_t **pq,
42                            const uint8_t *bitmap, int linesize,
43                            int w, int h,
44                            const int cmap[256])
45 {
46     uint8_t *q;
47     unsigned int bitbuf = 0;
48     int ncnt;
49     int x, y, len, color;
50
51     q = *pq;
52
53     for (y = 0; y < h; ++y) {
54         ncnt = 0;
55         for(x = 0; x < w; x += len) {
56             color = bitmap[x];
57             for (len=1; x+len < w; ++len)
58                 if (bitmap[x+len] != color)
59                     break;
60             color = cmap[color];
61             av_assert0(color < 4);
62             if (len < 0x04) {
63                 PUTNIBBLE((len << 2)|color);
64             } else if (len < 0x10) {
65                 PUTNIBBLE(len >> 2);
66                 PUTNIBBLE((len << 2)|color);
67             } else if (len < 0x40) {
68                 PUTNIBBLE(0);
69                 PUTNIBBLE(len >> 2);
70                 PUTNIBBLE((len << 2)|color);
71             } else if (x+len == w) {
72                 PUTNIBBLE(0);
73                 PUTNIBBLE(0);
74                 PUTNIBBLE(0);
75                 PUTNIBBLE(color);
76             } else {
77                 if (len > 0xff)
78                     len = 0xff;
79                 PUTNIBBLE(0);
80                 PUTNIBBLE(len >> 6);
81                 PUTNIBBLE(len >> 2);
82                 PUTNIBBLE((len << 2)|color);
83             }
84         }
85         /* end of line */
86         if (ncnt & 1)
87             PUTNIBBLE(0);
88         bitmap += linesize;
89     }
90
91     *pq = q;
92 }
93
94 static int color_distance(uint32_t a, uint32_t b)
95 {
96     int r = 0, d, i;
97
98     for (i = 0; i < 32; i += 8) {
99         d = ((a >> i) & 0xFF) - ((b >> i) & 0xFF);
100         r += d * d;
101     }
102     return r;
103 }
104
105 /**
106  * Count colors used in a rectangle, quantizing alpha and grouping by
107  * nearest global palette entry.
108  */
109 static void count_colors(AVCodecContext *avctx, unsigned hits[33],
110                          const AVSubtitleRect *r)
111 {
112     DVDSubtitleContext *dvdc = avctx->priv_data;
113     unsigned count[256] = { 0 };
114     uint32_t *palette = (uint32_t *)r->pict.data[1];
115     uint32_t color;
116     int x, y, i, j, match, d, best_d, av_uninit(best_j);
117     uint8_t *p = r->pict.data[0];
118
119     for (y = 0; y < r->h; y++) {
120         for (x = 0; x < r->w; x++)
121             count[*(p++)]++;
122         p += r->pict.linesize[0] - r->w;
123     }
124     for (i = 0; i < 256; i++) {
125         if (!count[i]) /* avoid useless search */
126             continue;
127         color = palette[i];
128         /* 0: transparent, 1-16: semi-transparent, 17-33 opaque */
129         match = color < 0x33000000 ? 0 : color < 0xCC000000 ? 1 : 17;
130         if (match) {
131             best_d = INT_MAX;
132             for (j = 0; j < 16; j++) {
133                 d = color_distance(color & 0xFFFFFF, dvdc->global_palette[j]);
134                 if (d < best_d) {
135                     best_d = d;
136                     best_j = j;
137                 }
138             }
139             match += best_j;
140         }
141         hits[match] += count[i];
142     }
143 }
144
145 static void select_palette(AVCodecContext *avctx, int out_palette[4],
146                            int out_alpha[4], unsigned hits[33])
147 {
148     DVDSubtitleContext *dvdc = avctx->priv_data;
149     int i, j, bright, mult;
150     uint32_t color;
151     int selected[4] = { 0 };
152     uint32_t pseudopal[33] = { 0 };
153     uint32_t refcolor[3] = { 0x00000000, 0xFFFFFFFF, 0xFF000000 };
154
155     /* Bonus for transparent: if the rectangle fits tightly the text, the
156        background color can be quite rare, but it would be ugly without it */
157     hits[0] *= 16;
158     /* Bonus for bright colors */
159     for (i = 0; i < 16; i++) {
160         if (!(hits[1 + i] + hits[17 + i]))
161             continue; /* skip unused colors to gain time */
162         color = dvdc->global_palette[i];
163         bright = 0;
164         for (j = 0; j < 3; j++, color >>= 8)
165             bright += (color & 0xFF) < 0x40 || (color & 0xFF) >= 0xC0;
166         mult = 2 + FFMIN(bright, 2);
167         hits[ 1 + i] *= mult;
168         hits[17 + i] *= mult;
169     }
170
171     /* Select four most frequent colors */
172     for (i = 0; i < 4; i++) {
173         for (j = 0; j < 33; j++)
174             if (hits[j] > hits[selected[i]])
175                 selected[i] = j;
176         hits[selected[i]] = 0;
177     }
178
179     /* Order the colors like in most DVDs:
180        0: background, 1: foreground, 2: outline */
181     for (i = 0; i < 16; i++) {
182         pseudopal[ 1 + i] = 0x80000000 | dvdc->global_palette[i];
183         pseudopal[17 + i] = 0xFF000000 | dvdc->global_palette[i];
184     }
185     for (i = 0; i < 3; i++) {
186         int best_d = color_distance(refcolor[i], pseudopal[selected[i]]);
187         for (j = i + 1; j < 4; j++) {
188             int d = color_distance(refcolor[i], pseudopal[selected[j]]);
189             if (d < best_d) {
190                 FFSWAP(int, selected[i], selected[j]);
191                 best_d = d;
192             }
193         }
194     }
195
196     /* Output */
197     for (i = 0; i < 4; i++) {
198         out_palette[i] = selected[i] ? (selected[i] - 1) & 0xF : 0;
199         out_alpha  [i] = !selected[i] ? 0 : selected[i] < 17 ? 0x80 : 0xFF;
200     }
201 }
202
203 static void build_color_map(AVCodecContext *avctx, int cmap[],
204                             const uint32_t palette[],
205                             const int out_palette[], int const out_alpha[])
206 {
207     DVDSubtitleContext *dvdc = avctx->priv_data;
208     int i, j, d, best_d;
209     uint32_t pseudopal[4];
210
211     for (i = 0; i < 4; i++)
212         pseudopal[i] = (out_alpha[i] << 24) |
213                        dvdc->global_palette[out_palette[i]];
214     for (i = 0; i < 256; i++) {
215         best_d = INT_MAX;
216         for (j = 0; j < 4; j++) {
217             d = color_distance(pseudopal[j], palette[i]);
218             if (d < best_d) {
219                 cmap[i] = j;
220                 best_d = d;
221             }
222         }
223     }
224 }
225
226 static void copy_rectangle(AVSubtitleRect *dst, AVSubtitleRect *src, int cmap[])
227 {
228     int x, y;
229     uint8_t *p, *q;
230
231     p = src->pict.data[0];
232     q = dst->pict.data[0] + (src->x - dst->x) +
233                             (src->y - dst->y) * dst->pict.linesize[0];
234     for (y = 0; y < src->h; y++) {
235         for (x = 0; x < src->w; x++)
236             *(q++) = cmap[*(p++)];
237         p += src->pict.linesize[0] - src->w;
238         q += dst->pict.linesize[0] - src->w;
239     }
240 }
241
242 static int encode_dvd_subtitles(AVCodecContext *avctx,
243                                 uint8_t *outbuf, int outbuf_size,
244                                 const AVSubtitle *h)
245 {
246     DVDSubtitleContext *dvdc = avctx->priv_data;
247     uint8_t *q, *qq;
248     int offset1, offset2;
249     int i, rects = h->num_rects, ret;
250     unsigned global_palette_hits[33] = { 0 };
251     int cmap[256];
252     int out_palette[4];
253     int out_alpha[4];
254     AVSubtitleRect vrect;
255     uint8_t *vrect_data = NULL;
256     int x2, y2;
257
258     if (rects == 0 || h->rects == NULL)
259         return AVERROR(EINVAL);
260     for (i = 0; i < rects; i++)
261         if (h->rects[i]->type != SUBTITLE_BITMAP) {
262             av_log(avctx, AV_LOG_ERROR, "Bitmap subtitle required\n");
263             return AVERROR(EINVAL);
264         }
265     vrect = *h->rects[0];
266
267     if (rects > 1) {
268         /* DVD subtitles can have only one rectangle: build a virtual
269            rectangle containing all actual rectangles.
270            The data of the rectangles will be copied later, when the palette
271            is decided, because the rectangles may have different palettes. */
272         int xmin = h->rects[0]->x, xmax = xmin + h->rects[0]->w;
273         int ymin = h->rects[0]->y, ymax = ymin + h->rects[0]->h;
274         for (i = 1; i < rects; i++) {
275             xmin = FFMIN(xmin, h->rects[i]->x);
276             ymin = FFMIN(ymin, h->rects[i]->y);
277             xmax = FFMAX(xmax, h->rects[i]->x + h->rects[i]->w);
278             ymax = FFMAX(ymax, h->rects[i]->y + h->rects[i]->h);
279         }
280         vrect.x = xmin;
281         vrect.y = ymin;
282         vrect.w = xmax - xmin;
283         vrect.h = ymax - ymin;
284         if ((ret = av_image_check_size(vrect.w, vrect.h, 0, avctx)) < 0)
285             return ret;
286
287         /* Count pixels outside the virtual rectangle as transparent */
288         global_palette_hits[0] = vrect.w * vrect.h;
289         for (i = 0; i < rects; i++)
290             global_palette_hits[0] -= h->rects[i]->w * h->rects[i]->h;
291     }
292
293     for (i = 0; i < rects; i++)
294         count_colors(avctx, global_palette_hits, h->rects[i]);
295     select_palette(avctx, out_palette, out_alpha, global_palette_hits);
296
297     if (rects > 1) {
298         if (!(vrect_data = av_calloc(vrect.w, vrect.h)))
299             return AVERROR(ENOMEM);
300         vrect.pict.data    [0] = vrect_data;
301         vrect.pict.linesize[0] = vrect.w;
302         for (i = 0; i < rects; i++) {
303             build_color_map(avctx, cmap, (uint32_t *)h->rects[i]->pict.data[1],
304                             out_palette, out_alpha);
305             copy_rectangle(&vrect, h->rects[i], cmap);
306         }
307         for (i = 0; i < 4; i++)
308             cmap[i] = i;
309     } else {
310         build_color_map(avctx, cmap, (uint32_t *)h->rects[0]->pict.data[1],
311                         out_palette, out_alpha);
312     }
313
314     av_log(avctx, AV_LOG_DEBUG, "Selected palette:");
315     for (i = 0; i < 4; i++)
316         av_log(avctx, AV_LOG_DEBUG, " 0x%06x@@%02x (0x%x,0x%x)",
317                dvdc->global_palette[out_palette[i]], out_alpha[i],
318                out_palette[i], out_alpha[i] >> 4);
319     av_log(avctx, AV_LOG_DEBUG, "\n");
320
321     // encode data block
322     q = outbuf + 4;
323     offset1 = q - outbuf;
324     // worst case memory requirement: 1 nibble per pixel..
325     if ((q - outbuf) + vrect.w * vrect.h / 2 + 17 + 21 > outbuf_size) {
326         av_log(NULL, AV_LOG_ERROR, "dvd_subtitle too big\n");
327         ret = AVERROR_BUFFER_TOO_SMALL;
328         goto fail;
329     }
330     dvd_encode_rle(&q, vrect.pict.data[0], vrect.w * 2,
331                    vrect.w, (vrect.h + 1) >> 1, cmap);
332     offset2 = q - outbuf;
333     dvd_encode_rle(&q, vrect.pict.data[0] + vrect.w, vrect.w * 2,
334                    vrect.w, vrect.h >> 1, cmap);
335
336     // set data packet size
337     qq = outbuf + 2;
338     bytestream_put_be16(&qq, q - outbuf);
339
340     // send start display command
341     bytestream_put_be16(&q, (h->start_display_time*90) >> 10);
342     bytestream_put_be16(&q, (q - outbuf) /*- 2 */ + 8 + 12 + 2);
343     *q++ = 0x03; // palette - 4 nibbles
344     *q++ = (out_palette[3] << 4) | out_palette[2];
345     *q++ = (out_palette[1] << 4) | out_palette[0];
346     *q++ = 0x04; // alpha - 4 nibbles
347     *q++ = (out_alpha[3] & 0xF0) | (out_alpha[2] >> 4);
348     *q++ = (out_alpha[1] & 0xF0) | (out_alpha[0] >> 4);
349
350     // 12 bytes per rect
351     x2 = vrect.x + vrect.w - 1;
352     y2 = vrect.y + vrect.h - 1;
353
354     *q++ = 0x05;
355     // x1 x2 -> 6 nibbles
356     *q++ = vrect.x >> 4;
357     *q++ = (vrect.x << 4) | ((x2 >> 8) & 0xf);
358     *q++ = x2;
359     // y1 y2 -> 6 nibbles
360     *q++ = vrect.y >> 4;
361     *q++ = (vrect.y << 4) | ((y2 >> 8) & 0xf);
362     *q++ = y2;
363
364     *q++ = 0x06;
365     // offset1, offset2
366     bytestream_put_be16(&q, offset1);
367     bytestream_put_be16(&q, offset2);
368
369     *q++ = 0x01; // start command
370     *q++ = 0xff; // terminating command
371
372     // send stop display command last
373     bytestream_put_be16(&q, (h->end_display_time*90) >> 10);
374     bytestream_put_be16(&q, (q - outbuf) - 2 /*+ 4*/);
375     *q++ = 0x02; // set end
376     *q++ = 0xff; // terminating command
377
378     qq = outbuf;
379     bytestream_put_be16(&qq, q - outbuf);
380
381     av_log(NULL, AV_LOG_DEBUG, "subtitle_packet size=%td\n", q - outbuf);
382     ret = q - outbuf;
383
384 fail:
385     av_free(vrect_data);
386     return ret;
387 }
388
389 static int dvdsub_init(AVCodecContext *avctx)
390 {
391     DVDSubtitleContext *dvdc = avctx->priv_data;
392     static const uint32_t default_palette[16] = {
393         0x000000, 0x0000FF, 0x00FF00, 0xFF0000,
394         0xFFFF00, 0xFF00FF, 0x00FFFF, 0xFFFFFF,
395         0x808000, 0x8080FF, 0x800080, 0x80FF80,
396         0x008080, 0xFF8080, 0x555555, 0xAAAAAA,
397     };
398     AVBPrint extradata;
399     int i, ret;
400
401     av_assert0(sizeof(dvdc->global_palette) == sizeof(default_palette));
402     memcpy(dvdc->global_palette, default_palette, sizeof(dvdc->global_palette));
403
404     av_bprint_init(&extradata, 0, 1);
405     if (avctx->width && avctx->height)
406         av_bprintf(&extradata, "size: %dx%d\n", avctx->width, avctx->height);
407     av_bprintf(&extradata, "palette:");
408     for (i = 0; i < 16; i++)
409         av_bprintf(&extradata, " %06"PRIx32"%c",
410                    dvdc->global_palette[i] & 0xFFFFFF, i < 15 ? ',' : '\n');
411
412     ret = ff_bprint_to_extradata(avctx, &extradata);
413     if (ret < 0)
414         return ret;
415
416     return 0;
417 }
418
419 static int dvdsub_encode(AVCodecContext *avctx,
420                          unsigned char *buf, int buf_size,
421                          const AVSubtitle *sub)
422 {
423     //DVDSubtitleContext *s = avctx->priv_data;
424     int ret;
425
426     ret = encode_dvd_subtitles(avctx, buf, buf_size, sub);
427     return ret;
428 }
429
430 AVCodec ff_dvdsub_encoder = {
431     .name           = "dvdsub",
432     .type           = AVMEDIA_TYPE_SUBTITLE,
433     .id             = AV_CODEC_ID_DVD_SUBTITLE,
434     .init           = dvdsub_init,
435     .encode_sub     = dvdsub_encode,
436     .long_name      = NULL_IF_CONFIG_SMALL("DVD subtitles"),
437     .priv_data_size = sizeof(DVDSubtitleContext),
438 };