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 /** @} */
  44
  45 /**
  46  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
  47  *
  48  * @param avctx pointer to the AVCodecContext
  49  * @param font name of the default font face to use
  50  * @param font_size default font size to use
  51  * @param color default text color to use (ABGR)
  52  * @param back_color default background color to use (ABGR)
  53  * @param bold 1 for bold text, 0 for normal text
  54  * @param italic 1 for italic text, 0 for normal text
  55  * @param underline 1 for underline text, 0 for normal text
  56  * @param alignment position of the text (left, center, top...), defined after
  57  *                  the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)
  58  * @return >= 0 on success otherwise an error code <0
  59  */
  60 int ff_ass_subtitle_header(AVCodecContext *avctx,
  61                            const char *font, int font_size,
  62                            int color, int back_color,
  63                            int bold, int italic, int underline,
  64                            int alignment);
  65
  66 /**
  67  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS
  68  * with default style.
  69  *
  70  * @param avctx pointer to the AVCodecContext
  71  * @return >= 0 on success otherwise an error code <0
  72  */
  73 int ff_ass_subtitle_header_default(AVCodecContext *avctx);
  74
  75 /**
  76  * Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.
  77  *
  78  * @param sub pointer to the AVSubtitle
  79  * @param dialog ASS dialog to add to sub
  80  * @param ts_start start timestamp for this dialog (in 1/100 second unit)
  81  * @param duration duration for this dialog (in 1/100 second unit), can be -1
  82  *                 to last until the end of the presentation
  83  * @param raw when set to 2, it indicates that dialog contains an ASS
  84  *                           dialog line as muxed in Matroska
  85  *            when set to 1, it indicates that dialog contains a whole SSA
  86  *                           dialog line which should be copied as is.
  87  *            when set to 0, it indicates that dialog contains only the Text
  88  *                           part of the ASS dialog line, the rest of the line
  89  *                           will be generated.
  90  * @return number of characters read from dialog. It can be less than the whole
  91  *         length of dialog, if dialog contains several lines of text.
  92  *         A negative value indicates an error.
  93  */
  94 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
  95                     int ts_start, int duration, int raw);
  96
  97 /**
  98  * Same as ff_ass_add_rect_bprint, but taking an AVBPrint buffer instead of a
  99  * string, and assuming raw=0.
 100  */
 101 int ff_ass_add_rect_bprint(AVSubtitle *sub, AVBPrint *buf,
 102                            int ts_start, int duration);
 103
 104 /**
 105  * Add an ASS dialog line to an AVBPrint buffer.
 106  *
 107  * @param buf pointer to an initialized AVBPrint buffer
 108  * @param dialog ASS dialog to add to sub
 109  * @param ts_start start timestamp for this dialog (in 1/100 second unit)
 110  * @param duration duration for this dialog (in 1/100 second unit), can be -1
 111  *                 to last until the end of the presentation
 112  * @param raw when set to 2, it indicates that dialog contains an ASS
 113  *                           dialog line as muxed in Matroska
 114  *            when set to 1, it indicates that dialog contains a whole SSA
 115  *                           dialog line which should be copied as is.
 116  *            when set to 0, it indicates that dialog contains only the Text
 117  *                           part of the ASS dialog line, the rest of the line
 118  *                           will be generated.
 119  * @return number of characters read from dialog. It can be less than the whole
 120  *         length of dialog, if dialog contains several lines of text.
 121  *         A negative value indicates an error.
 122  */
 123 int ff_ass_bprint_dialog(AVBPrint *buf, const char *dialog,
 124                          int ts_start, int duration, int raw);
 125
 126 /**
 127  * Escape a text subtitle using ASS syntax into an AVBPrint buffer.
 128  * Newline characters will be escaped to \N.
 129  *
 130  * @param buf pointer to an initialized AVBPrint buffer
 131  * @param p source text
 132  * @param size size of the source text
 133  * @param linebreaks additional newline chars, which will be escaped to \N
 134  * @param keep_ass_markup braces and backslash will not be escaped if set
 135  */
 136 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
 137                              const char *linebreaks, int keep_ass_markup);
 138 #endif /* AVCODEC_ASS_H */