Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / dvbsub.c
1 /*
2  * DVB subtitle encoding for ffmpeg
3  * Copyright (c) 2005 Fabrice Bellard
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 "libavutil/colorspace.h"
24
25 typedef struct DVBSubtitleContext {
26     int hide_state;
27     int object_version;
28 } DVBSubtitleContext;
29
30 #define PUTBITS2(val)\
31 {\
32     bitbuf |= (val) << bitcnt;\
33     bitcnt -= 2;\
34     if (bitcnt < 0) {\
35         bitcnt = 6;\
36         *q++ = bitbuf;\
37         bitbuf = 0;\
38     }\
39 }
40
41 static void dvb_encode_rle2(uint8_t **pq,
42                             const uint8_t *bitmap, int linesize,
43                             int w, int h)
44 {
45     uint8_t *q;
46     unsigned int bitbuf;
47     int bitcnt;
48     int x, y, len, x1, v, color;
49
50     q = *pq;
51
52     for(y = 0; y < h; y++) {
53         *q++ = 0x10;
54         bitbuf = 0;
55         bitcnt = 6;
56
57         x = 0;
58         while (x < w) {
59             x1 = x;
60             color = bitmap[x1++];
61             while (x1 < w && bitmap[x1] == color)
62                 x1++;
63             len = x1 - x;
64             if (color == 0 && len == 2) {
65                 PUTBITS2(0);
66                 PUTBITS2(0);
67                 PUTBITS2(1);
68             } else if (len >= 3 && len <= 10) {
69                 v = len - 3;
70                 PUTBITS2(0);
71                 PUTBITS2((v >> 2) | 2);
72                 PUTBITS2(v & 3);
73                 PUTBITS2(color);
74             } else if (len >= 12 && len <= 27) {
75                 v = len - 12;
76                 PUTBITS2(0);
77                 PUTBITS2(0);
78                 PUTBITS2(2);
79                 PUTBITS2(v >> 2);
80                 PUTBITS2(v & 3);
81                 PUTBITS2(color);
82             } else if (len >= 29) {
83                 /* length = 29 ... 284 */
84                 if (len > 284)
85                     len = 284;
86                 v = len - 29;
87                 PUTBITS2(0);
88                 PUTBITS2(0);
89                 PUTBITS2(3);
90                 PUTBITS2((v >> 6));
91                 PUTBITS2((v >> 4) & 3);
92                 PUTBITS2((v >> 2) & 3);
93                 PUTBITS2(v & 3);
94                 PUTBITS2(color);
95             } else {
96                 PUTBITS2(color);
97                 if (color == 0) {
98                     PUTBITS2(1);
99                 }
100                 len = 1;
101             }
102             x += len;
103         }
104         /* end of line */
105         PUTBITS2(0);
106         PUTBITS2(0);
107         PUTBITS2(0);
108         if (bitcnt != 6) {
109             *q++ = bitbuf;
110         }
111         *q++ = 0xf0;
112         bitmap += linesize;
113     }
114     *pq = q;
115 }
116
117 #define PUTBITS4(val)\
118 {\
119     bitbuf |= (val) << bitcnt;\
120     bitcnt -= 4;\
121     if (bitcnt < 0) {\
122         bitcnt = 4;\
123         *q++ = bitbuf;\
124         bitbuf = 0;\
125     }\
126 }
127
128 /* some DVB decoders only implement 4 bits/pixel */
129 static void dvb_encode_rle4(uint8_t **pq,
130                             const uint8_t *bitmap, int linesize,
131                             int w, int h)
132 {
133     uint8_t *q;
134     unsigned int bitbuf;
135     int bitcnt;
136     int x, y, len, x1, v, color;
137
138     q = *pq;
139
140     for(y = 0; y < h; y++) {
141         *q++ = 0x11;
142         bitbuf = 0;
143         bitcnt = 4;
144
145         x = 0;
146         while (x < w) {
147             x1 = x;
148             color = bitmap[x1++];
149             while (x1 < w && bitmap[x1] == color)
150                 x1++;
151             len = x1 - x;
152             if (color == 0 && len == 2) {
153                 PUTBITS4(0);
154                 PUTBITS4(0xd);
155             } else if (color == 0 && (len >= 3 && len <= 9)) {
156                 PUTBITS4(0);
157                 PUTBITS4(len - 2);
158             } else if (len >= 4 && len <= 7) {
159                 PUTBITS4(0);
160                 PUTBITS4(8 + len - 4);
161                 PUTBITS4(color);
162             } else if (len >= 9 && len <= 24) {
163                 PUTBITS4(0);
164                 PUTBITS4(0xe);
165                 PUTBITS4(len - 9);
166                 PUTBITS4(color);
167             } else if (len >= 25) {
168                 if (len > 280)
169                     len = 280;
170                 v = len - 25;
171                 PUTBITS4(0);
172                 PUTBITS4(0xf);
173                 PUTBITS4(v >> 4);
174                 PUTBITS4(v & 0xf);
175                 PUTBITS4(color);
176             } else {
177                 PUTBITS4(color);
178                 if (color == 0) {
179                     PUTBITS4(0xc);
180                 }
181                 len = 1;
182             }
183             x += len;
184         }
185         /* end of line */
186         PUTBITS4(0);
187         PUTBITS4(0);
188         if (bitcnt != 4) {
189             *q++ = bitbuf;
190         }
191         *q++ = 0xf0;
192         bitmap += linesize;
193     }
194     *pq = q;
195 }
196
197 static void dvb_encode_rle8(uint8_t **pq,
198                             const uint8_t *bitmap, int linesize,
199                             int w, int h)
200 {
201     uint8_t *q;
202     int x, y, len, x1, f, color;
203
204     q = *pq;
205
206     for (y = 0; y < h; y++) {
207         *q++ = 0x12;
208
209         x = 0;
210         f = 0;
211         while (x < w) {
212             x1 = x;
213             color = bitmap[x1++];
214             while (x1 < w && bitmap[x1] == color)
215                 x1++;
216             len = x1 - x;
217             if (len == 1 && color) {
218                 // 00000001 to 11111111           1 pixel in colour x
219                 *q++ = color;
220             } else {
221                 if (color == 0x00) {
222                     // 00000000 0LLLLLLL          L pixels (1-127) in colour 0 (L > 0)
223                     len = FFMIN(len, 127);
224                     *q++ = 0x00;
225                     *q++ = len;
226                 } else if (len > 2) {
227                     // 00000000 1LLLLLLL CCCCCCCC L pixels (3-127) in colour C (L > 2)
228                     len = FFMIN(len, 127);
229                     *q++ = 0x00;
230                     *q++ = 0x80+len;
231                     *q++ = color;
232                 }
233                 else if (len == 2) {
234                     *q++ = color;
235                     *q++ = color;
236                 } else {
237                     *q++ = color;
238                     len = 1;
239                 }
240             }
241             x += len;
242         }
243         /* end of line */
244         // 00000000 00000000 end of 8-bit/pixel_code_string
245         *q++ = 0x00;
246         *q++ = 0x00;
247         bitmap += linesize;
248     }
249     *pq = q;
250 }
251
252 static int encode_dvb_subtitles(DVBSubtitleContext *s,
253                                 uint8_t *outbuf, AVSubtitle *h)
254 {
255     uint8_t *q, *pseg_len;
256     int page_id, region_id, clut_id, object_id, i, bpp_index, page_state;
257
258
259     q = outbuf;
260
261     page_id = 1;
262
263     if (h->num_rects == 0 || h->rects == NULL)
264         return -1;
265
266     *q++ = 0x00; /* subtitle_stream_id */
267
268     /* page composition segment */
269
270     *q++ = 0x0f; /* sync_byte */
271     *q++ = 0x10; /* segment_type */
272     bytestream_put_be16(&q, page_id);
273     pseg_len = q;
274     q += 2; /* segment length */
275     *q++ = 30; /* page_timeout (seconds) */
276     if (s->hide_state)
277         page_state = 0; /* normal case */
278     else
279         page_state = 2; /* mode change */
280     /* page_version = 0 + page_state */
281     *q++ = (s->object_version << 4) | (page_state << 2) | 3;
282
283     for (region_id = 0; region_id < h->num_rects; region_id++) {
284         *q++ = region_id;
285         *q++ = 0xff; /* reserved */
286         bytestream_put_be16(&q, h->rects[region_id]->x); /* left pos */
287         bytestream_put_be16(&q, h->rects[region_id]->y); /* top pos */
288     }
289
290     bytestream_put_be16(&pseg_len, q - pseg_len - 2);
291
292     if (!s->hide_state) {
293         for (clut_id = 0; clut_id < h->num_rects; clut_id++) {
294
295             /* CLUT segment */
296
297             if (h->rects[clut_id]->nb_colors <= 4) {
298                 /* 2 bpp, some decoders do not support it correctly */
299                 bpp_index = 0;
300             } else if (h->rects[clut_id]->nb_colors <= 16) {
301                 /* 4 bpp, standard encoding */
302                 bpp_index = 1;
303             } else if (h->rects[clut_id]->nb_colors <= 256) {
304                 /* 8 bpp, standard encoding */
305                 bpp_index = 2;
306             } else {
307                 return -1;
308             }
309
310
311             /* CLUT segment */
312             *q++ = 0x0f; /* sync byte */
313             *q++ = 0x12; /* CLUT definition segment */
314             bytestream_put_be16(&q, page_id);
315             pseg_len = q;
316             q += 2; /* segment length */
317             *q++ = clut_id;
318             *q++ = (0 << 4) | 0xf; /* version = 0 */
319
320             for(i = 0; i < h->rects[clut_id]->nb_colors; i++) {
321                 *q++ = i; /* clut_entry_id */
322                 *q++ = (1 << (7 - bpp_index)) | (0xf << 1) | 1; /* 2 bits/pixel full range */
323                 {
324                     int a, r, g, b;
325                     uint32_t x= ((uint32_t*)h->rects[clut_id]->pict.data[1])[i];
326                     a = (x >> 24) & 0xff;
327                     r = (x >> 16) & 0xff;
328                     g = (x >>  8) & 0xff;
329                     b = (x >>  0) & 0xff;
330
331                     *q++ = RGB_TO_Y_CCIR(r, g, b);
332                     *q++ = RGB_TO_V_CCIR(r, g, b, 0);
333                     *q++ = RGB_TO_U_CCIR(r, g, b, 0);
334                     *q++ = 255 - a;
335                 }
336             }
337
338             bytestream_put_be16(&pseg_len, q - pseg_len - 2);
339         }
340     }
341
342     for (region_id = 0; region_id < h->num_rects; region_id++) {
343
344         /* region composition segment */
345
346         if (h->rects[region_id]->nb_colors <= 4) {
347             /* 2 bpp, some decoders do not support it correctly */
348             bpp_index = 0;
349         } else if (h->rects[region_id]->nb_colors <= 16) {
350             /* 4 bpp, standard encoding */
351             bpp_index = 1;
352         } else {
353             return -1;
354         }
355
356         *q++ = 0x0f; /* sync_byte */
357         *q++ = 0x11; /* segment_type */
358         bytestream_put_be16(&q, page_id);
359         pseg_len = q;
360         q += 2; /* segment length */
361         *q++ = region_id;
362         *q++ = (s->object_version << 4) | (0 << 3) | 0x07; /* version , no fill */
363         bytestream_put_be16(&q, h->rects[region_id]->w); /* region width */
364         bytestream_put_be16(&q, h->rects[region_id]->h); /* region height */
365         *q++ = ((1 + bpp_index) << 5) | ((1 + bpp_index) << 2) | 0x03;
366         *q++ = region_id; /* clut_id == region_id */
367         *q++ = 0; /* 8 bit fill colors */
368         *q++ = 0x03; /* 4 bit and 2 bit fill colors */
369
370         if (!s->hide_state) {
371             bytestream_put_be16(&q, region_id); /* object_id == region_id */
372             *q++ = (0 << 6) | (0 << 4);
373             *q++ = 0;
374             *q++ = 0xf0;
375             *q++ = 0;
376         }
377
378         bytestream_put_be16(&pseg_len, q - pseg_len - 2);
379     }
380
381     if (!s->hide_state) {
382
383         for (object_id = 0; object_id < h->num_rects; object_id++) {
384             void (*dvb_encode_rle)(uint8_t **pq,
385                                     const uint8_t *bitmap, int linesize,
386                                     int w, int h);
387
388             /* bpp_index maths */
389             if (h->rects[object_id]->nb_colors <= 4) {
390                 /* 2 bpp, some decoders do not support it correctly */
391                 dvb_encode_rle = dvb_encode_rle2;
392             } else if (h->rects[object_id]->nb_colors <= 16) {
393                 /* 4 bpp, standard encoding */
394                 dvb_encode_rle = dvb_encode_rle4;
395             } else if (h->rects[object_id]->nb_colors <= 256) {
396                 /* 8 bpp, standard encoding */
397                 dvb_encode_rle = dvb_encode_rle8;
398             } else {
399                 return -1;
400             }
401
402             /* Object Data segment */
403             *q++ = 0x0f; /* sync byte */
404             *q++ = 0x13;
405             bytestream_put_be16(&q, page_id);
406             pseg_len = q;
407             q += 2; /* segment length */
408
409             bytestream_put_be16(&q, object_id);
410             *q++ = (s->object_version << 4) | (0 << 2) | (0 << 1) | 1; /* version = 0,
411                                                                        onject_coding_method,
412                                                                        non_modifying_color_flag */
413             {
414                 uint8_t *ptop_field_len, *pbottom_field_len, *top_ptr, *bottom_ptr;
415
416                 ptop_field_len = q;
417                 q += 2;
418                 pbottom_field_len = q;
419                 q += 2;
420
421                 top_ptr = q;
422                 dvb_encode_rle(&q, h->rects[object_id]->pict.data[0], h->rects[object_id]->w * 2,
423                                     h->rects[object_id]->w, h->rects[object_id]->h >> 1);
424                 bottom_ptr = q;
425                 dvb_encode_rle(&q, h->rects[object_id]->pict.data[0] + h->rects[object_id]->w,
426                                     h->rects[object_id]->w * 2, h->rects[object_id]->w,
427                                     h->rects[object_id]->h >> 1);
428
429                 bytestream_put_be16(&ptop_field_len, bottom_ptr - top_ptr);
430                 bytestream_put_be16(&pbottom_field_len, q - bottom_ptr);
431             }
432
433             bytestream_put_be16(&pseg_len, q - pseg_len - 2);
434         }
435     }
436
437     /* end of display set segment */
438
439     *q++ = 0x0f; /* sync_byte */
440     *q++ = 0x80; /* segment_type */
441     bytestream_put_be16(&q, page_id);
442     pseg_len = q;
443     q += 2; /* segment length */
444
445     bytestream_put_be16(&pseg_len, q - pseg_len - 2);
446
447     *q++ = 0xff; /* end of PES data */
448
449     s->object_version = (s->object_version + 1) & 0xf;
450     s->hide_state = !s->hide_state;
451     return q - outbuf;
452 }
453
454 static int dvbsub_encode(AVCodecContext *avctx,
455                        unsigned char *buf, int buf_size, void *data)
456 {
457     DVBSubtitleContext *s = avctx->priv_data;
458     AVSubtitle *sub = data;
459     int ret;
460
461     ret = encode_dvb_subtitles(s, buf, sub);
462     return ret;
463 }
464
465 AVCodec ff_dvbsub_encoder = {
466     .name           = "dvbsub",
467     .type           = AVMEDIA_TYPE_SUBTITLE,
468     .id             = CODEC_ID_DVB_SUBTITLE,
469     .priv_data_size = sizeof(DVBSubtitleContext),
470     .encode         = dvbsub_encode,
471     .long_name = NULL_IF_CONFIG_SMALL("DVB subtitles"),
472 };