gst/tcp/gstmultihandlesink.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  * Copyright (C) <2011> Collabora Ltd.
   6  *     Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-multihandlesink
  26  * @see_also: tcpserversink
  27  *
  28  * This plugin writes incoming data to a set of file descriptors. The
  29  * file descriptors can be added to multihandlesink by emitting the #GstMultiHandleSink::add signal.
  30  * For each descriptor added, the #GstMultiHandleSink::client-added signal will be called.
  31  *
  32  * As of version 0.10.8, a client can also be added with the #GstMultiHandleSink::add-full signal
  33  * that allows for more control over what and how much data a client
  34  * initially receives.
  35  *
  36  * Clients can be removed from multihandlesink by emitting the #GstMultiHandleSink::remove signal. For
  37  * each descriptor removed, the #GstMultiHandleSink::client-removed signal will be called. The
  38  * #GstMultiHandleSink::client-removed signal can also be fired when multihandlesink decides that a
  39  * client is not active anymore or, depending on the value of the
  40  * #GstMultiHandleSink:recover-policy property, if the client is reading too slowly.
  41  * In all cases, multihandlesink will never close a file descriptor itself.
  42  * The user of multihandlesink is responsible for closing all file descriptors.
  43  * This can for example be done in response to the #GstMultiHandleSink::client-fd-removed signal.
  44  * Note that multihandlesink still has a reference to the file descriptor when the
  45  * #GstMultiHandleSink::client-removed signal is emitted, so that "get-stats" can be performed on
  46  * the descriptor; it is therefore not safe to close the file descriptor in
  47  * the #GstMultiHandleSink::client-removed signal handler, and you should use the
  48  * #GstMultiHandleSink::client-fd-removed signal to safely close the fd.
  49  *
  50  * Multisocketsink internally keeps a queue of the incoming buffers and uses a
  51  * separate thread to send the buffers to the clients. This ensures that no
  52  * client write can block the pipeline and that clients can read with different
  53  * speeds.
  54  *
  55  * When adding a client to multihandlesink, the #GstMultiHandleSink:sync-method property will define
  56  * which buffer in the queued buffers will be sent first to the client. Clients
  57  * can be sent the most recent buffer (which might not be decodable by the
  58  * client if it is not a keyframe), the next keyframe received in
  59  * multihandlesink (which can take some time depending on the keyframe rate), or the
  60  * last received keyframe (which will cause a simple burst-on-connect).
  61  * Multisocketsink will always keep at least one keyframe in its internal buffers
  62  * when the sync-mode is set to latest-keyframe.
  63  *
  64  * As of version 0.10.8, there are additional values for the #GstMultiHandleSink:sync-method
  65  * property to allow finer control over burst-on-connect behaviour. By selecting
  66  * the 'burst' method a minimum burst size can be chosen, 'burst-keyframe'
  67  * additionally requires that the burst begin with a keyframe, and
  68  * 'burst-with-keyframe' attempts to burst beginning with a keyframe, but will
  69  * prefer a minimum burst size even if it requires not starting with a keyframe.
  70  *
  71  * Multisocketsink can be instructed to keep at least a minimum amount of data
  72  * expressed in time or byte units in its internal queues with the
  73  * #GstMultiHandleSink:time-min and #GstMultiHandleSink:bytes-min properties respectively.
  74  * These properties are useful if the application adds clients with the
  75  * #GstMultiHandleSink::add-full signal to make sure that a burst connect can
  76  * actually be honored.
  77  *
  78  * When streaming data, clients are allowed to read at a different rate than
  79  * the rate at which multihandlesink receives data. If the client is reading too
  80  * fast, no data will be send to the client until multihandlesink receives more
  81  * data. If the client, however, reads too slowly, data for that client will be
  82  * queued up in multihandlesink. Two properties control the amount of data
  83  * (buffers) that is queued in multihandlesink: #GstMultiHandleSink:buffers-max and
  84  * #GstMultiHandleSink:buffers-soft-max. A client that falls behind by
  85  * #GstMultiHandleSink:buffers-max is removed from multihandlesink forcibly.
  86  *
  87  * A client with a lag of at least #GstMultiHandleSink:buffers-soft-max enters the recovery
  88  * procedure which is controlled with the #GstMultiHandleSink:recover-policy property.
  89  * A recover policy of NONE will do nothing, RESYNC_LATEST will send the most recently
  90  * received buffer as the next buffer for the client, RESYNC_SOFT_LIMIT
  91  * positions the client to the soft limit in the buffer queue and
  92  * RESYNC_KEYFRAME positions the client at the most recent keyframe in the
  93  * buffer queue.
  94  *
  95  * multihandlesink will by default synchronize on the clock before serving the
  96  * buffers to the clients. This behaviour can be disabled by setting the sync
  97  * property to FALSE. Multisocketsink will by default not do QoS and will never
  98  * drop late buffers.
  99  *
 100  * Last reviewed on 2006-09-12 (0.10.10)
 101  */
 102
 103 #ifdef HAVE_CONFIG_H
 104 #include "config.h"
 105 #endif
 106
 107 #include <gst/gst-i18n-plugin.h>
 108
 109 #include "gstmultihandlesink.h"
 110 #include "gsttcp-marshal.h"
 111
 112 #ifdef HAVE_SYS_SOCKET_H
 113 #include <sys/socket.h>
 114 #endif
 115
 116 #ifndef G_OS_WIN32
 117 #include <netinet/in.h>
 118 #endif
 119
 120 #define NOT_IMPLEMENTED 0
 121
 122 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
 123     GST_PAD_SINK,
 124     GST_PAD_ALWAYS,
 125     GST_STATIC_CAPS_ANY);
 126
 127 GST_DEBUG_CATEGORY_STATIC (multihandlesink_debug);
 128 #define GST_CAT_DEFAULT (multihandlesink_debug)
 129
 130 /* MultiHandleSink signals and args */
 131 enum
 132 {
 133   GST_MULTI_SINK_LAST_SIGNAL,
 134
 135   /* methods */
 136   SIGNAL_ADD,
 137   SIGNAL_ADD_BURST,
 138   SIGNAL_CLEAR,
 139
 140   /* signals */
 141   SIGNAL_CLIENT_ADDED,
 142   SIGNAL_CLIENT_REMOVED,
 143   SIGNAL_CLIENT_SOCKET_REMOVED,
 144
 145   LAST_SIGNAL
 146 };
 147
 148
 149 /* this is really arbitrarily chosen */
 150 #define DEFAULT_BUFFERS_MAX             -1
 151 #define DEFAULT_BUFFERS_SOFT_MAX        -1
 152 #define DEFAULT_TIME_MIN                -1
 153 #define DEFAULT_BYTES_MIN               -1
 154 #define DEFAULT_BUFFERS_MIN             -1
 155 #define DEFAULT_UNIT_FORMAT               GST_FORMAT_BUFFERS
 156 #define DEFAULT_UNITS_MAX               -1
 157 #define DEFAULT_UNITS_SOFT_MAX          -1
 158 #define DEFAULT_RECOVER_POLICY          GST_RECOVER_POLICY_NONE
 159 #define DEFAULT_TIMEOUT                 0
 160 #define DEFAULT_SYNC_METHOD             GST_SYNC_METHOD_LATEST
 161
 162 #define DEFAULT_BURST_FORMAT            GST_FORMAT_UNDEFINED
 163 #define DEFAULT_BURST_VALUE             0
 164
 165 #define DEFAULT_QOS_DSCP                -1
 166
 167 #define DEFAULT_RESEND_STREAMHEADER      TRUE
 168
 169 enum
 170 {
 171   PROP_0,
 172   PROP_BUFFERS_QUEUED,
 173   PROP_BYTES_QUEUED,
 174   PROP_TIME_QUEUED,
 175
 176   PROP_UNIT_FORMAT,
 177   PROP_UNITS_MAX,
 178   PROP_UNITS_SOFT_MAX,
 179
 180   PROP_BUFFERS_MAX,
 181   PROP_BUFFERS_SOFT_MAX,
 182
 183   PROP_TIME_MIN,
 184   PROP_BYTES_MIN,
 185   PROP_BUFFERS_MIN,
 186
 187   PROP_RECOVER_POLICY,
 188   PROP_TIMEOUT,
 189   PROP_SYNC_METHOD,
 190   PROP_BYTES_TO_SERVE,
 191   PROP_BYTES_SERVED,
 192
 193   PROP_BURST_FORMAT,
 194   PROP_BURST_VALUE,
 195
 196   PROP_QOS_DSCP,
 197
 198   PROP_RESEND_STREAMHEADER,
 199
 200   PROP_NUM_HANDLES,
 201
 202   PROP_LAST
 203 };
 204
 205 GType
 206 gst_multi_handle_sink_recover_policy_get_type (void)
 207 {
 208   static GType recover_policy_type = 0;
 209   static const GEnumValue recover_policy[] = {
 210     {GST_RECOVER_POLICY_NONE,
 211         "Do not try to recover", "none"},
 212     {GST_RECOVER_POLICY_RESYNC_LATEST,
 213         "Resync client to latest buffer", "latest"},
 214     {GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT,
 215         "Resync client to soft limit", "soft-limit"},
 216     {GST_RECOVER_POLICY_RESYNC_KEYFRAME,
 217         "Resync client to most recent keyframe", "keyframe"},
 218     {0, NULL, NULL},
 219   };
 220
 221   if (!recover_policy_type) {
 222     recover_policy_type =
 223         g_enum_register_static ("GstMultiHandleSinkRecoverPolicy",
 224         recover_policy);
 225   }
 226   return recover_policy_type;
 227 }
 228
 229 GType
 230 gst_multi_handle_sink_sync_method_get_type (void)
 231 {
 232   static GType sync_method_type = 0;
 233   static const GEnumValue sync_method[] = {
 234     {GST_SYNC_METHOD_LATEST,
 235         "Serve starting from the latest buffer", "latest"},
 236     {GST_SYNC_METHOD_NEXT_KEYFRAME,
 237         "Serve starting from the next keyframe", "next-keyframe"},
 238     {GST_SYNC_METHOD_LATEST_KEYFRAME,
 239           "Serve everything since the latest keyframe (burst)",
 240         "latest-keyframe"},
 241     {GST_SYNC_METHOD_BURST, "Serve burst-value data to client", "burst"},
 242     {GST_SYNC_METHOD_BURST_KEYFRAME,
 243           "Serve burst-value data starting on a keyframe",
 244         "burst-keyframe"},
 245     {GST_SYNC_METHOD_BURST_WITH_KEYFRAME,
 246           "Serve burst-value data preferably starting on a keyframe",
 247         "burst-with-keyframe"},
 248     {0, NULL, NULL},
 249   };
 250
 251   if (!sync_method_type) {
 252     sync_method_type =
 253         g_enum_register_static ("GstMultiHandleSinkSyncMethod", sync_method);
 254   }
 255   return sync_method_type;
 256 }
 257
 258 GType
 259 gst_multi_handle_sink_client_status_get_type (void)
 260 {
 261   static GType client_status_type = 0;
 262   static const GEnumValue client_status[] = {
 263     {GST_CLIENT_STATUS_OK, "ok", "ok"},
 264     {GST_CLIENT_STATUS_CLOSED, "Closed", "closed"},
 265     {GST_CLIENT_STATUS_REMOVED, "Removed", "removed"},
 266     {GST_CLIENT_STATUS_SLOW, "Too slow", "slow"},
 267     {GST_CLIENT_STATUS_ERROR, "Error", "error"},
 268     {GST_CLIENT_STATUS_DUPLICATE, "Duplicate", "duplicate"},
 269     {GST_CLIENT_STATUS_FLUSHING, "Flushing", "flushing"},
 270     {0, NULL, NULL},
 271   };
 272
 273   if (!client_status_type) {
 274     client_status_type =
 275         g_enum_register_static ("GstMultiHandleSinkClientStatus",
 276         client_status);
 277   }
 278   return client_status_type;
 279 }
 280
 281 static void gst_multi_handle_sink_finalize (GObject * object);
 282 static void gst_multi_handle_sink_clear (GstMultiHandleSink * mhsink);
 283
 284 static GstFlowReturn gst_multi_handle_sink_render (GstBaseSink * bsink,
 285     GstBuffer * buf);
 286 static void gst_multi_handle_sink_queue_buffer (GstMultiHandleSink * mhsink,
 287     GstBuffer * buffer);
 288 static gboolean gst_multi_handle_sink_client_queue_buffer (GstMultiHandleSink *
 289     mhsink, GstMultiHandleClient * mhclient, GstBuffer * buffer);
 290 static GstStateChangeReturn gst_multi_handle_sink_change_state (GstElement *
 291     element, GstStateChange transition);
 292
 293 static void gst_multi_handle_sink_set_property (GObject * object, guint prop_id,
 294     const GValue * value, GParamSpec * pspec);
 295 static void gst_multi_handle_sink_get_property (GObject * object, guint prop_id,
 296     GValue * value, GParamSpec * pspec);
 297
 298 #define gst_multi_handle_sink_parent_class parent_class
 299 G_DEFINE_TYPE (GstMultiHandleSink, gst_multi_handle_sink, GST_TYPE_BASE_SINK);
 300
 301 static guint gst_multi_handle_sink_signals[LAST_SIGNAL] = { 0 };
 302
 303 static gint
 304 find_syncframe (GstMultiHandleSink * sink, gint idx, gint direction);
 305 #define find_next_syncframe(s,i)        find_syncframe(s,i,1)
 306 #define find_prev_syncframe(s,i)        find_syncframe(s,i,-1)
 307 static gboolean is_sync_frame (GstMultiHandleSink * sink, GstBuffer * buffer);
 308 static gboolean gst_multi_handle_sink_stop (GstBaseSink * bsink);
 309 static gboolean gst_multi_handle_sink_start (GstBaseSink * bsink);
 310 static gint get_buffers_max (GstMultiHandleSink * sink, gint64 max);
 311 static gint
 312 gst_multi_handle_sink_recover_client (GstMultiHandleSink * sink,
 313     GstMultiHandleClient * client);
 314 static void gst_multi_handle_sink_setup_dscp (GstMultiHandleSink * mhsink);
 315 static gboolean
 316 find_limits (GstMultiHandleSink * sink,
 317     gint * min_idx, gint bytes_min, gint buffers_min, gint64 time_min,
 318     gint * max_idx, gint bytes_max, gint buffers_max, gint64 time_max);
 319
 320
 321 static void
 322 gst_multi_handle_sink_class_init (GstMultiHandleSinkClass * klass)
 323 {
 324   GObjectClass *gobject_class;
 325   GstElementClass *gstelement_class;
 326   GstBaseSinkClass *gstbasesink_class;
 327
 328   gobject_class = (GObjectClass *) klass;
 329   gstelement_class = (GstElementClass *) klass;
 330   gstbasesink_class = (GstBaseSinkClass *) klass;
 331
 332   gobject_class->set_property = gst_multi_handle_sink_set_property;
 333   gobject_class->get_property = gst_multi_handle_sink_get_property;
 334   gobject_class->finalize = gst_multi_handle_sink_finalize;
 335
 336   g_object_class_install_property (gobject_class, PROP_BUFFERS_MAX,
 337       g_param_spec_int ("buffers-max", "Buffers max",
 338           "max number of buffers to queue for a client (-1 = no limit)", -1,
 339           G_MAXINT, DEFAULT_BUFFERS_MAX,
 340           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 341   g_object_class_install_property (gobject_class, PROP_BUFFERS_SOFT_MAX,
 342       g_param_spec_int ("buffers-soft-max", "Buffers soft max",
 343           "Recover client when going over this limit (-1 = no limit)", -1,
 344           G_MAXINT, DEFAULT_BUFFERS_SOFT_MAX,
 345           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 346
 347   g_object_class_install_property (gobject_class, PROP_BYTES_MIN,
 348       g_param_spec_int ("bytes-min", "Bytes min",
 349           "min number of bytes to queue (-1 = as little as possible)", -1,
 350           G_MAXINT, DEFAULT_BYTES_MIN,
 351           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 352   g_object_class_install_property (gobject_class, PROP_TIME_MIN,
 353       g_param_spec_int64 ("time-min", "Time min",
 354           "min number of time to queue (-1 = as little as possible)", -1,
 355           G_MAXINT64, DEFAULT_TIME_MIN,
 356           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 357   g_object_class_install_property (gobject_class, PROP_BUFFERS_MIN,
 358       g_param_spec_int ("buffers-min", "Buffers min",
 359           "min number of buffers to queue (-1 = as few as possible)", -1,
 360           G_MAXINT, DEFAULT_BUFFERS_MIN,
 361           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 362
 363   g_object_class_install_property (gobject_class, PROP_UNIT_FORMAT,
 364       g_param_spec_enum ("unit-format", "Units format",
 365           "The unit to measure the max/soft-max/queued properties",
 366           GST_TYPE_FORMAT, DEFAULT_UNIT_FORMAT,
 367           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 368   g_object_class_install_property (gobject_class, PROP_UNITS_MAX,
 369       g_param_spec_int64 ("units-max", "Units max",
 370           "max number of units to queue (-1 = no limit)", -1, G_MAXINT64,
 371           DEFAULT_UNITS_MAX, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 372   g_object_class_install_property (gobject_class, PROP_UNITS_SOFT_MAX,
 373       g_param_spec_int64 ("units-soft-max", "Units soft max",
 374           "Recover client when going over this limit (-1 = no limit)", -1,
 375           G_MAXINT64, DEFAULT_UNITS_SOFT_MAX,
 376           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 377
 378   g_object_class_install_property (gobject_class, PROP_BUFFERS_QUEUED,
 379       g_param_spec_uint ("buffers-queued", "Buffers queued",
 380           "Number of buffers currently queued", 0, G_MAXUINT, 0,
 381           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 382 #if NOT_IMPLEMENTED
 383   g_object_class_install_property (gobject_class, PROP_BYTES_QUEUED,
 384       g_param_spec_uint ("bytes-queued", "Bytes queued",
 385           "Number of bytes currently queued", 0, G_MAXUINT, 0,
 386           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 387   g_object_class_install_property (gobject_class, PROP_TIME_QUEUED,
 388       g_param_spec_uint64 ("time-queued", "Time queued",
 389           "Number of time currently queued", 0, G_MAXUINT64, 0,
 390           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 391 #endif
 392
 393   g_object_class_install_property (gobject_class, PROP_RECOVER_POLICY,
 394       g_param_spec_enum ("recover-policy", "Recover Policy",
 395           "How to recover when client reaches the soft max",
 396           GST_TYPE_RECOVER_POLICY, DEFAULT_RECOVER_POLICY,
 397           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 398   g_object_class_install_property (gobject_class, PROP_TIMEOUT,
 399       g_param_spec_uint64 ("timeout", "Timeout",
 400           "Maximum inactivity timeout in nanoseconds for a client (0 = no limit)",
 401           0, G_MAXUINT64, DEFAULT_TIMEOUT,
 402           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 403   g_object_class_install_property (gobject_class, PROP_SYNC_METHOD,
 404       g_param_spec_enum ("sync-method", "Sync Method",
 405           "How to sync new clients to the stream", GST_TYPE_SYNC_METHOD,
 406           DEFAULT_SYNC_METHOD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 407   g_object_class_install_property (gobject_class, PROP_BYTES_TO_SERVE,
 408       g_param_spec_uint64 ("bytes-to-serve", "Bytes to serve",
 409           "Number of bytes received to serve to clients", 0, G_MAXUINT64, 0,
 410           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 411   g_object_class_install_property (gobject_class, PROP_BYTES_SERVED,
 412       g_param_spec_uint64 ("bytes-served", "Bytes served",
 413           "Total number of bytes send to all clients", 0, G_MAXUINT64, 0,
 414           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 415
 416   g_object_class_install_property (gobject_class, PROP_BURST_FORMAT,
 417       g_param_spec_enum ("burst-format", "Burst format",
 418           "The format of the burst units (when sync-method is burst[[-with]-keyframe])",
 419           GST_TYPE_FORMAT, DEFAULT_BURST_FORMAT,
 420           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 421   g_object_class_install_property (gobject_class, PROP_BURST_VALUE,
 422       g_param_spec_uint64 ("burst-value", "Burst value",
 423           "The amount of burst expressed in burst-format", 0, G_MAXUINT64,
 424           DEFAULT_BURST_VALUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 425
 426   g_object_class_install_property (gobject_class, PROP_QOS_DSCP,
 427       g_param_spec_int ("qos-dscp", "QoS diff srv code point",
 428           "Quality of Service, differentiated services code point (-1 default)",
 429           -1, 63, DEFAULT_QOS_DSCP,
 430           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 431
 432   /**
 433    * GstMultiHandleSink::resend-streamheader
 434    *
 435    * Resend the streamheaders to existing clients when they change.
 436    *
 437    * Since: 0.10.23
 438    */
 439   g_object_class_install_property (gobject_class, PROP_RESEND_STREAMHEADER,
 440       g_param_spec_boolean ("resend-streamheader", "Resend streamheader",
 441           "Resend the streamheader if it changes in the caps",
 442           DEFAULT_RESEND_STREAMHEADER,
 443           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 444
 445   g_object_class_install_property (gobject_class, PROP_NUM_HANDLES,
 446       g_param_spec_uint ("num-handles", "Number of handles",
 447           "The current number of client handles",
 448           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 449
 450   /**
 451    * GstMultiHandleSink::clear:
 452    * @gstmultihandlesink: the multihandlesink element to emit this signal on
 453    *
 454    * Remove all sockets from multihandlesink.  Since multihandlesink did not
 455    * open sockets itself, it does not explicitly close the sockets. The application
 456    * should do so by connecting to the client-socket-removed callback.
 457    */
 458   gst_multi_handle_sink_signals[SIGNAL_CLEAR] =
 459       g_signal_new ("clear", G_TYPE_FROM_CLASS (klass),
 460       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
 461       G_STRUCT_OFFSET (GstMultiHandleSinkClass, clear), NULL, NULL,
 462       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 463
 464   gst_element_class_add_pad_template (gstelement_class,
 465       gst_static_pad_template_get (&sinktemplate));
 466
 467   gst_element_class_set_static_metadata (gstelement_class,
 468       "Multi socket sink", "Sink/Network",
 469       "Send data to multiple sockets",
 470       "Thomas Vander Stichele <thomas at apestaart dot org>, "
 471       "Wim Taymans <wim@fluendo.com>, "
 472       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 473
 474   gstelement_class->change_state =
 475       GST_DEBUG_FUNCPTR (gst_multi_handle_sink_change_state);
 476
 477   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_render);
 478   klass->client_queue_buffer =
 479       GST_DEBUG_FUNCPTR (gst_multi_handle_sink_client_queue_buffer);
 480
 481 #if 0
 482   klass->add = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_add);
 483   klass->add_full = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_add_full);
 484   klass->remove = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_remove);
 485   klass->remove_flush = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_remove_flush);
 486 #endif
 487
 488   klass->clear = GST_DEBUG_FUNCPTR (gst_multi_handle_sink_clear);
 489
 490   GST_DEBUG_CATEGORY_INIT (multihandlesink_debug, "multihandlesink", 0,
 491       "Multi socket sink");
 492 }
 493
 494 static void
 495 gst_multi_handle_sink_init (GstMultiHandleSink * this)
 496 {
 497   GST_OBJECT_FLAG_UNSET (this, GST_MULTI_HANDLE_SINK_OPEN);
 498
 499   CLIENTS_LOCK_INIT (this);
 500   this->clients = NULL;
 501
 502   this->bufqueue = g_array_new (FALSE, TRUE, sizeof (GstBuffer *));
 503   this->unit_format = DEFAULT_UNIT_FORMAT;
 504   this->units_max = DEFAULT_UNITS_MAX;
 505   this->units_soft_max = DEFAULT_UNITS_SOFT_MAX;
 506   this->time_min = DEFAULT_TIME_MIN;
 507   this->bytes_min = DEFAULT_BYTES_MIN;
 508   this->buffers_min = DEFAULT_BUFFERS_MIN;
 509   this->recover_policy = DEFAULT_RECOVER_POLICY;
 510
 511   this->timeout = DEFAULT_TIMEOUT;
 512   this->def_sync_method = DEFAULT_SYNC_METHOD;
 513
 514   this->def_burst_format = DEFAULT_BURST_FORMAT;
 515   this->def_burst_value = DEFAULT_BURST_VALUE;
 516
 517   this->qos_dscp = DEFAULT_QOS_DSCP;
 518
 519   this->resend_streamheader = DEFAULT_RESEND_STREAMHEADER;
 520 }
 521
 522 static void
 523 gst_multi_handle_sink_finalize (GObject * object)
 524 {
 525   GstMultiHandleSink *this;
 526
 527   this = GST_MULTI_HANDLE_SINK (object);
 528
 529   CLIENTS_LOCK_CLEAR (this);
 530   g_array_free (this->bufqueue, TRUE);
 531   g_hash_table_destroy (this->handle_hash);
 532
 533   G_OBJECT_CLASS (parent_class)->finalize (object);
 534 }
 535
 536 gint
 537 gst_multi_handle_sink_setup_dscp_client (GstMultiHandleSink * sink,
 538     GstMultiHandleClient * client)
 539 {
 540 #if !defined(IP_TOS) || !defined(HAVE_SYS_SOCKET_H)
 541   return 0;
 542 #else
 543   gint tos;
 544   gint ret;
 545   int fd;
 546   union gst_sockaddr
 547   {
 548     struct sockaddr sa;
 549     struct sockaddr_in6 sa_in6;
 550     struct sockaddr_storage sa_stor;
 551   } sa;
 552   socklen_t slen = sizeof (sa);
 553   gint af;
 554   GstMultiHandleSinkClass *mhsinkclass = GST_MULTI_HANDLE_SINK_GET_CLASS (sink);
 555
 556   /* don't touch */
 557   if (sink->qos_dscp < 0)
 558     return 0;
 559
 560   fd = mhsinkclass->client_get_fd (client);
 561
 562   if ((ret = getsockname (fd, &sa.sa, &slen)) < 0) {
 563     GST_DEBUG_OBJECT (sink, "could not get sockname: %s", g_strerror (errno));
 564     return ret;
 565   }
 566
 567   af = sa.sa.sa_family;
 568
 569   /* if this is an IPv4-mapped address then do IPv4 QoS */
 570   if (af == AF_INET6) {
 571
 572     GST_DEBUG_OBJECT (sink, "check IP6 socket");
 573     if (IN6_IS_ADDR_V4MAPPED (&(sa.sa_in6.sin6_addr))) {
 574       GST_DEBUG_OBJECT (sink, "mapped to IPV4");
 575       af = AF_INET;
 576     }
 577   }
 578
 579   /* extract and shift 6 bits of the DSCP */
 580   tos = (sink->qos_dscp & 0x3f) << 2;
 581
 582   switch (af) {
 583     case AF_INET:
 584       ret = setsockopt (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos));
 585       break;
 586     case AF_INET6:
 587 #ifdef IPV6_TCLASS
 588       ret = setsockopt (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos));
 589       break;
 590 #endif
 591     default:
 592       ret = 0;
 593       GST_ERROR_OBJECT (sink, "unsupported AF");
 594       break;
 595   }
 596   if (ret)
 597     GST_DEBUG_OBJECT (sink, "could not set DSCP: %s", g_strerror (errno));
 598
 599   return ret;
 600 #endif
 601 }
 602
 603 void
 604 gst_multi_handle_sink_client_init (GstMultiHandleClient * client,
 605     GstSyncMethod sync_method)
 606 {
 607   GTimeVal now;
 608
 609   client->status = GST_CLIENT_STATUS_OK;
 610   client->bufpos = -1;
 611   client->flushcount = -1;
 612   client->bufoffset = 0;
 613   client->sending = NULL;
 614   client->bytes_sent = 0;
 615   client->dropped_buffers = 0;
 616   client->avg_queue_size = 0;
 617   client->first_buffer_ts = GST_CLOCK_TIME_NONE;
 618   client->last_buffer_ts = GST_CLOCK_TIME_NONE;
 619   client->new_connection = TRUE;
 620   client->sync_method = sync_method;
 621   client->currently_removing = FALSE;
 622
 623   /* update start time */
 624   g_get_current_time (&now);
 625   client->connect_time = GST_TIMEVAL_TO_TIME (now);
 626   client->disconnect_time = 0;
 627   /* set last activity time to connect time */
 628   client->last_activity_time = client->connect_time;
 629 }
 630
 631 static void
 632 gst_multi_handle_sink_setup_dscp (GstMultiHandleSink * mhsink)
 633 {
 634   GList *clients;
 635
 636   CLIENTS_LOCK (mhsink);
 637   for (clients = mhsink->clients; clients; clients = clients->next) {
 638     GstMultiHandleClient *client;
 639
 640     client = clients->data;
 641
 642     gst_multi_handle_sink_setup_dscp_client (mhsink, client);
 643   }
 644   CLIENTS_UNLOCK (mhsink);
 645 }
 646
 647 void
 648 gst_multi_handle_sink_add_full (GstMultiHandleSink * sink,
 649     GstMultiSinkHandle handle, GstSyncMethod sync_method, GstFormat min_format,
 650     guint64 min_value, GstFormat max_format, guint64 max_value)
 651 {
 652   GstMultiHandleClient *mhclient;
 653   GList *clink;
 654   GstMultiHandleSink *mhsink = GST_MULTI_HANDLE_SINK (sink);
 655   gchar debug[30];
 656   GstMultiHandleSinkClass *mhsinkclass =
 657       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
 658
 659   mhsinkclass->handle_debug (handle, debug);
 660   GST_DEBUG_OBJECT (sink, "%s adding client, sync_method %d, "
 661       "min_format %d, min_value %" G_GUINT64_FORMAT
 662       ", max_format %d, max_value %" G_GUINT64_FORMAT, debug,
 663       sync_method, min_format, min_value, max_format, max_value);
 664
 665   /* do limits check if we can */
 666   if (min_format == max_format) {
 667     if (max_value != -1 && min_value != -1 && max_value < min_value)
 668       goto wrong_limits;
 669   }
 670
 671   CLIENTS_LOCK (sink);
 672
 673   /* check the hash to find a duplicate handle */
 674   clink = g_hash_table_lookup (mhsink->handle_hash,
 675       mhsinkclass->handle_hash_key (handle));
 676   if (clink != NULL)
 677     goto duplicate;
 678
 679   mhclient = mhsinkclass->new_client (mhsink, handle, sync_method);
 680
 681   /* we can add the handle now */
 682   clink = mhsink->clients = g_list_prepend (mhsink->clients, mhclient);
 683   g_hash_table_insert (mhsink->handle_hash,
 684       mhsinkclass->handle_hash_key (mhclient->handle), clink);
 685   mhsink->clients_cookie++;
 686
 687
 688   mhclient->burst_min_format = min_format;
 689   mhclient->burst_min_value = min_value;
 690   mhclient->burst_max_format = max_format;
 691   mhclient->burst_max_value = max_value;
 692
 693   if (mhsinkclass->hash_changed)
 694     mhsinkclass->hash_changed (mhsink);
 695
 696   CLIENTS_UNLOCK (sink);
 697
 698   mhsinkclass->emit_client_added (mhsink, handle);
 699
 700   return;
 701
 702   /* errors */
 703 wrong_limits:
 704   {
 705     GST_WARNING_OBJECT (sink,
 706         "%s wrong values min =%" G_GUINT64_FORMAT ", max=%"
 707         G_GUINT64_FORMAT ", unit %d specified when adding client",
 708         debug, min_value, max_value, min_format);
 709     return;
 710   }
 711 duplicate:
 712   {
 713     CLIENTS_UNLOCK (sink);
 714     GST_WARNING_OBJECT (sink, "%s duplicate client found, refusing", debug);
 715     mhsinkclass->emit_client_removed (mhsink, handle,
 716         GST_CLIENT_STATUS_DUPLICATE);
 717     return;
 718   }
 719 }
 720
 721 /* "add" signal implementation */
 722 void
 723 gst_multi_handle_sink_add (GstMultiHandleSink * sink, GstMultiSinkHandle handle)
 724 {
 725   gst_multi_handle_sink_add_full (sink, handle, sink->def_sync_method,
 726       sink->def_burst_format, sink->def_burst_value, sink->def_burst_format,
 727       -1);
 728 }
 729
 730 /* "remove" signal implementation */
 731 void
 732 gst_multi_handle_sink_remove (GstMultiHandleSink * sink,
 733     GstMultiSinkHandle handle)
 734 {
 735   GList *clink;
 736   GstMultiHandleSink *mhsink = GST_MULTI_HANDLE_SINK (sink);
 737   GstMultiHandleSinkClass *mhsinkclass =
 738       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
 739   gchar debug[30];
 740
 741   mhsinkclass->handle_debug (handle, debug);
 742
 743   GST_DEBUG_OBJECT (sink, "%s removing client", debug);
 744
 745   CLIENTS_LOCK (sink);
 746   clink = g_hash_table_lookup (mhsink->handle_hash,
 747       mhsinkclass->handle_hash_key (handle));
 748   if (clink != NULL) {
 749     GstMultiHandleClient *mhclient = (GstMultiHandleClient *) clink->data;
 750
 751     if (mhclient->status != GST_CLIENT_STATUS_OK) {
 752       GST_INFO_OBJECT (sink,
 753           "%s Client already disconnecting with status %d",
 754           debug, mhclient->status);
 755       goto done;
 756     }
 757
 758     mhclient->status = GST_CLIENT_STATUS_REMOVED;
 759     gst_multi_handle_sink_remove_client_link (GST_MULTI_HANDLE_SINK (sink),
 760         clink);
 761     if (mhsinkclass->hash_changed)
 762       mhsinkclass->hash_changed (mhsink);
 763   } else {
 764     GST_WARNING_OBJECT (sink, "%s no client with this handle found!", debug);
 765   }
 766
 767 done:
 768   CLIENTS_UNLOCK (sink);
 769 }
 770
 771 /* "remove-flush" signal implementation */
 772 void
 773 gst_multi_handle_sink_remove_flush (GstMultiHandleSink * sink,
 774     GstMultiSinkHandle handle)
 775 {
 776   GList *clink;
 777   GstMultiHandleSink *mhsink = GST_MULTI_HANDLE_SINK (sink);
 778   GstMultiHandleSinkClass *mhsinkclass =
 779       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
 780   gchar debug[30];
 781
 782   mhsinkclass->handle_debug (handle, debug);
 783
 784   GST_DEBUG_OBJECT (sink, "%s flushing client", debug);
 785
 786   CLIENTS_LOCK (sink);
 787   clink = g_hash_table_lookup (mhsink->handle_hash,
 788       mhsinkclass->handle_hash_key (handle));
 789   if (clink != NULL) {
 790     GstMultiHandleClient *mhclient = (GstMultiHandleClient *) clink->data;
 791
 792     if (mhclient->status != GST_CLIENT_STATUS_OK) {
 793       GST_INFO_OBJECT (sink,
 794           "%s Client already disconnecting with status %d",
 795           mhclient->debug, mhclient->status);
 796       goto done;
 797     }
 798
 799     /* take the position of the client as the number of buffers left to flush.
 800      * If the client was at position -1, we flush 0 buffers, 0 == flush 1
 801      * buffer, etc... */
 802     mhclient->flushcount = mhclient->bufpos + 1;
 803     /* mark client as flushing. We can not remove the client right away because
 804      * it might have some buffers to flush in the ->sending queue. */
 805     mhclient->status = GST_CLIENT_STATUS_FLUSHING;
 806   } else {
 807     GST_WARNING_OBJECT (sink, "%s no client with this handle found!", debug);
 808   }
 809 done:
 810   CLIENTS_UNLOCK (sink);
 811 }
 812
 813 /* can be called both through the signal (i.e. from any thread) or when
 814  * stopping, after the writing thread has shut down */
 815 static void
 816 gst_multi_handle_sink_clear (GstMultiHandleSink * mhsink)
 817 {
 818   GList *clients, *next;
 819   guint32 cookie;
 820   GstMultiHandleSinkClass *mhsinkclass =
 821       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
 822
 823   GST_DEBUG_OBJECT (mhsink, "clearing all clients");
 824
 825   CLIENTS_LOCK (mhsink);
 826 restart:
 827   cookie = mhsink->clients_cookie;
 828   for (clients = mhsink->clients; clients; clients = next) {
 829     GstMultiHandleClient *mhclient;
 830
 831     if (cookie != mhsink->clients_cookie) {
 832       GST_DEBUG_OBJECT (mhsink, "cookie changed while removing all clients");
 833       goto restart;
 834     }
 835
 836     mhclient = (GstMultiHandleClient *) clients->data;
 837     next = g_list_next (clients);
 838
 839     mhclient->status = GST_CLIENT_STATUS_REMOVED;
 840     /* the next call changes the list, which is why we iterate
 841      * with a temporary next pointer */
 842     gst_multi_handle_sink_remove_client_link (mhsink, clients);
 843   }
 844   if (mhsinkclass->hash_changed)
 845     mhsinkclass->hash_changed (mhsink);
 846
 847   CLIENTS_UNLOCK (mhsink);
 848 }
 849
 850
 851 /* "get-stats" signal implementation
 852  */
 853 GstStructure *
 854 gst_multi_handle_sink_get_stats (GstMultiHandleSink * sink,
 855     GstMultiSinkHandle handle)
 856 {
 857   GstMultiHandleClient *client;
 858   GstStructure *result = NULL;
 859   GList *clink;
 860   GstMultiHandleSink *mhsink = GST_MULTI_HANDLE_SINK (sink);
 861   GstMultiHandleSinkClass *mhsinkclass =
 862       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
 863   gchar debug[30];
 864
 865   mhsinkclass->handle_debug (handle, debug);
 866
 867   CLIENTS_LOCK (sink);
 868   clink = g_hash_table_lookup (mhsink->handle_hash,
 869       mhsinkclass->handle_hash_key (handle));
 870   if (clink == NULL)
 871     goto noclient;
 872
 873   client = clink->data;
 874   if (client != NULL) {
 875     GstMultiHandleClient *mhclient = (GstMultiHandleClient *) client;
 876     guint64 interval;
 877
 878     result = gst_structure_new_empty ("multihandlesink-stats");
 879
 880     if (mhclient->disconnect_time == 0) {
 881       GTimeVal nowtv;
 882
 883       g_get_current_time (&nowtv);
 884
 885       interval = GST_TIMEVAL_TO_TIME (nowtv) - mhclient->connect_time;
 886     } else {
 887       interval = mhclient->disconnect_time - mhclient->connect_time;
 888     }
 889
 890     gst_structure_set (result,
 891         "bytes-sent", G_TYPE_UINT64, mhclient->bytes_sent,
 892         "connect-time", G_TYPE_UINT64, mhclient->connect_time,
 893         "disconnect-time", G_TYPE_UINT64, mhclient->disconnect_time,
 894         "connect-duration", G_TYPE_UINT64, interval,
 895         "last-activitity-time", G_TYPE_UINT64, mhclient->last_activity_time,
 896         "buffers-dropped", G_TYPE_UINT64, mhclient->dropped_buffers,
 897         "first-buffer-ts", G_TYPE_UINT64, mhclient->first_buffer_ts,
 898         "last-buffer-ts", G_TYPE_UINT64, mhclient->last_buffer_ts, NULL);
 899   }
 900
 901 noclient:
 902   CLIENTS_UNLOCK (sink);
 903
 904   /* python doesn't like a NULL pointer yet */
 905   if (result == NULL) {
 906     GST_WARNING_OBJECT (sink, "%s no client with this found!", debug);
 907     result = gst_structure_new_empty ("multihandlesink-stats");
 908   }
 909
 910   return result;
 911 }
 912
 913 /* should be called with the clientslock held.
 914  * Note that we don't close the fd as we didn't open it in the first
 915  * place. An application should connect to the client-fd-removed signal and
 916  * close the fd itself.
 917  */
 918 void
 919 gst_multi_handle_sink_remove_client_link (GstMultiHandleSink * sink,
 920     GList * link)
 921 {
 922   GTimeVal now;
 923   GstMultiHandleClient *mhclient = (GstMultiHandleClient *) link->data;
 924   GstMultiHandleSinkClass *mhsinkclass = GST_MULTI_HANDLE_SINK_GET_CLASS (sink);
 925
 926   if (mhclient->currently_removing) {
 927     GST_WARNING_OBJECT (sink, "%s client is already being removed",
 928         mhclient->debug);
 929     return;
 930   } else {
 931     mhclient->currently_removing = TRUE;
 932   }
 933
 934   /* FIXME: if we keep track of ip we can log it here and signal */
 935   switch (mhclient->status) {
 936     case GST_CLIENT_STATUS_OK:
 937       GST_WARNING_OBJECT (sink, "%s removing client %p for no reason",
 938           mhclient->debug, mhclient);
 939       break;
 940     case GST_CLIENT_STATUS_CLOSED:
 941       GST_DEBUG_OBJECT (sink, "%s removing client %p because of close",
 942           mhclient->debug, mhclient);
 943       break;
 944     case GST_CLIENT_STATUS_REMOVED:
 945       GST_DEBUG_OBJECT (sink,
 946           "%s removing client %p because the app removed it", mhclient->debug,
 947           mhclient);
 948       break;
 949     case GST_CLIENT_STATUS_SLOW:
 950       GST_INFO_OBJECT (sink,
 951           "%s removing client %p because it was too slow", mhclient->debug,
 952           mhclient);
 953       break;
 954     case GST_CLIENT_STATUS_ERROR:
 955       GST_WARNING_OBJECT (sink,
 956           "%s removing client %p because of error", mhclient->debug, mhclient);
 957       break;
 958     case GST_CLIENT_STATUS_FLUSHING:
 959     default:
 960       GST_WARNING_OBJECT (sink,
 961           "%s removing client %p with invalid reason %d", mhclient->debug,
 962           mhclient, mhclient->status);
 963       break;
 964   }
 965
 966   mhsinkclass->hash_removing (sink, mhclient);
 967
 968   g_get_current_time (&now);
 969   mhclient->disconnect_time = GST_TIMEVAL_TO_TIME (now);
 970
 971   /* free client buffers */
 972   g_slist_foreach (mhclient->sending, (GFunc) gst_mini_object_unref, NULL);
 973   g_slist_free (mhclient->sending);
 974   mhclient->sending = NULL;
 975
 976   if (mhclient->caps)
 977     gst_caps_unref (mhclient->caps);
 978   mhclient->caps = NULL;
 979
 980   /* unlock the mutex before signaling because the signal handler
 981    * might query some properties */
 982   CLIENTS_UNLOCK (sink);
 983
 984   mhsinkclass->emit_client_removed (sink, mhclient->handle, mhclient->status);
 985
 986   /* lock again before we remove the client completely */
 987   CLIENTS_LOCK (sink);
 988
 989   /* handle cannot be reused in the above signal callback so we can safely
 990    * remove it from the hashtable here */
 991   if (!g_hash_table_remove (sink->handle_hash,
 992           mhsinkclass->handle_hash_key (mhclient->handle))) {
 993     GST_WARNING_OBJECT (sink,
 994         "%s error removing client %p from hash", mhclient->debug, mhclient);
 995   }
 996   /* after releasing the lock above, the link could be invalid, more
 997    * precisely, the next and prev pointers could point to invalid list
 998    * links. One optimisation could be to add a cookie to the linked list
 999    * and take a shortcut when it did not change between unlocking and locking
1000    * our mutex. For now we just walk the list again. */
1001   sink->clients = g_list_remove (sink->clients, mhclient);
1002   sink->clients_cookie++;
1003
1004   if (mhsinkclass->removed)
1005     mhsinkclass->removed (sink, mhclient->handle);
1006
1007   CLIENTS_UNLOCK (sink);
1008
1009   /* sub-class must implement this to emit the client-$handle-removed signal */
1010   g_assert (mhsinkclass->client_free != NULL);
1011
1012   /* and the handle is really gone now */
1013   mhsinkclass->client_free (sink, mhclient);
1014
1015   g_free (mhclient);
1016
1017   CLIENTS_LOCK (sink);
1018 }
1019
1020 static gboolean
1021 gst_multi_handle_sink_client_queue_buffer (GstMultiHandleSink * mhsink,
1022     GstMultiHandleClient * mhclient, GstBuffer * buffer)
1023 {
1024   GstMultiHandleSink *sink = GST_MULTI_HANDLE_SINK (mhsink);
1025   GstCaps *caps;
1026
1027   /* TRUE: send them if the new caps have them */
1028   gboolean send_streamheader = FALSE;
1029   GstStructure *s;
1030
1031   /* before we queue the buffer, we check if we need to queue streamheader
1032    * buffers (because it's a new client, or because they changed) */
1033   caps = gst_pad_get_current_caps (GST_BASE_SINK_PAD (sink));
1034
1035   if (!mhclient->caps) {
1036     GST_DEBUG_OBJECT (sink,
1037         "%s no previous caps for this client, send streamheader",
1038         mhclient->debug);
1039     send_streamheader = TRUE;
1040     mhclient->caps = gst_caps_ref (caps);
1041   } else {
1042     /* there were previous caps recorded, so compare */
1043     if (!gst_caps_is_equal (caps, mhclient->caps)) {
1044       const GValue *sh1, *sh2;
1045
1046       /* caps are not equal, but could still have the same streamheader */
1047       s = gst_caps_get_structure (caps, 0);
1048       if (!gst_structure_has_field (s, "streamheader")) {
1049         /* no new streamheader, so nothing new to send */
1050         GST_DEBUG_OBJECT (sink,
1051             "%s new caps do not have streamheader, not sending",
1052             mhclient->debug);
1053       } else {
1054         /* there is a new streamheader */
1055         s = gst_caps_get_structure (mhclient->caps, 0);
1056         if (!gst_structure_has_field (s, "streamheader")) {
1057           /* no previous streamheader, so send the new one */
1058           GST_DEBUG_OBJECT (sink,
1059               "%s previous caps did not have streamheader, sending",
1060               mhclient->debug);
1061           send_streamheader = TRUE;
1062         } else {
1063           /* both old and new caps have streamheader set */
1064           if (!mhsink->resend_streamheader) {
1065             GST_DEBUG_OBJECT (sink,
1066                 "%s asked to not resend the streamheader, not sending",
1067                 mhclient->debug);
1068             send_streamheader = FALSE;
1069           } else {
1070             sh1 = gst_structure_get_value (s, "streamheader");
1071             s = gst_caps_get_structure (caps, 0);
1072             sh2 = gst_structure_get_value (s, "streamheader");
1073             if (gst_value_compare (sh1, sh2) != GST_VALUE_EQUAL) {
1074               GST_DEBUG_OBJECT (sink,
1075                   "%s new streamheader different from old, sending",
1076                   mhclient->debug);
1077               send_streamheader = TRUE;
1078             }
1079           }
1080         }
1081       }
1082     }
1083     /* Replace the old caps */
1084     gst_caps_unref (mhclient->caps);
1085     mhclient->caps = gst_caps_ref (caps);
1086   }
1087
1088   if (G_UNLIKELY (send_streamheader)) {
1089     const GValue *sh;
1090     GArray *buffers;
1091     int i;
1092
1093     GST_LOG_OBJECT (sink,
1094         "%s sending streamheader from caps %" GST_PTR_FORMAT,
1095         mhclient->debug, caps);
1096     s = gst_caps_get_structure (caps, 0);
1097     if (!gst_structure_has_field (s, "streamheader")) {
1098       GST_DEBUG_OBJECT (sink,
1099           "%s no new streamheader, so nothing to send", mhclient->debug);
1100     } else {
1101       GST_LOG_OBJECT (sink,
1102           "%s sending streamheader from caps %" GST_PTR_FORMAT,
1103           mhclient->debug, caps);
1104       sh = gst_structure_get_value (s, "streamheader");
1105       g_assert (G_VALUE_TYPE (sh) == GST_TYPE_ARRAY);
1106       buffers = g_value_peek_pointer (sh);
1107       GST_DEBUG_OBJECT (sink, "%d streamheader buffers", buffers->len);
1108       for (i = 0; i < buffers->len; ++i) {
1109         GValue *bufval;
1110         GstBuffer *buffer;
1111
1112         bufval = &g_array_index (buffers, GValue, i);
1113         g_assert (G_VALUE_TYPE (bufval) == GST_TYPE_BUFFER);
1114         buffer = g_value_peek_pointer (bufval);
1115         GST_DEBUG_OBJECT (sink,
1116             "%s queueing streamheader buffer of length %" G_GSIZE_FORMAT,
1117             mhclient->debug, gst_buffer_get_size (buffer));
1118         gst_buffer_ref (buffer);
1119
1120         mhclient->sending = g_slist_append (mhclient->sending, buffer);
1121       }
1122     }
1123   }
1124
1125   gst_caps_unref (caps);
1126   caps = NULL;
1127
1128   GST_LOG_OBJECT (sink, "%s queueing buffer of length %" G_GSIZE_FORMAT,
1129       mhclient->debug, gst_buffer_get_size (buffer));
1130
1131   gst_buffer_ref (buffer);
1132   mhclient->sending = g_slist_append (mhclient->sending, buffer);
1133
1134   return TRUE;
1135 }
1136
1137 static gboolean
1138 is_sync_frame (GstMultiHandleSink * sink, GstBuffer * buffer)
1139 {
1140   if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DELTA_UNIT)) {
1141     return FALSE;
1142   } else if (!GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_HEADER)) {
1143     return TRUE;
1144   }
1145
1146   return FALSE;
1147 }
1148
1149 /* find the keyframe in the list of buffers starting the
1150  * search from @idx. @direction as -1 will search backwards,
1151  * 1 will search forwards.
1152  * Returns: the index or -1 if there is no keyframe after idx.
1153  */
1154 gint
1155 find_syncframe (GstMultiHandleSink * sink, gint idx, gint direction)
1156 {
1157   gint i, len, result;
1158
1159   /* take length of queued buffers */
1160   len = sink->bufqueue->len;
1161
1162   /* assume we don't find a keyframe */
1163   result = -1;
1164
1165   /* then loop over all buffers to find the first keyframe */
1166   for (i = idx; i >= 0 && i < len; i += direction) {
1167     GstBuffer *buf;
1168
1169     buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1170     if (is_sync_frame (sink, buf)) {
1171       GST_LOG_OBJECT (sink, "found keyframe at %d from %d, direction %d",
1172           i, idx, direction);
1173       result = i;
1174       break;
1175     }
1176   }
1177   return result;
1178 }
1179
1180 /* Get the number of buffers from the buffer queue needed to satisfy
1181  * the maximum max in the configured units.
1182  * If units are not BUFFERS, and there are insufficient buffers in the
1183  * queue to satify the limit, return len(queue) + 1 */
1184 gint
1185 get_buffers_max (GstMultiHandleSink * sink, gint64 max)
1186 {
1187   switch (sink->unit_format) {
1188     case GST_FORMAT_BUFFERS:
1189       return max;
1190     case GST_FORMAT_TIME:
1191     {
1192       GstBuffer *buf;
1193       int i;
1194       int len;
1195       gint64 diff;
1196       GstClockTime first = GST_CLOCK_TIME_NONE;
1197
1198       len = sink->bufqueue->len;
1199
1200       for (i = 0; i < len; i++) {
1201         buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1202         if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1203           if (first == -1)
1204             first = GST_BUFFER_TIMESTAMP (buf);
1205
1206           diff = first - GST_BUFFER_TIMESTAMP (buf);
1207
1208           if (diff > max)
1209             return i + 1;
1210         }
1211       }
1212       return len + 1;
1213     }
1214     case GST_FORMAT_BYTES:
1215     {
1216       GstBuffer *buf;
1217       int i;
1218       int len;
1219       gint acc = 0;
1220
1221       len = sink->bufqueue->len;
1222
1223       for (i = 0; i < len; i++) {
1224         buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1225         acc += gst_buffer_get_size (buf);
1226
1227         if (acc > max)
1228           return i + 1;
1229       }
1230       return len + 1;
1231     }
1232     default:
1233       return max;
1234   }
1235 }
1236
1237 /* find the positions in the buffer queue where *_min and *_max
1238  * is satisfied
1239  */
1240 /* count the amount of data in the buffers and return the index
1241  * that satifies the given limits.
1242  *
1243  * Returns: index @idx in the buffer queue so that the given limits are
1244  * satisfied. TRUE if all the limits could be satisfied, FALSE if not
1245  * enough data was in the queue.
1246  *
1247  * FIXME, this code might now work if any of the units is in buffers...
1248  */
1249 gboolean
1250 find_limits (GstMultiHandleSink * sink,
1251     gint * min_idx, gint bytes_min, gint buffers_min, gint64 time_min,
1252     gint * max_idx, gint bytes_max, gint buffers_max, gint64 time_max)
1253 {
1254   GstClockTime first, time;
1255   gint i, len, bytes;
1256   gboolean result, max_hit;
1257
1258   /* take length of queue */
1259   len = sink->bufqueue->len;
1260
1261   /* this must hold */
1262   g_assert (len > 0);
1263
1264   GST_LOG_OBJECT (sink,
1265       "bytes_min %d, buffers_min %d, time_min %" GST_TIME_FORMAT
1266       ", bytes_max %d, buffers_max %d, time_max %" GST_TIME_FORMAT, bytes_min,
1267       buffers_min, GST_TIME_ARGS (time_min), bytes_max, buffers_max,
1268       GST_TIME_ARGS (time_max));
1269
1270   /* do the trivial buffer limit test */
1271   if (buffers_min != -1 && len < buffers_min) {
1272     *min_idx = len - 1;
1273     *max_idx = len - 1;
1274     return FALSE;
1275   }
1276
1277   result = FALSE;
1278   /* else count bytes and time */
1279   first = -1;
1280   bytes = 0;
1281   /* unset limits */
1282   *min_idx = -1;
1283   *max_idx = -1;
1284   max_hit = FALSE;
1285
1286   i = 0;
1287   /* loop through the buffers, when a limit is ok, mark it
1288    * as -1, we have at least one buffer in the queue. */
1289   do {
1290     GstBuffer *buf;
1291
1292     /* if we checked all min limits, update result */
1293     if (bytes_min == -1 && time_min == -1 && *min_idx == -1) {
1294       /* don't go below 0 */
1295       *min_idx = MAX (i - 1, 0);
1296     }
1297     /* if we reached one max limit break out */
1298     if (max_hit) {
1299       /* i > 0 when we get here, we subtract one to get the position
1300        * of the previous buffer. */
1301       *max_idx = i - 1;
1302       /* we have valid complete result if we found a min_idx too */
1303       result = *min_idx != -1;
1304       break;
1305     }
1306     buf = g_array_index (sink->bufqueue, GstBuffer *, i);
1307
1308     bytes += gst_buffer_get_size (buf);
1309
1310     /* take timestamp and save for the base first timestamp */
1311     if ((time = GST_BUFFER_TIMESTAMP (buf)) != -1) {
1312       GST_LOG_OBJECT (sink, "Ts %" GST_TIME_FORMAT " on buffer",
1313           GST_TIME_ARGS (time));
1314       if (first == -1)
1315         first = time;
1316
1317       /* increase max usage if we did not fill enough. Note that
1318        * buffers are sorted from new to old, so the first timestamp is
1319        * bigger than the next one. */
1320       if (time_min != -1 && first - time >= time_min)
1321         time_min = -1;
1322       if (time_max != -1 && first - time >= time_max)
1323         max_hit = TRUE;
1324     } else {
1325       GST_LOG_OBJECT (sink, "No timestamp on buffer");
1326     }
1327     /* time is OK or unknown, check and increase if not enough bytes */
1328     if (bytes_min != -1) {
1329       if (bytes >= bytes_min)
1330         bytes_min = -1;
1331     }
1332     if (bytes_max != -1) {
1333       if (bytes >= bytes_max) {
1334         max_hit = TRUE;
1335       }
1336     }
1337     i++;
1338   }
1339   while (i < len);
1340
1341   /* if we did not hit the max or min limit, set to buffer size */
1342   if (*max_idx == -1)
1343     *max_idx = len - 1;
1344   /* make sure min does not exceed max */
1345   if (*min_idx == -1)
1346     *min_idx = *max_idx;
1347
1348   return result;
1349 }
1350
1351 /* parse the unit/value pair and assign it to the result value of the
1352  * right type, leave the other values untouched
1353  *
1354  * Returns: FALSE if the unit is unknown or undefined. TRUE otherwise.
1355  */
1356 static gboolean
1357 assign_value (GstFormat format, guint64 value, gint * bytes, gint * buffers,
1358     GstClockTime * time)
1359 {
1360   gboolean res = TRUE;
1361
1362   /* set only the limit of the given format to the given value */
1363   switch (format) {
1364     case GST_FORMAT_BUFFERS:
1365       *buffers = (gint) value;
1366       break;
1367     case GST_FORMAT_TIME:
1368       *time = value;
1369       break;
1370     case GST_FORMAT_BYTES:
1371       *bytes = (gint) value;
1372       break;
1373     case GST_FORMAT_UNDEFINED:
1374     default:
1375       res = FALSE;
1376       break;
1377   }
1378   return res;
1379 }
1380
1381 /* count the index in the buffer queue to satisfy the given unit
1382  * and value pair starting from buffer at index 0.
1383  *
1384  * Returns: TRUE if there was enough data in the queue to satisfy the
1385  * burst values. @idx contains the index in the buffer that contains enough
1386  * data to satisfy the limits or the last buffer in the queue when the
1387  * function returns FALSE.
1388  */
1389 static gboolean
1390 count_burst_unit (GstMultiHandleSink * sink, gint * min_idx,
1391     GstFormat min_format, guint64 min_value, gint * max_idx,
1392     GstFormat max_format, guint64 max_value)
1393 {
1394   gint bytes_min = -1, buffers_min = -1;
1395   gint bytes_max = -1, buffers_max = -1;
1396   GstClockTime time_min = GST_CLOCK_TIME_NONE, time_max = GST_CLOCK_TIME_NONE;
1397
1398   assign_value (min_format, min_value, &bytes_min, &buffers_min, &time_min);
1399   assign_value (max_format, max_value, &bytes_max, &buffers_max, &time_max);
1400
1401   return find_limits (sink, min_idx, bytes_min, buffers_min, time_min,
1402       max_idx, bytes_max, buffers_max, time_max);
1403 }
1404
1405 /* decide where in the current buffer queue this new client should start
1406  * receiving buffers from.
1407  * This function is called whenever a client is connected and has not yet
1408  * received a buffer.
1409  * If this returns -1, it means that we haven't found a good point to
1410  * start streaming from yet, and this function should be called again later
1411  * when more buffers have arrived.
1412  */
1413 gint
1414 gst_multi_handle_sink_new_client_position (GstMultiHandleSink * sink,
1415     GstMultiHandleClient * client)
1416 {
1417   gint result;
1418
1419   GST_DEBUG_OBJECT (sink,
1420       "%s new client, deciding where to start in queue", client->debug);
1421   GST_DEBUG_OBJECT (sink, "queue is currently %d buffers long",
1422       sink->bufqueue->len);
1423   switch (client->sync_method) {
1424     case GST_SYNC_METHOD_LATEST:
1425       /* no syncing, we are happy with whatever the client is going to get */
1426       result = client->bufpos;
1427       GST_DEBUG_OBJECT (sink,
1428           "%s SYNC_METHOD_LATEST, position %d", client->debug, result);
1429       break;
1430     case GST_SYNC_METHOD_NEXT_KEYFRAME:
1431     {
1432       /* if one of the new buffers (between client->bufpos and 0) in the queue
1433        * is a sync point, we can proceed, otherwise we need to keep waiting */
1434       GST_LOG_OBJECT (sink,
1435           "%s new client, bufpos %d, waiting for keyframe",
1436           client->debug, client->bufpos);
1437
1438       result = find_prev_syncframe (sink, client->bufpos);
1439       if (result != -1) {
1440         GST_DEBUG_OBJECT (sink,
1441             "%s SYNC_METHOD_NEXT_KEYFRAME: result %d", client->debug, result);
1442         break;
1443       }
1444
1445       /* client is not on a syncbuffer, need to skip these buffers and
1446        * wait some more */
1447       GST_LOG_OBJECT (sink,
1448           "%s new client, skipping buffer(s), no syncpoint found",
1449           client->debug);
1450       client->bufpos = -1;
1451       break;
1452     }
1453     case GST_SYNC_METHOD_LATEST_KEYFRAME:
1454     {
1455       GST_DEBUG_OBJECT (sink, "%s SYNC_METHOD_LATEST_KEYFRAME", client->debug);
1456
1457       /* for new clients we initially scan the complete buffer queue for
1458        * a sync point when a buffer is added. If we don't find a keyframe,
1459        * we need to wait for the next keyframe and so we change the client's
1460        * sync method to GST_SYNC_METHOD_NEXT_KEYFRAME.
1461        */
1462       result = find_next_syncframe (sink, 0);
1463       if (result != -1) {
1464         GST_DEBUG_OBJECT (sink,
1465             "%s SYNC_METHOD_LATEST_KEYFRAME: result %d", client->debug, result);
1466         break;
1467       }
1468
1469       GST_DEBUG_OBJECT (sink,
1470           "%s SYNC_METHOD_LATEST_KEYFRAME: no keyframe found, "
1471           "switching to SYNC_METHOD_NEXT_KEYFRAME", client->debug);
1472       /* throw client to the waiting state */
1473       client->bufpos = -1;
1474       /* and make client sync to next keyframe */
1475       client->sync_method = GST_SYNC_METHOD_NEXT_KEYFRAME;
1476       break;
1477     }
1478     case GST_SYNC_METHOD_BURST:
1479     {
1480       gboolean ok;
1481       gint max;
1482
1483       /* move to the position where we satisfy the client's burst
1484        * parameters. If we could not satisfy the parameters because there
1485        * is not enough data, we just send what we have (which is in result).
1486        * We use the max value to limit the search
1487        */
1488       ok = count_burst_unit (sink, &result, client->burst_min_format,
1489           client->burst_min_value, &max, client->burst_max_format,
1490           client->burst_max_value);
1491       GST_DEBUG_OBJECT (sink,
1492           "%s SYNC_METHOD_BURST: burst_unit returned %d, result %d",
1493           client->debug, ok, result);
1494
1495       GST_LOG_OBJECT (sink, "min %d, max %d", result, max);
1496
1497       /* we hit the max and it is below the min, use that then */
1498       if (max != -1 && max <= result) {
1499         result = MAX (max - 1, 0);
1500         GST_DEBUG_OBJECT (sink,
1501             "%s SYNC_METHOD_BURST: result above max, taken down to %d",
1502             client->debug, result);
1503       }
1504       break;
1505     }
1506     case GST_SYNC_METHOD_BURST_KEYFRAME:
1507     {
1508       gint min_idx, max_idx;
1509       gint next_syncframe, prev_syncframe;
1510
1511       /* BURST_KEYFRAME:
1512        *
1513        * _always_ start sending a keyframe to the client. We first search
1514        * a keyframe between min/max limits. If there is none, we send it the
1515        * last keyframe before min. If there is none, the behaviour is like
1516        * NEXT_KEYFRAME.
1517        */
1518       /* gather burst limits */
1519       count_burst_unit (sink, &min_idx, client->burst_min_format,
1520           client->burst_min_value, &max_idx, client->burst_max_format,
1521           client->burst_max_value);
1522
1523       GST_LOG_OBJECT (sink, "min %d, max %d", min_idx, max_idx);
1524
1525       /* first find a keyframe after min_idx */
1526       next_syncframe = find_next_syncframe (sink, min_idx);
1527       if (next_syncframe != -1 && next_syncframe < max_idx) {
1528         /* we have a valid keyframe and it's below the max */
1529         GST_LOG_OBJECT (sink, "found keyframe in min/max limits");
1530         result = next_syncframe;
1531         break;
1532       }
1533
1534       /* no valid keyframe, try to find one below min */
1535       prev_syncframe = find_prev_syncframe (sink, min_idx);
1536       if (prev_syncframe != -1) {
1537         GST_WARNING_OBJECT (sink,
1538             "using keyframe below min in BURST_KEYFRAME sync mode");
1539         result = prev_syncframe;
1540         break;
1541       }
1542
1543       /* no prev keyframe or not enough data  */
1544       GST_WARNING_OBJECT (sink,
1545           "no prev keyframe found in BURST_KEYFRAME sync mode, waiting for next");
1546
1547       /* throw client to the waiting state */
1548       client->bufpos = -1;
1549       /* and make client sync to next keyframe */
1550       client->sync_method = GST_SYNC_METHOD_NEXT_KEYFRAME;
1551       result = -1;
1552       break;
1553     }
1554     case GST_SYNC_METHOD_BURST_WITH_KEYFRAME:
1555     {
1556       gint min_idx, max_idx;
1557       gint next_syncframe;
1558
1559       /* BURST_WITH_KEYFRAME:
1560        *
1561        * try to start sending a keyframe to the client. We first search
1562        * a keyframe between min/max limits. If there is none, we send it the
1563        * amount of data up 'till min.
1564        */
1565       /* gather enough data to burst */
1566       count_burst_unit (sink, &min_idx, client->burst_min_format,
1567           client->burst_min_value, &max_idx, client->burst_max_format,
1568           client->burst_max_value);
1569
1570       GST_LOG_OBJECT (sink, "min %d, max %d", min_idx, max_idx);
1571
1572       /* first find a keyframe after min_idx */
1573       next_syncframe = find_next_syncframe (sink, min_idx);
1574       if (next_syncframe != -1 && next_syncframe < max_idx) {
1575         /* we have a valid keyframe and it's below the max */
1576         GST_LOG_OBJECT (sink, "found keyframe in min/max limits");
1577         result = next_syncframe;
1578         break;
1579       }
1580
1581       /* no keyframe, send data from min_idx */
1582       GST_WARNING_OBJECT (sink, "using min in BURST_WITH_KEYFRAME sync mode");
1583
1584       /* make sure we don't go over the max limit */
1585       if (max_idx != -1 && max_idx <= min_idx) {
1586         result = MAX (max_idx - 1, 0);
1587       } else {
1588         result = min_idx;
1589       }
1590
1591       break;
1592     }
1593     default:
1594       g_warning ("unknown sync method %d", client->sync_method);
1595       result = client->bufpos;
1596       break;
1597   }
1598   return result;
1599 }
1600
1601 /* calculate the new position for a client after recovery. This function
1602  * does not update the client position but merely returns the required
1603  * position.
1604  */
1605 gint
1606 gst_multi_handle_sink_recover_client (GstMultiHandleSink * sink,
1607     GstMultiHandleClient * client)
1608 {
1609   gint newbufpos;
1610
1611   GST_WARNING_OBJECT (sink,
1612       "%s client %p is lagging at %d, recover using policy %d",
1613       client->debug, client, client->bufpos, sink->recover_policy);
1614
1615   switch (sink->recover_policy) {
1616     case GST_RECOVER_POLICY_NONE:
1617       /* do nothing, client will catch up or get kicked out when it reaches
1618        * the hard max */
1619       newbufpos = client->bufpos;
1620       break;
1621     case GST_RECOVER_POLICY_RESYNC_LATEST:
1622       /* move to beginning of queue */
1623       newbufpos = -1;
1624       break;
1625     case GST_RECOVER_POLICY_RESYNC_SOFT_LIMIT:
1626       /* move to beginning of soft max */
1627       newbufpos = get_buffers_max (sink, sink->units_soft_max);
1628       break;
1629     case GST_RECOVER_POLICY_RESYNC_KEYFRAME:
1630       /* find keyframe in buffers, we search backwards to find the
1631        * closest keyframe relative to what this client already received. */
1632       newbufpos = MIN (sink->bufqueue->len - 1,
1633           get_buffers_max (sink, sink->units_soft_max) - 1);
1634
1635       while (newbufpos >= 0) {
1636         GstBuffer *buf;
1637
1638         buf = g_array_index (sink->bufqueue, GstBuffer *, newbufpos);
1639         if (is_sync_frame (sink, buf)) {
1640           /* found a buffer that is not a delta unit */
1641           break;
1642         }
1643         newbufpos--;
1644       }
1645       break;
1646     default:
1647       /* unknown recovery procedure */
1648       newbufpos = get_buffers_max (sink, sink->units_soft_max);
1649       break;
1650   }
1651   return newbufpos;
1652 }
1653
1654 /* Queue a buffer on the global queue.
1655  *
1656  * This function adds the buffer to the front of a GArray. It removes the
1657  * tail buffer if the max queue size is exceeded, unreffing the queued buffer.
1658  * Note that unreffing the buffer is not a problem as clients who
1659  * started writing out this buffer will still have a reference to it in the
1660  * mhclient->sending queue.
1661  *
1662  * After adding the buffer, we update all client positions in the queue. If
1663  * a client moves over the soft max, we start the recovery procedure for this
1664  * slow client. If it goes over the hard max, it is put into the slow list
1665  * and removed.
1666  *
1667  * Special care is taken of clients that were waiting for a new buffer (they
1668  * had a position of -1) because they can proceed after adding this new buffer.
1669  * This is done by adding the client back into the write fd_set and signaling
1670  * the select thread that the fd_set changed.
1671  */
1672 static void
1673 gst_multi_handle_sink_queue_buffer (GstMultiHandleSink * mhsink,
1674     GstBuffer * buffer)
1675 {
1676   GList *clients, *next;
1677   gint queuelen;
1678   gboolean hash_changed = FALSE;
1679   gint max_buffer_usage;
1680   gint i;
1681   GTimeVal nowtv;
1682   GstClockTime now;
1683   gint max_buffers, soft_max_buffers;
1684   guint cookie;
1685   GstMultiHandleSink *sink = GST_MULTI_HANDLE_SINK (mhsink);
1686   GstMultiHandleSinkClass *mhsinkclass =
1687       GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
1688
1689   g_get_current_time (&nowtv);
1690   now = GST_TIMEVAL_TO_TIME (nowtv);
1691
1692   CLIENTS_LOCK (mhsink);
1693   /* add buffer to queue */
1694   g_array_prepend_val (mhsink->bufqueue, buffer);
1695   queuelen = mhsink->bufqueue->len;
1696
1697   if (mhsink->units_max > 0)
1698     max_buffers = get_buffers_max (mhsink, mhsink->units_max);
1699   else
1700     max_buffers = -1;
1701
1702   if (mhsink->units_soft_max > 0)
1703     soft_max_buffers = get_buffers_max (mhsink, mhsink->units_soft_max);
1704   else
1705     soft_max_buffers = -1;
1706   GST_LOG_OBJECT (sink, "Using max %d, softmax %d", max_buffers,
1707       soft_max_buffers);
1708
1709   /* then loop over the clients and update the positions */
1710   max_buffer_usage = 0;
1711
1712 restart:
1713   cookie = mhsink->clients_cookie;
1714   for (clients = mhsink->clients; clients; clients = next) {
1715     GstMultiHandleClient *mhclient = clients->data;
1716
1717     if (cookie != mhsink->clients_cookie) {
1718       GST_DEBUG_OBJECT (sink, "Clients cookie outdated, restarting");
1719       goto restart;
1720     }
1721
1722     next = g_list_next (clients);
1723
1724     mhclient->bufpos++;
1725     GST_LOG_OBJECT (sink, "%s client %p at position %d",
1726         mhclient->debug, mhclient, mhclient->bufpos);
1727     /* check soft max if needed, recover client */
1728     if (soft_max_buffers > 0 && mhclient->bufpos >= soft_max_buffers) {
1729       gint newpos;
1730
1731       newpos = gst_multi_handle_sink_recover_client (mhsink, mhclient);
1732       if (newpos != mhclient->bufpos) {
1733         mhclient->dropped_buffers += mhclient->bufpos - newpos;
1734         mhclient->bufpos = newpos;
1735         mhclient->discont = TRUE;
1736         GST_INFO_OBJECT (sink, "%s client %p position reset to %d",
1737             mhclient->debug, mhclient, mhclient->bufpos);
1738       } else {
1739         GST_INFO_OBJECT (sink,
1740             "%s client %p not recovering position", mhclient->debug, mhclient);
1741       }
1742     }
1743     /* check hard max and timeout, remove client */
1744     if ((max_buffers > 0 && mhclient->bufpos >= max_buffers) ||
1745         (mhsink->timeout > 0
1746             && now - mhclient->last_activity_time > mhsink->timeout)) {
1747       /* remove client */
1748       GST_WARNING_OBJECT (sink, "%s client %p is too slow, removing",
1749           mhclient->debug, mhclient);
1750       /* remove the client, the handle set will be cleared and the select thread
1751        * will be signaled */
1752       mhclient->status = GST_CLIENT_STATUS_SLOW;
1753       /* set client to invalid position while being removed */
1754       mhclient->bufpos = -1;
1755       gst_multi_handle_sink_remove_client_link (mhsink, clients);
1756       hash_changed = TRUE;
1757       continue;
1758     } else if (mhclient->bufpos == 0 || mhclient->new_connection) {
1759       /* can send data to this client now. need to signal the select thread that
1760        * the handle_set changed */
1761       mhsinkclass->hash_adding (mhsink, mhclient);
1762       hash_changed = TRUE;
1763     }
1764     /* keep track of maximum buffer usage */
1765     if (mhclient->bufpos > max_buffer_usage) {
1766       max_buffer_usage = mhclient->bufpos;
1767     }
1768   }
1769
1770   /* make sure we respect bytes-min, buffers-min and time-min when they are set */
1771   {
1772     gint usage, max;
1773
1774     GST_LOG_OBJECT (sink,
1775         "extending queue %d to respect time_min %" GST_TIME_FORMAT
1776         ", bytes_min %d, buffers_min %d", max_buffer_usage,
1777         GST_TIME_ARGS (mhsink->time_min), mhsink->bytes_min,
1778         mhsink->buffers_min);
1779
1780     /* get index where the limits are ok, we don't really care if all limits
1781      * are ok, we just queue as much as we need. We also don't compare against
1782      * the max limits. */
1783     find_limits (mhsink, &usage, mhsink->bytes_min, mhsink->buffers_min,
1784         mhsink->time_min, &max, -1, -1, -1);
1785
1786     max_buffer_usage = MAX (max_buffer_usage, usage + 1);
1787     GST_LOG_OBJECT (sink, "extended queue to %d", max_buffer_usage);
1788   }
1789
1790   /* now look for sync points and make sure there is at least one
1791    * sync point in the queue. We only do this if the LATEST_KEYFRAME or
1792    * BURST_KEYFRAME mode is selected */
1793   if (mhsink->def_sync_method == GST_SYNC_METHOD_LATEST_KEYFRAME ||
1794       mhsink->def_sync_method == GST_SYNC_METHOD_BURST_KEYFRAME) {
1795     /* no point in searching beyond the queue length */
1796     gint limit = queuelen;
1797     GstBuffer *buf;
1798
1799     /* no point in searching beyond the soft-max if any. */
1800     if (soft_max_buffers > 0) {
1801       limit = MIN (limit, soft_max_buffers);
1802     }
1803     GST_LOG_OBJECT (sink,
1804         "extending queue to include sync point, now at %d, limit is %d",
1805         max_buffer_usage, limit);
1806     for (i = 0; i < limit; i++) {
1807       buf = g_array_index (mhsink->bufqueue, GstBuffer *, i);
1808       if (is_sync_frame (mhsink, buf)) {
1809         /* found a sync frame, now extend the buffer usage to
1810          * include at least this frame. */
1811         max_buffer_usage = MAX (max_buffer_usage, i);
1812         break;
1813       }
1814     }
1815     GST_LOG_OBJECT (sink, "max buffer usage is now %d", max_buffer_usage);
1816   }
1817
1818   GST_LOG_OBJECT (sink, "len %d, usage %d", queuelen, max_buffer_usage);
1819
1820   /* nobody is referencing units after max_buffer_usage so we can
1821    * remove them from the queue. We remove them in reverse order as
1822    * this is the most optimal for GArray. */
1823   for (i = queuelen - 1; i > max_buffer_usage; i--) {
1824     GstBuffer *old;
1825
1826     /* queue exceeded max size */
1827     queuelen--;
1828     old = g_array_index (mhsink->bufqueue, GstBuffer *, i);
1829     mhsink->bufqueue = g_array_remove_index (mhsink->bufqueue, i);
1830
1831     /* unref tail buffer */
1832     gst_buffer_unref (old);
1833   }
1834   /* save for stats */
1835   mhsink->buffers_queued = max_buffer_usage;
1836   CLIENTS_UNLOCK (sink);
1837
1838   /* and send a signal to thread if handle_set changed */
1839   if (hash_changed && mhsinkclass->hash_changed) {
1840     mhsinkclass->hash_changed (mhsink);
1841   }
1842 }
1843
1844 static GstFlowReturn
1845 gst_multi_handle_sink_render (GstBaseSink * bsink, GstBuffer * buf)
1846 {
1847   gboolean in_caps;
1848 #if 0
1849   GstCaps *bufcaps, *padcaps;
1850 #endif
1851
1852   GstMultiHandleSink *sink = GST_MULTI_HANDLE_SINK (bsink);
1853
1854   g_return_val_if_fail (GST_OBJECT_FLAG_IS_SET (sink,
1855           GST_MULTI_HANDLE_SINK_OPEN), GST_FLOW_FLUSHING);
1856
1857 #if 0
1858   /* since we check every buffer for streamheader caps, we need to make
1859    * sure every buffer has caps set */
1860   bufcaps = gst_buffer_get_caps (buf);
1861   padcaps = GST_PAD_CAPS (GST_BASE_SINK_PAD (bsink));
1862
1863   /* make sure we have caps on the pad */
1864   if (!padcaps && !bufcaps)
1865     goto no_caps;
1866 #endif
1867
1868   /* get IN_CAPS first, code below might mess with the flags */
1869   in_caps = GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_HEADER);
1870
1871 #if 0
1872   /* stamp the buffer with previous caps if no caps set */
1873   if (!bufcaps) {
1874     if (!gst_buffer_is_writable (buf)) {
1875       /* metadata is not writable, copy will be made and original buffer
1876        * will be unreffed so we need to ref so that we don't lose the
1877        * buffer in the render method. */
1878       gst_buffer_ref (buf);
1879       /* the new buffer is ours only, we keep it out of the scope of this
1880        * function */
1881       buf = gst_buffer_make_writable (buf);
1882     } else {
1883       /* else the metadata is writable, we ref because we keep the buffer
1884        * out of the scope of this method */
1885       gst_buffer_ref (buf);
1886     }
1887     /* buffer metadata is writable now, set the caps */
1888     gst_buffer_set_caps (buf, padcaps);
1889   } else {
1890     gst_caps_unref (bufcaps);
1891
1892     /* since we keep this buffer out of the scope of this method */
1893     gst_buffer_ref (buf);
1894   }
1895 #endif
1896   gst_buffer_ref (buf);
1897
1898   GST_LOG_OBJECT (sink, "received buffer %p, in_caps: %s, offset %"
1899       G_GINT64_FORMAT ", offset_end %" G_GINT64_FORMAT
1900       ", timestamp %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
1901       buf, in_caps ? "yes" : "no", GST_BUFFER_OFFSET (buf),
1902       GST_BUFFER_OFFSET_END (buf),
1903       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)),
1904       GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
1905
1906   /* if we get IN_CAPS buffers, but the previous buffer was not IN_CAPS,
1907    * it means we're getting new streamheader buffers, and we should clear
1908    * the old ones */
1909   if (in_caps && sink->previous_buffer_in_caps == FALSE) {
1910     GST_DEBUG_OBJECT (sink,
1911         "receiving new HEADER buffers, clearing old streamheader");
1912     g_slist_foreach (sink->streamheader, (GFunc) gst_mini_object_unref, NULL);
1913     g_slist_free (sink->streamheader);
1914     sink->streamheader = NULL;
1915   }
1916
1917   /* save the current in_caps */
1918   sink->previous_buffer_in_caps = in_caps;
1919
1920   /* if the incoming buffer is marked as IN CAPS, then we assume for now
1921    * it's a streamheader that needs to be sent to each new client, so we
1922    * put it on our internal list of streamheader buffers.
1923    * FIXME: we could check if the buffer's contents are in fact part of the
1924    * current streamheader.
1925    *
1926    * We don't send the buffer to the client, since streamheaders are sent
1927    * separately when necessary. */
1928   if (in_caps) {
1929     GST_DEBUG_OBJECT (sink, "appending HEADER buffer with length %"
1930         G_GSIZE_FORMAT " to streamheader", gst_buffer_get_size (buf));
1931     sink->streamheader = g_slist_append (sink->streamheader, buf);
1932   } else {
1933     /* queue the buffer, this is a regular data buffer. */
1934     gst_multi_handle_sink_queue_buffer (sink, buf);
1935
1936     sink->bytes_to_serve += gst_buffer_get_size (buf);
1937   }
1938   return GST_FLOW_OK;
1939
1940   /* ERRORS */
1941 #if 0
1942 no_caps:
1943   {
1944     GST_ELEMENT_ERROR (sink, CORE, NEGOTIATION, (NULL),
1945         ("Received first buffer without caps set"));
1946     return GST_FLOW_NOT_NEGOTIATED;
1947   }
1948 #endif
1949 }
1950
1951 static void
1952 gst_multi_handle_sink_set_property (GObject * object, guint prop_id,
1953     const GValue * value, GParamSpec * pspec)
1954 {
1955   GstMultiHandleSink *multihandlesink;
1956
1957   multihandlesink = GST_MULTI_HANDLE_SINK (object);
1958
1959   switch (prop_id) {
1960     case PROP_BUFFERS_MAX:
1961       multihandlesink->units_max = g_value_get_int (value);
1962       break;
1963     case PROP_BUFFERS_SOFT_MAX:
1964       multihandlesink->units_soft_max = g_value_get_int (value);
1965       break;
1966     case PROP_TIME_MIN:
1967       multihandlesink->time_min = g_value_get_int64 (value);
1968       break;
1969     case PROP_BYTES_MIN:
1970       multihandlesink->bytes_min = g_value_get_int (value);
1971       break;
1972     case PROP_BUFFERS_MIN:
1973       multihandlesink->buffers_min = g_value_get_int (value);
1974       break;
1975     case PROP_UNIT_FORMAT:
1976       multihandlesink->unit_format = g_value_get_enum (value);
1977       break;
1978     case PROP_UNITS_MAX:
1979       multihandlesink->units_max = g_value_get_int64 (value);
1980       break;
1981     case PROP_UNITS_SOFT_MAX:
1982       multihandlesink->units_soft_max = g_value_get_int64 (value);
1983       break;
1984     case PROP_RECOVER_POLICY:
1985       multihandlesink->recover_policy = g_value_get_enum (value);
1986       break;
1987     case PROP_TIMEOUT:
1988       multihandlesink->timeout = g_value_get_uint64 (value);
1989       break;
1990     case PROP_SYNC_METHOD:
1991       multihandlesink->def_sync_method = g_value_get_enum (value);
1992       break;
1993     case PROP_BURST_FORMAT:
1994       multihandlesink->def_burst_format = g_value_get_enum (value);
1995       break;
1996     case PROP_BURST_VALUE:
1997       multihandlesink->def_burst_value = g_value_get_uint64 (value);
1998       break;
1999     case PROP_QOS_DSCP:
2000       multihandlesink->qos_dscp = g_value_get_int (value);
2001       gst_multi_handle_sink_setup_dscp (multihandlesink);
2002       break;
2003
2004     case PROP_RESEND_STREAMHEADER:
2005       multihandlesink->resend_streamheader = g_value_get_boolean (value);
2006       break;
2007
2008     default:
2009       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2010       break;
2011   }
2012 }
2013
2014 static void
2015 gst_multi_handle_sink_get_property (GObject * object, guint prop_id,
2016     GValue * value, GParamSpec * pspec)
2017 {
2018   GstMultiHandleSink *multihandlesink;
2019
2020   multihandlesink = GST_MULTI_HANDLE_SINK (object);
2021
2022   switch (prop_id) {
2023     case PROP_BUFFERS_MAX:
2024       g_value_set_int (value, multihandlesink->units_max);
2025       break;
2026     case PROP_BUFFERS_SOFT_MAX:
2027       g_value_set_int (value, multihandlesink->units_soft_max);
2028       break;
2029     case PROP_TIME_MIN:
2030       g_value_set_int64 (value, multihandlesink->time_min);
2031       break;
2032     case PROP_BYTES_MIN:
2033       g_value_set_int (value, multihandlesink->bytes_min);
2034       break;
2035     case PROP_BUFFERS_MIN:
2036       g_value_set_int (value, multihandlesink->buffers_min);
2037       break;
2038     case PROP_BUFFERS_QUEUED:
2039       g_value_set_uint (value, multihandlesink->buffers_queued);
2040       break;
2041     case PROP_BYTES_QUEUED:
2042       g_value_set_uint (value, multihandlesink->bytes_queued);
2043       break;
2044     case PROP_TIME_QUEUED:
2045       g_value_set_uint64 (value, multihandlesink->time_queued);
2046       break;
2047     case PROP_UNIT_FORMAT:
2048       g_value_set_enum (value, multihandlesink->unit_format);
2049       break;
2050     case PROP_UNITS_MAX:
2051       g_value_set_int64 (value, multihandlesink->units_max);
2052       break;
2053     case PROP_UNITS_SOFT_MAX:
2054       g_value_set_int64 (value, multihandlesink->units_soft_max);
2055       break;
2056     case PROP_RECOVER_POLICY:
2057       g_value_set_enum (value, multihandlesink->recover_policy);
2058       break;
2059     case PROP_TIMEOUT:
2060       g_value_set_uint64 (value, multihandlesink->timeout);
2061       break;
2062     case PROP_SYNC_METHOD:
2063       g_value_set_enum (value, multihandlesink->def_sync_method);
2064       break;
2065     case PROP_BYTES_TO_SERVE:
2066       g_value_set_uint64 (value, multihandlesink->bytes_to_serve);
2067       break;
2068     case PROP_BYTES_SERVED:
2069       g_value_set_uint64 (value, multihandlesink->bytes_served);
2070       break;
2071     case PROP_BURST_FORMAT:
2072       g_value_set_enum (value, multihandlesink->def_burst_format);
2073       break;
2074     case PROP_BURST_VALUE:
2075       g_value_set_uint64 (value, multihandlesink->def_burst_value);
2076       break;
2077     case PROP_QOS_DSCP:
2078       g_value_set_int (value, multihandlesink->qos_dscp);
2079       break;
2080     case PROP_RESEND_STREAMHEADER:
2081       g_value_set_boolean (value, multihandlesink->resend_streamheader);
2082       break;
2083     case PROP_NUM_HANDLES:
2084       g_value_set_uint (value,
2085           g_hash_table_size (multihandlesink->handle_hash));
2086       break;
2087     default:
2088       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2089       break;
2090   }
2091 }
2092
2093 /* create a socket for sending to remote machine */
2094 static gboolean
2095 gst_multi_handle_sink_start (GstBaseSink * bsink)
2096 {
2097   GstMultiHandleSinkClass *mhsclass;
2098   GstMultiHandleSink *mhsink;
2099
2100   if (GST_OBJECT_FLAG_IS_SET (bsink, GST_MULTI_HANDLE_SINK_OPEN))
2101     return TRUE;
2102
2103   mhsink = GST_MULTI_HANDLE_SINK (bsink);
2104   mhsclass = GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
2105
2106   if (!mhsclass->start_pre (mhsink))
2107     return FALSE;
2108
2109   mhsink->streamheader = NULL;
2110   mhsink->bytes_to_serve = 0;
2111   mhsink->bytes_served = 0;
2112
2113   if (mhsclass->init) {
2114     mhsclass->init (mhsink);
2115   }
2116
2117   mhsink->running = TRUE;
2118
2119   mhsink->thread = g_thread_new ("multihandlesink",
2120       (GThreadFunc) mhsclass->thread, mhsink);
2121
2122   GST_OBJECT_FLAG_SET (bsink, GST_MULTI_HANDLE_SINK_OPEN);
2123
2124   return TRUE;
2125 }
2126
2127 static gboolean
2128 gst_multi_handle_sink_stop (GstBaseSink * bsink)
2129 {
2130   GstMultiHandleSinkClass *mhclass;
2131   GstBuffer *buf;
2132   gint i;
2133   GstMultiHandleSink *mhsink = GST_MULTI_HANDLE_SINK (bsink);
2134
2135   mhclass = GST_MULTI_HANDLE_SINK_GET_CLASS (mhsink);
2136
2137   if (!GST_OBJECT_FLAG_IS_SET (bsink, GST_MULTI_HANDLE_SINK_OPEN))
2138     return TRUE;
2139
2140   mhsink->running = FALSE;
2141
2142   mhclass->stop_pre (mhsink);
2143
2144   if (mhsink->thread) {
2145     GST_DEBUG_OBJECT (mhsink, "joining thread");
2146     g_thread_join (mhsink->thread);
2147     GST_DEBUG_OBJECT (mhsink, "joined thread");
2148     mhsink->thread = NULL;
2149   }
2150
2151   /* free the clients */
2152   mhclass->clear (GST_MULTI_HANDLE_SINK (mhsink));
2153
2154   if (mhsink->streamheader) {
2155     g_slist_foreach (mhsink->streamheader, (GFunc) gst_mini_object_unref, NULL);
2156     g_slist_free (mhsink->streamheader);
2157     mhsink->streamheader = NULL;
2158   }
2159
2160   if (mhclass->close)
2161     mhclass->close (mhsink);
2162
2163   mhclass->stop_post (mhsink);
2164
2165   /* remove all queued buffers */
2166   if (mhsink->bufqueue) {
2167     GST_DEBUG_OBJECT (mhsink, "Emptying bufqueue with %d buffers",
2168         mhsink->bufqueue->len);
2169     for (i = mhsink->bufqueue->len - 1; i >= 0; --i) {
2170       buf = g_array_index (mhsink->bufqueue, GstBuffer *, i);
2171       GST_LOG_OBJECT (mhsink, "Removing buffer %p (%d) with refcount %d", buf,
2172           i, GST_MINI_OBJECT_REFCOUNT (buf));
2173       gst_buffer_unref (buf);
2174       mhsink->bufqueue = g_array_remove_index (mhsink->bufqueue, i);
2175     }
2176     /* freeing the array is done in _finalize */
2177   }
2178   GST_OBJECT_FLAG_UNSET (mhsink, GST_MULTI_HANDLE_SINK_OPEN);
2179
2180   return TRUE;
2181 }
2182
2183 static GstStateChangeReturn
2184 gst_multi_handle_sink_change_state (GstElement * element,
2185     GstStateChange transition)
2186 {
2187   GstMultiHandleSink *sink;
2188   GstStateChangeReturn ret;
2189
2190   sink = GST_MULTI_HANDLE_SINK (element);
2191
2192   /* we disallow changing the state from the streaming thread */
2193   if (g_thread_self () == sink->thread)
2194     return GST_STATE_CHANGE_FAILURE;
2195
2196
2197   switch (transition) {
2198     case GST_STATE_CHANGE_NULL_TO_READY:
2199       if (!gst_multi_handle_sink_start (GST_BASE_SINK (sink)))
2200         goto start_failed;
2201       break;
2202     case GST_STATE_CHANGE_READY_TO_PAUSED:
2203       break;
2204     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
2205       break;
2206     default:
2207       break;
2208   }
2209
2210   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2211
2212   switch (transition) {
2213     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
2214       break;
2215     case GST_STATE_CHANGE_PAUSED_TO_READY:
2216       break;
2217     case GST_STATE_CHANGE_READY_TO_NULL:
2218       gst_multi_handle_sink_stop (GST_BASE_SINK (sink));
2219       break;
2220     default:
2221       break;
2222   }
2223   return ret;
2224
2225   /* ERRORS */
2226 start_failed:
2227   {
2228     /* error message was posted */
2229     return GST_STATE_CHANGE_FAILURE;
2230   }
2231 }