2007-12-18 13:30:15 +00:00
|
|
|
/* GStreamer AVI GAB2 subtitle parser
|
2007-12-18 09:13:12 +00:00
|
|
|
* Copyright (C) <2007> Thijs Vermeir <thijsvermeir@gmail.com>
|
2007-12-18 13:30:15 +00:00
|
|
|
* Copyright (C) <2007> Tim-Philipp Müller <tim centricular net>
|
2007-12-18 09:13:12 +00:00
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Library General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Library General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Library General Public
|
|
|
|
* License along with this library; if not, write to the
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
*/
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* FIXME: BOM detection and format conversion; validate UTF-8; handle seeks */
|
|
|
|
|
|
|
|
/* example of a subtitle chunk in an avi file
|
|
|
|
* 00000000: 47 41 42 32 00 02 00 10 00 00 00 45 00 6e 00 67 GAB2.......E.n.g
|
|
|
|
* 00000010: 00 6c 00 69 00 73 00 68 00 00 00 04 00 8e 00 00 .l.i.s.h........
|
|
|
|
* 00000020: 00 ef bb bf 31 0d 0a 30 30 3a 30 30 3a 30 30 2c ....1..00:00:00,
|
|
|
|
* 00000030: 31 30 30 20 2d 2d 3e 20 30 30 3a 30 30 3a 30 32 100 --> 00:00:02
|
|
|
|
* 00000040: 2c 30 30 30 0d 0a 3c 62 3e 41 6e 20 55 54 46 38 ,000..<b>An UTF8
|
|
|
|
* 00000050: 20 53 75 62 74 69 74 6c 65 20 77 69 74 68 20 42 Subtitle with B
|
|
|
|
* 00000060: 4f 4d 3c 2f 62 3e 0d 0a 0d 0a 32 0d 0a 30 30 3a OM</b>....2..00:
|
|
|
|
* 00000070: 30 30 3a 30 32 2c 31 30 30 20 2d 2d 3e 20 30 30 00:02,100 --> 00
|
|
|
|
* 00000080: 3a 30 30 3a 30 34 2c 30 30 30 0d 0a 53 6f 6d 65 :00:04,000..Some
|
|
|
|
* 00000090: 74 68 69 6e 67 20 6e 6f 6e 41 53 43 49 49 20 2d thing nonASCII -
|
|
|
|
* 000000a0: 20 c2 b5 c3 b6 c3 a4 c3 bc c3 9f 0d 0a 0d 0a ..............
|
|
|
|
*/
|
2007-12-18 09:13:12 +00:00
|
|
|
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
#include "config.h"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include "gstavisubtitle.h"
|
|
|
|
|
|
|
|
GST_DEBUG_CATEGORY_STATIC (avisubtitle_debug);
|
|
|
|
#define GST_CAT_DEFAULT avisubtitle_debug
|
|
|
|
|
|
|
|
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
|
|
|
|
GST_PAD_SINK,
|
|
|
|
GST_PAD_ALWAYS,
|
|
|
|
GST_STATIC_CAPS ("application/x-subtitle-avi")
|
|
|
|
);
|
|
|
|
|
|
|
|
static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
|
|
|
|
GST_PAD_SRC,
|
|
|
|
GST_PAD_ALWAYS,
|
|
|
|
GST_STATIC_CAPS ("application/x-subtitle")
|
|
|
|
);
|
|
|
|
|
|
|
|
static GstFlowReturn gst_avi_subtitle_chain (GstPad * pad, GstBuffer * buffer);
|
2007-12-18 13:30:15 +00:00
|
|
|
static GstStateChangeReturn gst_avi_subtitle_change_state (GstElement * element,
|
|
|
|
GstStateChange transition);
|
2007-12-18 09:13:12 +00:00
|
|
|
|
|
|
|
GST_BOILERPLATE (GstAviSubtitle, gst_avi_subtitle, GstElement,
|
|
|
|
GST_TYPE_ELEMENT);
|
|
|
|
|
|
|
|
static GstBuffer *
|
2007-12-18 13:30:15 +00:00
|
|
|
gst_avi_subtitle_extract_utf8_file (GstBuffer * buffer, guint offset, guint len)
|
2007-12-18 09:13:12 +00:00
|
|
|
{
|
|
|
|
guint8 *file = GST_BUFFER_DATA (buffer) + offset;
|
|
|
|
|
|
|
|
if (file[0] == 0xEF && file[1] == 0xBB && file[2] == 0xBF) {
|
|
|
|
/* UTF-8 */
|
2007-12-18 13:30:15 +00:00
|
|
|
return gst_buffer_create_sub (buffer, offset + 3, len - 3);
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|
|
|
|
/* TODO Check for:
|
|
|
|
* 00 00 FE FF UTF-32, big-endian
|
|
|
|
* FF FE 00 00 UTF-32, little-endian
|
|
|
|
* FE FF UTF-16, big-endian
|
|
|
|
* FF FE UTF-16, little-endian
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* No BOM detected assuming UTF-8 */
|
2007-12-18 13:30:15 +00:00
|
|
|
return gst_buffer_create_sub (buffer, offset, len);
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static GstFlowReturn
|
2007-12-18 13:30:15 +00:00
|
|
|
gst_avi_subtitle_parse_gab2_chunk (GstAviSubtitle * sub, GstBuffer * buf)
|
2007-12-18 09:13:12 +00:00
|
|
|
{
|
2007-12-18 13:30:15 +00:00
|
|
|
const guint8 *data;
|
|
|
|
gchar *name_utf8;
|
|
|
|
guint name_length;
|
|
|
|
guint file_length;
|
|
|
|
guint size;
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
data = GST_BUFFER_DATA (buf);
|
|
|
|
size = GST_BUFFER_SIZE (buf);
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* check the magic word "GAB2\0", and the next word must be 2 */
|
|
|
|
if (size < 12 || memcmp (data, "GAB2\0\2\0", 5 + 2) != 0)
|
2007-12-18 09:13:12 +00:00
|
|
|
goto wrong_magic_word;
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* read 'name' of subtitle */
|
|
|
|
name_length = GST_READ_UINT32_LE (data + 5 + 2);
|
|
|
|
GST_LOG_OBJECT (sub, "length of name: %u", name_length);
|
|
|
|
if (size <= 17 + name_length)
|
|
|
|
goto wrong_name_length;
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
name_utf8 = g_convert ((gchar *) data + 11, name_length, "UTF-8", "UTF-16LE",
|
|
|
|
NULL, NULL, NULL);
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
if (name_utf8) {
|
|
|
|
/* FIXME: put in a taglist */
|
|
|
|
GST_LOG_OBJECT (sub, "subtitle name: %s", name_utf8);
|
|
|
|
g_free (name_utf8);
|
|
|
|
}
|
2007-12-18 09:13:12 +00:00
|
|
|
|
|
|
|
/* next word must be 4 */
|
2007-12-18 13:30:15 +00:00
|
|
|
if (GST_READ_UINT16_LE (data + 11 + name_length) != 0x4)
|
2007-12-18 09:13:12 +00:00
|
|
|
goto wrong_fixed_word_2;
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
file_length = GST_READ_UINT32_LE (data + 13 + name_length);
|
|
|
|
GST_LOG_OBJECT (sub, "length srt/ssa file: %u", file_length);
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
if (size < (17 + name_length + file_length))
|
2007-12-18 09:13:12 +00:00
|
|
|
goto wrong_total_length;
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* store this, so we can send it again after a seek; note that we shouldn't
|
|
|
|
* assume all the remaining data in the chunk is subtitle data, there may
|
|
|
|
* be padding at the end for some reason, so only parse file_length bytes */
|
|
|
|
sub->subfile =
|
|
|
|
gst_avi_subtitle_extract_utf8_file (buf, 17 + name_length, file_length);
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
return GST_FLOW_OK;
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* ERRORS */
|
2007-12-18 09:13:12 +00:00
|
|
|
wrong_magic_word:
|
2007-12-18 13:30:15 +00:00
|
|
|
{
|
|
|
|
GST_ELEMENT_ERROR (sub, STREAM, DECODE, (NULL), ("Wrong magic word"));
|
|
|
|
return GST_FLOW_ERROR;
|
|
|
|
}
|
|
|
|
wrong_name_length:
|
|
|
|
{
|
|
|
|
GST_ELEMENT_ERROR (sub, STREAM, DECODE, (NULL),
|
|
|
|
("name doesn't fit in buffer (%d < %d)", size, 17 + name_length));
|
|
|
|
return GST_FLOW_ERROR;
|
|
|
|
}
|
|
|
|
wrong_fixed_word_2:
|
|
|
|
{
|
|
|
|
GST_ELEMENT_ERROR (sub, STREAM, DECODE, (NULL),
|
|
|
|
("wrong fixed word: expected %u, got %u", 4,
|
|
|
|
GST_READ_UINT16_LE (data + 11 + name_length)));
|
|
|
|
return GST_FLOW_ERROR;
|
|
|
|
}
|
|
|
|
wrong_total_length:
|
|
|
|
{
|
|
|
|
GST_ELEMENT_ERROR (sub, STREAM, DECODE, (NULL),
|
|
|
|
("buffer size is wrong: need %d bytes, have %d bytes",
|
|
|
|
17 + name_length + file_length, size));
|
|
|
|
return GST_FLOW_ERROR;
|
|
|
|
}
|
|
|
|
}
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
static GstFlowReturn
|
|
|
|
gst_avi_subtitle_chain (GstPad * pad, GstBuffer * buffer)
|
|
|
|
{
|
|
|
|
GstAviSubtitle *sub = GST_AVI_SUBTITLE (GST_PAD_PARENT (pad));
|
|
|
|
GstFlowReturn ret;
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
if (sub->subfile != NULL) {
|
|
|
|
GST_WARNING_OBJECT (sub, "Got more buffers than expected, dropping");
|
|
|
|
ret = GST_FLOW_UNEXPECTED;
|
|
|
|
goto done;
|
|
|
|
}
|
2007-12-18 09:13:12 +00:00
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
/* we expect exactly one buffer with the whole srt/ssa file in it */
|
|
|
|
ret = gst_avi_subtitle_parse_gab2_chunk (sub, buffer);
|
|
|
|
if (ret != GST_FLOW_OK)
|
|
|
|
goto done;
|
|
|
|
|
|
|
|
/* now push the subtitle data downstream */
|
|
|
|
ret = gst_pad_push (sub->src, gst_buffer_ref (sub->subfile));
|
|
|
|
|
|
|
|
done:
|
2007-12-18 09:13:12 +00:00
|
|
|
|
|
|
|
gst_buffer_unref (buffer);
|
2007-12-18 13:30:15 +00:00
|
|
|
return ret;
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_avi_subtitle_base_init (gpointer klass)
|
|
|
|
{
|
|
|
|
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
GST_DEBUG_CATEGORY_INIT (avisubtitle_debug, "avisubtitle", 0,
|
|
|
|
"parse avi subtitle stream");
|
|
|
|
|
2007-12-18 09:13:12 +00:00
|
|
|
gst_element_class_add_pad_template (element_class,
|
|
|
|
gst_static_pad_template_get (&sink_template));
|
|
|
|
gst_element_class_add_pad_template (element_class,
|
|
|
|
gst_static_pad_template_get (&src_template));
|
|
|
|
|
2007-12-18 13:30:15 +00:00
|
|
|
gst_element_class_set_details_simple (element_class,
|
|
|
|
"Avi subtitle parser", "Codec/Demuxer", "Parse avi subtitle stream",
|
|
|
|
"Thijs Vermeir <thijsvermeir@gmail.com>");
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_avi_subtitle_class_init (GstAviSubtitleClass * klass)
|
|
|
|
{
|
2007-12-18 13:30:15 +00:00
|
|
|
GstElementClass *gstelement_class = (GstElementClass *) klass;
|
|
|
|
|
|
|
|
gstelement_class->change_state =
|
|
|
|
GST_DEBUG_FUNCPTR (gst_avi_subtitle_change_state);
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
gst_avi_subtitle_init (GstAviSubtitle * self, GstAviSubtitleClass * klass)
|
|
|
|
{
|
|
|
|
self->src = gst_pad_new_from_static_template (&src_template, "src");
|
|
|
|
gst_element_add_pad (GST_ELEMENT (self), self->src);
|
|
|
|
|
|
|
|
self->sink = gst_pad_new_from_static_template (&sink_template, "sink");
|
2007-12-18 13:30:15 +00:00
|
|
|
gst_pad_set_chain_function (self->sink,
|
|
|
|
GST_DEBUG_FUNCPTR (gst_avi_subtitle_chain));
|
2007-12-18 09:13:12 +00:00
|
|
|
gst_element_add_pad (GST_ELEMENT (self), self->sink);
|
2007-12-18 13:30:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static GstStateChangeReturn
|
|
|
|
gst_avi_subtitle_change_state (GstElement * element, GstStateChange transition)
|
|
|
|
{
|
|
|
|
GstStateChangeReturn ret;
|
|
|
|
GstAviSubtitle *sub = GST_AVI_SUBTITLE (element);
|
|
|
|
|
|
|
|
switch (transition) {
|
|
|
|
case GST_STATE_CHANGE_NULL_TO_READY:
|
|
|
|
case GST_STATE_CHANGE_READY_TO_PAUSED:
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
|
|
|
|
if (ret == GST_STATE_CHANGE_FAILURE)
|
|
|
|
return ret;
|
|
|
|
|
|
|
|
switch (transition) {
|
|
|
|
case GST_STATE_CHANGE_PAUSED_TO_READY:
|
|
|
|
if (sub->subfile) {
|
|
|
|
gst_buffer_unref (sub->subfile);
|
|
|
|
sub->subfile = NULL;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return ret;
|
2007-12-18 09:13:12 +00:00
|
|
|
}
|