Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Last modification | View Log | RSS feed

  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.  
  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.  *
  44.  * @param avctx pointer to the AVCodecContext
  45.  * @param font name of the default font face to use
  46.  * @param font_size default font size to use
  47.  * @param color default text color to use (ABGR)
  48.  * @param back_color default background color to use (ABGR)
  49.  * @param bold 1 for bold text, 0 for normal text
  50.  * @param italic 1 for italic text, 0 for normal text
  51.  * @param underline 1 for underline text, 0 for normal text
  52.  * @param alignment position of the text (left, center, top...), defined after
  53.  *                  the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)
  54.  * @return >= 0 on success otherwise an error code <0
  55.  */
  56. int ff_ass_subtitle_header(AVCodecContext *avctx,
  57.                            const char *font, int font_size,
  58.                            int color, int back_color,
  59.                            int bold, int italic, int underline,
  60.                            int alignment);
  61.  
  62. /**
  63.  * Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS
  64.  * with default style.
  65.  *
  66.  * @param avctx pointer to the AVCodecContext
  67.  * @return >= 0 on success otherwise an error code <0
  68.  */
  69. int ff_ass_subtitle_header_default(AVCodecContext *avctx);
  70.  
  71. /**
  72.  * Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.
  73.  *
  74.  * @param sub pointer to the AVSubtitle
  75.  * @param dialog ASS dialog to add to sub
  76.  * @param ts_start start timestamp for this dialog (in 1/100 second unit)
  77.  * @param duration duration for this dialog (in 1/100 second unit), can be -1
  78.  *                 to last until the end of the presentation
  79.  * @param raw when set to 2, it indicates that dialog contains an ASS
  80.  *                           dialog line as muxed in Matroska
  81.  *            when set to 1, it indicates that dialog contains a whole SSA
  82.  *                           dialog line which should be copied as is.
  83.  *            when set to 0, it indicates that dialog contains only the Text
  84.  *                           part of the ASS dialog line, the rest of the line
  85.  *                           will be generated.
  86.  * @return number of characters read from dialog. It can be less than the whole
  87.  *         length of dialog, if dialog contains several lines of text.
  88.  *         A negative value indicates an error.
  89.  */
  90. int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
  91.                     int ts_start, int duration, int raw);
  92.  
  93. #endif /* AVCODEC_ASS_H */
  94.