4e2ff2c144d74ecfc0e887e93eadc5abe00fa092
[ffmpeg.git] / libavcodec / textdec.c
1 /*
2  * Copyright (c) 2012 Clément Bœsch
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * Raw subtitles decoder
24  */
25
26 #include "avcodec.h"
27 #include "ass.h"
28 #include "libavutil/bprint.h"
29 #include "libavutil/opt.h"
30
31 typedef struct {
32     AVClass *class;
33     const char *linebreaks;
34     int keep_ass_markup;
35     int readorder;
36 } TextContext;
37
38 #define OFFSET(x) offsetof(TextContext, x)
39 #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
40 static const AVOption options[] = {
41     { "keep_ass_markup", "Set if ASS tags must be escaped", OFFSET(keep_ass_markup), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, .flags=SD },
42     { NULL }
43 };
44
45 static int text_decode_frame(AVCodecContext *avctx, void *data,
46                              int *got_sub_ptr, AVPacket *avpkt)
47 {
48     int ret = 0;
49     AVBPrint buf;
50     AVSubtitle *sub = data;
51     const char *ptr = avpkt->data;
52     TextContext *text = avctx->priv_data;
53
54     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
55     if (ptr && avpkt->size > 0 && *ptr) {
56         ff_ass_bprint_text_event(&buf, ptr, avpkt->size, text->linebreaks, text->keep_ass_markup);
57         ret = ff_ass_add_rect(sub, buf.str, text->readorder++, 0, NULL, NULL);
58     }
59     av_bprint_finalize(&buf, NULL);
60     if (ret < 0)
61         return ret;
62     *got_sub_ptr = sub->num_rects > 0;
63     return avpkt->size;
64 }
65
66 static void text_flush(AVCodecContext *avctx)
67 {
68     TextContext *text = avctx->priv_data;
69     text->readorder = 0;
70 }
71
72 #define DECLARE_CLASS(decname) static const AVClass decname ## _decoder_class = {   \
73     .class_name = #decname " decoder",      \
74     .item_name  = av_default_item_name,     \
75     .option     = decname ## _options,      \
76     .version    = LIBAVUTIL_VERSION_INT,    \
77 }
78
79 #if CONFIG_TEXT_DECODER
80 #define text_options options
81 DECLARE_CLASS(text);
82
83 AVCodec ff_text_decoder = {
84     .name           = "text",
85     .long_name      = NULL_IF_CONFIG_SMALL("Raw text subtitle"),
86     .priv_data_size = sizeof(TextContext),
87     .type           = AVMEDIA_TYPE_SUBTITLE,
88     .id             = AV_CODEC_ID_TEXT,
89     .decode         = text_decode_frame,
90     .init           = ff_ass_subtitle_header_default,
91     .priv_class     = &text_decoder_class,
92     .flush          = text_flush,
93 };
94 #endif
95
96 #if CONFIG_VPLAYER_DECODER || CONFIG_PJS_DECODER || CONFIG_SUBVIEWER1_DECODER || CONFIG_STL_DECODER
97
98 static int linebreak_init(AVCodecContext *avctx)
99 {
100     TextContext *text = avctx->priv_data;
101     text->linebreaks = "|";
102     return ff_ass_subtitle_header_default(avctx);
103 }
104
105 #if CONFIG_VPLAYER_DECODER
106 #define vplayer_options options
107 DECLARE_CLASS(vplayer);
108
109 AVCodec ff_vplayer_decoder = {
110     .name           = "vplayer",
111     .long_name      = NULL_IF_CONFIG_SMALL("VPlayer subtitle"),
112     .priv_data_size = sizeof(TextContext),
113     .type           = AVMEDIA_TYPE_SUBTITLE,
114     .id             = AV_CODEC_ID_VPLAYER,
115     .decode         = text_decode_frame,
116     .init           = linebreak_init,
117     .priv_class     = &vplayer_decoder_class,
118     .flush          = text_flush,
119 };
120 #endif
121
122 #if CONFIG_STL_DECODER
123 #define stl_options options
124 DECLARE_CLASS(stl);
125
126 AVCodec ff_stl_decoder = {
127     .name           = "stl",
128     .long_name      = NULL_IF_CONFIG_SMALL("Spruce subtitle format"),
129     .priv_data_size = sizeof(TextContext),
130     .type           = AVMEDIA_TYPE_SUBTITLE,
131     .id             = AV_CODEC_ID_STL,
132     .decode         = text_decode_frame,
133     .init           = linebreak_init,
134     .priv_class     = &stl_decoder_class,
135     .flush          = text_flush,
136 };
137 #endif
138
139 #if CONFIG_PJS_DECODER
140 #define pjs_options options
141 DECLARE_CLASS(pjs);
142
143 AVCodec ff_pjs_decoder = {
144     .name           = "pjs",
145     .long_name      = NULL_IF_CONFIG_SMALL("PJS subtitle"),
146     .priv_data_size = sizeof(TextContext),
147     .type           = AVMEDIA_TYPE_SUBTITLE,
148     .id             = AV_CODEC_ID_PJS,
149     .decode         = text_decode_frame,
150     .init           = linebreak_init,
151     .priv_class     = &pjs_decoder_class,
152     .flush          = text_flush,
153 };
154 #endif
155
156 #if CONFIG_SUBVIEWER1_DECODER
157 #define subviewer1_options options
158 DECLARE_CLASS(subviewer1);
159
160 AVCodec ff_subviewer1_decoder = {
161     .name           = "subviewer1",
162     .long_name      = NULL_IF_CONFIG_SMALL("SubViewer1 subtitle"),
163     .priv_data_size = sizeof(TextContext),
164     .type           = AVMEDIA_TYPE_SUBTITLE,
165     .id             = AV_CODEC_ID_SUBVIEWER1,
166     .decode         = text_decode_frame,
167     .init           = linebreak_init,
168     .priv_class     = &subviewer1_decoder_class,
169     .flush          = text_flush,
170 };
171 #endif
172
173 #endif /* text subtitles with '|' line break */