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           cur = end_tag + 1;
 798           continue;
 799         }
 800       }
 801     }
 802     ++next_tag;
 803     cur = next_tag;
 804   }
 805
 806   if (num_open_tags > 0) {
 807     GString *s;
 808
 809     s = g_string_new (*p_txt);
 810     while (num_open_tags > 0) {
 811       GST_LOG ("adding missing closing tag '%s'",
 812           (char *) g_ptr_array_index (open_tags, num_open_tags - 1));
 813       g_string_append_c (s, '<');
 814       g_string_append_c (s, '/');
 815       g_string_append (s, g_ptr_array_index (open_tags, num_open_tags - 1));
 816       g_string_append_c (s, '>');
 817       --num_open_tags;
 818     }
 819     g_free (*p_txt);
 820     *p_txt = g_string_free (s, FALSE);
 821   }
 822   g_ptr_array_free (open_tags, TRUE);
 823 }
 824
 825 static gboolean
 826 parse_subrip_time (const gchar * ts_string, GstClockTime * t)
 827 {
 828   gchar s[128] = { '\0', };
 829   gchar *end, *p;
 830   guint hour, min, sec, msec, len;
 831
 832   while (*ts_string == ' ')
 833     ++ts_string;
 834
 835   g_strlcpy (s, ts_string, sizeof (s));
 836   if ((end = strstr (s, "-->")))
 837     *end = '\0';
 838   g_strchomp (s);
 839
 840   /* ms may be in these formats:
 841    * hh:mm:ss,500 = 500ms
 842    * hh:mm:ss,  5 =   5ms
 843    * hh:mm:ss, 5  =  50ms
 844    * hh:mm:ss, 50 =  50ms
 845    * hh:mm:ss,5   = 500ms
 846    * and the same with . instead of ,.
 847    * sscanf() doesn't differentiate between '  5' and '5' so munge
 848    * the white spaces within the timestamp to '0' (I'm sure there's a
 849    * way to make sscanf() do this for us, but how?)
 850    */
 851   g_strdelimit (s, " ", '0');
 852   g_strdelimit (s, ".", ',');
 853
 854   /* make sure we have exactly three digits after he comma */
 855   p = strchr (s, ',');
 856   if (p == NULL) {
 857     /* If there isn't a ',' the timestamp is broken */
 858     /* https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/issues/532#note_100179 */
 859     GST_WARNING ("failed to parse subrip timestamp string '%s'", s);
 860     return FALSE;
 861   }
 862
 863   ++p;
 864   len = strlen (p);
 865   if (len > 3) {
 866     p[3] = '\0';
 867   } else
 868     while (len < 3) {
 869       g_strlcat (&p[len], "0", 2);
 870       ++len;
 871     }
 872
 873   GST_LOG ("parsing timestamp '%s'", s);
 874   if (sscanf (s, "%u:%u:%u,%u", &hour, &min, &sec, &msec) != 4) {
 875     /* https://www.w3.org/TR/webvtt1/#webvtt-timestamp
 876      *
 877      * The hours component is optional with webVTT, for example
 878      * mm:ss,500 is a valid webVTT timestamp. When not present,
 879      * hours is 0.
 880      */
 881     hour = 0;
 882
 883     if (sscanf (s, "%u:%u,%u", &min, &sec, &msec) != 3) {
 884       GST_WARNING ("failed to parse subrip timestamp string '%s'", s);
 885       return FALSE;
 886     }
 887   }
 888
 889   *t = ((hour * 3600) + (min * 60) + sec) * GST_SECOND + msec * GST_MSECOND;
 890   return TRUE;
 891 }
 892
 893 /* cue settings are part of the WebVTT specification. They are
 894  * declared after the time interval in the first line of the
 895  * cue. Example: 00:00:01,000 --> 00:00:02,000 D:vertical-lr A:start
 896  * See also http://www.whatwg.org/specs/web-apps/current-work/webvtt.html
 897  */
 898 static void
 899 parse_webvtt_cue_settings (ParserState * state, const gchar * settings)
 900 {
 901   gchar **splitted_settings = g_strsplit_set (settings, " \t", -1);
 902   gint i = 0;
 903   gint16 text_position, text_size;
 904   gint16 line_position;
 905   gboolean vertical_found = FALSE;
 906   gboolean alignment_found = FALSE;
 907
 908   while (i < g_strv_length (splitted_settings)) {
 909     gboolean valid_tag = FALSE;
 910     switch (splitted_settings[i][0]) {
 911       case 'T':
 912         if (sscanf (splitted_settings[i], "T:%" G_GINT16_FORMAT "%%",
 913                 &text_position) > 0) {
 914           state->text_position = (guint8) text_position;
 915           valid_tag = TRUE;
 916         }
 917         break;
 918       case 'D':
 919         if (strlen (splitted_settings[i]) > 2) {
 920           vertical_found = TRUE;
 921           g_free (state->vertical);
 922           state->vertical = g_strdup (splitted_settings[i] + 2);
 923           valid_tag = TRUE;
 924         }
 925         break;
 926       case 'L':
 927         if (g_str_has_suffix (splitted_settings[i], "%")) {
 928           if (sscanf (splitted_settings[i], "L:%" G_GINT16_FORMAT "%%",
 929                   &line_position) > 0) {
 930             state->line_position = line_position;
 931             valid_tag = TRUE;
 932           }
 933         } else {
 934           if (sscanf (splitted_settings[i], "L:%" G_GINT16_FORMAT,
 935                   &line_position) > 0) {
 936             state->line_number = line_position;
 937             valid_tag = TRUE;
 938           }
 939         }
 940         break;
 941       case 'S':
 942         if (sscanf (splitted_settings[i], "S:%" G_GINT16_FORMAT "%%",
 943                 &text_size) > 0) {
 944           state->text_size = (guint8) text_size;
 945           valid_tag = TRUE;
 946         }
 947         break;
 948       case 'A':
 949         if (strlen (splitted_settings[i]) > 2) {
 950           g_free (state->alignment);
 951           state->alignment = g_strdup (splitted_settings[i] + 2);
 952           alignment_found = TRUE;
 953           valid_tag = TRUE;
 954         }
 955         break;
 956       default:
 957         break;
 958     }
 959     if (!valid_tag) {
 960       GST_LOG ("Invalid or unrecognised setting found: %s",
 961           splitted_settings[i]);
 962     }
 963     i++;
 964   }
 965   g_strfreev (splitted_settings);
 966   if (!vertical_found) {
 967     g_free (state->vertical);
 968     state->vertical = g_strdup ("");
 969   }
 970   if (!alignment_found) {
 971     g_free (state->alignment);
 972     state->alignment = g_strdup ("");
 973   }
 974 }
 975
 976 static gchar *
 977 parse_subrip (ParserState * state, const gchar * line)
 978 {
 979   gchar *ret;
 980
 981   switch (state->state) {
 982     case 0:{
 983       char *endptr;
 984       guint64 id;
 985
 986       /* looking for a single integer as a Cue ID, but we
 987        * don't actually use it */
 988       errno = 0;
 989       id = g_ascii_strtoull (line, &endptr, 10);
 990       if (id == G_MAXUINT64 && errno == ERANGE)
 991         state->state = 1;
 992       else if (id == 0 && errno == EINVAL)
 993         state->state = 1;
 994       else if (endptr != line && *endptr == '\0')
 995         state->state = 1;
 996       return NULL;
 997     }
 998     case 1:
 999     {
1000       GstClockTime ts_start, ts_end;
1001       gchar *end_time;
1002
1003       /* looking for start_time --> end_time */
1004       if ((end_time = strstr (line, " --> ")) &&
1005           parse_subrip_time (line, &ts_start) &&
1006           parse_subrip_time (end_time + strlen (" --> "), &ts_end) &&
1007           state->start_time <= ts_end) {
1008         state->state = 2;
1009         state->start_time = ts_start;
1010         state->duration = ts_end - ts_start;
1011       } else {
1012         GST_DEBUG ("error parsing subrip time line '%s'", line);
1013         state->state = 0;
1014       }
1015       return NULL;
1016     }
1017     case 2:
1018     {
1019       /* No need to parse that text if it's out of segment */
1020       guint64 clip_start = 0, clip_stop = 0;
1021       gboolean in_seg = FALSE;
1022
1023       /* Check our segment start/stop */
1024       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1025           state->start_time, state->start_time + state->duration,
1026           &clip_start, &clip_stop);
1027
1028       if (in_seg) {
1029         state->start_time = clip_start;
1030         state->duration = clip_stop - clip_start;
1031       } else {
1032         state->state = 0;
1033         return NULL;
1034       }
1035     }
1036       /* looking for subtitle text; empty line ends this subtitle entry */
1037       if (state->buf->len)
1038         g_string_append_c (state->buf, '\n');
1039       g_string_append (state->buf, line);
1040       if (strlen (line) == 0) {
1041         ret = g_markup_escape_text (state->buf->str, state->buf->len);
1042         g_string_truncate (state->buf, 0);
1043         state->state = 0;
1044         subrip_unescape_formatting (ret, state->allowed_tags,
1045             state->allows_tag_attributes);
1046         subrip_remove_unhandled_tags (ret);
1047         strip_trailing_newlines (ret);
1048         subrip_fix_up_markup (&ret, state->allowed_tags);
1049         return ret;
1050       }
1051       return NULL;
1052     default:
1053       g_return_val_if_reached (NULL);
1054   }
1055 }
1056
1057 static gchar *
1058 parse_lrc (ParserState * state, const gchar * line)
1059 {
1060   gint m, s, c;
1061   const gchar *start;
1062   gint milli;
1063
1064   if (line[0] != '[')
1065     return NULL;
1066
1067   if (sscanf (line, "[%u:%02u.%03u]", &m, &s, &c) != 3 &&
1068       sscanf (line, "[%u:%02u.%02u]", &m, &s, &c) != 3)
1069     return NULL;
1070
1071   start = strchr (line, ']');
1072   if (start - line == 9)
1073     milli = 10;
1074   else
1075     milli = 1;
1076
1077   state->start_time = gst_util_uint64_scale (m, 60 * GST_SECOND, 1)
1078       + gst_util_uint64_scale (s, GST_SECOND, 1)
1079       + gst_util_uint64_scale (c, milli * GST_MSECOND, 1);
1080   state->duration = GST_CLOCK_TIME_NONE;
1081
1082   return g_strdup (start + 1);
1083 }
1084
1085 /* WebVTT is a new subtitle format for the upcoming HTML5 video track
1086  * element. This format is similar to Subrip, the biggest differences
1087  * are that there can be cue settings detailing how to display the cue
1088  * text and more markup tags are allowed.
1089  * See also http://www.whatwg.org/specs/web-apps/current-work/webvtt.html
1090  */
1091 static gchar *
1092 parse_webvtt (ParserState * state, const gchar * line)
1093 {
1094   /* Cue IDs are optional in WebVTT, but not in subrip,
1095    * so when in state 0 (cue ID), also check if we're
1096    * already at the start --> end time marker */
1097   if (state->state == 0 || state->state == 1) {
1098     GstClockTime ts_start, ts_end;
1099     gchar *end_time;
1100     gchar *cue_settings = NULL;
1101
1102     /* looking for start_time --> end_time */
1103     if ((end_time = strstr (line, " --> ")) &&
1104         parse_subrip_time (line, &ts_start) &&
1105         parse_subrip_time (end_time + strlen (" --> "), &ts_end) &&
1106         state->start_time <= ts_end) {
1107       state->state = 2;
1108       state->start_time = ts_start;
1109       state->duration = ts_end - ts_start;
1110       cue_settings = strstr (end_time + strlen (" --> "), " ");
1111     } else {
1112       GST_DEBUG ("error parsing subrip time line '%s'", line);
1113       state->state = 0;
1114     }
1115
1116     state->text_position = 0;
1117     state->text_size = 0;
1118     state->line_position = 0;
1119     state->line_number = 0;
1120
1121     if (cue_settings)
1122       parse_webvtt_cue_settings (state, cue_settings + 1);
1123     else {
1124       g_free (state->vertical);
1125       state->vertical = g_strdup ("");
1126       g_free (state->alignment);
1127       state->alignment = g_strdup ("");
1128     }
1129
1130     return NULL;
1131   } else
1132     return parse_subrip (state, line);
1133 }
1134
1135 static void
1136 unescape_newlines_br (gchar * read)
1137 {
1138   gchar *write = read;
1139
1140   /* Replace all occurrences of '[br]' with a newline as version 2
1141    * of the subviewer format uses this for newlines */
1142
1143   if (read[0] == '\0' || read[1] == '\0' || read[2] == '\0' || read[3] == '\0')
1144     return;
1145
1146   do {
1147     if (strncmp (read, "[br]", 4) == 0) {
1148       *write = '\n';
1149       read += 4;
1150     } else {
1151       *write = *read;
1152       read++;
1153     }
1154     write++;
1155   } while (*read);
1156
1157   *write = '\0';
1158 }
1159
1160 static gchar *
1161 parse_subviewer (ParserState * state, const gchar * line)
1162 {
1163   guint h1, m1, s1, ms1;
1164   guint h2, m2, s2, ms2;
1165   gchar *ret;
1166
1167   /* TODO: Maybe also parse the fields in the header, especially DELAY.
1168    * For examples see the unit test or
1169    * http://www.doom9.org/index.html?/sub.htm */
1170
1171   switch (state->state) {
1172     case 0:
1173       /* looking for start_time,end_time */
1174       if (sscanf (line, "%u:%u:%u.%u,%u:%u:%u.%u",
1175               &h1, &m1, &s1, &ms1, &h2, &m2, &s2, &ms2) == 8) {
1176         state->state = 1;
1177         state->start_time =
1178             (((guint64) h1) * 3600 + m1 * 60 + s1) * GST_SECOND +
1179             ms1 * GST_MSECOND;
1180         state->duration =
1181             (((guint64) h2) * 3600 + m2 * 60 + s2) * GST_SECOND +
1182             ms2 * GST_MSECOND - state->start_time;
1183       }
1184       return NULL;
1185     case 1:
1186     {
1187       /* No need to parse that text if it's out of segment */
1188       guint64 clip_start = 0, clip_stop = 0;
1189       gboolean in_seg = FALSE;
1190
1191       /* Check our segment start/stop */
1192       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1193           state->start_time, state->start_time + state->duration,
1194           &clip_start, &clip_stop);
1195
1196       if (in_seg) {
1197         state->start_time = clip_start;
1198         state->duration = clip_stop - clip_start;
1199       } else {
1200         state->state = 0;
1201         return NULL;
1202       }
1203     }
1204       /* looking for subtitle text; empty line ends this subtitle entry */
1205       if (state->buf->len)
1206         g_string_append_c (state->buf, '\n');
1207       g_string_append (state->buf, line);
1208       if (strlen (line) == 0) {
1209         ret = g_strdup (state->buf->str);
1210         unescape_newlines_br (ret);
1211         strip_trailing_newlines (ret);
1212         g_string_truncate (state->buf, 0);
1213         state->state = 0;
1214         return ret;
1215       }
1216       return NULL;
1217     default:
1218       g_assert_not_reached ();
1219       return NULL;
1220   }
1221 }
1222
1223 static gchar *
1224 parse_mpsub (ParserState * state, const gchar * line)
1225 {
1226   gchar *ret;
1227   float t1, t2;
1228
1229   switch (state->state) {
1230     case 0:
1231       /* looking for two floats (offset, duration) */
1232       if (sscanf (line, "%f %f", &t1, &t2) == 2) {
1233         state->state = 1;
1234         state->start_time += state->duration + GST_SECOND * t1;
1235         state->duration = GST_SECOND * t2;
1236       }
1237       return NULL;
1238     case 1:
1239     {                           /* No need to parse that text if it's out of segment */
1240       guint64 clip_start = 0, clip_stop = 0;
1241       gboolean in_seg = FALSE;
1242
1243       /* Check our segment start/stop */
1244       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1245           state->start_time, state->start_time + state->duration,
1246           &clip_start, &clip_stop);
1247
1248       if (in_seg) {
1249         state->start_time = clip_start;
1250         state->duration = clip_stop - clip_start;
1251       } else {
1252         state->state = 0;
1253         return NULL;
1254       }
1255     }
1256       /* looking for subtitle text; empty line ends this
1257        * subtitle entry */
1258       if (state->buf->len)
1259         g_string_append_c (state->buf, '\n');
1260       g_string_append (state->buf, line);
1261       if (strlen (line) == 0) {
1262         ret = g_strdup (state->buf->str);
1263         g_string_truncate (state->buf, 0);
1264         state->state = 0;
1265         return ret;
1266       }
1267       return NULL;
1268     default:
1269       g_assert_not_reached ();
1270       return NULL;
1271   }
1272 }
1273
1274 static const gchar *
1275 dks_skip_timestamp (const gchar * line)
1276 {
1277   while (*line && *line != ']')
1278     line++;
1279   if (*line == ']')
1280     line++;
1281   return line;
1282 }
1283
1284 static gchar *
1285 parse_dks (ParserState * state, const gchar * line)
1286 {
1287   guint h, m, s;
1288
1289   switch (state->state) {
1290     case 0:
1291       /* Looking for the start time and text */
1292       if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1293         const gchar *text;
1294         state->start_time = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND;
1295         text = dks_skip_timestamp (line);
1296         if (*text) {
1297           state->state = 1;
1298           g_string_append (state->buf, text);
1299         }
1300       }
1301       return NULL;
1302     case 1:
1303     {
1304       guint64 clip_start = 0, clip_stop = 0;
1305       gboolean in_seg;
1306       gchar *ret;
1307
1308       /* Looking for the end time */
1309       if (sscanf (line, "[%u:%u:%u]", &h, &m, &s) == 3) {
1310         state->state = 0;
1311         state->duration = (((guint64) h) * 3600 + m * 60 + s) * GST_SECOND -
1312             state->start_time;
1313       } else {
1314         GST_WARNING ("Failed to parse subtitle end time");
1315         return NULL;
1316       }
1317
1318       /* Check if this subtitle is out of the current segment */
1319       in_seg = gst_segment_clip (state->segment, GST_FORMAT_TIME,
1320           state->start_time, state->start_time + state->duration,
1321           &clip_start, &clip_stop);
1322
1323       if (!in_seg) {
1324         return NULL;
1325       }
1326
1327       state->start_time = clip_start;
1328       state->duration = clip_stop - clip_start;
1329
1330       ret = g_strdup (state->buf->str);
1331       g_string_truncate (state->buf, 0);
1332       unescape_newlines_br (ret);
1333       return ret;
1334     }
1335     default:
1336       g_assert_not_reached ();
1337       return NULL;
1338   }
1339 }
1340
1341 static void
1342 parser_state_init (ParserState * state)
1343 {
1344   GST_DEBUG ("initialising parser");
1345
1346   if (state->buf) {
1347     g_string_truncate (state->buf, 0);
1348   } else {
1349     state->buf = g_string_new (NULL);
1350   }
1351
1352   state->start_time = 0;
1353   state->duration = 0;
1354   state->max_duration = 0;      /* no limit */
1355   state->state = 0;
1356   state->segment = NULL;
1357 }
1358
1359 static void
1360 parser_state_dispose (GstSubParse * self, ParserState * state)
1361 {
1362   if (state->buf) {
1363     g_string_free (state->buf, TRUE);
1364     state->buf = NULL;
1365   }
1366
1367   g_free (state->vertical);
1368   state->vertical = NULL;
1369   g_free (state->alignment);
1370   state->alignment = NULL;
1371
1372   if (state->user_data) {
1373     switch (self->parser_type) {
1374       case GST_SUB_PARSE_FORMAT_QTTEXT:
1375         qttext_context_deinit (state);
1376         break;
1377       case GST_SUB_PARSE_FORMAT_SAMI:
1378         sami_context_deinit (state);
1379         break;
1380       default:
1381         break;
1382     }
1383   }
1384   state->allowed_tags = NULL;
1385 }
1386
1387
1388
1389 static GstCaps *
1390 gst_sub_parse_format_autodetect (GstSubParse * self)
1391 {
1392   gchar *data;
1393   GstSubParseFormat format;
1394
1395   if (strlen (self->textbuf->str) < 6) {
1396     GST_DEBUG ("File too small to be a subtitles file");
1397     return NULL;
1398   }
1399
1400   data = g_strndup (self->textbuf->str, 35);
1401   format = gst_sub_parse_data_format_autodetect (data);
1402   g_free (data);
1403
1404   self->parser_type = format;
1405   self->subtitle_codec = gst_sub_parse_get_format_description (format);
1406   parser_state_init (&self->state);
1407   self->state.allowed_tags = NULL;
1408
1409   switch (format) {
1410     case GST_SUB_PARSE_FORMAT_MDVDSUB:
1411       self->parse_line = parse_mdvdsub;
1412       return gst_caps_new_simple ("text/x-raw",
1413           "format", G_TYPE_STRING, "pango-markup", NULL);
1414     case GST_SUB_PARSE_FORMAT_SUBRIP:
1415       self->state.allowed_tags = (gpointer) allowed_srt_tags;
1416       self->state.allows_tag_attributes = FALSE;
1417       self->parse_line = parse_subrip;
1418       return gst_caps_new_simple ("text/x-raw",
1419           "format", G_TYPE_STRING, "pango-markup", NULL);
1420     case GST_SUB_PARSE_FORMAT_MPSUB:
1421       self->parse_line = parse_mpsub;
1422       return gst_caps_new_simple ("text/x-raw",
1423           "format", G_TYPE_STRING, "utf8", NULL);
1424     case GST_SUB_PARSE_FORMAT_SAMI:
1425       self->parse_line = parse_sami;
1426       sami_context_init (&self->state);
1427       return gst_caps_new_simple ("text/x-raw",
1428           "format", G_TYPE_STRING, "pango-markup", NULL);
1429     case GST_SUB_PARSE_FORMAT_TMPLAYER:
1430       self->parse_line = parse_tmplayer;
1431       self->state.max_duration = 5 * GST_SECOND;
1432       return gst_caps_new_simple ("text/x-raw",
1433           "format", G_TYPE_STRING, "utf8", NULL);
1434     case GST_SUB_PARSE_FORMAT_MPL2:
1435       self->parse_line = parse_mpl2;
1436       return gst_caps_new_simple ("text/x-raw",
1437           "format", G_TYPE_STRING, "pango-markup", NULL);
1438     case GST_SUB_PARSE_FORMAT_DKS:
1439       self->parse_line = parse_dks;
1440       return gst_caps_new_simple ("text/x-raw",
1441           "format", G_TYPE_STRING, "utf8", NULL);
1442     case GST_SUB_PARSE_FORMAT_VTT:
1443       self->state.allowed_tags = (gpointer) allowed_vtt_tags;
1444       self->state.allows_tag_attributes = TRUE;
1445       self->parse_line = parse_webvtt;
1446       return gst_caps_new_simple ("text/x-raw",
1447           "format", G_TYPE_STRING, "pango-markup", NULL);
1448     case GST_SUB_PARSE_FORMAT_SUBVIEWER:
1449       self->parse_line = parse_subviewer;
1450       return gst_caps_new_simple ("text/x-raw",
1451           "format", G_TYPE_STRING, "utf8", NULL);
1452     case GST_SUB_PARSE_FORMAT_QTTEXT:
1453       self->parse_line = parse_qttext;
1454       qttext_context_init (&self->state);
1455       return gst_caps_new_simple ("text/x-raw",
1456           "format", G_TYPE_STRING, "pango-markup", NULL);
1457     case GST_SUB_PARSE_FORMAT_LRC:
1458       self->parse_line = parse_lrc;
1459       return gst_caps_new_simple ("text/x-raw",
1460           "format", G_TYPE_STRING, "utf8", NULL);
1461     case GST_SUB_PARSE_FORMAT_UNKNOWN:
1462     default:
1463       GST_DEBUG ("no subtitle format detected");
1464       GST_ELEMENT_ERROR (self, STREAM, WRONG_TYPE,
1465           ("The input is not a valid/supported subtitle file"), (NULL));
1466       return NULL;
1467   }
1468 }
1469
1470 static void
1471 feed_textbuf (GstSubParse * self, GstBuffer * buf)
1472 {
1473   gboolean discont;
1474   gsize consumed;
1475   gchar *input = NULL;
1476   const guint8 *data;
1477   gsize avail;
1478
1479   discont = GST_BUFFER_IS_DISCONT (buf);
1480
1481   if (GST_BUFFER_OFFSET_IS_VALID (buf) &&
1482       GST_BUFFER_OFFSET (buf) != self->offset) {
1483     self->offset = GST_BUFFER_OFFSET (buf);
1484     discont = TRUE;
1485   }
1486
1487   if (discont) {
1488     GST_INFO ("discontinuity");
1489     /* flush the parser state */
1490     parser_state_init (&self->state);
1491     g_string_truncate (self->textbuf, 0);
1492     gst_adapter_clear (self->adapter);
1493     if (self->parser_type == GST_SUB_PARSE_FORMAT_SAMI)
1494       sami_context_reset (&self->state);
1495     /* we could set a flag to make sure that the next buffer we push out also
1496      * has the DISCONT flag set, but there's no point really given that it's
1497      * subtitles which are discontinuous by nature. */
1498   }
1499
1500   self->offset += gst_buffer_get_size (buf);
1501
1502   gst_adapter_push (self->adapter, buf);
1503
1504   avail = gst_adapter_available (self->adapter);
1505   data = gst_adapter_map (self->adapter, avail);
1506   input = convert_encoding (self, (const gchar *) data, avail, &consumed);
1507
1508   if (input && consumed > 0) {
1509     self->textbuf = g_string_append (self->textbuf, input);
1510     gst_adapter_unmap (self->adapter);
1511     gst_adapter_flush (self->adapter, consumed);
1512   } else {
1513     gst_adapter_unmap (self->adapter);
1514   }
1515
1516   g_free (input);
1517 }
1518
1519
1520 static void
1521 xml_text (GMarkupParseContext * context,
1522     const gchar * text, gsize text_len, gpointer user_data, GError ** error)
1523 {
1524   gchar **accum = (gchar **) user_data;
1525   gchar *concat;
1526
1527   if (*accum) {
1528     concat = g_strconcat (*accum, text, NULL);
1529     g_free (*accum);
1530     *accum = concat;
1531   } else {
1532     *accum = g_strdup (text);
1533   }
1534 }
1535
1536 static gchar *
1537 strip_pango_markup (gchar * markup, GError ** error)
1538 {
1539   GMarkupParser parser = { 0, };
1540   GMarkupParseContext *context;
1541   gchar *accum = NULL;
1542
1543   parser.text = xml_text;
1544   context = g_markup_parse_context_new (&parser, 0, &accum, NULL);
1545
1546   g_markup_parse_context_parse (context, "<root>", 6, NULL);
1547   g_markup_parse_context_parse (context, markup, strlen (markup), error);
1548   g_markup_parse_context_parse (context, "</root>", 7, NULL);
1549   if (*error)
1550     goto error;
1551
1552   g_markup_parse_context_end_parse (context, error);
1553   if (*error)
1554     goto error;
1555
1556 done:
1557   g_markup_parse_context_free (context);
1558   return accum;
1559
1560 error:
1561   g_free (accum);
1562   accum = NULL;
1563   goto done;
1564 }
1565
1566 static gboolean
1567 gst_sub_parse_negotiate (GstSubParse * self, GstCaps * preferred)
1568 {
1569   GstCaps *caps;
1570   gboolean ret = FALSE;
1571   const GstStructure *s1, *s2;
1572
1573   caps = gst_pad_get_allowed_caps (self->srcpad);
1574
1575   s1 = gst_caps_get_structure (preferred, 0);
1576
1577   if (!g_strcmp0 (gst_structure_get_string (s1, "format"), "utf8")) {
1578     GstCaps *intersected = gst_caps_intersect (caps, preferred);
1579     gst_caps_unref (caps);
1580     caps = intersected;
1581   }
1582
1583   caps = gst_caps_fixate (caps);
1584
1585   if (gst_caps_is_empty (caps)) {
1586     goto done;
1587   }
1588
1589   s2 = gst_caps_get_structure (caps, 0);
1590
1591   self->strip_pango_markup =
1592       !g_strcmp0 (gst_structure_get_string (s2, "format"), "utf8")
1593       && !g_strcmp0 (gst_structure_get_string (s1, "format"), "pango-markup");
1594
1595   if (self->strip_pango_markup) {
1596     GST_INFO_OBJECT (self, "We will convert from pango-markup to utf8");
1597   }
1598
1599   ret = gst_pad_set_caps (self->srcpad, caps);
1600
1601 done:
1602   gst_caps_unref (caps);
1603   return ret;
1604 }
1605
1606 static GstFlowReturn
1607 check_initial_events (GstSubParse * self)
1608 {
1609   gboolean need_tags = FALSE;
1610
1611   /* make sure we know the format */
1612   if (G_UNLIKELY (self->parser_type == GST_SUB_PARSE_FORMAT_UNKNOWN)) {
1613     GstCaps *preferred;
1614
1615     if (!(preferred = gst_sub_parse_format_autodetect (self))) {
1616       return GST_FLOW_NOT_NEGOTIATED;
1617     }
1618
1619     if (!gst_sub_parse_negotiate (self, preferred)) {
1620       gst_caps_unref (preferred);
1621       return GST_FLOW_NOT_NEGOTIATED;
1622     }
1623
1624     gst_caps_unref (preferred);
1625
1626     need_tags = TRUE;
1627   }
1628
1629   /* Push newsegment if needed */
1630   if (self->need_segment) {
1631     GstEvent *segment_event = gst_event_new_segment (&self->segment);
1632     GST_LOG_OBJECT (self, "pushing newsegment event with %" GST_SEGMENT_FORMAT,
1633         &self->segment);
1634
1635     gst_event_set_seqnum (segment_event, self->segment_seqnum);
1636     gst_pad_push_event (self->srcpad, segment_event);
1637     self->need_segment = FALSE;
1638   }
1639
1640   if (need_tags) {
1641     /* push tags */
1642     if (self->subtitle_codec != NULL) {
1643       GstTagList *tags;
1644
1645       tags = gst_tag_list_new (GST_TAG_SUBTITLE_CODEC, self->subtitle_codec,
1646           NULL);
1647       gst_pad_push_event (self->srcpad, gst_event_new_tag (tags));
1648     }
1649   }
1650
1651   return GST_FLOW_OK;
1652 }
1653
1654 static GstFlowReturn
1655 handle_buffer (GstSubParse * self, GstBuffer * buf)
1656 {
1657   GstFlowReturn ret = GST_FLOW_OK;
1658   gchar *line, *subtitle;
1659
1660   GST_DEBUG_OBJECT (self, "%" GST_PTR_FORMAT, buf);
1661
1662   if (self->first_buffer) {
1663     GstMapInfo map;
1664
1665     gst_buffer_map (buf, &map, GST_MAP_READ);
1666     self->detected_encoding =
1667         gst_sub_parse_detect_encoding ((gchar *) map.data, map.size);
1668     gst_buffer_unmap (buf, &map);
1669     self->first_buffer = FALSE;
1670     self->state.fps_n = self->fps_n;
1671     self->state.fps_d = self->fps_d;
1672   }
1673
1674   feed_textbuf (self, buf);
1675
1676   ret = check_initial_events (self);
1677   if (ret != GST_FLOW_OK)
1678     return ret;
1679
1680   while (!self->flushing && (line = get_next_line (self))) {
1681     guint offset = 0;
1682
1683     /* Set segment on our parser state machine */
1684     self->state.segment = &self->segment;
1685     /* Now parse the line, out of segment lines will just return NULL */
1686     GST_LOG_OBJECT (self, "State %d. Parsing line '%s'", self->state.state,
1687         line + offset);
1688     subtitle = self->parse_line (&self->state, line + offset);
1689     g_free (line);
1690
1691     if (subtitle) {
1692       guint subtitle_len;
1693
1694       if (self->strip_pango_markup) {
1695         GError *error = NULL;
1696         gchar *stripped;
1697
1698         if ((stripped = strip_pango_markup (subtitle, &error))) {
1699           g_free (subtitle);
1700           subtitle = stripped;
1701         } else {
1702           GST_WARNING_OBJECT (self, "Failed to strip pango markup: %s",
1703               error->message);
1704         }
1705       }
1706
1707       subtitle_len = strlen (subtitle);
1708
1709       /* +1 for terminating NUL character */
1710       buf = gst_buffer_new_and_alloc (subtitle_len + 1);
1711
1712       /* copy terminating NUL character as well */
1713       gst_buffer_fill (buf, 0, subtitle, subtitle_len + 1);
1714       gst_buffer_set_size (buf, subtitle_len);
1715
1716       GST_BUFFER_TIMESTAMP (buf) = self->state.start_time;
1717       GST_BUFFER_DURATION (buf) = self->state.duration;
1718
1719       /* in some cases (e.g. tmplayer) we can only determine the duration
1720        * of a text chunk from the timestamp of the next text chunk; in those
1721        * cases, we probably want to limit the duration to something
1722        * reasonable, so we don't end up showing some text for e.g. 40 seconds
1723        * just because nothing else is being said during that time */
1724       if (self->state.max_duration > 0 && GST_BUFFER_DURATION_IS_VALID (buf)) {
1725         if (GST_BUFFER_DURATION (buf) > self->state.max_duration)
1726           GST_BUFFER_DURATION (buf) = self->state.max_duration;
1727       }
1728
1729       self->segment.position = self->state.start_time;
1730
1731       GST_DEBUG_OBJECT (self, "Sending text '%s', %" GST_TIME_FORMAT " + %"
1732           GST_TIME_FORMAT, subtitle, GST_TIME_ARGS (self->state.start_time),
1733           GST_TIME_ARGS (self->state.duration));
1734
1735       g_free (self->state.vertical);
1736       self->state.vertical = NULL;
1737       g_free (self->state.alignment);
1738       self->state.alignment = NULL;
1739
1740       ret = gst_pad_push (self->srcpad, buf);
1741
1742       /* move this forward (the tmplayer parser needs this) */
1743       if (self->state.duration != GST_CLOCK_TIME_NONE)
1744         self->state.start_time += self->state.duration;
1745
1746       g_free (subtitle);
1747       subtitle = NULL;
1748
1749       if (ret != GST_FLOW_OK) {
1750         GST_DEBUG_OBJECT (self, "flow: %s", gst_flow_get_name (ret));
1751         break;
1752       }
1753     }
1754   }
1755
1756   return ret;
1757 }
1758
1759 static GstFlowReturn
1760 gst_sub_parse_chain (GstPad * sinkpad, GstObject * parent, GstBuffer * buf)
1761 {
1762   GstFlowReturn ret;
1763   GstSubParse *self;
1764
1765   self = GST_SUBPARSE (parent);
1766
1767   ret = handle_buffer (self, buf);
1768
1769   return ret;
1770 }
1771
1772 static gboolean
1773 gst_sub_parse_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
1774 {
1775   GstSubParse *self = GST_SUBPARSE (parent);
1776   gboolean ret = FALSE;
1777
1778   GST_LOG_OBJECT (self, "%s event", GST_EVENT_TYPE_NAME (event));
1779
1780   switch (GST_EVENT_TYPE (event)) {
1781     case GST_EVENT_STREAM_GROUP_DONE:
1782     case GST_EVENT_EOS:{
1783       /* Make sure the last subrip chunk is pushed out even
1784        * if the file does not have an empty line at the end */
1785       if (self->parser_type == GST_SUB_PARSE_FORMAT_SUBRIP ||
1786           self->parser_type == GST_SUB_PARSE_FORMAT_TMPLAYER ||
1787           self->parser_type == GST_SUB_PARSE_FORMAT_MPL2 ||
1788           self->parser_type == GST_SUB_PARSE_FORMAT_QTTEXT ||
1789           self->parser_type == GST_SUB_PARSE_FORMAT_VTT) {
1790         gchar term_chars[] = { '\n', '\n', '\0' };
1791         GstBuffer *buf = gst_buffer_new_and_alloc (2 + 1);
1792
1793         GST_DEBUG_OBJECT (self, "%s: force pushing of any remaining text",
1794             GST_EVENT_TYPE_NAME (event));
1795
1796         gst_buffer_fill (buf, 0, term_chars, 3);
1797         gst_buffer_set_size (buf, 2);
1798
1799         GST_BUFFER_OFFSET (buf) = self->offset;
1800         gst_sub_parse_chain (pad, parent, buf);
1801       }
1802       ret = gst_pad_event_default (pad, parent, event);
1803       break;
1804     }
1805     case GST_EVENT_SEGMENT:
1806     {
1807       const GstSegment *s;
1808       gst_event_parse_segment (event, &s);
1809       if (s->format == GST_FORMAT_TIME)
1810         gst_event_copy_segment (event, &self->segment);
1811       GST_DEBUG_OBJECT (self, "newsegment (%s)",
1812           gst_format_get_name (self->segment.format));
1813       self->segment_seqnum = gst_event_get_seqnum (event);
1814
1815       /* if not time format, we'll either start with a 0 timestamp anyway or
1816        * it's following a seek in which case we'll have saved the requested
1817        * seek segment and don't want to overwrite it (remember that on a seek
1818        * we always just seek back to the start in BYTES format and just throw
1819        * away all text that's before the requested position; if the subtitles
1820        * come from an upstream demuxer, it won't be able to handle our BYTES
1821        * seek request and instead send us a newsegment from the seek request
1822        * it received via its video pads instead, so all is fine then too) */
1823       ret = TRUE;
1824       gst_event_unref (event);
1825       /* in either case, let's not simply discard this event;
1826        * trigger sending of the saved requested seek segment
1827        * or the one taken here from upstream */
1828       self->need_segment = TRUE;
1829       break;
1830     }
1831     case GST_EVENT_GAP:
1832     {
1833       ret = check_initial_events (self);
1834       if (ret == GST_FLOW_OK) {
1835         ret = gst_pad_event_default (pad, parent, event);
1836       } else {
1837         gst_event_unref (event);
1838       }
1839       break;
1840     }
1841     case GST_EVENT_FLUSH_START:
1842     {
1843       self->flushing = TRUE;
1844
1845       ret = gst_pad_event_default (pad, parent, event);
1846       break;
1847     }
1848     case GST_EVENT_FLUSH_STOP:
1849     {
1850       self->flushing = FALSE;
1851
1852       ret = gst_pad_event_default (pad, parent, event);
1853       break;
1854     }
1855     default:
1856       ret = gst_pad_event_default (pad, parent, event);
1857       break;
1858   }
1859
1860   return ret;
1861 }
1862
1863
1864 static GstStateChangeReturn
1865 gst_sub_parse_change_state (GstElement * element, GstStateChange transition)
1866 {
1867   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1868   GstSubParse *self = GST_SUBPARSE (element);
1869
1870   switch (transition) {
1871     case GST_STATE_CHANGE_READY_TO_PAUSED:
1872       /* format detection will init the parser state */
1873       self->offset = 0;
1874       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1875       self->strip_pango_markup = FALSE;
1876       self->valid_utf8 = TRUE;
1877       self->first_buffer = TRUE;
1878       g_free (self->detected_encoding);
1879       self->detected_encoding = NULL;
1880       g_string_truncate (self->textbuf, 0);
1881       gst_adapter_clear (self->adapter);
1882       break;
1883     default:
1884       break;
1885   }
1886
1887   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1888   if (ret == GST_STATE_CHANGE_FAILURE)
1889     return ret;
1890
1891   switch (transition) {
1892     case GST_STATE_CHANGE_PAUSED_TO_READY:
1893       parser_state_dispose (self, &self->state);
1894       self->parser_type = GST_SUB_PARSE_FORMAT_UNKNOWN;
1895       break;
1896     default:
1897       break;
1898   }
1899
1900   return ret;
1901 }