sub/subreader.h

   1 /*
   2  * This file is part of MPlayer.
   3  *
   4  * MPlayer is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * MPlayer is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef MPLAYER_SUBREADER_H
  20 #define MPLAYER_SUBREADER_H
  21
  22 #include <stdio.h>
  23 #include <stdbool.h>
  24
  25 #include "config.h"
  26
  27 extern int suboverlap_enabled;
  28 extern int sub_no_text_pp;  // disable text post-processing
  29 extern int sub_match_fuzziness;
  30
  31 // subtitle formats
  32 #define SUB_INVALID   -1
  33 #define SUB_MICRODVD  0
  34 #define SUB_SUBRIP    1
  35 #define SUB_SUBVIEWER 2
  36 #define SUB_SAMI      3
  37 #define SUB_VPLAYER   4
  38 #define SUB_RT        5
  39 #define SUB_SSA       6
  40 #define SUB_PJS       7
  41 #define SUB_MPSUB     8
  42 #define SUB_AQTITLE   9
  43 #define SUB_SUBVIEWER2 10
  44 #define SUB_SUBRIP09 11
  45 #define SUB_JACOSUB  12
  46 #define SUB_MPL2     13
  47
  48 // One of the SUB_* constant above
  49 extern int sub_format;
  50
  51 #define SUB_MAX_TEXT 12
  52 #define SUB_ALIGNMENT_BOTTOMLEFT       1
  53 #define SUB_ALIGNMENT_BOTTOMCENTER     2
  54 #define SUB_ALIGNMENT_BOTTOMRIGHT      3
  55 #define SUB_ALIGNMENT_MIDDLELEFT       4
  56 #define SUB_ALIGNMENT_MIDDLECENTER     5
  57 #define SUB_ALIGNMENT_MIDDLERIGHT      6
  58 #define SUB_ALIGNMENT_TOPLEFT          7
  59 #define SUB_ALIGNMENT_TOPCENTER        8
  60 #define SUB_ALIGNMENT_TOPRIGHT         9
  61
  62 typedef struct subtitle {
  63
  64     int lines;
  65
  66     unsigned long start;
  67     unsigned long end;
  68
  69     char *text[SUB_MAX_TEXT];
  70     double endpts[SUB_MAX_TEXT];
  71     unsigned char alignment;
  72 } subtitle;
  73
  74 typedef struct sub_data {
  75     subtitle *subtitles;
  76     char *filename;
  77     int sub_uses_time;
  78     int sub_num;          // number of subtitle structs
  79     int sub_errs;
  80 } sub_data;
  81
  82 struct MPOpts;
  83 sub_data* sub_read_file (char *filename, float pts, struct MPOpts *opts);
  84 subtitle* subcp_recode (subtitle *sub);
  85 // enca_fd is the file enca uses to determine the codepage.
  86 // setting to NULL disables enca.
  87 struct stream;
  88 void subcp_open (struct stream *st); /* for demux_ogg.c */
  89 void subcp_close (void); /* for demux_ogg.c */
  90 #ifdef CONFIG_ENCA
  91 const char* guess_buffer_cp(unsigned char* buffer, int buflen, const char *preferred_language, const char *fallback);
  92 const char* guess_cp(struct stream *st, const char *preferred_language, const char *fallback);
  93 #endif
  94 void list_sub_file(sub_data* subd);
  95 void dump_srt(sub_data* subd, float fps);
  96 void dump_mpsub(sub_data* subd, float fps);
  97 void dump_microdvd(sub_data* subd, float fps);
  98 void dump_jacosub(sub_data* subd, float fps);
  99 void dump_sami(sub_data* subd, float fps);
 100 void sub_free( sub_data * subd );
 101 struct MPContext;
 102 void find_sub(struct MPContext *mpctx, sub_data* subd,int key);
 103 void step_sub(sub_data *subd, float pts, int movement);
 104 void sub_add_text(subtitle *sub, const char *txt, int len, double endpts);
 105 int sub_clear_text(subtitle *sub, double pts);
 106
 107 #endif /* MPLAYER_SUBREADER_H */