gst/subparse/: Add support for MPL2 subtitle format (#413799).
[platform/upstream/gstreamer.git] / 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
26 GST_DEBUG_CATEGORY_EXTERN (sub_parse_debug);
27 #define GST_CAT_DEFAULT sub_parse_debug
28
29 G_BEGIN_DECLS
30
31 #define GST_TYPE_SUBPARSE \
32   (gst_sub_parse_get_type ())
33 #define GST_SUBPARSE(obj) \
34   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SUBPARSE, GstSubParse))
35 #define GST_SUBPARSE_CLASS(klass) \
36   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SUBPARSE, GstSubParseClass))
37 #define GST_IS_SUBPARSE(obj) \
38   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SUBPARSE))
39 #define GST_IS_SUBPARSE_CLASS(klass) \
40   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SUBPARSE))
41
42 typedef struct _GstSubParse GstSubParse;
43 typedef struct _GstSubParseClass GstSubParseClass;
44
45 /* format enum */
46 typedef enum
47 {
48   GST_SUB_PARSE_FORMAT_UNKNOWN = 0,
49   GST_SUB_PARSE_FORMAT_MDVDSUB = 1,
50   GST_SUB_PARSE_FORMAT_SUBRIP = 2,
51   GST_SUB_PARSE_FORMAT_MPSUB = 3,
52   GST_SUB_PARSE_FORMAT_SAMI = 4,
53   GST_SUB_PARSE_FORMAT_TMPLAYER = 5,
54   GST_SUB_PARSE_FORMAT_MPL2 = 6
55 } GstSubParseFormat;
56
57 typedef struct {
58   int      state;
59   GString *buf;
60   guint64  start_time;
61   guint64  duration;
62   GstSegment *segment;
63   gpointer user_data;
64   gdouble  fps;          /* used by microdvd parser */
65 } ParserState;
66
67 typedef gchar* (*Parser) (ParserState *state, const gchar *line);
68
69 struct _GstSubParse {
70   GstElement element;
71
72   GstPad *sinkpad,*srcpad;
73
74   GString *textbuf;
75
76   GstSubParseFormat parser_type;
77   gboolean parser_detected;
78
79   Parser parse_line;
80   ParserState state;
81
82   /* seek */
83   guint64 offset;
84   guint64 next_offset;
85   
86   /* Segment */
87   GstSegment    segment;
88   GstSeekFlags  segment_flags;
89   gboolean      need_segment;
90   
91   gboolean flushing;
92   gboolean valid_utf8;
93   gchar   *encoding;
94 };
95
96 struct _GstSubParseClass {
97   GstElementClass parent_class;
98 };
99
100 GType gst_sub_parse_get_type (void);
101
102 G_END_DECLS
103
104 #endif /* __GST_SUBPARSE_H__ */