subprojects/gst-plugins-base/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  * Copyright (C) 2016 Philippe Normand <pnormand@igalia.com>
   6  * Copyright (C) 2016 Jan Schmidt <jan@centricular.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <sys/types.h>
  32 #include <glib.h>
  33
  34 #include "gstsubparse.h"
  35
  36 #include "gstssaparse.h"
  37 #include "samiparse.h"
  38 #include "tmplayerparse.h"
  39 #include "mpl2parse.h"
  40 #include "qttextparse.h"
  41 #include "gstsubparseelements.h"
  42
  43 #define DEFAULT_ENCODING   NULL
  44 #define ATTRIBUTE_REGEX "\\s?[a-zA-Z0-9\\. \t\\(\\)]*"
  45 static const gchar *allowed_srt_tags[] = { "i", "b", "u", NULL };
  46 static const gchar *allowed_vtt_tags[] =
  47     { "i", "b", "c", "u", "v", "ruby", "rt", NULL };
  48
  49 enum
  50 {
  51   PROP_0,
  52   PROP_ENCODING,
  53   PROP_VIDEOFPS
  54 };
  55
  56 static void
  57 gst_sub_parse_set_property (GObject * object, guint prop_id,
  58     const GValue * value, GParamSpec * pspec);
  59 static void
  60 gst_sub_parse_get_property (GObject * object, guint prop_id,
  61     GValue * value, GParamSpec * pspec);
  62
  63
  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         "application/x-subtitle-dks; application/x-subtitle-qttext;"
  70         "application/x-subtitle-lrc; application/x-subtitle-vtt")
  71     );
  72
  73 static GstStaticPadTemplate src_templ = GST_STATIC_PAD_TEMPLATE ("src",
  74     GST_PAD_SRC,
  75     GST_PAD_ALWAYS,
  76     GST_STATIC_CAPS ("text/x-raw, format= { pango-markup, utf8 }")
  77     );
  78
  79
  80 static gboolean gst_sub_parse_src_event (GstPad * pad, GstObject * parent,
  81     GstEvent * event);
  82 static gboolean gst_sub_parse_src_query (GstPad * pad, GstObject * parent,
  83     GstQuery * query);
  84 static gboolean gst_sub_parse_sink_event (GstPad * pad, GstObject * parent,
  85     GstEvent * event);
  86
  87 static GstStateChangeReturn gst_sub_parse_change_state (GstElement * element,
  88     GstStateChange transition);
  89
  90 static GstFlowReturn gst_sub_parse_chain (GstPad * sinkpad, GstObject * parent,
  91     GstBuffer * buf);
  92
  93 #define gst_sub_parse_parent_class parent_class
  94 G_DEFINE_TYPE (GstSubParse, gst_sub_parse, GST_TYPE_ELEMENT);
  95
  96 GST_ELEMENT_REGISTER_DEFINE_WITH_CODE (subparse, "subparse",
  97     GST_RANK_PRIMARY, GST_TYPE_SUBPARSE, sub_parse_element_init (plugin))
  98
  99
 100      static void gst_sub_parse_dispose (GObject * object)
 101 {
 102   GstSubParse *subparse = GST_SUBPARSE (object);
 103
 104   GST_DEBUG_OBJECT (subparse, "cleaning up subtitle parser");
 105
 106   if (subparse->encoding) {
 107     g_free (subparse->encoding);
 108     subparse->encoding = NULL;
 109   }
 110
 111   if (subparse->detected_encoding) {
 112     g_free (subparse->detected_encoding);
 113     subparse->detected_encoding = NULL;
 114   }
 115
 116   if (subparse->adapter) {
 117     g_object_unref (subparse->adapter);
 118     subparse->adapter = NULL;
 119   }
 120
 121   if (subparse->textbuf) {
 122     g_string_free (subparse->textbuf, TRUE);
 123     subparse->textbuf = NULL;
 124   }
 125
 126   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 127 }
 128
 129 static void
 130 gst_sub_parse_class_init (GstSubParseClass * klass)
 131 {
 132   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 133   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 134
 135   object_class->dispose = gst_sub_parse_dispose;
 136   object_class->set_property = gst_sub_parse_set_property;
 137   object_class->get_property = gst_sub_parse_get_property;
 138
 139   gst_element_class_add_static_pad_template (element_class, &sink_templ);
 140   gst_element_class_add_static_pad_template (element_class, &src_templ);
 141   gst_element_class_set_static_metadata (element_class,
 142       "Subtitle parser", "Codec/Parser/Subtitle",
 143       "Parses subtitle (.sub) files into text streams",
 144       "Gustavo J. A. M. Carneiro <gjc@inescporto.pt>, "
 145       "GStreamer maintainers <gstreamer-devel@lists.freedesktop.org>");
 146
 147   element_class->change_state = gst_sub_parse_change_state;
 148
 149   g_object_class_install_property (object_class, PROP_ENCODING,
 150       g_param_spec_string ("subtitle-encoding", "subtitle charset encoding",
 151           "Encoding to assume if input subtitles are not in UTF-8 or any other "
 152           "Unicode encoding. If not set, the GST_SUBTITLE_ENCODING environment "
 153           "variable will be checked for an encoding to use. If that is not set "
 154           "either, ISO-8859-15 will be assumed.", DEFAULT_ENCODING,
 155           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 156
 157   g_object_class_install_property (object_class, PROP_VIDEOFPS,
 158       gst_param_spec_fraction ("video-fps", "Video framerate",
 159           "Framerate of the video stream. This is needed by some subtitle "
 160           "formats to synchronize subtitles and video properly. If not set "
 161           "and the subtitle format requires it subtitles may be out of sync.",
 162           0, 1, G_MAXINT, 1, 24000, 1001,
 163           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 164 }
 165
 166 static void
 167 gst_sub_parse_init (GstSubParse * subparse)
 168 {
 169   subparse->sinkpad = gst_pad_new_from_static_template (&sink_templ, "sink");
 170   gst_pad_set_chain_function (subparse->sinkpad,
 171       GST_DEBUG_FUNCPTR (gst_sub_parse_chain));
 172   gst_pad_set_event_function (subparse->sinkpad,
 173       GST_DEBUG_FUNCPTR (gst_sub_parse_sink_event));
 174   gst_element_add_pad (GST_ELEMENT (subparse), subparse->sinkpad);
 175
 176   subparse->srcpad = gst_pad_new_from_static_template (&src_templ, "src");
 177   gst_pad_set_event_function (subparse->srcpad,
 178       GST_DEBUG_FUNCPTR (gst_sub_parse_src_event));
 179   gst_pad_set_query_function (subparse->srcpad,
 180       GST_DEBUG_FUNCPTR (gst_sub_parse_src_query));
 181   gst_element_add_pad (GST_ELEMENT (subparse), subparse->srcpad);
 182
 183   subparse->textbuf = g_string_new (NULL);
 184   subparse->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
 185   subparse->strip_pango_markup = FALSE;
 186   subparse->flushing = FALSE;
 187   gst_segment_init (&subparse->segment, GST_FORMAT_TIME);
 188   subparse->segment_seqnum = gst_util_seqnum_next ();
 189   subparse->need_segment = TRUE;
 190   subparse->encoding = g_strdup (DEFAULT_ENCODING);
 191   subparse->detected_encoding = NULL;
 192   subparse->adapter = gst_adapter_new ();
 193
 194   subparse->fps_n = 24000;
 195   subparse->fps_d = 1001;
 196 }
 197
 198 /*
 199  * Source pad functions.
 200  */
 201
 202 static gboolean
 203 gst_sub_parse_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
 204 {
 205   GstSubParse *self = GST_SUBPARSE (parent);
 206   gboolean ret = FALSE;
 207
 208   GST_DEBUG ("Handling %s query", GST_QUERY_TYPE_NAME (query));
 209
 210   switch (GST_QUERY_TYPE (query)) {
 211     case GST_QUERY_POSITION:{
 212       GstFormat fmt;
 213
 214       gst_query_parse_position (query, &fmt, NULL);
 215       if (fmt != GST_FORMAT_TIME) {
 216         ret = gst_pad_peer_query (self->sinkpad, query);
 217       } else {
 218         ret = TRUE;
 219         gst_query_set_position (query, GST_FORMAT_TIME, self->segment.position);
 220       }
 221       break;
 222     }
 223     case GST_QUERY_SEEKING:
 224     {
 225       GstFormat fmt;
 226       gboolean seekable = FALSE;
 227
 228       ret = TRUE;
 229
 230       gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
 231       if (fmt == GST_FORMAT_TIME) {
 232         GstQuery *peerquery = gst_query_new_seeking (GST_FORMAT_BYTES);
 233
 234         seekable = gst_pad_peer_query (self->sinkpad, peerquery);
 235         if (seekable)
 236           gst_query_parse_seeking (peerquery, NULL, &seekable, NULL, NULL);
 237         gst_query_unref (peerquery);
 238       }
 239
 240       gst_query_set_seeking (query, fmt, seekable, seekable ? 0 : -1, -1);
 241       break;
 242     }
 243     default:
 244       ret = gst_pad_query_default (pad, parent, query);
 245       break;
 246   }
 247
 248   return ret;
 249 }
 250
 251 static gboolean
 252 gst_sub_parse_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
 253 {
 254   GstSubParse *self = GST_SUBPARSE (parent);
 255   gboolean ret = FALSE;
 256
 257   GST_DEBUG ("Handling %s event", GST_EVENT_TYPE_NAME (event));
 258
 259   switch (GST_EVENT_TYPE (event)) {
 260     case GST_EVENT_SEEK:
 261     {
 262       GstFormat format;
 263       GstSeekFlags flags;
 264       GstSeekType start_type, stop_type;
 265       gint64 start, stop;
 266       gdouble rate;
 267       gboolean update;
 268
 269       gst_event_parse_seek (event, &rate, &format, &flags,
 270           &start_type, &start, &stop_type, &stop);
 271
 272       if (format != GST_FORMAT_TIME) {
 273         GST_WARNING_OBJECT (self, "we only support seeking in TIME format");
 274         gst_event_unref (event);
 275         goto beach;
 276       }
 277
 278       /* Convert that seek to a seeking in bytes at position 0,
 279          FIXME: could use an index */
 280       ret = gst_pad_push_event (self->sinkpad,
 281           gst_event_new_seek (rate, GST_FORMAT_BYTES, flags,
 282               GST_SEEK_TYPE_SET, 0, GST_SEEK_TYPE_NONE, 0));
 283
 284       if (ret) {
 285         /* Apply the seek to our segment */
 286         gst_segment_do_seek (&self->segment, rate, format, flags,
 287             start_type, start, stop_type, stop, &update);
 288
 289         GST_DEBUG_OBJECT (self, "segment after seek: %" GST_SEGMENT_FORMAT,
 290             &self->segment);
 291
 292         /* will mark need_segment when receiving segment from upstream,
 293          * after FLUSH and all that has happened,
 294          * rather than racing with chain */
 295       } else {
 296         GST_WARNING_OBJECT (self, "seek to 0 bytes failed");
 297       }
 298
 299       gst_event_unref (event);
 300       break;
 301     }
 302     default:
 303       ret = gst_pad_event_default (pad, parent, event);
 304       break;
 305   }
 306
 307 beach:
 308   return ret;
 309 }
 310
 311 static void
 312 gst_sub_parse_set_property (GObject * object, guint prop_id,
 313     const GValue * value, GParamSpec * pspec)
 314 {
 315   GstSubParse *subparse = GST_SUBPARSE (object);
 316
 317   GST_OBJECT_LOCK (subparse);
 318   switch (prop_id) {
 319     case PROP_ENCODING:
 320       g_free (subparse->encoding);
 321       subparse->encoding = g_value_dup_string (value);
 322       GST_LOG_OBJECT (object, "subtitle encoding set to %s",
 323           GST_STR_NULL (subparse->encoding));
 324       break;
 325     case PROP_VIDEOFPS:
 326     {
 327       subparse->fps_n = gst_value_get_fraction_numerator (value);
 328       subparse->fps_d = gst_value_get_fraction_denominator (value);
 329       GST_DEBUG_OBJECT (object, "video framerate set to %d/%d", subparse->fps_n,
 330           subparse->fps_d);
 331
 332       if (!subparse->state.have_internal_fps) {
 333         subparse->state.fps_n = subparse->fps_n;
 334         subparse->state.fps_d = subparse->fps_d;
 335       }
 336       break;
 337     }
 338     default:
 339       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 340       break;
 341   }
 342   GST_OBJECT_UNLOCK (subparse);
 343 }
 344
 345 static void
 346 gst_sub_parse_get_property (GObject * object, guint prop_id,
 347     GValue * value, GParamSpec * pspec)
 348 {
 349   GstSubParse *subparse = GST_SUBPARSE (object);
 350
 351   GST_OBJECT_LOCK (subparse);
 352   switch (prop_id) {
 353     case PROP_ENCODING:
 354       g_value_set_string (value, subparse->encoding);
 355       break;
 356     case PROP_VIDEOFPS:
 357       gst_value_set_fraction (value, subparse->fps_n, subparse->fps_d);
 358       break;
 359     default:
 360       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 361       break;
 362   }
 363   GST_OBJECT_UNLOCK (subparse);
 364 }
 365
 366 static const gchar *
 367 gst_sub_parse_get_format_description (GstSubParseFormat format)
 368 {
 369   switch (format) {
 370     case GST_SUB_PARSE_FORMAT_MDVDSUB:
 371       return "MicroDVD";
 372     case GST_SUB_PARSE_FORMAT_SUBRIP:
 373       return "SubRip";
 374     case GST_SUB_PARSE_FORMAT_MPSUB:
 375       return "MPSub";
 376     case GST_SUB_PARSE_FORMAT_SAMI:
 377       return "SAMI";
 378     case GST_SUB_PARSE_FORMAT_TMPLAYER:
 379       return "TMPlayer";
 380     case GST_SUB_PARSE_FORMAT_MPL2:
 381       return "MPL2";
 382     case GST_SUB_PARSE_FORMAT_SUBVIEWER:
 383       return "SubViewer";
 384     case GST_SUB_PARSE_FORMAT_DKS:
 385       return "DKS";
 386     case GST_SUB_PARSE_FORMAT_VTT:
 387       return "WebVTT";
 388     case GST_SUB_PARSE_FORMAT_QTTEXT:
 389       return "QTtext";
 390     case GST_SUB_PARSE_FORMAT_LRC:
 391       return "LRC";
 392     default:
 393     case GST_SUB_PARSE_FORMAT_UNKNOWN:
 394       break;
 395   }
 396   return NULL;
 397 }
 398
 399
 400
 401
 402
 403 static gchar *
 404 convert_encoding (GstSubParse * self, const gchar * str, gsize len,
 405     gsize * consumed)
 406 {
 407   const gchar *encoding;
 408   GError *err = NULL;
 409   gchar *ret = NULL;
 410
 411   *consumed = 0;
 412
 413   /* First try any detected encoding */
 414   if (self->detected_encoding) {
 415     ret =
 416         gst_sub_parse_gst_convert_to_utf8 (str, len, self->detected_encoding,
 417         consumed, &err);
 418
 419     if (!err)
 420       return ret;
 421
 422     GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
 423         self->detected_encoding, err->message);
 424     g_free (self->detected_encoding);
 425     self->detected_encoding = NULL;
 426     g_clear_error (&err);
 427   }
 428
 429   /* Otherwise check if it's UTF8 */
 430   if (self->valid_utf8) {
 431     if (g_utf8_validate (str, len, NULL)) {
 432       GST_LOG_OBJECT (self, "valid UTF-8, no conversion needed");
 433       *consumed = len;
 434       return g_strndup (str, len);
 435     }
 436     GST_INFO_OBJECT (self, "invalid UTF-8!");
 437     self->valid_utf8 = FALSE;
 438   }
 439
 440   /* Else try fallback */
 441   encoding = self->encoding;
 442   if (encoding == NULL || *encoding == '\0') {
 443     encoding = g_getenv ("GST_SUBTITLE_ENCODING");
 444   }
 445   if (encoding == NULL || *encoding == '\0') {
 446     /* if local encoding is UTF-8 and no encoding specified
 447      * via the environment variable, assume ISO-8859-15 */
 448     if (g_get_charset (&encoding)) {
 449       encoding = "ISO-8859-15";
 450     }
 451   }
 452
 453   ret = gst_sub_parse_gst_convert_to_utf8 (str, len, encoding, consumed, &err);
 454
 455   if (err) {
 456     GST_WARNING_OBJECT (self, "could not convert string from '%s' to UTF-8: %s",
 457         encoding, err->message);
 458     g_clear_error (&err);
 459
 460     /* invalid input encoding, fall back to ISO-8859-15 (always succeeds) */
 461     ret =
 462         gst_sub_parse_gst_convert_to_utf8 (str, len, "ISO-8859-15", consumed,
 463         NULL);
 464   }
 465
 466   GST_LOG_OBJECT (self,
 467       "successfully converted %" G_GSIZE_FORMAT " characters from %s to UTF-8"
 468       "%s", len, encoding, (err) ? " , using ISO-8859-15 as fallback" : "");
 469
 470   return ret;
 471 }
 472
 473 static gchar *
 474 get_next_line (GstSubParse * self)
 475 {
 476   char *line = NULL;
 477   const char *line_end;
 478   int line_len;
 479   gboolean have_r = FALSE;
 480
 481   line_end = strchr (self->textbuf->str, '\n');
 482
 483   if (!line_end) {
 484     /* end-of-line not found; return for more data */
 485     return NULL;
 486   }
 487
 488   /* get rid of '\r' */
 489   if (line_end != self->textbuf->str && *(line_end - 1) == '\r') {
 490     line_end--;
 491     have_r = TRUE;
 492   }
 493
 494   line_len = line_end - self->textbuf->str;
 495   line = g_strndup (self->textbuf->str, line_len);
 496   self->textbuf = g_string_erase (self->textbuf, 0,
 497       line_len + (have_r ? 2 : 1));
 498   return line;
 499 }
 500
 501 static gchar *
 502 parse_mdvdsub (ParserState * state, const gchar * line)
 503 {
 504   const gchar *line_split;
 505   gchar *line_chunk;
 506   guint start_frame, end_frame;
 507   guint64 clip_start = 0, clip_stop = 0;
 508   gboolean in_seg = FALSE;
 509   GString *markup;
 510   gchar *ret;
 511
 512   /* style variables */
 513   gboolean italic;
 514   gboolean bold;
 515   guint fontsize;
 516   gdouble fps = 0.0;
 517
 518   if (sscanf (line, "{%u}{%u}", &start_frame, &end_frame) != 2) {
 519     GST_WARNING ("Parsing of the following line, assumed to be in microdvd .sub"
 520         " format, failed:\n%s", line);
 521     return NULL;
 522   }
 523
 524   /* skip the {%u}{%u} part */
 525   line = strchr (line, '}') + 1;
 526   line = strchr (line, '}') + 1;
 527
 528   /* see if there's a first line with a framerate */
 529   if (start_frame == 1 && end_frame == 1) {
 530     gchar *rest, *end = NULL;
 531
 532     rest = g_strdup (line);
 533     g_strdelimit (rest, ",", '.');
 534     fps = g_ascii_strtod (rest, &end);
 535     if (end != rest) {
 536       gst_util_double_to_fraction (fps, &state->fps_n, &state->fps_d);
 537       GST_INFO ("framerate from file: %d/%d ('%s')", state->fps_n,
 538           state->fps_d, rest);
 539     }
 540     g_free (rest);
 541     return NULL;
 542   }
 543
 544   state->start_time =
 545       gst_util_uint64_scale (start_frame, GST_SECOND * state->fps_d,
 546       state->fps_n);
 547   state->duration =
 548       gst_util_uint64_scale (end_frame - start_frame, GST_SECOND * state->fps_d,
 549       state->fps_n);
 550
 551   /* Check our segment start/stop */
 552   in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
 553       state->start_time, state->start_time + state->duration, &clip_start,
 554       &clip_stop);
 555
 556   /* No need to parse that text if it's out of segment */
 557   if (in_seg) {
 558     state->start_time = clip_start;
 559     state->duration = clip_stop - clip_start;
 560   } else {
 561     return NULL;
 562   }
 563
 564   markup = g_string_new (NULL);
 565   while (1) {
 566     italic = FALSE;
 567     bold = FALSE;
 568     fontsize = 0;
 569     /* parse style markup */
 570     if (strncmp (line, "{y:i}", 5) == 0) {
 571       italic = TRUE;
 572       line = strchr (line, '}') + 1;
 573     }
 574     if (strncmp (line, "{y:b}", 5) == 0) {
 575       bold = TRUE;
 576       line = strchr (line, '}') + 1;
 577     }
 578     if (sscanf (line, "{s:%u}", &fontsize) == 1) {
 579       line = strchr (line, '}') + 1;
 580     }
 581     /* forward slashes at beginning/end signify italics too */
 582     if (g_str_has_prefix (line, "/")) {
 583       italic = TRUE;
 584       ++line;
 585     }
 586     if ((line_split = strchr (line, '|')))
 587       line_chunk = g_markup_escape_text (line, line_split - line);
 588     else
 589       line_chunk = g_markup_escape_text (line, strlen (line));
 590
 591     /* Remove italics markers at end of line/stanza (CHECKME: are end slashes
 592      * always at the end of a line or can they span multiple lines?) */
 593     if (g_str_has_suffix (line_chunk, "/")) {
 594       line_chunk[strlen (line_chunk) - 1] = '\0';
 595     }
 596
 597     markup = g_string_append (markup, "<span");
 598     if (italic)
 599       g_string_append (markup, " style=\"italic\"");
 600     if (bold)
 601       g_string_append (markup, " weight=\"bold\"");
 602     if (fontsize)
 603       g_string_append_printf (markup, " size=\"%u\"", fontsize * 1000);
 604     g_string_append_printf (markup, ">%s</span>", line_chunk);
 605     g_free (line_chunk);
 606     if (line_split) {
 607       g_string_append (markup, "\n");
 608       line = line_split + 1;
 609     } else {
 610       break;
 611     }
 612   }
 613   ret = markup->str;
 614   g_string_free (markup, FALSE);
 615   GST_DEBUG ("parse_mdvdsub returning (%f+%f): %s",
 616       state->start_time / (double) GST_SECOND,
 617       state->duration / (double) GST_SECOND, ret);
 618   return ret;
 619 }
 620
 621 static void
 622 strip_trailing_newlines (gchar * txt)
 623 {
 624   if (txt) {
 625     guint len;
 626
 627     len = strlen (txt);
 628     while (len > 1 && txt[len - 1] == '\n') {
 629       txt[len - 1] = '\0';
 630       --len;
 631     }
 632   }
 633 }
 634
 635 /* we want to escape text in general, but retain basic markup like
 636  * <i></i>, <u></u>, and <b></b>. The easiest and safest way is to
 637  * just unescape a white list of allowed markups again after
 638  * escaping everything (the text between these simple markers isn't
 639  * necessarily escaped, so it seems best to do it like this) */
 640 static void
 641 subrip_unescape_formatting (gchar * txt, gconstpointer allowed_tags_ptr,
 642     gboolean allows_tag_attributes)
 643 {
 644   gchar *res;
 645   GRegex *tag_regex;
 646   gchar *allowed_tags_pattern, *search_pattern;
 647   const gchar *replace_pattern;
 648
 649   /* No processing needed if no escaped tag marker found in the string. */
 650   if (strstr (txt, "&lt;") == NULL)
 651     return;
 652
 653   /* Build a list of alternates for our regexp.
 654    * FIXME: Could be built once and stored */
 655   allowed_tags_pattern = g_strjoinv ("|", (gchar **) allowed_tags_ptr);
 656   /* Look for starting/ending escaped tags with optional attributes. */
 657   search_pattern = g_strdup_printf ("&lt;(/)?\\ *(%s)(%s)&gt;",
 658       allowed_tags_pattern, ATTRIBUTE_REGEX);
 659   /* And unescape appropriately */
 660   if (allows_tag_attributes) {
 661     replace_pattern = "<\\1\\2\\3>";
 662   } else {
 663     replace_pattern = "<\\1\\2>";
 664   }
 665
 666   tag_regex = g_regex_new (search_pattern, 0, 0, NULL);
 667   res = g_regex_replace (tag_regex, txt, strlen (txt), 0,
 668       replace_pattern, 0, NULL);
 669
 670   /* res will always be shorter than the input or identical, so this
 671    * copy is OK */
 672   strcpy (txt, res);
 673
 674   g_free (res);
 675   g_free (search_pattern);
 676   g_free (allowed_tags_pattern);
 677
 678   g_regex_unref (tag_regex);
 679 }
 680
 681
 682 static gboolean
 683 subrip_remove_unhandled_tag (gchar * start, gchar * stop)
 684 {
 685   gchar *tag, saved;
 686
 687   tag = start + strlen ("&lt;");
 688   if (*tag == '/')
 689     ++tag;
 690
 691   if (g_ascii_tolower (*tag) < 'a' || g_ascii_tolower (*tag) > 'z')
 692     return FALSE;
 693
 694   saved = *stop;
 695   *stop = '\0';
 696   GST_LOG ("removing unhandled tag '%s'", start);
 697   *stop = saved;
 698   memmove (start, stop, strlen (stop) + 1);
 699   return TRUE;
 700 }
 701
 702 /* remove tags we haven't explicitly allowed earlier on, like font tags
 703  * for example */
 704 static void
 705 subrip_remove_unhandled_tags (gchar * txt)
 706 {
 707   gchar *pos, *gt;
 708
 709   for (pos = txt; pos != NULL && *pos != '\0'; ++pos) {
 710     if (strncmp (pos, "&lt;", 4) == 0 && (gt = strstr (pos + 4, "&gt;"))) {
 711       if (subrip_remove_unhandled_tag (pos, gt + strlen ("&gt;")))
 712         --pos;
 713     }
 714   }
 715 }
 716
 717 /* we only allow a fixed set of tags like <i>, <u> and <b>, so let's
 718  * take a simple approach. This code assumes the input has been
 719  * escaped and subrip_unescape_formatting() has then been run over the
 720  * input! This function adds missing closing markup tags and removes
 721  * broken closing tags for tags that have never been opened. */
 722 static void
 723 subrip_fix_up_markup (gchar ** p_txt, gconstpointer allowed_tags_ptr)
 724 {
 725   gchar *cur, *next_tag;
 726   GPtrArray *open_tags = NULL;
 727   guint num_open_tags = 0;
 728   const gchar *iter_tag;
 729   guint offset = 0;
 730   guint index;
 731   gchar *cur_tag;
 732   gchar *end_tag;
 733   GRegex *tag_regex;
 734   GMatchInfo *match_info;
 735   gchar **allowed_tags = (gchar **) allowed_tags_ptr;
 736
 737   g_assert (*p_txt != NULL);
 738
 739   open_tags = g_ptr_array_new_with_free_func (g_free);
 740   cur = *p_txt;
 741   while (*cur != '\0') {
 742     next_tag = strchr (cur, '<');
 743     if (next_tag == NULL)
 744       break;
 745     offset = 0;
 746     index = 0;
 747     while (index < g_strv_length (allowed_tags)) {
 748       iter_tag = allowed_tags[index];
 749       /* Look for a white listed tag */
 750       cur_tag = g_strconcat ("<", iter_tag, ATTRIBUTE_REGEX, ">", NULL);
 751       tag_regex = g_regex_new (cur_tag, 0, 0, NULL);
 752       (void) g_regex_match (tag_regex, next_tag, 0, &match_info);
 753
 754       if (g_match_info_matches (match_info)) {
 755         gint start_pos, end_pos;
 756         gchar *word = g_match_info_fetch (match_info, 0);
 757         g_match_info_fetch_pos (match_info, 0, &start_pos, &end_pos);
 758         if (start_pos == 0) {
 759           offset = strlen (word);
 760         }
 761         g_free (word);
 762       }
 763       g_match_info_free (match_info);
 764       g_regex_unref (tag_regex);
 765       g_free (cur_tag);
 766       index++;
 767       if (offset) {
 768         /* OK we found a tag, let's keep track of it */
 769         g_ptr_array_add (open_tags, g_ascii_strdown (iter_tag, -1));
 770         ++num_open_tags;
 771         break;
 772       }
 773     }
 774
 775     if (offset) {
 776       next_tag += offset;
 777       cur = next_tag;
 778       continue;
 779     }
 780
 781     if (*next_tag == '<' && *(next_tag + 1) == '/') {
 782       end_tag = strchr (next_tag, '>');
 783       if (end_tag) {
 784         const gchar *last = NULL;
 785         if (num_open_tags > 0)
 786           last = g_ptr_array_index (open_tags, num_open_tags - 1);
 787         if (num_open_tags == 0
 788             || g_ascii_strncasecmp (end_tag - 1, last, strlen (last))) {
 789           GST_LOG ("broken input, closing tag '%s' is not open", next_tag);
 790           /* Move everything after the tag end, including closing \0 */
 791           memmove (next_tag, end_tag + 1, strlen (end_tag));
 792           cur = next_tag;
 793           continue;
 794         } else {
 795           --num_open_tags;
 796           g_ptr_array_remove_index (open_tags, num_open_tags);
 797         }
 798       }
 799     }
 800     ++next_tag;
 801     cur = next_tag;
 802   }
 803
 804   if (num_open_tags > 0) {
 805     GString *s;
 806
 807     s = g_string_new (*p_txt);
 808     while (num_open_tags > 0) {
 809       GST_LOG ("adding missing closing tag '%s'",
 810           (char *) g_ptr_array_index (open_tags, num_open_tags - 1));
 811       g_string_append_c (s, '<');
 812       g_string_append_c (s, '/');
 813       g_string_append (s, g_ptr_array_index (open_tags, num_open_tags - 1));
 814       g_string_append_c (s, '>');
 815       --num_open_tags;
 816     }
 817     g_free (*p_txt);
 818     *p_txt = g_string_free (s, FALSE);
 819   }
 820   g_ptr_array_free (open_tags, TRUE);
 821 }
 822
 823 static gboolean
 824 parse_subrip_time (const gchar * ts_string, GstClockTime * t)
 825 {
 826   gchar s[128] = { '\0', };
 827   gchar *end, *p;
 828   guint hour, min, sec, msec, len;
 829
 830   while (*ts_string == ' ')
 831     ++ts_string;
 832
 833   g_strlcpy (s, ts_string, sizeof (s));
 834   if ((end = strstr (s, "-->")))
 835     *end = '\0';
 836   g_strchomp (s);
 837
 838   /* ms may be in these formats:
 839    * hh:mm:ss,500 = 500ms
 840    * hh:mm:ss,  5 =   5ms
 841    * hh:mm:ss, 5  =  50ms
 842    * hh:mm:ss, 50 =  50ms
 843    * hh:mm:ss,5   = 500ms
 844    * and the same with . instead of ,.
 845    * sscanf() doesn't differentiate between '  5' and '5' so munge
 846    * the white spaces within the timestamp to '0' (I'm sure there's a
 847    * way to make sscanf() do this for us, but how?)
 848    */
 849   g_strdelimit (s, " ", '0');
 850   g_strdelimit (s, ".", ',');
 851
 852   /* make sure we have exactly three digits after he comma */
 853   p = strchr (s, ',');
 854   if (p == NULL) {
 855     /* If there isn't a ',' the timestamp is broken */
 856     /* https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/issues/532#note_100179 */
 857     GST_WARNING ("failed to parse subrip timestamp string '%s'", s);
 858     return FALSE;
 859   }
 860
 861   ++p;
 862   len = strlen (p);
 863   if (len > 3) {
 864     p[3] = '\0';
 865   } else
 866     while (len < 3) {
 867       g_strlcat (&p[len], "0", 2);
 868       ++len;
 869     }
 870
 871   GST_LOG ("parsing timestamp '%s'", s);
 872   if (sscanf (s, "%u:%u:%u,%u", &hour, &min, &sec, &msec) != 4) {
 873     /* https://www.w3.org/TR/webvtt1/#webvtt-timestamp
 874      *
 875      * The hours component is optional with webVTT, for example
 876      * mm:ss,500 is a valid webVTT timestamp. When not present,
 877      * hours is 0.
 878      */
 879     hour = 0;
 880
 881     if (sscanf (s, "%u:%u,%u", &min, &sec, &msec) != 3) {
 882       GST_WARNING ("failed to parse subrip timestamp string '%s'", s);
 883       return FALSE;
 884     }
 885   }
 886
 887   *t = ((hour * 3600) + (min * 60) + sec) * GST_SECOND + msec * GST_MSECOND;
 888   return TRUE;
 889 }
 890
 891 /* cue settings are part of the WebVTT specification. They are
 892  * declared after the time interval in the first line of the
 893  * cue. Example: 00:00:01,000 --> 00:00:02,000 D:vertical-lr A:start
 894  * See also http://www.whatwg.org/specs/web-apps/current-work/webvtt.html
 895  */
 896 static void
 897 parse_webvtt_cue_settings (ParserState * state, const gchar * settings)
 898 {
 899   gchar **splitted_settings = g_strsplit_set (settings, " \t", -1);
 900   gint i = 0;
 901   gint16 text_position, text_size;
 902   gint16 line_position;
 903   gboolean vertical_found = FALSE;
 904   gboolean alignment_found = FALSE;
 905
 906   while (i < g_strv_length (splitted_settings)) {
 907     gboolean valid_tag = FALSE;
 908     switch (splitted_settings[i][0]) {
 909       case 'T':
 910         if (sscanf (splitted_settings[i], "T:%" G_GINT16_FORMAT "%%",
 911                 &text_position) > 0) {
 912           state->text_position = (guint8) text_position;
 913           valid_tag = TRUE;
 914         }
 915         break;
 916       case 'D':
 917         if (strlen (splitted_settings[i]) > 2) {
 918           vertical_found = TRUE;
 919           g_free (state->vertical);
 920           state->vertical = g_strdup (splitted_settings[i] + 2);
 921           valid_tag = TRUE;
 922         }
 923         break;
 924       case 'L':
 925         if (g_str_has_suffix (splitted_settings[i], "%")) {
 926           if (sscanf (splitted_settings[i], "L:%" G_GINT16_FORMAT "%%",
 927                   &line_position) > 0) {
 928             state->line_position = line_position;
 929             valid_tag = TRUE;
 930           }
 931         } else {
 932           if (sscanf (splitted_settings[i], "L:%" G_GINT16_FORMAT,
 933                   &line_position) > 0) {
 934             state->line_number = line_position;
 935             valid_tag = TRUE;
 936           }
 937         }
 938         break;
 939       case 'S':
 940         if (sscanf (splitted_settings[i], "S:%" G_GINT16_FORMAT "%%",
 941                 &text_size) > 0) {
 942           state->text_size = (guint8) text_size;
 943           valid_tag = TRUE;
 944         }
 945         break;
 946       case 'A':
 947         if (strlen (splitted_settings[i]) > 2) {
 948           g_free (state->alignment);
 949           state->alignment = g_strdup (splitted_settings[i] + 2);
 950           alignment_found = TRUE;
 951           valid_tag = TRUE;
 952         }
 953         break;
 954       default:
 955         break;
 956     }
 957     if (!valid_tag) {
 958       GST_LOG ("Invalid or unrecognised setting found: %s",
 959           splitted_settings[i]);
 960     }
 961     i++;
 962   }
 963   g_strfreev (splitted_settings);
 964   if (!vertical_found) {
 965     g_free (state->vertical);
 966     state->vertical = g_strdup ("");
 967   }
 968   if (!alignment_found) {
 969     g_free (state->alignment);
 970     state->alignment = g_strdup ("");
 971   }
 972 }
 973
 974 static gchar *
 975 parse_subrip (ParserState * state, const gchar * line)
 976 {
 977   gchar *ret;
 978
 979   switch (state->state) {
 980     case 0:{
 981       char *endptr;
 982       guint64 id;
 983
 984       /* looking for a single integer as a Cue ID, but we
 985        * don't actually use it */
 986       errno = 0;
 987       id = g_ascii_strtoull (line, &endptr, 10);
 988       if (id == G_MAXUINT64 && errno == ERANGE)
 989         state->state = 1;
 990       else if (id == 0 && errno == EINVAL)
 991         state->state = 1;
 992       else if (endptr != line && *endptr == '\0')
 993         state->state = 1;
 994       return NULL;
 995     }
 996     case 1:
 997     {
 998       GstClockTime ts_start, ts_end;
 999       gchar *end_time;
1000
1001       /* looking for start_time --> end_time */
1002       if ((end_time = strstr (line, " --> ")) &&
1003           parse_subrip_time (line, &ts_start) &&
1004           parse_subrip_time (end_time + strlen (" --> "), &ts_end) &&
1005           state->start_time <= ts_end) {
1006         state->state = 2;
1007         state->start_time = ts_start;
1008         state->duration = ts_end - ts_start;
1009       } else {
1010         GST_DEBUG ("error parsing subrip time line '%s'", line);
1011         state->state = 0;
1012       }
1013       return NULL;
1014     }
1015     case 2:
1016     {
1017       /* No need to parse that text if it's out of segment */
1018       guint64 clip_start = 0, clip_stop = 0;
1019       gboolean in_seg = FALSE;
1020
1021       /* Check our segment start/stop */
1022       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1023           state->start_time, state->start_time + state->duration,
1024           &clip_start, &clip_stop);
1025
1026       if (in_seg) {
1027         state->start_time = clip_start;
1028         state->duration = clip_stop - clip_start;
1029       } else {
1030         state->state = 0;
1031         return NULL;
1032       }
1033     }
1034       /* looking for subtitle text; empty line ends this subtitle entry */
1035       if (state->buf->len)
1036         g_string_append_c (state->buf, '\n');
1037       g_string_append (state->buf, line);
1038       if (strlen (line) == 0) {
1039         ret = g_markup_escape_text (state->buf->str, state->buf->len);
1040         g_string_truncate (state->buf, 0);
1041         state->state = 0;
1042         subrip_unescape_formatting (ret, state->allowed_tags,
1043             state->allows_tag_attributes);
1044         subrip_remove_unhandled_tags (ret);
1045         strip_trailing_newlines (ret);
1046         subrip_fix_up_markup (&ret, state->allowed_tags);
1047         return ret;
1048       }
1049       return NULL;
1050     default:
1051       g_return_val_if_reached (NULL);
1052   }
1053 }
1054
1055 static gchar *
1056 parse_lrc (ParserState * state, const gchar * line)
1057 {
1058   gint m, s, c;
1059   const gchar *start;
1060   gint milli;
1061
1062   if (line[0] != '[')
1063     return NULL;
1064
1065   if (sscanf (line, "[%u:%02u.%03u]", &m, &s, &c) != 3 &&
1066       sscanf (line, "[%u:%02u.%02u]", &m, &s, &c) != 3)
1067     return NULL;
1068
1069   start = strchr (line, ']');
1070   if (start - line == 9)
1071     milli = 10;
1072   else
1073     milli = 1;
1074
1075   state->start_time = gst_util_uint64_scale (m, 60 * GST_SECOND, 1)
1076       + gst_util_uint64_scale (s, GST_SECOND, 1)
1077       + gst_util_uint64_scale (c, milli * GST_MSECOND, 1);
1078   state->duration = GST_CLOCK_TIME_NONE;
1079
1080   return g_strdup (start + 1);
1081 }
1082
1083 /* WebVTT is a new subtitle format for the upcoming HTML5 video track
1084  * element. This format is similar to Subrip, the biggest differences
1085  * are that there can be cue settings detailing how to display the cue
1086  * text and more markup tags are allowed.
1087  * See also http://www.whatwg.org/specs/web-apps/current-work/webvtt.html
1088  */
1089 static gchar *
1090 parse_webvtt (ParserState * state, const gchar * line)
1091 {
1092   /* Cue IDs are optional in WebVTT, but not in subrip,
1093    * so when in state 0 (cue ID), also check if we're
1094    * already at the start --> end time marker */
1095   if (state->state == 0 || state->state == 1) {
1096     GstClockTime ts_start, ts_end;
1097     gchar *end_time;
1098     gchar *cue_settings = NULL;
1099
1100     /* looking for start_time --> end_time */
1101     if ((end_time = strstr (line, " --> ")) &&
1102         parse_subrip_time (line, &ts_start) &&
1103         parse_subrip_time (end_time + strlen (" --> "), &ts_end) &&
1104         state->start_time <= ts_end) {
1105       state->state = 2;
1106       state->start_time = ts_start;
1107       state->duration = ts_end - ts_start;
1108       cue_settings = strstr (end_time + strlen (" --> "), " ");
1109     } else {
1110       GST_DEBUG ("error parsing subrip time line '%s'", line);
1111       state->state = 0;
1112     }
1113
1114     state->text_position = 0;
1115     state->text_size = 0;
1116     state->line_position = 0;
1117     state->line_number = 0;
1118
1119     if (cue_settings)
1120       parse_webvtt_cue_settings (state, cue_settings + 1);
1121     else {
1122       g_free (state->vertical);
1123       state->vertical = g_strdup ("");
1124       g_free (state->alignment);
1125       state->alignment = g_strdup ("");
1126     }
1127
1128     return NULL;
1129   } else
1130     return parse_subrip (state, line);
1131 }
1132
1133 static void
1134 unescape_newlines_br (gchar * read)
1135 {
1136   gchar *write = read;
1137
1138   /* Replace all occurrences of '[br]' with a newline as version 2
1139    * of the subviewer format uses this for newlines */
1140
1141   if (read[0] == '\0' || read[1] == '\0' || read[2] == '\0' || read[3] == '\0')
1142     return;
1143
1144   do {
1145     if (strncmp (read, "[br]", 4) == 0) {
1146       *write = '\n';
1147       read += 4;
1148     } else {
1149       *write = *read;
1150       read++;
1151     }
1152     write++;
1153   } while (*read);
1154
1155   *write = '\0';
1156 }
1157
1158 static gchar *
1159 parse_subviewer (ParserState * state, const gchar * line)
1160 {
1161   guint h1, m1, s1, ms1;
1162   guint h2, m2, s2, ms2;
1163   gchar *ret;
1164
1165   /* TODO: Maybe also parse the fields in the header, especially DELAY.
1166    * For examples see the unit test or
1167    * http://www.doom9.org/index.html?/sub.htm */
1168
1169   switch (state->state) {
1170     case 0:
1171       /* looking for start_time,end_time */
1172       if (sscanf (line, "%u:%u:%u.%u,%u:%u:%u.%u",
1173               &h1, &m1, &s1, &ms1, &h2, &m2, &s2, &ms2) == 8) {
1174         state->state = 1;
1175         state->start_time =
1176             (((guint64) h1) * 3600 + m1 * 60 + s1) * GST_SECOND +
1177             ms1 * GST_MSECOND;
1178         state->duration =
1179             (((guint64) h2) * 3600 + m2 * 60 + s2) * GST_SECOND +
1180             ms2 * GST_MSECOND - state->start_time;
1181       }
1182       return NULL;
1183     case 1:
1184     {
1185       /* No need to parse that text if it's out of segment */
1186       guint64 clip_start = 0, clip_stop = 0;
1187       gboolean in_seg = FALSE;
1188
1189       /* Check our segment start/stop */
1190       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1191           state->start_time, state->start_time + state->duration,
1192           &clip_start, &clip_stop);
1193
1194       if (in_seg) {
1195         state->start_time = clip_start;
1196         state->duration = clip_stop - clip_start;
1197       } else {
1198         state->state = 0;
1199         return NULL;
1200       }
1201     }
1202       /* looking for subtitle text; empty line ends this subtitle entry */
1203       if (state->buf->len)
1204         g_string_append_c (state->buf, '\n');
1205       g_string_append (state->buf, line);
1206       if (strlen (line) == 0) {
1207         ret = g_strdup (state->buf->str);
1208         unescape_newlines_br (ret);
1209         strip_trailing_newlines (ret);
1210         g_string_truncate (state->buf, 0);
1211         state->state = 0;
1212         return ret;
1213       }
1214       return NULL;
1215     default:
1216       g_assert_not_reached ();
1217       return NULL;
1218   }
1219 }
1220
1221 static gchar *
1222 parse_mpsub (ParserState * state, const gchar * line)
1223 {
1224   gchar *ret;
1225   float t1, t2;
1226
1227   switch (state->state) {
1228     case 0:
1229       /* looking for two floats (offset, duration) */
1230       if (sscanf (line, "%f %f", &t1, &t2) == 2) {
1231         state->state = 1;
1232         state->start_time += state->duration + GST_SECOND * t1;
1233         state->duration = GST_SECOND * t2;
1234       }
1235       return NULL;
1236     case 1:
1237     {                           /* No need to parse that text if it's out of segment */
1238       guint64 clip_start = 0, clip_stop = 0;
1239       gboolean in_seg = FALSE;
1240
1241       /* Check our segment start/stop */
1242       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1243           state->start_time, state->start_time + state->duration,
1244           &clip_start, &clip_stop);
1245
1246       if (in_seg) {
1247         state->start_time = clip_start;
1248         state->duration = clip_stop - clip_start;
1249       } else {
1250         state->state = 0;
1251         return NULL;
1252       }
1253     }
1254       /* looking for subtitle text; empty line ends this
1255        * subtitle entry */
1256       if (state->buf->len)
1257         g_string_append_c (state->buf, '\n');
1258       g_string_append (state->buf, line);
1259       if (strlen (line) == 0) {
1260         ret = g_strdup (state->buf->str);
1261         g_string_truncate (state->buf, 0);
1262         state->state = 0;
1263         return ret;
1264       }
1265       return NULL;
1266     default:
1267       g_assert_not_reached ();
1268       return NULL;
1269   }
1270 }
1271
1272 static const gchar *
1273 dks_skip_timestamp (const gchar * line)
1274 {
1275   while (*line && *line != ']')
1276     line++;
1277   if (*line == ']')
1278     line++;
1279   return line;
1280 }
1281
1282 static gchar *
1283 parse_dks (ParserState * state, const gchar * line)
1284 {
1285   guint h, m, s;
1286
1287   switch (state->state) {
1288     case 0:
1289       /* Looking for the start time and text */
1290       if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1291         const gchar *text;
1292         state->start_time = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND;
1293         text = dks_skip_timestamp (line);
1294         if (*text) {
1295           state->state = 1;
1296           g_string_append (state->buf, text);
1297         }
1298       }
1299       return NULL;
1300     case 1:
1301     {
1302       guint64 clip_start = 0, clip_stop = 0;
1303       gboolean in_seg;
1304       gchar *ret;
1305
1306       /* Looking for the end time */
1307       if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1308         state->state = 0;
1309         state->duration = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND -
1310             state->start_time;
1311       } else {
1312         GST_WARNING ("Failed to parse subtitle end time");
1313         return NULL;
1314       }
1315
1316       /* Check if this subtitle is out of the current segment */
1317       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1318           state->start_time, state->start_time + state->duration,
1319           &clip_start, &clip_stop);
1320
1321       if (!in_seg) {
1322         return NULL;
1323       }
1324
1325       state->start_time = clip_start;
1326       state->duration = clip_stop - clip_start;
1327
1328       ret = g_strdup (state->buf->str);
1329       g_string_truncate (state->buf, 0);
1330       unescape_newlines_br (ret);
1331       return ret;
1332     }
1333     default:
1334       g_assert_not_reached ();
1335       return NULL;
1336   }
1337 }
1338
1339 static void
1340 parser_state_init (ParserState * state)
1341 {
1342   GST_DEBUG ("initialising parser");
1343
1344   if (state->buf) {
1345     g_string_truncate (state->buf, 0);
1346   } else {
1347     state->buf = g_string_new (NULL);
1348   }
1349
1350   state->start_time = 0;
1351   state->duration = 0;
1352   state->max_duration = 0;      /* no limit */
1353   state->state = 0;
1354   state->segment = NULL;
1355 }
1356
1357 static void
1358 parser_state_dispose (GstSubParse * self, ParserState * state)
1359 {
1360   if (state->buf) {
1361     g_string_free (state->buf, TRUE);
1362     state->buf = NULL;
1363   }
1364
1365   g_free (state->vertical);
1366   state->vertical = NULL;
1367   g_free (state->alignment);
1368   state->alignment = NULL;
1369
1370   if (state->user_data) {
1371     switch (self->parser_type) {
1372       case GST_SUB_PARSE_FORMAT_QTTEXT:
1373         qttext_context_deinit (state);
1374         break;
1375       case GST_SUB_PARSE_FORMAT_SAMI:
1376         sami_context_deinit (state);
1377         break;
1378       default:
1379         break;
1380     }
1381   }
1382   state->allowed_tags = NULL;
1383 }
1384
1385
1386
1387 static GstCaps *
1388 gst_sub_parse_format_autodetect (GstSubParse * self)
1389 {
1390   gchar *data;
1391   GstSubParseFormat format;
1392
1393   if (strlen (self->textbuf->str) < 6) {
1394     GST_DEBUG ("File too small to be a subtitles file");
1395     return NULL;
1396   }
1397
1398   data = g_strndup (self->textbuf->str, 35);
1399   format = gst_sub_parse_data_format_autodetect (data);
1400   g_free (data);
1401
1402   self->parser_type = format;
1403   self->subtitle_codec = gst_sub_parse_get_format_description (format);
1404   parser_state_init (&self->state);
1405   self->state.allowed_tags = NULL;
1406
1407   switch (format) {
1408     case GST_SUB_PARSE_FORMAT_MDVDSUB:
1409       self->parse_line = parse_mdvdsub;
1410       return gst_caps_new_simple ("text/x-raw",
1411           "format", G_TYPE_STRING, "pango-markup", NULL);
1412     case GST_SUB_PARSE_FORMAT_SUBRIP:
1413       self->state.allowed_tags = (gpointer) allowed_srt_tags;
1414       self->state.allows_tag_attributes = FALSE;
1415       self->parse_line = parse_subrip;
1416       return gst_caps_new_simple ("text/x-raw",
1417           "format", G_TYPE_STRING, "pango-markup", NULL);
1418     case GST_SUB_PARSE_FORMAT_MPSUB:
1419       self->parse_line = parse_mpsub;
1420       return gst_caps_new_simple ("text/x-raw",
1421           "format", G_TYPE_STRING, "utf8", NULL);
1422     case GST_SUB_PARSE_FORMAT_SAMI:
1423       self->parse_line = parse_sami;
1424       sami_context_init (&self->state);
1425       return gst_caps_new_simple ("text/x-raw",
1426           "format", G_TYPE_STRING, "pango-markup", NULL);
1427     case GST_SUB_PARSE_FORMAT_TMPLAYER:
1428       self->parse_line = parse_tmplayer;
1429       self->state.max_duration = 5 * GST_SECOND;
1430       return gst_caps_new_simple ("text/x-raw",
1431           "format", G_TYPE_STRING, "utf8", NULL);
1432     case GST_SUB_PARSE_FORMAT_MPL2:
1433       self->parse_line = parse_mpl2;
1434       return gst_caps_new_simple ("text/x-raw",
1435           "format", G_TYPE_STRING, "pango-markup", NULL);
1436     case GST_SUB_PARSE_FORMAT_DKS:
1437       self->parse_line = parse_dks;
1438       return gst_caps_new_simple ("text/x-raw",
1439           "format", G_TYPE_STRING, "utf8", NULL);
1440     case GST_SUB_PARSE_FORMAT_VTT:
1441       self->state.allowed_tags = (gpointer) allowed_vtt_tags;
1442       self->state.allows_tag_attributes = TRUE;
1443       self->parse_line = parse_webvtt;
1444       return gst_caps_new_simple ("text/x-raw",
1445           "format", G_TYPE_STRING, "pango-markup", NULL);
1446     case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1447       self->parse_line = parse_subviewer;
1448       return gst_caps_new_simple ("text/x-raw",
1449           "format", G_TYPE_STRING, "utf8", NULL);
1450     case GST_SUB_PARSE_FORMAT_QTTEXT:
1451       self->parse_line = parse_qttext;
1452       qttext_context_init (&self->state);
1453       return gst_caps_new_simple ("text/x-raw",
1454           "format", G_TYPE_STRING, "pango-markup", NULL);
1455     case GST_SUB_PARSE_FORMAT_LRC:
1456       self->parse_line = parse_lrc;
1457       return gst_caps_new_simple ("text/x-raw",
1458           "format", G_TYPE_STRING, "utf8", NULL);
1459     case GST_SUB_PARSE_FORMAT_UNKNOWN:
1460     default:
1461       GST_DEBUG ("no subtitle format detected");
1462       GST_ELEMENT_ERROR (self, STREAM, WRONG_TYPE,
1463           ("The input is not a valid/supported subtitle file"), (NULL));
1464       return NULL;
1465   }
1466 }
1467
1468 static void
1469 feed_textbuf (GstSubParse * self, GstBuffer * buf)
1470 {
1471   gboolean discont;
1472   gsize consumed;
1473   gchar *input = NULL;
1474   const guint8 *data;
1475   gsize avail;
1476
1477   discont = GST_BUFFER_IS_DISCONT (buf);
1478
1479   if (GST_BUFFER_OFFSET_IS_VALID (buf) &&
1480       GST_BUFFER_OFFSET (buf) != self->offset) {
1481     self->offset = GST_BUFFER_OFFSET (buf);
1482     discont = TRUE;
1483   }
1484
1485   if (discont) {
1486     GST_INFO ("discontinuity");
1487     /* flush the parser state */
1488     parser_state_init (&self->state);
1489     g_string_truncate (self->textbuf, 0);
1490     gst_adapter_clear (self->adapter);
1491     if (self->parser_type == GST_SUB_PARSE_FORMAT_SAMI)
1492       sami_context_reset (&self->state);
1493     /* we could set a flag to make sure that the next buffer we push out also
1494      * has the DISCONT flag set, but there's no point really given that it's
1495      * subtitles which are discontinuous by nature. */
1496   }
1497
1498   self->offset += gst_buffer_get_size (buf);
1499
1500   gst_adapter_push (self->adapter, buf);
1501
1502   avail = gst_adapter_available (self->adapter);
1503   data = gst_adapter_map (self->adapter, avail);
1504   input = convert_encoding (self, (const gchar *) data, avail, &consumed);
1505
1506   if (input && consumed > 0) {
1507     self->textbuf = g_string_append (self->textbuf, input);
1508     gst_adapter_unmap (self->adapter);
1509     gst_adapter_flush (self->adapter, consumed);
1510   } else {
1511     gst_adapter_unmap (self->adapter);
1512   }
1513
1514   g_free (input);
1515 }
1516
1517
1518 static void
1519 xml_text (GMarkupParseContext * context,
1520     const gchar * text, gsize text_len, gpointer user_data, GError ** error)
1521 {
1522   gchar **accum = (gchar **) user_data;
1523   gchar *concat;
1524
1525   if (*accum) {
1526     concat = g_strconcat (*accum, text, NULL);
1527     g_free (*accum);
1528     *accum = concat;
1529   } else {
1530     *accum = g_strdup (text);
1531   }
1532 }
1533
1534 static gchar *
1535 strip_pango_markup (gchar * markup, GError ** error)
1536 {
1537   GMarkupParser parser = { 0, };
1538   GMarkupParseContext *context;
1539   gchar *accum = NULL;
1540
1541   parser.text = xml_text;
1542   context = g_markup_parse_context_new (&parser, 0, &accum, NULL);
1543
1544   g_markup_parse_context_parse (context, "<root>", 6, NULL);
1545   g_markup_parse_context_parse (context, markup, strlen (markup), error);
1546   g_markup_parse_context_parse (context, "</root>", 7, NULL);
1547   if (*error)
1548     goto error;
1549
1550   g_markup_parse_context_end_parse (context, error);
1551   if (*error)
1552     goto error;
1553
1554 done:
1555   g_markup_parse_context_free (context);
1556   return accum;
1557
1558 error:
1559   g_free (accum);
1560   accum = NULL;
1561   goto done;
1562 }
1563
1564 static gboolean
1565 gst_sub_parse_negotiate (GstSubParse * self, GstCaps * preferred)
1566 {
1567   GstCaps *caps;
1568   gboolean ret = FALSE;
1569   const GstStructure *s1, *s2;
1570
1571   caps = gst_pad_get_allowed_caps (self->srcpad);
1572
1573   s1 = gst_caps_get_structure (preferred, 0);
1574
1575   if (!g_strcmp0 (gst_structure_get_string (s1, "format"), "utf8")) {
1576     GstCaps *intersected = gst_caps_intersect (caps, preferred);
1577     gst_caps_unref (caps);
1578     caps = intersected;
1579   }
1580
1581   caps = gst_caps_fixate (caps);
1582
1583   if (gst_caps_is_empty (caps)) {
1584     goto done;
1585   }
1586
1587   s2 = gst_caps_get_structure (caps, 0);
1588
1589   self->strip_pango_markup =
1590       !g_strcmp0 (gst_structure_get_string (s2, "format"), "utf8")
1591       && !g_strcmp0 (gst_structure_get_string (s1, "format"), "pango-markup");
1592
1593   if (self->strip_pango_markup) {
1594     GST_INFO_OBJECT (self, "We will convert from pango-markup to utf8");
1595   }
1596
1597   ret = gst_pad_set_caps (self->srcpad, caps);
1598
1599 done:
1600   gst_caps_unref (caps);
1601   return ret;
1602 }
1603
1604 static GstFlowReturn
1605 check_initial_events (GstSubParse * self)
1606 {
1607   gboolean need_tags = FALSE;
1608
1609   /* make sure we know the format */
1610   if (G_UNLIKELY (self->parser_type == GST_SUB_PARSE_FORMAT_UNKNOWN)) {
1611     GstCaps *preferred;
1612
1613     if (!(preferred = gst_sub_parse_format_autodetect (self))) {
1614       return GST_FLOW_NOT_NEGOTIATED;
1615     }
1616
1617     if (!gst_sub_parse_negotiate (self, preferred)) {
1618       gst_caps_unref (preferred);
1619       return GST_FLOW_NOT_NEGOTIATED;
1620     }
1621
1622     gst_caps_unref (preferred);
1623
1624     need_tags = TRUE;
1625   }
1626
1627   /* Push newsegment if needed */
1628   if (self->need_segment) {
1629     GstEvent *segment_event = gst_event_new_segment (&self->segment);
1630     GST_LOG_OBJECT (self, "pushing newsegment event with %" GST_SEGMENT_FORMAT,
1631         &self->segment);
1632
1633     gst_event_set_seqnum (segment_event, self->segment_seqnum);
1634     gst_pad_push_event (self->srcpad, segment_event);
1635     self->need_segment = FALSE;
1636   }
1637
1638   if (need_tags) {
1639     /* push tags */
1640     if (self->subtitle_codec != NULL) {
1641       GstTagList *tags;
1642
1643       tags = gst_tag_list_new (GST_TAG_SUBTITLE_CODEC, self->subtitle_codec,
1644           NULL);
1645       gst_pad_push_event (self->srcpad, gst_event_new_tag (tags));
1646     }
1647   }
1648
1649   return GST_FLOW_OK;
1650 }
1651
1652 static GstFlowReturn
1653 handle_buffer (GstSubParse * self, GstBuffer * buf)
1654 {
1655   GstFlowReturn ret = GST_FLOW_OK;
1656   gchar *line, *subtitle;
1657
1658   GST_DEBUG_OBJECT (self, "%" GST_PTR_FORMAT, buf);
1659
1660   if (self->first_buffer) {
1661     GstMapInfo map;
1662
1663     gst_buffer_map (buf, &map, GST_MAP_READ);
1664     self->detected_encoding =
1665         gst_sub_parse_detect_encoding ((gchar *) map.data, map.size);
1666     gst_buffer_unmap (buf, &map);
1667     self->first_buffer = FALSE;
1668     self->state.fps_n = self->fps_n;
1669     self->state.fps_d = self->fps_d;
1670   }
1671
1672   feed_textbuf (self, buf);
1673
1674   ret = check_initial_events (self);
1675   if (ret != GST_FLOW_OK)
1676     return ret;
1677
1678   while (!self->flushing && (line = get_next_line (self))) {
1679     guint offset = 0;
1680
1681     /* Set segment on our parser state machine */
1682     self->state.segment = &self->segment;
1683     /* Now parse the line, out of segment lines will just return NULL */
1684     GST_LOG_OBJECT (self, "State %d. Parsing line '%s'", self->state.state,
1685         line + offset);
1686     subtitle = self->parse_line (&self->state, line + offset);
1687     g_free (line);
1688
1689     if (subtitle) {
1690       guint subtitle_len;
1691
1692       if (self->strip_pango_markup) {
1693         GError *error = NULL;
1694         gchar *stripped;
1695
1696         if ((stripped = strip_pango_markup (subtitle, &error))) {
1697           g_free (subtitle);
1698           subtitle = stripped;
1699         } else {
1700           GST_WARNING_OBJECT (self, "Failed to strip pango markup: %s",
1701               error->message);
1702         }
1703       }
1704
1705       subtitle_len = strlen (subtitle);
1706
1707       /* +1 for terminating NUL character */
1708       buf = gst_buffer_new_and_alloc (subtitle_len + 1);
1709
1710       /* copy terminating NUL character as well */
1711       gst_buffer_fill (buf, 0, subtitle, subtitle_len + 1);
1712       gst_buffer_set_size (buf, subtitle_len);
1713
1714       GST_BUFFER_TIMESTAMP (buf) = self->state.start_time;
1715       GST_BUFFER_DURATION (buf) = self->state.duration;
1716
1717       /* in some cases (e.g. tmplayer) we can only determine the duration
1718        * of a text chunk from the timestamp of the next text chunk; in those
1719        * cases, we probably want to limit the duration to something
1720        * reasonable, so we don't end up showing some text for e.g. 40 seconds
1721        * just because nothing else is being said during that time */
1722       if (self->state.max_duration > 0 && GST_BUFFER_DURATION_IS_VALID (buf)) {
1723         if (GST_BUFFER_DURATION (buf) > self->state.max_duration)
1724           GST_BUFFER_DURATION (buf) = self->state.max_duration;
1725       }
1726
1727       self->segment.position = self->state.start_time;
1728
1729       GST_DEBUG_OBJECT (self, "Sending text '%s', %" GST_TIME_FORMAT " + %"
1730           GST_TIME_FORMAT, subtitle, GST_TIME_ARGS (self->state.start_time),
1731           GST_TIME_ARGS (self->state.duration));
1732
1733       g_free (self->state.vertical);
1734       self->state.vertical = NULL;
1735       g_free (self->state.alignment);
1736       self->state.alignment = NULL;
1737
1738       ret = gst_pad_push (self->srcpad, buf);
1739
1740       /* move this forward (the tmplayer parser needs this) */
1741       if (self->state.duration != GST_CLOCK_TIME_NONE)
1742         self->state.start_time += self->state.duration;
1743
1744       g_free (subtitle);
1745       subtitle = NULL;
1746
1747       if (ret != GST_FLOW_OK) {
1748         GST_DEBUG_OBJECT (self, "flow: %s", gst_flow_get_name (ret));
1749         break;
1750       }
1751     }
1752   }
1753
1754   return ret;
1755 }
1756
1757 static GstFlowReturn
1758 gst_sub_parse_chain (GstPad * sinkpad, GstObject * parent, GstBuffer * buf)
1759 {
1760   GstFlowReturn ret;
1761   GstSubParse *self;
1762
1763   self = GST_SUBPARSE (parent);
1764
1765   ret = handle_buffer (self, buf);
1766
1767   return ret;
1768 }
1769
1770 static gboolean
1771 gst_sub_parse_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
1772 {
1773   GstSubParse *self = GST_SUBPARSE (parent);
1774   gboolean ret = FALSE;
1775
1776   GST_LOG_OBJECT (self, "%s event", GST_EVENT_TYPE_NAME (event));
1777
1778   switch (GST_EVENT_TYPE (event)) {
1779     case GST_EVENT_STREAM_GROUP_DONE:
1780     case GST_EVENT_EOS:{
1781       /* Make sure the last subrip chunk is pushed out even
1782        * if the file does not have an empty line at the end */
1783       if (self->parser_type == GST_SUB_PARSE_FORMAT_SUBRIP ||
1784           self->parser_type == GST_SUB_PARSE_FORMAT_TMPLAYER ||
1785           self->parser_type == GST_SUB_PARSE_FORMAT_MPL2 ||
1786           self->parser_type == GST_SUB_PARSE_FORMAT_QTTEXT ||
1787           self->parser_type == GST_SUB_PARSE_FORMAT_VTT) {
1788         gchar term_chars[] = { '\n', '\n', '\0' };
1789         GstBuffer *buf = gst_buffer_new_and_alloc (2 + 1);
1790
1791         GST_DEBUG_OBJECT (self, "%s: force pushing of any remaining text",
1792             GST_EVENT_TYPE_NAME (event));
1793
1794         gst_buffer_fill (buf, 0, term_chars, 3);
1795         gst_buffer_set_size (buf, 2);
1796
1797         GST_BUFFER_OFFSET (buf) = self->offset;
1798         gst_sub_parse_chain (pad, parent, buf);
1799       }
1800       ret = gst_pad_event_default (pad, parent, event);
1801       break;
1802     }
1803     case GST_EVENT_SEGMENT:
1804     {
1805       const GstSegment *s;
1806       gst_event_parse_segment (event, &s);
1807       if (s->format == GST_FORMAT_TIME)
1808         gst_event_copy_segment (event, &self->segment);
1809       GST_DEBUG_OBJECT (self, "newsegment (%s)",
1810           gst_format_get_name (self->segment.format));
1811       self->segment_seqnum = gst_event_get_seqnum (event);
1812
1813       /* if not time format, we'll either start with a 0 timestamp anyway or
1814        * it's following a seek in which case we'll have saved the requested
1815        * seek segment and don't want to overwrite it (remember that on a seek
1816        * we always just seek back to the start in BYTES format and just throw
1817        * away all text that's before the requested position; if the subtitles
1818        * come from an upstream demuxer, it won't be able to handle our BYTES
1819        * seek request and instead send us a newsegment from the seek request
1820        * it received via its video pads instead, so all is fine then too) */
1821       ret = TRUE;
1822       gst_event_unref (event);
1823       /* in either case, let's not simply discard this event;
1824        * trigger sending of the saved requested seek segment
1825        * or the one taken here from upstream */
1826       self->need_segment = TRUE;
1827       break;
1828     }
1829     case GST_EVENT_GAP:
1830     {
1831       ret = check_initial_events (self);
1832       if (ret == GST_FLOW_OK) {
1833         ret = gst_pad_event_default (pad, parent, event);
1834       } else {
1835         gst_event_unref (event);
1836       }
1837       break;
1838     }
1839     case GST_EVENT_FLUSH_START:
1840     {
1841       self->flushing = TRUE;
1842
1843       ret = gst_pad_event_default (pad, parent, event);
1844       break;
1845     }
1846     case GST_EVENT_FLUSH_STOP:
1847     {
1848       self->flushing = FALSE;
1849
1850       ret = gst_pad_event_default (pad, parent, event);
1851       break;
1852     }
1853     default:
1854       ret = gst_pad_event_default (pad, parent, event);
1855       break;
1856   }
1857
1858   return ret;
1859 }
1860
1861
1862 static GstStateChangeReturn
1863 gst_sub_parse_change_state (GstElement * element, GstStateChange transition)
1864 {
1865   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1866   GstSubParse *self = GST_SUBPARSE (element);
1867
1868   switch (transition) {
1869     case GST_STATE_CHANGE_READY_TO_PAUSED:
1870       /* format detection will init the parser state */
1871       self->offset = 0;
1872       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1873       self->strip_pango_markup = FALSE;
1874       self->valid_utf8 = TRUE;
1875       self->first_buffer = TRUE;
1876       g_free (self->detected_encoding);
1877       self->detected_encoding = NULL;
1878       g_string_truncate (self->textbuf, 0);
1879       gst_adapter_clear (self->adapter);
1880       break;
1881     default:
1882       break;
1883   }
1884
1885   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1886   if (ret == GST_STATE_CHANGE_FAILURE)
1887     return ret;
1888
1889   switch (transition) {
1890     case GST_STATE_CHANGE_PAUSED_TO_READY:
1891       parser_state_dispose (self, &self->state);
1892       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1893       break;
1894     default:
1895       break;
1896   }
1897
1898   return ret;
1899 }