2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) 2004 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
4 * Copyright (C) 2006 Tim-Philipp Müller <tim centricular net>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
29 #include <sys/types.h>
32 #include "gstsubparse.h"
33 #include "gstssaparse.h"
34 #include "samiparse.h"
35 #include "tmplayerparse.h"
36 #include "mpl2parse.h"
38 GST_DEBUG_CATEGORY (sub_parse_debug);
40 #define DEFAULT_ENCODING NULL
50 gst_sub_parse_set_property (GObject * object, guint prop_id,
51 const GValue * value, GParamSpec * pspec);
53 gst_sub_parse_get_property (GObject * object, guint prop_id,
54 GValue * value, GParamSpec * pspec);
57 static const GstElementDetails sub_parse_details =
58 GST_ELEMENT_DETAILS ("Subtitle parser",
59 "Codec/Parser/Subtitle",
60 "Parses subtitle (.sub) files into text streams",
61 "Gustavo J. A. M. Carneiro <gjc@inescporto.pt>\n"
62 "GStreamer maintainers <gstreamer-devel@lists.sourceforge.net>");
64 #ifndef GST_DISABLE_XML
65 static GstStaticPadTemplate sink_templ = GST_STATIC_PAD_TEMPLATE ("sink",
68 GST_STATIC_CAPS ("application/x-subtitle; application/x-subtitle-sami; "
69 "application/x-subtitle-tmplayer; application/x-subtitle-mpl2; "
70 "application/x-subtitle-dks")
73 static GstStaticPadTemplate sink_templ = GST_STATIC_PAD_TEMPLATE ("sink",
76 GST_STATIC_CAPS ("application/x-subtitle; application/x-subtitle-dks; "
77 "application/x-subtitle-tmplayer; application/x-subtitle-mpl2")
81 static GstStaticPadTemplate src_templ = GST_STATIC_PAD_TEMPLATE ("src",
84 GST_STATIC_CAPS ("text/plain; text/x-pango-markup")
87 static void gst_sub_parse_base_init (GstSubParseClass * klass);
88 static void gst_sub_parse_class_init (GstSubParseClass * klass);
89 static void gst_sub_parse_init (GstSubParse * subparse);
91 static gboolean gst_sub_parse_src_event (GstPad * pad, GstEvent * event);
92 static gboolean gst_sub_parse_src_query (GstPad * pad, GstQuery * query);
93 static gboolean gst_sub_parse_sink_event (GstPad * pad, GstEvent * event);
95 static GstStateChangeReturn gst_sub_parse_change_state (GstElement * element,
96 GstStateChange transition);
98 static GstFlowReturn gst_sub_parse_chain (GstPad * sinkpad, GstBuffer * buf);
100 static GstElementClass *parent_class = NULL;
103 gst_sub_parse_get_type (void)
105 static GType sub_parse_type = 0;
107 if (!sub_parse_type) {
108 static const GTypeInfo sub_parse_info = {
109 sizeof (GstSubParseClass),
110 (GBaseInitFunc) gst_sub_parse_base_init,
112 (GClassInitFunc) gst_sub_parse_class_init,
115 sizeof (GstSubParse),
117 (GInstanceInitFunc) gst_sub_parse_init,
120 sub_parse_type = g_type_register_static (GST_TYPE_ELEMENT,
121 "GstSubParse", &sub_parse_info, 0);
124 return sub_parse_type;
128 gst_sub_parse_base_init (GstSubParseClass * klass)
130 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
132 gst_element_class_add_pad_template (element_class,
133 gst_static_pad_template_get (&sink_templ));
134 gst_element_class_add_pad_template (element_class,
135 gst_static_pad_template_get (&src_templ));
136 gst_element_class_set_details (element_class, &sub_parse_details);
140 gst_sub_parse_dispose (GObject * object)
142 GstSubParse *subparse = GST_SUBPARSE (object);
144 GST_DEBUG_OBJECT (subparse, "cleaning up subtitle parser");
146 if (subparse->encoding) {
147 g_free (subparse->encoding);
148 subparse->encoding = NULL;
151 if (subparse->detected_encoding) {
152 g_free (subparse->detected_encoding);
153 subparse->detected_encoding = NULL;
156 if (subparse->adapter) {
157 g_object_unref (subparse->adapter);
158 subparse->adapter = NULL;
161 if (subparse->textbuf) {
162 g_string_free (subparse->textbuf, TRUE);
163 subparse->textbuf = NULL;
165 #ifndef GST_DISABLE_XML
166 if (subparse->parser_type == GST_SUB_PARSE_FORMAT_SAMI)
167 sami_context_deinit (&subparse->state);
170 GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
174 gst_sub_parse_class_init (GstSubParseClass * klass)
176 GObjectClass *object_class = G_OBJECT_CLASS (klass);
177 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
179 parent_class = g_type_class_peek_parent (klass);
181 object_class->dispose = gst_sub_parse_dispose;
182 object_class->set_property = gst_sub_parse_set_property;
183 object_class->get_property = gst_sub_parse_get_property;
185 element_class->change_state = gst_sub_parse_change_state;
187 g_object_class_install_property (object_class, PROP_ENCODING,
188 g_param_spec_string ("subtitle-encoding", "subtitle charset encoding",
189 "Encoding to assume if input subtitles are not in UTF-8 or any other "
190 "Unicode encoding. If not set, the GST_SUBTITLE_ENCODING environment "
191 "variable will be checked for an encoding to use. If that is not set "
192 "either, ISO-8859-15 will be assumed.", DEFAULT_ENCODING,
193 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
195 g_object_class_install_property (object_class, PROP_VIDEOFPS,
196 gst_param_spec_fraction ("video-fps", "Video framerate",
197 "Framerate of the video stream. This is needed by some subtitle "
198 "formats to synchronize subtitles and video properly. If not set "
199 "and the subtitle format requires it subtitles may be out of sync.",
200 0, 1, G_MAXINT, 1, 24000, 1001, G_PARAM_READWRITE));
204 gst_sub_parse_init (GstSubParse * subparse)
206 subparse->sinkpad = gst_pad_new_from_static_template (&sink_templ, "sink");
207 gst_pad_set_chain_function (subparse->sinkpad,
208 GST_DEBUG_FUNCPTR (gst_sub_parse_chain));
209 gst_pad_set_event_function (subparse->sinkpad,
210 GST_DEBUG_FUNCPTR (gst_sub_parse_sink_event));
211 gst_element_add_pad (GST_ELEMENT (subparse), subparse->sinkpad);
213 subparse->srcpad = gst_pad_new_from_static_template (&src_templ, "src");
214 gst_pad_set_event_function (subparse->srcpad,
215 GST_DEBUG_FUNCPTR (gst_sub_parse_src_event));
216 gst_pad_set_query_function (subparse->srcpad,
217 GST_DEBUG_FUNCPTR (gst_sub_parse_src_query));
218 gst_element_add_pad (GST_ELEMENT (subparse), subparse->srcpad);
220 subparse->textbuf = g_string_new (NULL);
221 subparse->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
222 subparse->flushing = FALSE;
223 gst_segment_init (&subparse->segment, GST_FORMAT_TIME);
224 subparse->need_segment = TRUE;
225 subparse->encoding = g_strdup (DEFAULT_ENCODING);
226 subparse->detected_encoding = NULL;
227 subparse->adapter = gst_adapter_new ();
229 subparse->fps_n = 24000;
230 subparse->fps_d = 1001;
234 * Source pad functions.
238 gst_sub_parse_src_query (GstPad * pad, GstQuery * query)
240 GstSubParse *self = GST_SUBPARSE (gst_pad_get_parent (pad));
241 gboolean ret = FALSE;
243 GST_DEBUG ("Handling %s query", GST_QUERY_TYPE_NAME (query));
245 switch (GST_QUERY_TYPE (query)) {
246 case GST_QUERY_POSITION:{
249 gst_query_parse_position (query, &fmt, NULL);
250 if (fmt != GST_FORMAT_TIME) {
251 ret = gst_pad_peer_query (self->sinkpad, query);
254 gst_query_set_position (query, GST_FORMAT_TIME,
255 self->segment.last_stop);
258 case GST_QUERY_SEEKING:
261 gboolean seekable = FALSE;
265 gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
266 if (fmt == GST_FORMAT_TIME) {
267 GstQuery *peerquery = gst_query_new_seeking (GST_FORMAT_BYTES);
269 seekable = gst_pad_peer_query (self->sinkpad, peerquery);
271 gst_query_parse_seeking (peerquery, NULL, &seekable, NULL, NULL);
272 gst_query_unref (peerquery);
275 gst_query_set_seeking (query, fmt, seekable, seekable ? 0 : -1, -1);
280 ret = gst_pad_peer_query (self->sinkpad, query);
284 gst_object_unref (self);
290 gst_sub_parse_src_event (GstPad * pad, GstEvent * event)
292 GstSubParse *self = GST_SUBPARSE (gst_pad_get_parent (pad));
293 gboolean ret = FALSE;
295 GST_DEBUG ("Handling %s event", GST_EVENT_TYPE_NAME (event));
297 switch (GST_EVENT_TYPE (event)) {
301 GstSeekType start_type, stop_type;
306 gst_event_parse_seek (event, &rate, &format, &self->segment_flags,
307 &start_type, &start, &stop_type, &stop);
309 if (format != GST_FORMAT_TIME) {
310 GST_WARNING_OBJECT (self, "we only support seeking in TIME format");
311 gst_event_unref (event);
315 /* Convert that seek to a seeking in bytes at position 0,
316 FIXME: could use an index */
317 ret = gst_pad_push_event (self->sinkpad,
318 gst_event_new_seek (rate, GST_FORMAT_BYTES, self->segment_flags,
319 GST_SEEK_TYPE_SET, 0, GST_SEEK_TYPE_NONE, 0));
322 /* Apply the seek to our segment */
323 gst_segment_set_seek (&self->segment, rate, format, self->segment_flags,
324 start_type, start, stop_type, stop, &update);
326 GST_DEBUG_OBJECT (self, "segment after seek: %" GST_SEGMENT_FORMAT,
329 self->next_offset = 0;
331 self->need_segment = TRUE;
333 GST_WARNING_OBJECT (self, "seek to 0 bytes failed");
336 gst_event_unref (event);
340 ret = gst_pad_event_default (pad, event);
345 gst_object_unref (self);
351 gst_sub_parse_set_property (GObject * object, guint prop_id,
352 const GValue * value, GParamSpec * pspec)
354 GstSubParse *subparse = GST_SUBPARSE (object);
356 GST_OBJECT_LOCK (subparse);
359 g_free (subparse->encoding);
360 subparse->encoding = g_value_dup_string (value);
361 GST_LOG_OBJECT (object, "subtitle encoding set to %s",
362 GST_STR_NULL (subparse->encoding));
366 subparse->fps_n = gst_value_get_fraction_numerator (value);
367 subparse->fps_d = gst_value_get_fraction_denominator (value);
368 GST_DEBUG_OBJECT (object, "video framerate set to %d/%d", subparse->fps_n,
371 if (!subparse->state.have_internal_fps) {
372 subparse->state.fps_n = subparse->fps_n;
373 subparse->state.fps_d = subparse->fps_d;
378 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
381 GST_OBJECT_UNLOCK (subparse);
385 gst_sub_parse_get_property (GObject * object, guint prop_id,
386 GValue * value, GParamSpec * pspec)
388 GstSubParse *subparse = GST_SUBPARSE (object);
390 GST_OBJECT_LOCK (subparse);
393 g_value_set_string (value, subparse->encoding);
396 gst_value_set_fraction (value, subparse->fps_n, subparse->fps_d);
399 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
402 GST_OBJECT_UNLOCK (subparse);
406 gst_sub_parse_get_format_description (GstSubParseFormat format)
409 case GST_SUB_PARSE_FORMAT_MDVDSUB:
411 case GST_SUB_PARSE_FORMAT_SUBRIP:
413 case GST_SUB_PARSE_FORMAT_MPSUB:
415 case GST_SUB_PARSE_FORMAT_SAMI:
417 case GST_SUB_PARSE_FORMAT_TMPLAYER:
419 case GST_SUB_PARSE_FORMAT_MPL2:
421 case GST_SUB_PARSE_FORMAT_SUBVIEWER:
423 case GST_SUB_PARSE_FORMAT_DKS:
426 case GST_SUB_PARSE_FORMAT_UNKNOWN:
433 gst_convert_to_utf8 (const gchar * str, gsize len, const gchar * encoding,
434 gsize * consumed, GError ** err)
440 g_convert_with_fallback (str, len, "UTF-8", encoding, "*", consumed, NULL,
445 /* + 3 to skip UTF-8 BOM if it was added */
447 if (len >= 3 && (guint8) ret[0] == 0xEF && (guint8) ret[1] == 0xBB
448 && (guint8) ret[2] == 0xBF)
449 g_memmove (ret, ret + 3, len + 1 - 3);
455 detect_encoding (const gchar * str, gsize len)
457 if (len >= 3 && (guint8) str[0] == 0xEF && (guint8) str[1] == 0xBB
458 && (guint8) str[2] == 0xBF)
459 return g_strdup ("UTF-8");
461 if (len >= 2 && (guint8) str[0] == 0xFE && (guint8) str[1] == 0xFF)
462 return g_strdup ("UTF-16BE");
464 if (len >= 2 && (guint8) str[0] == 0xFF && (guint8) str[1] == 0xFE)
465 return g_strdup ("UTF-16LE");
467 if (len >= 4 && (guint8) str[0] == 0x00 && (guint8) str[1] == 0x00
468 && (guint8) str[2] == 0xFE && (guint8) str[3] == 0xFF)
469 return g_strdup ("UTF-32BE");
471 if (len >= 4 && (guint8) str[0] == 0xFF && (guint8) str[1] == 0xFE
472 && (guint8) str[2] == 0x00 && (guint8) str[3] == 0x00)
473 return g_strdup ("UTF-32LE");
479 convert_encoding (GstSubParse * self, const gchar * str, gsize len,
482 const gchar *encoding;
488 /* First try any detected encoding */
489 if (self->detected_encoding) {
491 gst_convert_to_utf8 (str, len, self->detected_encoding, consumed, &err);
496 GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
497 self->detected_encoding, err->message);
498 g_free (self->detected_encoding);
499 self->detected_encoding = NULL;
503 /* Otherwise check if it's UTF8 */
504 if (self->valid_utf8) {
505 if (g_utf8_validate (str, len, NULL)) {
506 GST_LOG_OBJECT (self, "valid UTF-8, no conversion needed");
508 return g_strndup (str, len);
510 GST_INFO_OBJECT (self, "invalid UTF-8!");
511 self->valid_utf8 = FALSE;
514 /* Else try fallback */
515 encoding = self->encoding;
516 if (encoding == NULL || *encoding == '\0') {
517 encoding = g_getenv ("GST_SUBTITLE_ENCODING");
519 if (encoding == NULL || *encoding == '\0') {
520 /* if local encoding is UTF-8 and no encoding specified
521 * via the environment variable, assume ISO-8859-15 */
522 if (g_get_charset (&encoding)) {
523 encoding = "ISO-8859-15";
527 ret = gst_convert_to_utf8 (str, len, encoding, consumed, &err);
530 GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
531 encoding, err->message);
534 /* invalid input encoding, fall back to ISO-8859-15 (always succeeds) */
535 ret = gst_convert_to_utf8 (str, len, "ISO-8859-15", consumed, NULL);
538 GST_LOG_OBJECT (self,
539 "successfully converted %" G_GSIZE_FORMAT " characters from %s to UTF-8"
540 "%s", len, encoding, (err) ? " , using ISO-8859-15 as fallback" : "");
546 get_next_line (GstSubParse * self)
549 const char *line_end;
551 gboolean have_r = FALSE;
553 line_end = strchr (self->textbuf->str, '\n');
556 /* end-of-line not found; return for more data */
560 /* get rid of '\r' */
561 if (line_end != self->textbuf->str && *(line_end - 1) == '\r') {
566 line_len = line_end - self->textbuf->str;
567 line = g_strndup (self->textbuf->str, line_len);
568 self->textbuf = g_string_erase (self->textbuf, 0,
569 line_len + (have_r ? 2 : 1));
574 parse_mdvdsub (ParserState * state, const gchar * line)
576 const gchar *line_split;
578 guint start_frame, end_frame;
579 gint64 clip_start = 0, clip_stop = 0;
580 gboolean in_seg = FALSE;
584 /* style variables */
590 if (sscanf (line, "{%u}{%u}", &start_frame, &end_frame) != 2) {
591 g_warning ("Parse of the following line, assumed to be in microdvd .sub"
592 " format, failed:\n%s", line);
596 /* skip the {%u}{%u} part */
597 line = strchr (line, '}') + 1;
598 line = strchr (line, '}') + 1;
600 /* see if there's a first line with a framerate */
601 if (start_frame == 1 && end_frame == 1) {
602 gchar *rest, *end = NULL;
604 rest = g_strdup (line);
605 g_strdelimit (rest, ",", '.');
606 fps = g_ascii_strtod (rest, &end);
608 gst_util_double_to_fraction (fps, &state->fps_n, &state->fps_d);
609 GST_INFO ("framerate from file: %d/%d ('%s')", state->fps_n,
617 gst_util_uint64_scale (start_frame, GST_SECOND * state->fps_d,
620 gst_util_uint64_scale (end_frame - start_frame, GST_SECOND * state->fps_d,
623 /* Check our segment start/stop */
624 in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
625 state->start_time, state->start_time + state->duration, &clip_start,
628 /* No need to parse that text if it's out of segment */
630 state->start_time = clip_start;
631 state->duration = clip_stop - clip_start;
636 markup = g_string_new (NULL);
641 /* parse style markup */
642 if (strncmp (line, "{y:i}", 5) == 0) {
644 line = strchr (line, '}') + 1;
646 if (strncmp (line, "{y:b}", 5) == 0) {
648 line = strchr (line, '}') + 1;
650 if (sscanf (line, "{s:%u}", &fontsize) == 1) {
651 line = strchr (line, '}') + 1;
653 /* forward slashes at beginning/end signify italics too */
654 if (g_str_has_prefix (line, "/")) {
658 if ((line_split = strchr (line, '|')))
659 line_chunk = g_markup_escape_text (line, line_split - line);
661 line_chunk = g_markup_escape_text (line, strlen (line));
663 /* Remove italics markers at end of line/stanza (CHECKME: are end slashes
664 * always at the end of a line or can they span multiple lines?) */
665 if (g_str_has_suffix (line_chunk, "/")) {
666 line_chunk[strlen (line_chunk) - 1] = '\0';
669 markup = g_string_append (markup, "<span");
671 g_string_append (markup, " style=\"italic\"");
673 g_string_append (markup, " weight=\"bold\"");
675 g_string_append_printf (markup, " size=\"%u\"", fontsize * 1000);
676 g_string_append_printf (markup, ">%s</span>", line_chunk);
679 g_string_append (markup, "\n");
680 line = line_split + 1;
686 g_string_free (markup, FALSE);
687 GST_DEBUG ("parse_mdvdsub returning (%f+%f): %s",
688 state->start_time / (double) GST_SECOND,
689 state->duration / (double) GST_SECOND, ret);
694 strip_trailing_newlines (gchar * txt)
700 while (len > 1 && txt[len - 1] == '\n') {
707 /* we want to escape text in general, but retain basic markup like
708 * <i></i>, <u></u>, and <b></b>. The easiest and safest way is to
709 * just unescape a white list of allowed markups again after
710 * escaping everything (the text between these simple markers isn't
711 * necessarily escaped, so it seems best to do it like this) */
713 subrip_unescape_formatting (gchar * txt)
717 for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
718 if (g_ascii_strncasecmp (pos, "<u>", 9) == 0 ||
719 g_ascii_strncasecmp (pos, "<i>", 9) == 0 ||
720 g_ascii_strncasecmp (pos, "<b>", 9) == 0) {
722 pos[1] = g_ascii_tolower (pos[4]);
724 /* move NUL terminator as well */
725 g_memmove (pos + 3, pos + 9, strlen (pos + 9) + 1);
730 for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
731 if (g_ascii_strncasecmp (pos, "</u>", 10) == 0 ||
732 g_ascii_strncasecmp (pos, "</i>", 10) == 0 ||
733 g_ascii_strncasecmp (pos, "</b>", 10) == 0) {
736 pos[2] = g_ascii_tolower (pos[5]);
738 /* move NUL terminator as well */
739 g_memmove (pos + 4, pos + 10, strlen (pos + 10) + 1);
747 subrip_remove_unhandled_tag (gchar * start, gchar * stop)
751 tag = start + strlen ("<");
755 if (g_ascii_tolower (*tag) < 'a' || g_ascii_tolower (*tag) > 'z')
760 GST_LOG ("removing unhandled tag '%s'", start);
762 g_memmove (start, stop, strlen (stop) + 1);
766 /* remove tags we haven't explicitly allowed earlier on, like font tags
769 subrip_remove_unhandled_tags (gchar * txt)
773 for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
774 if (strncmp (pos, "<", 4) == 0 && (gt = strstr (pos + 4, ">"))) {
775 if (subrip_remove_unhandled_tag (pos, gt + strlen (">")))
781 /* we only allow <i>, <u> and <b>, so let's take a simple approach. This code
782 * assumes the input has been escaped and subrip_unescape_formatting() has then
783 * been run over the input! This function adds missing closing markup tags and
784 * removes broken closing tags for tags that have never been opened. */
786 subrip_fix_up_markup (gchar ** p_txt)
788 gchar *cur, *next_tag;
790 guint num_open_tags = 0;
792 g_assert (*p_txt != NULL);
795 while (*cur != '\0') {
796 next_tag = strchr (cur, '<');
797 if (next_tag == NULL)
803 if (num_open_tags == 0 || open_tags[num_open_tags - 1] != *next_tag) {
804 GST_LOG ("broken input, closing tag '%c' is not open", *next_tag);
805 g_memmove (next_tag - 2, next_tag + 2, strlen (next_tag + 2) + 1);
808 /* it's all good, closing tag which is open */
816 if (num_open_tags == G_N_ELEMENTS (open_tags))
817 return; /* something dodgy is going on, stop parsing */
818 open_tags[num_open_tags] = *next_tag;
822 GST_ERROR ("unexpected tag '%c' (%s)", *next_tag, next_tag);
823 g_assert_not_reached ();
829 if (num_open_tags > 0) {
832 s = g_string_new (*p_txt);
833 while (num_open_tags > 0) {
834 GST_LOG ("adding missing closing tag '%c'", open_tags[num_open_tags - 1]);
835 g_string_append_c (s, '<');
836 g_string_append_c (s, '/');
837 g_string_append_c (s, open_tags[num_open_tags - 1]);
838 g_string_append_c (s, '>');
842 *p_txt = g_string_free (s, FALSE);
847 parse_subrip_time (const gchar * ts_string, GstClockTime * t)
849 gchar s[128] = { '\0', };
851 guint hour, min, sec, msec, len;
853 while (*ts_string == ' ')
856 g_strlcpy (s, ts_string, sizeof (s));
857 if ((end = strstr (s, "-->")))
861 /* ms may be in these formats:
862 * hh:mm:ss,500 = 500ms
865 * hh:mm:ss, 50 = 50ms
867 * and the same with . instead of ,.
868 * sscanf() doesn't differentiate between ' 5' and '5' so munge
869 * the white spaces within the timestamp to '0' (I'm sure there's a
870 * way to make sscanf() do this for us, but how?)
872 g_strdelimit (s, " ", '0');
873 g_strdelimit (s, ".", ',');
875 /* make sure we have exactly three digits after he comma */
877 g_assert (p != NULL);
884 g_strlcat (&p[len], "0", 2);
888 GST_LOG ("parsing timestamp '%s'", s);
889 if (sscanf (s, "%u:%u:%u,%u", &hour, &min, &sec, &msec) != 4) {
890 GST_WARNING ("failed to parse subrip timestamp string '%s'", s);
894 *t = ((hour * 3600) + (min * 60) + sec) * GST_SECOND + msec * GST_MSECOND;
899 parse_subrip (ParserState * state, const gchar * line)
904 switch (state->state) {
906 /* looking for a single integer */
907 if (sscanf (line, "%u", &subnum) == 1)
912 GstClockTime ts_start, ts_end;
915 /* looking for start_time --> end_time */
916 if ((end_time = strstr (line, " --> ")) &&
917 parse_subrip_time (line, &ts_start) &&
918 parse_subrip_time (end_time + strlen (" --> "), &ts_end) &&
919 state->start_time <= ts_end) {
921 state->start_time = ts_start;
922 state->duration = ts_end - ts_start;
924 GST_DEBUG ("error parsing subrip time line '%s'", line);
931 /* No need to parse that text if it's out of segment */
932 gint64 clip_start = 0, clip_stop = 0;
933 gboolean in_seg = FALSE;
935 /* Check our segment start/stop */
936 in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
937 state->start_time, state->start_time + state->duration,
938 &clip_start, &clip_stop);
941 state->start_time = clip_start;
942 state->duration = clip_stop - clip_start;
948 /* looking for subtitle text; empty line ends this subtitle entry */
950 g_string_append_c (state->buf, '\n');
951 g_string_append (state->buf, line);
952 if (strlen (line) == 0) {
953 ret = g_markup_escape_text (state->buf->str, state->buf->len);
954 g_string_truncate (state->buf, 0);
956 subrip_unescape_formatting (ret);
957 subrip_remove_unhandled_tags (ret);
958 strip_trailing_newlines (ret);
959 subrip_fix_up_markup (&ret);
964 g_return_val_if_reached (NULL);
969 unescape_newlines_br (gchar * read)
973 /* Replace all occurences of '[br]' with a newline as version 2
974 * of the subviewer format uses this for newlines */
976 if (read[0] == '\0' || read[1] == '\0' || read[2] == '\0' || read[3] == '\0')
980 if (strncmp (read, "[br]", 4) == 0) {
994 parse_subviewer (ParserState * state, const gchar * line)
996 guint h1, m1, s1, ms1;
997 guint h2, m2, s2, ms2;
1000 /* TODO: Maybe also parse the fields in the header, especially DELAY.
1001 * For examples see the unit test or
1002 * http://www.doom9.org/index.html?/sub.htm */
1004 switch (state->state) {
1006 /* looking for start_time,end_time */
1007 if (sscanf (line, "%u:%u:%u.%u,%u:%u:%u.%u",
1008 &h1, &m1, &s1, &ms1, &h2, &m2, &s2, &ms2) == 8) {
1011 (((guint64) h1) * 3600 + m1 * 60 + s1) * GST_SECOND +
1014 (((guint64) h2) * 3600 + m2 * 60 + s2) * GST_SECOND +
1015 ms2 * GST_MSECOND - state->start_time;
1020 /* No need to parse that text if it's out of segment */
1021 gint64 clip_start = 0, clip_stop = 0;
1022 gboolean in_seg = FALSE;
1024 /* Check our segment start/stop */
1025 in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1026 state->start_time, state->start_time + state->duration,
1027 &clip_start, &clip_stop);
1030 state->start_time = clip_start;
1031 state->duration = clip_stop - clip_start;
1037 /* looking for subtitle text; empty line ends this subtitle entry */
1038 if (state->buf->len)
1039 g_string_append_c (state->buf, '\n');
1040 g_string_append (state->buf, line);
1041 if (strlen (line) == 0) {
1042 ret = g_strdup (state->buf->str);
1043 unescape_newlines_br (ret);
1044 strip_trailing_newlines (ret);
1045 g_string_truncate (state->buf, 0);
1051 g_assert_not_reached ();
1057 parse_mpsub (ParserState * state, const gchar * line)
1062 switch (state->state) {
1064 /* looking for two floats (offset, duration) */
1065 if (sscanf (line, "%f %f", &t1, &t2) == 2) {
1067 state->start_time += state->duration + GST_SECOND * t1;
1068 state->duration = GST_SECOND * t2;
1072 { /* No need to parse that text if it's out of segment */
1073 gint64 clip_start = 0, clip_stop = 0;
1074 gboolean in_seg = FALSE;
1076 /* Check our segment start/stop */
1077 in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1078 state->start_time, state->start_time + state->duration,
1079 &clip_start, &clip_stop);
1082 state->start_time = clip_start;
1083 state->duration = clip_stop - clip_start;
1089 /* looking for subtitle text; empty line ends this
1091 if (state->buf->len)
1092 g_string_append_c (state->buf, '\n');
1093 g_string_append (state->buf, line);
1094 if (strlen (line) == 0) {
1095 ret = g_strdup (state->buf->str);
1096 g_string_truncate (state->buf, 0);
1102 g_assert_not_reached ();
1107 static const gchar *
1108 dks_skip_timestamp (const gchar * line)
1110 while (*line && *line != ']')
1118 parse_dks (ParserState * state, const gchar * line)
1122 switch (state->state) {
1124 /* Looking for the start time and text */
1125 if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1127 state->start_time = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND;
1128 text = dks_skip_timestamp (line);
1131 g_string_append (state->buf, text);
1137 gint64 clip_start = 0, clip_stop = 0;
1141 /* Looking for the end time */
1142 if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1144 state->duration = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND -
1147 GST_WARNING ("Failed to parse subtitle end time");
1151 /* Check if this subtitle is out of the current segment */
1152 in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1153 state->start_time, state->start_time + state->duration,
1154 &clip_start, &clip_stop);
1160 state->start_time = clip_start;
1161 state->duration = clip_stop - clip_start;
1163 ret = g_strdup (state->buf->str);
1164 g_string_truncate (state->buf, 0);
1165 unescape_newlines_br (ret);
1169 g_assert_not_reached ();
1175 parser_state_init (ParserState * state)
1177 GST_DEBUG ("initialising parser");
1180 g_string_truncate (state->buf, 0);
1182 state->buf = g_string_new (NULL);
1185 state->start_time = 0;
1186 state->duration = 0;
1187 state->max_duration = 0; /* no limit */
1189 state->segment = NULL;
1193 parser_state_dispose (GstSubParse * self, ParserState * state)
1196 g_string_free (state->buf, TRUE);
1199 #ifndef GST_DISABLE_XML
1200 if (state->user_data && self->parser_type == GST_SUB_PARSE_FORMAT_SAMI) {
1201 sami_context_reset (state);
1206 /* regex type enum */
1209 GST_SUB_PARSE_REGEX_UNKNOWN = 0,
1210 GST_SUB_PARSE_REGEX_MDVDSUB = 1,
1211 GST_SUB_PARSE_REGEX_SUBRIP = 2,
1212 GST_SUB_PARSE_REGEX_DKS = 3,
1216 gst_sub_parse_data_format_autodetect_regex_once (GstSubParseRegex regtype)
1218 gpointer result = NULL;
1219 GError *gerr = NULL;
1221 case GST_SUB_PARSE_REGEX_MDVDSUB:
1223 (gpointer) g_regex_new ("^\\{[0-9]+\\}\\{[0-9]+\\}", 0, 0, &gerr);
1224 if (result == NULL) {
1225 g_warning ("Compilation of mdvd regex failed: %s", gerr->message);
1226 g_error_free (gerr);
1229 case GST_SUB_PARSE_REGEX_SUBRIP:
1230 result = (gpointer) g_regex_new ("^([ 0-9]){0,3}[0-9]\\s*(\x0d)?\x0a"
1231 "[ 0-9][0-9]:[ 0-9][0-9]:[ 0-9][0-9][,.][ 0-9]{0,2}[0-9]"
1232 " +--> +([ 0-9])?[0-9]:[ 0-9][0-9]:[ 0-9][0-9][,.][ 0-9]{0,2}[0-9]",
1234 if (result == NULL) {
1235 g_warning ("Compilation of subrip regex failed: %s", gerr->message);
1236 g_error_free (gerr);
1239 case GST_SUB_PARSE_REGEX_DKS:
1240 result = (gpointer) g_regex_new ("^\[[0-9]+:[0-9]+:[0-9]+].*",
1242 if (result == NULL) {
1243 g_warning ("Compilation of dks regex failed: %s", gerr->message);
1244 g_error_free (gerr);
1248 GST_WARNING ("Trying to allocate regex of unknown type %u", regtype);
1254 * FIXME: maybe we should pass along a second argument, the preceding
1255 * text buffer, because that is how this originally worked, even though
1256 * I don't really see the use of that.
1259 static GstSubParseFormat
1260 gst_sub_parse_data_format_autodetect (gchar * match_str)
1264 static GOnce mdvd_rx_once = G_ONCE_INIT;
1265 static GOnce subrip_rx_once = G_ONCE_INIT;
1266 static GOnce dks_rx_once = G_ONCE_INIT;
1272 g_once (&mdvd_rx_once,
1273 (GThreadFunc) gst_sub_parse_data_format_autodetect_regex_once,
1274 (gpointer) GST_SUB_PARSE_REGEX_MDVDSUB);
1275 g_once (&subrip_rx_once,
1276 (GThreadFunc) gst_sub_parse_data_format_autodetect_regex_once,
1277 (gpointer) GST_SUB_PARSE_REGEX_SUBRIP);
1278 g_once (&dks_rx_once,
1279 (GThreadFunc) gst_sub_parse_data_format_autodetect_regex_once,
1280 (gpointer) GST_SUB_PARSE_REGEX_DKS);
1282 mdvd_grx = (GRegex *) mdvd_rx_once.retval;
1283 subrip_grx = (GRegex *) subrip_rx_once.retval;
1284 dks_grx = (GRegex *) dks_rx_once.retval;
1286 if (g_regex_match (mdvd_grx, match_str, 0, NULL) == TRUE) {
1287 GST_LOG ("MicroDVD (frame based) format detected");
1288 return GST_SUB_PARSE_FORMAT_MDVDSUB;
1290 if (g_regex_match (subrip_grx, match_str, 0, NULL) == TRUE) {
1291 GST_LOG ("SubRip (time based) format detected");
1292 return GST_SUB_PARSE_FORMAT_SUBRIP;
1294 if (g_regex_match (dks_grx, match_str, 0, NULL) == TRUE) {
1295 GST_LOG ("DKS (time based) format detected");
1296 return GST_SUB_PARSE_FORMAT_DKS;
1299 if (!strncmp (match_str, "FORMAT=TIME", 11)) {
1300 GST_LOG ("MPSub (time based) format detected");
1301 return GST_SUB_PARSE_FORMAT_MPSUB;
1303 #ifndef GST_DISABLE_XML
1304 if (strstr (match_str, "<SAMI>") != NULL ||
1305 strstr (match_str, "<sami>") != NULL) {
1306 GST_LOG ("SAMI (time based) format detected");
1307 return GST_SUB_PARSE_FORMAT_SAMI;
1310 /* we're boldly assuming the first subtitle appears within the first hour */
1311 if (sscanf (match_str, "0:%02u:%02u:", &n1, &n2) == 2 ||
1312 sscanf (match_str, "0:%02u:%02u=", &n1, &n2) == 2 ||
1313 sscanf (match_str, "00:%02u:%02u:", &n1, &n2) == 2 ||
1314 sscanf (match_str, "00:%02u:%02u=", &n1, &n2) == 2 ||
1315 sscanf (match_str, "00:%02u:%02u,%u=", &n1, &n2, &n3) == 3) {
1316 GST_LOG ("TMPlayer (time based) format detected");
1317 return GST_SUB_PARSE_FORMAT_TMPLAYER;
1319 if (sscanf (match_str, "[%u][%u]", &n1, &n2) == 2) {
1320 GST_LOG ("MPL2 (time based) format detected");
1321 return GST_SUB_PARSE_FORMAT_MPL2;
1323 if (strstr (match_str, "[INFORMATION]") != NULL) {
1324 GST_LOG ("SubViewer (time based) format detected");
1325 return GST_SUB_PARSE_FORMAT_SUBVIEWER;
1328 GST_DEBUG ("no subtitle format detected");
1329 return GST_SUB_PARSE_FORMAT_UNKNOWN;
1333 gst_sub_parse_format_autodetect (GstSubParse * self)
1336 GstSubParseFormat format;
1338 if (strlen (self->textbuf->str) < 30) {
1339 GST_DEBUG ("File too small to be a subtitles file");
1343 data = g_strndup (self->textbuf->str, 35);
1344 format = gst_sub_parse_data_format_autodetect (data);
1347 self->parser_type = format;
1348 self->subtitle_codec = gst_sub_parse_get_format_description (format);
1349 parser_state_init (&self->state);
1352 case GST_SUB_PARSE_FORMAT_MDVDSUB:
1353 self->parse_line = parse_mdvdsub;
1354 return gst_caps_new_simple ("text/x-pango-markup", NULL);
1355 case GST_SUB_PARSE_FORMAT_SUBRIP:
1356 self->parse_line = parse_subrip;
1357 return gst_caps_new_simple ("text/x-pango-markup", NULL);
1358 case GST_SUB_PARSE_FORMAT_MPSUB:
1359 self->parse_line = parse_mpsub;
1360 return gst_caps_new_simple ("text/plain", NULL);
1361 #ifndef GST_DISABLE_XML
1362 case GST_SUB_PARSE_FORMAT_SAMI:
1363 self->parse_line = parse_sami;
1364 sami_context_init (&self->state);
1365 return gst_caps_new_simple ("text/x-pango-markup", NULL);
1367 case GST_SUB_PARSE_FORMAT_TMPLAYER:
1368 self->parse_line = parse_tmplayer;
1369 self->state.max_duration = 5 * GST_SECOND;
1370 return gst_caps_new_simple ("text/plain", NULL);
1371 case GST_SUB_PARSE_FORMAT_MPL2:
1372 self->parse_line = parse_mpl2;
1373 return gst_caps_new_simple ("text/x-pango-markup", NULL);
1374 case GST_SUB_PARSE_FORMAT_DKS:
1375 self->parse_line = parse_dks;
1376 return gst_caps_new_simple ("text/plain", NULL);
1377 case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1378 self->parse_line = parse_subviewer;
1379 return gst_caps_new_simple ("text/plain", NULL);
1380 case GST_SUB_PARSE_FORMAT_UNKNOWN:
1382 GST_DEBUG ("no subtitle format detected");
1383 GST_ELEMENT_ERROR (self, STREAM, WRONG_TYPE,
1384 ("The input is not a valid/supported subtitle file"), (NULL));
1390 feed_textbuf (GstSubParse * self, GstBuffer * buf)
1394 gchar *input = NULL;
1396 discont = GST_BUFFER_IS_DISCONT (buf);
1398 if (GST_BUFFER_OFFSET_IS_VALID (buf) &&
1399 GST_BUFFER_OFFSET (buf) != self->offset) {
1400 self->offset = GST_BUFFER_OFFSET (buf);
1405 GST_INFO ("discontinuity");
1406 /* flush the parser state */
1407 parser_state_init (&self->state);
1408 g_string_truncate (self->textbuf, 0);
1409 gst_adapter_clear (self->adapter);
1410 #ifndef GST_DISABLE_XML
1411 sami_context_reset (&self->state);
1413 /* we could set a flag to make sure that the next buffer we push out also
1414 * has the DISCONT flag set, but there's no point really given that it's
1415 * subtitles which are discontinuous by nature. */
1418 self->offset = GST_BUFFER_OFFSET (buf) + GST_BUFFER_SIZE (buf);
1419 self->next_offset = self->offset;
1421 gst_adapter_push (self->adapter, buf);
1424 convert_encoding (self, (const gchar *) gst_adapter_peek (self->adapter,
1425 gst_adapter_available (self->adapter)),
1426 (gsize) gst_adapter_available (self->adapter), &consumed);
1428 if (input && consumed > 0) {
1429 self->textbuf = g_string_append (self->textbuf, input);
1430 gst_adapter_flush (self->adapter, consumed);
1436 static GstFlowReturn
1437 handle_buffer (GstSubParse * self, GstBuffer * buf)
1439 GstFlowReturn ret = GST_FLOW_OK;
1440 GstCaps *caps = NULL;
1441 gchar *line, *subtitle;
1443 if (self->first_buffer) {
1444 self->detected_encoding =
1445 detect_encoding ((gchar *) GST_BUFFER_DATA (buf),
1446 GST_BUFFER_SIZE (buf));
1447 self->first_buffer = FALSE;
1448 self->state.fps_n = self->fps_n;
1449 self->state.fps_d = self->fps_d;
1452 feed_textbuf (self, buf);
1454 /* make sure we know the format */
1455 if (G_UNLIKELY (self->parser_type == GST_SUB_PARSE_FORMAT_UNKNOWN)) {
1456 if (!(caps = gst_sub_parse_format_autodetect (self))) {
1457 return GST_FLOW_UNEXPECTED;
1459 if (!gst_pad_set_caps (self->srcpad, caps)) {
1460 gst_caps_unref (caps);
1461 return GST_FLOW_UNEXPECTED;
1463 gst_caps_unref (caps);
1466 if (self->subtitle_codec != NULL) {
1469 tags = gst_tag_list_new ();
1470 gst_tag_list_add (tags, GST_TAG_MERGE_APPEND, GST_TAG_SUBTITLE_CODEC,
1471 self->subtitle_codec, NULL);
1472 gst_element_found_tags_for_pad (GST_ELEMENT (self), self->srcpad, tags);
1476 while (!self->flushing && (line = get_next_line (self))) {
1479 /* Set segment on our parser state machine */
1480 self->state.segment = &self->segment;
1481 /* Now parse the line, out of segment lines will just return NULL */
1482 GST_LOG_OBJECT (self, "Parsing line '%s'", line + offset);
1483 subtitle = self->parse_line (&self->state, line + offset);
1487 guint subtitle_len = strlen (subtitle);
1489 /* +1 for terminating NUL character */
1490 ret = gst_pad_alloc_buffer_and_set_caps (self->srcpad,
1491 GST_BUFFER_OFFSET_NONE, subtitle_len + 1,
1492 GST_PAD_CAPS (self->srcpad), &buf);
1494 if (ret == GST_FLOW_OK) {
1495 /* copy terminating NUL character as well */
1496 memcpy (GST_BUFFER_DATA (buf), subtitle, subtitle_len + 1);
1497 GST_BUFFER_SIZE (buf) = subtitle_len;
1498 GST_BUFFER_TIMESTAMP (buf) = self->state.start_time;
1499 GST_BUFFER_DURATION (buf) = self->state.duration;
1501 /* in some cases (e.g. tmplayer) we can only determine the duration
1502 * of a text chunk from the timestamp of the next text chunk; in those
1503 * cases, we probably want to limit the duration to something
1504 * reasonable, so we don't end up showing some text for e.g. 40 seconds
1505 * just because nothing else is being said during that time */
1506 if (self->state.max_duration > 0 && GST_BUFFER_DURATION_IS_VALID (buf)) {
1507 if (GST_BUFFER_DURATION (buf) > self->state.max_duration)
1508 GST_BUFFER_DURATION (buf) = self->state.max_duration;
1511 gst_segment_set_last_stop (&self->segment, GST_FORMAT_TIME,
1512 self->state.start_time);
1514 GST_DEBUG_OBJECT (self, "Sending text '%s', %" GST_TIME_FORMAT " + %"
1515 GST_TIME_FORMAT, subtitle, GST_TIME_ARGS (self->state.start_time),
1516 GST_TIME_ARGS (self->state.duration));
1518 ret = gst_pad_push (self->srcpad, buf);
1521 /* move this forward (the tmplayer parser needs this) */
1522 if (self->state.duration != GST_CLOCK_TIME_NONE)
1523 self->state.start_time += self->state.duration;
1528 if (ret != GST_FLOW_OK) {
1529 GST_DEBUG_OBJECT (self, "flow: %s", gst_flow_get_name (ret));
1538 static GstFlowReturn
1539 gst_sub_parse_chain (GstPad * sinkpad, GstBuffer * buf)
1544 self = GST_SUBPARSE (GST_PAD_PARENT (sinkpad));
1546 /* Push newsegment if needed */
1547 if (self->need_segment) {
1548 GST_LOG_OBJECT (self, "pushing newsegment event with %" GST_SEGMENT_FORMAT,
1551 gst_pad_push_event (self->srcpad, gst_event_new_new_segment (FALSE,
1552 self->segment.rate, self->segment.format,
1553 self->segment.last_stop, self->segment.stop, self->segment.time));
1554 self->need_segment = FALSE;
1557 ret = handle_buffer (self, buf);
1563 gst_sub_parse_sink_event (GstPad * pad, GstEvent * event)
1565 GstSubParse *self = GST_SUBPARSE (gst_pad_get_parent (pad));
1566 gboolean ret = FALSE;
1568 GST_DEBUG ("Handling %s event", GST_EVENT_TYPE_NAME (event));
1570 switch (GST_EVENT_TYPE (event)) {
1571 case GST_EVENT_EOS:{
1572 /* Make sure the last subrip chunk is pushed out even
1573 * if the file does not have an empty line at the end */
1574 if (self->parser_type == GST_SUB_PARSE_FORMAT_SUBRIP ||
1575 self->parser_type == GST_SUB_PARSE_FORMAT_TMPLAYER ||
1576 self->parser_type == GST_SUB_PARSE_FORMAT_MPL2) {
1577 GstBuffer *buf = gst_buffer_new_and_alloc (2 + 1);
1579 GST_DEBUG ("EOS. Pushing remaining text (if any)");
1580 GST_BUFFER_DATA (buf)[0] = '\n';
1581 GST_BUFFER_DATA (buf)[1] = '\n';
1582 GST_BUFFER_DATA (buf)[2] = '\0'; /* play it safe */
1583 GST_BUFFER_SIZE (buf) = 2;
1584 GST_BUFFER_OFFSET (buf) = self->offset;
1585 gst_sub_parse_chain (pad, buf);
1587 ret = gst_pad_event_default (pad, event);
1590 case GST_EVENT_NEWSEGMENT:
1594 gint64 start, stop, time;
1597 gst_event_parse_new_segment (event, &update, &rate, &format, &start,
1600 GST_DEBUG_OBJECT (self, "newsegment (%s)", gst_format_get_name (format));
1602 if (format == GST_FORMAT_TIME) {
1603 gst_segment_set_newsegment (&self->segment, update, rate, format,
1606 /* if not time format, we'll either start with a 0 timestamp anyway or
1607 * it's following a seek in which case we'll have saved the requested
1608 * seek segment and don't want to overwrite it (remember that on a seek
1609 * we always just seek back to the start in BYTES format and just throw
1610 * away all text that's before the requested position; if the subtitles
1611 * come from an upstream demuxer, it won't be able to handle our BYTES
1612 * seek request and instead send us a newsegment from the seek request
1613 * it received via its video pads instead, so all is fine then too) */
1617 gst_event_unref (event);
1620 case GST_EVENT_FLUSH_START:
1622 self->flushing = TRUE;
1624 ret = gst_pad_event_default (pad, event);
1627 case GST_EVENT_FLUSH_STOP:
1629 self->flushing = FALSE;
1631 ret = gst_pad_event_default (pad, event);
1635 ret = gst_pad_event_default (pad, event);
1639 gst_object_unref (self);
1645 static GstStateChangeReturn
1646 gst_sub_parse_change_state (GstElement * element, GstStateChange transition)
1648 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1649 GstSubParse *self = GST_SUBPARSE (element);
1651 switch (transition) {
1652 case GST_STATE_CHANGE_READY_TO_PAUSED:
1653 /* format detection will init the parser state */
1655 self->next_offset = 0;
1656 self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1657 self->valid_utf8 = TRUE;
1658 self->first_buffer = TRUE;
1659 g_free (self->detected_encoding);
1660 self->detected_encoding = NULL;
1661 g_string_truncate (self->textbuf, 0);
1662 gst_adapter_clear (self->adapter);
1668 ret = parent_class->change_state (element, transition);
1669 if (ret == GST_STATE_CHANGE_FAILURE)
1672 switch (transition) {
1673 case GST_STATE_CHANGE_PAUSED_TO_READY:
1674 parser_state_dispose (self, &self->state);
1675 self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1688 /* FIXME 0.11: these caps are ugly, use app/x-subtitle + type field or so;
1689 * also, give different subtitle formats really different types */
1690 static GstStaticCaps mpl2_caps =
1691 GST_STATIC_CAPS ("application/x-subtitle-mpl2");
1692 #define SUB_CAPS (gst_static_caps_get (&sub_caps))
1694 static GstStaticCaps tmp_caps =
1695 GST_STATIC_CAPS ("application/x-subtitle-tmplayer");
1696 #define TMP_CAPS (gst_static_caps_get (&tmp_caps))
1698 static GstStaticCaps sub_caps = GST_STATIC_CAPS ("application/x-subtitle");
1699 #define MPL2_CAPS (gst_static_caps_get (&mpl2_caps))
1701 #ifndef GST_DISABLE_XML
1702 static GstStaticCaps smi_caps = GST_STATIC_CAPS ("application/x-subtitle-sami");
1703 #define SAMI_CAPS (gst_static_caps_get (&smi_caps))
1706 static GstStaticCaps dks_caps = GST_STATIC_CAPS ("application/x-subtitle-dks");
1707 #define DKS_CAPS (gst_static_caps_get (&dks_caps))
1710 gst_subparse_type_find (GstTypeFind * tf, gpointer private)
1712 GstSubParseFormat format;
1716 gchar *encoding = NULL;
1719 if (!(data = gst_type_find_peek (tf, 0, 129)))
1722 /* make sure string passed to _autodetect() is NUL-terminated */
1723 str = g_malloc0 (129);
1724 memcpy (str, data, 128);
1726 if ((encoding = detect_encoding (str, 128)) != NULL) {
1727 gchar *converted_str;
1731 converted_str = gst_convert_to_utf8 (str, 128, encoding, &tmp, &err);
1732 if (converted_str == NULL) {
1733 GST_DEBUG ("Encoding '%s' detected but conversion failed: %s", encoding,
1739 str = converted_str;
1744 /* Check if at least the first 120 chars are valid UTF8,
1745 * otherwise convert as always */
1746 if (!g_utf8_validate (str, 128, &end) && (end - str) < 120) {
1747 gchar *converted_str;
1752 enc = g_getenv ("GST_SUBTITLE_ENCODING");
1753 if (enc == NULL || *enc == '\0') {
1754 /* if local encoding is UTF-8 and no encoding specified
1755 * via the environment variable, assume ISO-8859-15 */
1756 if (g_get_charset (&enc)) {
1757 enc = "ISO-8859-15";
1760 converted_str = gst_convert_to_utf8 (str, 128, enc, &tmp, &err);
1761 if (converted_str == NULL) {
1762 GST_DEBUG ("Charset conversion failed: %s", err->message);
1768 str = converted_str;
1772 format = gst_sub_parse_data_format_autodetect (str);
1776 case GST_SUB_PARSE_FORMAT_MDVDSUB:
1777 GST_DEBUG ("MicroDVD format detected");
1780 case GST_SUB_PARSE_FORMAT_SUBRIP:
1781 GST_DEBUG ("SubRip format detected");
1784 case GST_SUB_PARSE_FORMAT_MPSUB:
1785 GST_DEBUG ("MPSub format detected");
1788 #ifndef GST_DISABLE_XML
1789 case GST_SUB_PARSE_FORMAT_SAMI:
1790 GST_DEBUG ("SAMI (time-based) format detected");
1794 case GST_SUB_PARSE_FORMAT_TMPLAYER:
1795 GST_DEBUG ("TMPlayer (time based) format detected");
1798 /* FIXME: our MPL2 typefinding is not really good enough to warrant
1799 * returning a high probability (however, since we registered our
1800 * typefinder here with a rank of MARGINAL we should pretty much only
1801 * be called if most other typefinders have already run */
1802 case GST_SUB_PARSE_FORMAT_MPL2:
1803 GST_DEBUG ("MPL2 (time based) format detected");
1806 case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1807 GST_DEBUG ("SubViewer format detected");
1810 case GST_SUB_PARSE_FORMAT_DKS:
1811 GST_DEBUG ("DKS format detected");
1815 case GST_SUB_PARSE_FORMAT_UNKNOWN:
1816 GST_DEBUG ("no subtitle format detected");
1820 /* if we're here, it's ok */
1821 gst_type_find_suggest (tf, GST_TYPE_FIND_MAXIMUM, caps);
1825 plugin_init (GstPlugin * plugin)
1827 static gchar *sub_exts[] = { "srt", "sub", "mpsub", "mdvd", "smi", "txt",
1831 GST_DEBUG_CATEGORY_INIT (sub_parse_debug, "subparse", 0, ".sub parser");
1833 if (!gst_type_find_register (plugin, "subparse_typefind", GST_RANK_MARGINAL,
1834 gst_subparse_type_find, sub_exts, SUB_CAPS, NULL, NULL))
1837 if (!gst_element_register (plugin, "subparse",
1838 GST_RANK_PRIMARY, GST_TYPE_SUBPARSE) ||
1839 !gst_element_register (plugin, "ssaparse",
1840 GST_RANK_PRIMARY, GST_TYPE_SSA_PARSE)) {
1847 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1851 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)