2 * Copyright (C) 2005 Andy Wingo <wingo@pobox.com>
3 * Copyright (C) 2010 Tim-Philipp Müller <tim centricular net>
4 * Copyright (C) 2012 Collabora Ltd. <tim.muller@collabora.co.uk>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
22 * SECTION:gstnettimepacket
23 * @short_description: Helper structure to construct clock packets used
25 * @see_also: #GstClock, #GstNetClientClock, #GstNetTimeProvider
27 * Various functions for receiving, sending an serializing #GstNetTimePacket
30 * Last reviewed on 2005-11-23 (0.9.5)
44 #include "gstnettimepacket.h"
46 G_DEFINE_BOXED_TYPE (GstNetTimePacket, gst_net_time_packet,
47 gst_net_time_packet_copy, gst_net_time_packet_free);
50 * gst_net_time_packet_new:
51 * @buffer: (array): a buffer from which to construct the packet, or NULL
53 * Creates a new #GstNetTimePacket from a buffer received over the network. The
54 * caller is responsible for ensuring that @buffer is at least
55 * #GST_NET_TIME_PACKET_SIZE bytes long.
57 * If @buffer is #NULL, the local and remote times will be set to
58 * #GST_CLOCK_TIME_NONE.
60 * MT safe. Caller owns return value (gst_net_time_packet_free to free).
62 * Returns: The new #GstNetTimePacket.
65 gst_net_time_packet_new (const guint8 * buffer)
67 GstNetTimePacket *ret;
69 g_assert (sizeof (GstClockTime) == 8);
71 ret = g_new0 (GstNetTimePacket, 1);
74 ret->local_time = GST_READ_UINT64_BE (buffer);
75 ret->remote_time = GST_READ_UINT64_BE (buffer + sizeof (GstClockTime));
77 ret->local_time = GST_CLOCK_TIME_NONE;
78 ret->remote_time = GST_CLOCK_TIME_NONE;
85 * gst_net_time_packet_free:
86 * @packet: the #GstNetTimePacket
91 gst_net_time_packet_free (GstNetTimePacket * packet)
97 * gst_net_time_packet_copy:
98 * @packet: the #GstNetTimePacket
100 * Make a copy of @packet.
102 * Returns: a copy of @packet, free with gst_net_time_packet_free().
105 gst_net_time_packet_copy (const GstNetTimePacket * packet)
107 GstNetTimePacket *ret;
109 ret = g_new0 (GstNetTimePacket, 1);
110 ret->local_time = packet->local_time;
111 ret->remote_time = packet->remote_time;
117 * gst_net_time_packet_serialize:
118 * @packet: the #GstNetTimePacket
120 * Serialized a #GstNetTimePacket into a newly-allocated sequence of
121 * #GST_NET_TIME_PACKET_SIZE bytes, in network byte order. The value returned is
122 * suitable for passing to write(2) or sendto(2) for communication over the
125 * MT safe. Caller owns return value (g_free to free).
127 * Returns: A newly allocated sequence of #GST_NET_TIME_PACKET_SIZE bytes.
130 gst_net_time_packet_serialize (const GstNetTimePacket * packet)
134 g_assert (sizeof (GstClockTime) == 8);
136 ret = g_new0 (guint8, GST_NET_TIME_PACKET_SIZE);
138 GST_WRITE_UINT64_BE (ret, packet->local_time);
139 GST_WRITE_UINT64_BE (ret + sizeof (GstClockTime), packet->remote_time);
145 * gst_net_time_packet_receive:
146 * @socket: socket to receive the time packet on
147 * @src_address: (out): address of variable to return sender address
148 * @error: return address for a #GError, or NULL
150 * Receives a #GstNetTimePacket over a socket. Handles interrupted system
151 * calls, but otherwise returns NULL on error.
153 * Returns: (transfer full): a new #GstNetTimePacket, or NULL on error. Free
154 * with gst_net_time_packet_free() when done.
157 gst_net_time_packet_receive (GSocket * socket,
158 GSocketAddress ** src_address, GError ** error)
160 gchar buffer[GST_NET_TIME_PACKET_SIZE];
164 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
165 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
168 ret = g_socket_receive_from (socket, src_address, buffer,
169 GST_NET_TIME_PACKET_SIZE, NULL, &err);
172 if (err->code == G_IO_ERROR_WOULD_BLOCK) {
179 } else if (ret < GST_NET_TIME_PACKET_SIZE) {
182 return gst_net_time_packet_new ((const guint8 *) buffer);
188 GST_DEBUG ("receive error: %s", err->message);
189 g_propagate_error (error, err);
194 GST_DEBUG ("someone sent us a short packet (%" G_GSSIZE_FORMAT " < %d)",
195 ret, GST_NET_TIME_PACKET_SIZE);
196 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_DATA,
197 "short time packet (%d < %d)", (int) ret, GST_NET_TIME_PACKET_SIZE);
203 * gst_net_time_packet_send:
204 * @packet: the #GstNetTimePacket to send
205 * @socket: socket to send the time packet on
206 * @dest_address: address to send the time packet to
207 * @error: return address for a #GError, or NULL
209 * Sends a #GstNetTimePacket over a socket.
213 * Returns: TRUE if successful, FALSE in case an error occurred.
216 gst_net_time_packet_send (const GstNetTimePacket * packet,
217 GSocket * socket, GSocketAddress * dest_address, GError ** error)
219 gboolean was_blocking;
223 g_return_val_if_fail (packet != NULL, FALSE);
224 g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
225 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (dest_address), FALSE);
226 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
228 was_blocking = g_socket_get_blocking (socket);
231 g_socket_set_blocking (socket, FALSE);
233 /* FIXME: avoid pointless alloc/free, serialise into stack-allocated buffer */
234 buffer = gst_net_time_packet_serialize (packet);
236 res = g_socket_send_to (socket, dest_address, (const gchar *) buffer,
237 GST_NET_TIME_PACKET_SIZE, NULL, error);
239 /* datagram packets should be sent as a whole or not at all */
240 g_assert (res < 0 || res == GST_NET_TIME_PACKET_SIZE);
245 g_socket_set_blocking (socket, TRUE);
247 return (res == GST_NET_TIME_PACKET_SIZE);