845a86802dd88552cefb0aad546f0f17fc20788c
[platform/upstream/gstreamer.git] / gst / tcp / gstmultifdsink.c
1 /* GStreamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3  * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
4  * Copyright (C) 2006 Wim Taymans <wim at fluendo dot com>
5  *
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.
10  *
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.
15  *
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., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /**
23  * SECTION:element-multifdsink
24  * @short_description: Send data to multiple file descriptors
25  * @see_also: tcpserversink
26  *
27  * <refsect2>
28  * <para>
29  * This plugin writes incoming data to a set of file descriptors. The
30  * file descriptors can be added to multifdsink by emitting the "add" signal. 
31  * For each descriptor added, the "client-added" signal will be called.
32  * </para>
33  * <para>
34  * As of version 0.10.8, a client can also be added with the "add-full" signal
35  * that allows for more control over what and how much data a client 
36  * initially receives.
37  * </para>
38  * <para>
39  * Clients can be removed from multifdsink by emitting the "remove" signal. For
40  * each descriptor removed, the "client-removed" signal will be called. The
41  * "client-removed" signal can also be fired when multifdsink decides that a
42  * client is not active anymore or, depending on the value of the
43  * "recover-policy" property, if the client is reading too slowly.
44  * In all cases, multifdsink will never close a file descriptor itself.
45  * The user of multifdsink is responsible for closing all file descriptors.
46  * This can for example be done in response to the "client-fd-removed" signal.
47  * Note that multifdsink still has a reference to the file descriptor when the
48  * "client-removed" signal is emitted, so that "get-stats" can be performed on
49  * the descriptor; it is therefore not safe to close the file descriptor in
50  * the "client-removed" signal handler, and you should use the 
51  * "client-fd-removed" signal to safely close the fd.
52  * </para>
53  * <para>
54  * Multifdsink internally keeps a queue of the incoming buffers and uses a
55  * separate thread to send the buffers to the clients. This ensures that no
56  * client write can block the pipeline and that clients can read with different
57  * speeds.
58  * </para>
59  * <para>
60  * When adding a client to multifdsink, the "sync-method" property will define
61  * which buffer in the queued buffers will be sent first to the client. Clients 
62  * can be sent the most recent buffer (which might not be decodable by the 
63  * client if it is not a keyframe), the next keyframe received in 
64  * multifdsink (which can take some time depending on the keyframe rate), or the
65  * last received keyframe (which will cause a simple burst-on-connect). 
66  * Multifdsink will always keep at least one keyframe in its internal buffers
67  * when the sync-mode is set to latest-keyframe.
68  * </para>
69  * <para>
70  * As of version 0.10.8, there are additional values for the sync-method 
71  * property to allow finer control over burst-on-connect behaviour. By selecting
72  * the 'burst' method a minimum burst size can be chosen, 'burst-keyframe'
73  * additionally requires that the burst begin with a keyframe, and 
74  * 'burst-with-keyframe' attempts to burst beginning with a keyframe, but will
75  * prefer a minimum burst size even if it requires not starting with a keyframe.
76  * </para>
77  * <para>
78  * Multifdsink can be instructed to keep at least a minimum amount of data
79  * expressed in time or byte units in its internal queues with the the 
80  * "time-min" and "bytes-min" properties respectively. These properties are
81  * useful if the application adds clients with the "add-full" signal to
82  * make sure that a burst connect can actually be honored. 
83  * </para>
84  * <para>
85  * When streaming data, clients are allowed to read at a different rate than
86  * the rate at which multifdsink receives data. If the client is reading too
87  * fast, no data will be send to the client until multifdsink receives more
88  * data. If the client, however, reads too slowly, data for that client will be 
89  * queued up in multifdsink. Two properties control the amount of data 
90  * (buffers) that is queued in multifdsink: "buffers-max" and 
91  * "buffers-soft-max". A client that falls behind by "buffers-max" is removed 
92  * from multifdsink forcibly.
93  * </para>
94  * <para>
95  * A client with a lag of at least "buffers-soft-max" enters the recovery
96  * procedure which is controlled with the "recover-policy" property. A recover
97  * policy of NONE will do nothing, RESYNC_LATEST will send the most recently
98  * received buffer as the next buffer for the client, RESYNC_SOFT_LIMIT
99  * positions the client to the soft limit in the buffer queue and
100  * RESYNC_KEYFRAME positions the client at the most recent keyframe in the
101  * buffer queue.
102  * </para>
103  * <para>
104  * multifdsink will by default synchronize on the clock before serving the 
105  * buffers to the clients. This behaviour can be disabled by setting the sync 
106  * property to FALSE. Multifdsink will by default not do QoS and will never
107  * drop late buffers.
108  * </para>
109  * </refsect2>
110  *
111  * Last reviewed on 2006-09-12 (0.10.10)
112  */
113
114 #ifdef HAVE_CONFIG_H
115 #include "config.h"
116 #endif
117 #include <gst/gst-i18n-plugin.h>
118
119 #include <sys/ioctl.h>
120 #include <unistd.h>
121 #include <fcntl.h>
122 #include <sys/types.h>
123 #include <sys/socket.h>
124 #include <sys/stat.h>
125
126 #ifdef HAVE_FIONREAD_IN_SYS_FILIO
127 #include <sys/filio.h>
128 #endif
129
130 #include "gstmultifdsink.h"
131 #include "gsttcp-marshal.h"
132
133 #define NOT_IMPLEMENTED 0
134
135 /* the select call is also performed on the control sockets, that way
136  * we can send special commands to unblock or restart the select call */
137 #define CONTROL_RESTART         'R'     /* restart the select call */
138 #define CONTROL_STOP            'S'     /* stop the select call */
139 #define CONTROL_SOCKETS(sink)   sink->control_sock
140 #define WRITE_SOCKET(sink)      sink->control_sock[1]
141 #define READ_SOCKET(sink)       sink->control_sock[0]
142
143 #define SEND_COMMAND(sink, command)             \
144 G_STMT_START {                                  \
145   unsigned char c; c = command;                 \
146   write (WRITE_SOCKET(sink).fd, &c, 1);         \
147 } G_STMT_END
148
149 #define READ_COMMAND(sink, command, res)        \
150 G_STMT_START {                                  \
151   res = read(READ_SOCKET(sink).fd, &command, 1);\
152 } G_STMT_END
153
154 /* elementfactory information */
155 static const GstElementDetails gst_multi_fd_sink_details =
156 GST_ELEMENT_DETAILS ("Multi filedescriptor sink",
157     "Sink/Network",
158     "Send data to multiple filedescriptors",
159     "Thomas Vander Stichele <thomas at apestaart dot org>, "
160     "Wim Taymans <wim@fluendo.com>");
161
162 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
163     GST_PAD_SINK,
164     GST_PAD_ALWAYS,
165     GST_STATIC_CAPS_ANY);
166
167 GST_DEBUG_CATEGORY_STATIC (multifdsink_debug);
168 #define GST_CAT_DEFAULT (multifdsink_debug)
169
170 /* MultiFdSink signals and args */
171 enum
172 {
173   /* methods */
174   SIGNAL_ADD,
175   SIGNAL_ADD_BURST,
176   SIGNAL_REMOVE,
177   SIGNAL_CLEAR,
178   SIGNAL_GET_STATS,
179
180   /* signals */
181   SIGNAL_CLIENT_ADDED,
182   SIGNAL_CLIENT_REMOVED,
183   SIGNAL_CLIENT_FD_REMOVED,
184
185   LAST_SIGNAL
186 };
187
188 /* this is really arbitrarily chosen */
189 #define DEFAULT_PROTOCOL                GST_TCP_PROTOCOL_NONE
190 #define DEFAULT_MODE                    GST_FDSET_MODE_POLL
191 #define DEFAULT_BUFFERS_MAX             -1
192 #define DEFAULT_BUFFERS_SOFT_MAX        -1
193 #define DEFAULT_TIME_MIN                -1
194 #define DEFAULT_BYTES_MIN               -1
195 #define DEFAULT_BUFFERS_MIN             -1
196 #define DEFAULT_UNIT_TYPE               GST_UNIT_TYPE_BUFFERS
197 #define DEFAULT_UNITS_MAX               -1
198 #define DEFAULT_UNITS_SOFT_MAX          -1
199 #define DEFAULT_RECOVER_POLICY          GST_RECOVER_POLICY_NONE
200 #define DEFAULT_TIMEOUT                 0
201 #define DEFAULT_SYNC_METHOD             GST_SYNC_METHOD_LATEST
202
203 #define DEFAULT_BURST_UNIT              GST_UNIT_TYPE_UNDEFINED
204 #define DEFAULT_BURST_VALUE             0
205
206 enum
207 {
208   PROP_0,
209   PROP_PROTOCOL,
210   PROP_MODE,
211   PROP_BUFFERS_QUEUED,
212   PROP_BYTES_QUEUED,
213   PROP_TIME_QUEUED,
214
215   PROP_UNIT_TYPE,
216   PROP_UNITS_MAX,
217   PROP_UNITS_SOFT_MAX,
218
219   PROP_BUFFERS_MAX,
220   PROP_BUFFERS_SOFT_MAX,
221
222   PROP_TIME_MIN,
223   PROP_BYTES_MIN,
224   PROP_BUFFERS_MIN,
225
226   PROP_RECOVER_POLICY,
227   PROP_TIMEOUT,
228   PROP_SYNC_METHOD,
229   PROP_BYTES_TO_SERVE,
230   PROP_BYTES_SERVED,
231
232   PROP_BURST_UNIT,
233   PROP_BURST_VALUE,
234 };
235
236 #define GST_TYPE_RECOVER_POLICY (gst_recover_policy_get_type())
237 static GType
238 gst_recover_policy_get_type (void)
239 {
240   static GType recover_policy_type = 0;
241   static const GEnumValue recover_policy[] = {
242     {GST_RECOVER_POLICY_NONE,
243         "Do not try to recover", "none"},
244     {GST_RECOVER_POLICY_RESYNC_LATEST,
245         "Resync client to latest buffer", "latest"},
246     {GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT,
247         "Resync client to soft limit", "soft-limit"},
248     {GST_RECOVER_POLICY_RESYNC_KEYFRAME,
249         "Resync client to most recent keyframe", "keyframe"},
250     {0, NULL, NULL},
251   };
252
253   if (!recover_policy_type) {
254     recover_policy_type =
255         g_enum_register_static ("GstRecoverPolicy", recover_policy);
256   }
257   return recover_policy_type;
258 }
259
260 #define GST_TYPE_SYNC_METHOD (gst_sync_method_get_type())
261 static GType
262 gst_sync_method_get_type (void)
263 {
264   static GType sync_method_type = 0;
265   static const GEnumValue sync_method[] = {
266     {GST_SYNC_METHOD_LATEST,
267         "Serve starting from the latest buffer", "latest"},
268     {GST_SYNC_METHOD_NEXT_KEYFRAME,
269         "Serve starting from the next keyframe", "next-keyframe"},
270     {GST_SYNC_METHOD_LATEST_KEYFRAME,
271           "Serve everything since the latest keyframe (burst)",
272         "latest-keyframe"},
273     {GST_SYNC_METHOD_BURST, "Serve burst-value data to client", "burst"},
274     {GST_SYNC_METHOD_BURST_KEYFRAME,
275           "Serve burst-value data starting on a keyframe",
276         "burst-keyframe"},
277     {GST_SYNC_METHOD_BURST_WITH_KEYFRAME,
278           "Serve burst-value data preferably starting on a keyframe",
279         "burst-with-keyframe"},
280     {0, NULL, NULL},
281   };
282
283   if (!sync_method_type) {
284     sync_method_type = g_enum_register_static ("GstSyncMethod", sync_method);
285   }
286   return sync_method_type;
287 }
288
289 #define GST_TYPE_UNIT_TYPE (gst_unit_type_get_type())
290 static GType
291 gst_unit_type_get_type (void)
292 {
293   static GType unit_type_type = 0;
294   static const GEnumValue unit_type[] = {
295     {GST_UNIT_TYPE_UNDEFINED, "Undefined", "undefined"},
296     {GST_UNIT_TYPE_BUFFERS, "Buffers", "buffers"},
297     {GST_UNIT_TYPE_BYTES, "Bytes", "bytes"},
298     {GST_UNIT_TYPE_TIME, "Time", "time"},
299     {0, NULL, NULL},
300   };
301
302   if (!unit_type_type) {
303     unit_type_type = g_enum_register_static ("GstTCPUnitType", unit_type);
304   }
305   return unit_type_type;
306 }
307
308 #define GST_TYPE_CLIENT_STATUS (gst_client_status_get_type())
309 static GType
310 gst_client_status_get_type (void)
311 {
312   static GType client_status_type = 0;
313   static const GEnumValue client_status[] = {
314     {GST_CLIENT_STATUS_OK, "ok", "ok"},
315     {GST_CLIENT_STATUS_CLOSED, "Closed", "closed"},
316     {GST_CLIENT_STATUS_REMOVED, "Removed", "removed"},
317     {GST_CLIENT_STATUS_SLOW, "Too slow", "slow"},
318     {GST_CLIENT_STATUS_ERROR, "Error", "error"},
319     {GST_CLIENT_STATUS_DUPLICATE, "Duplicate", "duplicate"},
320     {0, NULL, NULL},
321   };
322
323   if (!client_status_type) {
324     client_status_type =
325         g_enum_register_static ("GstClientStatus", client_status);
326   }
327   return client_status_type;
328 }
329
330 static void gst_multi_fd_sink_finalize (GObject * object);
331
332 static void gst_multi_fd_sink_remove_client_link (GstMultiFdSink * sink,
333     GList * link);
334
335 static GstFlowReturn gst_multi_fd_sink_render (GstBaseSink * bsink,
336     GstBuffer * buf);
337 static GstStateChangeReturn gst_multi_fd_sink_change_state (GstElement *
338     element, GstStateChange transition);
339
340 static void gst_multi_fd_sink_set_property (GObject * object, guint prop_id,
341     const GValue * value, GParamSpec * pspec);
342 static void gst_multi_fd_sink_get_property (GObject * object, guint prop_id,
343     GValue * value, GParamSpec * pspec);
344
345 GST_BOILERPLATE (GstMultiFdSink, gst_multi_fd_sink, GstBaseSink,
346     GST_TYPE_BASE_SINK);
347
348 static guint gst_multi_fd_sink_signals[LAST_SIGNAL] = { 0 };
349
350 static void
351 gst_multi_fd_sink_base_init (gpointer g_class)
352 {
353   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
354
355   gst_element_class_add_pad_template (element_class,
356       gst_static_pad_template_get (&sinktemplate));
357
358   gst_element_class_set_details (element_class, &gst_multi_fd_sink_details);
359 }
360
361 static void
362 gst_multi_fd_sink_class_init (GstMultiFdSinkClass * klass)
363 {
364   GObjectClass *gobject_class;
365   GstElementClass *gstelement_class;
366   GstBaseSinkClass *gstbasesink_class;
367
368   gobject_class = (GObjectClass *) klass;
369   gstelement_class = (GstElementClass *) klass;
370   gstbasesink_class = (GstBaseSinkClass *) klass;
371
372   gobject_class->set_property = gst_multi_fd_sink_set_property;
373   gobject_class->get_property = gst_multi_fd_sink_get_property;
374   gobject_class->finalize = gst_multi_fd_sink_finalize;
375
376   g_object_class_install_property (gobject_class, PROP_PROTOCOL,
377       g_param_spec_enum ("protocol", "Protocol", "The protocol to wrap data in",
378           GST_TYPE_TCP_PROTOCOL, DEFAULT_PROTOCOL, G_PARAM_READWRITE));
379   g_object_class_install_property (gobject_class, PROP_MODE,
380       g_param_spec_enum ("mode", "Mode",
381           "The mode for selecting activity on the fds", GST_TYPE_FDSET_MODE,
382           DEFAULT_MODE, G_PARAM_READWRITE));
383
384   g_object_class_install_property (gobject_class, PROP_BUFFERS_MAX,
385       g_param_spec_int ("buffers-max", "Buffers max",
386           "max number of buffers to queue for a client (-1 = no limit)", -1,
387           G_MAXINT, DEFAULT_BUFFERS_MAX, G_PARAM_READWRITE));
388   g_object_class_install_property (gobject_class,
389       PROP_BUFFERS_SOFT_MAX, g_param_spec_int ("buffers-soft-max",
390           "Buffers soft max",
391           "Recover client when going over this limit (-1 = no limit)", -1,
392           G_MAXINT, DEFAULT_BUFFERS_SOFT_MAX, G_PARAM_READWRITE));
393
394   g_object_class_install_property (gobject_class, PROP_BYTES_MIN,
395       g_param_spec_int ("bytes-min", "Bytes min",
396           "min number of bytes to queue (-1 = as little as possible)", -1,
397           G_MAXINT, DEFAULT_BYTES_MIN, G_PARAM_READWRITE));
398   g_object_class_install_property (gobject_class, PROP_TIME_MIN,
399       g_param_spec_int64 ("time-min", "Time min",
400           "min number of time to queue (-1 = as little as possible)", -1,
401           G_MAXINT64, DEFAULT_TIME_MIN, G_PARAM_READWRITE));
402   g_object_class_install_property (gobject_class, PROP_BUFFERS_MIN,
403       g_param_spec_int ("buffers-min", "Buffers min",
404           "min number of buffers to queue (-1 = as few as possible)", -1,
405           G_MAXINT, DEFAULT_BUFFERS_MIN, G_PARAM_READWRITE));
406
407   g_object_class_install_property (gobject_class, PROP_UNIT_TYPE,
408       g_param_spec_enum ("unit-type", "Units type",
409           "The unit to measure the max/soft-max/queued properties",
410           GST_TYPE_UNIT_TYPE, DEFAULT_UNIT_TYPE, G_PARAM_READWRITE));
411   g_object_class_install_property (gobject_class, PROP_UNITS_MAX,
412       g_param_spec_int64 ("units-max", "Units max",
413           "max number of units to queue (-1 = no limit)", -1, G_MAXINT64,
414           DEFAULT_UNITS_MAX, G_PARAM_READWRITE));
415   g_object_class_install_property (gobject_class, PROP_UNITS_SOFT_MAX,
416       g_param_spec_int64 ("units-soft-max", "Units soft max",
417           "Recover client when going over this limit (-1 = no limit)", -1,
418           G_MAXINT64, DEFAULT_UNITS_SOFT_MAX, G_PARAM_READWRITE));
419
420   g_object_class_install_property (gobject_class, PROP_BUFFERS_QUEUED,
421       g_param_spec_uint ("buffers-queued", "Buffers queued",
422           "Number of buffers currently queued", 0, G_MAXUINT, 0,
423           G_PARAM_READABLE));
424 #if NOT_IMPLEMENTED
425   g_object_class_install_property (gobject_class, PROP_BYTES_QUEUED,
426       g_param_spec_uint ("bytes-queued", "Bytes queued",
427           "Number of bytes currently queued", 0, G_MAXUINT, 0,
428           G_PARAM_READABLE));
429   g_object_class_install_property (gobject_class, PROP_TIME_QUEUED,
430       g_param_spec_uint64 ("time-queued", "Time queued",
431           "Number of time currently queued", 0, G_MAXUINT64, 0,
432           G_PARAM_READABLE));
433 #endif
434
435   g_object_class_install_property (gobject_class, PROP_RECOVER_POLICY,
436       g_param_spec_enum ("recover-policy", "Recover Policy",
437           "How to recover when client reaches the soft max",
438           GST_TYPE_RECOVER_POLICY, DEFAULT_RECOVER_POLICY, G_PARAM_READWRITE));
439   g_object_class_install_property (gobject_class, PROP_TIMEOUT,
440       g_param_spec_uint64 ("timeout", "Timeout",
441           "Maximum inactivity timeout in nanoseconds for a client (0 = no limit)",
442           0, G_MAXUINT64, DEFAULT_TIMEOUT, G_PARAM_READWRITE));
443   g_object_class_install_property (gobject_class, PROP_SYNC_METHOD,
444       g_param_spec_enum ("sync-method", "Sync Method",
445           "How to sync new clients to the stream",
446           GST_TYPE_SYNC_METHOD, DEFAULT_SYNC_METHOD, G_PARAM_READWRITE));
447   g_object_class_install_property (gobject_class, PROP_BYTES_TO_SERVE,
448       g_param_spec_uint64 ("bytes-to-serve", "Bytes to serve",
449           "Number of bytes received to serve to clients", 0, G_MAXUINT64, 0,
450           G_PARAM_READABLE));
451   g_object_class_install_property (gobject_class, PROP_BYTES_SERVED,
452       g_param_spec_uint64 ("bytes-served", "Bytes served",
453           "Total number of bytes send to all clients", 0, G_MAXUINT64, 0,
454           G_PARAM_READABLE));
455
456   g_object_class_install_property (gobject_class, PROP_BURST_UNIT,
457       g_param_spec_enum ("burst-unit", "Burst unit",
458           "The format of the burst units (when sync-method is burst[[-with]-keyframe])",
459           GST_TYPE_UNIT_TYPE, DEFAULT_BURST_UNIT, G_PARAM_READWRITE));
460   g_object_class_install_property (gobject_class, PROP_BURST_VALUE,
461       g_param_spec_uint64 ("burst-value", "Burst value",
462           "The amount of burst expressed in burst-unit",
463           0, G_MAXUINT64, DEFAULT_BURST_VALUE, G_PARAM_READWRITE));
464
465   /**
466    * GstMultiFdSink::add:
467    * @gstmultifdsink: the multifdsink element to emit this signal on
468    * @fd:             the file descriptor to add to multifdsink
469    *
470    * Hand the given open file descriptor to multifdsink to write to.
471    */
472   gst_multi_fd_sink_signals[SIGNAL_ADD] =
473       g_signal_new ("add", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
474       G_STRUCT_OFFSET (GstMultiFdSinkClass, add),
475       NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
476   /**
477    * GstMultiFdSink::add-full:
478    * @gstmultifdsink: the multifdsink element to emit this signal on
479    * @fd:             the file descriptor to add to multifdsink
480    * @keyframe:       start bursting from a keyframe
481    * @unit_type_min:  the unit-type of @value_min
482    * @value_min:      the minimum amount of data to burst expressed in
483    *                  @unit_type_min units.
484    * @unit_type_max:  the unit-type of @value_max
485    * @value_max:      the maximum amount of data to burst expressed in
486    *                  @unit_type_max units.
487    *
488    * Hand the given open file descriptor to multifdsink to write to and
489    * specify the burst parameters for the new connection.
490    */
491   gst_multi_fd_sink_signals[SIGNAL_ADD_BURST] =
492       g_signal_new ("add-full", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
493       G_STRUCT_OFFSET (GstMultiFdSinkClass, add_full),
494       NULL, NULL, gst_tcp_marshal_VOID__INT_BOOLEAN_INT_UINT64_INT_UINT64,
495       G_TYPE_NONE, 6, G_TYPE_INT, G_TYPE_BOOLEAN, GST_TYPE_UNIT_TYPE,
496       G_TYPE_UINT64, GST_TYPE_UNIT_TYPE, G_TYPE_UINT64);
497   /**
498    * GstMultiFdSink::remove:
499    * @gstmultifdsink: the multifdsink element to emit this signal on
500    * @fd:             the file descriptor to remove from multifdsink
501    *
502    * Remove the given open file descriptor from multifdsink.
503    */
504   gst_multi_fd_sink_signals[SIGNAL_REMOVE] =
505       g_signal_new ("remove", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
506       G_STRUCT_OFFSET (GstMultiFdSinkClass, remove),
507       NULL, NULL, gst_tcp_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
508   /**
509    * GstMultiFdSink::clear:
510    * @gstmultifdsink: the multifdsink element to emit this signal on
511    *
512    * Remove all file descriptors from multifdsink.  Since multifdsink did not
513    * open fd's itself, it does not explicitly close the fd.  The application
514    * should do so by connecting to the client-fd-removed callback.
515    */
516   gst_multi_fd_sink_signals[SIGNAL_CLEAR] =
517       g_signal_new ("clear", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
518       G_STRUCT_OFFSET (GstMultiFdSinkClass, clear),
519       NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
520
521   /**
522    * GstMultiFdSink::get-stats:
523    * @gstmultifdsink: the multifdsink element to emit this signal on
524    * @fd:             the file descriptor to get stats of from multifdsink
525    *
526    * Get statistics about @fd. This function returns a GValueArray to ease
527    * automatic wrapping for bindings.
528    *
529    * Returns: a GValueArray with the statistics. The array contains guint64
530    *     values that represent respectively: total number of bytes sent, time
531    *     when the client was added, time when the client was
532    *     disconnected/removed, time the client is/was active, last activity
533    *     time (in epoch seconds), number of buffers dropped.
534    *     All times are expressed in nanoseconds (GstClockTime).
535    *     The array can be 0-length if the client was not found.
536    */
537   gst_multi_fd_sink_signals[SIGNAL_GET_STATS] =
538       g_signal_new ("get-stats", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
539       G_STRUCT_OFFSET (GstMultiFdSinkClass, get_stats),
540       NULL, NULL, gst_tcp_marshal_BOXED__INT, G_TYPE_VALUE_ARRAY, 1,
541       G_TYPE_INT);
542
543   /**
544    * GstMultiFdSink::client-added:
545    * @gstmultifdsink: the multifdsink element that emitted this signal
546    * @fd:             the file descriptor that was added to multifdsink
547    *
548    * The given file descriptor was added to multifdsink. This signal will
549    * be emitted from the streaming thread so application should be prepared
550    * for that.
551    */
552   gst_multi_fd_sink_signals[SIGNAL_CLIENT_ADDED] =
553       g_signal_new ("client-added", G_TYPE_FROM_CLASS (klass),
554       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiFdSinkClass, client_added),
555       NULL, NULL, gst_tcp_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
556   /**
557    * GstMultiFdSink::client-removed:
558    * @gstmultifdsink: the multifdsink element that emitted this signal
559    * @fd:             the file descriptor that is to be removed from multifdsink
560    * @status:         the reason why the client was removed
561    *
562    * The given file descriptor is about to be removed from multifdsink. This
563    * signal will be emitted from the streaming thread so applications should
564    * be prepared for that.
565    *
566    * @gstmultifdsink still holds a handle to @fd so it is possible to call
567    * the get-stats signal from this callback. For the same reason it is
568    * not safe to close() and reuse @fd in this callback.
569    */
570   gst_multi_fd_sink_signals[SIGNAL_CLIENT_REMOVED] =
571       g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
572       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiFdSinkClass,
573           client_removed), NULL, NULL, gst_tcp_marshal_VOID__INT_BOXED,
574       G_TYPE_NONE, 2, G_TYPE_INT, GST_TYPE_CLIENT_STATUS);
575   /**
576    * GstMultiFdSink::client-fd-removed:
577    * @gstmultifdsink: the multifdsink element that emitted this signal
578    * @fd:             the file descriptor that was removed from multifdsink
579    *
580    * The given file descriptor was removed from multifdsink. This signal will
581    * be emitted from the streaming thread so applications should be prepared
582    * for that.
583    *
584    * In this callback, @gstmultifdsink has removed all the information
585    * associated with @fd and it is therefore not possible to call get-stats
586    * with @fd. It is however safe to close() and reuse @fd in the callback.
587    *
588    * Since: 0.10.7
589    */
590   gst_multi_fd_sink_signals[SIGNAL_CLIENT_FD_REMOVED] =
591       g_signal_new ("client-fd-removed", G_TYPE_FROM_CLASS (klass),
592       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiFdSinkClass,
593           client_fd_removed), NULL, NULL, gst_tcp_marshal_VOID__INT,
594       G_TYPE_NONE, 1, G_TYPE_INT);
595
596   gstelement_class->change_state =
597       GST_DEBUG_FUNCPTR (gst_multi_fd_sink_change_state);
598
599   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_render);
600
601   klass->add = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_add);
602   klass->add_full = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_add_full);
603   klass->remove = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_remove);
604   klass->clear = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_clear);
605   klass->get_stats = GST_DEBUG_FUNCPTR (gst_multi_fd_sink_get_stats);
606
607   GST_DEBUG_CATEGORY_INIT (multifdsink_debug, "multifdsink", 0, "FD sink");
608 }
609
610 static void
611 gst_multi_fd_sink_init (GstMultiFdSink * this, GstMultiFdSinkClass * klass)
612 {
613   GST_OBJECT_FLAG_UNSET (this, GST_MULTI_FD_SINK_OPEN);
614
615   this->protocol = DEFAULT_PROTOCOL;
616   this->mode = DEFAULT_MODE;
617
618   CLIENTS_LOCK_INIT (this);
619   this->clients = NULL;
620   this->fd_hash = g_hash_table_new (g_int_hash, g_int_equal);
621
622   this->bufqueue = g_array_new (FALSE, TRUE, sizeof (GstBuffer *));
623   this->unit_type = DEFAULT_UNIT_TYPE;
624   this->units_max = DEFAULT_UNITS_MAX;
625   this->units_soft_max = DEFAULT_UNITS_SOFT_MAX;
626   this->time_min = DEFAULT_TIME_MIN;
627   this->bytes_min = DEFAULT_BYTES_MIN;
628   this->buffers_min = DEFAULT_BUFFERS_MIN;
629   this->recover_policy = DEFAULT_RECOVER_POLICY;
630
631   this->timeout = DEFAULT_TIMEOUT;
632   this->def_sync_method = DEFAULT_SYNC_METHOD;
633   this->def_burst_unit = DEFAULT_BURST_UNIT;
634   this->def_burst_value = DEFAULT_BURST_VALUE;
635
636   this->header_flags = 0;
637 }
638
639 static void
640 gst_multi_fd_sink_finalize (GObject * object)
641 {
642   GstMultiFdSink *this;
643
644   this = GST_MULTI_FD_SINK (object);
645
646   CLIENTS_LOCK_FREE (this);
647   g_hash_table_destroy (this->fd_hash);
648   g_array_free (this->bufqueue, TRUE);
649
650   G_OBJECT_CLASS (parent_class)->finalize (object);
651 }
652
653 /* "add-full" signal implementation */
654 void
655 gst_multi_fd_sink_add_full (GstMultiFdSink * sink, int fd,
656     GstSyncMethod sync_method, GstUnitType min_unit, guint64 min_value,
657     GstUnitType max_unit, guint64 max_value)
658 {
659   GstTCPClient *client;
660   GList *clink;
661   GTimeVal now;
662   gint flags, res;
663   struct stat statbuf;
664
665   GST_DEBUG_OBJECT (sink, "[fd %5d] adding client, sync_method %d, "
666       "min_unit %d, min_value %" G_GUINT64_FORMAT
667       ", max_unit %d, max_value %" G_GUINT64_FORMAT, fd, sync_method,
668       min_unit, min_value, max_unit, max_value);
669
670   /* do limits check if we can */
671   if (min_unit == max_unit) {
672     if (max_value != -1 && min_value != -1 && max_value < min_value)
673       goto wrong_limits;
674   }
675
676   /* create client datastructure */
677   client = g_new0 (GstTCPClient, 1);
678   client->fd.fd = fd;
679   client->status = GST_CLIENT_STATUS_OK;
680   client->bufpos = -1;
681   client->bufoffset = 0;
682   client->sending = NULL;
683   client->bytes_sent = 0;
684   client->dropped_buffers = 0;
685   client->avg_queue_size = 0;
686   client->new_connection = TRUE;
687   client->burst_min_unit = min_unit;
688   client->burst_min_value = min_value;
689   client->burst_max_unit = max_unit;
690   client->burst_max_value = max_value;
691   client->sync_method = sync_method;
692   client->currently_removing = FALSE;
693
694   /* update start time */
695   g_get_current_time (&now);
696   client->connect_time = GST_TIMEVAL_TO_TIME (now);
697   client->disconnect_time = 0;
698   /* set last activity time to connect time */
699   client->last_activity_time = client->connect_time;
700
701   CLIENTS_LOCK (sink);
702
703   /* check the hash to find a duplicate fd */
704   clink = g_hash_table_lookup (sink->fd_hash, &client->fd.fd);
705   if (clink != NULL)
706     goto duplicate;
707
708   /* we can add the fd now */
709   clink = sink->clients = g_list_prepend (sink->clients, client);
710   g_hash_table_insert (sink->fd_hash, &client->fd.fd, clink);
711   sink->clients_cookie++;
712
713   /* set the socket to non blocking */
714   res = fcntl (fd, F_SETFL, O_NONBLOCK);
715   /* we always read from a client */
716   gst_fdset_add_fd (sink->fdset, &client->fd);
717
718   /* we don't try to read from write only fds */
719   flags = fcntl (fd, F_GETFL, 0);
720   if ((flags & O_ACCMODE) != O_WRONLY) {
721     gst_fdset_fd_ctl_read (sink->fdset, &client->fd, TRUE);
722   }
723   /* figure out the mode, can't use send() for non sockets */
724   res = fstat (fd, &statbuf);
725   if (S_ISSOCK (statbuf.st_mode)) {
726     client->is_socket = TRUE;
727   }
728
729   SEND_COMMAND (sink, CONTROL_RESTART);
730
731   CLIENTS_UNLOCK (sink);
732
733   g_signal_emit (G_OBJECT (sink),
734       gst_multi_fd_sink_signals[SIGNAL_CLIENT_ADDED], 0, fd);
735
736   return;
737
738   /* errors */
739 wrong_limits:
740   {
741     GST_WARNING_OBJECT (sink,
742         "[fd %5d] wrong values min =%" G_GUINT64_FORMAT ", max=%"
743         G_GUINT64_FORMAT ", unit %d specified when adding client", fd,
744         min_value, max_value, min_unit);
745     return;
746   }
747 duplicate:
748   {
749     client->status = GST_CLIENT_STATUS_DUPLICATE;
750     CLIENTS_UNLOCK (sink);
751     GST_WARNING_OBJECT (sink, "[fd %5d] duplicate client found, refusing", fd);
752     g_signal_emit (G_OBJECT (sink),
753         gst_multi_fd_sink_signals[SIGNAL_CLIENT_REMOVED], 0, fd,
754         client->status);
755     g_free (client);
756     return;
757   }
758 }
759
760 /* "add" signal implemntation */
761 void
762 gst_multi_fd_sink_add (GstMultiFdSink * sink, int fd)
763 {
764   gst_multi_fd_sink_add_full (sink, fd, sink->def_sync_method,
765       sink->def_burst_unit, sink->def_burst_value, sink->def_burst_unit, -1);
766 }
767
768 /* "remove" signal implementation */
769 void
770 gst_multi_fd_sink_remove (GstMultiFdSink * sink, int fd)
771 {
772   GList *clink;
773
774   GST_DEBUG_OBJECT (sink, "[fd %5d] removing client", fd);
775
776   CLIENTS_LOCK (sink);
777   clink = g_hash_table_lookup (sink->fd_hash, &fd);
778   if (clink != NULL) {
779     GstTCPClient *client = (GstTCPClient *) clink->data;
780
781     if (client->status != GST_CLIENT_STATUS_OK) {
782       GST_INFO_OBJECT (sink,
783           "[fd %5d] Client already disconnecting with status %d",
784           fd, client->status);
785       goto done;
786     }
787
788     client->status = GST_CLIENT_STATUS_REMOVED;
789     gst_multi_fd_sink_remove_client_link (sink, clink);
790     SEND_COMMAND (sink, CONTROL_RESTART);
791   } else {
792     GST_WARNING_OBJECT (sink, "[fd %5d] no client with this fd found!", fd);
793   }
794
795 done:
796   CLIENTS_UNLOCK (sink);
797 }
798
799 /* can be called both through the signal (i.e. from any thread) or when 
800  * stopping, after the writing thread has shut down */
801 void
802 gst_multi_fd_sink_clear (GstMultiFdSink * sink)
803 {
804   GList *clients, *next;
805   guint32 cookie;
806
807   GST_DEBUG_OBJECT (sink, "clearing all clients");
808
809   CLIENTS_LOCK (sink);
810 restart:
811   cookie = sink->clients_cookie;
812   for (clients = sink->clients; clients; clients = next) {
813     GstTCPClient *client;
814
815     if (cookie != sink->clients_cookie) {
816       GST_DEBUG_OBJECT (sink, "cookie changed while removing all clients");
817       goto restart;
818     }
819
820     client = (GstTCPClient *) clients->data;
821     next = g_list_next (clients);
822
823     client->status = GST_CLIENT_STATUS_REMOVED;
824     gst_multi_fd_sink_remove_client_link (sink, clients);
825   }
826   SEND_COMMAND (sink, CONTROL_RESTART);
827   CLIENTS_UNLOCK (sink);
828 }
829
830 /* "get-stats" signal implementation
831  * the array returned contains:
832  *
833  * guint64 : bytes_sent
834  * guint64 : connect time (in nanoseconds, since Epoch)
835  * guint64 : disconnect time (in nanoseconds, since Epoch)
836  * guint64 : time the client is/was connected (in nanoseconds)
837  * guint64 : last activity time (in nanoseconds, since Epoch)
838  * guint64 : buffers dropped due to recovery
839  */
840 GValueArray *
841 gst_multi_fd_sink_get_stats (GstMultiFdSink * sink, int fd)
842 {
843   GstTCPClient *client;
844   GValueArray *result = NULL;
845   GList *clink;
846
847   CLIENTS_LOCK (sink);
848   clink = g_hash_table_lookup (sink->fd_hash, &fd);
849   if (clink == NULL)
850     goto noclient;
851
852   client = (GstTCPClient *) clink->data;
853   if (client != NULL) {
854     GValue value = { 0 };
855     guint64 interval;
856
857     result = g_value_array_new (5);
858
859     g_value_init (&value, G_TYPE_UINT64);
860     g_value_set_uint64 (&value, client->bytes_sent);
861     result = g_value_array_append (result, &value);
862     g_value_unset (&value);
863     g_value_init (&value, G_TYPE_UINT64);
864     g_value_set_uint64 (&value, client->connect_time);
865     result = g_value_array_append (result, &value);
866     g_value_unset (&value);
867     if (client->disconnect_time == 0) {
868       GTimeVal nowtv;
869
870       g_get_current_time (&nowtv);
871
872       interval = GST_TIMEVAL_TO_TIME (nowtv) - client->connect_time;
873     } else {
874       interval = client->disconnect_time - client->connect_time;
875     }
876     g_value_init (&value, G_TYPE_UINT64);
877     g_value_set_uint64 (&value, client->disconnect_time);
878     result = g_value_array_append (result, &value);
879     g_value_unset (&value);
880     g_value_init (&value, G_TYPE_UINT64);
881     g_value_set_uint64 (&value, interval);
882     result = g_value_array_append (result, &value);
883     g_value_unset (&value);
884     g_value_init (&value, G_TYPE_UINT64);
885     g_value_set_uint64 (&value, client->last_activity_time);
886     result = g_value_array_append (result, &value);
887     g_value_unset (&value);
888     g_value_init (&value, G_TYPE_UINT64);
889     g_value_set_uint64 (&value, client->dropped_buffers);
890     result = g_value_array_append (result, &value);
891   }
892
893 noclient:
894   CLIENTS_UNLOCK (sink);
895
896   /* python doesn't like a NULL pointer yet */
897   if (result == NULL) {
898     GST_WARNING_OBJECT (sink, "[fd %5d] no client with this found!", fd);
899     result = g_value_array_new (0);
900   }
901
902   return result;
903 }
904
905 /* should be called with the clientslock helt.
906  * Note that we don't close the fd as we didn't open it in the first
907  * place. An application should connect to the client-fd-removed signal and
908  * close the fd itself.
909  */
910 static void
911 gst_multi_fd_sink_remove_client_link (GstMultiFdSink * sink, GList * link)
912 {
913   int fd;
914   GTimeVal now;
915   GstTCPClient *client = (GstTCPClient *) link->data;
916   GstMultiFdSinkClass *fclass;
917
918   fclass = GST_MULTI_FD_SINK_GET_CLASS (sink);
919
920   fd = client->fd.fd;
921
922   if (client->currently_removing) {
923     GST_WARNING_OBJECT (sink, "[fd %5d] client is already being removed", fd);
924     return;
925   } else {
926     client->currently_removing = TRUE;
927   }
928
929   /* FIXME: if we keep track of ip we can log it here and signal */
930   switch (client->status) {
931     case GST_CLIENT_STATUS_OK:
932       GST_WARNING_OBJECT (sink, "[fd %5d] removing client %p for no reason",
933           fd, client);
934       break;
935     case GST_CLIENT_STATUS_CLOSED:
936       GST_DEBUG_OBJECT (sink, "[fd %5d] removing client %p because of close",
937           fd, client);
938       break;
939     case GST_CLIENT_STATUS_REMOVED:
940       GST_DEBUG_OBJECT (sink,
941           "[fd %5d] removing client %p because the app removed it", fd, client);
942       break;
943     case GST_CLIENT_STATUS_SLOW:
944       GST_INFO_OBJECT (sink,
945           "[fd %5d] removing client %p because it was too slow", fd, client);
946       break;
947     case GST_CLIENT_STATUS_ERROR:
948       GST_WARNING_OBJECT (sink,
949           "[fd %5d] removing client %p because of error", fd, client);
950       break;
951     default:
952       GST_WARNING_OBJECT (sink,
953           "[fd %5d] removing client %p with invalid reason", fd, client);
954       break;
955   }
956
957   gst_fdset_remove_fd (sink->fdset, &client->fd);
958
959   g_get_current_time (&now);
960   client->disconnect_time = GST_TIMEVAL_TO_TIME (now);
961
962   /* free client buffers */
963   g_slist_foreach (client->sending, (GFunc) gst_mini_object_unref, NULL);
964   g_slist_free (client->sending);
965   client->sending = NULL;
966
967   if (client->caps)
968     gst_caps_unref (client->caps);
969   client->caps = NULL;
970
971   /* unlock the mutex before signaling because the signal handler
972    * might query some properties */
973   CLIENTS_UNLOCK (sink);
974
975   g_signal_emit (G_OBJECT (sink),
976       gst_multi_fd_sink_signals[SIGNAL_CLIENT_REMOVED], 0, fd, client->status);
977
978   /* lock again before we remove the client completely */
979   CLIENTS_LOCK (sink);
980
981   /* fd cannot be reused in the above signal callback so we can safely
982    * remove it from the hashtable here */
983   if (!g_hash_table_remove (sink->fd_hash, &client->fd.fd)) {
984     GST_WARNING_OBJECT (sink,
985         "[fd %5d] error removing client %p from hash", client->fd.fd, client);
986   }
987   /* after releasing the lock above, the link could be invalid, more
988    * precisely, the next and prev pointers could point to invalid list
989    * links. One optimisation could be to add a cookie to the linked list
990    * and take a shortcut when it did not change between unlocking and locking
991    * our mutex. For now we just walk the list again. */
992   sink->clients = g_list_remove (sink->clients, client);
993   sink->clients_cookie++;
994
995   if (fclass->removed)
996     fclass->removed (sink, client->fd.fd);
997
998   g_free (client);
999   CLIENTS_UNLOCK (sink);
1000
1001   /* and the fd is really gone now */
1002   g_signal_emit (G_OBJECT (sink),
1003       gst_multi_fd_sink_signals[SIGNAL_CLIENT_FD_REMOVED], 0, fd);
1004
1005   CLIENTS_LOCK (sink);
1006 }
1007
1008 /* handle a read on a client fd,
1009  * which either indicates a close or should be ignored
1010  * returns FALSE if some error occured or the client closed. */
1011 static gboolean
1012 gst_multi_fd_sink_handle_client_read (GstMultiFdSink * sink,
1013     GstTCPClient * client)
1014 {
1015   int avail, fd;
1016   gboolean ret;
1017
1018   fd = client->fd.fd;
1019
1020   if (ioctl (fd, FIONREAD, &avail) < 0)
1021     goto ioctl_failed;
1022
1023   GST_DEBUG_OBJECT (sink, "[fd %5d] select reports client read of %d bytes",
1024       fd, avail);
1025
1026   ret = TRUE;
1027
1028   if (avail == 0) {
1029     /* client sent close, so remove it */
1030     GST_DEBUG_OBJECT (sink, "[fd %5d] client asked for close, removing", fd);
1031     client->status = GST_CLIENT_STATUS_CLOSED;
1032     ret = FALSE;
1033   } else if (avail < 0) {
1034     GST_WARNING_OBJECT (sink, "[fd %5d] avail < 0, removing", fd);
1035     client->status = GST_CLIENT_STATUS_ERROR;
1036     ret = FALSE;
1037   } else {
1038     guint8 dummy[512];
1039     gint nread;
1040
1041     /* just Read 'n' Drop, could also just drop the client as it's not supposed
1042      * to write to us except for closing the socket, I guess it's because we
1043      * like to listen to our customers. */
1044     do {
1045       /* this is the maximum we can read */
1046       gint to_read = MIN (avail, 512);
1047
1048       GST_DEBUG_OBJECT (sink, "[fd %5d] client wants us to read %d bytes",
1049           fd, to_read);
1050
1051       nread = read (fd, dummy, to_read);
1052       if (nread < -1) {
1053         GST_WARNING_OBJECT (sink, "[fd %5d] could not read %d bytes: %s (%d)",
1054             fd, to_read, g_strerror (errno), errno);
1055         client->status = GST_CLIENT_STATUS_ERROR;
1056         ret = FALSE;
1057         break;
1058       } else if (nread == 0) {
1059         GST_WARNING_OBJECT (sink, "[fd %5d] 0 bytes in read, removing", fd);
1060         client->status = GST_CLIENT_STATUS_ERROR;
1061         ret = FALSE;
1062         break;
1063       }
1064       avail -= nread;
1065     }
1066     while (avail > 0);
1067   }
1068   return ret;
1069
1070   /* ERRORS */
1071 ioctl_failed:
1072   {
1073     GST_WARNING_OBJECT (sink, "[fd %5d] ioctl failed: %s (%d)",
1074         fd, g_strerror (errno), errno);
1075     client->status = GST_CLIENT_STATUS_ERROR;
1076     return FALSE;
1077   }
1078 }
1079
1080 /* Queue raw data for this client, creating a new buffer.
1081  * This takes ownership of the data by
1082  * setting it as GST_BUFFER_MALLOCDATA() on the created buffer so
1083  * be sure to pass g_free()-able @data.
1084  */
1085 static gboolean
1086 gst_multi_fd_sink_client_queue_data (GstMultiFdSink * sink,
1087     GstTCPClient * client, gchar * data, gint len)
1088 {
1089   GstBuffer *buf;
1090
1091   buf = gst_buffer_new ();
1092   GST_BUFFER_DATA (buf) = (guint8 *) data;
1093   GST_BUFFER_MALLOCDATA (buf) = (guint8 *) data;
1094   GST_BUFFER_SIZE (buf) = len;
1095
1096   GST_LOG_OBJECT (sink, "[fd %5d] queueing data of length %d",
1097       client->fd.fd, len);
1098
1099   client->sending = g_slist_append (client->sending, buf);
1100
1101   return TRUE;
1102 }
1103
1104 /* GDP-encode given caps and queue them for sending */
1105 static gboolean
1106 gst_multi_fd_sink_client_queue_caps (GstMultiFdSink * sink,
1107     GstTCPClient * client, const GstCaps * caps)
1108 {
1109   guint8 *header;
1110   guint8 *payload;
1111   guint length;
1112   gchar *string;
1113
1114   g_return_val_if_fail (caps != NULL, FALSE);
1115
1116   string = gst_caps_to_string (caps);
1117   GST_DEBUG_OBJECT (sink, "[fd %5d] Queueing caps %s through GDP",
1118       client->fd.fd, string);
1119   g_free (string);
1120
1121   if (!gst_dp_packet_from_caps (caps, sink->header_flags, &length, &header,
1122           &payload)) {
1123     GST_DEBUG_OBJECT (sink, "Could not create GDP packet from caps");
1124     return FALSE;
1125   }
1126   gst_multi_fd_sink_client_queue_data (sink, client, (gchar *) header, length);
1127
1128   length = gst_dp_header_payload_length (header);
1129   gst_multi_fd_sink_client_queue_data (sink, client, (gchar *) payload, length);
1130
1131   return TRUE;
1132 }
1133
1134 static gboolean
1135 is_sync_frame (GstMultiFdSink * sink, GstBuffer * buffer)
1136 {
1137   if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DELTA_UNIT)) {
1138     return FALSE;
1139   } else if (!GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_IN_CAPS)) {
1140     return TRUE;
1141   }
1142
1143   return FALSE;
1144 }
1145
1146 /* queue the given buffer for the given client, possibly adding the GDP
1147  * header if GDP is being used */
1148 static gboolean
1149 gst_multi_fd_sink_client_queue_buffer (GstMultiFdSink * sink,
1150     GstTCPClient * client, GstBuffer * buffer)
1151 {
1152   GstCaps *caps;
1153
1154   /* TRUE: send them if the new caps have them */
1155   gboolean send_streamheader = FALSE;
1156   GstStructure *s;
1157
1158   /* before we queue the buffer, we check if we need to queue streamheader
1159    * buffers (because it's a new client, or because they changed) */
1160   caps = gst_buffer_get_caps (buffer);  /* cleaned up after streamheader */
1161   if (!client->caps) {
1162     GST_LOG_OBJECT (sink,
1163         "[fd %5d] no previous caps for this client, send streamheader",
1164         client->fd.fd);
1165     send_streamheader = TRUE;
1166     client->caps = gst_caps_ref (caps);
1167   } else {
1168     /* there were previous caps recorded, so compare */
1169     if (!gst_caps_is_equal (caps, client->caps)) {
1170       const GValue *sh1, *sh2;
1171
1172       /* caps are not equal, but could still have the same streamheader */
1173       s = gst_caps_get_structure (caps, 0);
1174       if (!gst_structure_has_field (s, "streamheader")) {
1175         /* no new streamheader, so nothing new to send */
1176         GST_LOG_OBJECT (sink,
1177             "[fd %5d] new caps do not have streamheader, not sending",
1178             client->fd.fd);
1179       } else {
1180         /* there is a new streamheader */
1181         s = gst_caps_get_structure (client->caps, 0);
1182         if (!gst_structure_has_field (s, "streamheader")) {
1183           /* no previous streamheader, so send the new one */
1184           GST_LOG_OBJECT (sink,
1185               "[fd %5d] previous caps did not have streamheader, sending",
1186               client->fd.fd);
1187           send_streamheader = TRUE;
1188         } else {
1189           /* both old and new caps have streamheader set */
1190           sh1 = gst_structure_get_value (s, "streamheader");
1191           s = gst_caps_get_structure (caps, 0);
1192           sh2 = gst_structure_get_value (s, "streamheader");
1193           if (gst_value_compare (sh1, sh2) != GST_VALUE_EQUAL) {
1194             GST_LOG_OBJECT (sink,
1195                 "[fd %5d] new streamheader different from old, sending",
1196                 client->fd.fd);
1197             send_streamheader = TRUE;
1198           }
1199         }
1200       }
1201     }
1202     /* Replace the old caps */
1203     gst_caps_unref (client->caps);
1204     client->caps = gst_caps_ref (caps);
1205   }
1206
1207   if (G_UNLIKELY (send_streamheader)) {
1208     const GValue *sh;
1209     GArray *buffers;
1210     int i;
1211
1212     GST_LOG_OBJECT (sink,
1213         "[fd %5d] sending streamheader from caps %" GST_PTR_FORMAT,
1214         client->fd.fd, caps);
1215     s = gst_caps_get_structure (caps, 0);
1216     if (!gst_structure_has_field (s, "streamheader")) {
1217       GST_LOG_OBJECT (sink,
1218           "[fd %5d] no new streamheader, so nothing to send", client->fd.fd);
1219     } else {
1220       GST_LOG_OBJECT (sink,
1221           "[fd %5d] sending streamheader from caps %" GST_PTR_FORMAT,
1222           client->fd.fd, caps);
1223       sh = gst_structure_get_value (s, "streamheader");
1224       g_assert (G_VALUE_TYPE (sh) == GST_TYPE_ARRAY);
1225       buffers = g_value_peek_pointer (sh);
1226       for (i = 0; i < buffers->len; ++i) {
1227         GValue *bufval;
1228         GstBuffer *buffer;
1229
1230         bufval = &g_array_index (buffers, GValue, i);
1231         g_assert (G_VALUE_TYPE (bufval) == GST_TYPE_BUFFER);
1232         buffer = g_value_peek_pointer (bufval);
1233         GST_LOG_OBJECT (sink,
1234             "[fd %5d] queueing streamheader buffer of length %d",
1235             client->fd.fd, GST_BUFFER_SIZE (buffer));
1236         gst_buffer_ref (buffer);
1237
1238         if (sink->protocol == GST_TCP_PROTOCOL_GDP) {
1239           guint8 *header;
1240           guint len;
1241
1242           if (!gst_dp_header_from_buffer (buffer, sink->header_flags, &len,
1243                   &header)) {
1244             GST_DEBUG_OBJECT (sink,
1245                 "[fd %5d] could not create header, removing client",
1246                 client->fd.fd);
1247             return FALSE;
1248           }
1249           gst_multi_fd_sink_client_queue_data (sink, client, (gchar *) header,
1250               len);
1251         }
1252
1253         client->sending = g_slist_append (client->sending, buffer);
1254       }
1255     }
1256   }
1257
1258   gst_caps_unref (caps);
1259   caps = NULL;
1260   /* now we can send the buffer, possibly sending a GDP header first */
1261   if (sink->protocol == GST_TCP_PROTOCOL_GDP) {
1262     guint8 *header;
1263     guint len;
1264
1265     if (!gst_dp_header_from_buffer (buffer, sink->header_flags, &len, &header)) {
1266       GST_DEBUG_OBJECT (sink,
1267           "[fd %5d] could not create header, removing client", client->fd.fd);
1268       return FALSE;
1269     }
1270     gst_multi_fd_sink_client_queue_data (sink, client, (gchar *) header, len);
1271   }
1272
1273   GST_LOG_OBJECT (sink, "[fd %5d] queueing buffer of length %d",
1274       client->fd.fd, GST_BUFFER_SIZE (buffer));
1275
1276   gst_buffer_ref (buffer);
1277   client->sending = g_slist_append (client->sending, buffer);
1278
1279   return TRUE;
1280 }
1281
1282 /* find the keyframe in the list of buffers starting the
1283  * search from @idx. @direction as -1 will search backwards, 
1284  * 1 will search forwards.
1285  * Returns: the index or -1 if there is no keyframe after idx.
1286  */
1287 static gint
1288 find_syncframe (GstMultiFdSink * sink, gint idx, gint direction)
1289 {
1290   gint i, len, result;
1291
1292   /* take length of queued buffers */
1293   len = sink->bufqueue->len;
1294
1295   /* assume we don't find a keyframe */
1296   result = -1;
1297
1298   /* then loop over all buffers to find the first keyframe */
1299   for (i = idx; i >= 0 && i < len; i += direction) {
1300     GstBuffer *buf;
1301
1302     buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1303     if (is_sync_frame (sink, buf)) {
1304       GST_LOG_OBJECT (sink, "found keyframe at %d from %d, direction %d",
1305           i, idx, direction);
1306       result = i;
1307       break;
1308     }
1309   }
1310   return result;
1311 }
1312
1313 #define find_next_syncframe(s,i)        find_syncframe(s,i,1)
1314 #define find_prev_syncframe(s,i)        find_syncframe(s,i,-1)
1315
1316 /* Get the number of buffers from the buffer queue needed to satisfy
1317  * the maximum max in the configured units.
1318  * If units are not BUFFERS, and there are insufficient buffers in the
1319  * queue to satify the limit, return len(queue) + 1 */
1320 static gint
1321 get_buffers_max (GstMultiFdSink * sink, gint64 max)
1322 {
1323   switch (sink->unit_type) {
1324     case GST_UNIT_TYPE_BUFFERS:
1325       return max;
1326     case GST_UNIT_TYPE_TIME:
1327     {
1328       GstBuffer *buf;
1329       int i;
1330       int len;
1331       gint64 diff;
1332       GstClockTime first = GST_CLOCK_TIME_NONE;
1333
1334       len = sink->bufqueue->len;
1335
1336       for (i = 0; i < len; i++) {
1337         buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1338         if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1339           if (first == -1)
1340             first = GST_BUFFER_TIMESTAMP (buf);
1341
1342           diff = first - GST_BUFFER_TIMESTAMP (buf);
1343
1344           if (diff > max)
1345             return i + 1;
1346         }
1347       }
1348       return len + 1;
1349     }
1350     case GST_UNIT_TYPE_BYTES:
1351     {
1352       GstBuffer *buf;
1353       int i;
1354       int len;
1355       gint acc = 0;
1356
1357       len = sink->bufqueue->len;
1358
1359       for (i = 0; i < len; i++) {
1360         buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1361         acc += GST_BUFFER_SIZE (buf);
1362
1363         if (acc > max)
1364           return i + 1;
1365       }
1366       return len + 1;
1367     }
1368     default:
1369       return max;
1370   }
1371 }
1372
1373 /* find the positions in the buffer queue where *_min and *_max
1374  * is satisfied
1375  */
1376 /* count the amount of data in the buffers and return the index
1377  * that satifies the given limits.
1378  *
1379  * Returns: index @idx in the buffer queue so that the given limits are
1380  * satisfied. TRUE if all the limits could be satisfied, FALSE if not
1381  * enough data was in the queue.
1382  *
1383  * FIXME, this code might now work if any of the units is in buffers...
1384  */
1385 static gboolean
1386 find_limits (GstMultiFdSink * sink,
1387     gint * min_idx, gint bytes_min, gint buffers_min, gint64 time_min,
1388     gint * max_idx, gint bytes_max, gint buffers_max, gint64 time_max)
1389 {
1390   GstClockTime first, time;
1391   gint i, len, bytes;
1392   gboolean result, max_hit;
1393
1394   /* take length of queue */
1395   len = sink->bufqueue->len;
1396
1397   /* this must hold */
1398   g_assert (len > 0);
1399
1400   GST_LOG_OBJECT (sink,
1401       "bytes_min %d, buffers_min %d, time_min %" GST_TIME_FORMAT
1402       ", bytes_max %d, buffers_max %d, time_max %" GST_TIME_FORMAT, bytes_min,
1403       buffers_min, GST_TIME_ARGS (time_min), bytes_max, buffers_max,
1404       GST_TIME_ARGS (time_max));
1405
1406   /* do the trivial buffer limit test */
1407   if (buffers_min != -1 && len < buffers_min) {
1408     *min_idx = len - 1;
1409     *max_idx = len - 1;
1410     return FALSE;
1411   }
1412
1413   result = FALSE;
1414   /* else count bytes and time */
1415   first = -1;
1416   bytes = 0;
1417   /* unset limits */
1418   *min_idx = -1;
1419   *max_idx = -1;
1420   max_hit = FALSE;
1421
1422   i = 0;
1423   /* loop through the buffers, when a limit is ok, mark it 
1424    * as -1, we have at least one buffer in the queue. */
1425   do {
1426     GstBuffer *buf;
1427
1428     /* if we checked all min limits, update result */
1429     if (bytes_min == -1 && time_min == -1 && *min_idx == -1) {
1430       /* don't go below 0 */
1431       *min_idx = MAX (i - 1, 0);
1432     }
1433     /* if we reached one max limit break out */
1434     if (max_hit) {
1435       /* i > 0 when we get here, we subtract one to get the position
1436        * of the previous buffer. */
1437       *max_idx = i - 1;
1438       /* we have valid complete result if we found a min_idx too */
1439       result = *min_idx != -1;
1440       break;
1441     }
1442     buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1443
1444     bytes += GST_BUFFER_SIZE (buf);
1445
1446     /* take timestamp and save for the base first timestamp */
1447     if ((time = GST_BUFFER_TIMESTAMP (buf)) != -1) {
1448       GST_LOG_OBJECT (sink, "Ts %" GST_TIME_FORMAT " on buffer",
1449           GST_TIME_ARGS (time));
1450       if (first == -1)
1451         first = time;
1452
1453       /* increase max usage if we did not fill enough. Note that
1454        * buffers are sorted from new to old, so the first timestamp is
1455        * bigger than the next one. */
1456       if (time_min != -1 && first - time >= time_min)
1457         time_min = -1;
1458       if (time_max != -1 && first - time >= time_max)
1459         max_hit = TRUE;
1460     } else {
1461       GST_DEBUG_OBJECT (sink, "No timestamp on buffer");
1462     }
1463     /* time is OK or unknown, check and increase if not enough bytes */
1464     if (bytes_min != -1) {
1465       if (bytes >= bytes_min)
1466         bytes_min = -1;
1467     }
1468     if (bytes_max != -1) {
1469       if (bytes >= bytes_max) {
1470         max_hit = TRUE;
1471       }
1472     }
1473     i++;
1474   }
1475   while (i < len);
1476
1477   /* if we did not hit the max or min limit, set to buffer size */
1478   if (*max_idx == -1)
1479     *max_idx = len - 1;
1480   /* make sure min does not exceed max */
1481   if (*min_idx == -1)
1482     *min_idx = *max_idx;
1483
1484   return result;
1485 }
1486
1487 /* parse the unit/value pair and assign it to the result value of the
1488  * right type, leave the other values untouched 
1489  *
1490  * Returns: FALSE if the unit is unknown or undefined. TRUE otherwise.
1491  */
1492 static gboolean
1493 assign_value (GstUnitType unit, guint64 value, gint * bytes, gint * buffers,
1494     GstClockTime * time)
1495 {
1496   gboolean res = TRUE;
1497
1498   /* set only the limit of the given format to the given value */
1499   switch (unit) {
1500     case GST_UNIT_TYPE_BUFFERS:
1501       *buffers = (gint) value;
1502       break;
1503     case GST_UNIT_TYPE_TIME:
1504       *time = value;
1505       break;
1506     case GST_UNIT_TYPE_BYTES:
1507       *bytes = (gint) value;
1508       break;
1509     case GST_UNIT_TYPE_UNDEFINED:
1510     default:
1511       res = FALSE;
1512       break;
1513   }
1514   return res;
1515 }
1516
1517 /* count the index in the buffer queue to satisfy the given unit
1518  * and value pair starting from buffer at index 0.
1519  *
1520  * Returns: TRUE if there was enough data in the queue to satisfy the
1521  * burst values. @idx contains the index in the buffer that contains enough
1522  * data to satisfy the limits or the last buffer in the queue when the
1523  * function returns FALSE.
1524  */
1525 static gboolean
1526 count_burst_unit (GstMultiFdSink * sink, gint * min_idx, GstUnitType min_unit,
1527     guint64 min_value, gint * max_idx, GstUnitType max_unit, guint64 max_value)
1528 {
1529   gint bytes_min = -1, buffers_min = -1;
1530   gint bytes_max = -1, buffers_max = -1;
1531   GstClockTime time_min = GST_CLOCK_TIME_NONE, time_max = GST_CLOCK_TIME_NONE;
1532
1533   assign_value (min_unit, min_value, &bytes_min, &buffers_min, &time_min);
1534   assign_value (max_unit, max_value, &bytes_max, &buffers_max, &time_max);
1535
1536   return find_limits (sink, min_idx, bytes_min, buffers_min, time_min,
1537       max_idx, bytes_max, buffers_max, time_max);
1538 }
1539
1540 /* decide where in the current buffer queue this new client should start
1541  * receiving buffers from.
1542  * This function is called whenever a client is connected and has not yet
1543  * received a buffer.
1544  * If this returns -1, it means that we haven't found a good point to
1545  * start streaming from yet, and this function should be called again later
1546  * when more buffers have arrived.
1547  */
1548 static gint
1549 gst_multi_fd_sink_new_client (GstMultiFdSink * sink, GstTCPClient * client)
1550 {
1551   gint result;
1552
1553   GST_DEBUG_OBJECT (sink,
1554       "[fd %5d] new client, deciding where to start in queue", client->fd.fd);
1555   switch (client->sync_method) {
1556     case GST_SYNC_METHOD_LATEST:
1557       /* no syncing, we are happy with whatever the client is going to get */
1558       result = client->bufpos;
1559       GST_DEBUG_OBJECT (sink,
1560           "[fd %5d] SYNC_METHOD_LATEST, position %d", client->fd.fd, result);
1561       break;
1562     case GST_SYNC_METHOD_NEXT_KEYFRAME:
1563     {
1564       /* if one of the new buffers (between client->bufpos and 0) in the queue
1565        * is a sync point, we can proceed, otherwise we need to keep waiting */
1566       GST_LOG_OBJECT (sink,
1567           "[fd %5d] new client, bufpos %d, waiting for keyframe", client->fd.fd,
1568           client->bufpos);
1569
1570       result = find_prev_syncframe (sink, client->bufpos);
1571       if (result != -1) {
1572         GST_DEBUG_OBJECT (sink,
1573             "[fd %5d] SYNC_METHOD_NEXT_KEYFRAME: result %d",
1574             client->fd.fd, result);
1575         break;
1576       }
1577
1578       /* client is not on a syncbuffer, need to skip these buffers and
1579        * wait some more */
1580       GST_LOG_OBJECT (sink,
1581           "[fd %5d] new client, skipping buffer(s), no syncpoint found",
1582           client->fd.fd);
1583       client->bufpos = -1;
1584       break;
1585     }
1586     case GST_SYNC_METHOD_LATEST_KEYFRAME:
1587     {
1588       GST_DEBUG_OBJECT (sink,
1589           "[fd %5d] SYNC_METHOD_LATEST_KEYFRAME", client->fd.fd);
1590
1591       /* for new clients we initially scan the complete buffer queue for
1592        * a sync point when a buffer is added. If we don't find a keyframe,
1593        * we need to wait for the next keyframe and so we change the client's
1594        * sync method to GST_SYNC_METHOD_NEXT_KEYFRAME.
1595        */
1596       result = find_next_syncframe (sink, 0);
1597       if (result != -1) {
1598         GST_DEBUG_OBJECT (sink,
1599             "[fd %5d] SYNC_METHOD_LATEST_KEYFRAME: result %d", client->fd.fd,
1600             result);
1601         break;
1602       }
1603
1604       GST_DEBUG_OBJECT (sink,
1605           "[fd %5d] SYNC_METHOD_LATEST_KEYFRAME: no keyframe found, "
1606           "switching to SYNC_METHOD_NEXT_KEYFRAME", client->fd.fd);
1607       /* throw client to the waiting state */
1608       client->bufpos = -1;
1609       /* and make client sync to next keyframe */
1610       client->sync_method = GST_SYNC_METHOD_NEXT_KEYFRAME;
1611       break;
1612     }
1613     case GST_SYNC_METHOD_BURST:
1614     {
1615       gboolean ok;
1616       gint max;
1617
1618       /* move to the position where we satisfy the client's burst
1619        * parameters. If we could not satisfy the parameters because there
1620        * is not enough data, we just send what we have (which is in result).
1621        * We use the max value to limit the search
1622        */
1623       ok = count_burst_unit (sink, &result, client->burst_min_unit,
1624           client->burst_min_value, &max, client->burst_max_unit,
1625           client->burst_max_value);
1626       GST_DEBUG_OBJECT (sink,
1627           "[fd %5d] SYNC_METHOD_BURST: burst_unit returned %d, result %d",
1628           client->fd.fd, ok, result);
1629
1630       GST_LOG_OBJECT (sink, "min %d, max %d", result, max);
1631
1632       /* we hit the max and it is below the min, use that then */
1633       if (max != -1 && max <= result) {
1634         result = MAX (max - 1, 0);
1635         GST_DEBUG_OBJECT (sink,
1636             "[fd %5d] SYNC_METHOD_BURST: result above max, taken down to %d",
1637             client->fd.fd, result);
1638       }
1639       break;
1640     }
1641     case GST_SYNC_METHOD_BURST_KEYFRAME:
1642     {
1643       gboolean ok;
1644       gint min_idx, max_idx;
1645       gint next_syncframe, prev_syncframe;
1646
1647       /* BURST_KEYFRAME:
1648        *
1649        * _always_ start sending a keyframe to the client. We first search
1650        * a keyframe between min/max limits. If there is none, we send it the
1651        * last keyframe before min. If there is none, the behaviour is like
1652        * NEXT_KEYFRAME.
1653        */
1654       /* gather burst limits */
1655       ok = count_burst_unit (sink, &min_idx, client->burst_min_unit,
1656           client->burst_min_value, &max_idx, client->burst_max_unit,
1657           client->burst_max_value);
1658
1659       GST_LOG_OBJECT (sink, "min %d, max %d", min_idx, max_idx);
1660
1661       /* first find a keyframe after min_idx */
1662       next_syncframe = find_next_syncframe (sink, min_idx);
1663       if (next_syncframe != -1 && next_syncframe < max_idx) {
1664         /* we have a valid keyframe and it's below the max */
1665         GST_LOG_OBJECT (sink, "found keyframe in min/max limits");
1666         result = next_syncframe;
1667         break;
1668       }
1669
1670       /* no valid keyframe, try to find one below min */
1671       prev_syncframe = find_prev_syncframe (sink, min_idx);
1672       if (prev_syncframe != -1) {
1673         GST_WARNING_OBJECT (sink,
1674             "using keyframe below min in BURST_KEYFRAME sync mode");
1675         result = prev_syncframe;
1676         break;
1677       }
1678
1679       /* no prev keyframe or not enough data  */
1680       GST_WARNING_OBJECT (sink,
1681           "no prev keyframe found in BURST_KEYFRAME sync mode, waiting for next");
1682
1683       /* throw client to the waiting state */
1684       client->bufpos = -1;
1685       /* and make client sync to next keyframe */
1686       client->sync_method = GST_SYNC_METHOD_NEXT_KEYFRAME;
1687       result = -1;
1688       break;
1689     }
1690     case GST_SYNC_METHOD_BURST_WITH_KEYFRAME:
1691     {
1692       gboolean ok;
1693       gint min_idx, max_idx;
1694       gint next_syncframe;
1695
1696       /* BURST_WITH_KEYFRAME:
1697        *
1698        * try to start sending a keyframe to the client. We first search
1699        * a keyframe between min/max limits. If there is none, we send it the
1700        * amount of data up 'till min.
1701        */
1702       /* gather enough data to burst */
1703       ok = count_burst_unit (sink, &min_idx, client->burst_min_unit,
1704           client->burst_min_value, &max_idx, client->burst_max_unit,
1705           client->burst_max_value);
1706
1707       GST_LOG_OBJECT (sink, "min %d, max %d", min_idx, max_idx);
1708
1709       /* first find a keyframe after min_idx */
1710       next_syncframe = find_next_syncframe (sink, min_idx);
1711       if (next_syncframe != -1 && next_syncframe < max_idx) {
1712         /* we have a valid keyframe and it's below the max */
1713         GST_LOG_OBJECT (sink, "found keyframe in min/max limits");
1714         result = next_syncframe;
1715         break;
1716       }
1717
1718       /* no keyframe, send data from min_idx */
1719       GST_WARNING_OBJECT (sink, "using min in BURST_WITH_KEYFRAME sync mode");
1720
1721       /* make sure we don't go over the max limit */
1722       if (max_idx != -1 && max_idx <= min_idx) {
1723         result = MAX (max_idx - 1, 0);
1724       } else {
1725         result = min_idx;
1726       }
1727
1728       break;
1729     }
1730     default:
1731       g_warning ("unknown sync method %d", client->sync_method);
1732       result = client->bufpos;
1733       break;
1734   }
1735   return result;
1736 }
1737
1738 /* Handle a write on a client,
1739  * which indicates a read request from a client.
1740  *
1741  * For each client we maintain a queue of GstBuffers that contain the raw bytes
1742  * we need to send to the client. In the case of the GDP protocol, we create
1743  * buffers out of the header bytes so that we can focus only on sending
1744  * buffers.
1745  *
1746  * We first check to see if we need to send caps (in GDP) and streamheaders.
1747  * If so, we queue them.
1748  *
1749  * Then we run into the main loop that tries to send as many buffers as
1750  * possible. It will first exhaust the client->sending queue and if the queue
1751  * is empty, it will pick a buffer from the global queue.
1752  *
1753  * Sending the buffers from the client->sending queue is basically writing
1754  * the bytes to the socket and maintaining a count of the bytes that were
1755  * sent. When the buffer is completely sent, it is removed from the
1756  * client->sending queue and we try to pick a new buffer for sending.
1757  *
1758  * When the sending returns a partial buffer we stop sending more data as
1759  * the next send operation could block.
1760  *
1761  * This functions returns FALSE if some error occured.
1762  */
1763 static gboolean
1764 gst_multi_fd_sink_handle_client_write (GstMultiFdSink * sink,
1765     GstTCPClient * client)
1766 {
1767   int fd = client->fd.fd;
1768   gboolean more;
1769   gboolean res;
1770   GstClockTime now;
1771   GTimeVal nowtv;
1772
1773   g_get_current_time (&nowtv);
1774   now = GST_TIMEVAL_TO_TIME (nowtv);
1775
1776   /* when using GDP, first check if we have queued caps yet */
1777   if (sink->protocol == GST_TCP_PROTOCOL_GDP) {
1778     if (!client->caps_sent) {
1779       GstPad *peer;
1780       GstCaps *caps;
1781
1782       peer = gst_pad_get_peer (GST_BASE_SINK_PAD (sink));
1783       if (!peer) {
1784         GST_WARNING_OBJECT (sink, "pad has no peer");
1785         return FALSE;
1786       }
1787       gst_object_unref (peer);
1788
1789       caps = gst_pad_get_negotiated_caps (GST_BASE_SINK_PAD (sink));
1790       if (!caps) {
1791         GST_WARNING_OBJECT (sink, "pad caps not yet negotiated");
1792         return FALSE;
1793       }
1794
1795       /* queue caps for sending */
1796       res = gst_multi_fd_sink_client_queue_caps (sink, client, caps);
1797
1798       gst_caps_unref (caps);
1799
1800       if (!res) {
1801         GST_DEBUG_OBJECT (sink, "Failed queueing caps, removing client");
1802         return FALSE;
1803       }
1804       client->caps_sent = TRUE;
1805     }
1806   }
1807
1808   more = TRUE;
1809   do {
1810     gint maxsize;
1811
1812     if (!client->sending) {
1813       /* client is not working on a buffer */
1814       if (client->bufpos == -1) {
1815         /* client is too fast, remove from write queue until new buffer is
1816          * available */
1817         gst_fdset_fd_ctl_write (sink->fdset, &client->fd, FALSE);
1818         return TRUE;
1819       } else {
1820         /* client can pick a buffer from the global queue */
1821         GstBuffer *buf;
1822
1823         /* for new connections, we need to find a good spot in the
1824          * bufqueue to start streaming from */
1825         if (client->new_connection) {
1826           gint position = gst_multi_fd_sink_new_client (sink, client);
1827
1828           if (position >= 0) {
1829             /* we got a valid spot in the queue */
1830             client->new_connection = FALSE;
1831             client->bufpos = position;
1832           } else {
1833             /* cannot send data to this client yet */
1834             gst_fdset_fd_ctl_write (sink->fdset, &client->fd, FALSE);
1835             return TRUE;
1836           }
1837         }
1838
1839         /* grab buffer */
1840         buf = g_array_index (sink->bufqueue, GstBuffer *, client->bufpos);
1841         client->bufpos--;
1842         GST_LOG_OBJECT (sink, "[fd %5d] client %p at position %d",
1843             fd, client, client->bufpos);
1844
1845         /* queueing a buffer will ref it */
1846         gst_multi_fd_sink_client_queue_buffer (sink, client, buf);
1847
1848         /* need to start from the first byte for this new buffer */
1849         client->bufoffset = 0;
1850       }
1851     }
1852
1853     /* see if we need to send something */
1854     if (client->sending) {
1855       ssize_t wrote;
1856       GstBuffer *head;
1857
1858       /* pick first buffer from list */
1859       head = GST_BUFFER (client->sending->data);
1860       maxsize = GST_BUFFER_SIZE (head) - client->bufoffset;
1861
1862       /* try to write the complete buffer */
1863 #ifdef MSG_NOSIGNAL
1864 #define FLAGS MSG_NOSIGNAL
1865 #else
1866 #define FLAGS 0
1867 #endif
1868       if (client->is_socket) {
1869         wrote =
1870             send (fd, GST_BUFFER_DATA (head) + client->bufoffset, maxsize,
1871             FLAGS);
1872       } else {
1873         wrote = write (fd, GST_BUFFER_DATA (head) + client->bufoffset, maxsize);
1874       }
1875
1876       if (wrote < 0) {
1877         /* hmm error.. */
1878         if (errno == EAGAIN) {
1879           /* nothing serious, resource was unavailable, try again later */
1880           more = FALSE;
1881         } else if (errno == ECONNRESET) {
1882           goto connection_reset;
1883         } else {
1884           goto write_error;
1885         }
1886       } else {
1887         if (wrote < maxsize) {
1888           /* partial write means that the client cannot read more and we should
1889            * stop sending more */
1890           GST_LOG_OBJECT (sink,
1891               "partial write on %d of %" G_GSSIZE_FORMAT " bytes", fd, wrote);
1892           client->bufoffset += wrote;
1893           more = FALSE;
1894         } else {
1895           /* complete buffer was written, we can proceed to the next one */
1896           client->sending = g_slist_remove (client->sending, head);
1897           gst_buffer_unref (head);
1898           /* make sure we start from byte 0 for the next buffer */
1899           client->bufoffset = 0;
1900         }
1901         /* update stats */
1902         client->bytes_sent += wrote;
1903         client->last_activity_time = now;
1904         sink->bytes_served += wrote;
1905       }
1906     }
1907   } while (more);
1908
1909   return TRUE;
1910
1911   /* ERRORS */
1912 connection_reset:
1913   {
1914     GST_DEBUG_OBJECT (sink, "[fd %5d] connection reset by peer, removing", fd);
1915     client->status = GST_CLIENT_STATUS_CLOSED;
1916     return FALSE;
1917   }
1918 write_error:
1919   {
1920     GST_WARNING_OBJECT (sink,
1921         "[fd %5d] could not write, removing client: %s (%d)", fd,
1922         g_strerror (errno), errno);
1923     client->status = GST_CLIENT_STATUS_ERROR;
1924     return FALSE;
1925   }
1926 }
1927
1928 /* calculate the new position for a client after recovery. This function
1929  * does not update the client position but merely returns the required
1930  * position.
1931  */
1932 static gint
1933 gst_multi_fd_sink_recover_client (GstMultiFdSink * sink, GstTCPClient * client)
1934 {
1935   gint newbufpos;
1936
1937   GST_WARNING_OBJECT (sink,
1938       "[fd %5d] client %p is lagging at %d, recover using policy %d",
1939       client->fd.fd, client, client->bufpos, sink->recover_policy);
1940
1941   switch (sink->recover_policy) {
1942     case GST_RECOVER_POLICY_NONE:
1943       /* do nothing, client will catch up or get kicked out when it reaches
1944        * the hard max */
1945       newbufpos = client->bufpos;
1946       break;
1947     case GST_RECOVER_POLICY_RESYNC_LATEST:
1948       /* move to beginning of queue */
1949       newbufpos = -1;
1950       break;
1951     case GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT:
1952       /* move to beginning of soft max */
1953       newbufpos = get_buffers_max (sink, sink->units_soft_max);
1954       break;
1955     case GST_RECOVER_POLICY_RESYNC_KEYFRAME:
1956       /* find keyframe in buffers, we search backwards to find the
1957        * closest keyframe relative to what this client already received. */
1958       newbufpos = MIN (sink->bufqueue->len - 1,
1959           get_buffers_max (sink, sink->units_soft_max) - 1);
1960
1961       while (newbufpos >= 0) {
1962         GstBuffer *buf;
1963
1964         buf = g_array_index (sink->bufqueue, GstBuffer *, newbufpos);
1965         if (is_sync_frame (sink, buf)) {
1966           /* found a buffer that is not a delta unit */
1967           break;
1968         }
1969         newbufpos--;
1970       }
1971       break;
1972     default:
1973       /* unknown recovery procedure */
1974       newbufpos = get_buffers_max (sink, sink->units_soft_max);
1975       break;
1976   }
1977   return newbufpos;
1978 }
1979
1980 /* Queue a buffer on the global queue.
1981  *
1982  * This function adds the buffer to the front of a GArray. It removes the
1983  * tail buffer if the max queue size is exceeded, unreffing the queued buffer.
1984  * Note that unreffing the buffer is not a problem as clients who
1985  * started writing out this buffer will still have a reference to it in the
1986  * client->sending queue.
1987  *
1988  * After adding the buffer, we update all client positions in the queue. If
1989  * a client moves over the soft max, we start the recovery procedure for this
1990  * slow client. If it goes over the hard max, it is put into the slow list
1991  * and removed.
1992  *
1993  * Special care is taken of clients that were waiting for a new buffer (they
1994  * had a position of -1) because they can proceed after adding this new buffer.
1995  * This is done by adding the client back into the write fd_set and signalling
1996  * the select thread that the fd_set changed.
1997  */
1998 static void
1999 gst_multi_fd_sink_queue_buffer (GstMultiFdSink * sink, GstBuffer * buf)
2000 {
2001   GList *clients, *next;
2002   gint queuelen;
2003   gboolean need_signal = FALSE;
2004   gint max_buffer_usage;
2005   gint i;
2006   GTimeVal nowtv;
2007   GstClockTime now;
2008   gint max_buffers, soft_max_buffers;
2009   guint cookie;
2010
2011   g_get_current_time (&nowtv);
2012   now = GST_TIMEVAL_TO_TIME (nowtv);
2013
2014   CLIENTS_LOCK (sink);
2015   /* add buffer to queue */
2016   g_array_prepend_val (sink->bufqueue, buf);
2017   queuelen = sink->bufqueue->len;
2018
2019   if (sink->units_max > 0)
2020     max_buffers = get_buffers_max (sink, sink->units_max);
2021   else
2022     max_buffers = -1;
2023
2024   if (sink->units_soft_max > 0)
2025     soft_max_buffers = get_buffers_max (sink, sink->units_soft_max);
2026   else
2027     soft_max_buffers = -1;
2028   GST_LOG_OBJECT (sink, "Using max %d, softmax %d", max_buffers,
2029       soft_max_buffers);
2030
2031   /* then loop over the clients and update the positions */
2032   max_buffer_usage = 0;
2033
2034 restart:
2035   cookie = sink->clients_cookie;
2036   for (clients = sink->clients; clients; clients = next) {
2037     GstTCPClient *client;
2038
2039     if (cookie != sink->clients_cookie) {
2040       GST_DEBUG_OBJECT (sink, "Clients cookie outdated, restarting");
2041       goto restart;
2042     }
2043
2044     client = (GstTCPClient *) clients->data;
2045     next = g_list_next (clients);
2046
2047     client->bufpos++;
2048     GST_LOG_OBJECT (sink, "[fd %5d] client %p at position %d",
2049         client->fd.fd, client, client->bufpos);
2050     /* check soft max if needed, recover client */
2051     if (soft_max_buffers > 0 && client->bufpos >= soft_max_buffers) {
2052       gint newpos;
2053
2054       newpos = gst_multi_fd_sink_recover_client (sink, client);
2055       if (newpos != client->bufpos) {
2056         client->dropped_buffers += client->bufpos - newpos;
2057         client->bufpos = newpos;
2058         client->discont = TRUE;
2059         GST_INFO_OBJECT (sink, "[fd %5d] client %p position reset to %d",
2060             client->fd.fd, client, client->bufpos);
2061       } else {
2062         GST_INFO_OBJECT (sink,
2063             "[fd %5d] client %p not recovering position",
2064             client->fd.fd, client);
2065       }
2066     }
2067     /* check hard max and timeout, remove client */
2068     if ((max_buffers > 0 && client->bufpos >= max_buffers) ||
2069         (sink->timeout > 0
2070             && now - client->last_activity_time > sink->timeout)) {
2071       /* remove client */
2072       GST_WARNING_OBJECT (sink, "[fd %5d] client %p is too slow, removing",
2073           client->fd.fd, client);
2074       /* remove the client, the fd set will be cleared and the select thread
2075        * will be signaled */
2076       client->status = GST_CLIENT_STATUS_SLOW;
2077       /* set client to invalid position while being removed */
2078       client->bufpos = -1;
2079       gst_multi_fd_sink_remove_client_link (sink, clients);
2080       need_signal = TRUE;
2081       continue;
2082     } else if (client->bufpos == 0 || client->new_connection) {
2083       /* can send data to this client now. need to signal the select thread that
2084        * the fd_set changed */
2085       gst_fdset_fd_ctl_write (sink->fdset, &client->fd, TRUE);
2086       need_signal = TRUE;
2087     }
2088     /* keep track of maximum buffer usage */
2089     if (client->bufpos > max_buffer_usage) {
2090       max_buffer_usage = client->bufpos;
2091     }
2092   }
2093
2094   /* make sure we respect bytes-min, buffers-min and time-min when they are set */
2095   {
2096     gint usage, max;
2097
2098     GST_LOG_OBJECT (sink,
2099         "extending queue %d to respect time_min %" GST_TIME_FORMAT
2100         ", bytes_min %d, buffers_min %d", max_buffer_usage,
2101         GST_TIME_ARGS (sink->time_min), sink->bytes_min, sink->buffers_min);
2102
2103     /* get index where the limits are ok, we don't really care if all limits
2104      * are ok, we just queue as much as we need. We also don't compare against
2105      * the max limits. */
2106     find_limits (sink, &usage, sink->bytes_min, sink->buffers_min,
2107         sink->time_min, &max, -1, -1, -1);
2108
2109     max_buffer_usage = MAX (max_buffer_usage, usage + 1);
2110     GST_LOG_OBJECT (sink, "extended queue to %d", max_buffer_usage);
2111   }
2112
2113   /* now look for sync points and make sure there is at least one
2114    * sync point in the queue. We only do this if the LATEST_KEYFRAME or 
2115    * BURST_KEYFRAME mode is selected */
2116   if (sink->def_sync_method == GST_SYNC_METHOD_LATEST_KEYFRAME ||
2117       sink->def_sync_method == GST_SYNC_METHOD_BURST_KEYFRAME) {
2118     /* no point in searching beyond the queue length */
2119     gint limit = queuelen;
2120     GstBuffer *buf;
2121
2122     /* no point in searching beyond the soft-max if any. */
2123     if (soft_max_buffers) {
2124       limit = MIN (limit, soft_max_buffers);
2125     }
2126     GST_LOG_OBJECT (sink, "extending queue to include sync point, now at %d",
2127         max_buffer_usage);
2128     for (i = 0; i < limit; i++) {
2129       buf = g_array_index (sink->bufqueue, GstBuffer *, i);
2130       if (is_sync_frame (sink, buf)) {
2131         /* found a sync frame, now extend the buffer usage to
2132          * include at least this frame. */
2133         max_buffer_usage = MAX (max_buffer_usage, i);
2134         break;
2135       }
2136     }
2137     GST_LOG_OBJECT (sink, "max buffer usage is now %d", max_buffer_usage);
2138   }
2139
2140   GST_LOG_OBJECT (sink, "len %d, usage %d", queuelen, max_buffer_usage);
2141
2142   /* nobody is referencing units after max_buffer_usage so we can
2143    * remove them from the queue. We remove them in reverse order as
2144    * this is the most optimal for GArray. */
2145   for (i = queuelen - 1; i > max_buffer_usage; i--) {
2146     GstBuffer *old;
2147
2148     /* queue exceeded max size */
2149     queuelen--;
2150     old = g_array_index (sink->bufqueue, GstBuffer *, i);
2151     sink->bufqueue = g_array_remove_index (sink->bufqueue, i);
2152
2153     /* unref tail buffer */
2154     gst_buffer_unref (old);
2155   }
2156   /* save for stats */
2157   sink->buffers_queued = max_buffer_usage;
2158   CLIENTS_UNLOCK (sink);
2159
2160   /* and send a signal to thread if fd_set changed */
2161   if (need_signal) {
2162     SEND_COMMAND (sink, CONTROL_RESTART);
2163   }
2164 }
2165
2166 /* Handle the clients. Basically does a blocking select for one
2167  * of the client fds to become read or writable. We also have a
2168  * filedescriptor to receive commands on that we need to check.
2169  *
2170  * After going out of the select call, we read and write to all
2171  * clients that can do so. Badly behaving clients are put on a
2172  * garbage list and removed.
2173  */
2174 static void
2175 gst_multi_fd_sink_handle_clients (GstMultiFdSink * sink)
2176 {
2177   int result;
2178   GList *clients, *next;
2179   gboolean try_again;
2180   GstMultiFdSinkClass *fclass;
2181   guint cookie;
2182
2183   fclass = GST_MULTI_FD_SINK_GET_CLASS (sink);
2184
2185   do {
2186     gboolean stop = FALSE;
2187
2188     try_again = FALSE;
2189
2190     /* check for:
2191      * - server socket input (ie, new client connections)
2192      * - client socket input (ie, clients saying goodbye)
2193      * - client socket output (ie, client reads)          */
2194     GST_LOG_OBJECT (sink, "waiting on action on fdset");
2195     result = gst_fdset_wait (sink->fdset, -1);
2196
2197     /* < 0 is an error, 0 just means a timeout happened, which is impossible */
2198     if (result < 0) {
2199       GST_WARNING_OBJECT (sink, "wait failed: %s (%d)", g_strerror (errno),
2200           errno);
2201       if (errno == EBADF) {
2202         /* ok, so one or more of the fds is invalid. We loop over them to find
2203          * the ones that give an error to the F_GETFL fcntl. */
2204         CLIENTS_LOCK (sink);
2205       restart:
2206         cookie = sink->clients_cookie;
2207         for (clients = sink->clients; clients; clients = next) {
2208           GstTCPClient *client;
2209           int fd;
2210           long flags;
2211           int res;
2212
2213           if (cookie != sink->clients_cookie) {
2214             GST_DEBUG_OBJECT (sink, "Cookie changed finding bad fd");
2215             goto restart;
2216           }
2217
2218           client = (GstTCPClient *) clients->data;
2219           next = g_list_next (clients);
2220
2221           fd = client->fd.fd;
2222
2223           res = fcntl (fd, F_GETFL, &flags);
2224           if (res == -1) {
2225             GST_WARNING_OBJECT (sink, "fnctl failed for %d, removing: %s (%d)",
2226                 fd, g_strerror (errno), errno);
2227             if (errno == EBADF) {
2228               client->status = GST_CLIENT_STATUS_ERROR;
2229               gst_multi_fd_sink_remove_client_link (sink, clients);
2230             }
2231           }
2232         }
2233         CLIENTS_UNLOCK (sink);
2234         /* after this, go back in the select loop as the read/writefds
2235          * are not valid */
2236         try_again = TRUE;
2237       } else if (errno == EINTR) {
2238         /* interrupted system call, just redo the select */
2239         try_again = TRUE;
2240       } else {
2241         /* this is quite bad... */
2242         GST_ELEMENT_ERROR (sink, RESOURCE, READ, (NULL),
2243             ("select failed: %s (%d)", g_strerror (errno), errno));
2244         return;
2245       }
2246     } else {
2247       GST_LOG_OBJECT (sink, "wait done: %d sockets with events", result);
2248       /* read all commands */
2249       if (gst_fdset_fd_can_read (sink->fdset, &READ_SOCKET (sink))) {
2250         GST_LOG_OBJECT (sink, "have a command");
2251         while (TRUE) {
2252           gchar command;
2253           int res;
2254
2255           READ_COMMAND (sink, command, res);
2256           if (res <= 0) {
2257             GST_LOG_OBJECT (sink, "no more commands");
2258             /* no more commands */
2259             break;
2260           }
2261
2262           switch (command) {
2263             case CONTROL_RESTART:
2264               GST_LOG_OBJECT (sink, "restart");
2265               /* need to restart the select call as the fd_set changed */
2266               /* if other file descriptors than the READ_SOCKET had activity,
2267                * we don't restart just yet, but handle the other clients first
2268                */
2269               if (result == 1)
2270                 try_again = TRUE;
2271               break;
2272             case CONTROL_STOP:
2273               /* break out of the select loop */
2274               GST_LOG_OBJECT (sink, "stop");
2275               /* stop this function */
2276               stop = TRUE;
2277               break;
2278             default:
2279               GST_WARNING_OBJECT (sink, "unkown");
2280               g_warning ("multifdsink: unknown control message received");
2281               break;
2282           }
2283         }
2284       }
2285     }
2286     if (stop) {
2287       return;
2288     }
2289   } while (try_again);
2290
2291   /* subclasses can check fdset with this virtual function */
2292   if (fclass->wait)
2293     fclass->wait (sink, sink->fdset);
2294
2295   /* Check the clients */
2296   CLIENTS_LOCK (sink);
2297
2298 restart2:
2299   cookie = sink->clients_cookie;
2300   for (clients = sink->clients; clients; clients = next) {
2301     GstTCPClient *client;
2302
2303     if (sink->clients_cookie != cookie) {
2304       GST_DEBUG_OBJECT (sink, "Restarting loop, cookie out of date");
2305       goto restart2;
2306     }
2307
2308     client = (GstTCPClient *) clients->data;
2309     next = g_list_next (clients);
2310
2311     if (client->status != GST_CLIENT_STATUS_OK) {
2312       gst_multi_fd_sink_remove_client_link (sink, clients);
2313       continue;
2314     }
2315
2316     if (gst_fdset_fd_has_closed (sink->fdset, &client->fd)) {
2317       client->status = GST_CLIENT_STATUS_CLOSED;
2318       gst_multi_fd_sink_remove_client_link (sink, clients);
2319       continue;
2320     }
2321     if (gst_fdset_fd_has_error (sink->fdset, &client->fd)) {
2322       GST_WARNING_OBJECT (sink, "gst_fdset_fd_has_error for %d", client->fd.fd);
2323       client->status = GST_CLIENT_STATUS_ERROR;
2324       gst_multi_fd_sink_remove_client_link (sink, clients);
2325       continue;
2326     }
2327     if (gst_fdset_fd_can_read (sink->fdset, &client->fd)) {
2328       /* handle client read */
2329       if (!gst_multi_fd_sink_handle_client_read (sink, client)) {
2330         gst_multi_fd_sink_remove_client_link (sink, clients);
2331         continue;
2332       }
2333     }
2334     if (gst_fdset_fd_can_write (sink->fdset, &client->fd)) {
2335       /* handle client write */
2336       if (!gst_multi_fd_sink_handle_client_write (sink, client)) {
2337         gst_multi_fd_sink_remove_client_link (sink, clients);
2338         continue;
2339       }
2340     }
2341   }
2342   CLIENTS_UNLOCK (sink);
2343 }
2344
2345 /* we handle the client communication in another thread so that we do not block
2346  * the gstreamer thread while we select() on the client fds */
2347 static gpointer
2348 gst_multi_fd_sink_thread (GstMultiFdSink * sink)
2349 {
2350   while (sink->running) {
2351     gst_multi_fd_sink_handle_clients (sink);
2352   }
2353   return NULL;
2354 }
2355
2356 static GstFlowReturn
2357 gst_multi_fd_sink_render (GstBaseSink * bsink, GstBuffer * buf)
2358 {
2359   GstMultiFdSink *sink;
2360   gboolean in_caps;
2361   GstCaps *bufcaps, *padcaps;
2362
2363   sink = GST_MULTI_FD_SINK (bsink);
2364
2365   g_return_val_if_fail (GST_OBJECT_FLAG_IS_SET (sink, GST_MULTI_FD_SINK_OPEN),
2366       GST_FLOW_WRONG_STATE);
2367
2368   /* since we check every buffer for streamheader caps, we need to make
2369    * sure every buffer has caps set */
2370   bufcaps = gst_buffer_get_caps (buf);
2371   padcaps = GST_PAD_CAPS (GST_BASE_SINK_PAD (bsink));
2372
2373   /* make sure we have caps on the pad */
2374   if (!padcaps && !bufcaps)
2375     goto no_caps;
2376
2377   /* get IN_CAPS first, code below might mess with the flags */
2378   in_caps = GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_IN_CAPS);
2379
2380   /* stamp the buffer with previous caps if no caps set */
2381   if (!bufcaps) {
2382     if (!gst_buffer_is_metadata_writable (buf)) {
2383       /* metadata is not writable, copy will be made and original buffer
2384        * will be unreffed so we need to ref so that we don't lose the
2385        * buffer in the render method. */
2386       gst_buffer_ref (buf);
2387       /* the new buffer is ours only, we keep it out of the scope of this
2388        * function */
2389       buf = gst_buffer_make_metadata_writable (buf);
2390     } else {
2391       /* else the metadata is writable, we ref because we keep the buffer
2392        * out of the scope of this method */
2393       gst_buffer_ref (buf);
2394     }
2395     /* buffer metadata is writable now, set the caps */
2396     gst_buffer_set_caps (buf, padcaps);
2397   } else {
2398     gst_caps_unref (bufcaps);
2399
2400     /* since we keep this buffer out of the scope of this method */
2401     gst_buffer_ref (buf);
2402   }
2403
2404   GST_LOG_OBJECT (sink, "received buffer %p, in_caps: %d", buf, in_caps);
2405
2406   /* if we get IN_CAPS buffers, but the previous buffer was not IN_CAPS,
2407    * it means we're getting new streamheader buffers, and we should clear
2408    * the old ones */
2409   if (in_caps && sink->previous_buffer_in_caps == FALSE) {
2410     GST_DEBUG_OBJECT (sink,
2411         "receiving new IN_CAPS buffers, clearing old streamheader");
2412     g_slist_foreach (sink->streamheader, (GFunc) gst_mini_object_unref, NULL);
2413     g_slist_free (sink->streamheader);
2414     sink->streamheader = NULL;
2415   }
2416
2417   /* save the current in_caps */
2418   sink->previous_buffer_in_caps = in_caps;
2419
2420   /* if the incoming buffer is marked as IN CAPS, then we assume for now
2421    * it's a streamheader that needs to be sent to each new client, so we
2422    * put it on our internal list of streamheader buffers.
2423    * FIXME: we could check if the buffer's contents are in fact part of the
2424    * current streamheader.
2425    *
2426    * We don't send the buffer to the client, since streamheaders are sent
2427    * separately when necessary. */
2428   if (in_caps) {
2429     GST_DEBUG_OBJECT (sink,
2430         "appending IN_CAPS buffer with length %d to streamheader",
2431         GST_BUFFER_SIZE (buf));
2432     sink->streamheader = g_slist_append (sink->streamheader, buf);
2433   } else {
2434     /* queue the buffer, this is a regular data buffer. */
2435     gst_multi_fd_sink_queue_buffer (sink, buf);
2436
2437     sink->bytes_to_serve += GST_BUFFER_SIZE (buf);
2438   }
2439   return GST_FLOW_OK;
2440
2441   /* ERRORS */
2442 no_caps:
2443   {
2444     GST_ELEMENT_ERROR (sink, CORE, NEGOTIATION, (NULL),
2445         ("Received first buffer without caps set"));
2446     return GST_FLOW_NOT_NEGOTIATED;
2447   }
2448 }
2449
2450 static void
2451 gst_multi_fd_sink_set_property (GObject * object, guint prop_id,
2452     const GValue * value, GParamSpec * pspec)
2453 {
2454   GstMultiFdSink *multifdsink;
2455
2456   multifdsink = GST_MULTI_FD_SINK (object);
2457
2458   switch (prop_id) {
2459     case PROP_PROTOCOL:
2460       multifdsink->protocol = g_value_get_enum (value);
2461       break;
2462     case PROP_MODE:
2463       multifdsink->mode = g_value_get_enum (value);
2464       break;
2465     case PROP_BUFFERS_MAX:
2466       multifdsink->units_max = g_value_get_int (value);
2467       break;
2468     case PROP_BUFFERS_SOFT_MAX:
2469       multifdsink->units_soft_max = g_value_get_int (value);
2470       break;
2471     case PROP_TIME_MIN:
2472       multifdsink->time_min = g_value_get_int64 (value);
2473       break;
2474     case PROP_BYTES_MIN:
2475       multifdsink->bytes_min = g_value_get_int (value);
2476       break;
2477     case PROP_BUFFERS_MIN:
2478       multifdsink->buffers_min = g_value_get_int (value);
2479       break;
2480     case PROP_UNIT_TYPE:
2481       multifdsink->unit_type = g_value_get_enum (value);
2482       break;
2483     case PROP_UNITS_MAX:
2484       multifdsink->units_max = g_value_get_int64 (value);
2485       break;
2486     case PROP_UNITS_SOFT_MAX:
2487       multifdsink->units_soft_max = g_value_get_int64 (value);
2488       break;
2489     case PROP_RECOVER_POLICY:
2490       multifdsink->recover_policy = g_value_get_enum (value);
2491       break;
2492     case PROP_TIMEOUT:
2493       multifdsink->timeout = g_value_get_uint64 (value);
2494       break;
2495     case PROP_SYNC_METHOD:
2496       multifdsink->def_sync_method = g_value_get_enum (value);
2497       break;
2498     case PROP_BURST_UNIT:
2499       multifdsink->def_burst_unit = g_value_get_enum (value);
2500       break;
2501     case PROP_BURST_VALUE:
2502       multifdsink->def_burst_value = g_value_get_uint64 (value);
2503       break;
2504
2505     default:
2506       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2507       break;
2508   }
2509 }
2510
2511 static void
2512 gst_multi_fd_sink_get_property (GObject * object, guint prop_id, GValue * value,
2513     GParamSpec * pspec)
2514 {
2515   GstMultiFdSink *multifdsink;
2516
2517   multifdsink = GST_MULTI_FD_SINK (object);
2518
2519   switch (prop_id) {
2520     case PROP_PROTOCOL:
2521       g_value_set_enum (value, multifdsink->protocol);
2522       break;
2523     case PROP_MODE:
2524       g_value_set_enum (value, multifdsink->mode);
2525       break;
2526     case PROP_BUFFERS_MAX:
2527       g_value_set_int (value, multifdsink->units_max);
2528       break;
2529     case PROP_BUFFERS_SOFT_MAX:
2530       g_value_set_int (value, multifdsink->units_soft_max);
2531       break;
2532     case PROP_TIME_MIN:
2533       g_value_set_int64 (value, multifdsink->time_min);
2534       break;
2535     case PROP_BYTES_MIN:
2536       g_value_set_int (value, multifdsink->bytes_min);
2537       break;
2538     case PROP_BUFFERS_MIN:
2539       g_value_set_int (value, multifdsink->buffers_min);
2540       break;
2541     case PROP_BUFFERS_QUEUED:
2542       g_value_set_uint (value, multifdsink->buffers_queued);
2543       break;
2544     case PROP_BYTES_QUEUED:
2545       g_value_set_uint (value, multifdsink->bytes_queued);
2546       break;
2547     case PROP_TIME_QUEUED:
2548       g_value_set_uint64 (value, multifdsink->time_queued);
2549       break;
2550     case PROP_UNIT_TYPE:
2551       g_value_set_enum (value, multifdsink->unit_type);
2552       break;
2553     case PROP_UNITS_MAX:
2554       g_value_set_int64 (value, multifdsink->units_max);
2555       break;
2556     case PROP_UNITS_SOFT_MAX:
2557       g_value_set_int64 (value, multifdsink->units_soft_max);
2558       break;
2559     case PROP_RECOVER_POLICY:
2560       g_value_set_enum (value, multifdsink->recover_policy);
2561       break;
2562     case PROP_TIMEOUT:
2563       g_value_set_uint64 (value, multifdsink->timeout);
2564       break;
2565     case PROP_SYNC_METHOD:
2566       g_value_set_enum (value, multifdsink->def_sync_method);
2567       break;
2568     case PROP_BYTES_TO_SERVE:
2569       g_value_set_uint64 (value, multifdsink->bytes_to_serve);
2570       break;
2571     case PROP_BYTES_SERVED:
2572       g_value_set_uint64 (value, multifdsink->bytes_served);
2573       break;
2574     case PROP_BURST_UNIT:
2575       g_value_set_enum (value, multifdsink->def_burst_unit);
2576       break;
2577     case PROP_BURST_VALUE:
2578       g_value_set_uint64 (value, multifdsink->def_burst_value);
2579       break;
2580
2581     default:
2582       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2583       break;
2584   }
2585 }
2586
2587
2588 /* create a socket for sending to remote machine */
2589 static gboolean
2590 gst_multi_fd_sink_start (GstBaseSink * bsink)
2591 {
2592   GstMultiFdSinkClass *fclass;
2593   int control_socket[2];
2594   GstMultiFdSink *this;
2595
2596   if (GST_OBJECT_FLAG_IS_SET (bsink, GST_MULTI_FD_SINK_OPEN))
2597     return TRUE;
2598
2599   this = GST_MULTI_FD_SINK (bsink);
2600   fclass = GST_MULTI_FD_SINK_GET_CLASS (this);
2601
2602   GST_INFO_OBJECT (this, "starting in mode %d", this->mode);
2603   this->fdset = gst_fdset_new (this->mode);
2604
2605   if (socketpair (PF_UNIX, SOCK_STREAM, 0, control_socket) < 0)
2606     goto socket_pair;
2607
2608   READ_SOCKET (this).fd = control_socket[0];
2609   WRITE_SOCKET (this).fd = control_socket[1];
2610
2611   gst_fdset_add_fd (this->fdset, &READ_SOCKET (this));
2612   gst_fdset_fd_ctl_read (this->fdset, &READ_SOCKET (this), TRUE);
2613
2614   fcntl (READ_SOCKET (this).fd, F_SETFL, O_NONBLOCK);
2615   fcntl (WRITE_SOCKET (this).fd, F_SETFL, O_NONBLOCK);
2616
2617   this->streamheader = NULL;
2618   this->bytes_to_serve = 0;
2619   this->bytes_served = 0;
2620
2621   if (fclass->init) {
2622     fclass->init (this);
2623   }
2624
2625   this->running = TRUE;
2626   this->thread = g_thread_create ((GThreadFunc) gst_multi_fd_sink_thread,
2627       this, TRUE, NULL);
2628
2629   GST_OBJECT_FLAG_SET (this, GST_MULTI_FD_SINK_OPEN);
2630
2631   return TRUE;
2632
2633   /* ERRORS */
2634 socket_pair:
2635   {
2636     GST_ELEMENT_ERROR (this, RESOURCE, OPEN_READ_WRITE, (NULL),
2637         GST_ERROR_SYSTEM);
2638     return FALSE;
2639   }
2640 }
2641
2642 static gboolean
2643 multifdsink_hash_remove (gpointer key, gpointer value, gpointer data)
2644 {
2645   return TRUE;
2646 }
2647
2648 static gboolean
2649 gst_multi_fd_sink_stop (GstBaseSink * bsink)
2650 {
2651   GstMultiFdSinkClass *fclass;
2652   GstMultiFdSink *this;
2653   GstBuffer *buf;
2654   int i;
2655
2656   this = GST_MULTI_FD_SINK (bsink);
2657   fclass = GST_MULTI_FD_SINK_GET_CLASS (this);
2658
2659   if (!GST_OBJECT_FLAG_IS_SET (bsink, GST_MULTI_FD_SINK_OPEN))
2660     return TRUE;
2661
2662   this->running = FALSE;
2663
2664   SEND_COMMAND (this, CONTROL_STOP);
2665   if (this->thread) {
2666     GST_DEBUG_OBJECT (this, "joining thread");
2667     g_thread_join (this->thread);
2668     GST_DEBUG_OBJECT (this, "joined thread");
2669     this->thread = NULL;
2670   }
2671
2672   /* free the clients */
2673   gst_multi_fd_sink_clear (this);
2674
2675   close (READ_SOCKET (this).fd);
2676   close (WRITE_SOCKET (this).fd);
2677
2678   if (this->streamheader) {
2679     g_slist_foreach (this->streamheader, (GFunc) gst_mini_object_unref, NULL);
2680     g_slist_free (this->streamheader);
2681     this->streamheader = NULL;
2682   }
2683
2684   if (fclass->close)
2685     fclass->close (this);
2686
2687   if (this->fdset) {
2688     gst_fdset_remove_fd (this->fdset, &READ_SOCKET (this));
2689     gst_fdset_free (this->fdset);
2690     this->fdset = NULL;
2691   }
2692   g_hash_table_foreach_remove (this->fd_hash, multifdsink_hash_remove, this);
2693
2694   /* remove all queued buffers */
2695   if (this->bufqueue) {
2696     GST_DEBUG_OBJECT (this, "Emptying bufqueue with %d buffers",
2697         this->bufqueue->len);
2698     for (i = this->bufqueue->len - 1; i >= 0; --i) {
2699       buf = g_array_index (this->bufqueue, GstBuffer *, i);
2700       GST_LOG_OBJECT (this, "Removing buffer %p (%d) with refcount %d", buf, i,
2701           GST_MINI_OBJECT_REFCOUNT (buf));
2702       gst_buffer_unref (buf);
2703       this->bufqueue = g_array_remove_index (this->bufqueue, i);
2704     }
2705     /* freeing the array is done in _finalize */
2706   }
2707   GST_OBJECT_FLAG_UNSET (this, GST_MULTI_FD_SINK_OPEN);
2708
2709   return TRUE;
2710 }
2711
2712 static GstStateChangeReturn
2713 gst_multi_fd_sink_change_state (GstElement * element, GstStateChange transition)
2714 {
2715   GstMultiFdSink *sink;
2716   GstStateChangeReturn ret;
2717
2718   sink = GST_MULTI_FD_SINK (element);
2719
2720   /* we disallow changing the state from the streaming thread */
2721   if (g_thread_self () == sink->thread)
2722     return GST_STATE_CHANGE_FAILURE;
2723
2724
2725   switch (transition) {
2726     case GST_STATE_CHANGE_NULL_TO_READY:
2727       if (!gst_multi_fd_sink_start (GST_BASE_SINK (sink)))
2728         goto start_failed;
2729       break;
2730     case GST_STATE_CHANGE_READY_TO_PAUSED:
2731       break;
2732     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
2733       break;
2734     default:
2735       break;
2736   }
2737
2738   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2739
2740   switch (transition) {
2741     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
2742       break;
2743     case GST_STATE_CHANGE_PAUSED_TO_READY:
2744       break;
2745     case GST_STATE_CHANGE_READY_TO_NULL:
2746       gst_multi_fd_sink_stop (GST_BASE_SINK (sink));
2747       break;
2748     default:
2749       break;
2750   }
2751   return ret;
2752
2753   /* ERRORS */
2754 start_failed:
2755   {
2756     /* error message was posted */
2757     return GST_STATE_CHANGE_FAILURE;
2758   }
2759 }