gstreamer/gst/netsim/gstnetsim.c
2017-11-25 11:27:57 +00:00

769 lines
24 KiB
C

/*
* GStreamer
*
* Copyright 2006 Collabora Ltd,
* Copyright 2006 Nokia Corporation
* @author: Philippe Kalaf <philippe.kalaf@collabora.co.uk>.
* Copyright 2012-2016 Pexip
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstnetsim.h"
#include <string.h>
#include <math.h>
#include <float.h>
GST_DEBUG_CATEGORY (netsim_debug);
#define GST_CAT_DEFAULT (netsim_debug)
static GType
distribution_get_type (void)
{
static volatile gsize g_define_type_id__volatile = 0;
if (g_once_init_enter (&g_define_type_id__volatile)) {
static const GEnumValue values[] = {
{DISTRIBUTION_UNIFORM, "uniform", "uniform"},
{DISTRIBUTION_NORMAL, "normal", "normal"},
{DISTRIBUTION_GAMMA, "gamma", "gamma"},
{0, NULL, NULL}
};
GType g_define_type_id =
g_enum_register_static ("GstNetSimDistribution", values);
g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
}
return g_define_type_id__volatile;
}
enum
{
PROP_0,
PROP_MIN_DELAY,
PROP_MAX_DELAY,
PROP_DELAY_DISTRIBUTION,
PROP_DELAY_PROBABILITY,
PROP_DROP_PROBABILITY,
PROP_DUPLICATE_PROBABILITY,
PROP_DROP_PACKETS,
PROP_MAX_KBPS,
PROP_MAX_BUCKET_SIZE,
PROP_ALLOW_REORDERING,
};
/* these numbers are nothing but wild guesses and dont reflect any reality */
#define DEFAULT_MIN_DELAY 200
#define DEFAULT_MAX_DELAY 400
#define DEFAULT_DELAY_DISTRIBUTION DISTRIBUTION_UNIFORM
#define DEFAULT_DELAY_PROBABILITY 0.0
#define DEFAULT_DROP_PROBABILITY 0.0
#define DEFAULT_DUPLICATE_PROBABILITY 0.0
#define DEFAULT_DROP_PACKETS 0
#define DEFAULT_MAX_KBPS -1
#define DEFAULT_MAX_BUCKET_SIZE -1
#define DEFAULT_ALLOW_REORDERING TRUE
static GstStaticPadTemplate gst_net_sim_sink_template =
GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
static GstStaticPadTemplate gst_net_sim_src_template =
GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
G_DEFINE_TYPE (GstNetSim, gst_net_sim, GST_TYPE_ELEMENT);
static gboolean
gst_net_sim_source_dispatch (GSource * source,
GSourceFunc callback, gpointer user_data)
{
callback (user_data);
return FALSE;
}
GSourceFuncs gst_net_sim_source_funcs = {
NULL, /* prepare */
NULL, /* check */
gst_net_sim_source_dispatch,
NULL /* finalize */
};
static void
gst_net_sim_loop (GstNetSim * netsim)
{
GMainLoop *loop;
GST_TRACE_OBJECT (netsim, "TASK: begin");
g_mutex_lock (&netsim->loop_mutex);
loop = g_main_loop_ref (netsim->main_loop);
netsim->running = TRUE;
GST_TRACE_OBJECT (netsim, "TASK: signal start");
g_cond_signal (&netsim->start_cond);
g_mutex_unlock (&netsim->loop_mutex);
GST_TRACE_OBJECT (netsim, "TASK: run");
g_main_loop_run (loop);
g_main_loop_unref (loop);
g_mutex_lock (&netsim->loop_mutex);
GST_TRACE_OBJECT (netsim, "TASK: pause");
gst_pad_pause_task (netsim->srcpad);
netsim->running = FALSE;
GST_TRACE_OBJECT (netsim, "TASK: signal end");
g_cond_signal (&netsim->start_cond);
g_mutex_unlock (&netsim->loop_mutex);
GST_TRACE_OBJECT (netsim, "TASK: end");
}
static gboolean
_main_loop_quit_and_remove_source (gpointer user_data)
{
GMainLoop *main_loop = user_data;
GST_DEBUG ("MAINLOOP: Quit %p", main_loop);
g_main_loop_quit (main_loop);
g_assert (!g_main_loop_is_running (main_loop));
return FALSE; /* Remove source */
}
static gboolean
gst_net_sim_src_activatemode (GstPad * pad, GstObject * parent,
GstPadMode mode, gboolean active)
{
GstNetSim *netsim = GST_NET_SIM (parent);
gboolean result = FALSE;
g_mutex_lock (&netsim->loop_mutex);
if (active) {
if (netsim->main_loop == NULL) {
GMainContext *main_context = g_main_context_new ();
netsim->main_loop = g_main_loop_new (main_context, FALSE);
g_main_context_unref (main_context);
GST_TRACE_OBJECT (netsim, "ACT: Starting task on srcpad");
result = gst_pad_start_task (netsim->srcpad,
(GstTaskFunction) gst_net_sim_loop, netsim, NULL);
GST_TRACE_OBJECT (netsim, "ACT: Wait for task to start");
g_assert (!netsim->running);
while (!netsim->running)
g_cond_wait (&netsim->start_cond, &netsim->loop_mutex);
GST_TRACE_OBJECT (netsim, "ACT: Task on srcpad started");
}
} else {
if (netsim->main_loop != NULL) {
GSource *source;
guint id;
/* Adds an Idle Source which quits the main loop from within.
* This removes the possibility for run/quit race conditions. */
GST_TRACE_OBJECT (netsim, "DEACT: Stopping main loop on deactivate");
source = g_idle_source_new ();
g_source_set_callback (source, _main_loop_quit_and_remove_source,
g_main_loop_ref (netsim->main_loop),
(GDestroyNotify) g_main_loop_unref);
id = g_source_attach (source,
g_main_loop_get_context (netsim->main_loop));
g_source_unref (source);
g_assert_cmpuint (id, >, 0);
g_main_loop_unref (netsim->main_loop);
netsim->main_loop = NULL;
GST_TRACE_OBJECT (netsim, "DEACT: Wait for mainloop and task to pause");
g_assert (netsim->running);
while (netsim->running)
g_cond_wait (&netsim->start_cond, &netsim->loop_mutex);
GST_TRACE_OBJECT (netsim, "DEACT: Stopping task on srcpad");
result = gst_pad_stop_task (netsim->srcpad);
GST_TRACE_OBJECT (netsim, "DEACT: Mainloop and GstTask stopped");
}
}
g_mutex_unlock (&netsim->loop_mutex);
return result;
}
typedef struct
{
GstPad *pad;
GstBuffer *buf;
} PushBufferCtx;
G_INLINE_FUNC PushBufferCtx *
push_buffer_ctx_new (GstPad * pad, GstBuffer * buf)
{
PushBufferCtx *ctx = g_slice_new (PushBufferCtx);
ctx->pad = gst_object_ref (pad);
ctx->buf = gst_buffer_ref (buf);
return ctx;
}
G_INLINE_FUNC void
push_buffer_ctx_free (PushBufferCtx * ctx)
{
if (G_LIKELY (ctx != NULL)) {
gst_buffer_unref (ctx->buf);
gst_object_unref (ctx->pad);
g_slice_free (PushBufferCtx, ctx);
}
}
static gboolean
push_buffer_ctx_push (PushBufferCtx * ctx)
{
GST_DEBUG_OBJECT (ctx->pad, "Pushing buffer now");
gst_pad_push (ctx->pad, gst_buffer_ref (ctx->buf));
return FALSE;
}
static gint
get_random_value_uniform (GRand * rand_seed, gint32 min_value, gint32 max_value)
{
return g_rand_int_range (rand_seed, min_value, max_value + 1);
}
/* Use the Box-Muller transform. */
static gdouble
random_value_normal (GRand * rand_seed, gdouble mu, gdouble sigma,
NormalDistributionState * state)
{
gdouble u1, u2, t1, t2;
state->generate = !state->generate;
if (!state->generate)
return state->z1 * sigma + mu;
do {
u1 = g_rand_double (rand_seed);
u2 = g_rand_double (rand_seed);
} while (u1 <= DBL_EPSILON);
t1 = sqrt (-2.0 * log (u1));
t2 = 2.0 * G_PI * u2;
state->z0 = t1 * cos (t2);
state->z1 = t1 * sin (t2);
return state->z0 * sigma + mu;
}
/* Generate a value from a normal distributation with 95% confidense interval
* between LOW and HIGH */
static gint
get_random_value_normal (GRand * rand_seed, gint32 low, gint32 high,
NormalDistributionState * state)
{
gdouble mu = (high + low) / 2.0;
gdouble sigma = (high - low) / (2 * 1.96); /* 95% confidence interval */
gdouble z = random_value_normal (rand_seed, mu, sigma, state);
return round (z);
}
/* Marsaglia and Tsang's method */
static gdouble
random_value_gamma (GRand * rand_seed, gdouble a, gdouble b,
NormalDistributionState * state)
{
const gdouble d = a - 1.0 / 3.0;
const gdouble c = 1.0 / sqrt (9 * d);
gdouble x, u, z, v;
if (a >= 1.0) {
while (TRUE) {
z = random_value_normal (rand_seed, 0.0, 1.0, state);
if (z > -1.0 / c) {
u = g_rand_double (rand_seed);
v = 1.0 + c * z;
v = v * v * v;
if (log (u) < (0.5 * z * z + d * (1 - v + log (v)))) {
x = d * v;
break;
}
}
}
} else {
u = g_rand_double (rand_seed);
x = random_value_gamma (rand_seed, a + 1, b, state) * pow (u, 1.0 / a);
}
return x * b;
}
static gint
get_random_value_gamma (GRand * rand_seed, gint32 low, gint32 high,
NormalDistributionState * state)
{
/* shape parameter 1.25 gives an OK simulation of wireless networks */
/* Find the scale parameter so that P(0 < x < high-low) < 0.95 */
/* We know: P(0 < x < R) < 0.95 for gamma(1.25, 1), R = 3.4640381 */
gdouble shape = 1.25;
gdouble scale = (high - low) / 3.4640381;
gdouble x = random_value_gamma (rand_seed, shape, scale, state);
/* Add offset so that low is the minimum possible value */
return round (x + low);
}
static GstFlowReturn
gst_net_sim_delay_buffer (GstNetSim * netsim, GstBuffer * buf)
{
GstFlowReturn ret = GST_FLOW_OK;
g_mutex_lock (&netsim->loop_mutex);
if (netsim->main_loop != NULL && netsim->delay_probability > 0 &&
g_rand_double (netsim->rand_seed) < netsim->delay_probability) {
gint delay;
PushBufferCtx *ctx;
GSource *source;
gint64 ready_time;
switch (netsim->delay_distribution) {
case DISTRIBUTION_UNIFORM:
delay = get_random_value_uniform (netsim->rand_seed, netsim->min_delay,
netsim->max_delay);
break;
case DISTRIBUTION_NORMAL:
delay = get_random_value_normal (netsim->rand_seed, netsim->min_delay,
netsim->max_delay, &netsim->delay_state);
break;
case DISTRIBUTION_GAMMA:
delay = get_random_value_gamma (netsim->rand_seed, netsim->min_delay,
netsim->max_delay, &netsim->delay_state);
break;
default:
g_assert_not_reached ();
break;
}
if (delay < 0)
delay = 0;
ctx = push_buffer_ctx_new (netsim->srcpad, buf);
source = g_source_new (&gst_net_sim_source_funcs, sizeof (GSource));
ready_time = g_get_monotonic_time () + delay * 1000;
if (!netsim->allow_reordering && ready_time < netsim->last_ready_time)
ready_time = netsim->last_ready_time + 1;
GST_DEBUG_OBJECT (netsim, "Delaying packet by %ldms",
(ready_time - netsim->last_ready_time) / 1000);
netsim->last_ready_time = ready_time;
g_source_set_ready_time (source, ready_time);
g_source_set_callback (source, (GSourceFunc) push_buffer_ctx_push,
ctx, (GDestroyNotify) push_buffer_ctx_free);
g_source_attach (source, g_main_loop_get_context (netsim->main_loop));
g_source_unref (source);
} else {
ret = gst_pad_push (netsim->srcpad, gst_buffer_ref (buf));
}
g_mutex_unlock (&netsim->loop_mutex);
return ret;
}
static gint
gst_net_sim_get_tokens (GstNetSim * netsim)
{
gint tokens = 0;
GstClockTimeDiff elapsed_time = 0;
GstClockTime current_time = 0;
GstClockTimeDiff token_time;
GstClock *clock;
/* check for umlimited kbps and fill up the bucket if that is the case,
* if not, calculate the number of tokens to add based on the elapsed time */
if (netsim->max_kbps == -1)
return netsim->max_bucket_size * 1000 - netsim->bucket_size;
/* get the current time */
clock = gst_element_get_clock (GST_ELEMENT_CAST (netsim));
if (clock == NULL) {
GST_WARNING_OBJECT (netsim, "No clock, can't get the time");
} else {
current_time = gst_clock_get_time (clock);
}
/* get the elapsed time */
if (GST_CLOCK_TIME_IS_VALID (netsim->prev_time)) {
if (current_time < netsim->prev_time) {
GST_WARNING_OBJECT (netsim, "Clock is going backwards!!");
} else {
elapsed_time = GST_CLOCK_DIFF (netsim->prev_time, current_time);
}
} else {
netsim->prev_time = current_time;
}
/* calculate number of tokens and how much time is "spent" by these tokens */
tokens =
gst_util_uint64_scale_int (elapsed_time, netsim->max_kbps * 1000,
GST_SECOND);
token_time =
gst_util_uint64_scale_int (GST_SECOND, tokens, netsim->max_kbps * 1000);
/* increment the time with how much we spent in terms of whole tokens */
netsim->prev_time += token_time;
gst_object_unref (clock);
return tokens;
}
static gboolean
gst_net_sim_token_bucket (GstNetSim * netsim, GstBuffer * buf)
{
gsize buffer_size;
gint tokens;
/* with an unlimited bucket-size, we have nothing to do */
if (netsim->max_bucket_size == -1)
return TRUE;
/* get buffer size in bits */
buffer_size = gst_buffer_get_size (buf) * 8;
tokens = gst_net_sim_get_tokens (netsim);
netsim->bucket_size = MIN (G_MAXINT, netsim->bucket_size + tokens);
GST_LOG_OBJECT (netsim, "Adding %d tokens to bucket (contains %lu tokens)",
tokens, netsim->bucket_size);
if (netsim->max_bucket_size != -1 && netsim->bucket_size >
netsim->max_bucket_size * 1000)
netsim->bucket_size = netsim->max_bucket_size * 1000;
if (buffer_size > netsim->bucket_size) {
GST_DEBUG_OBJECT (netsim, "Buffer size (%lu) exeedes bucket size (%lu)",
buffer_size, netsim->bucket_size);
return FALSE;
}
netsim->bucket_size -= buffer_size;
GST_LOG_OBJECT (netsim, "Buffer taking %lu tokens (%lu left)",
buffer_size, netsim->bucket_size);
return TRUE;
}
static GstFlowReturn
gst_net_sim_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
{
GstNetSim *netsim = GST_NET_SIM (parent);
GstFlowReturn ret = GST_FLOW_OK;
if (!gst_net_sim_token_bucket (netsim, buf))
goto done;
if (netsim->drop_packets > 0) {
netsim->drop_packets--;
GST_DEBUG_OBJECT (netsim, "Dropping packet (%d left)",
netsim->drop_packets);
} else if (netsim->drop_probability > 0
&& g_rand_double (netsim->rand_seed) <
(gdouble) netsim->drop_probability) {
GST_DEBUG_OBJECT (netsim, "Dropping packet");
} else if (netsim->duplicate_probability > 0 &&
g_rand_double (netsim->rand_seed) <
(gdouble) netsim->duplicate_probability) {
GST_DEBUG_OBJECT (netsim, "Duplicating packet");
gst_net_sim_delay_buffer (netsim, buf);
ret = gst_net_sim_delay_buffer (netsim, buf);
} else {
ret = gst_net_sim_delay_buffer (netsim, buf);
}
done:
gst_buffer_unref (buf);
return ret;
}
static void
gst_net_sim_set_property (GObject * object,
guint prop_id, const GValue * value, GParamSpec * pspec)
{
GstNetSim *netsim = GST_NET_SIM (object);
switch (prop_id) {
case PROP_MIN_DELAY:
netsim->min_delay = g_value_get_int (value);
break;
case PROP_MAX_DELAY:
netsim->max_delay = g_value_get_int (value);
break;
case PROP_DELAY_DISTRIBUTION:
netsim->delay_distribution = g_value_get_enum (value);
break;
case PROP_DELAY_PROBABILITY:
netsim->delay_probability = g_value_get_float (value);
break;
case PROP_DROP_PROBABILITY:
netsim->drop_probability = g_value_get_float (value);
break;
case PROP_DUPLICATE_PROBABILITY:
netsim->duplicate_probability = g_value_get_float (value);
break;
case PROP_DROP_PACKETS:
netsim->drop_packets = g_value_get_uint (value);
break;
case PROP_MAX_KBPS:
netsim->max_kbps = g_value_get_int (value);
break;
case PROP_MAX_BUCKET_SIZE:
netsim->max_bucket_size = g_value_get_int (value);
if (netsim->max_bucket_size != -1)
netsim->bucket_size = netsim->max_bucket_size * 1000;
break;
case PROP_ALLOW_REORDERING:
netsim->allow_reordering = g_value_get_boolean (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_net_sim_get_property (GObject * object,
guint prop_id, GValue * value, GParamSpec * pspec)
{
GstNetSim *netsim = GST_NET_SIM (object);
switch (prop_id) {
case PROP_MIN_DELAY:
g_value_set_int (value, netsim->min_delay);
break;
case PROP_MAX_DELAY:
g_value_set_int (value, netsim->max_delay);
break;
case PROP_DELAY_DISTRIBUTION:
g_value_set_enum (value, netsim->delay_distribution);
break;
case PROP_DELAY_PROBABILITY:
g_value_set_float (value, netsim->delay_probability);
break;
case PROP_DROP_PROBABILITY:
g_value_set_float (value, netsim->drop_probability);
break;
case PROP_DUPLICATE_PROBABILITY:
g_value_set_float (value, netsim->duplicate_probability);
break;
case PROP_DROP_PACKETS:
g_value_set_uint (value, netsim->drop_packets);
break;
case PROP_MAX_KBPS:
g_value_set_int (value, netsim->max_kbps);
break;
case PROP_MAX_BUCKET_SIZE:
g_value_set_int (value, netsim->max_bucket_size);
break;
case PROP_ALLOW_REORDERING:
g_value_set_boolean (value, netsim->allow_reordering);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_net_sim_init (GstNetSim * netsim)
{
netsim->srcpad =
gst_pad_new_from_static_template (&gst_net_sim_src_template, "src");
netsim->sinkpad =
gst_pad_new_from_static_template (&gst_net_sim_sink_template, "sink");
gst_element_add_pad (GST_ELEMENT (netsim), netsim->srcpad);
gst_element_add_pad (GST_ELEMENT (netsim), netsim->sinkpad);
g_mutex_init (&netsim->loop_mutex);
g_cond_init (&netsim->start_cond);
netsim->rand_seed = g_rand_new ();
netsim->main_loop = NULL;
netsim->prev_time = GST_CLOCK_TIME_NONE;
GST_OBJECT_FLAG_SET (netsim->sinkpad,
GST_PAD_FLAG_PROXY_CAPS | GST_PAD_FLAG_PROXY_ALLOCATION);
gst_pad_set_chain_function (netsim->sinkpad,
GST_DEBUG_FUNCPTR (gst_net_sim_chain));
gst_pad_set_activatemode_function (netsim->srcpad,
GST_DEBUG_FUNCPTR (gst_net_sim_src_activatemode));
}
static void
gst_net_sim_finalize (GObject * object)
{
GstNetSim *netsim = GST_NET_SIM (object);
g_rand_free (netsim->rand_seed);
g_mutex_clear (&netsim->loop_mutex);
g_cond_clear (&netsim->start_cond);
G_OBJECT_CLASS (gst_net_sim_parent_class)->finalize (object);
}
static void
gst_net_sim_dispose (GObject * object)
{
GstNetSim *netsim = GST_NET_SIM (object);
g_assert (netsim->main_loop == NULL);
G_OBJECT_CLASS (gst_net_sim_parent_class)->dispose (object);
}
static void
gst_net_sim_class_init (GstNetSimClass * klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
gst_element_class_add_static_pad_template (gstelement_class,
&gst_net_sim_src_template);
gst_element_class_add_static_pad_template (gstelement_class,
&gst_net_sim_sink_template);
gst_element_class_set_metadata (gstelement_class,
"Network Simulator",
"Filter/Network",
"An element that simulates network jitter, "
"packet loss and packet duplication",
"Philippe Kalaf <philippe.kalaf@collabora.co.uk>, "
"Havard Graff <havard@pexip.com>");
gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_net_sim_dispose);
gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_net_sim_finalize);
gobject_class->set_property = gst_net_sim_set_property;
gobject_class->get_property = gst_net_sim_get_property;
g_object_class_install_property (gobject_class, PROP_MIN_DELAY,
g_param_spec_int ("min-delay", "Minimum delay (ms)",
"The minimum delay in ms to apply to buffers",
G_MININT, G_MAXINT, DEFAULT_MIN_DELAY,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_MAX_DELAY,
g_param_spec_int ("max-delay", "Maximum delay (ms)",
"The maximum delay (inclusive) in ms to apply to buffers",
G_MININT, G_MAXINT, DEFAULT_MAX_DELAY,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
/**
* GstNetSim:delay-distribution:
*
* Distribution for the amount of delay.
*
* Since: 1.14
*/
g_object_class_install_property (gobject_class, PROP_DELAY_DISTRIBUTION,
g_param_spec_enum ("delay-distribution", "Delay Distribution",
"Distribution for the amount of delay",
distribution_get_type (), DEFAULT_DELAY_DISTRIBUTION,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_DELAY_PROBABILITY,
g_param_spec_float ("delay-probability", "Delay Probability",
"The Probability a buffer is delayed",
0.0, 1.0, DEFAULT_DELAY_PROBABILITY,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_DROP_PROBABILITY,
g_param_spec_float ("drop-probability", "Drop Probability",
"The Probability a buffer is dropped",
0.0, 1.0, DEFAULT_DROP_PROBABILITY,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_DUPLICATE_PROBABILITY,
g_param_spec_float ("duplicate-probability", "Duplicate Probability",
"The Probability a buffer is duplicated",
0.0, 1.0, DEFAULT_DUPLICATE_PROBABILITY,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_DROP_PACKETS,
g_param_spec_uint ("drop-packets", "Drop Packets",
"Drop the next n packets",
0, G_MAXUINT, DEFAULT_DROP_PACKETS,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
/**
* GstNetSim:max-kbps:
*
* The maximum number of kilobits to let through per second. Setting this
* property to a positive value enables network congestion simulation using
* a token bucket algorithm. Also see the "max-bucket-size" property,
*
* Since: 1.14
*/
g_object_class_install_property (gobject_class, PROP_MAX_KBPS,
g_param_spec_int ("max-kbps", "Maximum Kbps",
"The maximum number of kilobits to let through per second "
"(-1 = unlimited)", -1, G_MAXINT, DEFAULT_MAX_KBPS,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
/**
* GstNetSim:max-bucket-size:
*
* The size of the token bucket, related to burstiness resilience.
*
* Since: 1.14
*/
g_object_class_install_property (gobject_class, PROP_MAX_BUCKET_SIZE,
g_param_spec_int ("max-bucket-size", "Maximum Bucket Size (Kb)",
"The size of the token bucket, related to burstiness resilience "
"(-1 = unlimited)", -1, G_MAXINT, DEFAULT_MAX_BUCKET_SIZE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
/**
* GstNetSim:allow-reordering:
*
* When delaying packets, are they allowed to be reordered or not. By
* default this is enabled, but in the real world packet reordering is
* fairly uncommon, yet the delay functions will always introduce reordering
* if delay > packet-spacing, This property allows switching that off.
*
* Since: 1.14
*/
g_object_class_install_property (gobject_class, PROP_ALLOW_REORDERING,
g_param_spec_boolean ("allow-reordering", "Allow Reordering",
"When delaying packets, are they allowed to be reordered or not",
DEFAULT_ALLOW_REORDERING,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
GST_DEBUG_CATEGORY_INIT (netsim_debug, "netsim", 0, "Network simulator");
}
static gboolean
gst_net_sim_plugin_init (GstPlugin * plugin)
{
return gst_element_register (plugin, "netsim",
GST_RANK_MARGINAL, GST_TYPE_NET_SIM);
}
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR,
netsim,
"Network Simulator",
gst_net_sim_plugin_init, PACKAGE_VERSION, "LGPL", GST_PACKAGE_NAME,
GST_PACKAGE_ORIGIN)