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