libs/gst/net/gstnetaddressmeta.c

   1 /* GStreamer
   2  * Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 /**
  21  * SECTION:gstnetaddressmeta
  22  * @title: GstNetAddressMeta
  23  * @short_description: Network address metadata
  24  *
  25  * #GstNetAddressMeta can be used to store a network address (a #GSocketAddress)
  26  * in a #GstBuffer so that it network elements can track the to and from address
  27  * of the buffer.
  28  */
  29
  30 #include <string.h>
  31
  32 #include "gstnetaddressmeta.h"
  33
  34 static gboolean
  35 net_address_meta_init (GstMeta * meta, gpointer params, GstBuffer * buffer)
  36 {
  37   GstNetAddressMeta *nmeta = (GstNetAddressMeta *) meta;
  38
  39   nmeta->addr = NULL;
  40
  41   return TRUE;
  42 }
  43
  44 static gboolean
  45 net_address_meta_transform (GstBuffer * transbuf, GstMeta * meta,
  46     GstBuffer * buffer, GQuark type, gpointer data)
  47 {
  48   GstNetAddressMeta *smeta, *dmeta;
  49   smeta = (GstNetAddressMeta *) meta;
  50
  51   /* we always copy no matter what transform */
  52   dmeta = gst_buffer_add_net_address_meta (transbuf, smeta->addr);
  53   if (!dmeta)
  54     return FALSE;
  55
  56   return TRUE;
  57 }
  58
  59 static void
  60 net_address_meta_free (GstMeta * meta, GstBuffer * buffer)
  61 {
  62   GstNetAddressMeta *nmeta = (GstNetAddressMeta *) meta;
  63
  64   if (nmeta->addr)
  65     g_object_unref (nmeta->addr);
  66   nmeta->addr = NULL;
  67 }
  68
  69 GType
  70 gst_net_address_meta_api_get_type (void)
  71 {
  72   static volatile GType type;
  73   static const gchar *tags[] = { "origin", NULL };
  74
  75   if (g_once_init_enter (&type)) {
  76     GType _type = gst_meta_api_type_register ("GstNetAddressMetaAPI", tags);
  77     g_once_init_leave (&type, _type);
  78   }
  79   return type;
  80 }
  81
  82 const GstMetaInfo *
  83 gst_net_address_meta_get_info (void)
  84 {
  85   static const GstMetaInfo *meta_info = NULL;
  86
  87   if (g_once_init_enter ((GstMetaInfo **) & meta_info)) {
  88     const GstMetaInfo *mi = gst_meta_register (GST_NET_ADDRESS_META_API_TYPE,
  89         "GstNetAddressMeta",
  90         sizeof (GstNetAddressMeta),
  91         net_address_meta_init,
  92         net_address_meta_free, net_address_meta_transform);
  93     g_once_init_leave ((GstMetaInfo **) & meta_info, (GstMetaInfo *) mi);
  94   }
  95   return meta_info;
  96 }
  97
  98 /**
  99  * gst_buffer_add_net_address_meta:
 100  * @buffer: a #GstBuffer
 101  * @addr: a @GSocketAddress to connect to @buffer
 102  *
 103  * Attaches @addr as metadata in a #GstNetAddressMeta to @buffer.
 104  *
 105  * Returns: (transfer none): a #GstNetAddressMeta connected to @buffer
 106  */
 107 GstNetAddressMeta *
 108 gst_buffer_add_net_address_meta (GstBuffer * buffer, GSocketAddress * addr)
 109 {
 110   GstNetAddressMeta *meta;
 111
 112   g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
 113   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (addr), NULL);
 114
 115   meta =
 116       (GstNetAddressMeta *) gst_buffer_add_meta (buffer,
 117       GST_NET_ADDRESS_META_INFO, NULL);
 118
 119   meta->addr = g_object_ref (addr);
 120
 121   return meta;
 122 }
 123
 124 /**
 125  * gst_buffer_get_net_address_meta:
 126  * @buffer: a #GstBuffer
 127  *
 128  * Find the #GstNetAddressMeta on @buffer.
 129  *
 130  * Returns: (transfer none): the #GstNetAddressMeta or %NULL when there
 131  * is no such metadata on @buffer.
 132  */
 133 GstNetAddressMeta *
 134 gst_buffer_get_net_address_meta (GstBuffer * buffer)
 135 {
 136   return (GstNetAddressMeta *)
 137       gst_buffer_get_meta (buffer, GST_NET_ADDRESS_META_API_TYPE);
 138 }