gst/subparse/gstsubparse.h

   1 /* GStreamer
   2  * Copyright (C) <2002> David A. Schleef <ds@schleef.org>
   3  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GST_SUBPARSE_H__
  22 #define __GST_SUBPARSE_H__
  23
  24 #include <gst/gst.h>
  25 #include <gst/base/gstadapter.h>
  26
  27 GST_DEBUG_CATEGORY_EXTERN (sub_parse_debug);
  28 #define GST_CAT_DEFAULT sub_parse_debug
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_SUBPARSE \
  33   (gst_sub_parse_get_type ())
  34 #define GST_SUBPARSE(obj) \
  35   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SUBPARSE, GstSubParse))
  36 #define GST_SUBPARSE_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SUBPARSE, GstSubParseClass))
  38 #define GST_IS_SUBPARSE(obj) \
  39   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SUBPARSE))
  40 #define GST_IS_SUBPARSE_CLASS(klass) \
  41   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SUBPARSE))
  42
  43 typedef struct _GstSubParse GstSubParse;
  44 typedef struct _GstSubParseClass GstSubParseClass;
  45
  46 /* format enum */
  47 typedef enum
  48 {
  49   GST_SUB_PARSE_FORMAT_UNKNOWN = 0,
  50   GST_SUB_PARSE_FORMAT_MDVDSUB = 1,
  51   GST_SUB_PARSE_FORMAT_SUBRIP = 2,
  52   GST_SUB_PARSE_FORMAT_MPSUB = 3,
  53   GST_SUB_PARSE_FORMAT_SAMI = 4,
  54   GST_SUB_PARSE_FORMAT_TMPLAYER = 5,
  55   GST_SUB_PARSE_FORMAT_MPL2 = 6,
  56   GST_SUB_PARSE_FORMAT_SUBVIEWER = 7,
  57   GST_SUB_PARSE_FORMAT_DKS = 8
  58 } GstSubParseFormat;
  59
  60 typedef struct {
  61   int      state;
  62   GString *buf;
  63   guint64  start_time;
  64   guint64  duration;
  65   guint64  max_duration; /* to clamp duration, 0 = no limit (used by tmplayer parser) */
  66   GstSegment *segment;
  67   gpointer user_data;
  68   gboolean have_internal_fps; /* If TRUE don't overwrite fps by property */
  69   gint fps_n, fps_d;     /* used by frame based parsers */
  70 } ParserState;
  71
  72 typedef gchar* (*Parser) (ParserState *state, const gchar *line);
  73
  74 struct _GstSubParse {
  75   GstElement element;
  76
  77   GstPad *sinkpad,*srcpad;
  78
  79   /* contains the input in the input encoding */
  80   GstAdapter *adapter;
  81   /* contains the UTF-8 decoded input */
  82   GString *textbuf;
  83
  84   GstSubParseFormat parser_type;
  85   gboolean parser_detected;
  86   const gchar *subtitle_codec;
  87
  88   Parser parse_line;
  89   ParserState state;
  90
  91   /* seek */
  92   guint64 offset;
  93   guint64 next_offset;
  94
  95   /* Segment */
  96   GstSegment    segment;
  97   GstSeekFlags  segment_flags;
  98   gboolean      need_segment;
  99
 100   gboolean flushing;
 101   gboolean valid_utf8;
 102   gchar   *detected_encoding;
 103   gchar   *encoding;
 104
 105   gboolean first_buffer;
 106
 107   /* used by frame based parsers */
 108   gint fps_n, fps_d;
 109 };
 110
 111 struct _GstSubParseClass {
 112   GstElementClass parent_class;
 113 };
 114
 115 GType gst_sub_parse_get_type (void);
 116
 117 G_END_DECLS
 118
 119 #endif /* __GST_SUBPARSE_H__ */