git.sesse.net Git - ffmpeg/blob - 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  * Can specify all fields explicitly
  53  *
  54  * @param avctx pointer to the AVCodecContext
  55  * @param play_res_x subtitle frame width
  56  * @param play_res_y subtitle frame height
  57  * @param font name of the default font face to use
  58  * @param font_size default font size to use
  59  * @param primary_color default text color to use (ABGR)
  60  * @param secondary_color default secondary text color to use (ABGR)
  61  * @param outline_color default outline color to use (ABGR)
  62  * @param back_color default background color to use (ABGR)
  63  * @param bold 1 for bold text, 0 for normal text
  64  * @param italic 1 for italic text, 0 for normal text
  65  * @param underline 1 for underline text, 0 for normal text
  66  * @param border_style 1 for outline, 3 for opaque box
  67  * @param alignment position of the text (left, center, top...), defined after
  68  *                  the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)
  69  * @return >= 0 on success otherwise an error code <0
  70  */
  71 int ff_ass_subtitle_header_full(AVCodecContext *avctx,
  72                                 int play_res_x, int play_res_y,
  73                                 const char *font, int font_size,
  74                                 int primary_color, int secondary_color,
  75                                 int outline_color, int back_color,
  76                                 int bold, int italic, int underline,
  77                                 int border_style, int alignment);
  78 /**
  79  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
  80  *
  81  * @param avctx pointer to the AVCodecContext
  82  * @param font name of the default font face to use
  83  * @param font_size default font size to use
  84  * @param color default text color to use (ABGR)
  85  * @param back_color default background color to use (ABGR)
  86  * @param bold 1 for bold text, 0 for normal text
  87  * @param italic 1 for italic text, 0 for normal text
  88  * @param underline 1 for underline text, 0 for normal text
  89  * @param alignment position of the text (left, center, top...), defined after
  90  *                  the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)
  91  * @return >= 0 on success otherwise an error code <0
  92  */
  93 int ff_ass_subtitle_header(AVCodecContext *avctx,
  94                            const char *font, int font_size,
  95                            int color, int back_color,
  96                            int bold, int italic, int underline,
  97                            int border_style, int alignment);
  98
  99 /**
 100  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS
 101  * with default style.
 102  *
 103  * @param avctx pointer to the AVCodecContext
 104  * @return >= 0 on success otherwise an error code <0
 105  */
 106 int ff_ass_subtitle_header_default(AVCodecContext *avctx);
 107
 108 /**
 109  * Craft an ASS dialog string.
 110  */
 111 char *ff_ass_get_dialog(int readorder, int layer, const char *style,
 112                         const char *speaker, const char *text);
 113
 114 /**
 115  * Add an ASS dialog to a subtitle.
 116  */
 117 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
 118                     int readorder, int layer, const char *style,
 119                     const char *speaker);
 120
 121 /**
 122  * Helper to flush a text subtitles decoder making use of the
 123  * FFASSDecoderContext.
 124  */
 125 void ff_ass_decoder_flush(AVCodecContext *avctx);
 126
 127 /**
 128  * Escape a text subtitle using ASS syntax into an AVBPrint buffer.
 129  * Newline characters will be escaped to \N.
 130  *
 131  * @param buf pointer to an initialized AVBPrint buffer
 132  * @param p source text
 133  * @param size size of the source text
 134  * @param linebreaks additional newline chars, which will be escaped to \N
 135  * @param keep_ass_markup braces and backslash will not be escaped if set
 136  */
 137 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
 138                              const char *linebreaks, int keep_ass_markup);
 139 #endif /* AVCODEC_ASS_H */