gstreamer/ext/metadata/gstmetadatamux.c

612 lines
16 KiB
C
Raw Normal View History

/*
* GStreamer
* Copyright 2007 Edgard Lima <edgard.lima@indt.org.br>
*
* 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-metadatamux
*
* <refsect2>
* <para>
* This element writes tags into metadata (EXIF, IPTC and XMP) chunks, and
* writes the chunks into image files (JPEG, PNG). Tags the are received as
* GST_EVENT_TAG event or set by the application using #GstTagSetter interface.
* </para>
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v -m filesrc location=orig.jpeg ! metadatamux ! filesink
* location=dest.jpeg
* </programlisting>
* <programlisting>
* gst-launch -v -m filesrc location=orig.png ! metadatademux ! pngdec !
* ffmpegcolorspace ! jpegenc ! metadatamux ! filesink location=dest.jpeg
* </programlisting>
* </para>
* <title>How it works</title>
* <para>
* If this element receives a GST_TAG_EXIF, GST_TAG_IPTC or GST_TAG_XMP which
* are whole chunk metadata tags, then this whole chunk will be modified by
* individual tags received and written to the file. Otherwise, a new chunk
* will be created from the scratch and then modified in same way.
* </para>
* </refsect2>
*/
/*
* includes
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <gst/gst.h>
#include "gstmetadatamux.h"
#include "metadataiptc.h"
#include "metadataxmp.h"
#include <string.h>
/*
* enum and types
*/
enum
{
LAST_SIGNAL
};
enum
{
ARG_0,
ARG_EXIF_BYTE_ORDER,
};
/*
* defines and static global vars
*/
GST_DEBUG_CATEGORY (gst_metadata_mux_debug);
#define GST_CAT_DEFAULT gst_metadata_mux_debug
#define GOTO_DONE_IF_NULL(ptr) \
do { if ( NULL == (ptr) ) goto done; } while(FALSE)
#define GOTO_DONE_IF_NULL_AND_FAIL(ptr, ret) \
do { if ( NULL == (ptr) ) { (ret) = FALSE; goto done; } } while(FALSE)
#define DEFAULT_EXIF_BYTE_ORDER GST_META_EXIF_BYTE_ORDER_MOTOROLA
static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("image/jpeg, tags-extracted = (bool) true;"
"image/png, tags-extracted = (bool) true")
);
static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("image/jpeg; " "image/png")
);
static GstMetadataMuxClass *metadata_parent_class = NULL;
/*
* static helper functions declaration
*/
static gboolean gst_metadata_mux_configure_srccaps (GstMetadataMux * filter);
/*
* GObject callback functions declaration
*/
static void gst_metadata_mux_base_init (gpointer gclass);
static void gst_metadata_mux_class_init (GstMetadataMuxClass * klass);
static void
gst_metadata_mux_init (GstMetadataMux * filter, GstMetadataMuxClass * gclass);
static void gst_metadata_mux_dispose (GObject * object);
static void gst_metadata_mux_finalize (GObject * object);
static void gst_metadata_mux_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_metadata_mux_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstStateChangeReturn gst_metadata_mux_change_state (GstElement * element,
GstStateChange transition);
/*
* GstBaseMetadata virtual functions declaration
*/
static void gst_metadata_mux_create_chunks_from_tags (GstBaseMetadata * base);
static gboolean gst_metadata_mux_set_caps (GstPad * pad, GstCaps * caps);
static GstCaps *gst_metadata_mux_get_caps (GstPad * pad);
static gboolean gst_metadata_mux_sink_event (GstPad * pad, GstEvent * event);
/*
* GST BOILERPLATE
*/
static void
gst_metadata_mux_add_interfaces (GType type)
{
static const GInterfaceInfo tag_setter_info = { NULL, NULL, NULL };
g_type_add_interface_static (type, GST_TYPE_TAG_SETTER, &tag_setter_info);
}
GST_BOILERPLATE_FULL (GstMetadataMux, gst_metadata_mux, GstBaseMetadata,
GST_TYPE_BASE_METADATA, gst_metadata_mux_add_interfaces);
/*
* static helper functions implementation
*/
static gboolean
gst_metadata_mux_configure_srccaps (GstMetadataMux * filter)
{
GstCaps *caps = NULL;
gboolean ret = FALSE;
gchar *mime = NULL;
switch (GST_BASE_METADATA_IMG_TYPE (filter)) {
case IMG_JPEG:
mime = "image/jpeg";
break;
case IMG_PNG:
mime = "image/png";
break;
default:
ret = FALSE;
goto done;
break;
}
caps = gst_caps_new_simple (mime, NULL);
ret = gst_pad_set_caps (GST_BASE_METADATA_SRC_PAD (filter), caps);
done:
if (caps) {
gst_caps_unref (caps);
caps = NULL;
}
return ret;
}
/*
* GObject callback functions declaration
*/
static void
gst_metadata_mux_base_init (gpointer gclass)
{
/* *INDENT-OFF* */
static GstElementDetails element_details = {
"Metadata muxer",
2009-11-24 12:34:51 +00:00
"Muxer/Formatter/Metadata",
"Write metadata (EXIF, IPTC and XMP) into a image stream",
"Edgard Lima <edgard.lima@indt.org.br>"
};
/* *INDENT-ON* */
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);
}
static void
gst_metadata_mux_class_init (GstMetadataMuxClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *gstelement_class;
GstBaseMetadataClass *gstbasemetadata_class;
gobject_class = (GObjectClass *) klass;
gstelement_class = (GstElementClass *) klass;
gstbasemetadata_class = (GstBaseMetadataClass *) klass;
metadata_parent_class = g_type_class_peek_parent (klass);
gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_metadata_mux_dispose);
gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_metadata_mux_finalize);
gobject_class->set_property = gst_metadata_mux_set_property;
gobject_class->get_property = gst_metadata_mux_get_property;
gstelement_class->change_state =
GST_DEBUG_FUNCPTR (gst_metadata_mux_change_state);
gstbasemetadata_class->processing =
GST_DEBUG_FUNCPTR (gst_metadata_mux_create_chunks_from_tags);
gstbasemetadata_class->set_caps =
GST_DEBUG_FUNCPTR (gst_metadata_mux_set_caps);
gstbasemetadata_class->get_sink_caps =
GST_DEBUG_FUNCPTR (gst_metadata_mux_get_caps);
gstbasemetadata_class->get_src_caps =
GST_DEBUG_FUNCPTR (gst_metadata_mux_get_caps);
gstbasemetadata_class->sink_event =
GST_DEBUG_FUNCPTR (gst_metadata_mux_sink_event);
/**
* GstMetadataMux:exif-byte-order:
*
* Set byte-order for exif metadata writing.
*
* Since: 0.10.11
*/
g_object_class_install_property (gobject_class, ARG_EXIF_BYTE_ORDER,
g_param_spec_enum ("exif-byte-order", "Exif byte-order",
"Byte-order for exif metadata writing", GST_TYPE_META_EXIF_BYTE_ORDER,
DEFAULT_EXIF_BYTE_ORDER, G_PARAM_READWRITE));
}
static void
gst_metadata_mux_init (GstMetadataMux * filter, GstMetadataMuxClass * gclass)
{
gst_base_metadata_set_option_flag (GST_BASE_METADATA (filter),
META_OPT_EXIF | META_OPT_IPTC | META_OPT_XMP | META_OPT_MUX);
filter->exif_options.byteorder = DEFAULT_EXIF_BYTE_ORDER;
}
static void
gst_metadata_mux_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstMetadataMux *filter = GST_METADATA_MUX (object);
switch (prop_id) {
case ARG_EXIF_BYTE_ORDER:
filter->exif_options.byteorder = g_value_get_enum (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_metadata_mux_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstMetadataMux *filter = GST_METADATA_MUX (object);
switch (prop_id) {
case ARG_EXIF_BYTE_ORDER:
g_value_set_enum (value, filter->exif_options.byteorder);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static GstStateChangeReturn
gst_metadata_mux_change_state (GstElement * element, GstStateChange transition)
{
GstStateChangeReturn ret;
GstMetadataMux *filter = GST_METADATA_MUX (element);
switch (transition) {
case GST_STATE_CHANGE_NULL_TO_READY:
break;
case GST_STATE_CHANGE_READY_TO_PAUSED:
break;
case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
break;
default:
break;
}
ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
switch (transition) {
case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
break;
case GST_STATE_CHANGE_PAUSED_TO_READY:
gst_tag_setter_reset_tags (GST_TAG_SETTER (filter));
break;
case GST_STATE_CHANGE_READY_TO_NULL:
break;
default:
break;
}
return ret;
}
static void
gst_metadata_mux_dispose (GObject * object)
{
G_OBJECT_CLASS (metadata_parent_class)->dispose (object);
}
static void
gst_metadata_mux_finalize (GObject * object)
{
G_OBJECT_CLASS (metadata_parent_class)->finalize (object);
}
/*
* GstBaseMetadata virtual functions implementation
*/
/*
* gst_metadata_mux_create_chunks_from_tags:
* @base: the base metadata instance
*
* This function creates new metadata (EXIF, IPTC, XMP) chunks with the tags
* received and add it to the list of segments that will be injected to the
* resulting file by #GstBaseMetadata.
*
* Returns: nothing
*
*/
static void
gst_metadata_mux_create_chunks_from_tags (GstBaseMetadata * base)
{
GstMetadataMux *filter = GST_METADATA_MUX (base);
GstTagSetter *setter = GST_TAG_SETTER (filter);
const GstTagList *taglist = gst_tag_setter_get_tag_list (setter);
guint8 *buf = NULL;
guint32 size = 0;
2009-07-16 15:14:18 +00:00
GST_DEBUG_OBJECT (base, "Creating chunks from tags..");
if (taglist) {
if (gst_base_metadata_get_option_flag (base) & META_OPT_EXIF) {
2009-07-16 15:14:18 +00:00
GST_DEBUG_OBJECT (base, "Using EXIF");
metadatamux_exif_create_chunk_from_tag_list (&buf, &size, taglist,
&filter->exif_options);
gst_base_metadata_update_inject_segment_with_new_data (base, &buf, &size,
MD_CHUNK_EXIF);
}
if (gst_base_metadata_get_option_flag (base) & META_OPT_IPTC) {
2009-07-16 15:14:18 +00:00
GST_DEBUG_OBJECT (base, "Using IPTC");
metadatamux_iptc_create_chunk_from_tag_list (&buf, &size, taglist);
gst_base_metadata_update_inject_segment_with_new_data (base, &buf, &size,
MD_CHUNK_IPTC);
}
if (gst_base_metadata_get_option_flag (base) & META_OPT_XMP) {
2009-07-16 15:14:18 +00:00
GST_DEBUG_OBJECT (base, "Using XMP");
metadatamux_xmp_create_chunk_from_tag_list (&buf, &size, taglist);
gst_base_metadata_update_inject_segment_with_new_data (base, &buf, &size,
MD_CHUNK_XMP);
}
}
2009-07-16 15:14:18 +00:00
else {
GST_DEBUG_OBJECT (base, "Empty taglist");
}
if (buf) {
g_free (buf);
}
}
static gboolean
gst_metadata_mux_set_caps (GstPad * pad, GstCaps * caps)
{
GstMetadataMux *filter = NULL;
GstStructure *structure = NULL;
const gchar *mime = NULL;
gboolean ret = FALSE;
gboolean based = TRUE;
filter = GST_METADATA_MUX (gst_pad_get_parent (pad));
structure = gst_caps_get_structure (caps, 0);
mime = gst_structure_get_name (structure);
if (strcmp (mime, "image/jpeg") == 0) {
GST_BASE_METADATA_IMG_TYPE (filter) = IMG_JPEG;
} else if (strcmp (mime, "image/png") == 0) {
GST_BASE_METADATA_IMG_TYPE (filter) = IMG_PNG;
} else {
ret = FALSE;
goto done;
}
if (gst_structure_get_boolean (structure, "tags-extracted", &based)) {
if (based == FALSE) {
ret = FALSE;
goto done;
}
}
ret = gst_metadata_mux_configure_srccaps (filter);
done:
gst_object_unref (filter);
return ret;
}
static GstCaps *
gst_metadata_mux_get_caps (GstPad * pad)
{
GstMetadataMux *filter = NULL;
GstPad *otherpad;
GstCaps *caps_new = NULL;
GstCaps *caps_otherpad_peer = NULL;
filter = GST_METADATA_MUX (gst_pad_get_parent (pad));
(GST_BASE_METADATA_SRC_PAD (filter) == pad) ?
(otherpad = GST_BASE_METADATA_SINK_PAD (filter)) :
(otherpad = GST_BASE_METADATA_SRC_PAD (filter));
caps_new = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
caps_otherpad_peer = gst_pad_get_allowed_caps (otherpad);
GOTO_DONE_IF_NULL (caps_otherpad_peer);
if (gst_caps_is_empty (caps_otherpad_peer)
|| gst_caps_is_any (caps_otherpad_peer)) {
goto done;
} else {
guint i;
guint caps_size = 0;
caps_size = gst_caps_get_size (caps_otherpad_peer);
gst_caps_unref (caps_new);
caps_new = gst_caps_new_empty ();
for (i = 0; i < caps_size; ++i) {
GstStructure *structure = NULL;
GstStructure *structure_new = NULL;
const gchar *mime = NULL;
structure = gst_caps_get_structure (caps_otherpad_peer, i);
mime = gst_structure_get_name (structure);
if (pad == GST_BASE_METADATA_SINK_PAD (filter)) {
structure_new =
gst_structure_new (mime, "tags-extracted", G_TYPE_BOOLEAN, TRUE,
NULL);
} else {
structure_new = gst_structure_new (mime, NULL);
}
gst_caps_append_structure (caps_new, structure_new);
}
}
done:
if (caps_otherpad_peer) {
gst_caps_unref (caps_otherpad_peer);
caps_otherpad_peer = NULL;
}
gst_object_unref (filter);
return caps_new;
}
static gboolean
gst_metadata_mux_sink_event (GstPad * pad, GstEvent * event)
{
GstMetadataMux *filter = NULL;
gboolean ret = FALSE;
filter = GST_METADATA_MUX (gst_pad_get_parent (pad));
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_TAG:
{
GstTagList *taglist;
GstTagSetter *setter = GST_TAG_SETTER (filter);
const GstTagMergeMode mode = gst_tag_setter_get_tag_merge_mode (setter);
gst_event_parse_tag (event, &taglist);
gst_tag_setter_merge_tags (setter, taglist, mode);
break;
}
default:
break;
}
ret = gst_pad_event_default (pad, event);
gst_object_unref (filter);
return ret;
}
/*
* element plugin init function
*/
gboolean
gst_metadata_mux_plugin_init (GstPlugin * plugin)
{
GST_DEBUG_CATEGORY_INIT (gst_metadata_mux_debug, "metadatamux", 0,
"Metadata muxer");
return gst_element_register (plugin, "metadatamux",
GST_RANK_NONE, GST_TYPE_METADATA_MUX);
}