avcodec/nvenc: support external context in sw mode
[ffmpeg.git] / libavcodec / ass.h
1 /*
2  * SSA/ASS common functions
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 #include "libavutil/bprint.h"
27
28 #define ASS_DEFAULT_PLAYRESX 384
29 #define ASS_DEFAULT_PLAYRESY 288
30
31 /**
32  * @name Default values for ASS style
33  * @{
34  */
35 #define ASS_DEFAULT_FONT        "Arial"
36 #define ASS_DEFAULT_FONT_SIZE   16
37 #define ASS_DEFAULT_COLOR       0xffffff
38 #define ASS_DEFAULT_BACK_COLOR  0
39 #define ASS_DEFAULT_BOLD        0
40 #define ASS_DEFAULT_ITALIC      0
41 #define ASS_DEFAULT_UNDERLINE   0
42 #define ASS_DEFAULT_ALIGNMENT   2
43 #define ASS_DEFAULT_BORDERSTYLE 1
44 /** @} */
45
46 typedef struct FFASSDecoderContext {
47     int readorder;
48 } FFASSDecoderContext;
49
50 /**
51  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
52  *
53  * @param avctx pointer to the AVCodecContext
54  * @param font name of the default font face to use
55  * @param font_size default font size to use
56  * @param color default text color to use (ABGR)
57  * @param back_color default background color to use (ABGR)
58  * @param bold 1 for bold text, 0 for normal text
59  * @param italic 1 for italic text, 0 for normal text
60  * @param underline 1 for underline text, 0 for normal text
61  * @param alignment position of the text (left, center, top...), defined after
62  *                  the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)
63  * @return >= 0 on success otherwise an error code <0
64  */
65 int ff_ass_subtitle_header(AVCodecContext *avctx,
66                            const char *font, int font_size,
67                            int color, int back_color,
68                            int bold, int italic, int underline,
69                            int border_style, int alignment);
70
71 /**
72  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS
73  * with default style.
74  *
75  * @param avctx pointer to the AVCodecContext
76  * @return >= 0 on success otherwise an error code <0
77  */
78 int ff_ass_subtitle_header_default(AVCodecContext *avctx);
79
80 /**
81  * Craft an ASS dialog string.
82  */
83 char *ff_ass_get_dialog(int readorder, int layer, const char *style,
84                         const char *speaker, const char *text);
85
86 /**
87  * Add an ASS dialog to a subtitle.
88  */
89 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
90                     int readorder, int layer, const char *style,
91                     const char *speaker);
92
93 /**
94  * Helper to flush a text subtitles decoder making use of the
95  * FFASSDecoderContext.
96  */
97 void ff_ass_decoder_flush(AVCodecContext *avctx);
98
99 /**
100  * Escape a text subtitle using ASS syntax into an AVBPrint buffer.
101  * Newline characters will be escaped to \N.
102  *
103  * @param buf pointer to an initialized AVBPrint buffer
104  * @param p source text
105  * @param size size of the source text
106  * @param linebreaks additional newline chars, which will be escaped to \N
107  * @param keep_ass_markup braces and backslash will not be escaped if set
108  */
109 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
110                              const char *linebreaks, int keep_ass_markup);
111 #endif /* AVCODEC_ASS_H */