add new Kate plugin, for Kate overlay streams

katedec: Kate decoder (text only)
kateenc: Kate encoder (text and DVD SPU only)
katetag: Kate tagger
kateparse: Kate parser
tiger: Kate renderer using the Tiger rendering library

Fixes #525743.
This commit is contained in:
Vincent Penquerc'h 2009-02-15 18:35:04 +00:00 committed by Tim-Philipp Müller
parent 114425d7ee
commit e88984ccbd
26 changed files with 6039 additions and 2 deletions

View file

@ -85,6 +85,8 @@ textoverlay pango (http://www.pango.org/)
dirac (http://www.bbc.co.uk/rd/projects/dirac/)
effectv (Our ports was relicensed)(http://effectv.sourceforge.net/)
musepack (http://www.musepack.net/)
kate libtiger (http://libtiger.googlecode.com/)
Optional, only for the tiger element
Plugins which use a BSD covered library are as follows:
@ -93,6 +95,7 @@ vorbis libogg/libvorbis (http://www.xiph.org/ogg/vorbis/)
gsttheora libtheora (http://www.theora.org/)
speex (http://www.speex.org/)
flac libFLAC (http://flac.sourceforge.net/)
kate libkate (http://libkate.googlecode.com/)
Plugins based on libraries with other free licenses:

View file

@ -118,9 +118,11 @@ libtheora (for Ogg Theora video support)
libmms (for MMS protocol support)
(http://www.sf.net/projects/libmms)
libamrnb (for AMR-NB support)
(http://http://www.penguin.cz/~utx/amr)
(http://www.penguin.cz/~utx/amr)
libamrwb (for AMR-WB support)
(http://http://www.penguin.cz/~utx/amr)
(http://www.penguin.cz/~utx/amr)
libkate (for Kate support)
(http://libkate.googlecode.com/)
Optional (debian) packages:

View file

@ -944,6 +944,30 @@ AG_GST_CHECK_FEATURE(JP2K, [jp2k], jp2kdec jp2kenc, [
AC_SUBST(JP2K_LIBS)
])
dnl *** kate ***
translit(dnm, m, l) AM_CONDITIONAL(USE_KATE, true)
AG_GST_CHECK_FEATURE(KATE, [Kate], kate, [
PKG_CHECK_MODULES(KATE, kate >= 0.1.7, HAVE_KATE="yes", [
HAVE_KATE="no"
AC_MSG_RESULT(no)
])
AC_SUBST(KATE_CFLAGS)
AC_SUBST(KATE_LIBS)
PKG_CHECK_MODULES(TIGER, tiger >= 0.3.2,
[
HAVE_TIGER="yes"
AC_DEFINE(HAVE_TIGER, 1, [Define if libtiger is available])
],
[
HAVE_TIGER="no"
AC_MSG_RESULT(no)
]
)
AM_CONDITIONAL(USE_TIGER, test "x$HAVE_TIGER" = "xyes")
AC_SUBST(TIGER_CFLAGS)
AC_SUBST(TIGER_LIBS)
])
dnl *** ladspa ***
translit(dnm, m, l) AM_CONDITIONAL(USE_LADSPA, true)
AG_GST_CHECK_FEATURE(LADSPA, [ladspa], ladspa, [
@ -1526,6 +1550,7 @@ AM_CONDITIONAL(USE_THEORADEC, false)
AM_CONDITIONAL(USE_TIMIDITY, false)
AM_CONDITIONAL(USE_XVID, false)
AM_CONDITIONAL(USE_WILDMIDI, false)
AM_CONDITIONAL(USE_KATE, false)
AM_CONDITIONAL(USE_WININET, false)
AM_CONDITIONAL(USE_ACM, false)
AM_CONDITIONAL(USE_VDPAU, false)
@ -1698,6 +1723,7 @@ ext/gsm/Makefile
ext/ivorbis/Makefile
ext/jack/Makefile
ext/jp2k/Makefile
ext/kate/Makefile
ext/ladspa/Makefile
ext/lv2/Makefile
ext/libmms/Makefile

View file

@ -100,6 +100,11 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/ivorbis/vorbisdec.h \
$(top_srcdir)/ext/jack/gstjackaudiosrc.h \
$(top_srcdir)/ext/jack/gstjackaudiosink.h \
$(top_srcdir)/ext/kate/gstkateenc.h \
$(top_srcdir)/ext/kate/gstkatedec.h \
$(top_srcdir)/ext/kate/gstkateparse.h \
$(top_srcdir)/ext/kate/gstkatetag.h \
$(top_srcdir)/ext/kate/gstkatetiger.h \
$(top_srcdir)/ext/musicbrainz/gsttrm.h \
$(top_srcdir)/ext/metadata/gstbasemetadata.h \
$(top_srcdir)/ext/metadata/gstmetadatademux.h \

View file

@ -50,6 +50,10 @@
<xi:include href="xml/element-ivorbisdec.xml" />
<xi:include href="xml/element-jackaudiosrc.xml" />
<xi:include href="xml/element-jackaudiosink.xml" />
<xi:include href="xml/element-kateenc.xml" />
<xi:include href="xml/element-katedec.xml" />
<xi:include href="xml/element-kateparse.xml" />
<xi:include href="xml/element-katetag.xml" />
<xi:include href="xml/element-legacyresample.xml" />
<xi:include href="xml/element-liveadder.xml" />
<xi:include href="xml/element-metadatademux.xml" />
@ -76,6 +80,7 @@
<xi:include href="xml/element-speed.xml" />
<xi:include href="xml/element-stereo.xml" />
<!--xi:include href="xml/element-theoradecexp.xml" /-->
<xi:include href="xml/element-tiger.xml" />
<xi:include href="xml/element-timidity.xml" />
<xi:include href="xml/element-trm.xml" />
<xi:include href="xml/element-valve.xml" />
@ -120,6 +125,7 @@
<xi:include href="xml/plugin-gstrtpmanager.xml" />
<xi:include href="xml/plugin-h264parse.xml" />
<xi:include href="xml/plugin-jack.xml" />
<xi:include href="xml/plugin-kate.xml" />
<xi:include href="xml/plugin-ladspa.xml" />
<xi:include href="xml/plugin-liveadder.xml" />
<xi:include href="xml/plugin-metadata.xml" />

View file

@ -471,6 +471,76 @@ GstLiveAdderFunction
gst_live_adder_get_type
</SECTION>
<SECTION>
<FILE>element-katedec</FILE>
<TITLE>katedec</TITLE>
GstKateDec
<SUBSECTION Standard>
GstKateDecClass
GST_KATE_DEC
GST_KATE_DEC_CLASS
GST_IS_KATE_DEC
GST_IS_KATE_DEC_CLASS
GST_TYPE_KATE_DEC
gst_kate_dec_get_type
</SECTION>
<SECTION>
<FILE>element-kateenc</FILE>
<TITLE>kateenc</TITLE>
GstKateEnc
<SUBSECTION Standard>
GstKateEncClass
GST_KATE_ENC
GST_KATE_ENC_CLASS
GST_IS_KATE_ENC
GST_IS_KATE_ENC_CLASS
GST_TYPE_KATE_ENC
gst_kate_enc_get_type
</SECTION>
<SECTION>
<FILE>element-kateparse</FILE>
<TITLE>kateparse</TITLE>
GstKateParse
<SUBSECTION Standard>
GstKateParseClass
GST_KATE_PARSE
GST_KATE_PARSE_CLASS
GST_IS_KATE_PARSE
GST_IS_KATE_PARSE_CLASS
GST_TYPE_KATE_PARSE
gst_kate_parse_get_type
</SECTION>
<SECTION>
<FILE>element-katetag</FILE>
<TITLE>katetag</TITLE>
GstKateTag
<SUBSECTION Standard>
GstKateTagClass
GST_KATE_TAG
GST_KATE_TAG_CLASS
GST_IS_KATE_TAG
GST_IS_KATE_TAG_CLASS
GST_TYPE_KATE_TAG
gst_kate_tag_get_type
</SECTION>
<SECTION>
<FILE>element-tiger</FILE>
<TITLE>tiger</TITLE>
GstKateTiger
<SUBSECTION Standard>
GstKateTigerClass
GST_KATE_TIGER
GST_KATE_TIGER_CLASS
GST_IS_KATE_TIGER
GST_IS_KATE_TIGER_CLASS
GST_TYPE_KATE_TIGER
gst_kate_tiger_get_type
</SECTION>
<SECTION>
<FILE>gstbasemetadata</FILE>
<TITLE>GstBaseMetadata</TITLE>

View file

@ -148,6 +148,12 @@ else
JP2K_DIR =
endif
if USE_KATE
KATE_DIR=kate
else
KATE_DIR=
endif
if USE_LADSPA
LADSPA_DIR = ladspa
else
@ -362,6 +368,7 @@ SUBDIRS=\
$(IVORBIS_DIR) \
$(JACK_DIR) \
$(JP2K_DIR) \
$(KATE_DIR) \
$(LADSPA_DIR) \
$(LV2_DIR) \
$(LCS_DIR) \
@ -411,6 +418,7 @@ DIST_SUBDIRS = \
ladspa \
jack \
jp2k \
kate \
libmms \
lv2 \
dts \

20
ext/kate/Makefile.am Normal file
View file

@ -0,0 +1,20 @@
# plugindir is set in configure
plugin_LTLIBRARIES = libgstkate.la
# sources used to compile this plug-in
libgstkate_la_SOURCES = gstkate.c gstkatedec.c gstkateenc.c gstkateparse.c gstkatetag.c gstkateutil.c
if USE_TIGER
libgstkate_la_SOURCES += gstkatetiger.c
endif
# flags used to compile this plugin
libgstkate_la_CFLAGS = $(GST_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(TIGER_CFLAGS) $(KATE_CFLAGS)
libgstkate_la_LIBADD = $(GST_PLUGIN_BASE_LIBS) -lgsttag-$(GST_MAJORMINOR) $(GST_LIBS) $(TIGER_LIBS) $(KATE_LIBS)
libgstkate_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
libgstkate_la_LIBTOOLFLAGS = --tag=disable-static
# headers we need but don't want installed
noinst_HEADERS = gstkate.h gstkatedec.h gstkateenc.h gstkateparse.h gstkatetag.h gstkateutil.h gstkatetiger.h
EXTRA_DIST=README

20
ext/kate/README Normal file
View file

@ -0,0 +1,20 @@
Kate is a free codec for text based data, which can also carry images.
It is typically used to create overlays on a video.
libkate, a codec for Kate streams, is required to build this plugin:
http://libkate.googlecode.com/
libtiger, a rendering library for Kate streams, is optional:
http://libtiger.googlecode.com/
The Kate plugin contains various elements to manipulate Kate streams:
- katedec: decodes Kate streams to text
- kateenc: encodes Kate streams from text and SPU images
- kateparse: parses Kate streams
- katetag: allows changing metadata in Kate streams
- tiger: decodes and renders Kate streams using libtiger (needs libtiger)
More information about Kate can be found at:
http://wiki.xiph.org/index.php/OggKate

150
ext/kate/gstkate.c Normal file
View file

@ -0,0 +1,150 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <gst/gst.h>
#include "gstkate.h"
#include "gstkatedec.h"
#include "gstkateenc.h"
#include "gstkateparse.h"
#include "gstkatetag.h"
#ifdef HAVE_TIGER
#include "gstkatetiger.h"
#endif
GST_DEBUG_CATEGORY (gst_katedec_debug);
GST_DEBUG_CATEGORY (gst_kateenc_debug);
GST_DEBUG_CATEGORY (gst_kateparse_debug);
GST_DEBUG_CATEGORY (gst_katetag_debug);
#ifdef HAVE_TIGER
GST_DEBUG_CATEGORY (gst_katetiger_debug);
#endif
static GstStaticCaps kate_caps = GST_STATIC_CAPS (GST_KATE_MIME_TYPE);
#define KATE_CAPS (gst_static_caps_get(&kate_caps))
static void
gst_kate_type_find (GstTypeFind * tf, gpointer private)
{
guint8 *data = gst_type_find_peek (tf, 0, 8);
if (data) {
if (memcmp (data, "\200kate\0\0\0", 8) != 0)
return;
gst_type_find_suggest (tf, GST_TYPE_FIND_MAXIMUM, KATE_CAPS);
}
}
/* entry point to initialize the plug-in
* initialize the plug-in itself
* register the element factories and pad templates
* register the features
*/
static gboolean
plugin_init (GstPlugin * plugin)
{
GstCaps *caps;
caps = gst_caps_new_simple (GST_KATE_MIME_TYPE, NULL);
if (!gst_type_find_register (plugin, GST_KATE_MIME_TYPE, GST_RANK_PRIMARY,
gst_kate_type_find, NULL, caps, NULL, NULL)) {
GST_WARNING ("kate: failed to register typefind");
gst_caps_unref (caps);
return FALSE;
}
gst_caps_unref (caps);
GST_DEBUG_CATEGORY_INIT (gst_katedec_debug, "katedec", 0, "Kate decoder");
GST_DEBUG_CATEGORY_INIT (gst_kateenc_debug, "kateenc", 0, "Kate encoder");
GST_DEBUG_CATEGORY_INIT (gst_kateparse_debug, "kateparse", 0, "Kate parser");
GST_DEBUG_CATEGORY_INIT (gst_katetag_debug, "katetag", 0, "Kate tagger");
#ifdef HAVE_TIGER
GST_DEBUG_CATEGORY_INIT (gst_katetiger_debug, "tiger", 0,
"Kate Tiger renderer");
#endif
/* if we don't build tiger, we'll want to autoplug and convert to text,
but if we do build tiger, we'll want to use it preferentially as it
can play non text streams too */
if (!gst_element_register (plugin, "katedec", GST_RANK_PRIMARY,
GST_TYPE_KATE_DEC))
return FALSE;
if (!gst_element_register (plugin, "kateenc", GST_RANK_NONE,
GST_TYPE_KATE_ENC))
return FALSE;
if (!gst_element_register (plugin, "kateparse", GST_RANK_NONE,
GST_TYPE_KATE_PARSE))
return FALSE;
if (!gst_element_register (plugin, "katetag", GST_RANK_NONE,
GST_TYPE_KATE_TAG))
return FALSE;
#ifdef HAVE_TIGER
if (!gst_element_register (plugin, "tiger", GST_RANK_NONE,
GST_TYPE_KATE_TIGER))
return FALSE;
#endif
return TRUE;
}
/* this is the structure that gstreamer looks for to register plugins
*/
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR,
"kate",
"Kate plugin",
plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)

55
ext/kate/gstkate.h Normal file
View file

@ -0,0 +1,55 @@
/*
* GStreamer
* Copyright (C) 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
#ifndef __GST_KATE_H__
#define __GST_KATE_H__
#include <gst/gst.h>
G_BEGIN_DECLS
#define GST_KATE_MIME_TYPE "application/x-kate"
G_END_DECLS
#endif /* __GST_KATE_H__ */

318
ext/kate/gstkatedec.c Normal file
View file

@ -0,0 +1,318 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
/**
* SECTION:element-katedec
* @see_also: oggdemux
*
* <refsect2>
* <para>
* This element decodes Kate streams
* <ulink url="http://libkate.googlecode.com/">Kate</ulink> is a free codec
* for text based data, such as subtitles. Any number of kate streams can be
* embedded in an Ogg stream.
* </para>
* <para>
* libkate (see above url) is needed to build this plugin.
* </para>
* <title>Example pipeline</title>
* <para>
* This explicitely decodes a Kate stream:
* <programlisting>
* gst-launch filesrc location=test.ogg ! oggdemux ! katedec ! fakesink silent=TRUE
* </programlisting>
* </para>
* <para>
* This will automatically detect and use any Kate streams multiplexed
* in an Ogg stream:
* <programlisting>
* gst-launch playbin uri=file:///tmp/test.ogg
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <gst/gst.h>
#include "gstkate.h"
#include "gstkatedec.h"
GST_DEBUG_CATEGORY_EXTERN (gst_katedec_debug);
#define GST_CAT_DEFAULT gst_katedec_debug
/* Filter signals and args */
enum
{
/* FILL ME */
LAST_SIGNAL
};
enum
{
ARG_REMOVE_MARKUP = DECODER_BASE_ARG_COUNT
};
static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (GST_KATE_MIME_TYPE)
);
static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("text/plain; text/x-pango-markup")
);
GST_BOILERPLATE (GstKateDec, gst_kate_dec, GstElement, GST_TYPE_ELEMENT);
static void gst_kate_dec_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_kate_dec_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstFlowReturn gst_kate_dec_chain (GstPad * pad, GstBuffer * buf);
static GstStateChangeReturn gst_kate_dec_change_state (GstElement * element,
GstStateChange transition);
static gboolean gst_kate_dec_sink_query (GstPad * pad, GstQuery * query);
static void
gst_kate_dec_base_init (gpointer gclass)
{
static GstElementDetails element_details =
GST_ELEMENT_DETAILS ("Kate stream text decoder",
"Codec/Decoder/Subtitle",
"Decodes Kate text streams",
"Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>");
GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&src_factory));
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&sink_factory));
gst_element_class_set_details (element_class, &element_details);
}
/* initialize the plugin's class */
static void
gst_kate_dec_class_init (GstKateDecClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *gstelement_class;
gobject_class = (GObjectClass *) klass;
gstelement_class = (GstElementClass *) klass;
gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_kate_dec_set_property);
gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_kate_dec_get_property);
gst_kate_util_install_decoder_base_properties (gobject_class);
g_object_class_install_property (gobject_class, ARG_REMOVE_MARKUP,
g_param_spec_boolean ("remove-markup", "Remove markup",
"Remove markup from decoded text ?", FALSE, G_PARAM_READWRITE));
gstelement_class->change_state =
GST_DEBUG_FUNCPTR (gst_kate_dec_change_state);
}
/* initialize the new element
* instantiate pads and add them to element
* set functions
* initialize structure
*/
static void
gst_kate_dec_init (GstKateDec * dec, GstKateDecClass * gclass)
{
GST_DEBUG_OBJECT (dec, "gst_kate_dec_init");
dec->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
gst_pad_set_chain_function (dec->sinkpad,
GST_DEBUG_FUNCPTR (gst_kate_dec_chain));
gst_pad_set_query_function (dec->sinkpad,
GST_DEBUG_FUNCPTR (gst_kate_dec_sink_query));
gst_pad_use_fixed_caps (dec->sinkpad);
gst_pad_set_caps (dec->sinkpad,
gst_static_pad_template_get_caps (&sink_factory));
gst_element_add_pad (GST_ELEMENT (dec), dec->sinkpad);
dec->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
gst_element_add_pad (GST_ELEMENT (dec), dec->srcpad);
gst_kate_util_decode_base_init (&dec->decoder);
dec->remove_markup = FALSE;
}
static void
gst_kate_dec_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
switch (prop_id) {
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_kate_dec_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstKateDec *kd = GST_KATE_DEC (object);
switch (prop_id) {
case ARG_REMOVE_MARKUP:
g_value_set_boolean (value, kd->remove_markup);
break;
default:
if (!gst_kate_util_decoder_base_get_property (&kd->decoder, object,
prop_id, value, pspec)) {
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
break;
}
}
/* GstElement vmethod implementations */
/* chain function
* this function does the actual processing
*/
static GstFlowReturn
gst_kate_dec_chain (GstPad * pad, GstBuffer * buf)
{
GstKateDec *kd = GST_KATE_DEC (gst_pad_get_parent (pad));
const kate_event *ev = NULL;
GstFlowReturn rflow = GST_FLOW_OK;
rflow =
gst_kate_util_decoder_base_chain_kate_packet (&kd->decoder,
GST_ELEMENT_CAST (kd), pad, buf, kd->srcpad, &ev);
if (G_UNLIKELY (rflow != GST_FLOW_OK)) {
gst_object_unref (kd);
gst_buffer_unref (buf);
return rflow;
}
if (ev) {
gchar *escaped;
GstBuffer *buffer;
size_t len;
if (kd->remove_markup && ev->text_markup_type != kate_markup_none) {
size_t len0 = ev->len + 1;
escaped = g_strdup (ev->text);
if (escaped) {
kate_text_remove_markup (ev->text_encoding, escaped, &len0);
}
} else if (ev->text_markup_type == kate_markup_none) {
/* no pango markup yet, escape text */
/* TODO: actually do the pango thing */
escaped = g_markup_printf_escaped ("%s", ev->text);
} else {
escaped = g_strdup (ev->text);
}
if (G_LIKELY (escaped)) {
len = strlen (escaped);
GST_DEBUG_OBJECT (kd, "kate event: %s, escaped %s", ev->text, escaped);
buffer = gst_buffer_new_and_alloc (len + 1);
if (G_LIKELY (buffer)) {
/* allocate and copy the NULs, but don't include them in passed size */
memcpy (GST_BUFFER_DATA (buffer), escaped, len + 1);
GST_BUFFER_SIZE (buffer) = len;
GST_BUFFER_TIMESTAMP (buffer) = ev->start_time * GST_SECOND;
GST_BUFFER_DURATION (buffer) =
(ev->end_time - ev->start_time) * GST_SECOND;
gst_buffer_set_caps (buffer, GST_PAD_CAPS (kd->srcpad));
rflow = gst_pad_push (kd->srcpad, buffer);
if (rflow == GST_FLOW_NOT_LINKED) {
GST_DEBUG_OBJECT (kd, "source pad not linked, ignored");
} else if (rflow != GST_FLOW_OK) {
GST_WARNING_OBJECT (kd, "failed to push buffer: %s",
gst_flow_get_name (rflow));
}
} else {
GST_WARNING_OBJECT (kd, "failed to create buffer");
rflow = GST_FLOW_ERROR;
}
g_free (escaped);
} else {
GST_WARNING_OBJECT (kd, "failed to allocate string");
rflow = GST_FLOW_ERROR;
}
}
gst_object_unref (kd);
gst_buffer_unref (buf);
return rflow;
}
static GstStateChangeReturn
gst_kate_dec_change_state (GstElement * element, GstStateChange transition)
{
GstKateDec *kd = GST_KATE_DEC (element);
return gst_kate_decoder_base_change_state (&kd->decoder, element,
parent_class, transition);
}
gboolean
gst_kate_dec_sink_query (GstPad * pad, GstQuery * query)
{
GstKateDec *kd = GST_KATE_DEC (gst_pad_get_parent (pad));
gboolean res =
gst_kate_decoder_base_sink_query (&kd->decoder, GST_ELEMENT_CAST (kd),
pad, query);
gst_object_unref (kd);
return res;
}

88
ext/kate/gstkatedec.h Normal file
View file

@ -0,0 +1,88 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
#ifndef __GST_KATE_DEC_H__
#define __GST_KATE_DEC_H__
#include <kate/kate.h>
#include <gst/gst.h>
#include "gstkateutil.h"
G_BEGIN_DECLS
/* #defines don't like whitespacey bits */
#define GST_TYPE_KATE_DEC \
(gst_kate_dec_get_type())
#define GST_KATE_DEC(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_KATE_DEC,GstKateDec))
#define GST_KATE_DEC_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_KATE,GstKateDecClass))
#define GST_IS_KATE_DEC(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_KATE_DEC))
#define GST_IS_KATE_DEC_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_KATE_DEC))
typedef struct _GstKateDec GstKateDec;
typedef struct _GstKateDecClass GstKateDecClass;
struct _GstKateDec
{
GstElement element;
GstPad *sinkpad;
GstPad *srcpad;
GstKateDecoderBase decoder;
gboolean remove_markup;
};
struct _GstKateDecClass
{
GstElementClass parent_class;
};
GType gst_kate_dec_get_type (void);
G_END_DECLS
#endif /* __GST_KATE_DEC_H__ */

1834
ext/kate/gstkateenc.c Normal file

File diff suppressed because it is too large Load diff

120
ext/kate/gstkateenc.h Normal file
View file

@ -0,0 +1,120 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
#ifndef __GST_KATE_ENC_H__
#define __GST_KATE_ENC_H__
#include <gst/gst.h>
#include <kate/kate.h>
G_BEGIN_DECLS
/* #defines don't like whitespacey bits */
#define GST_TYPE_KATE_ENC \
(gst_kate_enc_get_type())
#define GST_KATE_ENC(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_KATE_ENC,GstKateEnc))
#define GST_KATE_ENC_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_KATE,GstKateEncClass))
#define GST_IS_KATE_ENC(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_KATE_ENC))
#define GST_IS_KATE_ENC_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_KATE_ENC))
typedef struct _GstKateEnc GstKateEnc;
typedef struct _GstKateEncClass GstKateEncClass;
struct _GstKateEnc
{
GstElement element;
GstPad *sinkpad, *srcpad;
kate_info ki;
kate_comment kc;
kate_state k;
GstTagList *tags;
GstClockTime last_timestamp;
GstClockTime latest_end_time;
gboolean headers_sent;
gboolean initialized;
gboolean delayed_spu;
GstClockTime delayed_start;
gchar *language;
gchar *category;
int granule_rate_numerator;
int granule_rate_denominator;
int granule_shift;
float keepalive_min_time;
float default_spu_duration;
size_t original_canvas_width;
size_t original_canvas_height;
/* SPU decoding */
guint8 spu_colormap[4];
guint32 spu_clut[16];
guint8 spu_alpha[4];
guint16 spu_top;
guint16 spu_left;
guint16 spu_right;
guint16 spu_bottom;
guint16 spu_pix_data[2];
guint16 show_time;
guint16 hide_time;
};
struct _GstKateEncClass
{
GstElementClass parent_class;
};
GType gst_kate_enc_get_type (void);
G_END_DECLS
#endif /* __GST_KATE_ENC_H__ */

613
ext/kate/gstkateparse.c Normal file
View file

@ -0,0 +1,613 @@
/* GStreamer
* Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
* Copyright (C) 2006 Andy Wingo <wingo@pobox.com>
* Copyright (C) 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* 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.
*/
/**
* SECTION:element-kateparse
* @short_description: parses kate streams
* @see_also: katedec, vorbisparse, oggdemux, theoraparse
*
* <refsect2>
* <para>
* The kateparse element will parse the header packets of the Kate
* stream and put them as the streamheader in the caps. This is used in the
* multifdsink case where you want to stream live kate streams to multiple
* clients, each client has to receive the streamheaders first before they can
* consume the kate packets.
* </para>
* <para>
* This element also makes sure that the buffers that it pushes out are properly
* timestamped and that their offset and offset_end are set. The buffers that
* kateparse outputs have all of the metadata that oggmux expects to receive,
* which allows you to (for example) remux an ogg/kate file.
* </para>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* gst-launch -v filesrc location=kate.ogg ! oggdemux ! kateparse ! fakesink
* </programlisting>
* This pipeline shows that the streamheader is set in the caps, and that each
* buffer has the timestamp, duration, offset, and offset_end set.
* </para>
* <para>
* <programlisting>
* gst-launch filesrc location=kate.ogg ! oggdemux ! kateparse \
* ! oggmux ! filesink location=kate-remuxed.ogg
* </programlisting>
* This pipeline shows remuxing. kate-remuxed.ogg might not be exactly the same
* as kate.ogg, but they should produce exactly the same decoded data.
* </para>
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include "gstkate.h"
#include "gstkateutil.h"
#include "gstkateparse.h"
GST_DEBUG_CATEGORY_EXTERN (gst_kateparse_debug);
#define GST_CAT_DEFAULT gst_kateparse_debug
static const GstElementDetails gst_kate_parse_details =
GST_ELEMENT_DETAILS ("Kate stream parser",
"Codec/Parser/Subtitle",
"parse raw kate streams",
"Vincent Penquerc'h <ogg.k.ogg.k at googlemail dot com>");
static GstStaticPadTemplate gst_kate_parse_sink_factory =
GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (GST_KATE_MIME_TYPE)
);
static GstStaticPadTemplate gst_kate_parse_src_factory =
GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (GST_KATE_MIME_TYPE)
);
GST_BOILERPLATE (GstKateParse, gst_kate_parse, GstElement, GST_TYPE_ELEMENT);
static GstFlowReturn gst_kate_parse_chain (GstPad * pad, GstBuffer * buffer);
static GstStateChangeReturn gst_kate_parse_change_state (GstElement * element,
GstStateChange transition);
static gboolean gst_kate_parse_sink_event (GstPad * pad, GstEvent * event);
static gboolean gst_kate_parse_src_query (GstPad * pad, GstQuery * query);
#if 0
static gboolean gst_kate_parse_convert (GstPad * pad,
GstFormat src_format, gint64 src_value,
GstFormat * dest_format, gint64 * dest_value);
#endif
static GstFlowReturn gst_kate_parse_parse_packet (GstKateParse * parse,
GstBuffer * buf);
static void
gst_kate_parse_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&gst_kate_parse_src_factory));
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&gst_kate_parse_sink_factory));
gst_element_class_set_details (element_class, &gst_kate_parse_details);
}
static void
gst_kate_parse_class_init (GstKateParseClass * klass)
{
GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
gstelement_class->change_state = gst_kate_parse_change_state;
klass->parse_packet = GST_DEBUG_FUNCPTR (gst_kate_parse_parse_packet);
}
static void
gst_kate_parse_init (GstKateParse * parse, GstKateParseClass * g_class)
{
parse->sinkpad =
gst_pad_new_from_static_template (&gst_kate_parse_sink_factory, "sink");
gst_pad_set_chain_function (parse->sinkpad,
GST_DEBUG_FUNCPTR (gst_kate_parse_chain));
gst_pad_set_event_function (parse->sinkpad,
GST_DEBUG_FUNCPTR (gst_kate_parse_sink_event));
gst_element_add_pad (GST_ELEMENT (parse), parse->sinkpad);
parse->srcpad =
gst_pad_new_from_static_template (&gst_kate_parse_src_factory, "src");
gst_pad_set_query_function (parse->srcpad,
GST_DEBUG_FUNCPTR (gst_kate_parse_src_query));
gst_element_add_pad (GST_ELEMENT (parse), parse->srcpad);
}
static void
gst_kate_parse_drain_event_queue (GstKateParse * parse)
{
while (parse->event_queue->length) {
GstEvent *event;
event = GST_EVENT_CAST (g_queue_pop_head (parse->event_queue));
gst_pad_event_default (parse->sinkpad, event);
}
}
static GstFlowReturn
gst_kate_parse_push_headers (GstKateParse * parse)
{
/* mark and put on caps */
GstCaps *caps;
GstBuffer *outbuf;
kate_packet packet;
GList *headers, *outbuf_list = NULL;
int ret;
gboolean res;
/* get the headers into the caps, passing them to kate as we go */
caps =
gst_kate_util_set_header_on_caps (&parse->element,
gst_pad_get_caps (parse->srcpad), parse->streamheader);
if (G_UNLIKELY (!caps)) {
GST_ERROR_OBJECT (parse, "Failed to set headers on caps");
return GST_FLOW_ERROR;
}
GST_DEBUG_OBJECT (parse, "here are the caps: %" GST_PTR_FORMAT, caps);
res = gst_pad_set_caps (parse->srcpad, caps);
gst_caps_unref (caps);
if (G_UNLIKELY (!res)) {
GST_WARNING_OBJECT (parse, "Failed to set pad caps");
return GST_FLOW_ERROR;
}
headers = parse->streamheader;
while (headers) {
outbuf = GST_BUFFER_CAST (headers->data);
kate_packet_wrap (&packet, GST_BUFFER_SIZE (outbuf),
GST_BUFFER_DATA (outbuf));
ret = kate_decode_headerin (&parse->ki, &parse->kc, &packet);
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (parse, "kate_decode_headerin returned %d", ret);
}
outbuf_list = g_list_append (outbuf_list, outbuf);
headers = headers->next;
}
/* first process queued events */
gst_kate_parse_drain_event_queue (parse);
/* push out buffers, ignoring return value... */
headers = outbuf_list;
while (headers) {
outbuf = GST_BUFFER_CAST (headers->data);
gst_buffer_set_caps (outbuf, GST_PAD_CAPS (parse->srcpad));
gst_pad_push (parse->srcpad, outbuf);
headers = headers->next;
}
g_list_free (outbuf_list);
parse->streamheader_sent = TRUE;
return GST_FLOW_OK;
}
static void
gst_kate_parse_clear_queue (GstKateParse * parse)
{
GST_DEBUG_OBJECT (parse, "Clearing queue");
while (parse->buffer_queue->length) {
GstBuffer *buf;
buf = GST_BUFFER_CAST (g_queue_pop_head (parse->buffer_queue));
gst_buffer_unref (buf);
}
while (parse->event_queue->length) {
GstEvent *event;
event = GST_EVENT_CAST (g_queue_pop_head (parse->event_queue));
gst_event_unref (event);
}
}
static GstFlowReturn
gst_kate_parse_push_buffer (GstKateParse * parse, GstBuffer * buf,
gint64 granulepos)
{
GST_LOG_OBJECT (parse, "granulepos %16llx", granulepos);
if (granulepos < 0) {
/* packets coming not from Ogg won't have a granpos in the offset end,
so we have to synthesize one here - only problem is we don't know
the backlink - pretend there's none for now */
GST_INFO_OBJECT (parse, "No granulepos on buffer, synthesizing one");
granulepos =
kate_duration_granule (&parse->ki,
GST_BUFFER_TIMESTAMP (buf) /
(double) GST_SECOND) << kate_granule_shift (&parse->ki);
}
GST_BUFFER_OFFSET (buf) =
kate_granule_time (&parse->ki, granulepos) * GST_SECOND;
GST_BUFFER_OFFSET_END (buf) = granulepos;
GST_BUFFER_TIMESTAMP (buf) = GST_BUFFER_OFFSET (buf);
/* Hack to flush each packet on its own page - taken off the CMML encoder element */
/* TODO: this is shite and needs to go once I find a way to tell Ogg to flush
as it messes up Matroska's track duration */
GST_BUFFER_DURATION (buf) = G_MAXINT64;
gst_buffer_set_caps (buf, GST_PAD_CAPS (parse->srcpad));
return gst_pad_push (parse->srcpad, buf);
}
static GstFlowReturn
gst_kate_parse_drain_queue_prematurely (GstKateParse * parse)
{
GstFlowReturn ret = GST_FLOW_OK;
/* got an EOS event, make sure to push out any buffers that were in the queue
* -- won't normally be the case, but this catches the
* didn't-get-a-granulepos-on-the-last-packet case. Assuming a continuous
* stream. */
/* if we got EOS before any buffers came, go ahead and push the other events
* first */
gst_kate_parse_drain_event_queue (parse);
while (!g_queue_is_empty (parse->buffer_queue)) {
GstBuffer *buf;
gint64 granpos;
buf = GST_BUFFER_CAST (g_queue_pop_head (parse->buffer_queue));
granpos = GST_BUFFER_OFFSET_END (buf);
ret = gst_kate_parse_push_buffer (parse, buf, granpos);
if (ret != GST_FLOW_OK)
goto done;
}
g_assert (g_queue_is_empty (parse->buffer_queue));
done:
return ret;
}
static GstFlowReturn
gst_kate_parse_drain_queue (GstKateParse * parse, gint64 granulepos)
{
GstFlowReturn ret = GST_FLOW_OK;
if (!g_queue_is_empty (parse->buffer_queue)) {
GstBuffer *buf;
buf = GST_BUFFER_CAST (g_queue_pop_head (parse->buffer_queue));
ret = gst_kate_parse_push_buffer (parse, buf, granulepos);
if (ret != GST_FLOW_OK)
goto done;
}
g_assert (g_queue_is_empty (parse->buffer_queue));
done:
return ret;
}
static GstFlowReturn
gst_kate_parse_queue_buffer (GstKateParse * parse, GstBuffer * buf)
{
GstFlowReturn ret = GST_FLOW_OK;
gint64 granpos;
buf = gst_buffer_make_metadata_writable (buf);
/* oggdemux stores the granule pos in the offset end */
granpos = GST_BUFFER_OFFSET_END (buf);
GST_LOG_OBJECT (parse, "granpos %16llx", granpos);
g_queue_push_tail (parse->buffer_queue, buf);
#if 1
/* if getting buffers from matroska, we won't have a granpos here... */
//if (GST_BUFFER_OFFSET_END_IS_VALID (buf)) {
ret = gst_kate_parse_drain_queue (parse, granpos);
//}
#else
if (granpos >= 0) {
ret = gst_kate_parse_drain_queue (parse, granpos);
} else {
GST_WARNING_OBJECT (parse, "granulepos < 0 (%lld)", granpos);
ret = GST_FLOW_ERROR;
}
#endif
return ret;
}
static GstFlowReturn
gst_kate_parse_parse_packet (GstKateParse * parse, GstBuffer * buf)
{
GstFlowReturn ret = GST_FLOW_OK;
g_assert (parse);
parse->packetno++;
GST_LOG_OBJECT (parse, "Got packet %02x, %u bytes",
GST_BUFFER_SIZE (buf) ? GST_BUFFER_DATA (buf)[0] : -1,
GST_BUFFER_SIZE (buf));
if (GST_BUFFER_SIZE (buf) > 0 && GST_BUFFER_DATA (buf)[0] & 0x80) {
GST_DEBUG_OBJECT (parse, "Found header %02x", GST_BUFFER_DATA (buf)[0]);
/* if 0x80 is set, it's streamheader,
* so put it on the streamheader list and return */
parse->streamheader = g_list_append (parse->streamheader, buf);
ret = GST_FLOW_OK;
} else {
if (!parse->streamheader_sent) {
GST_DEBUG_OBJECT (parse, "Found non header, pushing headers seen so far");
ret = gst_kate_parse_push_headers (parse);
}
if (ret == GST_FLOW_OK) {
ret = gst_kate_parse_queue_buffer (parse, buf);
}
}
return ret;
}
static GstFlowReturn
gst_kate_parse_chain (GstPad * pad, GstBuffer * buffer)
{
GstKateParseClass *klass;
GstKateParse *parse;
parse = GST_KATE_PARSE (GST_PAD_PARENT (pad));
klass = GST_KATE_PARSE_CLASS (G_OBJECT_GET_CLASS (parse));
g_assert (klass->parse_packet != NULL);
return klass->parse_packet (parse, buffer);
}
static gboolean
gst_kate_parse_queue_event (GstKateParse * parse, GstEvent * event)
{
GstFlowReturn ret = TRUE;
g_queue_push_tail (parse->event_queue, event);
return ret;
}
static gboolean
gst_kate_parse_sink_event (GstPad * pad, GstEvent * event)
{
gboolean ret;
GstKateParse *parse;
parse = GST_KATE_PARSE (gst_pad_get_parent (pad));
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_FLUSH_START:
gst_kate_parse_clear_queue (parse);
ret = gst_pad_event_default (pad, event);
break;
case GST_EVENT_EOS:
if (!parse->streamheader_sent) {
GST_DEBUG_OBJECT (parse, "Got EOS, pushing headers seen so far");
ret = gst_kate_parse_push_headers (parse);
if (ret != GST_FLOW_OK)
goto done;
}
gst_kate_parse_drain_queue_prematurely (parse);
ret = gst_pad_event_default (pad, event);
break;
default:
if (!parse->streamheader_sent && GST_EVENT_IS_SERIALIZED (event))
ret = gst_kate_parse_queue_event (parse, event);
else
ret = gst_pad_event_default (pad, event);
break;
}
done:
gst_object_unref (parse);
return ret;
}
#if 0
static gboolean
gst_kate_parse_convert (GstPad * pad,
GstFormat src_format, gint64 src_value,
GstFormat * dest_format, gint64 * dest_value)
{
gboolean res = TRUE;
GstKateParse *parse;
parse = GST_KATE_PARSE (GST_PAD_PARENT (pad));
/* fixme: assumes atomic access to lots of instance variables modified from
* the streaming thread, including 64-bit variables */
if (!parse->streamheader_sent)
return FALSE;
if (src_format == *dest_format) {
*dest_value = src_value;
return TRUE;
}
if (parse->sinkpad == pad &&
(src_format == GST_FORMAT_BYTES || *dest_format == GST_FORMAT_BYTES))
return FALSE;
switch (src_format) {
case GST_FORMAT_TIME:
switch (*dest_format) {
default:
res = FALSE;
}
break;
case GST_FORMAT_DEFAULT:
switch (*dest_format) {
case GST_FORMAT_TIME:
*dest_value = kate_granule_time (&parse->ki, src_value) * GST_SECOND;
break;
default:
res = FALSE;
}
break;
default:
res = FALSE;
}
return res;
}
#endif
static gboolean
gst_kate_parse_src_query (GstPad * pad, GstQuery * query)
{
#if 1
// TODO
GST_WARNING ("gst_kate_parse_src_query");
return FALSE;
#else
gint64 granulepos;
GstKateParse *parse;
gboolean res = FALSE;
parse = GST_KATE_PARSE (GST_PAD_PARENT (pad));
switch (GST_QUERY_TYPE (query)) {
case GST_QUERY_POSITION:
{
GstFormat format;
gint64 value;
granulepos = parse->prev_granulepos;
gst_query_parse_position (query, &format, NULL);
/* and convert to the final format */
if (!(res =
gst_kate_parse_convert (pad, GST_FORMAT_DEFAULT, granulepos,
&format, &value)))
goto error;
/* fixme: support segments
value = (value - parse->segment_start) + parse->segment_time;
*/
gst_query_set_position (query, format, value);
GST_LOG_OBJECT (parse, "query %p: peer returned granulepos: %"
G_GUINT64_FORMAT " - we return %" G_GUINT64_FORMAT " (format %u)",
query, granulepos, value, format);
break;
}
case GST_QUERY_DURATION:
{
/* fixme: not threadsafe */
/* query peer for total length */
if (!gst_pad_is_linked (parse->sinkpad)) {
GST_WARNING_OBJECT (parse, "sink pad %" GST_PTR_FORMAT " is not linked",
parse->sinkpad);
goto error;
}
if (!(res = gst_pad_query (GST_PAD_PEER (parse->sinkpad), query)))
goto error;
break;
}
case GST_QUERY_CONVERT:
{
GstFormat src_fmt, dest_fmt;
gint64 src_val, dest_val;
gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
if (!(res =
gst_kate_parse_convert (pad, src_fmt, src_val, &dest_fmt,
&dest_val)))
goto error;
gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
break;
}
default:
res = gst_pad_query_default (pad, query);
break;
}
return res;
error:
{
GST_WARNING_OBJECT (parse, "error handling query");
return res;
}
#endif
}
static GstStateChangeReturn
gst_kate_parse_change_state (GstElement * element, GstStateChange transition)
{
GstKateParse *parse = GST_KATE_PARSE (element);
GstStateChangeReturn ret;
switch (transition) {
case GST_STATE_CHANGE_READY_TO_PAUSED:
kate_info_init (&parse->ki);
kate_comment_init (&parse->kc);
parse->packetno = 0;
parse->streamheader_sent = FALSE;
parse->streamheader = NULL;
parse->buffer_queue = g_queue_new ();
parse->event_queue = g_queue_new ();
break;
default:
break;
}
ret = parent_class->change_state (element, transition);
switch (transition) {
case GST_STATE_CHANGE_PAUSED_TO_READY:
kate_info_clear (&parse->ki);
kate_comment_clear (&parse->kc);
gst_kate_parse_clear_queue (parse);
g_queue_free (parse->buffer_queue);
parse->buffer_queue = NULL;
g_queue_free (parse->event_queue);
parse->event_queue = NULL;
break;
default:
break;
}
return ret;
}

78
ext/kate/gstkateparse.h Normal file
View file

@ -0,0 +1,78 @@
/* -*- c-basic-offset: 2 -*-
* GStreamer
* Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
* Copyright (C) <2008> Vincent Penquerc'h <ogg.k.ogg.k at googlemail dot com>
*
* 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.
*/
#ifndef __GST_KATE_PARSE_H__
#define __GST_KATE_PARSE_H__
#include <gst/gst.h>
#include <kate/kate.h>
G_BEGIN_DECLS
#define GST_TYPE_KATE_PARSE \
(gst_kate_parse_get_type())
#define GST_KATE_PARSE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_KATE_PARSE,GstKateParse))
#define GST_KATE_PARSE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_KATE_PARSE,GstKateParseClass))
#define GST_IS_KATE_PARSE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_KATE_PARSE))
#define GST_IS_KATKATEE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_KATE_PARSE))
typedef struct _GstKateParse GstKateParse;
typedef struct _GstKateParseClass GstKateParseClass;
/**
* GstKateParse:
*
* Opaque data structure.
*/
struct _GstKateParse
{
GstElement element;
GstPad *sinkpad;
GstPad *srcpad;
guint packetno;
gboolean streamheader_sent;
GList *streamheader;
GQueue *event_queue;
GQueue *buffer_queue;
kate_info ki;
kate_comment kc;
};
struct _GstKateParseClass
{
GstElementClass parent_class;
/* virtual functions */
GstFlowReturn (*parse_packet) (GstKateParse * parse, GstBuffer * buf);
};
GType gst_kate_parse_get_type (void);
G_END_DECLS
#endif /* __GST_KATE_PARSE_H__ */

347
ext/kate/gstkatetag.c Normal file
View file

@ -0,0 +1,347 @@
/*
* GStreamer
* Copyright (C) 2006 James Livingston <doclivingston@gmail.com>
* Copyright (C) 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* 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.
*/
/**
* SECTION:element-katetag
* @see_also: #oggdemux, #oggmux, #kateparse, #GstTagSetter
* @short_description: retags kate streams
*
* <refsect2>
* <para>
* The katetag element can change the tag contained within a raw
* kate stream. Specifically, it modifies the comments header packet
* of the kate stream, as well as the language and category of the
* kate stream.
* </para>
* <para>
* The element will also process the stream as the #kateparse element does
* so it can be used when remuxing an Ogg Kate stream, without additional
* elements.
* </para>
* <para>
* Applications can set the tags to write using the #GstTagSetter interface.
* Tags contained within the kate stream will be picked up
* automatically (and merged according to the merge mode set via the tag
* setter interface).
* </para>
* <title>Example pipelines</title>
* <para>
* This element is only useful with gst-launch for modifying the language
* and/or category (which are properties of the stream located in the kate
* beginning of stream header), because it does not support setting the tags
* on a #GstTagSetter interface. Conceptually, the element will usually be
* used like:
* <programlisting>
* gst-launch -v filesrc location=foo.ogg ! oggdemux ! katetag ! oggmux ! filesink location=bar.ogg
* </programlisting>
* </para>
* <para>
* This pipeline will set the language and category of the stream to the
* given values:
* <programlisting>
* gst-launch -v filesrc location=foo.ogg ! oggdemux ! katetag language=pt_BR category=subtitles ! oggmux ! filesink location=bar.ogg
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <string.h>
#include <glib.h>
#include <gst/tag/tag.h>
#include <gst/gsttagsetter.h>
#include <kate/kate.h>
#include "gstkatetag.h"
GST_DEBUG_CATEGORY_EXTERN (gst_katetag_debug);
#define GST_CAT_DEFAULT gst_katetag_debug
enum
{
ARG_0,
ARG_LANGUAGE,
ARG_CATEGORY,
ARG_ORIGINAL_CANVAS_WIDTH,
ARG_ORIGINAL_CANVAS_HEIGHT,
};
static void gst_kate_tag_base_init (gpointer g_class);
static void gst_kate_tag_class_init (GstKateTagClass * klass);
static void gst_kate_tag_init (GstKateTag * kt, GstKateTagClass * g_class);
static GstFlowReturn gst_kate_tag_parse_packet (GstKateParse * parse,
GstBuffer * buffer);
static void gst_kate_tag_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_kate_tag_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static void gst_kate_tag_dispose (GObject * object);
#define _do_init(type) \
G_STMT_START{ \
static const GInterfaceInfo tag_setter_info = { \
NULL, \
NULL, \
NULL \
}; \
g_type_add_interface_static (type, GST_TYPE_TAG_SETTER, \
&tag_setter_info); \
}G_STMT_END
GST_BOILERPLATE_FULL (GstKateTag, gst_kate_tag, GstKateParse,
GST_TYPE_KATE_PARSE, _do_init);
static GstElementDetails kate_tag_details =
GST_ELEMENT_DETAILS ("Kate stream tagger",
"Formatter/Metadata",
"Retags kate streams",
"Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>");
static void
gst_kate_tag_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
gst_element_class_set_details (element_class, &kate_tag_details);
}
static void
gst_kate_tag_class_init (GstKateTagClass * klass)
{
GObjectClass *gobject_class;
GstKateParseClass *gstkateparse_class;
gobject_class = (GObjectClass *) klass;
gstkateparse_class = GST_KATE_PARSE_CLASS (klass);
gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_kate_tag_set_property);
gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_kate_tag_get_property);
gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_kate_tag_dispose);
g_object_class_install_property (gobject_class, ARG_LANGUAGE,
g_param_spec_string ("language", "Language",
"Set the language of the stream", "", G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_CATEGORY,
g_param_spec_string ("category", "Category",
"Set the category of the stream", "", G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_ORIGINAL_CANVAS_WIDTH,
g_param_spec_int ("original-canvas-width", "Original canvas width",
"Set the width of the canvas this stream was authored for (0 is unspecified)",
0, G_MAXINT, 0, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_ORIGINAL_CANVAS_HEIGHT,
g_param_spec_int ("original-canvas-height", "Original canvas height",
"Set the height of the canvas this stream was authored for (0 is unspecified)",
0, G_MAXINT, 0, G_PARAM_READWRITE));
gstkateparse_class->parse_packet =
GST_DEBUG_FUNCPTR (gst_kate_tag_parse_packet);
}
static void
gst_kate_tag_init (GstKateTag * kt, GstKateTagClass * g_class)
{
kt->language = NULL;
kt->category = NULL;
kt->original_canvas_width = -1;
kt->original_canvas_height = -1;
}
static void
gst_kate_tag_dispose (GObject * object)
{
GstKateTag *kt = GST_KATE_TAG (object);
GST_LOG_OBJECT (kt, "disposing");
if (kt->language) {
g_free (kt->language);
kt->language = NULL;
}
if (kt->category) {
g_free (kt->category);
kt->category = NULL;
}
GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
}
static void
gst_kate_tag_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstKateTag *kt = GST_KATE_TAG (object);
const char *str;
switch (prop_id) {
case ARG_LANGUAGE:
if (kt->language) {
g_free (kt->language);
kt->language = NULL;
}
str = g_value_get_string (value);
if (str)
kt->language = g_strdup (str);
break;
case ARG_CATEGORY:
if (kt->category) {
g_free (kt->category);
kt->category = NULL;
}
str = g_value_get_string (value);
if (str)
kt->category = g_strdup (str);
break;
case ARG_ORIGINAL_CANVAS_WIDTH:
kt->original_canvas_width = g_value_get_int (value);
break;
case ARG_ORIGINAL_CANVAS_HEIGHT:
kt->original_canvas_height = g_value_get_int (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_kate_tag_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstKateTag *kt = GST_KATE_TAG (object);
switch (prop_id) {
case ARG_LANGUAGE:
g_value_set_string (value, kt->language ? kt->language : "");
break;
case ARG_CATEGORY:
g_value_set_string (value, kt->category ? kt->category : "");
break;
case ARG_ORIGINAL_CANVAS_WIDTH:
g_value_set_int (value, kt->original_canvas_width);
break;
case ARG_ORIGINAL_CANVAS_HEIGHT:
g_value_set_int (value, kt->original_canvas_height);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static guint16
encode_canvas_size (size_t size)
{
size_t base = size;
size_t shift = 0;
int value;
while (base & ~((1 << 12) - 1)) {
/* we have a high bit we can't fit, increase shift if we wouldn't lose low bits */
if ((size >> shift) & 1)
return 0;
++shift;
base >>= 1;
}
if (G_UNLIKELY (shift >= 16))
return 0;
/* the size can be represented in our encoding */
value = (base << 4) | shift;
return (guint16) value;
}
static GstFlowReturn
gst_kate_tag_parse_packet (GstKateParse * parse, GstBuffer * buffer)
{
GstTagList *old_tags, *new_tags;
const GstTagList *user_tags;
GstKateTag *kt;
gchar *encoder = NULL;
GstBuffer *new_buf;
kt = GST_KATE_TAG (parse);
/* rewrite the language and category */
if (GST_BUFFER_SIZE (buffer) >= 64 && GST_BUFFER_DATA (buffer)[0] == 0x80) {
buffer = gst_buffer_copy (buffer);
/* language is at offset 32, 16 bytes, zero terminated */
if (kt->language) {
strncpy ((char *) GST_BUFFER_DATA (buffer) + 32, kt->language, 15);
GST_BUFFER_DATA (buffer)[47] = 0;
}
/* category is at offset 48, 16 bytes, zero terminated */
if (kt->category) {
strncpy ((char *) GST_BUFFER_DATA (buffer) + 48, kt->category, 15);
GST_BUFFER_DATA (buffer)[63] = 0;
}
if (kt->original_canvas_width >= 0) {
guint16 v = encode_canvas_size (kt->original_canvas_width);
GST_BUFFER_DATA (buffer)[16] = v & 0xff;
GST_BUFFER_DATA (buffer)[17] = (v >> 8) & 0xff;
}
if (kt->original_canvas_height >= 0) {
guint16 v = encode_canvas_size (kt->original_canvas_height);
GST_BUFFER_DATA (buffer)[18] = v & 0xff;
GST_BUFFER_DATA (buffer)[19] = (v >> 8) & 0xff;
}
}
/* rewrite the comments packet */
if (GST_BUFFER_SIZE (buffer) >= 9 && GST_BUFFER_DATA (buffer)[0] == 0x81) {
old_tags =
gst_tag_list_from_vorbiscomment_buffer (buffer,
(const guint8 *) "\201kate\0\0\0\0", 9, &encoder);
user_tags = gst_tag_setter_get_tag_list (GST_TAG_SETTER (kt));
/* build new tag list */
new_tags = gst_tag_list_merge (user_tags, old_tags,
gst_tag_setter_get_tag_merge_mode (GST_TAG_SETTER (kt)));
gst_tag_list_free (old_tags);
new_buf =
gst_tag_list_to_vorbiscomment_buffer (new_tags,
(const guint8 *) "\201kate\0\0\0\0", 9, encoder);
gst_buffer_copy_metadata (new_buf, buffer, GST_BUFFER_COPY_TIMESTAMPS);
gst_tag_list_free (new_tags);
g_free (encoder);
gst_buffer_unref (buffer);
/* the buffer will have the framing bit used by Vorbis, but we don't use it */
--GST_BUFFER_SIZE (new_buf);
buffer = new_buf;
}
return GST_KATE_PARSE_CLASS (parent_class)->parse_packet (parse, buffer);
}

65
ext/kate/gstkatetag.h Normal file
View file

@ -0,0 +1,65 @@
/* -*- c-basic-offset: 2 -*-
* GStreamer
* Copyright (C) <2006> James Livingston <doclivingston@gmail.com>
* Copyright (C) <2008> Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* 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.
*/
#ifndef __GST_KATE_TAG_H__
#define __GST_KATE_TAG_H__
#include "gstkateparse.h"
G_BEGIN_DECLS
#define GST_TYPE_KATE_TAG \
(gst_kate_tag_get_type())
#define GST_KATE_TAG(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_KATE_TAG,GstKateTag))
#define GST_KATE_TAG_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_KATE_TAG,GstKateTagClass))
#define GST_IS_KATE_TAG(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_KATE_TAG))
#define GST_IS_KATE_TAG_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_KATE_TAG))
typedef struct _GstKateTag GstKateTag;
typedef struct _GstKateTagClass GstKateTagClass;
/**
* GstKateTag:
*
* Opaque data structure.
*/
struct _GstKateTag
{
GstKateParse parse;
gchar *language;
gchar *category;
gint original_canvas_width;
gint original_canvas_height;
};
struct _GstKateTagClass
{
GstKateParseClass parent_class;
};
GType gst_kate_tag_get_type (void);
G_END_DECLS
#endif /* __GST_KATE_TAG_H__ */

802
ext/kate/gstkatetiger.c Normal file
View file

@ -0,0 +1,802 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
/**
* SECTION:element-tiger
* @see_also: katedec
*
* <refsect2>
* <para>
* This element decodes and renders Kate streams
* <ulink url="http://libkate.googlecode.com/">Kate</ulink> is a free codec
* for text based data, such as subtitles. Any number of kate streams can be
* embedded in an Ogg stream.
* </para>
* <para>
* libkate (see above url) and <ulink url="http://libtiger.googlecode.com/">libtiger</ulink>
* are needed to build this element.
* </para>
* <title>Example pipeline</title>
* <para>
* This pipeline renders a Kate stream on top of a Theora video multiplexed
* in the same stream:
* <programlisting>
* gst-launch \
* filesrc location=video.ogg ! oggdemux name=demux \
* demux. ! queue ! theoradec ! ffmpegcolorspace ! tiger name=tiger \
* demux. ! queue ! kateparse ! tiger. \
* tiger. ! ffmpegcolorspace ! autovideosink
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <gst/gst.h>
#include <gst/video/video.h>
#include "gstkate.h"
#include "gstkatetiger.h"
GST_DEBUG_CATEGORY_EXTERN (gst_katetiger_debug);
#define GST_CAT_DEFAULT gst_katetiger_debug
/* Filter signals and args */
enum
{
/* FILL ME */
LAST_SIGNAL
};
enum
{
ARG_DEFAULT_FONT_DESC = DECODER_BASE_ARG_COUNT,
ARG_QUALITY,
ARG_DEFAULT_FONT_EFFECT,
ARG_DEFAULT_FONT_EFFECT_STRENGTH,
ARG_DEFAULT_FONT_RED,
ARG_DEFAULT_FONT_GREEN,
ARG_DEFAULT_FONT_BLUE,
ARG_DEFAULT_FONT_ALPHA,
ARG_DEFAULT_BACKGROUND_RED,
ARG_DEFAULT_BACKGROUND_GREEN,
ARG_DEFAULT_BACKGROUND_BLUE,
ARG_DEFAULT_BACKGROUND_ALPHA,
};
static GstStaticPadTemplate kate_sink_factory =
GST_STATIC_PAD_TEMPLATE ("kate_sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (GST_KATE_MIME_TYPE)
);
static GstStaticPadTemplate video_sink_factory =
GST_STATIC_PAD_TEMPLATE ("video_sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("video/x-raw-rgb, bpp=(int)32, depth=(int)24")
);
static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("video/x-raw-rgb, bpp=(int)32, depth=(int)24")
);
GST_BOILERPLATE (GstKateTiger, gst_kate_tiger, GstElement, GST_TYPE_ELEMENT);
static GType
gst_kate_tiger_font_effect_get_type ()
{
static GType font_effect_type = 0;
if (!font_effect_type) {
static const GEnumValue font_effects[] = {
{tiger_font_plain, "none", "none"},
{tiger_font_shadow, "shadow", "shadow"},
{tiger_font_outline, "outline", "outline"},
{0, NULL, NULL}
};
font_effect_type = g_enum_register_static ("GstFontEffect", font_effects);
}
return font_effect_type;
}
static void gst_kate_tiger_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_kate_tiger_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static void gst_kate_tiger_dispose (GObject * object);
static GstFlowReturn gst_kate_tiger_kate_chain (GstPad * pad, GstBuffer * buf);
static GstFlowReturn gst_kate_tiger_video_chain (GstPad * pad, GstBuffer * buf);
static GstStateChangeReturn gst_kate_tiger_change_state (GstElement * element,
GstStateChange transition);
static gboolean gst_kate_tiger_kate_sink_query (GstPad * pad, GstQuery * query);
static gboolean gst_kate_tiger_kate_event (GstPad * pad, GstEvent * event);
static gboolean gst_kate_tiger_video_set_caps (GstPad * pad, GstCaps * caps);
static gboolean gst_kate_tiger_source_event (GstPad * pad, GstEvent * event);
static void
gst_kate_tiger_base_init (gpointer gclass)
{
static GstElementDetails element_details =
GST_ELEMENT_DETAILS ("Kate stream renderer",
"Codec/Decoder/Video/Overlay",
"Decodes and renders Kate streams on top of a video",
"Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>");
GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&src_factory));
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&kate_sink_factory));
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&video_sink_factory));
gst_element_class_set_details (element_class, &element_details);
}
/* initialize the plugin's class */
static void
gst_kate_tiger_class_init (GstKateTigerClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *gstelement_class;
gobject_class = (GObjectClass *) klass;
gstelement_class = (GstElementClass *) klass;
gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_kate_tiger_get_property);
gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_kate_tiger_set_property);
gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_kate_tiger_dispose);
gst_kate_util_install_decoder_base_properties (gobject_class);
g_object_class_install_property (gobject_class, ARG_QUALITY,
g_param_spec_double ("quality", "Rendering quality",
"Rendering quality (0 is faster, 1 is best and slower)",
0.0, 1.0, 1.0, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_DESC,
g_param_spec_string ("default-font-desc", "Default font description",
"Default font description (Pango style) to render text with",
"", G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_EFFECT,
g_param_spec_enum ("default-font-effect", "Default font effect",
"Whether to apply an effect to text by default, for increased readability",
gst_kate_tiger_font_effect_get_type (),
tiger_font_plain, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
g_object_class_install_property (gobject_class,
ARG_DEFAULT_FONT_EFFECT_STRENGTH,
g_param_spec_double ("default-font-effect-strength",
"Default font effect strength",
"How pronounced should the font effect be (effect dependent)", 0.0,
1.0, 0.5, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_RED,
g_param_spec_int ("default-font-red",
"Default font color (red component)",
"Default font color (red component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_GREEN,
g_param_spec_int ("default-font-green",
"Default font color (green component)",
"Default font color (green component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_BLUE,
g_param_spec_int ("default-font-blue",
"Default font color (blue component)",
"Default font color (blue component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_FONT_ALPHA,
g_param_spec_int ("default-font-alpha",
"Default font color (alpha component)",
"Default font color (alpha component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_BACKGROUND_RED,
g_param_spec_int ("default-background-red",
"Default background color (red component)",
"Default background color (red component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_BACKGROUND_GREEN,
g_param_spec_int ("default-background-green",
"Default background color (green component)",
"Default background color (green component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_BACKGROUND_BLUE,
g_param_spec_int ("default-background-blue",
"Default background color (blue component)",
"Default background color (blue component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
g_object_class_install_property (gobject_class, ARG_DEFAULT_BACKGROUND_ALPHA,
g_param_spec_int ("default-background-alpha",
"Default background color (alpha component)",
"Default background color (alpha component, between 0 and 255) to render text with",
0, 255, 255, G_PARAM_READWRITE));
gstelement_class->change_state =
GST_DEBUG_FUNCPTR (gst_kate_tiger_change_state);
}
/* initialize the new element
* instantiate pads and add them to element
* set functions
* initialize structure
*/
static void
gst_kate_tiger_init (GstKateTiger * tiger, GstKateTigerClass * gclass)
{
GST_DEBUG_OBJECT (tiger, "gst_kate_tiger_init");
tiger->mutex = g_mutex_new ();
tiger->katesinkpad =
gst_pad_new_from_static_template (&kate_sink_factory, "kate_sink");
gst_pad_set_chain_function (tiger->katesinkpad,
GST_DEBUG_FUNCPTR (gst_kate_tiger_kate_chain));
gst_pad_set_query_function (tiger->katesinkpad,
GST_DEBUG_FUNCPTR (gst_kate_tiger_kate_sink_query));
gst_pad_use_fixed_caps (tiger->katesinkpad);
gst_pad_set_caps (tiger->katesinkpad,
gst_static_pad_template_get_caps (&kate_sink_factory));
gst_pad_set_event_function (tiger->katesinkpad, gst_kate_tiger_kate_event);
gst_element_add_pad (GST_ELEMENT (tiger), tiger->katesinkpad);
tiger->videosinkpad =
gst_pad_new_from_static_template (&video_sink_factory, "video_sink");
gst_pad_set_chain_function (tiger->videosinkpad,
GST_DEBUG_FUNCPTR (gst_kate_tiger_video_chain));
//gst_pad_set_query_function (tiger->videosinkpad, GST_DEBUG_FUNCPTR (gst_kate_tiger_video_sink_query));
gst_pad_use_fixed_caps (tiger->videosinkpad);
gst_pad_set_caps (tiger->videosinkpad,
gst_static_pad_template_get_caps (&video_sink_factory));
gst_pad_set_setcaps_function (tiger->videosinkpad,
GST_DEBUG_FUNCPTR (gst_kate_tiger_video_set_caps));
gst_element_add_pad (GST_ELEMENT (tiger), tiger->videosinkpad);
tiger->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
gst_pad_set_event_function (tiger->srcpad, gst_kate_tiger_source_event);
gst_element_add_pad (GST_ELEMENT (tiger), tiger->srcpad);
gst_kate_util_decode_base_init (&tiger->decoder);
tiger->tr = NULL;
tiger->default_font_desc = NULL;
tiger->quality = -1.0;
tiger->default_font_effect = tiger_font_plain;
tiger->default_font_effect_strength = 0.5;
tiger->default_font_r = 255;
tiger->default_font_g = 255;
tiger->default_font_b = 255;
tiger->default_font_a = 255;
tiger->default_background_r = 0;
tiger->default_background_g = 0;
tiger->default_background_b = 0;
tiger->default_background_a = 0;
tiger->video_width = 0;
tiger->video_height = 0;
}
static void
gst_kate_tiger_dispose (GObject * object)
{
GstKateTiger *tiger = GST_KATE_TIGER (object);
GST_LOG_OBJECT (tiger, "disposing");
if (tiger->default_font_desc) {
g_free (tiger->default_font_desc);
tiger->default_font_desc = NULL;
}
g_mutex_free (tiger->mutex);
tiger->mutex = NULL;
GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
}
static void
gst_kate_tiger_update_quality (GstKateTiger * tiger)
{
if (tiger->tr && tiger->quality >= 0.0) {
tiger_renderer_set_quality (tiger->tr, tiger->quality);
}
}
static void
gst_kate_tiger_update_default_font_effect (GstKateTiger * tiger)
{
if (tiger->tr) {
tiger_renderer_set_default_font_effect (tiger->tr,
tiger->default_font_effect, tiger->default_font_effect_strength);
}
}
static void
gst_kate_tiger_update_default_font_color (GstKateTiger * tiger)
{
if (tiger->tr) {
tiger_renderer_set_default_font_color (tiger->tr,
tiger->default_font_r / 255.0,
tiger->default_font_g / 255.0,
tiger->default_font_b / 255.0, tiger->default_font_a / 255.0);
}
}
static void
gst_kate_tiger_update_default_background_color (GstKateTiger * tiger)
{
if (tiger->tr) {
tiger_renderer_set_default_background_fill_color (tiger->tr,
tiger->default_background_r / 255.0,
tiger->default_background_g / 255.0,
tiger->default_background_b / 255.0,
tiger->default_background_a / 255.0);
}
}
static void
gst_kate_tiger_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstKateTiger *tiger = GST_KATE_TIGER (object);
const char *str;
g_mutex_lock (tiger->mutex);
switch (prop_id) {
case ARG_DEFAULT_FONT_DESC:
if (tiger->default_font_desc) {
g_free (tiger->default_font_desc);
tiger->default_font_desc = NULL;
}
str = g_value_get_string (value);
if (str) {
tiger->default_font_desc = g_strdup (str);
if (tiger->tr)
tiger_renderer_set_default_font_description (tiger->tr,
tiger->default_font_desc);
}
break;
case ARG_QUALITY:
tiger->quality = g_value_get_double (value);
gst_kate_tiger_update_quality (tiger);
break;
case ARG_DEFAULT_FONT_EFFECT:
tiger->default_font_effect = g_value_get_enum (value);
gst_kate_tiger_update_default_font_effect (tiger);
break;
case ARG_DEFAULT_FONT_EFFECT_STRENGTH:
tiger->default_font_effect_strength = g_value_get_double (value);
gst_kate_tiger_update_default_font_effect (tiger);
break;
case ARG_DEFAULT_FONT_RED:
tiger->default_font_r = g_value_get_int (value);
gst_kate_tiger_update_default_font_color (tiger);
break;
case ARG_DEFAULT_FONT_GREEN:
tiger->default_font_g = g_value_get_int (value);
gst_kate_tiger_update_default_font_color (tiger);
break;
case ARG_DEFAULT_FONT_BLUE:
tiger->default_font_b = g_value_get_int (value);
gst_kate_tiger_update_default_font_color (tiger);
break;
case ARG_DEFAULT_FONT_ALPHA:
tiger->default_font_a = g_value_get_int (value);
gst_kate_tiger_update_default_font_color (tiger);
break;
case ARG_DEFAULT_BACKGROUND_RED:
tiger->default_background_r = g_value_get_int (value);
gst_kate_tiger_update_default_background_color (tiger);
break;
case ARG_DEFAULT_BACKGROUND_GREEN:
tiger->default_background_g = g_value_get_int (value);
gst_kate_tiger_update_default_background_color (tiger);
break;
case ARG_DEFAULT_BACKGROUND_BLUE:
tiger->default_background_b = g_value_get_int (value);
gst_kate_tiger_update_default_background_color (tiger);
break;
case ARG_DEFAULT_BACKGROUND_ALPHA:
tiger->default_background_a = g_value_get_int (value);
gst_kate_tiger_update_default_background_color (tiger);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
g_mutex_unlock (tiger->mutex);
}
static void
gst_kate_tiger_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstKateTiger *tiger = GST_KATE_TIGER (object);
g_mutex_lock (tiger->mutex);
switch (prop_id) {
case ARG_DEFAULT_FONT_DESC:
g_value_set_string (value,
tiger->default_font_desc ? tiger->default_font_desc : "");
break;
case ARG_QUALITY:
g_value_set_double (value, tiger->quality);
break;
case ARG_DEFAULT_FONT_EFFECT:
g_value_set_enum (value, tiger->default_font_effect);
break;
case ARG_DEFAULT_FONT_EFFECT_STRENGTH:
g_value_set_double (value, tiger->default_font_effect_strength);
break;
case ARG_DEFAULT_FONT_RED:
g_value_set_int (value, tiger->default_font_r);
break;
case ARG_DEFAULT_FONT_GREEN:
g_value_set_int (value, tiger->default_font_g);
break;
case ARG_DEFAULT_FONT_BLUE:
g_value_set_int (value, tiger->default_font_b);
break;
case ARG_DEFAULT_FONT_ALPHA:
g_value_set_int (value, tiger->default_font_a);
break;
case ARG_DEFAULT_BACKGROUND_RED:
g_value_set_int (value, tiger->default_background_r);
break;
case ARG_DEFAULT_BACKGROUND_GREEN:
g_value_set_int (value, tiger->default_background_g);
break;
case ARG_DEFAULT_BACKGROUND_BLUE:
g_value_set_int (value, tiger->default_background_b);
break;
case ARG_DEFAULT_BACKGROUND_ALPHA:
g_value_set_int (value, tiger->default_background_a);
break;
default:
if (!gst_kate_util_decoder_base_get_property (&tiger->decoder, object,
prop_id, value, pspec)) {
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
break;
}
g_mutex_unlock (tiger->mutex);
}
/* GstElement vmethod implementations */
/* chain function
* this function does the actual processing
*/
static GstFlowReturn
gst_kate_tiger_kate_chain (GstPad * pad, GstBuffer * buf)
{
GstKateTiger *tiger = GST_KATE_TIGER (gst_pad_get_parent (pad));
const kate_event *ev = NULL;
GstFlowReturn rflow = GST_FLOW_OK;
g_mutex_lock (tiger->mutex);
GST_LOG_OBJECT (tiger, "Got kate buffer");
rflow =
gst_kate_util_decoder_base_chain_kate_packet (&tiger->decoder,
GST_ELEMENT_CAST (tiger), pad, buf, tiger->srcpad, &ev);
if (G_LIKELY (rflow == GST_FLOW_OK)) {
if (ev) {
int ret = tiger_renderer_add_event (tiger->tr, ev->ki, ev);
GST_INFO_OBJECT (tiger, "adding event for %p from %f to %f: %p, \"%s\"",
ev->ki, ev->start_time, ev->end_time, ev->bitmap, ev->text);
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (tiger,
"failed to add Kate event to Tiger renderer: %d", ret);
}
}
}
gst_object_unref (tiger);
gst_buffer_unref (buf);
g_mutex_unlock (tiger->mutex);
return rflow;
}
static gboolean
gst_kate_tiger_video_set_caps (GstPad * pad, GstCaps * caps)
{
GstKateTiger *tiger = GST_KATE_TIGER (gst_pad_get_parent (pad));
GstStructure *s;
gint w, h;
gboolean res = FALSE;
g_mutex_lock (tiger->mutex);
s = gst_caps_get_structure (caps, 0);
if (G_LIKELY (gst_structure_get_int (s, "width", &w))
&& G_LIKELY (gst_structure_get_int (s, "height", &h))) {
GST_INFO_OBJECT (tiger, "video sink: %d %d", w, h);
tiger->video_width = w;
tiger->video_height = h;
res = TRUE;
}
g_mutex_unlock (tiger->mutex);
gst_object_unref (tiger);
return TRUE;
}
static GstFlowReturn
gst_kate_tiger_video_chain (GstPad * pad, GstBuffer * buf)
{
GstKateTiger *tiger = GST_KATE_TIGER (gst_pad_get_parent (pad));
GstFlowReturn rflow = GST_FLOW_OK;
unsigned char *ptr;
int ret;
g_mutex_lock (tiger->mutex);
GST_LOG_OBJECT (tiger, "got video frame, %u bytes", GST_BUFFER_SIZE (buf));
/* draw on it */
buf = gst_buffer_make_writable (buf);
if (G_UNLIKELY (!buf)) {
GST_WARNING_OBJECT (tiger, "Failed to make video buffer writable");
} else {
ptr = GST_BUFFER_DATA (buf);
if (!ptr) {
GST_WARNING_OBJECT (tiger,
"Failed to get a pointer to video buffer data");
} else {
ret = tiger_renderer_set_buffer (tiger->tr, ptr, tiger->video_width, tiger->video_height, tiger->video_width * 4, 0); // TODO: stride ?
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (tiger,
"Tiger renderer failed to set buffer to video frame: %d", ret);
} else {
kate_float t = GST_BUFFER_TIMESTAMP (buf) / (gdouble) GST_SECOND;
ret = tiger_renderer_update (tiger->tr, t, 1);
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (tiger, "Tiger renderer failed to update: %d",
ret);
} else {
ret = tiger_renderer_render (tiger->tr);
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (tiger,
"Tiger renderer failed to render to video frame: %d", ret);
} else {
GST_LOG_OBJECT (tiger,
"Tiger renderer rendered on video frame at %f", t);
}
}
}
}
}
rflow = gst_pad_push (tiger->srcpad, buf);
gst_object_unref (tiger);
g_mutex_unlock (tiger->mutex);
return rflow;
}
static GstStateChangeReturn
gst_kate_tiger_change_state (GstElement * element, GstStateChange transition)
{
GstKateTiger *tiger = GST_KATE_TIGER (element);
GstStateChangeReturn res;
switch (transition) {
case GST_STATE_CHANGE_PAUSED_TO_READY:
GST_DEBUG_OBJECT (tiger, "PAUSED -> READY, clearing kate state");
g_mutex_lock (tiger->mutex);
if (tiger->tr) {
tiger_renderer_destroy (tiger->tr);
tiger->tr = NULL;
}
g_mutex_unlock (tiger->mutex);
break;
default:
break;
}
res =
gst_kate_decoder_base_change_state (&tiger->decoder, element,
parent_class, transition);
switch (transition) {
case GST_STATE_CHANGE_READY_TO_PAUSED:
GST_DEBUG_OBJECT (tiger, "READY -> PAUSED, initializing kate state");
g_mutex_lock (tiger->mutex);
if (tiger->decoder.initialized) {
int ret = tiger_renderer_create (&tiger->tr);
if (ret < 0) {
GST_WARNING_OBJECT (tiger, "failed to create tiger renderer: %d",
ret);
} else {
ret =
tiger_renderer_set_default_font_description (tiger->tr,
tiger->default_font_desc);
if (ret < 0) {
GST_WARNING_OBJECT (tiger,
"failed to set tiger default font description: %d", ret);
}
gst_kate_tiger_update_default_font_color (tiger);
gst_kate_tiger_update_default_background_color (tiger);
gst_kate_tiger_update_default_font_effect (tiger);
gst_kate_tiger_update_quality (tiger);
}
}
g_mutex_unlock (tiger->mutex);
break;
default:
break;
}
return res;
}
static gboolean
gst_kate_tiger_seek (GstKateTiger * tiger, GstPad * pad, GstEvent * event)
{
GstFormat format;
gdouble rate;
GstSeekFlags flags;
GstSeekType cur_type, stop_type;
gint64 cur, stop;
gst_event_parse_seek (event, &rate, &format, &flags, &cur_type, &cur,
&stop_type, &stop);
/* forward to both sinks */
gst_event_ref (event);
if (gst_pad_push_event (tiger->videosinkpad, event)) {
if (gst_pad_push_event (tiger->katesinkpad, event)) {
if (format == GST_FORMAT_TIME) {
/* if seeking in time, we can update tiger to remove any appropriate events */
kate_float target = cur / (gdouble) GST_SECOND;
GST_INFO_OBJECT (tiger, "Seeking in time to %f", target);
g_mutex_lock (tiger->mutex);
tiger_renderer_seek (tiger->tr, target);
g_mutex_unlock (tiger->mutex);
}
return TRUE;
} else {
return FALSE;
}
} else {
gst_event_unref (event);
return FALSE;
}
}
static gboolean
gst_kate_tiger_source_event (GstPad * pad, GstEvent * event)
{
GstKateTiger *tiger =
(GstKateTiger *) (gst_object_get_parent (GST_OBJECT (pad)));
gboolean res = TRUE;
g_return_val_if_fail (tiger != NULL, FALSE);
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_SEEK:
GST_INFO_OBJECT (tiger, "Seek on source pad");
res = gst_kate_tiger_seek (tiger, pad, event);
break;
default:
res = gst_pad_event_default (pad, event);
break;
}
gst_object_unref (tiger);
return res;
}
static gboolean
gst_kate_tiger_kate_event (GstPad * pad, GstEvent * event)
{
GstKateTiger *tiger =
(GstKateTiger *) (gst_object_get_parent (GST_OBJECT (pad)));
gboolean res = TRUE;
g_return_val_if_fail (tiger != NULL, FALSE);
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_NEWSEGMENT:
GST_INFO_OBJECT (tiger, "New segment on Kate pad");
gst_event_unref (event);
break;
case GST_EVENT_EOS:
/* we ignore this, it just means we don't have anymore Kate packets, but
the Tiger renderer will still draw (if appropriate) on incoming video */
GST_INFO_OBJECT (tiger, "EOS on Kate pad");
gst_event_unref (event);
break;
default:
res = gst_pad_event_default (pad, event);
break;
}
gst_object_unref (tiger);
return res;
}
gboolean
gst_kate_tiger_kate_sink_query (GstPad * pad, GstQuery * query)
{
GstKateTiger *tiger = GST_KATE_TIGER (gst_pad_get_parent (pad));
gboolean res = gst_kate_decoder_base_sink_query (&tiger->decoder,
GST_ELEMENT_CAST (tiger), pad, query);
gst_object_unref (tiger);
return res;
}

108
ext/kate/gstkatetiger.h Normal file
View file

@ -0,0 +1,108 @@
/*
* GStreamer
* Copyright 2005 Thomas Vander Stichele <thomas@apestaart.org>
* Copyright 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* Copyright 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* 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.
*/
#ifndef __GST_KATE_TIGER_H__
#define __GST_KATE_TIGER_H__
#include <kate/kate.h>
#include <tiger/tiger.h>
#include <gst/gst.h>
#include "gstkateutil.h"
G_BEGIN_DECLS
/* #defines don't like whitespacey bits */
#define GST_TYPE_KATE_TIGER \
(gst_kate_tiger_get_type())
#define GST_KATE_TIGER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_KATE_TIGER,GstKateTiger))
#define GST_KATE_TIGER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_KATE,GstKateTigerClass))
#define GST_IS_KATE_TIGER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_KATE_TIGER))
#define GST_IS_KATE_TIGER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_KATE_TIGER))
typedef struct _GstKateTiger GstKateTiger;
typedef struct _GstKateTigerClass GstKateTigerClass;
struct _GstKateTiger
{
GstElement element;
GstPad *katesinkpad;
GstPad *videosinkpad;
GstPad *srcpad;
GstKateDecoderBase decoder;
tiger_renderer *tr;
gdouble quality;
gchar *default_font_desc;
gboolean default_font_effect;
gdouble default_font_effect_strength;
guchar default_font_r;
guchar default_font_g;
guchar default_font_b;
guchar default_font_a;
guchar default_background_r;
guchar default_background_g;
guchar default_background_b;
guchar default_background_a;
gint video_width;
gint video_height;
GMutex *mutex;
};
struct _GstKateTigerClass
{
GstElementClass parent_class;
};
GType gst_kate_tiger_get_type (void);
G_END_DECLS
#endif /* __GST_KATE_TIGER_H__ */

371
ext/kate/gstkateutil.c Normal file
View file

@ -0,0 +1,371 @@
/* GStreamer
* Copyright (C) 2008 Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
*
* 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.
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <gst/tag/tag.h>
#include "gstkate.h"
#include "gstkateutil.h"
GstCaps *
gst_kate_util_set_header_on_caps (GstElement * element, GstCaps * caps,
GList * headers)
{
GstStructure *structure;
GValue array = { 0 };
if (G_UNLIKELY (!caps))
return NULL;
if (G_UNLIKELY (!headers))
return NULL;
caps = gst_caps_make_writable (caps);
structure = gst_caps_get_structure (caps, 0);
g_value_init (&array, GST_TYPE_ARRAY);
while (headers) {
GValue value = { 0 };
GstBuffer *buffer = headers->data;
g_assert (buffer);
GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_IN_CAPS);
g_value_init (&value, GST_TYPE_BUFFER);
/* as in theoraenc, we need to copy to avoid circular references */
buffer = gst_buffer_copy (buffer);
gst_value_set_buffer (&value, buffer);
gst_buffer_unref (buffer);
gst_value_array_append_value (&array, &value);
g_value_unset (&value);
headers = headers->next;
}
gst_structure_set_value (structure, "streamheader", &array);
g_value_unset (&array);
GST_LOG_OBJECT (element, "here are the newly set caps: %" GST_PTR_FORMAT,
caps);
return caps;
}
void
gst_kate_util_install_decoder_base_properties (GObjectClass * gobject_class)
{
g_object_class_install_property (gobject_class, ARG_DEC_BASE_LANGUAGE,
g_param_spec_string ("language", "Language", "The language of the stream",
"", G_PARAM_READABLE));
g_object_class_install_property (gobject_class, ARG_DEC_BASE_CATEGORY,
g_param_spec_string ("category", "Category", "The category of the stream",
"", G_PARAM_READABLE));
g_object_class_install_property (gobject_class,
ARG_DEC_BASE_ORIGINAL_CANVAS_WIDTH,
g_param_spec_int ("original-canvas-width",
"Original canvas width (0 is unspecified)",
"The canvas width this stream was authored for", 0, G_MAXINT, 0,
G_PARAM_READABLE));
g_object_class_install_property (gobject_class,
ARG_DEC_BASE_ORIGINAL_CANVAS_HEIGHT,
g_param_spec_int ("original-canvas-height", "Original canvas height",
"The canvas height this stream was authored for (0 is unspecified)",
0, G_MAXINT, 0, G_PARAM_READABLE));
}
void
gst_kate_util_decode_base_init (GstKateDecoderBase * decoder)
{
if (G_UNLIKELY (!decoder))
return;
decoder->language = NULL;
decoder->category = NULL;
decoder->original_canvas_width = 0;
decoder->original_canvas_height = 0;
decoder->tags = NULL;
decoder->initialized = FALSE;
}
gboolean
gst_kate_util_decoder_base_get_property (GstKateDecoderBase * decoder,
GObject * object, guint prop_id, GValue * value, GParamSpec * pspec)
{
gboolean res = TRUE;
switch (prop_id) {
case ARG_DEC_BASE_LANGUAGE:
g_value_set_string (value, decoder->language);
break;
case ARG_DEC_BASE_CATEGORY:
g_value_set_string (value, decoder->category);
break;
case ARG_DEC_BASE_ORIGINAL_CANVAS_WIDTH:
g_value_set_int (value, decoder->original_canvas_width);
break;
case ARG_DEC_BASE_ORIGINAL_CANVAS_HEIGHT:
g_value_set_int (value, decoder->original_canvas_height);
break;
default:
res = FALSE;
break;
}
return res;
}
GstFlowReturn
gst_kate_util_decoder_base_chain_kate_packet (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstBuffer * buf, GstPad * srcpad,
const kate_event ** ev)
{
kate_packet kp;
int ret;
GstFlowReturn rflow = GST_FLOW_OK;
GST_DEBUG_OBJECT (element, "got kate packet, %u bytes, type %02x",
GST_BUFFER_SIZE (buf),
GST_BUFFER_SIZE (buf) == 0 ? -1 : GST_BUFFER_DATA (buf)[0]);
kate_packet_wrap (&kp, GST_BUFFER_SIZE (buf), GST_BUFFER_DATA (buf));
ret = kate_high_decode_packetin (&decoder->k, &kp, ev);
if (G_UNLIKELY (ret < 0)) {
GST_WARNING_OBJECT (element, "kate_high_decode_packetin failed (%d)", ret);
return GST_FLOW_ERROR;
} else if (G_UNLIKELY (ret > 0)) {
GST_DEBUG_OBJECT (element,
"kate_high_decode_packetin has received EOS packet");
return GST_FLOW_OK;
}
/* headers may be interesting to retrieve information from */
if (G_LIKELY (GST_BUFFER_SIZE (buf) > 0))
switch (GST_BUFFER_DATA (buf)[0]) {
GstCaps *caps;
case 0x80: /* ID header */
GST_INFO_OBJECT (element, "Parsed ID header: language %s, category %s",
decoder->k.ki->language, decoder->k.ki->category);
caps = gst_caps_new_simple ("text/x-pango-markup", NULL);
gst_pad_set_caps (srcpad, caps);
gst_caps_unref (caps);
if (decoder->k.ki->language && *decoder->k.ki->language) {
GstTagList *tags = gst_tag_list_new ();
if (tags) {
gst_tag_list_add (tags, GST_TAG_MERGE_APPEND, GST_TAG_LANGUAGE_CODE,
decoder->k.ki->language, NULL);
// TODO: category - where should it go ?
decoder->tags =
gst_tag_list_merge (decoder->tags, tags, GST_TAG_MERGE_REPLACE);
gst_tag_list_free (tags);
}
}
/* update properties */
if (decoder->language)
g_free (decoder->language);
decoder->language = g_strdup (decoder->k.ki->language);
if (decoder->category)
g_free (decoder->category);
decoder->category = g_strdup (decoder->k.ki->category);
decoder->original_canvas_width = decoder->k.ki->original_canvas_width;
decoder->original_canvas_height = decoder->k.ki->original_canvas_height;
break;
case 0x81: /* Vorbis comments header */
GST_INFO_OBJECT (element, "Parsed comments header");
{
gchar *encoder = NULL;
GstTagList *list = gst_tag_list_from_vorbiscomment_buffer (buf,
(const guint8 *) "\201kate\0\0\0\0", 9, &encoder);
if (list) {
decoder->tags =
gst_tag_list_merge (decoder->tags, list, GST_TAG_MERGE_REPLACE);
gst_tag_list_free (list);
}
if (!decoder->tags) {
GST_ERROR_OBJECT (element, "failed to decode comment header");
decoder->tags = gst_tag_list_new ();
}
if (encoder) {
gst_tag_list_add (decoder->tags, GST_TAG_MERGE_REPLACE,
GST_TAG_ENCODER, encoder, NULL);
g_free (encoder);
}
gst_tag_list_add (decoder->tags, GST_TAG_MERGE_REPLACE, GST_TAG_CODEC,
"kate", NULL);
gst_tag_list_add (decoder->tags, GST_TAG_MERGE_REPLACE,
GST_TAG_ENCODER_VERSION, decoder->k.ki->bitstream_version_major,
NULL);
if (decoder->initialized) {
gst_element_found_tags_for_pad (element, srcpad, decoder->tags);
decoder->tags = NULL;
} else {
/* Only push them as messages for the time being. *
* They will be pushed on the pad once the decoder is initialized */
gst_element_post_message (element,
gst_message_new_tag (GST_OBJECT (element),
gst_tag_list_copy (decoder->tags)));
}
}
break;
default:
break;
}
return rflow;
}
GstStateChangeReturn
gst_kate_decoder_base_change_state (GstKateDecoderBase * decoder,
GstElement * element, GstElementClass * parent_class,
GstStateChange transition)
{
GstStateChangeReturn res;
int ret;
switch (transition) {
case GST_STATE_CHANGE_NULL_TO_READY:
break;
case GST_STATE_CHANGE_READY_TO_PAUSED:
GST_DEBUG_OBJECT (element, "READY -> PAUSED, initializing kate state");
ret = kate_high_decode_init (&decoder->k);
if (ret < 0) {
GST_WARNING_OBJECT (element, "failed to initialize kate state: %d",
ret);
}
decoder->initialized = TRUE;
break;
case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
break;
default:
break;
}
res = parent_class->change_state (element, transition);
switch (transition) {
case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
break;
case GST_STATE_CHANGE_PAUSED_TO_READY:
GST_DEBUG_OBJECT (element, "PAUSED -> READY, clearing kate state");
if (decoder->initialized) {
kate_high_decode_clear (&decoder->k);
decoder->initialized = FALSE;
}
break;
case GST_STATE_CHANGE_READY_TO_NULL:
break;
default:
break;
}
return res;
}
static GstClockTime
gst_kate_util_granule_time (kate_state * k, gint64 granulepos)
{
if (G_UNLIKELY (granulepos == -1))
return -1;
return kate_granule_time (k->ki, granulepos) * GST_SECOND;
}
/*
conversions on the sink:
- default is granules at num/den rate (subject to the granule shift)
- default -> time is possible
- bytes do not mean anything, packets can be any number of bytes, and we
have no way to know the number of bytes emitted without decoding
conversions on the source:
- nothing
*/
gboolean
gst_kate_decoder_base_convert (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstFormat src_fmt, gint64 src_val,
GstFormat * dest_fmt, gint64 * dest_val)
{
gboolean res = FALSE;
if (src_fmt == *dest_fmt) {
*dest_val = src_val;
return TRUE;
}
if (!decoder->initialized) {
GST_WARNING_OBJECT (element, "not initialized yet");
return FALSE;
}
if (src_fmt == GST_FORMAT_BYTES || *dest_fmt == GST_FORMAT_BYTES) {
GST_WARNING_OBJECT (element, "unsupported format");
return FALSE;
}
switch (src_fmt) {
case GST_FORMAT_DEFAULT:
switch (*dest_fmt) {
case GST_FORMAT_TIME:
*dest_val = gst_kate_util_granule_time (&decoder->k, src_val);
res = TRUE;
break;
default:
res = FALSE;
break;
}
break;
default:
res = FALSE;
break;
}
if (!res) {
GST_WARNING_OBJECT (element, "unsupported format");
}
return res;
}
gboolean
gst_kate_decoder_base_sink_query (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstQuery * query)
{
switch (GST_QUERY_TYPE (query)) {
case GST_QUERY_CONVERT:
{
GstFormat src_fmt, dest_fmt;
gint64 src_val, dest_val;
gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
if (!gst_kate_decoder_base_convert (decoder, element, pad, src_fmt,
src_val, &dest_fmt, &dest_val)) {
return gst_pad_query_default (pad, query);
}
gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
return TRUE;
}
default:
return gst_pad_query_default (pad, query);
}
}

77
ext/kate/gstkateutil.h Normal file
View file

@ -0,0 +1,77 @@
/* -*- c-basic-offset: 2 -*-
* GStreamer
* Copyright (C) <2008> Vincent Penquerc'h <ogg.k.ogg.k at googlemail dot com>
*
* 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.
*/
#ifndef __GST_KATE_UTIL_H__
#define __GST_KATE_UTIL_H__
#include <kate/kate.h>
#include <gst/gst.h>
G_BEGIN_DECLS enum
{
ARG_DEC_BASE_0,
ARG_DEC_BASE_LANGUAGE,
ARG_DEC_BASE_CATEGORY,
ARG_DEC_BASE_ORIGINAL_CANVAS_WIDTH,
ARG_DEC_BASE_ORIGINAL_CANVAS_HEIGHT,
DECODER_BASE_ARG_COUNT
};
typedef struct
{
kate_state k;
gboolean initialized;
GstTagList *tags;
gchar *language;
gchar *category;
gint original_canvas_width;
gint original_canvas_height;
} GstKateDecoderBase;
extern GstCaps *gst_kate_util_set_header_on_caps (GstElement * element,
GstCaps * caps, GList * headers);
extern void gst_kate_util_decode_base_init (GstKateDecoderBase * decoder);
extern void gst_kate_util_install_decoder_base_properties (GObjectClass *
gobject_class);
extern gboolean gst_kate_util_decoder_base_get_property (GstKateDecoderBase *
decoder, GObject * object, guint prop_id, GValue * value,
GParamSpec * pspec);
extern GstFlowReturn
gst_kate_util_decoder_base_chain_kate_packet (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstBuffer * buffer, GstPad * srcpad,
const kate_event ** ev);
extern GstStateChangeReturn
gst_kate_decoder_base_change_state (GstKateDecoderBase * decoder,
GstElement * element, GstElementClass * parent_class,
GstStateChange transition);
extern gboolean gst_kate_decoder_base_convert (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstFormat src_fmt, gint64 src_val,
GstFormat * dest_fmt, gint64 * dest_val);
extern gboolean gst_kate_decoder_base_sink_query (GstKateDecoderBase * decoder,
GstElement * element, GstPad * pad, GstQuery * query);
G_END_DECLS
#endif /* __GST_KATE_UTIL_H__ */

View file

@ -158,6 +158,7 @@ rm -rf $RPM_BUILD_ROOT
@USE_CELT_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstcelt.so
@USE_MPEG2ENC_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstmpeg2enc.so
@USE_MPLEX_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstmplex.so
@USE_KATE_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstkate.so
%changelog
* Thu Mar 12 2009 Christian Schaller <chrisian.schaller at collabora dot co uk>

View file

@ -63,6 +63,13 @@ else
check_timidity=
endif
if USE_KATE
check_kate=elements/kate
else
check_kate=
endif
VALGRIND_TO_FIX = \
elements/mpeg2enc \
elements/mplex
@ -78,6 +85,7 @@ check_PROGRAMS = \
$(check_neon) \
$(check_ofa) \
$(check_timidity) \
$(check_kate) \
elements/aacparse \
elements/amrparse \
elements/camerabin \
@ -119,4 +127,7 @@ elements_rtpbin_buffer_list_SOURCES = elements/rtpbin_buffer_list.c
elements_timidity_CFLAGS = $(GST_BASE_CFLAGS) $(AM_CFLAGS)
elements_timidity_LDADD = $(GST_BASE_LIBS) $(LDADD)
elements_kate_CFLAGS = $(GST_BASE_CFLAGS) $(AM_CFLAGS)
elements_kate_LDADD = $(GST_BASE_LIBS) $(LDADD)
EXTRA_DIST = gst-plugins-bad.supp

839
tests/check/elements/kate.c Normal file
View file

@ -0,0 +1,839 @@
/* GStreamer
*
* unit test for kate
*
* Copyright (C) <2007> Stefan Kost <ensonic@users.sf.net>
* Copyright (C) <2008> ogg.k.ogg.k <ogg.k.ogg.k@googlemail.com>
*
* 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.
*/
#include <unistd.h>
#include <gst/check/gstcheck.h>
#include <gst/base/gsttypefindhelper.h>
static const guint8 kate_header_0x80[64] = {
0x80, 0x6b, 0x61, 0x74, 0x65, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x09, 0x00, 0x00, 0x00, 0x20, /* .kate...... ... */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe8, 0x03, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, /* ................ */
0x65, 0x6e, 0x5f, 0x47, 0x42, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* en_GB........... */
0x6e, 0x6f, 0x6e, 0x65, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* none............ */
};
static const guint8 kate_header_0x81[53] = {
0x81, 0x6b, 0x61, 0x74, 0x65, 0x00, 0x00, 0x00, 0x00, 0x15, 0x00, 0x00, 0x00, 0x6c, 0x69, 0x62, /* .kate........lib */
0x6b, 0x61, 0x74, 0x65, 0x20, 0x30, 0x2e, 0x31, 0x2e, 0x30, 0x20, 0x28, 0x54, 0x69, 0x67, 0x65, /* kate 0.1.0 (Tige */
0x72, 0x29, 0x01, 0x00, 0x00, 0x00, 0x0b, 0x00, 0x00, 0x00, 0x54, 0x49, 0x54, 0x4c, 0x45, 0x3d, /* r)........TITLE= */
0x54, 0x69, 0x67, 0x65, 0x72, /* Tiger */
};
static const guint8 kate_header_0x8x[10] = {
0x80, 0x6b, 0x61, 0x74, 0x65, 0x00, 0x00, 0x00, 0x00
};
static const guint8 kate_header_0x88[11] = {
0x88, 0x6b, 0x61, 0x74, 0x65, 0x00, 0x00, 0x00, 0x00, 0x00
};
static const guint8 kate_header_0x00[45] = {
0x00, 0xe8, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xd0, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00, /* ................ */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0e, 0x00, 0x00, 0x00, 0x70, 0x6c, 0x61, /* .............pla */
0x69, 0x6e, 0x20, 0x6f, 0x6c, 0x64, 0x20, 0x74, 0x65, 0x78, 0x74, 0x08, 0x00 /* in old text.. */
};
static const guint8 kate_header_0x01[1] = {
0x01
};
static const guint8 kate_header_0x7f[1] = {
0x7f
};
static const unsigned char kate_spu[] = {
0x00, 0x1b, /* size */
0x00, 0x06, /* commands at offset 6 */
0x45, /* first line data - 2 pixels of colors 0 and 1 */
0x76, /* first line data - 2 pixels of colors 3 and 2 */
0x00, 0x00, /* timestamp */
0x00, 0x06, /* link to next command sequence - points back to the current one to mark no more */
0x06, 0x00, 0x04, 0x00, 0x05, /* pointers to data */
0x05, 0x00, 0x30, 0x04, 0x00, 0x10, 0x02, /* area: 3x1 -> 4x2 */
0x04, 0x0f, 0xff, /* alpha: color 0 transparent, all others opaque */
0x01, /* show */
0xff /* end */
};
/* A lot of these taken from the vorbisdec test */
/* For ease of programming we use globals to keep refs for our floating
* src and sink pads we create; otherwise we always have to do get_pad,
* get_peer, and then remove references in every test function */
static GstPad *mydecsrcpad, *mydecsinkpad;
static GstPad *myencsrcpad, *myencsinkpad;
static GstPad *myparsesrcpad, *myparsesinkpad;
static GstPad *mytagsrcpad, *mytagsinkpad;
static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
static GstElement *
setup_katedec (void)
{
GstElement *katedec;
GST_DEBUG ("setup_katedec");
katedec = gst_check_setup_element ("katedec");
mydecsrcpad = gst_check_setup_src_pad (katedec, &srctemplate, NULL);
mydecsinkpad = gst_check_setup_sink_pad (katedec, &sinktemplate, NULL);
gst_pad_set_active (mydecsrcpad, TRUE);
gst_pad_set_active (mydecsinkpad, TRUE);
return katedec;
}
static void
cleanup_katedec (GstElement * katedec)
{
GST_DEBUG ("cleanup_katedec");
gst_element_set_state (katedec, GST_STATE_NULL);
gst_pad_set_active (mydecsrcpad, FALSE);
gst_pad_set_active (mydecsinkpad, FALSE);
gst_check_teardown_src_pad (katedec);
gst_check_teardown_sink_pad (katedec);
gst_check_teardown_element (katedec);
}
static GstElement *
setup_kateenc (void)
{
GstElement *kateenc;
GST_DEBUG ("setup_kateenc");
kateenc = gst_check_setup_element ("kateenc");
myencsrcpad = gst_check_setup_src_pad (kateenc, &srctemplate, NULL);
myencsinkpad = gst_check_setup_sink_pad (kateenc, &sinktemplate, NULL);
gst_pad_set_active (myencsrcpad, TRUE);
gst_pad_set_active (myencsinkpad, TRUE);
return kateenc;
}
static void
cleanup_kateenc (GstElement * kateenc)
{
GST_DEBUG ("cleanup_kateenc");
gst_element_set_state (kateenc, GST_STATE_NULL);
gst_pad_set_active (myencsrcpad, FALSE);
gst_pad_set_active (myencsinkpad, FALSE);
gst_check_teardown_src_pad (kateenc);
gst_check_teardown_sink_pad (kateenc);
gst_check_teardown_element (kateenc);
}
static GstElement *
setup_kateparse (void)
{
GstElement *kateparse;
GST_DEBUG ("setup_kateparse");
kateparse = gst_check_setup_element ("kateparse");
myparsesrcpad = gst_check_setup_src_pad (kateparse, &srctemplate, NULL);
myparsesinkpad = gst_check_setup_sink_pad (kateparse, &sinktemplate, NULL);
gst_pad_set_active (myparsesrcpad, TRUE);
gst_pad_set_active (myparsesinkpad, TRUE);
return kateparse;
}
static void
cleanup_kateparse (GstElement * kateparse)
{
GST_DEBUG ("cleanup_kateparse");
gst_element_set_state (kateparse, GST_STATE_NULL);
gst_pad_set_active (myparsesrcpad, FALSE);
gst_pad_set_active (myparsesinkpad, FALSE);
gst_check_teardown_src_pad (kateparse);
gst_check_teardown_sink_pad (kateparse);
gst_check_teardown_element (kateparse);
}
static GstElement *
setup_katetag (void)
{
GstElement *katetag;
GST_DEBUG ("setup_katetag");
katetag = gst_check_setup_element ("katetag");
mytagsrcpad = gst_check_setup_src_pad (katetag, &srctemplate, NULL);
mytagsinkpad = gst_check_setup_sink_pad (katetag, &sinktemplate, NULL);
gst_pad_set_active (mytagsrcpad, TRUE);
gst_pad_set_active (mytagsinkpad, TRUE);
return katetag;
}
static void
cleanup_katetag (GstElement * katetag)
{
GST_DEBUG ("cleanup_katetag");
gst_element_set_state (katetag, GST_STATE_NULL);
gst_pad_set_active (mytagsrcpad, FALSE);
gst_pad_set_active (mytagsinkpad, FALSE);
gst_check_teardown_src_pad (katetag);
gst_check_teardown_sink_pad (katetag);
gst_check_teardown_element (katetag);
}
static void
check_buffers (guint expected, gboolean headers_in_caps)
{
GstBuffer *outbuffer;
guint i, num_buffers;
const int num_headers = 9;
unsigned char packet_type;
/* check buffers are the type we expect */
num_buffers = g_list_length (buffers);
fail_unless (num_buffers >= num_headers + expected); /* at least 9 headers, plus a variable number of data packets */
for (i = 0; i < num_buffers; ++i) {
outbuffer = GST_BUFFER (buffers->data);
fail_if (outbuffer == NULL);
fail_if (GST_BUFFER_SIZE (outbuffer) == 0);
if (i < num_headers) {
/* different headers packets */
packet_type = (0x80 | i);
fail_unless (GST_BUFFER_DATA (outbuffer)[0] == packet_type);
/* headers could be in caps, so would have an extra ref */
} else if (i == num_buffers - 1) {
/* eos data packet */
packet_type = 0x7f;
fail_unless (GST_BUFFER_DATA (outbuffer)[0] == packet_type);
} else {
/* data packet */
packet_type = 0;
fail_unless (GST_BUFFER_DATA (outbuffer)[0] >= 0
&& GST_BUFFER_DATA (outbuffer)[0] < 0x7f);
}
buffers = g_list_remove (buffers, outbuffer);
ASSERT_BUFFER_REFCOUNT (outbuffer, "outbuffer", 1);
gst_buffer_unref (outbuffer);
outbuffer = NULL;
}
}
GST_START_TEST (test_kate_typefind)
{
GstTypeFindProbability prob;
const gchar *type;
GstBuffer *buf;
GstCaps *caps = NULL;
buf = gst_buffer_new ();
GST_BUFFER_DATA (buf) = (guint8 *) kate_header_0x80;
GST_BUFFER_SIZE (buf) = sizeof (kate_header_0x80);
GST_BUFFER_OFFSET (buf) = 0;
caps = gst_type_find_helper_for_buffer (NULL, buf, &prob);
fail_unless (caps != NULL);
GST_LOG ("Found type: %" GST_PTR_FORMAT, caps);
type = gst_structure_get_name (gst_caps_get_structure (caps, 0));
fail_unless_equals_string (type, "application/x-kate");
fail_unless (prob > GST_TYPE_FIND_MINIMUM && prob <= GST_TYPE_FIND_MAXIMUM);
gst_buffer_unref (buf);
gst_caps_unref (caps);
}
GST_END_TEST;
GST_START_TEST (test_kate_empty_identification_header)
{
GstElement *katedec;
GstBuffer *inbuffer;
GstBus *bus;
katedec = setup_katedec ();
bus = gst_bus_new ();
fail_unless (gst_element_set_state (katedec,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
inbuffer = gst_buffer_new_and_alloc (0);
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
/* set a bus here so we avoid getting state change messages */
gst_element_set_bus (katedec, bus);
fail_unless_equals_int (gst_pad_push (mydecsrcpad, inbuffer), GST_FLOW_ERROR);
/* ... but it ends up being collected on the global buffer list */
fail_unless_equals_int (g_list_length (buffers), 0);
gst_element_set_bus (katedec, NULL);
/* cleanup */
gst_object_unref (GST_OBJECT (bus));
cleanup_katedec (katedec);
}
GST_END_TEST;
/* FIXME: also tests comment header */
GST_START_TEST (test_kate_identification_header)
{
GstElement *katedec;
GstBuffer *inbuffer;
GstBus *bus;
GstMessage *message;
GstTagList *tag_list;
gchar *language;
gchar *title;
katedec = setup_katedec ();
fail_unless (gst_element_set_state (katedec,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
inbuffer = gst_buffer_new_and_alloc (sizeof (kate_header_0x80));
memcpy (GST_BUFFER_DATA (inbuffer), kate_header_0x80,
sizeof (kate_header_0x80));
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_ref (inbuffer);
gst_element_set_bus (katedec, bus);
/* pushing gives away my reference ... */
fail_unless (gst_pad_push (mydecsrcpad, inbuffer) == GST_FLOW_OK);
/* ... and nothing ends up on the global buffer list */
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_unref (inbuffer);
fail_unless (g_list_length (buffers) == 0);
inbuffer = gst_buffer_new_and_alloc (sizeof (kate_header_0x81));
memcpy (GST_BUFFER_DATA (inbuffer), kate_header_0x81,
sizeof (kate_header_0x81));
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_ref (inbuffer);
/* pushing gives away my reference ... */
fail_unless (gst_pad_push (mydecsrcpad, inbuffer) == GST_FLOW_OK);
/* ... and nothing ends up on the global buffer list */
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_unref (inbuffer);
fail_unless (g_list_length (buffers) == 0);
/* there's a tag message waiting */
fail_if ((message = gst_bus_pop (bus)) == NULL);
gst_message_parse_tag (message, &tag_list);
fail_unless_equals_int (gst_tag_list_get_tag_size (tag_list,
GST_TAG_LANGUAGE_CODE), 1);
fail_unless (gst_tag_list_get_string (tag_list, GST_TAG_LANGUAGE_CODE,
&language));
fail_unless_equals_string (language, "en_GB");
g_free (language);
fail_unless_equals_int (gst_tag_list_get_tag_size (tag_list, "title"), 1);
fail_unless (gst_tag_list_get_string (tag_list, GST_TAG_TITLE, &title));
fail_unless_equals_string (title, "Tiger");
g_free (title);
gst_tag_list_free (tag_list);
gst_message_unref (message);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (katedec, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_katedec (katedec);
}
GST_END_TEST;
GST_START_TEST (test_kate_encode_nothing)
{
GstElement *kateenc;
kateenc = setup_kateenc ();
fail_unless (gst_element_set_state (kateenc,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateenc,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* cleanup */
cleanup_kateenc (kateenc);
}
GST_END_TEST;
GST_START_TEST (test_kate_encode_empty)
{
GstElement *kateenc;
GstBuffer *inbuffer;
GstBus *bus;
GstCaps *caps;
kateenc = setup_kateenc ();
fail_unless (gst_element_set_state (kateenc,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
inbuffer = gst_buffer_new_and_alloc (0);
GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) =
1 * GST_SECOND;
GST_BUFFER_DURATION (inbuffer) = 5 * GST_SECOND;
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_ref (inbuffer);
caps = gst_caps_from_string ("text/plain");
fail_unless (caps != NULL);
gst_buffer_set_caps (inbuffer, caps);
gst_caps_unref (caps);
gst_element_set_bus (kateenc, bus);
/* pushing gives away my reference ... */
fail_unless (gst_pad_push (myencsrcpad, inbuffer) == GST_FLOW_ERROR);
fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateenc,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
gst_element_set_bus (kateenc, NULL);
/* cleanup */
gst_object_unref (GST_OBJECT (bus));
cleanup_kateenc (kateenc);
}
GST_END_TEST;
GST_START_TEST (test_kate_encode_simple)
{
GstElement *kateenc;
GstBuffer *inbuffer;
GstBus *bus;
const gchar *test_string = "";
GstCaps *caps;
kateenc = setup_kateenc ();
fail_unless (gst_element_set_state (kateenc,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
inbuffer = gst_buffer_new_and_alloc (strlen (test_string) + 1);
memcpy (GST_BUFFER_DATA (inbuffer), test_string, strlen (test_string) + 1);
GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) =
1 * GST_SECOND;
GST_BUFFER_DURATION (inbuffer) = 5 * GST_SECOND;
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_ref (inbuffer);
caps = gst_caps_from_string ("text/plain");
fail_unless (caps != NULL);
gst_buffer_set_caps (inbuffer, caps);
gst_caps_unref (caps);
gst_element_set_bus (kateenc, bus);
/* pushing gives away my reference ... */
fail_unless (gst_pad_push (myencsrcpad, inbuffer) == GST_FLOW_OK);
/* ... and nothing ends up on the global buffer list */
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_unref (inbuffer);
fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateenc,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* at least one data packet and one EOS packet should have been emitted */
check_buffers (1 + 1, FALSE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (kateenc, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_kateenc (kateenc);
g_list_free (buffers);
}
GST_END_TEST;
GST_START_TEST (test_kate_encode_spu)
{
GstElement *kateenc;
GstBuffer *inbuffer;
GstBus *bus;
GstCaps *caps;
kateenc = setup_kateenc ();
fail_unless (gst_element_set_state (kateenc,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
inbuffer = gst_buffer_new_and_alloc (sizeof (kate_spu));
memcpy (GST_BUFFER_DATA (inbuffer), kate_spu, sizeof (kate_spu));
GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) =
1 * GST_SECOND;
GST_BUFFER_DURATION (inbuffer) = 5 * GST_SECOND;
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_ref (inbuffer);
caps = gst_caps_from_string ("video/x-dvd-subpicture");
fail_unless (caps != NULL);
gst_buffer_set_caps (inbuffer, caps);
gst_caps_unref (caps);
gst_element_set_bus (kateenc, bus);
/* pushing gives away my reference ... */
fail_unless_equals_int (gst_pad_push (myencsrcpad, inbuffer), GST_FLOW_OK);
/* ... and nothing ends up on the global buffer list */
ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
gst_buffer_unref (inbuffer);
fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateenc,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* at least one data packet and one EOS packet should have been emitted */
check_buffers (2, FALSE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (kateenc, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_kateenc (kateenc);
g_list_free (buffers);
}
GST_END_TEST;
GST_START_TEST (test_kate_encode_keepalives)
{
GstElement *kateenc;
GstBus *bus;
guint i, round;
enum
{ n_keepalives = 1000 };
static const struct
{
gdouble keepalive_min_time;
gint packets;
} cfg[3] = {
{
0.5, n_keepalives}, {
2.0, n_keepalives / 2}, {
5.0, n_keepalives / 5},};
for (round = 0; round < 3; ++round) {
kateenc = setup_kateenc ();
fail_unless (gst_element_set_state (kateenc,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
gst_element_set_bus (kateenc, bus);
g_object_set (kateenc, "keepalive-min-time", cfg[round].keepalive_min_time,
NULL);
/* the second one here should not emit a keepalive since the time since last packet
is less than the keepalive delay */
for (i = 1; i <= n_keepalives; ++i) {
gint64 t = i * GST_SECOND;
fail_unless (gst_pad_push_event (myencsrcpad,
gst_event_new_new_segment (TRUE, 1.0, GST_FORMAT_TIME, t, -1,
0)) == TRUE);
}
fail_unless (gst_pad_push_event (myencsrcpad,
gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateenc,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* at least a number data packet and an EOS packet should have been emitted */
check_buffers (cfg[round].packets + 1, FALSE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (kateenc, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_kateenc (kateenc);
g_list_free (buffers);
}
}
GST_END_TEST;
static void
test_kate_send_headers (GstPad * pad)
{
GstBuffer *inbuffer;
int i;
/* push headers */
inbuffer = gst_buffer_new ();
GST_BUFFER_DATA (inbuffer) = (guint8 *) kate_header_0x80;
GST_BUFFER_SIZE (inbuffer) = sizeof (kate_header_0x80);
GST_BUFFER_OFFSET (inbuffer) = GST_BUFFER_OFFSET_END (inbuffer) = 0;
fail_unless_equals_int (gst_pad_push (pad, inbuffer), GST_FLOW_OK);
inbuffer = gst_buffer_new ();
GST_BUFFER_DATA (inbuffer) = (guint8 *) kate_header_0x81;
GST_BUFFER_SIZE (inbuffer) = sizeof (kate_header_0x81);
GST_BUFFER_OFFSET (inbuffer) = GST_BUFFER_OFFSET_END (inbuffer) = 0;
fail_unless_equals_int (gst_pad_push (pad, inbuffer), GST_FLOW_OK);
for (i = 2; i < 8; ++i) {
inbuffer = gst_buffer_new_and_alloc (sizeof (kate_header_0x8x));
memcpy (GST_BUFFER_DATA (inbuffer), (guint8 *) kate_header_0x8x,
sizeof (kate_header_0x8x));
GST_BUFFER_DATA (inbuffer)[0] = 0x80 | i;
GST_BUFFER_OFFSET (inbuffer) = GST_BUFFER_OFFSET_END (inbuffer) = 0;
fail_unless_equals_int (gst_pad_push (pad, inbuffer), GST_FLOW_OK);
}
inbuffer = gst_buffer_new ();
GST_BUFFER_DATA (inbuffer) = (guint8 *) kate_header_0x88;
GST_BUFFER_SIZE (inbuffer) = sizeof (kate_header_0x88);
GST_BUFFER_OFFSET (inbuffer) = GST_BUFFER_OFFSET_END (inbuffer) = 0;
fail_unless_equals_int (gst_pad_push (pad, inbuffer), GST_FLOW_OK);
}
GST_START_TEST (test_kate_parse)
{
GstElement *kateparse;
GstBuffer *inbuffer;
GstBus *bus;
kateparse = setup_kateparse ();
fail_unless (gst_element_set_state (kateparse,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
gst_element_set_bus (kateparse, bus);
test_kate_send_headers (myparsesrcpad);
/* push a text packet */
inbuffer = gst_buffer_new ();
GST_BUFFER_DATA (inbuffer) = (guint8 *) kate_header_0x00;
GST_BUFFER_SIZE (inbuffer) = sizeof (kate_header_0x00);
GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) =
1 * GST_SECOND;
GST_BUFFER_DURATION (inbuffer) = 5 * GST_SECOND;
GST_BUFFER_OFFSET_END (inbuffer) = (GST_BUFFER_TIMESTAMP (inbuffer) << 32); /* granpos */
fail_unless_equals_int (gst_pad_push (myparsesrcpad, inbuffer), GST_FLOW_OK);
/* push a eos packet */
inbuffer = gst_buffer_new ();
GST_BUFFER_DATA (inbuffer) = (guint8 *) kate_header_0x7f;
GST_BUFFER_SIZE (inbuffer) = sizeof (kate_header_0x7f);
GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) =
6 * GST_SECOND;
GST_BUFFER_DURATION (inbuffer) = 0;
GST_BUFFER_OFFSET_END (inbuffer) = (GST_BUFFER_TIMESTAMP (inbuffer) << 32); /* granpos */
fail_unless_equals_int (gst_pad_push (myparsesrcpad, inbuffer), GST_FLOW_OK);
/* signal eos */
fail_unless (gst_pad_push_event (myparsesrcpad,
gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (kateparse,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* at least one data packet and one EOS packet should have been emitted */
check_buffers (2, TRUE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (kateparse, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_kateparse (kateparse);
g_list_free (buffers);
}
GST_END_TEST;
GST_START_TEST (test_kate_tag_passthrough)
{
GstElement *katetag;
GstBus *bus;
GstBuffer *outbuffer;
GList *list;
katetag = setup_katetag ();
fail_unless (gst_element_set_state (katetag,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
gst_element_set_bus (katetag, bus);
test_kate_send_headers (mytagsrcpad);
/* signal eos */
fail_unless (gst_pad_push_event (mytagsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (katetag,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* get the first buffer and check language/category */
fail_unless (g_list_length (buffers) >= 2); /* ID header, Vorbis comments header */
outbuffer = GST_BUFFER (buffers->data);
fail_if (outbuffer == NULL);
/* check identification header is unchanged */
list = g_list_nth (buffers, 0);
fail_unless (list != NULL);
outbuffer = list->data;
fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
sizeof (kate_header_0x80));
fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer), kate_header_0x80,
sizeof (kate_header_0x80)), 0);
/* check comment header is unchanged */
list = g_list_nth (buffers, 1);
fail_unless (list != NULL);
outbuffer = list->data;
fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
sizeof (kate_header_0x81));
fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer), kate_header_0x81,
sizeof (kate_header_0x81)), 0);
/* all headers should have been emitted, but no particular packets */
check_buffers (0, TRUE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (katetag, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_katetag (katetag);
g_list_free (buffers);
}
GST_END_TEST;
GST_START_TEST (test_kate_tag)
{
GstElement *katetag;
GstBus *bus;
GstBuffer *outbuffer;
katetag = setup_katetag ();
fail_unless (gst_element_set_state (katetag,
GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
"could not set to playing");
bus = gst_bus_new ();
gst_element_set_bus (katetag, bus);
g_object_set (katetag, "language", "cy", NULL);
g_object_set (katetag, "category", "subtitles", NULL);
test_kate_send_headers (mytagsrcpad);
/* signal eos */
fail_unless (gst_pad_push_event (mytagsrcpad, gst_event_new_eos ()) == TRUE);
fail_unless (gst_element_set_state (katetag,
GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
"could not set to ready");
/* get the first buffer and check language/category */
fail_unless (g_list_length (buffers) >= 1);
outbuffer = GST_BUFFER (buffers->data);
fail_if (outbuffer == NULL);
fail_if (GST_BUFFER_SIZE (outbuffer) != 64);
fail_if (strcmp ((const char *) GST_BUFFER_DATA (outbuffer) + 32, "cy"));
fail_if (strcmp ((const char *) GST_BUFFER_DATA (outbuffer) + 48,
"subtitles"));
/* all headers should have been emitted, but no particular packets */
check_buffers (0, TRUE);
/* cleanup */
gst_bus_set_flushing (bus, TRUE);
gst_element_set_bus (katetag, NULL);
gst_object_unref (GST_OBJECT (bus));
cleanup_katetag (katetag);
g_list_free (buffers);
}
GST_END_TEST;
Suite *
kate_suite (void)
{
Suite *s = suite_create ("kate");
TCase *tc_chain = tcase_create ("general");
suite_add_tcase (s, tc_chain);
#define X if (0)
tcase_add_test (tc_chain, test_kate_typefind);
tcase_add_test (tc_chain, test_kate_empty_identification_header);
tcase_add_test (tc_chain, test_kate_identification_header);
tcase_add_test (tc_chain, test_kate_encode_nothing);
tcase_add_test (tc_chain, test_kate_encode_empty);
tcase_add_test (tc_chain, test_kate_encode_simple);
tcase_add_test (tc_chain, test_kate_encode_spu);
tcase_add_test (tc_chain, test_kate_encode_keepalives);
tcase_add_test (tc_chain, test_kate_parse);
tcase_add_test (tc_chain, test_kate_tag_passthrough);
tcase_add_test (tc_chain, test_kate_tag);
#undef X
return s;
}
int
main (int argc, char **argv)
{
int nf;
Suite *s = kate_suite ();
SRunner *sr = srunner_create (s);
gst_check_init (&argc, &argv);
srunner_run_all (sr, CK_NORMAL);
nf = srunner_ntests_failed (sr);
srunner_free (sr);
return nf;
}