1/*
2 * SSA/ASS common funtions
3 * Copyright (c) 2010  Aurelien Jacobs <aurel@gnuage.org>
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; 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 * @name Default values for ASS style
29 * @{
30 */
31#define ASS_DEFAULT_FONT        "Arial"
32#define ASS_DEFAULT_FONT_SIZE   16
33#define ASS_DEFAULT_COLOR       0xffffff
34#define ASS_DEFAULT_BACK_COLOR  0
35#define ASS_DEFAULT_BOLD        0
36#define ASS_DEFAULT_ITALIC      0
37#define ASS_DEFAULT_UNDERLINE   0
38#define ASS_DEFAULT_ALIGNMENT   2
39/** @} */
40
41/**
42 * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS
43 * with default style.
44 *
45 * @param avctx pointer to the AVCodecContext
46 * @return >= 0 on success otherwise an error code <0
47 */
48int ff_ass_subtitle_header_default(AVCodecContext *avctx);
49
50/**
51 * Initialize an AVSubtitle structure for use with ff_ass_add_rect().
52 *
53 * @param sub pointer to the AVSubtitle
54 */
55void ff_ass_init(AVSubtitle *sub);
56
57/**
58 * Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.
59 *
60 * @param sub pointer to the AVSubtitle
61 * @param dialog ASS dialog to add to sub
62 * @param ts_start start timestamp for this dialog (in 1/100 second unit)
63 * @param ts_end end timestamp for this dialog (in 1/100 second unit)
64 * @param raw when set to 1, it indicates that dialog contains a whole ASS
65 *                           dialog line which should be copied as is.
66 *            when set to 0, it indicates that dialog contains only the Text
67 *                           part of the ASS dialog line, the rest of the line
68 *                           will be generated.
69 * @return number of characters read from dialog. It can be less than the whole
70 *         length of dialog, if dialog contains several lines of text.
71 *         A negative value indicates an error.
72 */
73int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
74                    int ts_start, int ts_end, int raw);
75
76#endif /* AVCODEC_ASS_H */
77