add missing files in previous commit (ASS encoder and decoder)
[libav.git] / libavcodec / ass.h
1 /*
2 * SSA/ASS common funtions
3 * Copyright (c) 2010 Aurelien Jacobs <aurel@gnuage.org>
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
22 #ifndef AVCODEC_ASS_H
23 #define AVCODEC_ASS_H
24
25 #include "avcodec.h"
26
27 /**
28 * Initialize an AVSubtitle structure for use with ff_ass_add_rect().
29 *
30 * @param sub pointer to the AVSubtitle
31 */
32 void ff_ass_init(AVSubtitle *sub);
33
34 /**
35 * Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.
36 *
37 * @param sub pointer to the AVSubtitle
38 * @param dialog ASS dialog to add to sub
39 * @param ts_start start timestamp for this dialog (in 1/100 second unit)
40 * @param ts_end end timestamp for this dialog (in 1/100 second unit)
41 * @param raw when set to 1, it indicates that dialog contains a whole ASS
42 * dialog line which should be copied as is.
43 * when set to 0, it indicates that dialog contains only the Text
44 * part of the ASS dialog line, the rest of the line
45 * will be generated.
46 * @return number of characters read from dialog. It can be less than the whole
47 * length of dialog, if dialog contains several lines of text.
48 * A negative value indicates an error.
49 */
50 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
51 int ts_start, int ts_end, int raw);
52
53 #endif /* AVCODEC_ASS_H */