2 * Copyright (C) 2014 Wim Taymans <wim.taymans@gmail.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:element-downloadbuffer
24 * @title: downloadbuffer
26 * The downloadbuffer element provides on-disk buffering and caching of, typically,
27 * a network file. temp-template should be set to a value such as
28 * /tmp/gstreamer-XXXXXX and the element will allocate a random free filename and
29 * buffer the data in the file.
31 * With max-size-bytes and max-size-time you can configure the buffering limits.
32 * The downloadbuffer element will try to read-ahead these amounts of data. When
33 * the amount of read-ahead data drops below low-percent of the configured max,
34 * the element will start emitting BUFFERING messages until high-percent of max is
37 * The downloadbuffer provides push and pull based scheduling on its source pad
38 * and will efficiently seek in the upstream element when needed.
40 * The temp-location property will be used to notify the application of the
43 * When the downloadbuffer has completely downloaded the media, it will
44 * post an application message named <classname>"GstCacheDownloadComplete"</classname>
45 * with the following information:
49 * <classname>"location"</classname>:
50 * the location of the completely downloaded file.
58 #include "gstdownloadbuffer.h"
60 #include <glib/gstdio.h>
62 #include "gst/gst-i18n-lib.h"
63 #include "gst/glib-compat-private.h"
68 #include <io.h> /* lseek, open, close, read */
70 #define lseek _lseeki64
79 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
84 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
89 GST_DEBUG_CATEGORY_STATIC (downloadbuffer_debug);
90 #define GST_CAT_DEFAULT (downloadbuffer_debug)
98 #define DEFAULT_BUFFER_SIZE 4096
100 /* default property values */
101 #define DEFAULT_MAX_SIZE_BYTES (2 * 1024 * 1024) /* 2 MB */
102 #define DEFAULT_MAX_SIZE_TIME 2 * GST_SECOND /* 2 seconds */
103 #define DEFAULT_LOW_PERCENT 10
104 #define DEFAULT_HIGH_PERCENT 99
105 #define DEFAULT_TEMP_REMOVE TRUE
120 #define GST_DOWNLOAD_BUFFER_CLEAR_LEVEL(l) G_STMT_START { \
125 #define STATUS(elem, pad, msg) \
126 GST_LOG_OBJECT (elem, "(%s:%s) " msg ": %u of %u " \
127 "bytes, %" G_GUINT64_FORMAT " of %" G_GUINT64_FORMAT \
129 GST_DEBUG_PAD_NAME (pad), \
130 elem->cur_level.bytes, \
131 elem->max_level.bytes, \
132 elem->cur_level.time, \
133 elem->max_level.time)
135 #define GST_DOWNLOAD_BUFFER_MUTEX_LOCK(q) G_STMT_START { \
136 g_mutex_lock (&q->qlock); \
139 #define GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK(q,res,label) G_STMT_START { \
140 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (q); \
141 if (res != GST_FLOW_OK) \
145 #define GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK(q) G_STMT_START { \
146 g_mutex_unlock (&q->qlock); \
149 #define GST_DOWNLOAD_BUFFER_WAIT_ADD_CHECK(q, res, o, label) G_STMT_START { \
150 STATUS (q, q->srcpad, "wait for ADD"); \
151 q->waiting_add = TRUE; \
152 q->waiting_offset = o; \
153 g_cond_wait (&q->item_add, &q->qlock); \
154 q->waiting_add = FALSE; \
155 if (res != GST_FLOW_OK) { \
156 STATUS (q, q->srcpad, "received ADD wakeup"); \
159 STATUS (q, q->srcpad, "received ADD"); \
162 #define GST_DOWNLOAD_BUFFER_SIGNAL_ADD(q, o) G_STMT_START { \
163 if (q->waiting_add && q->waiting_offset <= o) { \
164 STATUS (q, q->sinkpad, "signal ADD"); \
165 g_cond_signal (&q->item_add); \
170 GST_DEBUG_CATEGORY_INIT (downloadbuffer_debug, "downloadbuffer", 0, \
171 "downloadbuffer element");
173 #define gst_download_buffer_parent_class parent_class
174 G_DEFINE_TYPE_WITH_CODE (GstDownloadBuffer, gst_download_buffer,
175 GST_TYPE_ELEMENT, _do_init);
177 static GstMessage *update_buffering (GstDownloadBuffer * dlbuf);
179 static void gst_download_buffer_finalize (GObject * object);
181 static void gst_download_buffer_set_property (GObject * object,
182 guint prop_id, const GValue * value, GParamSpec * pspec);
183 static void gst_download_buffer_get_property (GObject * object,
184 guint prop_id, GValue * value, GParamSpec * pspec);
186 static GstFlowReturn gst_download_buffer_chain (GstPad * pad,
187 GstObject * parent, GstBuffer * buffer);
188 static void gst_download_buffer_loop (GstPad * pad);
190 static gboolean gst_download_buffer_handle_sink_event (GstPad * pad,
191 GstObject * parent, GstEvent * event);
192 static gboolean gst_download_buffer_handle_sink_query (GstPad * pad,
193 GstObject * parent, GstQuery * query);
195 static gboolean gst_download_buffer_handle_src_event (GstPad * pad,
196 GstObject * parent, GstEvent * event);
197 static gboolean gst_download_buffer_handle_src_query (GstPad * pad,
198 GstObject * parent, GstQuery * query);
199 static gboolean gst_download_buffer_handle_query (GstElement * element,
202 static GstFlowReturn gst_download_buffer_get_range (GstPad * pad,
203 GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
205 static gboolean gst_download_buffer_src_activate_mode (GstPad * pad,
206 GstObject * parent, GstPadMode mode, gboolean active);
207 static gboolean gst_download_buffer_sink_activate_mode (GstPad * pad,
208 GstObject * parent, GstPadMode mode, gboolean active);
209 static GstStateChangeReturn gst_download_buffer_change_state (GstElement *
210 element, GstStateChange transition);
212 /* static guint gst_download_buffer_signals[LAST_SIGNAL] = { 0 }; */
215 gst_download_buffer_class_init (GstDownloadBufferClass * klass)
217 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
218 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
220 gobject_class->set_property = gst_download_buffer_set_property;
221 gobject_class->get_property = gst_download_buffer_get_property;
224 g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BYTES,
225 g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
226 "Max. amount of data to buffer (bytes, 0=disable)",
227 0, G_MAXUINT, DEFAULT_MAX_SIZE_BYTES,
228 G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
229 G_PARAM_STATIC_STRINGS));
230 g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
231 g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
232 "Max. amount of data to buffer (in ns, 0=disable)", 0, G_MAXUINT64,
233 DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
234 G_PARAM_STATIC_STRINGS));
236 g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
237 g_param_spec_int ("low-percent", "Low percent",
238 "Low threshold for buffering to start. Only used if use-buffering is True",
239 0, 100, DEFAULT_LOW_PERCENT,
240 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
241 g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
242 g_param_spec_int ("high-percent", "High percent",
243 "High threshold for buffering to finish. Only used if use-buffering is True",
244 0, 100, DEFAULT_HIGH_PERCENT,
245 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
247 g_object_class_install_property (gobject_class, PROP_TEMP_TEMPLATE,
248 g_param_spec_string ("temp-template", "Temporary File Template",
249 "File template to store temporary files in, should contain directory "
250 "and XXXXXX. (NULL == disabled)",
251 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
253 g_object_class_install_property (gobject_class, PROP_TEMP_LOCATION,
254 g_param_spec_string ("temp-location", "Temporary File Location",
255 "Location to store temporary files in (Only read this property, "
256 "use temp-template to configure the name template)",
257 NULL, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
260 * GstDownloadBuffer:temp-remove
262 * When temp-template is set, remove the temporary file when going to READY.
264 g_object_class_install_property (gobject_class, PROP_TEMP_REMOVE,
265 g_param_spec_boolean ("temp-remove", "Remove the Temporary File",
266 "Remove the temp-location after use",
267 DEFAULT_TEMP_REMOVE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
269 /* set several parent class virtual functions */
270 gobject_class->finalize = gst_download_buffer_finalize;
272 gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);
273 gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
275 gst_element_class_set_static_metadata (gstelement_class, "DownloadBuffer",
276 "Generic", "Download Buffer element",
277 "Wim Taymans <wim.taymans@gmail.com>");
279 gstelement_class->change_state =
280 GST_DEBUG_FUNCPTR (gst_download_buffer_change_state);
281 gstelement_class->query =
282 GST_DEBUG_FUNCPTR (gst_download_buffer_handle_query);
286 gst_download_buffer_init (GstDownloadBuffer * dlbuf)
288 dlbuf->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
290 gst_pad_set_chain_function (dlbuf->sinkpad,
291 GST_DEBUG_FUNCPTR (gst_download_buffer_chain));
292 gst_pad_set_activatemode_function (dlbuf->sinkpad,
293 GST_DEBUG_FUNCPTR (gst_download_buffer_sink_activate_mode));
294 gst_pad_set_event_function (dlbuf->sinkpad,
295 GST_DEBUG_FUNCPTR (gst_download_buffer_handle_sink_event));
296 gst_pad_set_query_function (dlbuf->sinkpad,
297 GST_DEBUG_FUNCPTR (gst_download_buffer_handle_sink_query));
298 GST_PAD_SET_PROXY_CAPS (dlbuf->sinkpad);
299 gst_element_add_pad (GST_ELEMENT (dlbuf), dlbuf->sinkpad);
301 dlbuf->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
303 gst_pad_set_activatemode_function (dlbuf->srcpad,
304 GST_DEBUG_FUNCPTR (gst_download_buffer_src_activate_mode));
305 gst_pad_set_getrange_function (dlbuf->srcpad,
306 GST_DEBUG_FUNCPTR (gst_download_buffer_get_range));
307 gst_pad_set_event_function (dlbuf->srcpad,
308 GST_DEBUG_FUNCPTR (gst_download_buffer_handle_src_event));
309 gst_pad_set_query_function (dlbuf->srcpad,
310 GST_DEBUG_FUNCPTR (gst_download_buffer_handle_src_query));
311 GST_PAD_SET_PROXY_CAPS (dlbuf->srcpad);
312 gst_element_add_pad (GST_ELEMENT (dlbuf), dlbuf->srcpad);
315 GST_DOWNLOAD_BUFFER_CLEAR_LEVEL (dlbuf->cur_level);
316 dlbuf->max_level.bytes = DEFAULT_MAX_SIZE_BYTES;
317 dlbuf->max_level.time = DEFAULT_MAX_SIZE_TIME;
318 dlbuf->low_percent = DEFAULT_LOW_PERCENT;
319 dlbuf->high_percent = DEFAULT_HIGH_PERCENT;
321 dlbuf->srcresult = GST_FLOW_FLUSHING;
322 dlbuf->sinkresult = GST_FLOW_FLUSHING;
323 dlbuf->in_timer = g_timer_new ();
324 dlbuf->out_timer = g_timer_new ();
326 g_mutex_init (&dlbuf->qlock);
327 dlbuf->waiting_add = FALSE;
328 g_cond_init (&dlbuf->item_add);
330 /* tempfile related */
331 dlbuf->temp_template = NULL;
332 dlbuf->temp_location = NULL;
333 dlbuf->temp_remove = DEFAULT_TEMP_REMOVE;
336 /* called only once, as opposed to dispose */
338 gst_download_buffer_finalize (GObject * object)
340 GstDownloadBuffer *dlbuf = GST_DOWNLOAD_BUFFER (object);
342 g_mutex_clear (&dlbuf->qlock);
343 g_cond_clear (&dlbuf->item_add);
344 g_timer_destroy (dlbuf->in_timer);
345 g_timer_destroy (dlbuf->out_timer);
347 /* temp_file path cleanup */
348 g_free (dlbuf->temp_template);
349 g_free (dlbuf->temp_location);
351 G_OBJECT_CLASS (parent_class)->finalize (object);
355 reset_positions (GstDownloadBuffer * dlbuf)
357 dlbuf->write_pos = 0;
359 dlbuf->filling = TRUE;
360 dlbuf->buffering_percent = 0;
361 dlbuf->is_buffering = TRUE;
362 dlbuf->seeking = FALSE;
363 GST_DOWNLOAD_BUFFER_CLEAR_LEVEL (dlbuf->cur_level);
367 reset_rate_timer (GstDownloadBuffer * dlbuf)
370 dlbuf->bytes_out = 0;
371 dlbuf->byte_in_rate = 0.0;
372 dlbuf->byte_in_period = 0;
373 dlbuf->byte_out_rate = 0.0;
374 dlbuf->last_in_elapsed = 0.0;
375 dlbuf->last_out_elapsed = 0.0;
376 dlbuf->in_timer_started = FALSE;
377 dlbuf->out_timer_started = FALSE;
380 /* the interval in seconds to recalculate the rate */
381 #define RATE_INTERVAL 0.2
382 /* Tuning for rate estimation. We use a large window for the input rate because
383 * it should be stable when connected to a network. The output rate is less
384 * stable (the elements preroll, queues behind a demuxer fill, ...) and should
385 * therefore adapt more quickly.
386 * However, initial input rate may be subject to a burst, and should therefore
387 * initially also adapt more quickly to changes, and only later on give higher
388 * weight to previous values. */
389 #define AVG_IN(avg,val,w1,w2) ((avg) * (w1) + (val) * (w2)) / ((w1) + (w2))
390 #define AVG_OUT(avg,val) ((avg) * 3.0 + (val)) / 4.0
393 update_levels (GstDownloadBuffer * dlbuf, guint bytes)
395 dlbuf->cur_level.bytes = bytes;
397 if (dlbuf->byte_in_rate > 0.0) {
398 dlbuf->cur_level.time =
399 dlbuf->cur_level.bytes / dlbuf->byte_in_rate * GST_SECOND;
402 GST_DEBUG ("levels: bytes %u/%u, time %" GST_TIME_FORMAT "/%" GST_TIME_FORMAT,
403 dlbuf->cur_level.bytes, dlbuf->max_level.bytes,
404 GST_TIME_ARGS (dlbuf->cur_level.time),
405 GST_TIME_ARGS (dlbuf->max_level.time));
409 update_in_rates (GstDownloadBuffer * dlbuf)
411 gdouble elapsed, period;
412 gdouble byte_in_rate;
414 if (!dlbuf->in_timer_started) {
415 dlbuf->in_timer_started = TRUE;
416 g_timer_start (dlbuf->in_timer);
420 elapsed = g_timer_elapsed (dlbuf->in_timer, NULL);
422 /* recalc after each interval. */
423 if (dlbuf->last_in_elapsed + RATE_INTERVAL < elapsed) {
424 period = elapsed - dlbuf->last_in_elapsed;
426 GST_DEBUG_OBJECT (dlbuf,
427 "rates: period %f, in %" G_GUINT64_FORMAT ", global period %f",
428 period, dlbuf->bytes_in, dlbuf->byte_in_period);
430 byte_in_rate = dlbuf->bytes_in / period;
432 if (dlbuf->byte_in_rate == 0.0)
433 dlbuf->byte_in_rate = byte_in_rate;
435 dlbuf->byte_in_rate = AVG_IN (dlbuf->byte_in_rate, byte_in_rate,
436 (double) dlbuf->byte_in_period, period);
438 /* another data point, cap at 16 for long time running average */
439 if (dlbuf->byte_in_period < 16 * RATE_INTERVAL)
440 dlbuf->byte_in_period += period;
442 /* reset the values to calculate rate over the next interval */
443 dlbuf->last_in_elapsed = elapsed;
445 GST_DEBUG_OBJECT (dlbuf, "rates: in %f", dlbuf->byte_in_rate);
450 update_out_rates (GstDownloadBuffer * dlbuf)
452 gdouble elapsed, period;
453 gdouble byte_out_rate;
455 if (!dlbuf->out_timer_started) {
456 dlbuf->out_timer_started = TRUE;
457 g_timer_start (dlbuf->out_timer);
461 elapsed = g_timer_elapsed (dlbuf->out_timer, NULL);
463 /* recalc after each interval. */
464 if (dlbuf->last_out_elapsed + RATE_INTERVAL < elapsed) {
465 period = elapsed - dlbuf->last_out_elapsed;
467 GST_DEBUG_OBJECT (dlbuf,
468 "rates: period %f, out %" G_GUINT64_FORMAT, period, dlbuf->bytes_out);
470 byte_out_rate = dlbuf->bytes_out / period;
472 if (dlbuf->byte_out_rate == 0.0)
473 dlbuf->byte_out_rate = byte_out_rate;
475 dlbuf->byte_out_rate = AVG_OUT (dlbuf->byte_out_rate, byte_out_rate);
477 /* reset the values to calculate rate over the next interval */
478 dlbuf->last_out_elapsed = elapsed;
479 dlbuf->bytes_out = 0;
480 GST_DEBUG_OBJECT (dlbuf, "rates: out %f", dlbuf->byte_out_rate);
485 get_buffering_percent (GstDownloadBuffer * dlbuf, gboolean * is_buffering,
490 if (dlbuf->high_percent <= 0) {
494 *is_buffering = FALSE;
498 /* Ensure the variables used to calculate buffering state are up-to-date. */
499 update_in_rates (dlbuf);
500 update_out_rates (dlbuf);
502 /* figure out the percent we are filled, we take the max of all formats. */
503 if (dlbuf->max_level.bytes > 0) {
504 if (dlbuf->cur_level.bytes >= dlbuf->max_level.bytes)
507 perc = dlbuf->cur_level.bytes * 100 / dlbuf->max_level.bytes;
511 if (dlbuf->max_level.time > 0) {
512 if (dlbuf->cur_level.time >= dlbuf->max_level.time)
515 perc = MAX (perc, dlbuf->cur_level.time * 100 / dlbuf->max_level.time);
517 perc = MAX (0, perc);
520 *is_buffering = dlbuf->is_buffering;
522 /* scale to high percent so that it becomes the 100% mark */
523 perc = perc * 100 / dlbuf->high_percent;
531 GST_DEBUG_OBJECT (dlbuf, "buffering %d, percent %d", dlbuf->is_buffering,
538 get_buffering_stats (GstDownloadBuffer * dlbuf, gint percent,
539 GstBufferingMode * mode, gint * avg_in, gint * avg_out,
540 gint64 * buffering_left)
543 *mode = GST_BUFFERING_DOWNLOAD;
546 *avg_in = dlbuf->byte_in_rate;
548 *avg_out = dlbuf->byte_out_rate;
550 if (buffering_left) {
553 *buffering_left = (percent == 100 ? 0 : -1);
555 max = dlbuf->max_level.time;
556 cur = dlbuf->cur_level.time;
558 if (percent != 100 && max > cur)
559 *buffering_left = (max - cur) / 1000000;
564 update_buffering (GstDownloadBuffer * dlbuf)
567 gboolean post = FALSE;
568 GstMessage *message = NULL;
570 if (!get_buffering_percent (dlbuf, NULL, &percent))
573 if (dlbuf->is_buffering) {
575 /* if we were buffering see if we reached the high watermark */
576 if (percent >= dlbuf->high_percent)
577 dlbuf->is_buffering = FALSE;
579 /* we were not buffering, check if we need to start buffering if we drop
580 * below the low threshold */
581 if (percent < dlbuf->low_percent) {
582 dlbuf->is_buffering = TRUE;
588 if (percent == dlbuf->buffering_percent)
591 dlbuf->buffering_percent = percent;
595 GstBufferingMode mode;
596 gint avg_in, avg_out;
597 gint64 buffering_left;
599 get_buffering_stats (dlbuf, percent, &mode, &avg_in, &avg_out,
602 message = gst_message_new_buffering (GST_OBJECT_CAST (dlbuf),
604 gst_message_set_buffering_stats (message, mode,
605 avg_in, avg_out, buffering_left);
612 perform_seek_to_offset (GstDownloadBuffer * dlbuf, guint64 offset)
620 /* until we receive the FLUSH_STOP from this seek, we skip data */
621 dlbuf->seeking = TRUE;
622 dlbuf->write_pos = offset;
623 dlbuf->filling = FALSE;
624 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
626 GST_DEBUG_OBJECT (dlbuf, "Seeking to %" G_GUINT64_FORMAT, offset);
629 gst_event_new_seek (1.0, GST_FORMAT_BYTES,
630 GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_ACCURATE, GST_SEEK_TYPE_SET, offset,
631 GST_SEEK_TYPE_NONE, -1);
633 res = gst_pad_push_event (dlbuf->sinkpad, event);
634 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
639 /* get the threshold for when we decide to seek rather than wait */
641 get_seek_threshold (GstDownloadBuffer * dlbuf)
645 /* FIXME, find a good threshold based on the incoming rate. */
646 threshold = 1024 * 512;
651 /* called with DOWNLOAD_BUFFER_MUTEX */
653 gst_download_buffer_update_upstream_size (GstDownloadBuffer * dlbuf)
655 gint64 upstream_size = 0;
657 if (gst_pad_peer_query_duration (dlbuf->sinkpad, GST_FORMAT_BYTES,
659 GST_INFO_OBJECT (dlbuf, "upstream size: %" G_GINT64_FORMAT, upstream_size);
660 dlbuf->upstream_size = upstream_size;
664 /* called with DOWNLOAD_BUFFER_MUTEX */
666 gst_download_buffer_wait_for_data (GstDownloadBuffer * dlbuf, guint64 offset,
673 GST_DEBUG_OBJECT (dlbuf, "wait for %" G_GUINT64_FORMAT ", length %u",
676 wanted = offset + length;
678 /* pause the timer while we wait. The fact that we are waiting does not mean
679 * the byterate on the output pad is lower */
680 if ((started = dlbuf->out_timer_started))
681 g_timer_stop (dlbuf->out_timer);
683 /* check range before us */
684 if (gst_sparse_file_get_range_before (dlbuf->file, offset, &start, &stop)) {
685 GST_DEBUG_OBJECT (dlbuf,
686 "range before %" G_GSIZE_FORMAT " - %" G_GSIZE_FORMAT, start, stop);
687 if (start <= offset && offset < stop) {
688 GST_DEBUG_OBJECT (dlbuf, "we have the offset");
689 /* we have the range, continue it */
692 guint64 threshold, dist;
694 /* there is a range before us, check how far away it is */
695 threshold = get_seek_threshold (dlbuf);
696 dist = offset - stop;
698 if (dist <= threshold) {
699 GST_DEBUG_OBJECT (dlbuf, "not too far");
700 /* not far away, continue it */
706 if (dlbuf->write_pos != offset)
707 perform_seek_to_offset (dlbuf, offset);
709 dlbuf->filling = TRUE;
710 if (dlbuf->write_pos > dlbuf->read_pos)
711 update_levels (dlbuf, dlbuf->write_pos - dlbuf->read_pos);
713 update_levels (dlbuf, 0);
715 /* now wait for more data */
716 GST_DEBUG_OBJECT (dlbuf, "waiting for more data");
717 GST_DOWNLOAD_BUFFER_WAIT_ADD_CHECK (dlbuf, dlbuf->srcresult, wanted,
719 GST_DEBUG_OBJECT (dlbuf, "got more data");
721 /* and continue if we were running before */
723 g_timer_continue (dlbuf->out_timer);
729 GST_DEBUG_OBJECT (dlbuf, "we are flushing");
730 return GST_FLOW_FLUSHING;
734 /* called with DOWNLOAD_BUFFER_MUTEX */
736 check_upstream_size (GstDownloadBuffer * dlbuf, gsize offset, guint * length)
738 gsize stop = offset + *length;
739 /* catch any reads beyond the size of the file here to make sure cache
740 * doesn't send seek events beyond the size of the file upstream, since
741 * that would confuse elements such as souphttpsrc and/or http servers.
742 * Demuxers often just loop until EOS at the end of the file to figure out
743 * when they've read all the end-headers or index chunks. */
744 if (G_UNLIKELY (dlbuf->upstream_size == -1 || stop >= dlbuf->upstream_size)) {
745 gst_download_buffer_update_upstream_size (dlbuf);
748 if (dlbuf->upstream_size != -1) {
749 if (offset >= dlbuf->upstream_size)
752 if (G_UNLIKELY (stop > dlbuf->upstream_size)) {
753 *length = dlbuf->upstream_size - offset;
754 GST_DEBUG_OBJECT (dlbuf, "adjusting length downto %u", *length);
760 /* called with DOWNLOAD_BUFFER_MUTEX */
762 gst_download_buffer_read_buffer (GstDownloadBuffer * dlbuf, guint64 offset,
763 guint length, GstBuffer ** buffer)
767 GstFlowReturn ret = GST_FLOW_OK;
768 gsize res, remaining;
769 GError *error = NULL;
771 length = (length == -1) ? DEFAULT_BUFFER_SIZE : length;
772 offset = (offset == -1) ? dlbuf->read_pos : offset;
774 if (!check_upstream_size (dlbuf, offset, &length))
777 /* allocate the output buffer of the requested size */
779 buf = gst_buffer_new_allocate (NULL, length, NULL);
783 if (!gst_buffer_map (buf, &info, GST_MAP_WRITE))
786 GST_DEBUG_OBJECT (dlbuf, "Reading %u bytes from %" G_GUINT64_FORMAT, length,
789 dlbuf->read_pos = offset;
793 gst_sparse_file_read (dlbuf->file, offset, info.data, length,
795 if (G_UNLIKELY (res == 0)) {
796 switch (error->code) {
797 case GST_SPARSE_FILE_IO_ERROR_WOULD_BLOCK:
798 /* we don't have the requested data in the file, decide what to
800 ret = gst_download_buffer_wait_for_data (dlbuf, offset, length);
801 if (ret != GST_FLOW_OK)
807 g_clear_error (&error);
811 gst_buffer_unmap (buf, &info);
812 gst_buffer_resize (buf, 0, res);
814 dlbuf->bytes_out += res;
815 dlbuf->read_pos += res;
817 GST_DEBUG_OBJECT (dlbuf,
818 "Read %" G_GSIZE_FORMAT " bytes, remaining %" G_GSIZE_FORMAT, res,
821 if (dlbuf->read_pos + remaining == dlbuf->upstream_size)
822 update_levels (dlbuf, dlbuf->max_level.bytes);
824 update_levels (dlbuf, remaining);
826 GST_BUFFER_OFFSET (buf) = offset;
827 GST_BUFFER_OFFSET_END (buf) = offset + res;
836 GST_DEBUG_OBJECT (dlbuf, "EOS hit");
841 GST_ELEMENT_ERROR (dlbuf, RESOURCE, BUSY,
842 (_("Failed to map buffer.")), ("failed to map buffer in WRITE mode"));
844 gst_buffer_unref (buf);
845 return GST_FLOW_ERROR;
849 GST_DEBUG_OBJECT (dlbuf, "we are flushing");
850 g_clear_error (&error);
851 gst_buffer_unmap (buf, &info);
853 gst_buffer_unref (buf);
854 return GST_FLOW_FLUSHING;
858 GST_DEBUG_OBJECT (dlbuf, "we have a read error: %s", error->message);
859 g_clear_error (&error);
860 gst_buffer_unmap (buf, &info);
862 gst_buffer_unref (buf);
867 /* must be called with MUTEX_LOCK. Will briefly release the lock when notifying
868 * the temp filename. */
870 gst_download_buffer_open_temp_location_file (GstDownloadBuffer * dlbuf)
878 GST_DEBUG_OBJECT (dlbuf, "opening temp file %s", dlbuf->temp_template);
880 /* If temp_template was set, allocate a filename and open that file */
883 if (dlbuf->temp_template == NULL)
886 /* make copy of the template, we don't want to change this */
887 name = g_strdup (dlbuf->temp_template);
889 fd = g_mkstemp_full (name, O_RDWR | O_LARGEFILE, S_IRUSR | S_IWUSR);
891 fd = g_mkstemp (name);
896 /* open the file for update/writing */
897 dlbuf->file = gst_sparse_file_new ();
898 /* error creating file */
899 if (!gst_sparse_file_set_fd (dlbuf->file, fd))
902 g_free (dlbuf->temp_location);
903 dlbuf->temp_location = name;
905 reset_positions (dlbuf);
907 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
909 /* we can't emit the notify with the lock */
910 g_object_notify (G_OBJECT (dlbuf), "temp-location");
912 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
914 GST_DEBUG_OBJECT (dlbuf, "opened temp file %s", dlbuf->temp_template);
921 GST_DEBUG_OBJECT (dlbuf, "temp file was already open");
926 GST_ELEMENT_ERROR (dlbuf, RESOURCE, NOT_FOUND,
927 (_("No Temp directory specified.")), (NULL));
932 GST_ELEMENT_ERROR (dlbuf, RESOURCE, OPEN_READ,
933 (_("Could not create temp file \"%s\"."), dlbuf->temp_template),
940 GST_ELEMENT_ERROR (dlbuf, RESOURCE, OPEN_READ,
941 (_("Could not open file \"%s\" for reading."), name), GST_ERROR_SYSTEM);
950 gst_download_buffer_close_temp_location_file (GstDownloadBuffer * dlbuf)
953 if (dlbuf->file == NULL)
956 GST_DEBUG_OBJECT (dlbuf, "closing sparse file");
958 if (dlbuf->temp_remove) {
959 if (remove (dlbuf->temp_location) < 0) {
960 GST_WARNING_OBJECT (dlbuf, "Failed to remove temporary file %s: %s",
961 dlbuf->temp_location, g_strerror (errno));
964 gst_sparse_file_free (dlbuf->file);
965 close (dlbuf->temp_fd);
970 gst_download_buffer_flush_temp_file (GstDownloadBuffer * dlbuf)
972 if (dlbuf->file == NULL)
975 GST_DEBUG_OBJECT (dlbuf, "flushing temp file");
977 gst_sparse_file_clear (dlbuf->file);
981 gst_download_buffer_locked_flush (GstDownloadBuffer * dlbuf, gboolean full,
985 gst_download_buffer_flush_temp_file (dlbuf);
986 reset_positions (dlbuf);
987 gst_event_replace (&dlbuf->stream_start_event, NULL);
988 gst_event_replace (&dlbuf->segment_event, NULL);
992 gst_download_buffer_handle_sink_event (GstPad * pad, GstObject * parent,
996 GstDownloadBuffer *dlbuf;
998 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1000 switch (GST_EVENT_TYPE (event)) {
1001 case GST_EVENT_FLUSH_START:
1003 GST_LOG_OBJECT (dlbuf, "received flush start event");
1004 if (GST_PAD_MODE (dlbuf->srcpad) == GST_PAD_MODE_PUSH) {
1006 ret = gst_pad_push_event (dlbuf->srcpad, event);
1008 /* now unblock the chain function */
1009 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1010 dlbuf->srcresult = GST_FLOW_FLUSHING;
1011 dlbuf->sinkresult = GST_FLOW_FLUSHING;
1012 /* unblock the loop and chain functions */
1013 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, -1);
1014 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1016 /* make sure it pauses, this should happen since we sent
1017 * flush_start downstream. */
1018 gst_pad_pause_task (dlbuf->srcpad);
1019 GST_LOG_OBJECT (dlbuf, "loop stopped");
1021 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1022 /* flush the sink pad */
1023 dlbuf->sinkresult = GST_FLOW_FLUSHING;
1024 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1026 gst_event_unref (event);
1030 case GST_EVENT_FLUSH_STOP:
1032 GST_LOG_OBJECT (dlbuf, "received flush stop event");
1034 if (GST_PAD_MODE (dlbuf->srcpad) == GST_PAD_MODE_PUSH) {
1036 ret = gst_pad_push_event (dlbuf->srcpad, event);
1038 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1039 gst_download_buffer_locked_flush (dlbuf, FALSE, TRUE);
1040 dlbuf->srcresult = GST_FLOW_OK;
1041 dlbuf->sinkresult = GST_FLOW_OK;
1042 dlbuf->unexpected = FALSE;
1043 dlbuf->seeking = FALSE;
1044 /* reset rate counters */
1045 reset_rate_timer (dlbuf);
1046 gst_pad_start_task (dlbuf->srcpad,
1047 (GstTaskFunction) gst_download_buffer_loop, dlbuf->srcpad, NULL);
1048 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1050 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1051 dlbuf->unexpected = FALSE;
1052 dlbuf->sinkresult = GST_FLOW_OK;
1053 dlbuf->seeking = FALSE;
1054 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1056 gst_event_unref (event);
1061 if (GST_EVENT_IS_SERIALIZED (event)) {
1062 GstMessage *msg = NULL;
1064 /* serialized events go in the buffer */
1065 GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK (dlbuf, dlbuf->sinkresult,
1067 switch (GST_EVENT_TYPE (event)) {
1069 GST_DEBUG_OBJECT (dlbuf, "we have EOS");
1070 /* Zero the thresholds, this makes sure the dlbuf is completely
1071 * filled and we can read all data from the dlbuf. */
1072 /* update the buffering status */
1073 update_levels (dlbuf, dlbuf->max_level.bytes);
1074 /* update the buffering */
1075 msg = update_buffering (dlbuf);
1076 /* wakeup the waiter and let it recheck */
1077 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, -1);
1079 case GST_EVENT_SEGMENT:
1080 gst_event_replace (&dlbuf->segment_event, event);
1081 /* a new segment allows us to accept more buffers if we got EOS
1082 * from downstream */
1083 dlbuf->unexpected = FALSE;
1085 case GST_EVENT_STREAM_START:
1086 gst_event_replace (&dlbuf->stream_start_event, event);
1091 gst_event_unref (event);
1092 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1094 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1096 /* non-serialized events are passed upstream. */
1097 ret = gst_pad_push_event (dlbuf->srcpad, event);
1106 GST_DEBUG_OBJECT (dlbuf, "refusing event, we are flushing");
1107 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1108 gst_event_unref (event);
1114 gst_download_buffer_handle_sink_query (GstPad * pad, GstObject * parent,
1117 GstDownloadBuffer *dlbuf;
1120 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1122 switch (GST_QUERY_TYPE (query)) {
1124 if (GST_QUERY_IS_SERIALIZED (query)) {
1125 GST_DEBUG_OBJECT (dlbuf, "refusing serialized query %p", query);
1128 res = gst_pad_query_default (pad, parent, query);
1135 static GstFlowReturn
1136 gst_download_buffer_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
1138 GstDownloadBuffer *dlbuf;
1141 gsize res, available;
1142 GError *error = NULL;
1143 GstMessage *msg = NULL;
1145 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1147 GST_LOG_OBJECT (dlbuf, "received buffer %p of "
1148 "size %" G_GSIZE_FORMAT ", time %" GST_TIME_FORMAT ", duration %"
1149 GST_TIME_FORMAT, buffer, gst_buffer_get_size (buffer),
1150 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
1151 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
1153 /* we have to lock the dlbuf since we span threads */
1154 GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK (dlbuf, dlbuf->sinkresult, out_flushing);
1155 /* when we received unexpected from downstream, refuse more buffers */
1156 if (dlbuf->unexpected)
1159 /* while we didn't receive the newsegment, we're seeking and we skip data */
1163 /* put buffer in dlbuf now */
1164 offset = dlbuf->write_pos;
1167 if (GST_BUFFER_OFFSET_IS_VALID (buffer) &&
1168 GST_BUFFER_OFFSET (buffer) != offset) {
1169 GST_WARNING_OBJECT (dlbuf, "buffer offset does not match current writing "
1170 "position! %" G_GINT64_FORMAT " != %" G_GINT64_FORMAT,
1171 GST_BUFFER_OFFSET (buffer), offset);
1174 if (!gst_buffer_map (buffer, &info, GST_MAP_READ))
1177 GST_DEBUG_OBJECT (dlbuf, "Writing %" G_GSIZE_FORMAT " bytes to %"
1178 G_GUINT64_FORMAT, info.size, offset);
1181 gst_sparse_file_write (dlbuf->file, offset, info.data, info.size,
1182 &available, &error);
1186 gst_buffer_unmap (buffer, &info);
1187 gst_buffer_unref (buffer);
1189 dlbuf->write_pos = offset + info.size;
1190 dlbuf->bytes_in += info.size;
1192 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, dlbuf->write_pos + available);
1194 /* we hit the end, see what to do */
1195 if (dlbuf->write_pos + available == dlbuf->upstream_size) {
1198 /* we have everything up to the end, find a region to fill */
1199 if (gst_sparse_file_get_range_after (dlbuf->file, 0, &start, &stop)) {
1200 if (stop < dlbuf->upstream_size) {
1201 /* a hole to fill, seek to its end */
1202 perform_seek_to_offset (dlbuf, stop);
1204 /* we filled all the holes, we are done */
1209 /* see if we need to skip this region or just read it again. The idea
1210 * is that when the region is not big, we want to avoid a seek and just
1212 guint64 threshold = get_seek_threshold (dlbuf);
1214 if (available > threshold) {
1215 /* further than threshold, it's better to skip than to reread */
1216 perform_seek_to_offset (dlbuf, dlbuf->write_pos + available);
1219 if (dlbuf->filling) {
1220 if (dlbuf->write_pos > dlbuf->read_pos)
1221 update_levels (dlbuf, dlbuf->write_pos - dlbuf->read_pos);
1223 update_levels (dlbuf, 0);
1226 /* update the buffering */
1227 msg = update_buffering (dlbuf);
1229 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1232 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1239 GstFlowReturn ret = dlbuf->sinkresult;
1240 GST_LOG_OBJECT (dlbuf,
1241 "exit because task paused, reason: %s", gst_flow_get_name (ret));
1242 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1243 gst_buffer_unref (buffer);
1248 GST_LOG_OBJECT (dlbuf, "exit because we received EOS");
1249 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1250 gst_buffer_unref (buffer);
1251 return GST_FLOW_EOS;
1255 GST_LOG_OBJECT (dlbuf, "exit because we are seeking");
1256 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1257 gst_buffer_unref (buffer);
1262 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1263 gst_buffer_unref (buffer);
1264 GST_ELEMENT_ERROR (dlbuf, RESOURCE, BUSY,
1265 (_("Failed to map buffer.")), ("failed to map buffer in READ mode"));
1266 return GST_FLOW_ERROR;
1270 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1271 gst_buffer_unmap (buffer, &info);
1272 gst_buffer_unref (buffer);
1273 GST_ELEMENT_ERROR (dlbuf, RESOURCE, WRITE,
1274 (_("Error while writing to download file.")), ("%s", error->message));
1275 g_clear_error (&error);
1276 return GST_FLOW_ERROR;
1280 GST_LOG_OBJECT (dlbuf, "we completed the download");
1281 dlbuf->write_pos = dlbuf->upstream_size;
1282 dlbuf->filling = FALSE;
1283 update_levels (dlbuf, dlbuf->max_level.bytes);
1284 msg = update_buffering (dlbuf);
1286 gst_element_post_message (GST_ELEMENT_CAST (dlbuf),
1287 gst_message_new_element (GST_OBJECT_CAST (dlbuf),
1288 gst_structure_new ("GstCacheDownloadComplete",
1289 "location", G_TYPE_STRING, dlbuf->temp_location, NULL)));
1291 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1294 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1296 return GST_FLOW_EOS;
1300 /* called repeatedly with @pad as the source pad. This function should push out
1301 * data to the peer element. */
1303 gst_download_buffer_loop (GstPad * pad)
1305 GstDownloadBuffer *dlbuf;
1307 GstBuffer *buffer = NULL;
1308 GstMessage *msg = NULL;
1310 dlbuf = GST_DOWNLOAD_BUFFER (GST_PAD_PARENT (pad));
1312 /* have to lock for thread-safety */
1313 GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK (dlbuf, dlbuf->srcresult, out_flushing);
1315 if (dlbuf->stream_start_event != NULL) {
1316 gst_pad_push_event (dlbuf->srcpad, dlbuf->stream_start_event);
1317 dlbuf->stream_start_event = NULL;
1319 if (dlbuf->segment_event != NULL) {
1320 gst_pad_push_event (dlbuf->srcpad, dlbuf->segment_event);
1321 dlbuf->segment_event = NULL;
1324 ret = gst_download_buffer_read_buffer (dlbuf, -1, -1, &buffer);
1325 if (ret != GST_FLOW_OK)
1328 /* update the buffering */
1329 msg = update_buffering (dlbuf);
1331 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1334 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1336 ret = gst_pad_push (dlbuf->srcpad, buffer);
1338 /* need to check for srcresult here as well */
1339 GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK (dlbuf, dlbuf->srcresult, out_flushing);
1340 dlbuf->srcresult = ret;
1341 dlbuf->sinkresult = ret;
1342 if (ret != GST_FLOW_OK)
1344 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1351 GstFlowReturn ret = dlbuf->srcresult;
1353 gst_pad_pause_task (dlbuf->srcpad);
1354 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1355 GST_LOG_OBJECT (dlbuf, "pause task, reason: %s", gst_flow_get_name (ret));
1356 /* let app know about us giving up if upstream is not expected to do so */
1357 if (ret == GST_FLOW_EOS) {
1358 /* FIXME perform EOS logic, this is really a basesrc operating on a
1360 gst_pad_push_event (dlbuf->srcpad, gst_event_new_eos ());
1361 } else if ((ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS)) {
1362 GST_ELEMENT_FLOW_ERROR (dlbuf, ret);
1363 gst_pad_push_event (dlbuf->srcpad, gst_event_new_eos ());
1370 gst_download_buffer_handle_src_event (GstPad * pad, GstObject * parent,
1373 gboolean res = TRUE;
1374 GstDownloadBuffer *dlbuf = GST_DOWNLOAD_BUFFER (parent);
1376 #ifndef GST_DISABLE_GST_DEBUG
1377 GST_DEBUG_OBJECT (dlbuf, "got event %p (%s)",
1378 event, GST_EVENT_TYPE_NAME (event));
1381 switch (GST_EVENT_TYPE (event)) {
1382 case GST_EVENT_FLUSH_START:
1383 /* now unblock the getrange function */
1384 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1385 GST_DEBUG_OBJECT (dlbuf, "flushing");
1386 dlbuf->srcresult = GST_FLOW_FLUSHING;
1387 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, -1);
1388 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1390 /* when using a temp file, we eat the event */
1392 gst_event_unref (event);
1394 case GST_EVENT_FLUSH_STOP:
1395 /* now unblock the getrange function */
1396 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1397 dlbuf->srcresult = GST_FLOW_OK;
1398 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1400 /* when using a temp file, we eat the event */
1402 gst_event_unref (event);
1404 case GST_EVENT_RECONFIGURE:
1405 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1406 /* assume downstream is linked now and try to push again */
1407 if (dlbuf->srcresult == GST_FLOW_NOT_LINKED) {
1408 dlbuf->srcresult = GST_FLOW_OK;
1409 dlbuf->sinkresult = GST_FLOW_OK;
1410 if (GST_PAD_MODE (pad) == GST_PAD_MODE_PUSH) {
1411 gst_pad_start_task (pad, (GstTaskFunction) gst_download_buffer_loop,
1415 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1417 res = gst_pad_push_event (dlbuf->sinkpad, event);
1420 res = gst_pad_push_event (dlbuf->sinkpad, event);
1428 gst_download_buffer_handle_src_query (GstPad * pad, GstObject * parent,
1431 GstDownloadBuffer *dlbuf;
1433 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1435 switch (GST_QUERY_TYPE (query)) {
1436 case GST_QUERY_POSITION:
1441 if (!gst_pad_peer_query (dlbuf->sinkpad, query))
1444 /* get peer position */
1445 gst_query_parse_position (query, &format, &peer_pos);
1447 /* FIXME: this code assumes that there's no discont in the dlbuf */
1449 case GST_FORMAT_BYTES:
1450 peer_pos -= dlbuf->cur_level.bytes;
1451 if (peer_pos < 0) /* Clamp result to 0 */
1454 case GST_FORMAT_TIME:
1455 peer_pos -= dlbuf->cur_level.time;
1456 if (peer_pos < 0) /* Clamp result to 0 */
1460 GST_WARNING_OBJECT (dlbuf, "dropping query in %s format, don't "
1461 "know how to adjust value", gst_format_get_name (format));
1464 /* set updated position */
1465 gst_query_set_position (query, format, peer_pos);
1468 case GST_QUERY_DURATION:
1470 GST_DEBUG_OBJECT (dlbuf, "doing peer query");
1472 if (!gst_pad_peer_query (dlbuf->sinkpad, query))
1475 GST_DEBUG_OBJECT (dlbuf, "peer query success");
1478 case GST_QUERY_BUFFERING:
1481 gboolean is_buffering;
1482 GstBufferingMode mode;
1483 gint avg_in, avg_out;
1484 gint64 buffering_left;
1486 GST_DEBUG_OBJECT (dlbuf, "query buffering");
1488 get_buffering_percent (dlbuf, &is_buffering, &percent);
1489 gst_query_set_buffering_percent (query, is_buffering, percent);
1491 get_buffering_stats (dlbuf, percent, &mode, &avg_in, &avg_out,
1493 gst_query_set_buffering_stats (query, mode, avg_in, avg_out,
1497 /* add ranges for download and ringbuffer buffering */
1501 gint64 estimated_total;
1503 gsize offset, range_start, range_stop;
1505 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1506 write_pos = dlbuf->write_pos;
1508 /* get duration of upstream in bytes */
1509 gst_download_buffer_update_upstream_size (dlbuf);
1510 duration = dlbuf->upstream_size;
1512 GST_DEBUG_OBJECT (dlbuf, "percent %d, duration %" G_GINT64_FORMAT
1513 ", writing %" G_GINT64_FORMAT, percent, duration, write_pos);
1515 gst_query_parse_buffering_range (query, &format, NULL, NULL, NULL);
1517 /* fill out the buffered ranges */
1520 estimated_total = -1;
1521 while (gst_sparse_file_get_range_after (dlbuf->file, offset,
1522 &range_start, &range_stop)) {
1523 gboolean current_range;
1525 GST_DEBUG_OBJECT (dlbuf,
1526 "range starting at %" G_GSIZE_FORMAT " and finishing at %"
1527 G_GSIZE_FORMAT, range_start, range_stop);
1529 offset = range_stop;
1531 /* find the range we are currently downloading, we'll remember it
1532 * after we convert to the target format */
1533 if (range_start <= write_pos && range_stop >= write_pos) {
1534 current_range = TRUE;
1535 /* calculate remaining and total download time */
1536 if (duration >= range_stop && avg_in > 0.0)
1537 estimated_total = ((duration - range_stop) * 1000) / avg_in;
1539 current_range = FALSE;
1542 case GST_FORMAT_PERCENT:
1543 /* get our available data relative to the duration */
1544 if (duration == -1) {
1548 range_start = gst_util_uint64_scale (GST_FORMAT_PERCENT_MAX,
1549 range_start, duration);
1550 range_stop = gst_util_uint64_scale (GST_FORMAT_PERCENT_MAX,
1551 range_stop, duration);
1554 case GST_FORMAT_BYTES:
1562 if (current_range) {
1563 /* we are currently downloading this range */
1564 start = range_start;
1567 GST_DEBUG_OBJECT (dlbuf,
1568 "range to format: %" G_GSIZE_FORMAT " - %" G_GSIZE_FORMAT,
1569 range_start, range_stop);
1570 if (range_start == range_stop)
1572 gst_query_add_buffering_range (query, range_start, range_stop);
1575 GST_DEBUG_OBJECT (dlbuf, "estimated-total %" G_GINT64_FORMAT,
1578 gst_query_set_buffering_range (query, format, start, stop,
1581 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1585 case GST_QUERY_SCHEDULING:
1587 GstSchedulingFlags flags = 0;
1589 if (!gst_pad_peer_query (dlbuf->sinkpad, query))
1592 gst_query_parse_scheduling (query, &flags, NULL, NULL, NULL);
1594 /* we can operate in pull mode when we are using a tempfile */
1595 flags |= GST_SCHEDULING_FLAG_SEEKABLE;
1596 gst_query_set_scheduling (query, flags, 0, -1, 0);
1597 gst_query_add_scheduling_mode (query, GST_PAD_MODE_PULL);
1598 gst_query_add_scheduling_mode (query, GST_PAD_MODE_PUSH);
1602 /* peer handled other queries */
1603 if (!gst_pad_query_default (pad, parent, query))
1613 GST_DEBUG_OBJECT (dlbuf, "failed peer query");
1619 gst_download_buffer_handle_query (GstElement * element, GstQuery * query)
1621 GstDownloadBuffer *dlbuf = GST_DOWNLOAD_BUFFER (element);
1623 /* simply forward to the srcpad query function */
1624 return gst_download_buffer_handle_src_query (dlbuf->srcpad,
1625 GST_OBJECT_CAST (element), query);
1628 static GstFlowReturn
1629 gst_download_buffer_get_range (GstPad * pad, GstObject * parent, guint64 offset,
1630 guint length, GstBuffer ** buffer)
1632 GstDownloadBuffer *dlbuf;
1634 GstMessage *msg = NULL;
1636 dlbuf = GST_DOWNLOAD_BUFFER_CAST (parent);
1638 GST_DOWNLOAD_BUFFER_MUTEX_LOCK_CHECK (dlbuf, dlbuf->srcresult, out_flushing);
1639 /* FIXME - function will block when the range is not yet available */
1640 ret = gst_download_buffer_read_buffer (dlbuf, offset, length, buffer);
1641 /* update the buffering */
1642 msg = update_buffering (dlbuf);
1644 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1647 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1654 ret = dlbuf->srcresult;
1656 GST_DEBUG_OBJECT (dlbuf, "we are flushing");
1657 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1662 /* sink currently only operates in push mode */
1664 gst_download_buffer_sink_activate_mode (GstPad * pad, GstObject * parent,
1665 GstPadMode mode, gboolean active)
1668 GstDownloadBuffer *dlbuf;
1670 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1673 case GST_PAD_MODE_PUSH:
1675 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1676 GST_DEBUG_OBJECT (dlbuf, "activating push mode");
1677 dlbuf->srcresult = GST_FLOW_OK;
1678 dlbuf->sinkresult = GST_FLOW_OK;
1679 dlbuf->unexpected = FALSE;
1680 reset_rate_timer (dlbuf);
1681 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1683 /* unblock chain function */
1684 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1685 GST_DEBUG_OBJECT (dlbuf, "deactivating push mode");
1686 dlbuf->srcresult = GST_FLOW_FLUSHING;
1687 dlbuf->sinkresult = GST_FLOW_FLUSHING;
1688 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1690 /* wait until it is unblocked and clean up */
1691 GST_PAD_STREAM_LOCK (pad);
1692 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1693 gst_download_buffer_locked_flush (dlbuf, TRUE, FALSE);
1694 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1695 GST_PAD_STREAM_UNLOCK (pad);
1706 /* src operating in push mode, we start a task on the source pad that pushes out
1707 * buffers from the dlbuf */
1709 gst_download_buffer_src_activate_push (GstPad * pad, GstObject * parent,
1712 gboolean result = FALSE;
1713 GstDownloadBuffer *dlbuf;
1715 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1718 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1719 GST_DEBUG_OBJECT (dlbuf, "activating push mode");
1720 dlbuf->srcresult = GST_FLOW_OK;
1721 dlbuf->sinkresult = GST_FLOW_OK;
1722 dlbuf->unexpected = FALSE;
1724 gst_pad_start_task (pad, (GstTaskFunction) gst_download_buffer_loop,
1726 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1728 /* unblock loop function */
1729 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1730 GST_DEBUG_OBJECT (dlbuf, "deactivating push mode");
1731 dlbuf->srcresult = GST_FLOW_FLUSHING;
1732 dlbuf->sinkresult = GST_FLOW_FLUSHING;
1733 /* the item add signal will unblock */
1734 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, -1);
1735 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1737 /* step 2, make sure streaming finishes */
1738 result = gst_pad_stop_task (pad);
1744 /* pull mode, downstream will call our getrange function */
1746 gst_download_buffer_src_activate_pull (GstPad * pad, GstObject * parent,
1750 GstDownloadBuffer *dlbuf;
1752 dlbuf = GST_DOWNLOAD_BUFFER (parent);
1755 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1756 /* open the temp file now */
1757 result = gst_download_buffer_open_temp_location_file (dlbuf);
1758 GST_DEBUG_OBJECT (dlbuf, "activating pull mode");
1759 dlbuf->srcresult = GST_FLOW_OK;
1760 dlbuf->sinkresult = GST_FLOW_OK;
1761 dlbuf->unexpected = FALSE;
1762 dlbuf->upstream_size = 0;
1763 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1765 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1766 GST_DEBUG_OBJECT (dlbuf, "deactivating pull mode");
1767 dlbuf->srcresult = GST_FLOW_FLUSHING;
1768 dlbuf->sinkresult = GST_FLOW_FLUSHING;
1769 /* this will unlock getrange */
1770 GST_DOWNLOAD_BUFFER_SIGNAL_ADD (dlbuf, -1);
1772 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1779 gst_download_buffer_src_activate_mode (GstPad * pad, GstObject * parent,
1780 GstPadMode mode, gboolean active)
1785 case GST_PAD_MODE_PULL:
1786 res = gst_download_buffer_src_activate_pull (pad, parent, active);
1788 case GST_PAD_MODE_PUSH:
1789 res = gst_download_buffer_src_activate_push (pad, parent, active);
1792 GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
1799 static GstStateChangeReturn
1800 gst_download_buffer_change_state (GstElement * element,
1801 GstStateChange transition)
1803 GstDownloadBuffer *dlbuf;
1804 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1806 dlbuf = GST_DOWNLOAD_BUFFER (element);
1808 switch (transition) {
1809 case GST_STATE_CHANGE_NULL_TO_READY:
1811 case GST_STATE_CHANGE_READY_TO_PAUSED:
1812 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1813 if (!gst_download_buffer_open_temp_location_file (dlbuf))
1814 ret = GST_STATE_CHANGE_FAILURE;
1815 gst_event_replace (&dlbuf->stream_start_event, NULL);
1816 gst_event_replace (&dlbuf->segment_event, NULL);
1817 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1819 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1825 if (ret == GST_STATE_CHANGE_FAILURE)
1828 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1830 if (ret == GST_STATE_CHANGE_FAILURE)
1833 switch (transition) {
1834 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1836 case GST_STATE_CHANGE_PAUSED_TO_READY:
1837 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1838 gst_download_buffer_close_temp_location_file (dlbuf);
1839 gst_event_replace (&dlbuf->stream_start_event, NULL);
1840 gst_event_replace (&dlbuf->segment_event, NULL);
1841 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1843 case GST_STATE_CHANGE_READY_TO_NULL:
1852 #define CAPACITY_CHANGE(elem) \
1853 update_buffering (elem);
1856 gst_download_buffer_set_temp_template (GstDownloadBuffer * dlbuf,
1857 const gchar * template)
1861 /* the element must be stopped in order to do this */
1862 GST_OBJECT_LOCK (dlbuf);
1863 state = GST_STATE (dlbuf);
1864 if (state != GST_STATE_READY && state != GST_STATE_NULL)
1866 GST_OBJECT_UNLOCK (dlbuf);
1868 /* set new location */
1869 g_free (dlbuf->temp_template);
1870 dlbuf->temp_template = g_strdup (template);
1877 GST_WARNING_OBJECT (dlbuf, "setting temp-template property in wrong state");
1878 GST_OBJECT_UNLOCK (dlbuf);
1883 gst_download_buffer_set_property (GObject * object,
1884 guint prop_id, const GValue * value, GParamSpec * pspec)
1886 GstDownloadBuffer *dlbuf = GST_DOWNLOAD_BUFFER (object);
1887 GstMessage *msg = NULL;
1889 /* someone could change levels here, and since this
1890 * affects the get/put funcs, we need to lock for safety. */
1891 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1894 case PROP_MAX_SIZE_BYTES:
1895 dlbuf->max_level.bytes = g_value_get_uint (value);
1896 msg = CAPACITY_CHANGE (dlbuf);
1898 case PROP_MAX_SIZE_TIME:
1899 dlbuf->max_level.time = g_value_get_uint64 (value);
1900 msg = CAPACITY_CHANGE (dlbuf);
1902 case PROP_LOW_PERCENT:
1903 dlbuf->low_percent = g_value_get_int (value);
1905 case PROP_HIGH_PERCENT:
1906 dlbuf->high_percent = g_value_get_int (value);
1908 case PROP_TEMP_TEMPLATE:
1909 gst_download_buffer_set_temp_template (dlbuf, g_value_get_string (value));
1911 case PROP_TEMP_REMOVE:
1912 dlbuf->temp_remove = g_value_get_boolean (value);
1915 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1919 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);
1922 gst_element_post_message (GST_ELEMENT_CAST (dlbuf), msg);
1927 gst_download_buffer_get_property (GObject * object,
1928 guint prop_id, GValue * value, GParamSpec * pspec)
1930 GstDownloadBuffer *dlbuf = GST_DOWNLOAD_BUFFER (object);
1932 GST_DOWNLOAD_BUFFER_MUTEX_LOCK (dlbuf);
1935 case PROP_MAX_SIZE_BYTES:
1936 g_value_set_uint (value, dlbuf->max_level.bytes);
1938 case PROP_MAX_SIZE_TIME:
1939 g_value_set_uint64 (value, dlbuf->max_level.time);
1941 case PROP_LOW_PERCENT:
1942 g_value_set_int (value, dlbuf->low_percent);
1944 case PROP_HIGH_PERCENT:
1945 g_value_set_int (value, dlbuf->high_percent);
1947 case PROP_TEMP_TEMPLATE:
1948 g_value_set_string (value, dlbuf->temp_template);
1950 case PROP_TEMP_LOCATION:
1951 g_value_set_string (value, dlbuf->temp_location);
1953 case PROP_TEMP_REMOVE:
1954 g_value_set_boolean (value, dlbuf->temp_remove);
1957 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1961 GST_DOWNLOAD_BUFFER_MUTEX_UNLOCK (dlbuf);