Commit 80dd2062 authored by Wim Taymans's avatar Wim Taymans
Browse files

net: add net address metadata

parent af69a0f2
common @ 762b6927
Subproject commit 0546e5881d1ec7137c71d35247729e28c1a4ab66
Subproject commit 762b6927ffdd1726cb4f4783f49b5cfaa9edd941
......@@ -3,11 +3,13 @@ lib_LTLIBRARIES = libgstnet-@GST_MAJORMINOR@.la
libgstnet_@GST_MAJORMINOR@_includedir = $(includedir)/gstreamer-@GST_MAJORMINOR@/gst/net
libgstnet_@GST_MAJORMINOR@_include_HEADERS = \
gstnet.h \
gstnetaddressmeta.h \
gstnetclientclock.h \
gstnettimepacket.h \
gstnettimeprovider.h
libgstnet_@GST_MAJORMINOR@_la_SOURCES = \
gstnetaddressmeta.c \
gstnetclientclock.c \
gstnettimepacket.c \
gstnettimeprovider.c
......
/* GStreamer
* Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.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:gstnetaddressmeta
* @short_description: Network address metadata
*
* #GstNetAddress can be used to store a network address. #GstNetAddressMeta can
* be used to store a network address in a #GstBuffer so that it network
* elements can track the to and from address of the buffer.
*
* Last reviewed on 2011-11-03 (0.11.2)
*/
#include <string.h>
#include "gstnetaddressmeta.h"
static void
net_address_meta_copy (GstBuffer * copybuf, GstNetAddressMeta * meta,
GstBuffer * buffer, gsize offset, gsize size)
{
GstNetAddressMeta *naddr;
naddr = gst_buffer_add_net_address_meta (copybuf);
memcpy (&naddr->naddr, &meta->naddr, sizeof (meta->naddr));
}
const GstMetaInfo *
gst_net_address_meta_get_info (void)
{
static const GstMetaInfo *meta_info = NULL;
if (meta_info == NULL) {
meta_info = gst_meta_register ("GstNetAddressMeta", "GstNetAddressMeta",
sizeof (GstNetAddressMeta),
(GstMetaInitFunction) NULL,
(GstMetaFreeFunction) NULL,
(GstMetaCopyFunction) net_address_meta_copy,
(GstMetaTransformFunction) NULL);
}
return meta_info;
}
/**
* gst_net_address_set_ip4_address:
* @naddr: a network address
* @address: an IPv4 network address.
* @port: a port number to set.
*
* Set @naddr with the IPv4 @address and @port pair.
*
* Note that @port and @address must be expressed in network byte order,
* use g_htons() and g_htonl() to convert them to network byte order.
*/
void
gst_net_address_set_ip4_address (GstNetAddress * naddr, guint32 address,
guint16 port)
{
g_return_if_fail (naddr != NULL);
naddr->type = GST_NET_TYPE_IP4;
naddr->address.ip4 = address;
naddr->port = port;
}
/**
* gst_net_address_set_ip6_address:
* @naddr: a network address
* @address: an IPv6 network address.
* @port: a port number to set.
*
* Set @naddr with the IPv6 @address and @port pair.
*
* Note that @port must be expressed in network byte order, use g_htons() to convert
* it to network byte order.
*/
void
gst_net_address_set_ip6_address (GstNetAddress * naddr, guint8 address[16],
guint16 port)
{
g_return_if_fail (naddr != NULL);
naddr->type = GST_NET_TYPE_IP6;
memcpy (&naddr->address.ip6, address, 16);
naddr->port = port;
}
/**
* gst_net_address_get_net_type:
* @naddr: a network address
*
* Get the type of address stored in @naddr.
*
* Returns: the network type stored in @naddr.
*/
GstNetType
gst_net_address_get_net_type (const GstNetAddress * naddr)
{
g_return_val_if_fail (naddr != NULL, GST_NET_TYPE_UNKNOWN);
return naddr->type;
}
/**
* gst_net_address_get_ip4_address:
* @naddr: a network address
* @address: a location to store the address.
* @port: a location to store the port.
*
* Get the IPv4 address stored in @naddr into @address. This function requires
* that the address type of @naddr is of type #GST_NET_TYPE_IP4.
*
* Note that @port and @address are expressed in network byte order, use
* g_ntohs() and g_ntohl() to convert them to host order.
*
* Returns: TRUE if the address could be retrieved.
*/
gboolean
gst_net_address_get_ip4_address (const GstNetAddress * naddr, guint32 * address,
guint16 * port)
{
g_return_val_if_fail (naddr != NULL, FALSE);
if (naddr->type == GST_NET_TYPE_UNKNOWN || naddr->type == GST_NET_TYPE_IP6)
return FALSE;
if (address)
*address = naddr->address.ip4;
if (port)
*port = naddr->port;
return TRUE;
}
/**
* gst_net_address_get_ip6_address:
* @naddr: a network address
* @address: a location to store the result.
* @port: a location to store the port.
*
* Get the IPv6 address stored in @naddr into @address.
*
* If @naddr is of type GST_NET_TYPE_IP4, the transitional IP6 address is
* returned.
*
* Note that @port is expressed in network byte order, use g_ntohs() to convert
* it to host order.
*
* Returns: TRUE if the address could be retrieved.
*/
gboolean
gst_net_address_get_ip6_address (const GstNetAddress * naddr,
guint8 address[16], guint16 * port)
{
static guint8 ip4_transition[16] =
{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF };
g_return_val_if_fail (naddr != NULL, FALSE);
if (naddr->type == GST_NET_TYPE_UNKNOWN)
return FALSE;
if (address) {
if (naddr->type == GST_NET_TYPE_IP6) {
memcpy (address, naddr->address.ip6, 16);
} else { /* naddr->type == GST_NET_TYPE_IP4 */
memcpy (address, ip4_transition, 12);
memcpy (address + 12, (guint8 *) & (naddr->address.ip4), 4);
}
}
if (port)
*port = naddr->port;
return TRUE;
}
/**
* gst_net_address_get_address_bytes:
* @naddr: a network address
* @address: a location to store the result.
* @port: a location to store the port.
*
* Get just the address bytes stored in @naddr into @address.
*
* Note that @port is expressed in network byte order, use g_ntohs() to convert
* it to host order. IP4 addresses are also stored in network byte order.
*
* Returns: number of bytes actually copied
*
* Since: 0.10.22
*/
gint
gst_net_address_get_address_bytes (const GstNetAddress * naddr,
guint8 address[16], guint16 * port)
{
gint ret = 0;
g_return_val_if_fail (naddr != NULL, FALSE);
if (naddr->type == GST_NET_TYPE_UNKNOWN)
return 0;
if (address) {
if (naddr->type == GST_NET_TYPE_IP6) {
memcpy (address, naddr->address.ip6, 16);
ret = 16;
} else { /* naddr->type == GST_NET_TYPE_IP4 */
memcpy (address, (guint8 *) & (naddr->address.ip4), 4);
ret = 4;
}
}
if (port)
*port = naddr->port;
return ret;
}
/**
* gst_net_address_set_address_bytes:
* @naddr: a network address
* @type: the address type (IPv4 or IPV6)
* @address: a location to store the result.
* @port: a location to store the port.
*
* Set just the address bytes stored in @naddr into @address.
*
* Note that @port must be expressed in network byte order, use g_htons() to
* convert it to network byte order order. IP4 address bytes must also be
* stored in network byte order.
*
* Returns: number of bytes actually copied
*
* Since: 0.10.22
*/
gint
gst_net_address_set_address_bytes (GstNetAddress * naddr, GstNetType type,
guint8 address[16], guint16 port)
{
gint len = 0;
g_return_val_if_fail (naddr != NULL, 0);
naddr->type = type;
switch (naddr->type) {
case GST_NET_TYPE_UNKNOWN:
case GST_NET_TYPE_IP6:
len = 16;
memcpy (naddr->address.ip6, address, 16);
break;
case GST_NET_TYPE_IP4:
len = 4;
memcpy ((guint8 *) & (naddr->address.ip4), address, 4);
break;
}
if (port)
naddr->port = port;
return len;
}
/**
* gst_net_address_equal:
* @naddr1: The first #GstNetAddress
* @naddr2: The second #GstNetAddress
*
* Compare two #GstNetAddress structures
*
* Returns: TRUE if they are identical, FALSE otherwise
*
* Since: 0.10.18
*/
gboolean
gst_net_address_equal (const GstNetAddress * naddr1,
const GstNetAddress * naddr2)
{
g_return_val_if_fail (naddr1 != NULL, FALSE);
g_return_val_if_fail (naddr2 != NULL, FALSE);
if (naddr1->type != naddr2->type)
return FALSE;
if (naddr1->port != naddr2->port)
return FALSE;
switch (naddr1->type) {
case GST_NET_TYPE_IP4:
if (naddr1->address.ip4 != naddr2->address.ip4)
return FALSE;
break;
case GST_NET_TYPE_IP6:
if (memcmp (naddr1->address.ip6, naddr2->address.ip6,
sizeof (naddr1->address.ip6)))
return FALSE;
break;
default:
break;
}
return TRUE;
}
/**
* gst_net_address_to_string:
* @naddr: a #GstNetAddress
* @dest: destination
* @len: len of @dest
*
* Copies a string representation of @naddr into @dest. Up to @len bytes are
* copied.
*
* Returns: the number of bytes which would be produced if the buffer was large
* enough
*
* Since: 0.10.24
*/
gint
gst_net_address_to_string (const GstNetAddress * naddr, gchar * dest,
gulong len)
{
gint result;
g_return_val_if_fail (naddr != NULL, FALSE);
g_return_val_if_fail (dest != NULL, FALSE);
switch (naddr->type) {
case GST_NET_TYPE_IP4:
{
guint32 address;
guint16 port;
gst_net_address_get_ip4_address (naddr, &address, &port);
address = g_ntohl (address);
result = g_snprintf (dest, len, "%d.%d.%d.%d:%d", (address >> 24) & 0xff,
(address >> 16) & 0xff, (address >> 8) & 0xff, address & 0xff,
g_ntohs (port));
break;
}
case GST_NET_TYPE_IP6:
{
guint8 address[16];
guint16 port;
gst_net_address_get_ip6_address (naddr, address, &port);
result =
g_snprintf (dest, len, "[%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x]:%d",
(address[0] << 8) | address[1], (address[2] << 8) | address[3],
(address[4] << 8) | address[5], (address[6] << 8) | address[7],
(address[8] << 8) | address[9], (address[10] << 8) | address[11],
(address[12] << 8) | address[13], (address[14] << 8) | address[15],
g_ntohs (port));
break;
}
default:
dest[0] = 0;
result = 0;
break;
}
return result;
}
/* GStreamer
* Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.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_NET_ADDRESS_META_H__
#define __GST_NET_ADDRESS_META_H__
#include <gst/gst.h>
G_BEGIN_DECLS
typedef struct _GstNetAddress GstNetAddress;
/**
* GstNetType:
* @GST_NET_TYPE_UNKNOWN: unknown address type
* @GST_NET_TYPE_IP4: an IPv4 address type
* @GST_NET_TYPE_IP6: and IPv6 address type
*
* The Address type used in #GstNetAddress.
*/
typedef enum {
GST_NET_TYPE_UNKNOWN,
GST_NET_TYPE_IP4,
GST_NET_TYPE_IP6,
} GstNetType;
/**
* GST_NETADDRESS_MAX_LEN:
*
* The maximum length of a string representation of a GstNetAddress as produced
* by gst_net_address_to_string().
*
* Since: 0.10.24
*/
#define GST_NETADDRESS_MAX_LEN 64
/**
* GstNetAddress:
*
* An opaque network address as used in #GstNetAddressMeta.
*/
struct _GstNetAddress {
/*< private >*/
GstNetType type;
union {
guint8 ip6[16];
guint32 ip4;
} address;
guint16 port;
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
typedef struct _GstNetAddressMeta GstNetAddressMeta;
/**
* GstNetAddressMeta:
*
* Buffer metadata for network addresses.
*/
struct _GstNetAddressMeta {
GstMeta meta;
GstNetAddress naddr;
};
const GstMetaInfo *gst_net_address_meta_get_info (void);
#define GST_NET_ADDRESS_META_INFO (gst_net_address_meta_get_info())
#define gst_buffer_get_net_address_meta(b) \
((GstNetAddressMeta*)gst_buffer_get_meta((b),GST_NET_ADDRESS_META_INFO))
#define gst_buffer_add_net_address_meta(b) \
((GstNetAddressMeta*)gst_buffer_add_meta((b),GST_NET_ADDRESS_META_INFO,NULL))
/* address operations */
void gst_net_address_set_ip4_address (GstNetAddress *naddr, guint32 address, guint16 port);
void gst_net_address_set_ip6_address (GstNetAddress *naddr, guint8 address[16], guint16 port);
gint gst_net_address_set_address_bytes (GstNetAddress *naddr, GstNetType type,
guint8 address[16], guint16 port);
GstNetType gst_net_address_get_net_type (const GstNetAddress *naddr);
gboolean gst_net_address_get_ip4_address (const GstNetAddress *naddr, guint32 *address, guint16 *port);
gboolean gst_net_address_get_ip6_address (const GstNetAddress *naddr, guint8 address[16], guint16 *port);
gint gst_net_address_get_address_bytes (const GstNetAddress *naddr, guint8 address[16], guint16 *port);
gboolean gst_net_address_equal (const GstNetAddress *naddr1,
const GstNetAddress *naddr2);
gint gst_net_address_to_string (const GstNetAddress *naddr, gchar *dest, gulong len);
G_END_DECLS
#endif /* __GST_NET_ADDRESS_META_H__ */
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment