gst/subparse/gstsubparse.c

   1 /* GStreamer
   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>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <sys/types.h>
  29 #include <glib.h>
  30 #include <regex.h>
  31
  32 #include "gstsubparse.h"
  33 #include "gstssaparse.h"
  34 #include "samiparse.h"
  35 #include "tmplayerparse.h"
  36 #include "mpl2parse.h"
  37
  38 GST_DEBUG_CATEGORY (sub_parse_debug);
  39
  40 #define DEFAULT_ENCODING   NULL
  41
  42 enum
  43 {
  44   PROP_0,
  45   PROP_ENCODING
  46 };
  47
  48 static void
  49 gst_sub_parse_set_property (GObject * object, guint prop_id,
  50     const GValue * value, GParamSpec * pspec);
  51 static void
  52 gst_sub_parse_get_property (GObject * object, guint prop_id,
  53     GValue * value, GParamSpec * pspec);
  54
  55
  56 static const GstElementDetails sub_parse_details =
  57 GST_ELEMENT_DETAILS ("Subtitle parser",
  58     "Codec/Parser/Subtitle",
  59     "Parses subtitle (.sub) files into text streams",
  60     "Gustavo J. A. M. Carneiro <gjc@inescporto.pt>\n"
  61     "Ronald S. Bultje <rbultje@ronald.bitfreak.net>");
  62
  63 #ifndef GST_DISABLE_XML
  64 static GstStaticPadTemplate sink_templ = GST_STATIC_PAD_TEMPLATE ("sink",
  65     GST_PAD_SINK,
  66     GST_PAD_ALWAYS,
  67     GST_STATIC_CAPS ("application/x-subtitle; application/x-subtitle-sami; "
  68         "application/x-subtitle-tmplayer; application/x-subtitle-mpl2")
  69     );
  70 #else
  71 static GstStaticPadTemplate sink_templ = GST_STATIC_PAD_TEMPLATE ("sink",
  72     GST_PAD_SINK,
  73     GST_PAD_ALWAYS,
  74     GST_STATIC_CAPS ("application/x-subtitle")
  75     );
  76 #endif
  77
  78 static GstStaticPadTemplate src_templ = GST_STATIC_PAD_TEMPLATE ("src",
  79     GST_PAD_SRC,
  80     GST_PAD_ALWAYS,
  81     GST_STATIC_CAPS ("text/plain; text/x-pango-markup")
  82     );
  83
  84 static void gst_sub_parse_base_init (GstSubParseClass * klass);
  85 static void gst_sub_parse_class_init (GstSubParseClass * klass);
  86 static void gst_sub_parse_init (GstSubParse * subparse);
  87
  88 static gboolean gst_sub_parse_src_event (GstPad * pad, GstEvent * event);
  89 static gboolean gst_sub_parse_sink_event (GstPad * pad, GstEvent * event);
  90
  91 static GstStateChangeReturn gst_sub_parse_change_state (GstElement * element,
  92     GstStateChange transition);
  93
  94 static GstFlowReturn gst_sub_parse_chain (GstPad * sinkpad, GstBuffer * buf);
  95
  96 static GstElementClass *parent_class = NULL;
  97
  98 GType
  99 gst_sub_parse_get_type (void)
 100 {
 101   static GType sub_parse_type = 0;
 102
 103   if (!sub_parse_type) {
 104     static const GTypeInfo sub_parse_info = {
 105       sizeof (GstSubParseClass),
 106       (GBaseInitFunc) gst_sub_parse_base_init,
 107       NULL,
 108       (GClassInitFunc) gst_sub_parse_class_init,
 109       NULL,
 110       NULL,
 111       sizeof (GstSubParse),
 112       0,
 113       (GInstanceInitFunc) gst_sub_parse_init,
 114     };
 115
 116     sub_parse_type = g_type_register_static (GST_TYPE_ELEMENT,
 117         "GstSubParse", &sub_parse_info, 0);
 118   }
 119
 120   return sub_parse_type;
 121 }
 122
 123 static void
 124 gst_sub_parse_base_init (GstSubParseClass * klass)
 125 {
 126   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 127
 128   gst_element_class_add_pad_template (element_class,
 129       gst_static_pad_template_get (&sink_templ));
 130   gst_element_class_add_pad_template (element_class,
 131       gst_static_pad_template_get (&src_templ));
 132   gst_element_class_set_details (element_class, &sub_parse_details);
 133 }
 134
 135 static void
 136 gst_sub_parse_dispose (GObject * object)
 137 {
 138   GstSubParse *subparse = GST_SUBPARSE (object);
 139
 140   GST_DEBUG_OBJECT (subparse, "cleaning up subtitle parser");
 141
 142   if (subparse->encoding) {
 143     g_free (subparse->encoding);
 144     subparse->encoding = NULL;
 145   }
 146
 147   if (subparse->detected_encoding) {
 148     g_free (subparse->detected_encoding);
 149     subparse->detected_encoding = NULL;
 150   }
 151
 152   if (subparse->adapter) {
 153     gst_object_unref (subparse->adapter);
 154     subparse->adapter = NULL;
 155   }
 156
 157   if (subparse->textbuf) {
 158     g_string_free (subparse->textbuf, TRUE);
 159     subparse->textbuf = NULL;
 160   }
 161 #ifndef GST_DISABLE_XML
 162   sami_context_deinit (&subparse->state);
 163 #endif
 164
 165   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 166 }
 167
 168 static void
 169 gst_sub_parse_class_init (GstSubParseClass * klass)
 170 {
 171   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 172   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 173
 174   parent_class = g_type_class_peek_parent (klass);
 175
 176   object_class->dispose = gst_sub_parse_dispose;
 177   object_class->set_property = gst_sub_parse_set_property;
 178   object_class->get_property = gst_sub_parse_get_property;
 179
 180   element_class->change_state = gst_sub_parse_change_state;
 181
 182   g_object_class_install_property (object_class, PROP_ENCODING,
 183       g_param_spec_string ("subtitle-encoding", "subtitle charset encoding",
 184           "Encoding to assume if input subtitles are not in UTF-8 or any other "
 185           "Unicode encoding. If not set, the GST_SUBTITLE_ENCODING environment "
 186           "variable will be checked for an encoding to use. If that is not set "
 187           "either, ISO-8859-15 will be assumed.", DEFAULT_ENCODING,
 188           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 189 }
 190
 191 static void
 192 gst_sub_parse_init (GstSubParse * subparse)
 193 {
 194   subparse->sinkpad = gst_pad_new_from_static_template (&sink_templ, "sink");
 195   gst_pad_set_chain_function (subparse->sinkpad,
 196       GST_DEBUG_FUNCPTR (gst_sub_parse_chain));
 197   gst_pad_set_event_function (subparse->sinkpad,
 198       GST_DEBUG_FUNCPTR (gst_sub_parse_sink_event));
 199   gst_element_add_pad (GST_ELEMENT (subparse), subparse->sinkpad);
 200
 201   subparse->srcpad = gst_pad_new_from_static_template (&src_templ, "src");
 202   gst_pad_set_event_function (subparse->srcpad,
 203       GST_DEBUG_FUNCPTR (gst_sub_parse_src_event));
 204   gst_element_add_pad (GST_ELEMENT (subparse), subparse->srcpad);
 205
 206   subparse->textbuf = g_string_new (NULL);
 207   subparse->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
 208   subparse->flushing = FALSE;
 209   gst_segment_init (&subparse->segment, GST_FORMAT_TIME);
 210   subparse->need_segment = TRUE;
 211   subparse->encoding = g_strdup (DEFAULT_ENCODING);
 212   subparse->detected_encoding = NULL;
 213   subparse->adapter = gst_adapter_new ();
 214 }
 215
 216 /*
 217  * Source pad functions.
 218  */
 219
 220 static gboolean
 221 gst_sub_parse_src_event (GstPad * pad, GstEvent * event)
 222 {
 223   GstSubParse *self = GST_SUBPARSE (gst_pad_get_parent (pad));
 224   gboolean ret = FALSE;
 225
 226   GST_DEBUG ("Handling %s event", GST_EVENT_TYPE_NAME (event));
 227
 228   switch (GST_EVENT_TYPE (event)) {
 229     case GST_EVENT_SEEK:
 230     {
 231       GstFormat format;
 232       GstSeekType start_type, stop_type;
 233       gint64 start, stop;
 234       gdouble rate;
 235       gboolean update;
 236
 237       gst_event_parse_seek (event, &rate, &format, &self->segment_flags,
 238           &start_type, &start, &stop_type, &stop);
 239
 240       if (format != GST_FORMAT_TIME) {
 241         GST_WARNING_OBJECT (self, "we only support seeking in TIME format");
 242         gst_event_unref (event);
 243         goto beach;
 244       }
 245
 246       /* Convert that seek to a seeking in bytes at position 0,
 247          FIXME: could use an index */
 248       ret = gst_pad_push_event (self->sinkpad,
 249           gst_event_new_seek (rate, GST_FORMAT_BYTES, self->segment_flags,
 250               GST_SEEK_TYPE_SET, 0, GST_SEEK_TYPE_NONE, 0));
 251
 252       if (ret) {
 253         /* Apply the seek to our segment */
 254         gst_segment_set_seek (&self->segment, rate, format, self->segment_flags,
 255             start_type, start, stop_type, stop, &update);
 256
 257         GST_DEBUG_OBJECT (self, "segment after seek: %" GST_SEGMENT_FORMAT,
 258             &self->segment);
 259
 260         self->next_offset = 0;
 261
 262         self->need_segment = TRUE;
 263       } else {
 264         GST_WARNING_OBJECT (self, "seek to 0 bytes failed");
 265       }
 266
 267       gst_event_unref (event);
 268       break;
 269     }
 270     default:
 271       ret = gst_pad_event_default (pad, event);
 272       break;
 273   }
 274
 275 beach:
 276   gst_object_unref (self);
 277
 278   return ret;
 279 }
 280
 281 static void
 282 gst_sub_parse_set_property (GObject * object, guint prop_id,
 283     const GValue * value, GParamSpec * pspec)
 284 {
 285   GstSubParse *subparse = GST_SUBPARSE (object);
 286
 287   GST_OBJECT_LOCK (subparse);
 288   switch (prop_id) {
 289     case PROP_ENCODING:
 290       g_free (subparse->encoding);
 291       subparse->encoding = g_value_dup_string (value);
 292       GST_LOG_OBJECT (object, "subtitle encoding set to %s",
 293           GST_STR_NULL (subparse->encoding));
 294       break;
 295     default:
 296       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 297       break;
 298   }
 299   GST_OBJECT_UNLOCK (subparse);
 300 }
 301
 302 static void
 303 gst_sub_parse_get_property (GObject * object, guint prop_id,
 304     GValue * value, GParamSpec * pspec)
 305 {
 306   GstSubParse *subparse = GST_SUBPARSE (object);
 307
 308   GST_OBJECT_LOCK (subparse);
 309   switch (prop_id) {
 310     case PROP_ENCODING:
 311       g_value_set_string (value, subparse->encoding);
 312       break;
 313     default:
 314       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 315       break;
 316   }
 317   GST_OBJECT_UNLOCK (subparse);
 318 }
 319
 320 static gchar *
 321 gst_convert_to_utf8 (const gchar * str, gsize len, const gchar * encoding,
 322     gsize * consumed, GError ** err)
 323 {
 324   gchar *ret = NULL;
 325
 326   *consumed = 0;
 327   ret =
 328       g_convert_with_fallback (str, len, "UTF-8", encoding, "*", consumed, NULL,
 329       err);
 330   if (ret == NULL)
 331     return ret;
 332
 333   /* + 3 to skip UTF-8 BOM if it was added */
 334   len = strlen (ret);
 335   if (len >= 3 && (guint8) ret[0] == 0xEF && (guint8) ret[1] == 0xBB
 336       && (guint8) ret[2] == 0xBF)
 337     g_memmove (ret, ret + 3, len + 1 - 3);
 338
 339   return ret;
 340 }
 341
 342 static gchar *
 343 detect_encoding (const gchar * str, gsize len)
 344 {
 345   if (len >= 3 && (guint8) str[0] == 0xEF && (guint8) str[1] == 0xBB
 346       && (guint8) str[2] == 0xBF)
 347     return g_strdup ("UTF-8");
 348
 349   if (len >= 2 && (guint8) str[0] == 0xFE && (guint8) str[1] == 0xFF)
 350     return g_strdup ("UTF-16BE");
 351
 352   if (len >= 2 && (guint8) str[0] == 0xFF && (guint8) str[1] == 0xFE)
 353     return g_strdup ("UTF-16LE");
 354
 355   if (len >= 4 && (guint8) str[0] == 0x00 && (guint8) str[1] == 0x00
 356       && (guint8) str[2] == 0xFE && (guint8) str[3] == 0xFF)
 357     return g_strdup ("UTF-32BE");
 358
 359   if (len >= 4 && (guint8) str[0] == 0xFF && (guint8) str[1] == 0xFE
 360       && (guint8) str[2] == 0x00 && (guint8) str[3] == 0x00)
 361     return g_strdup ("UTF-32LE");
 362
 363   return NULL;
 364 }
 365
 366 static gchar *
 367 convert_encoding (GstSubParse * self, const gchar * str, gsize len,
 368     gsize * consumed)
 369 {
 370   const gchar *encoding;
 371   GError *err = NULL;
 372   gchar *ret = NULL;
 373
 374   *consumed = 0;
 375
 376   /* First try any detected encoding */
 377   if (self->detected_encoding) {
 378     ret =
 379         gst_convert_to_utf8 (str, len, self->detected_encoding, consumed, &err);
 380
 381     if (!err)
 382       return ret;
 383
 384     GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
 385         encoding, err->message);
 386     g_free (self->detected_encoding);
 387     self->detected_encoding = NULL;
 388     g_error_free (err);
 389   }
 390
 391   /* Otherwise check if it's UTF8 */
 392   if (self->valid_utf8) {
 393     if (g_utf8_validate (str, len, NULL)) {
 394       GST_LOG_OBJECT (self, "valid UTF-8, no conversion needed");
 395       *consumed = len;
 396       return g_strndup (str, len);
 397     }
 398     GST_INFO_OBJECT (self, "invalid UTF-8!");
 399     self->valid_utf8 = FALSE;
 400   }
 401
 402   /* Else try fallback */
 403   encoding = self->encoding;
 404   if (encoding == NULL || *encoding == '\0') {
 405     encoding = g_getenv ("GST_SUBTITLE_ENCODING");
 406   }
 407   if (encoding == NULL || *encoding == '\0') {
 408     /* if local encoding is UTF-8 and no encoding specified
 409      * via the environment variable, assume ISO-8859-15 */
 410     if (g_get_charset (&encoding)) {
 411       encoding = "ISO-8859-15";
 412     }
 413   }
 414
 415   ret = gst_convert_to_utf8 (str, len, encoding, consumed, &err);
 416
 417   if (err) {
 418     GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
 419         encoding, err->message);
 420     g_error_free (err);
 421
 422     /* invalid input encoding, fall back to ISO-8859-15 (always succeeds) */
 423     ret = gst_convert_to_utf8 (str, len, "ISO-8859-15", consumed, NULL);
 424   }
 425
 426   GST_LOG_OBJECT (self,
 427       "successfully converted %" G_GSIZE_FORMAT " characters from %s to UTF-8"
 428       "%s", len, encoding, (err) ? " , using ISO-8859-15 as fallback" : "");
 429
 430   return ret;
 431 }
 432
 433 static gchar *
 434 get_next_line (GstSubParse * self)
 435 {
 436   char *line = NULL;
 437   const char *line_end;
 438   int line_len;
 439   gboolean have_r = FALSE;
 440
 441   line_end = strchr (self->textbuf->str, '\n');
 442
 443   if (!line_end) {
 444     /* end-of-line not found; return for more data */
 445     return NULL;
 446   }
 447
 448   /* get rid of '\r' */
 449   if (line_end != self->textbuf->str && *(line_end - 1) == '\r') {
 450     line_end--;
 451     have_r = TRUE;
 452   }
 453
 454   line_len = line_end - self->textbuf->str;
 455   line = g_strndup (self->textbuf->str, line_len);
 456   self->textbuf = g_string_erase (self->textbuf, 0,
 457       line_len + (have_r ? 2 : 1));
 458   return line;
 459 }
 460
 461 static gchar *
 462 parse_mdvdsub (ParserState * state, const gchar * line)
 463 {
 464   const gchar *line_split;
 465   gchar *line_chunk;
 466   guint start_frame, end_frame;
 467   gint64 clip_start = 0, clip_stop = 0;
 468   gboolean in_seg = FALSE;
 469   GString *markup;
 470   gchar *ret;
 471
 472   /* style variables */
 473   gboolean italic;
 474   gboolean bold;
 475   guint fontsize;
 476
 477   if (sscanf (line, "{%u}{%u}", &start_frame, &end_frame) != 2) {
 478     g_warning ("Parse of the following line, assumed to be in microdvd .sub"
 479         " format, failed:\n%s", line);
 480     return NULL;
 481   }
 482
 483   /* skip the {%u}{%u} part */
 484   line = strchr (line, '}') + 1;
 485   line = strchr (line, '}') + 1;
 486
 487   /* see if there's a first line with a framerate */
 488   if (state->fps == 0.0 && start_frame == 1 && end_frame == 1) {
 489     gchar *rest, *end = NULL;
 490
 491     rest = g_strdup (line);
 492     g_strdelimit (rest, ",", '.');
 493     state->fps = g_ascii_strtod (rest, &end);
 494     if (end == rest)
 495       state->fps = 0.0;
 496     GST_INFO ("framerate from file: %f ('%s')", state->fps, rest);
 497     g_free (rest);
 498     return NULL;
 499   }
 500
 501   if (state->fps == 0.0) {
 502     /* FIXME: hardcoded for now, is there a better way/assumption? */
 503     state->fps = 24000.0 / 1001.0;
 504     GST_INFO ("no framerate specified, assuming %f", state->fps);
 505   }
 506
 507   state->start_time = start_frame / state->fps * GST_SECOND;
 508   state->duration = (end_frame - start_frame) / state->fps * GST_SECOND;
 509
 510   /* Check our segment start/stop */
 511   in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
 512       state->start_time, state->start_time + state->duration, &clip_start,
 513       &clip_stop);
 514
 515   /* No need to parse that text if it's out of segment */
 516   if (in_seg) {
 517     state->start_time = clip_start;
 518     state->duration = clip_stop - clip_start;
 519   } else {
 520     return NULL;
 521   }
 522
 523   markup = g_string_new (NULL);
 524   while (1) {
 525     italic = FALSE;
 526     bold = FALSE;
 527     fontsize = 0;
 528     /* parse style markup */
 529     if (strncmp (line, "{y:i}", 5) == 0) {
 530       italic = TRUE;
 531       line = strchr (line, '}') + 1;
 532     }
 533     if (strncmp (line, "{y:b}", 5) == 0) {
 534       bold = TRUE;
 535       line = strchr (line, '}') + 1;
 536     }
 537     if (sscanf (line, "{s:%u}", &fontsize) == 1) {
 538       line = strchr (line, '}') + 1;
 539     }
 540     /* forward slashes at beginning/end signify italics too */
 541     if (g_str_has_prefix (line, "/")) {
 542       italic = TRUE;
 543       ++line;
 544     }
 545     if ((line_split = strchr (line, '|')))
 546       line_chunk = g_markup_escape_text (line, line_split - line);
 547     else
 548       line_chunk = g_markup_escape_text (line, strlen (line));
 549
 550     /* Remove italics markers at end of line/stanza (CHECKME: are end slashes
 551      * always at the end of a line or can they span multiple lines?) */
 552     if (g_str_has_suffix (line_chunk, "/")) {
 553       line_chunk[strlen (line_chunk) - 1] = '\0';
 554     }
 555
 556     markup = g_string_append (markup, "<span");
 557     if (italic)
 558       g_string_append (markup, " style=\"italic\"");
 559     if (bold)
 560       g_string_append (markup, " weight=\"bold\"");
 561     if (fontsize)
 562       g_string_append_printf (markup, " size=\"%u\"", fontsize * 1000);
 563     g_string_append_printf (markup, ">%s</span>", line_chunk);
 564     g_free (line_chunk);
 565     if (line_split) {
 566       g_string_append (markup, "\n");
 567       line = line_split + 1;
 568     } else {
 569       break;
 570     }
 571   }
 572   ret = markup->str;
 573   g_string_free (markup, FALSE);
 574   GST_DEBUG ("parse_mdvdsub returning (%f+%f): %s",
 575       state->start_time / (double) GST_SECOND,
 576       state->duration / (double) GST_SECOND, ret);
 577   return ret;
 578 }
 579
 580 static void
 581 strip_trailing_newlines (gchar * txt)
 582 {
 583   if (txt) {
 584     guint len;
 585
 586     len = strlen (txt);
 587     while (len > 1 && txt[len - 1] == '\n') {
 588       txt[len - 1] = '\0';
 589       --len;
 590     }
 591   }
 592 }
 593
 594 /* we want to escape text in general, but retain basic markup like
 595  * <i></i>, <u></u>, and <b></b>. The easiest and safest way is to
 596  * just unescape a white list of allowed markups again after
 597  * escaping everything (the text between these simple markers isn't
 598  * necessarily escaped, so it seems best to do it like this) */
 599 static void
 600 subrip_unescape_formatting (gchar * txt)
 601 {
 602   gchar *pos;
 603
 604   for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
 605     if (g_ascii_strncasecmp (pos, "&lt;u&gt;", 9) == 0 ||
 606         g_ascii_strncasecmp (pos, "&lt;i&gt;", 9) == 0 ||
 607         g_ascii_strncasecmp (pos, "&lt;b&gt;", 9) == 0) {
 608       pos[0] = '<';
 609       pos[1] = g_ascii_tolower (pos[4]);
 610       pos[2] = '>';
 611       /* move NUL terminator as well */
 612       g_memmove (pos + 3, pos + 9, strlen (pos + 9) + 1);
 613       pos += 2;
 614     }
 615   }
 616
 617   for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
 618     if (g_ascii_strncasecmp (pos, "&lt;/u&gt;", 10) == 0 ||
 619         g_ascii_strncasecmp (pos, "&lt;/i&gt;", 10) == 0 ||
 620         g_ascii_strncasecmp (pos, "&lt;/b&gt;", 10) == 0) {
 621       pos[0] = '<';
 622       pos[1] = '/';
 623       pos[2] = g_ascii_tolower (pos[5]);
 624       pos[3] = '>';
 625       /* move NUL terminator as well */
 626       g_memmove (pos + 4, pos + 10, strlen (pos + 10) + 1);
 627       pos += 3;
 628     }
 629   }
 630 }
 631
 632
 633 static gboolean
 634 subrip_remove_unhandled_tag (gchar * start, gchar * stop)
 635 {
 636   gchar *tag, saved;
 637
 638   tag = start + strlen ("&lt;");
 639   if (*tag == '/')
 640     ++tag;
 641
 642   if (g_ascii_tolower (*tag) < 'a' || g_ascii_tolower (*tag) > 'z')
 643     return FALSE;
 644
 645   saved = *stop;
 646   *stop = '\0';
 647   GST_LOG ("removing unhandled tag '%s'", start);
 648   *stop = saved;
 649   g_memmove (start, stop, strlen (stop) + 1);
 650   return TRUE;
 651 }
 652
 653 /* remove tags we haven't explicitly allowed earlier on, like font tags
 654  * for example */
 655 static void
 656 subrip_remove_unhandled_tags (gchar * txt)
 657 {
 658   gchar *pos, *gt;
 659
 660   for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
 661     if (strncmp (pos, "&lt;", 4) == 0 && (gt = strstr (pos + 4, "&gt;"))) {
 662       if (subrip_remove_unhandled_tag (pos, gt + strlen ("&gt;")))
 663         --pos;
 664     }
 665   }
 666 }
 667
 668 /* we only allow <i>, <u> and <b>, so let's take a simple approach. This code
 669  * assumes the input has been escaped and subrip_unescape_formatting() has then
 670  * been run over the input! This function adds missing closing markup tags and
 671  * removes broken closing tags for tags that have never been opened. */
 672 static void
 673 subrip_fix_up_markup (gchar ** p_txt)
 674 {
 675   gchar *cur, *next_tag;
 676   gchar open_tags[32];
 677   guint num_open_tags = 0;
 678
 679   g_assert (*p_txt != NULL);
 680
 681   cur = *p_txt;
 682   while (*cur != '\0') {
 683     next_tag = strchr (cur, '<');
 684     if (next_tag == NULL)
 685       break;
 686     ++next_tag;
 687     switch (*next_tag) {
 688       case '/':{
 689         ++next_tag;
 690         if (num_open_tags == 0 || open_tags[num_open_tags - 1] != *next_tag) {
 691           GST_LOG ("broken input, closing tag '%c' is not open", *next_tag);
 692           g_memmove (next_tag - 2, next_tag + 2, strlen (next_tag + 2) + 1);
 693           next_tag -= 2;
 694         } else {
 695           /* it's all good, closing tag which is open */
 696           --num_open_tags;
 697         }
 698         break;
 699       }
 700       case 'i':
 701       case 'b':
 702       case 'u':
 703         if (num_open_tags == G_N_ELEMENTS (open_tags))
 704           return;               /* something dodgy is going on, stop parsing */
 705         open_tags[num_open_tags] = *next_tag;
 706         ++num_open_tags;
 707         break;
 708       default:
 709         GST_ERROR ("unexpected tag '%c' (%s)", *next_tag, next_tag);
 710         g_assert_not_reached ();
 711         break;
 712     }
 713     cur = next_tag;
 714   }
 715
 716   if (num_open_tags > 0) {
 717     GString *s;
 718
 719     s = g_string_new (*p_txt);
 720     while (num_open_tags > 0) {
 721       GST_LOG ("adding missing closing tag '%c'", open_tags[num_open_tags - 1]);
 722       g_string_append_c (s, '<');
 723       g_string_append_c (s, '/');
 724       g_string_append_c (s, open_tags[num_open_tags - 1]);
 725       g_string_append_c (s, '>');
 726       --num_open_tags;
 727     }
 728     g_free (*p_txt);
 729     *p_txt = g_string_free (s, FALSE);
 730   }
 731 }
 732
 733 static gchar *
 734 parse_subrip (ParserState * state, const gchar * line)
 735 {
 736   guint h1, m1, s1, ms1;
 737   guint h2, m2, s2, ms2;
 738   int subnum;
 739   gchar *ret;
 740
 741   switch (state->state) {
 742     case 0:
 743       /* looking for a single integer */
 744       if (sscanf (line, "%u", &subnum) == 1)
 745         state->state = 1;
 746       return NULL;
 747     case 1:
 748       /* looking for start_time --> end_time */
 749       if (sscanf (line, "%u:%u:%u,%u --> %u:%u:%u,%u",
 750               &h1, &m1, &s1, &ms1, &h2, &m2, &s2, &ms2) == 8) {
 751         state->state = 2;
 752         state->start_time =
 753             (((guint64) h1) * 3600 + m1 * 60 + s1) * GST_SECOND +
 754             ms1 * GST_MSECOND;
 755         state->duration =
 756             (((guint64) h2) * 3600 + m2 * 60 + s2) * GST_SECOND +
 757             ms2 * GST_MSECOND - state->start_time;
 758       } else {
 759         GST_DEBUG ("error parsing subrip time line");
 760         state->state = 0;
 761       }
 762       return NULL;
 763     case 2:
 764     {
 765       /* No need to parse that text if it's out of segment */
 766       gint64 clip_start = 0, clip_stop = 0;
 767       gboolean in_seg = FALSE;
 768
 769       /* Check our segment start/stop */
 770       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
 771           state->start_time, state->start_time + state->duration,
 772           &clip_start, &clip_stop);
 773
 774       if (in_seg) {
 775         state->start_time = clip_start;
 776         state->duration = clip_stop - clip_start;
 777       } else {
 778         state->state = 0;
 779         return NULL;
 780       }
 781     }
 782       /* looking for subtitle text; empty line ends this subtitle entry */
 783       if (state->buf->len)
 784         g_string_append_c (state->buf, '\n');
 785       g_string_append (state->buf, line);
 786       if (strlen (line) == 0) {
 787         ret = g_markup_escape_text (state->buf->str, state->buf->len);
 788         g_string_truncate (state->buf, 0);
 789         state->state = 0;
 790         subrip_unescape_formatting (ret);
 791         subrip_remove_unhandled_tags (ret);
 792         strip_trailing_newlines (ret);
 793         subrip_fix_up_markup (&ret);
 794         return ret;
 795       }
 796       return NULL;
 797     default:
 798       g_return_val_if_reached (NULL);
 799   }
 800 }
 801
 802 static void
 803 subviewer_unescape_newlines (gchar * read)
 804 {
 805   gchar *write = read;
 806
 807   /* Replace all occurences of '[br]' with a newline as version 2
 808    * of the subviewer format uses this for newlines */
 809
 810   if (read[0] == '\0' || read[1] == '\0' || read[2] == '\0' || read[3] == '\0')
 811     return;
 812
 813   do {
 814     if (strncmp (read, "[br]", 4) == 0) {
 815       *write = '\n';
 816       read += 4;
 817     } else {
 818       *write = *read;
 819       read++;
 820     }
 821     write++;
 822   } while (*read);
 823
 824   *write = '\0';
 825 }
 826
 827 static gchar *
 828 parse_subviewer (ParserState * state, const gchar * line)
 829 {
 830   guint h1, m1, s1, ms1;
 831   guint h2, m2, s2, ms2;
 832   gchar *ret;
 833
 834   /* TODO: Maybe also parse the fields in the header, especially DELAY.
 835    * For examples see the unit test or
 836    * http://www.doom9.org/index.html?/sub.htm */
 837
 838   switch (state->state) {
 839     case 0:
 840       /* looking for start_time,end_time */
 841       if (sscanf (line, "%u:%u:%u.%u,%u:%u:%u.%u",
 842               &h1, &m1, &s1, &ms1, &h2, &m2, &s2, &ms2) == 8) {
 843         state->state = 1;
 844         state->start_time =
 845             (((guint64) h1) * 3600 + m1 * 60 + s1) * GST_SECOND +
 846             ms1 * GST_MSECOND;
 847         state->duration =
 848             (((guint64) h2) * 3600 + m2 * 60 + s2) * GST_SECOND +
 849             ms2 * GST_MSECOND - state->start_time;
 850       }
 851       return NULL;
 852     case 1:
 853     {
 854       /* No need to parse that text if it's out of segment */
 855       gint64 clip_start = 0, clip_stop = 0;
 856       gboolean in_seg = FALSE;
 857
 858       /* Check our segment start/stop */
 859       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
 860           state->start_time, state->start_time + state->duration,
 861           &clip_start, &clip_stop);
 862
 863       if (in_seg) {
 864         state->start_time = clip_start;
 865         state->duration = clip_stop - clip_start;
 866       } else {
 867         state->state = 0;
 868         return NULL;
 869       }
 870     }
 871       /* looking for subtitle text; empty line ends this subtitle entry */
 872       if (state->buf->len)
 873         g_string_append_c (state->buf, '\n');
 874       g_string_append (state->buf, line);
 875       if (strlen (line) == 0) {
 876         ret = g_strdup (state->buf->str);
 877         subviewer_unescape_newlines (ret);
 878         strip_trailing_newlines (ret);
 879         g_string_truncate (state->buf, 0);
 880         state->state = 0;
 881         return ret;
 882       }
 883       return NULL;
 884     default:
 885       g_assert_not_reached ();
 886       return NULL;
 887   }
 888 }
 889
 890 static gchar *
 891 parse_mpsub (ParserState * state, const gchar * line)
 892 {
 893   gchar *ret;
 894   float t1, t2;
 895
 896   switch (state->state) {
 897     case 0:
 898       /* looking for two floats (offset, duration) */
 899       if (sscanf (line, "%f %f", &t1, &t2) == 2) {
 900         state->state = 1;
 901         state->start_time += state->duration + GST_SECOND * t1;
 902         state->duration = GST_SECOND * t2;
 903       }
 904       return NULL;
 905     case 1:
 906     {                           /* No need to parse that text if it's out of segment */
 907       gint64 clip_start = 0, clip_stop = 0;
 908       gboolean in_seg = FALSE;
 909
 910       /* Check our segment start/stop */
 911       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
 912           state->start_time, state->start_time + state->duration,
 913           &clip_start, &clip_stop);
 914
 915       if (in_seg) {
 916         state->start_time = clip_start;
 917         state->duration = clip_stop - clip_start;
 918       } else {
 919         state->state = 0;
 920         return NULL;
 921       }
 922     }
 923       /* looking for subtitle text; empty line ends this
 924        * subtitle entry */
 925       if (state->buf->len)
 926         g_string_append_c (state->buf, '\n');
 927       g_string_append (state->buf, line);
 928       if (strlen (line) == 0) {
 929         ret = g_strdup (state->buf->str);
 930         g_string_truncate (state->buf, 0);
 931         state->state = 0;
 932         return ret;
 933       }
 934       return NULL;
 935     default:
 936       g_assert_not_reached ();
 937       return NULL;
 938   }
 939 }
 940
 941 static void
 942 parser_state_init (ParserState * state)
 943 {
 944   GST_DEBUG ("initialising parser");
 945
 946   if (state->buf) {
 947     g_string_truncate (state->buf, 0);
 948   } else {
 949     state->buf = g_string_new (NULL);
 950   }
 951
 952   state->start_time = 0;
 953   state->duration = 0;
 954   state->max_duration = 0;      /* no limit */
 955   state->state = 0;
 956   state->segment = NULL;
 957 }
 958
 959 static void
 960 parser_state_dispose (ParserState * state)
 961 {
 962   if (state->buf) {
 963     g_string_free (state->buf, TRUE);
 964     state->buf = NULL;
 965   }
 966 #ifndef GST_DISABLE_XML
 967   if (state->user_data) {
 968     sami_context_reset (state);
 969   }
 970 #endif
 971 }
 972
 973 /* regex type enum */
 974 typedef enum
 975 {
 976   GST_SUB_PARSE_REGEX_UNKNOWN = 0,
 977   GST_SUB_PARSE_REGEX_MDVDSUB = 1,
 978   GST_SUB_PARSE_REGEX_SUBRIP = 2,
 979 } GstSubParseRegex;
 980
 981 static gpointer
 982 gst_sub_parse_data_format_autodetect_regex_once (GstSubParseRegex regtype)
 983 {
 984   gpointer result = NULL;
 985   GError *gerr = NULL;
 986   switch (regtype) {
 987     case GST_SUB_PARSE_REGEX_MDVDSUB:
 988       result =
 989           (gpointer) g_regex_new ("^\\{[0-9]+\\}\\{[0-9]+\\}", 0, 0, &gerr);
 990       if (result == NULL) {
 991         g_warning ("Compilation of mdvd regex failed: %s", gerr->message);
 992         g_error_free (gerr);
 993       }
 994       break;
 995     case GST_SUB_PARSE_REGEX_SUBRIP:
 996       result = (gpointer) g_regex_new ("^([ 0-9]){0,3}[0-9](\x0d)?\x0a"
 997           "[ 0-9][0-9]:[ 0-9][0-9]:[ 0-9][0-9],[ 0-9]{2}[0-9]"
 998           " --> ([ 0-9])?[0-9]:[ 0-9][0-9]:[ 0-9][0-9],[ 0-9]{2}[0-9]",
 999           0, 0, &gerr);
1000       if (result == NULL) {
1001         g_warning ("Compilation of subrip regex failed: %s", gerr->message);
1002         g_error_free (gerr);
1003       }
1004       break;
1005     default:
1006       GST_WARNING ("Trying to allocate regex of unknown type %u", regtype);
1007   }
1008   return result;
1009 }
1010
1011 /*
1012  * FIXME: maybe we should pass along a second argument, the preceding
1013  * text buffer, because that is how this originally worked, even though
1014  * I don't really see the use of that.
1015  */
1016
1017 static GstSubParseFormat
1018 gst_sub_parse_data_format_autodetect (gchar * match_str)
1019 {
1020   guint n1, n2, n3;
1021
1022   static GOnce mdvd_rx_once = G_ONCE_INIT;
1023   static GOnce subrip_rx_once = G_ONCE_INIT;
1024
1025   GRegex *mdvd_grx;
1026   GRegex *subrip_grx;
1027
1028   g_once (&mdvd_rx_once,
1029       (GThreadFunc) gst_sub_parse_data_format_autodetect_regex_once,
1030       (gpointer) GST_SUB_PARSE_REGEX_MDVDSUB);
1031   g_once (&subrip_rx_once,
1032       (GThreadFunc) gst_sub_parse_data_format_autodetect_regex_once,
1033       (gpointer) GST_SUB_PARSE_REGEX_SUBRIP);
1034
1035   mdvd_grx = (GRegex *) mdvd_rx_once.retval;
1036   subrip_grx = (GRegex *) subrip_rx_once.retval;
1037
1038   if (g_regex_match (mdvd_grx, match_str, 0, NULL) == TRUE) {
1039     GST_LOG ("MicroDVD (frame based) format detected");
1040     return GST_SUB_PARSE_FORMAT_MDVDSUB;
1041   }
1042   if (g_regex_match (subrip_grx, match_str, 0, NULL) == TRUE) {
1043     GST_LOG ("SubRip (time based) format detected");
1044     return GST_SUB_PARSE_FORMAT_SUBRIP;
1045   }
1046
1047   if (!strncmp (match_str, "FORMAT=TIME", 11)) {
1048     GST_LOG ("MPSub (time based) format detected");
1049     return GST_SUB_PARSE_FORMAT_MPSUB;
1050   }
1051 #ifndef GST_DISABLE_XML
1052   if (strstr (match_str, "<SAMI>") != NULL ||
1053       strstr (match_str, "<sami>") != NULL) {
1054     GST_LOG ("SAMI (time based) format detected");
1055     return GST_SUB_PARSE_FORMAT_SAMI;
1056   }
1057 #endif
1058   /* we're boldly assuming the first subtitle appears within the first hour */
1059   if (sscanf (match_str, "0:%02u:%02u:", &n1, &n2) == 2 ||
1060       sscanf (match_str, "0:%02u:%02u=", &n1, &n2) == 2 ||
1061       sscanf (match_str, "00:%02u:%02u:", &n1, &n2) == 2 ||
1062       sscanf (match_str, "00:%02u:%02u=", &n1, &n2) == 2 ||
1063       sscanf (match_str, "00:%02u:%02u,%u=", &n1, &n2, &n3) == 3) {
1064     GST_LOG ("TMPlayer (time based) format detected");
1065     return GST_SUB_PARSE_FORMAT_TMPLAYER;
1066   }
1067   if (sscanf (match_str, "[%u][%u]", &n1, &n2) == 2) {
1068     GST_LOG ("MPL2 (time based) format detected");
1069     return GST_SUB_PARSE_FORMAT_MPL2;
1070   }
1071   if (strstr (match_str, "[INFORMATION]") != NULL) {
1072     GST_LOG ("SubViewer (time based) format detected");
1073     return GST_SUB_PARSE_FORMAT_SUBVIEWER;
1074   }
1075
1076   GST_DEBUG ("no subtitle format detected");
1077   return GST_SUB_PARSE_FORMAT_UNKNOWN;
1078 }
1079
1080 static GstCaps *
1081 gst_sub_parse_format_autodetect (GstSubParse * self)
1082 {
1083   gchar *data;
1084   GstSubParseFormat format;
1085
1086   if (strlen (self->textbuf->str) < 35) {
1087     GST_DEBUG ("File too small to be a subtitles file");
1088     return NULL;
1089   }
1090
1091   data = g_strndup (self->textbuf->str, 35);
1092   format = gst_sub_parse_data_format_autodetect (data);
1093   g_free (data);
1094
1095   self->parser_type = format;
1096   parser_state_init (&self->state);
1097
1098   switch (format) {
1099     case GST_SUB_PARSE_FORMAT_MDVDSUB:
1100       self->parse_line = parse_mdvdsub;
1101       return gst_caps_new_simple ("text/x-pango-markup", NULL);
1102     case GST_SUB_PARSE_FORMAT_SUBRIP:
1103       self->parse_line = parse_subrip;
1104       return gst_caps_new_simple ("text/x-pango-markup", NULL);
1105     case GST_SUB_PARSE_FORMAT_MPSUB:
1106       self->parse_line = parse_mpsub;
1107       return gst_caps_new_simple ("text/plain", NULL);
1108 #ifndef GST_DISABLE_XML
1109     case GST_SUB_PARSE_FORMAT_SAMI:
1110       self->parse_line = parse_sami;
1111       sami_context_init (&self->state);
1112       return gst_caps_new_simple ("text/x-pango-markup", NULL);
1113 #endif
1114     case GST_SUB_PARSE_FORMAT_TMPLAYER:
1115       self->parse_line = parse_tmplayer;
1116       self->state.max_duration = 5 * GST_SECOND;
1117       return gst_caps_new_simple ("text/plain", NULL);
1118     case GST_SUB_PARSE_FORMAT_MPL2:
1119       self->parse_line = parse_mpl2;
1120       return gst_caps_new_simple ("text/x-pango-markup", NULL);
1121     case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1122       self->parse_line = parse_subviewer;
1123       return gst_caps_new_simple ("text/plain", NULL);
1124     case GST_SUB_PARSE_FORMAT_UNKNOWN:
1125     default:
1126       GST_DEBUG ("no subtitle format detected");
1127       GST_ELEMENT_ERROR (self, STREAM, WRONG_TYPE,
1128           ("The input is not a valid/supported subtitle file"), (NULL));
1129       return NULL;
1130   }
1131 }
1132
1133 static void
1134 feed_textbuf (GstSubParse * self, GstBuffer * buf)
1135 {
1136   gboolean discont;
1137   gsize consumed;
1138   gchar *input = NULL;
1139
1140   discont = GST_BUFFER_IS_DISCONT (buf);
1141
1142   if (GST_BUFFER_OFFSET_IS_VALID (buf) &&
1143       GST_BUFFER_OFFSET (buf) != self->offset) {
1144     self->offset = GST_BUFFER_OFFSET (buf);
1145     discont = TRUE;
1146   }
1147
1148   if (discont) {
1149     GST_INFO ("discontinuity");
1150     /* flush the parser state */
1151     parser_state_init (&self->state);
1152     g_string_truncate (self->textbuf, 0);
1153     gst_adapter_clear (self->adapter);
1154 #ifndef GST_DISABLE_XML
1155     sami_context_reset (&self->state);
1156 #endif
1157     /* we could set a flag to make sure that the next buffer we push out also
1158      * has the DISCONT flag set, but there's no point really given that it's
1159      * subtitles which are discontinuous by nature. */
1160   }
1161
1162   self->offset = GST_BUFFER_OFFSET (buf) + GST_BUFFER_SIZE (buf);
1163   self->next_offset = self->offset;
1164
1165   gst_adapter_push (self->adapter, buf);
1166
1167   input =
1168       convert_encoding (self, (const gchar *) gst_adapter_peek (self->adapter,
1169           gst_adapter_available (self->adapter)),
1170       (gsize) gst_adapter_available (self->adapter), &consumed);
1171
1172   if (input && consumed > 0) {
1173     self->textbuf = g_string_append (self->textbuf, input);
1174     gst_adapter_flush (self->adapter, consumed);
1175   }
1176
1177   g_free (input);
1178 }
1179
1180 static GstFlowReturn
1181 handle_buffer (GstSubParse * self, GstBuffer * buf)
1182 {
1183   GstFlowReturn ret = GST_FLOW_OK;
1184   GstCaps *caps = NULL;
1185   gchar *line, *subtitle;
1186
1187   if (self->first_buffer) {
1188     self->detected_encoding =
1189         detect_encoding ((gchar *) GST_BUFFER_DATA (buf),
1190         GST_BUFFER_SIZE (buf));
1191     self->first_buffer = FALSE;
1192   }
1193
1194   feed_textbuf (self, buf);
1195
1196   /* make sure we know the format */
1197   if (G_UNLIKELY (self->parser_type == GST_SUB_PARSE_FORMAT_UNKNOWN)) {
1198     if (!(caps = gst_sub_parse_format_autodetect (self))) {
1199       return GST_FLOW_UNEXPECTED;
1200     }
1201     if (!gst_pad_set_caps (self->srcpad, caps)) {
1202       gst_caps_unref (caps);
1203       return GST_FLOW_UNEXPECTED;
1204     }
1205     gst_caps_unref (caps);
1206   }
1207
1208   while (!self->flushing && (line = get_next_line (self))) {
1209     guint offset = 0;
1210
1211     /* Set segment on our parser state machine */
1212     self->state.segment = &self->segment;
1213     /* Now parse the line, out of segment lines will just return NULL */
1214     GST_LOG_OBJECT (self, "Parsing line '%s'", line + offset);
1215     subtitle = self->parse_line (&self->state, line + offset);
1216     g_free (line);
1217
1218     if (subtitle) {
1219       guint subtitle_len = strlen (subtitle);
1220
1221       /* +1 for terminating NUL character */
1222       ret = gst_pad_alloc_buffer_and_set_caps (self->srcpad,
1223           GST_BUFFER_OFFSET_NONE, subtitle_len + 1,
1224           GST_PAD_CAPS (self->srcpad), &buf);
1225
1226       if (ret == GST_FLOW_OK) {
1227         /* copy terminating NUL character as well */
1228         memcpy (GST_BUFFER_DATA (buf), subtitle, subtitle_len + 1);
1229         GST_BUFFER_SIZE (buf) = subtitle_len;
1230         GST_BUFFER_TIMESTAMP (buf) = self->state.start_time;
1231         GST_BUFFER_DURATION (buf) = self->state.duration;
1232
1233         /* in some cases (e.g. tmplayer) we can only determine the duration
1234          * of a text chunk from the timestamp of the next text chunk; in those
1235          * cases, we probably want to limit the duration to something
1236          * reasonable, so we don't end up showing some text for e.g. 40 seconds
1237          * just because nothing else is being said during that time */
1238         if (self->state.max_duration > 0 && GST_BUFFER_DURATION_IS_VALID (buf)) {
1239           if (GST_BUFFER_DURATION (buf) > self->state.max_duration)
1240             GST_BUFFER_DURATION (buf) = self->state.max_duration;
1241         }
1242
1243         gst_segment_set_last_stop (&self->segment, GST_FORMAT_TIME,
1244             self->state.start_time);
1245
1246         GST_DEBUG_OBJECT (self, "Sending text '%s', %" GST_TIME_FORMAT " + %"
1247             GST_TIME_FORMAT, subtitle, GST_TIME_ARGS (self->state.start_time),
1248             GST_TIME_ARGS (self->state.duration));
1249
1250         ret = gst_pad_push (self->srcpad, buf);
1251       }
1252
1253       /* move this forward (the tmplayer parser needs this) */
1254       if (self->state.duration != GST_CLOCK_TIME_NONE)
1255         self->state.start_time += self->state.duration;
1256
1257       g_free (subtitle);
1258       subtitle = NULL;
1259
1260       if (ret != GST_FLOW_OK) {
1261         GST_DEBUG_OBJECT (self, "flow: %s", gst_flow_get_name (ret));
1262         break;
1263       }
1264     }
1265   }
1266
1267   return ret;
1268 }
1269
1270 static GstFlowReturn
1271 gst_sub_parse_chain (GstPad * sinkpad, GstBuffer * buf)
1272 {
1273   GstFlowReturn ret;
1274   GstSubParse *self;
1275
1276   self = GST_SUBPARSE (GST_PAD_PARENT (sinkpad));
1277
1278   /* Push newsegment if needed */
1279   if (self->need_segment) {
1280     GST_LOG_OBJECT (self, "pushing newsegment event with %" GST_SEGMENT_FORMAT,
1281         &self->segment);
1282
1283     gst_pad_push_event (self->srcpad, gst_event_new_new_segment (FALSE,
1284             self->segment.rate, self->segment.format,
1285             self->segment.last_stop, self->segment.stop, self->segment.time));
1286     self->need_segment = FALSE;
1287   }
1288
1289   ret = handle_buffer (self, buf);
1290
1291   return ret;
1292 }
1293
1294 static gboolean
1295 gst_sub_parse_sink_event (GstPad * pad, GstEvent * event)
1296 {
1297   GstSubParse *self = GST_SUBPARSE (gst_pad_get_parent (pad));
1298   gboolean ret = FALSE;
1299
1300   GST_DEBUG ("Handling %s event", GST_EVENT_TYPE_NAME (event));
1301
1302   switch (GST_EVENT_TYPE (event)) {
1303     case GST_EVENT_EOS:{
1304       /* Make sure the last subrip chunk is pushed out even
1305        * if the file does not have an empty line at the end */
1306       if (self->parser_type == GST_SUB_PARSE_FORMAT_SUBRIP ||
1307           self->parser_type == GST_SUB_PARSE_FORMAT_TMPLAYER ||
1308           self->parser_type == GST_SUB_PARSE_FORMAT_MPL2) {
1309         GstBuffer *buf = gst_buffer_new_and_alloc (2 + 1);
1310
1311         GST_DEBUG ("EOS. Pushing remaining text (if any)");
1312         GST_BUFFER_DATA (buf)[0] = '\n';
1313         GST_BUFFER_DATA (buf)[1] = '\n';
1314         GST_BUFFER_DATA (buf)[2] = '\0';        /* play it safe */
1315         GST_BUFFER_SIZE (buf) = 2;
1316         GST_BUFFER_OFFSET (buf) = self->offset;
1317         gst_sub_parse_chain (pad, buf);
1318       }
1319       ret = gst_pad_event_default (pad, event);
1320       break;
1321     }
1322     case GST_EVENT_NEWSEGMENT:
1323     {
1324       GstFormat format;
1325       gdouble rate;
1326       gint64 start, stop, time;
1327       gboolean update;
1328
1329       gst_event_parse_new_segment (event, &update, &rate, &format, &start,
1330           &stop, &time);
1331
1332       GST_DEBUG_OBJECT (self, "newsegment (%s)", gst_format_get_name (format));
1333
1334       if (format == GST_FORMAT_TIME) {
1335         gst_segment_set_newsegment (&self->segment, update, rate, format,
1336             start, stop, time);
1337       } else {
1338         /* if not time format, we'll either start with a 0 timestamp anyway or
1339          * it's following a seek in which case we'll have saved the requested
1340          * seek segment and don't want to overwrite it (remember that on a seek
1341          * we always just seek back to the start in BYTES format and just throw
1342          * away all text that's before the requested position; if the subtitles
1343          * come from an upstream demuxer, it won't be able to handle our BYTES
1344          * seek request and instead send us a newsegment from the seek request
1345          * it received via its video pads instead, so all is fine then too) */
1346       }
1347
1348       ret = TRUE;
1349       gst_event_unref (event);
1350       break;
1351     }
1352     case GST_EVENT_FLUSH_START:
1353     {
1354       self->flushing = TRUE;
1355
1356       ret = gst_pad_event_default (pad, event);
1357       break;
1358     }
1359     case GST_EVENT_FLUSH_STOP:
1360     {
1361       self->flushing = FALSE;
1362
1363       ret = gst_pad_event_default (pad, event);
1364       break;
1365     }
1366     default:
1367       ret = gst_pad_event_default (pad, event);
1368       break;
1369   }
1370
1371   gst_object_unref (self);
1372
1373   return ret;
1374 }
1375
1376
1377 static GstStateChangeReturn
1378 gst_sub_parse_change_state (GstElement * element, GstStateChange transition)
1379 {
1380   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1381   GstSubParse *self = GST_SUBPARSE (element);
1382
1383   switch (transition) {
1384     case GST_STATE_CHANGE_READY_TO_PAUSED:
1385       /* format detection will init the parser state */
1386       self->offset = 0;
1387       self->next_offset = 0;
1388       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1389       self->valid_utf8 = TRUE;
1390       self->first_buffer = TRUE;
1391       g_free (self->detected_encoding);
1392       self->detected_encoding = NULL;
1393       g_string_truncate (self->textbuf, 0);
1394       gst_adapter_clear (self->adapter);
1395       break;
1396     default:
1397       break;
1398   }
1399
1400   ret = parent_class->change_state (element, transition);
1401   if (ret == GST_STATE_CHANGE_FAILURE)
1402     return ret;
1403
1404   switch (transition) {
1405     case GST_STATE_CHANGE_PAUSED_TO_READY:
1406       parser_state_dispose (&self->state);
1407       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1408       break;
1409     default:
1410       break;
1411   }
1412
1413   return ret;
1414 }
1415
1416 /*
1417  * Typefind support.
1418  */
1419
1420 /* FIXME 0.11: these caps are ugly, use app/x-subtitle + type field or so;
1421  * also, give different  subtitle formats really different types */
1422 static GstStaticCaps mpl2_caps =
1423 GST_STATIC_CAPS ("application/x-subtitle-mpl2");
1424 #define SUB_CAPS (gst_static_caps_get (&sub_caps))
1425
1426 static GstStaticCaps tmp_caps =
1427 GST_STATIC_CAPS ("application/x-subtitle-tmplayer");
1428 #define TMP_CAPS (gst_static_caps_get (&tmp_caps))
1429
1430 static GstStaticCaps sub_caps = GST_STATIC_CAPS ("application/x-subtitle");
1431 #define MPL2_CAPS (gst_static_caps_get (&mpl2_caps))
1432
1433 #ifndef GST_DISABLE_XML
1434 static GstStaticCaps smi_caps = GST_STATIC_CAPS ("application/x-subtitle-sami");
1435 #define SAMI_CAPS (gst_static_caps_get (&smi_caps))
1436 #endif
1437
1438 static void
1439 gst_subparse_type_find (GstTypeFind * tf, gpointer private)
1440 {
1441   GstSubParseFormat format;
1442   const guint8 *data;
1443   GstCaps *caps;
1444   gchar *str;
1445   gchar *encoding = NULL;
1446   const gchar *end;
1447
1448   if (!(data = gst_type_find_peek (tf, 0, 129)))
1449     return;
1450
1451   /* make sure string passed to _autodetect() is NUL-terminated */
1452   str = g_malloc0 (129);
1453   memcpy (str, data, 128);
1454
1455   if ((encoding = detect_encoding (str, 128)) != NULL) {
1456     gchar *converted_str;
1457     GError *err = NULL;
1458     gsize tmp;
1459
1460     converted_str = gst_convert_to_utf8 (str, 128, encoding, &tmp, &err);
1461     if (converted_str == NULL) {
1462       GST_DEBUG ("Encoding '%s' detected but conversion failed: %s", encoding,
1463           err->message);
1464       g_error_free (err);
1465       g_free (encoding);
1466     } else {
1467       g_free (str);
1468       str = converted_str;
1469       g_free (encoding);
1470     }
1471   }
1472
1473   /* Check if at least the first 120 chars are valid UTF8,
1474    * otherwise convert as always */
1475   if (!g_utf8_validate (str, 128, &end) && (end - str) < 120) {
1476     gchar *converted_str;
1477     GError *err = NULL;
1478     gsize tmp;
1479     const gchar *enc;
1480
1481     enc = g_getenv ("GST_SUBTITLE_ENCODING");
1482     if (enc == NULL || *enc == '\0') {
1483       /* if local encoding is UTF-8 and no encoding specified
1484        * via the environment variable, assume ISO-8859-15 */
1485       if (g_get_charset (&enc)) {
1486         enc = "ISO-8859-15";
1487       }
1488     }
1489     converted_str = gst_convert_to_utf8 (str, 128, enc, &tmp, &err);
1490     if (converted_str == NULL) {
1491       GST_DEBUG ("Charset conversion failed: %s", err->message);
1492       g_error_free (err);
1493       g_free (str);
1494       return;
1495     } else {
1496       g_free (str);
1497       str = converted_str;
1498     }
1499   }
1500
1501   format = gst_sub_parse_data_format_autodetect (str);
1502   g_free (str);
1503
1504   switch (format) {
1505     case GST_SUB_PARSE_FORMAT_MDVDSUB:
1506       GST_DEBUG ("MicroDVD format detected");
1507       caps = SUB_CAPS;
1508       break;
1509     case GST_SUB_PARSE_FORMAT_SUBRIP:
1510       GST_DEBUG ("SubRip format detected");
1511       caps = SUB_CAPS;
1512       break;
1513     case GST_SUB_PARSE_FORMAT_MPSUB:
1514       GST_DEBUG ("MPSub format detected");
1515       caps = SUB_CAPS;
1516       break;
1517 #ifndef GST_DISABLE_XML
1518     case GST_SUB_PARSE_FORMAT_SAMI:
1519       GST_DEBUG ("SAMI (time-based) format detected");
1520       caps = SAMI_CAPS;
1521       break;
1522 #endif
1523     case GST_SUB_PARSE_FORMAT_TMPLAYER:
1524       GST_DEBUG ("TMPlayer (time based) format detected");
1525       caps = TMP_CAPS;
1526       break;
1527       /* FIXME: our MPL2 typefinding is not really good enough to warrant
1528        * returning a high probability (however, since we registered our
1529        * typefinder here with a rank of MARGINAL we should pretty much only
1530        * be called if most other typefinders have already run */
1531     case GST_SUB_PARSE_FORMAT_MPL2:
1532       GST_DEBUG ("MPL2 (time based) format detected");
1533       caps = MPL2_CAPS;
1534       break;
1535     case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1536       GST_DEBUG ("SubViewer format detected");
1537       caps = SUB_CAPS;
1538       break;
1539     default:
1540     case GST_SUB_PARSE_FORMAT_UNKNOWN:
1541       GST_DEBUG ("no subtitle format detected");
1542       return;
1543   }
1544
1545   /* if we're here, it's ok */
1546   gst_type_find_suggest (tf, GST_TYPE_FIND_MAXIMUM, caps);
1547 }
1548
1549 static gboolean
1550 plugin_init (GstPlugin * plugin)
1551 {
1552   static gchar *sub_exts[] = { "srt", "sub", "mpsub", "mdvd", "smi", "txt",
1553     NULL
1554   };
1555
1556   GST_DEBUG_CATEGORY_INIT (sub_parse_debug, "subparse", 0, ".sub parser");
1557
1558   if (!gst_type_find_register (plugin, "subparse_typefind", GST_RANK_MARGINAL,
1559           gst_subparse_type_find, sub_exts, SUB_CAPS, NULL, NULL))
1560     return FALSE;
1561
1562   if (!gst_element_register (plugin, "subparse",
1563           GST_RANK_PRIMARY, GST_TYPE_SUBPARSE) ||
1564       !gst_element_register (plugin, "ssaparse",
1565           GST_RANK_PRIMARY, GST_TYPE_SSA_PARSE)) {
1566     return FALSE;
1567   }
1568
1569   return TRUE;
1570 }
1571
1572 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1573     GST_VERSION_MINOR,
1574     "subparse",
1575     "Subtitle parsing",
1576     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)