2 * Copyright (C) 2010 Marc-Andre Lureau <marcandre.lureau@gmail.com>
3 * Copyright (C) 2010 Andoni Morales Alastruey <ylatuya@gmail.com>
4 * Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
5 * Author: Youness Alaoui <youness.alaoui@collabora.co.uk>, Collabora Ltd.
6 * Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>, Collabora Ltd.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
26 * SECTION:element-hlsdemux
28 * HTTP Live Streaming demuxer element.
31 * <title>Example launch line</title>
33 * gst-launch souphttpsrc location=http://devimages.apple.com/iphone/samples/bipbop/gear4/prog_index.m3u8 ! hlsdemux ! decodebin2 ! videoconvert ! videoscale ! autovideosink
37 * Last reviewed on 2010-10-07
44 /* FIXME 0.11: suppress warnings for deprecated API such as GStaticRecMutex
45 * with newer GLib versions (>= 2.31.0) */
46 #define GLIB_DISABLE_DEPRECATION_WARNINGS
49 #include <gst/glib-compat-private.h>
51 #include "gsthlsdemux.h"
53 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src_%u",
58 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
61 GST_STATIC_CAPS ("application/x-hls"));
63 GST_DEBUG_CATEGORY_STATIC (gst_hls_demux_debug);
64 #define GST_CAT_DEFAULT gst_hls_demux_debug
72 PROP_CONNECTION_SPEED,
76 static const float update_interval_factor[] = { 1, 0.5, 1.5, 3 };
78 #define DEFAULT_FRAGMENTS_CACHE 3
79 #define DEFAULT_FAILED_COUNT 3
80 #define DEFAULT_BITRATE_LIMIT 0.8
81 #define DEFAULT_CONNECTION_SPEED 0
84 static void gst_hls_demux_set_property (GObject * object, guint prop_id,
85 const GValue * value, GParamSpec * pspec);
86 static void gst_hls_demux_get_property (GObject * object, guint prop_id,
87 GValue * value, GParamSpec * pspec);
88 static void gst_hls_demux_dispose (GObject * obj);
91 static GstStateChangeReturn
92 gst_hls_demux_change_state (GstElement * element, GstStateChange transition);
95 static GstFlowReturn gst_hls_demux_chain (GstPad * pad, GstObject * parent,
97 static gboolean gst_hls_demux_sink_event (GstPad * pad, GstObject * parent,
99 static gboolean gst_hls_demux_src_event (GstPad * pad, GstObject * parent,
101 static gboolean gst_hls_demux_src_query (GstPad * pad, GstObject * parent,
103 static void gst_hls_demux_stream_loop (GstHLSDemux * demux);
104 static void gst_hls_demux_updates_loop (GstHLSDemux * demux);
105 static void gst_hls_demux_stop (GstHLSDemux * demux);
106 static void gst_hls_demux_pause_tasks (GstHLSDemux * demux, gboolean caching);
107 static gboolean gst_hls_demux_cache_fragments (GstHLSDemux * demux);
108 static gboolean gst_hls_demux_schedule (GstHLSDemux * demux);
109 static gboolean gst_hls_demux_switch_playlist (GstHLSDemux * demux);
110 static gboolean gst_hls_demux_get_next_fragment (GstHLSDemux * demux,
112 static gboolean gst_hls_demux_update_playlist (GstHLSDemux * demux,
114 static void gst_hls_demux_reset (GstHLSDemux * demux, gboolean dispose);
115 static gboolean gst_hls_demux_set_location (GstHLSDemux * demux,
117 static gchar *gst_hls_src_buf_to_utf8_playlist (GstBuffer * buf);
119 #define gst_hls_demux_parent_class parent_class
120 G_DEFINE_TYPE (GstHLSDemux, gst_hls_demux, GST_TYPE_ELEMENT);
123 gst_hls_demux_dispose (GObject * obj)
125 GstHLSDemux *demux = GST_HLS_DEMUX (obj);
127 if (demux->stream_task) {
128 if (GST_TASK_STATE (demux->stream_task) != GST_TASK_STOPPED) {
129 GST_DEBUG_OBJECT (demux, "Leaving streaming task");
130 gst_task_stop (demux->stream_task);
131 g_rec_mutex_lock (&demux->stream_lock);
132 g_rec_mutex_unlock (&demux->stream_lock);
133 gst_task_join (demux->stream_task);
135 gst_object_unref (demux->stream_task);
136 g_rec_mutex_clear (&demux->stream_lock);
137 demux->stream_task = NULL;
140 if (demux->updates_task) {
141 if (GST_TASK_STATE (demux->updates_task) != GST_TASK_STOPPED) {
142 GST_DEBUG_OBJECT (demux, "Leaving updates task");
143 demux->cancelled = TRUE;
144 gst_uri_downloader_cancel (demux->downloader);
145 gst_task_stop (demux->updates_task);
146 g_mutex_lock (&demux->updates_timed_lock);
147 GST_TASK_SIGNAL (demux->updates_task);
148 g_rec_mutex_lock (&demux->updates_lock);
149 g_rec_mutex_unlock (&demux->updates_lock);
150 g_mutex_unlock (&demux->updates_timed_lock);
151 gst_task_join (demux->updates_task);
153 gst_object_unref (demux->updates_task);
154 g_mutex_clear (&demux->updates_timed_lock);
155 g_rec_mutex_clear (&demux->updates_lock);
156 demux->updates_task = NULL;
159 if (demux->downloader != NULL) {
160 g_object_unref (demux->downloader);
161 demux->downloader = NULL;
164 gst_hls_demux_reset (demux, TRUE);
166 g_queue_free (demux->queue);
168 G_OBJECT_CLASS (parent_class)->dispose (obj);
172 gst_hls_demux_class_init (GstHLSDemuxClass * klass)
174 GObjectClass *gobject_class;
175 GstElementClass *element_class;
177 gobject_class = (GObjectClass *) klass;
178 element_class = (GstElementClass *) klass;
180 gobject_class->set_property = gst_hls_demux_set_property;
181 gobject_class->get_property = gst_hls_demux_get_property;
182 gobject_class->dispose = gst_hls_demux_dispose;
184 g_object_class_install_property (gobject_class, PROP_FRAGMENTS_CACHE,
185 g_param_spec_uint ("fragments-cache", "Fragments cache",
186 "Number of fragments needed to be cached to start playing",
187 2, G_MAXUINT, DEFAULT_FRAGMENTS_CACHE,
188 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
190 g_object_class_install_property (gobject_class, PROP_BITRATE_LIMIT,
191 g_param_spec_float ("bitrate-limit",
192 "Bitrate limit in %",
193 "Limit of the available bitrate to use when switching to alternates.",
194 0, 1, DEFAULT_BITRATE_LIMIT,
195 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
197 g_object_class_install_property (gobject_class, PROP_CONNECTION_SPEED,
198 g_param_spec_uint ("connection-speed", "Connection Speed",
199 "Network connection speed in kbps (0 = unknown)",
200 0, G_MAXUINT / 1000, DEFAULT_CONNECTION_SPEED,
201 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
203 element_class->change_state = GST_DEBUG_FUNCPTR (gst_hls_demux_change_state);
205 gst_element_class_add_pad_template (element_class,
206 gst_static_pad_template_get (&srctemplate));
208 gst_element_class_add_pad_template (element_class,
209 gst_static_pad_template_get (&sinktemplate));
211 gst_element_class_set_static_metadata (element_class,
214 "HTTP Live Streaming demuxer",
215 "Marc-Andre Lureau <marcandre.lureau@gmail.com>\n"
216 "Andoni Morales Alastruey <ylatuya@gmail.com>");
218 GST_DEBUG_CATEGORY_INIT (gst_hls_demux_debug, "hlsdemux", 0,
223 gst_hls_demux_init (GstHLSDemux * demux)
226 demux->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
227 gst_pad_set_chain_function (demux->sinkpad,
228 GST_DEBUG_FUNCPTR (gst_hls_demux_chain));
229 gst_pad_set_event_function (demux->sinkpad,
230 GST_DEBUG_FUNCPTR (gst_hls_demux_sink_event));
231 gst_element_add_pad (GST_ELEMENT (demux), demux->sinkpad);
234 demux->downloader = gst_uri_downloader_new ();
236 demux->do_typefind = TRUE;
239 demux->fragments_cache = DEFAULT_FRAGMENTS_CACHE;
240 demux->bitrate_limit = DEFAULT_BITRATE_LIMIT;
241 demux->connection_speed = DEFAULT_CONNECTION_SPEED;
243 demux->queue = g_queue_new ();
246 g_rec_mutex_init (&demux->updates_lock);
247 demux->updates_task =
248 gst_task_new ((GstTaskFunction) gst_hls_demux_updates_loop, demux, NULL);
249 gst_task_set_lock (demux->updates_task, &demux->updates_lock);
250 g_mutex_init (&demux->updates_timed_lock);
253 g_rec_mutex_init (&demux->stream_lock);
255 gst_task_new ((GstTaskFunction) gst_hls_demux_stream_loop, demux, NULL);
256 gst_task_set_lock (demux->stream_task, &demux->stream_lock);
258 demux->have_group_id = FALSE;
259 demux->group_id = G_MAXUINT;
263 gst_hls_demux_set_property (GObject * object, guint prop_id,
264 const GValue * value, GParamSpec * pspec)
266 GstHLSDemux *demux = GST_HLS_DEMUX (object);
269 case PROP_FRAGMENTS_CACHE:
270 demux->fragments_cache = g_value_get_uint (value);
272 case PROP_BITRATE_LIMIT:
273 demux->bitrate_limit = g_value_get_float (value);
275 case PROP_CONNECTION_SPEED:
276 demux->connection_speed = g_value_get_uint (value) * 1000;
279 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
285 gst_hls_demux_get_property (GObject * object, guint prop_id, GValue * value,
288 GstHLSDemux *demux = GST_HLS_DEMUX (object);
291 case PROP_FRAGMENTS_CACHE:
292 g_value_set_uint (value, demux->fragments_cache);
294 case PROP_BITRATE_LIMIT:
295 g_value_set_float (value, demux->bitrate_limit);
297 case PROP_CONNECTION_SPEED:
298 g_value_set_uint (value, demux->connection_speed / 1000);
301 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
306 static GstStateChangeReturn
307 gst_hls_demux_change_state (GstElement * element, GstStateChange transition)
309 GstStateChangeReturn ret;
310 GstHLSDemux *demux = GST_HLS_DEMUX (element);
312 switch (transition) {
313 case GST_STATE_CHANGE_READY_TO_PAUSED:
314 gst_hls_demux_reset (demux, FALSE);
315 gst_uri_downloader_reset (demux->downloader);
321 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
323 switch (transition) {
324 case GST_STATE_CHANGE_PAUSED_TO_READY:
325 demux->cancelled = TRUE;
326 gst_hls_demux_stop (demux);
327 gst_task_join (demux->stream_task);
328 gst_hls_demux_reset (demux, FALSE);
337 gst_hls_demux_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
341 demux = GST_HLS_DEMUX (parent);
343 switch (event->type) {
349 GstSeekType start_type, stop_type;
352 GstClockTime position, current_pos, target_pos;
353 gint current_sequence;
354 GstM3U8MediaFile *file;
356 GST_INFO_OBJECT (demux, "Received GST_EVENT_SEEK");
358 if (gst_m3u8_client_is_live (demux->client)) {
359 GST_WARNING_OBJECT (demux, "Received seek event for live stream");
363 gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
366 if (format != GST_FORMAT_TIME)
369 GST_DEBUG_OBJECT (demux, "seek event, rate: %f start: %" GST_TIME_FORMAT
370 " stop: %" GST_TIME_FORMAT, rate, GST_TIME_ARGS (start),
371 GST_TIME_ARGS (stop));
373 GST_M3U8_CLIENT_LOCK (demux->client);
374 file = GST_M3U8_MEDIA_FILE (demux->client->current->files->data);
375 current_sequence = file->sequence;
377 target_pos = (GstClockTime) start;
378 for (walk = demux->client->current->files; walk; walk = walk->next) {
381 current_sequence = file->sequence;
382 if (current_pos <= target_pos
383 && target_pos < current_pos + file->duration) {
386 current_pos += file->duration;
388 GST_M3U8_CLIENT_UNLOCK (demux->client);
391 GST_WARNING_OBJECT (demux, "Could not find seeked fragment");
395 if (flags & GST_SEEK_FLAG_FLUSH) {
396 GST_DEBUG_OBJECT (demux, "sending flush start");
397 gst_pad_push_event (demux->srcpad, gst_event_new_flush_start ());
400 demux->cancelled = TRUE;
401 gst_task_pause (demux->stream_task);
402 gst_uri_downloader_cancel (demux->downloader);
403 gst_task_stop (demux->updates_task);
404 g_mutex_lock (&demux->updates_timed_lock);
405 GST_TASK_SIGNAL (demux->updates_task);
406 g_mutex_unlock (&demux->updates_timed_lock);
407 g_rec_mutex_lock (&demux->updates_lock);
408 g_rec_mutex_unlock (&demux->updates_lock);
409 gst_task_pause (demux->stream_task);
411 /* wait for streaming to finish */
412 g_rec_mutex_lock (&demux->stream_lock);
414 demux->need_cache = TRUE;
415 while (!g_queue_is_empty (demux->queue)) {
416 GstFragment *fragment = g_queue_pop_head (demux->queue);
417 g_object_unref (fragment);
419 g_queue_clear (demux->queue);
421 GST_M3U8_CLIENT_LOCK (demux->client);
422 GST_DEBUG_OBJECT (demux, "seeking to sequence %d", current_sequence);
423 demux->client->sequence = current_sequence;
424 gst_m3u8_client_get_current_position (demux->client, &position);
425 demux->position_shift = start - position;
426 demux->need_segment = TRUE;
427 GST_M3U8_CLIENT_UNLOCK (demux->client);
430 if (flags & GST_SEEK_FLAG_FLUSH) {
431 GST_DEBUG_OBJECT (demux, "sending flush stop");
432 gst_pad_push_event (demux->srcpad, gst_event_new_flush_stop (TRUE));
435 demux->cancelled = FALSE;
436 gst_uri_downloader_reset (demux->downloader);
437 gst_task_start (demux->stream_task);
438 g_rec_mutex_unlock (&demux->stream_lock);
446 return gst_pad_event_default (pad, parent, event);
450 gst_hls_demux_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
457 demux = GST_HLS_DEMUX (parent);
459 switch (event->type) {
461 gchar *playlist = NULL;
463 if (demux->playlist == NULL) {
464 GST_WARNING_OBJECT (demux, "Received EOS without a playlist.");
468 GST_DEBUG_OBJECT (demux,
469 "Got EOS on the sink pad: main playlist fetched");
471 query = gst_query_new_uri ();
472 ret = gst_pad_peer_query (demux->sinkpad, query);
474 gst_query_parse_uri_redirection (query, &uri);
476 gst_query_parse_uri (query, &uri);
477 gst_hls_demux_set_location (demux, uri);
480 gst_query_unref (query);
482 playlist = gst_hls_src_buf_to_utf8_playlist (demux->playlist);
483 demux->playlist = NULL;
484 if (playlist == NULL) {
485 GST_WARNING_OBJECT (demux, "Error validating first playlist.");
486 } else if (!gst_m3u8_client_update (demux->client, playlist)) {
487 /* In most cases, this will happen if we set a wrong url in the
488 * source element and we have received the 404 HTML response instead of
490 GST_ELEMENT_ERROR (demux, STREAM, DECODE, ("Invalid playlist."),
495 if (!ret && gst_m3u8_client_is_live (demux->client)) {
496 GST_ELEMENT_ERROR (demux, RESOURCE, NOT_FOUND,
497 ("Failed querying the playlist uri, "
498 "required for live sources."), (NULL));
502 gst_task_start (demux->stream_task);
503 gst_event_unref (event);
506 case GST_EVENT_SEGMENT:
507 /* Swallow newsegments, we'll push our own */
508 gst_event_unref (event);
514 return gst_pad_event_default (pad, parent, event);
518 gst_hls_demux_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
520 GstHLSDemux *hlsdemux;
521 gboolean ret = FALSE;
526 hlsdemux = GST_HLS_DEMUX (parent);
528 switch (query->type) {
529 case GST_QUERY_DURATION:{
530 GstClockTime duration = -1;
533 gst_query_parse_duration (query, &fmt, NULL);
534 if (fmt == GST_FORMAT_TIME) {
535 duration = gst_m3u8_client_get_duration (hlsdemux->client);
536 if (GST_CLOCK_TIME_IS_VALID (duration) && duration > 0) {
537 gst_query_set_duration (query, GST_FORMAT_TIME, duration);
541 GST_INFO_OBJECT (hlsdemux, "GST_QUERY_DURATION returns %s with duration %"
542 GST_TIME_FORMAT, ret ? "TRUE" : "FALSE", GST_TIME_ARGS (duration));
546 if (hlsdemux->client) {
547 /* FIXME: Do we answer with the variant playlist, with the current
548 * playlist or the the uri of the least downlowaded fragment? */
549 gst_query_set_uri (query, gst_m3u8_client_get_uri (hlsdemux->client));
553 case GST_QUERY_SEEKING:{
557 gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
558 GST_INFO_OBJECT (hlsdemux, "Received GST_QUERY_SEEKING with format %d",
560 if (fmt == GST_FORMAT_TIME) {
561 GstClockTime duration;
563 duration = gst_m3u8_client_get_duration (hlsdemux->client);
564 if (GST_CLOCK_TIME_IS_VALID (duration) && duration > 0)
567 gst_query_set_seeking (query, fmt,
568 !gst_m3u8_client_is_live (hlsdemux->client), 0, stop);
570 GST_INFO_OBJECT (hlsdemux, "GST_QUERY_SEEKING returning with stop : %"
571 GST_TIME_FORMAT, GST_TIME_ARGS (stop));
576 /* Don't fordward queries upstream because of the special nature of this
577 * "demuxer", which relies on the upstream element only to be fed with the
586 gst_hls_demux_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
588 GstHLSDemux *demux = GST_HLS_DEMUX (parent);
590 if (demux->playlist == NULL)
591 demux->playlist = buf;
593 demux->playlist = gst_buffer_append (demux->playlist, buf);
599 gst_hls_demux_pause_tasks (GstHLSDemux * demux, gboolean caching)
601 if (GST_TASK_STATE (demux->updates_task) != GST_TASK_STOPPED) {
602 demux->cancelled = TRUE;
603 gst_uri_downloader_cancel (demux->downloader);
604 gst_task_pause (demux->updates_task);
606 g_mutex_lock (&demux->updates_timed_lock);
607 GST_TASK_SIGNAL (demux->updates_task);
609 g_mutex_unlock (&demux->updates_timed_lock);
612 if (GST_TASK_STATE (demux->stream_task) != GST_TASK_STOPPED) {
613 demux->stop_stream_task = TRUE;
614 gst_task_pause (demux->stream_task);
619 gst_hls_demux_stop (GstHLSDemux * demux)
621 gst_uri_downloader_cancel (demux->downloader);
623 if (GST_TASK_STATE (demux->updates_task) != GST_TASK_STOPPED) {
624 demux->cancelled = TRUE;
625 gst_uri_downloader_cancel (demux->downloader);
626 gst_task_stop (demux->updates_task);
627 g_mutex_lock (&demux->updates_timed_lock);
628 GST_TASK_SIGNAL (demux->updates_task);
629 g_mutex_unlock (&demux->updates_timed_lock);
630 g_rec_mutex_lock (&demux->updates_lock);
631 g_rec_mutex_unlock (&demux->updates_lock);
634 if (GST_TASK_STATE (demux->stream_task) != GST_TASK_STOPPED) {
635 demux->stop_stream_task = TRUE;
636 gst_task_stop (demux->stream_task);
637 g_rec_mutex_lock (&demux->stream_lock);
638 g_rec_mutex_unlock (&demux->stream_lock);
643 switch_pads (GstHLSDemux * demux, GstCaps * newcaps)
645 GstPad *oldpad = demux->srcpad;
649 GST_DEBUG ("Switching pads (oldpad:%p) with caps: %" GST_PTR_FORMAT, oldpad,
652 /* First create and activate new pad */
653 demux->srcpad = gst_pad_new_from_static_template (&srctemplate, NULL);
654 gst_pad_set_event_function (demux->srcpad,
655 GST_DEBUG_FUNCPTR (gst_hls_demux_src_event));
656 gst_pad_set_query_function (demux->srcpad,
657 GST_DEBUG_FUNCPTR (gst_hls_demux_src_query));
658 gst_pad_set_element_private (demux->srcpad, demux);
659 gst_pad_set_active (demux->srcpad, TRUE);
662 gst_pad_create_stream_id (demux->srcpad, GST_ELEMENT_CAST (demux), NULL);
664 event = gst_pad_get_sticky_event (demux->sinkpad, GST_EVENT_STREAM_START, 0);
666 if (gst_event_parse_group_id (event, &demux->group_id))
667 demux->have_group_id = TRUE;
669 demux->have_group_id = FALSE;
670 gst_event_unref (event);
671 } else if (!demux->have_group_id) {
672 demux->have_group_id = TRUE;
673 demux->group_id = gst_util_group_id_next ();
675 event = gst_event_new_stream_start (stream_id);
676 if (demux->have_group_id)
677 gst_event_set_group_id (event, demux->group_id);
679 gst_pad_push_event (demux->srcpad, event);
682 gst_pad_set_caps (demux->srcpad, newcaps);
684 gst_element_add_pad (GST_ELEMENT (demux), demux->srcpad);
686 gst_element_no_more_pads (GST_ELEMENT (demux));
690 gst_pad_push_event (oldpad, gst_event_new_eos ());
691 gst_pad_set_active (oldpad, FALSE);
692 gst_element_remove_pad (GST_ELEMENT (demux), oldpad);
697 gst_hls_demux_stream_loop (GstHLSDemux * demux)
699 GstFragment *fragment;
702 GstCaps *bufcaps, *srccaps = NULL;
704 /* Loop for the source pad task. The task is started when we have
705 * received the main playlist from the source element. It tries first to
706 * cache the first fragments and then it waits until it has more data in the
707 * queue. This task is woken up when we push a new fragment to the queue or
708 * when we reached the end of the playlist */
709 GST_DEBUG_OBJECT (demux, "Enter task");
711 if (G_UNLIKELY (demux->need_cache)) {
712 if (!gst_hls_demux_cache_fragments (demux))
715 /* we can start now the updates thread (only if on playing) */
716 gst_task_start (demux->updates_task);
717 GST_INFO_OBJECT (demux, "First fragments cached successfully");
720 if (g_queue_is_empty (demux->queue)) {
721 if (demux->end_of_playlist)
722 goto end_of_playlist;
727 fragment = g_queue_pop_head (demux->queue);
728 buf = gst_fragment_get_buffer (fragment);
730 /* Figure out if we need to create/switch pads */
731 if (G_LIKELY (demux->srcpad))
732 srccaps = gst_pad_get_current_caps (demux->srcpad);
733 bufcaps = gst_fragment_get_caps (fragment);
734 if (G_UNLIKELY (!srccaps || !gst_caps_is_equal_fixed (bufcaps, srccaps)
735 || demux->need_segment)) {
736 switch_pads (demux, bufcaps);
737 demux->need_segment = TRUE;
739 gst_caps_unref (bufcaps);
740 if (G_LIKELY (srccaps))
741 gst_caps_unref (srccaps);
742 g_object_unref (fragment);
744 if (demux->need_segment) {
746 GstClockTime start = GST_BUFFER_PTS (buf);
748 start += demux->position_shift;
749 /* And send a newsegment */
750 GST_DEBUG_OBJECT (demux, "Sending new-segment. segment start:%"
751 GST_TIME_FORMAT, GST_TIME_ARGS (start));
752 gst_segment_init (&segment, GST_FORMAT_TIME);
753 segment.start = start;
754 segment.time = start;
755 gst_pad_push_event (demux->srcpad, gst_event_new_segment (&segment));
756 demux->need_segment = FALSE;
757 demux->position_shift = 0;
760 GST_DEBUG_OBJECT (demux, "Pushing buffer %p", buf);
762 ret = gst_pad_push (demux->srcpad, buf);
763 if (ret != GST_FLOW_OK)
766 GST_DEBUG_OBJECT (demux, "Pushed buffer");
772 GST_DEBUG_OBJECT (demux, "Reached end of playlist, sending EOS");
773 gst_pad_push_event (demux->srcpad, gst_event_new_eos ());
774 gst_hls_demux_pause_tasks (demux, FALSE);
780 gst_task_pause (demux->stream_task);
781 if (!demux->cancelled) {
782 GST_ELEMENT_ERROR (demux, RESOURCE, NOT_FOUND,
783 ("Could not cache the first fragments"), (NULL));
784 gst_hls_demux_pause_tasks (demux, FALSE);
791 if (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS) {
792 GST_ELEMENT_ERROR (demux, STREAM, FAILED, (NULL),
793 ("stream stopped, reason %s", gst_flow_get_name (ret)));
794 gst_pad_push_event (demux->srcpad, gst_event_new_eos ());
796 GST_DEBUG_OBJECT (demux, "stream stopped, reason %s",
797 gst_flow_get_name (ret));
799 gst_hls_demux_pause_tasks (demux, FALSE);
805 GST_DEBUG_OBJECT (demux, "Pause task");
806 gst_task_pause (demux->stream_task);
812 gst_hls_demux_reset (GstHLSDemux * demux, gboolean dispose)
814 demux->need_cache = TRUE;
815 demux->end_of_playlist = FALSE;
816 demux->cancelled = FALSE;
817 demux->do_typefind = TRUE;
819 if (demux->input_caps) {
820 gst_caps_unref (demux->input_caps);
821 demux->input_caps = NULL;
824 if (demux->playlist) {
825 gst_buffer_unref (demux->playlist);
826 demux->playlist = NULL;
830 gst_m3u8_client_free (demux->client);
831 demux->client = NULL;
835 demux->client = gst_m3u8_client_new ("");
838 while (!g_queue_is_empty (demux->queue)) {
839 GstFragment *fragment = g_queue_pop_head (demux->queue);
840 g_object_unref (fragment);
842 g_queue_clear (demux->queue);
844 demux->position_shift = 0;
845 demux->need_segment = TRUE;
847 demux->have_group_id = FALSE;
848 demux->group_id = G_MAXUINT;
852 gst_hls_demux_set_location (GstHLSDemux * demux, const gchar * uri)
855 gst_m3u8_client_free (demux->client);
856 demux->client = gst_m3u8_client_new (uri);
857 GST_INFO_OBJECT (demux, "Changed location: %s", uri);
862 gst_hls_demux_updates_loop (GstHLSDemux * demux)
864 /* Loop for the updates. It's started when the first fragments are cached and
865 * schedules the next update of the playlist (for lives sources) and the next
866 * update of fragments. When a new fragment is downloaded, it compares the
867 * download time with the next scheduled update to check if we can or should
868 * switch to a different bitrate */
870 /* block until the next scheduled update or the signal to quit this thread */
871 g_mutex_lock (&demux->updates_timed_lock);
872 GST_DEBUG_OBJECT (demux, "Started updates task");
874 if (demux->cancelled)
877 /* schedule the next update */
878 gst_hls_demux_schedule (demux);
880 /* block until the next scheduled update or the signal to quit this thread */
881 GST_DEBUG_OBJECT (demux, "Waiting");
882 if (g_cond_timed_wait (GST_TASK_GET_COND (demux->updates_task),
883 &demux->updates_timed_lock, &demux->next_update)) {
884 GST_DEBUG_OBJECT (demux, "Unlocked");
887 GST_DEBUG_OBJECT (demux, "Continue");
889 if (demux->cancelled)
892 /* update the playlist for live sources */
893 if (gst_m3u8_client_is_live (demux->client)) {
894 if (!gst_hls_demux_update_playlist (demux, TRUE)) {
895 if (demux->cancelled)
897 demux->client->update_failed_count++;
898 if (demux->client->update_failed_count < DEFAULT_FAILED_COUNT) {
899 GST_WARNING_OBJECT (demux, "Could not update the playlist");
902 GST_ELEMENT_ERROR (demux, RESOURCE, NOT_FOUND,
903 ("Could not update the playlist"), (NULL));
909 /* if it's a live source and the playlist couldn't be updated, there aren't
910 * more fragments in the playlist, so we just wait for the next schedulled
912 if (gst_m3u8_client_is_live (demux->client) &&
913 demux->client->update_failed_count > 0) {
914 GST_WARNING_OBJECT (demux,
915 "The playlist hasn't been updated, failed count is %d",
916 demux->client->update_failed_count);
920 if (demux->cancelled)
923 /* fetch the next fragment */
924 if (g_queue_is_empty (demux->queue)) {
925 GST_DEBUG_OBJECT (demux, "queue empty, get next fragment");
926 if (!gst_hls_demux_get_next_fragment (demux, FALSE)) {
927 if (demux->cancelled) {
929 } else if (!demux->end_of_playlist) {
930 demux->client->update_failed_count++;
931 if (demux->client->update_failed_count < DEFAULT_FAILED_COUNT) {
932 GST_WARNING_OBJECT (demux, "Could not fetch the next fragment");
935 GST_ELEMENT_ERROR (demux, RESOURCE, NOT_FOUND,
936 ("Could not fetch the next fragment"), (NULL));
941 demux->client->update_failed_count = 0;
943 if (demux->cancelled)
946 /* try to switch to another bitrate if needed */
947 gst_hls_demux_switch_playlist (demux);
954 GST_DEBUG_OBJECT (demux, "Stopped updates task");
955 g_mutex_unlock (&demux->updates_timed_lock);
961 GST_DEBUG_OBJECT (demux, "Stopped updates task because of error");
962 gst_hls_demux_pause_tasks (demux, TRUE);
963 g_mutex_unlock (&demux->updates_timed_lock);
968 gst_hls_demux_cache_fragments (GstHLSDemux * demux)
972 /* If this playlist is a variant playlist, select the first one
974 if (gst_m3u8_client_has_variant_playlist (demux->client)) {
975 GstM3U8 *child = NULL;
977 if (demux->connection_speed == 0) {
979 GST_M3U8_CLIENT_LOCK (demux->client);
980 child = demux->client->main->current_variant->data;
981 GST_M3U8_CLIENT_UNLOCK (demux->client);
983 GList *tmp = gst_m3u8_client_get_playlist_for_bitrate (demux->client,
984 demux->connection_speed);
986 child = GST_M3U8 (tmp->data);
989 gst_m3u8_client_set_current (demux->client, child);
990 if (!gst_hls_demux_update_playlist (demux, FALSE)) {
991 GST_ERROR_OBJECT (demux, "Could not fetch the child playlist %s",
997 if (!gst_m3u8_client_is_live (demux->client)) {
998 GstClockTime duration = gst_m3u8_client_get_duration (demux->client);
1000 GST_DEBUG_OBJECT (demux, "Sending duration message : %" GST_TIME_FORMAT,
1001 GST_TIME_ARGS (duration));
1002 if (duration != GST_CLOCK_TIME_NONE)
1003 gst_element_post_message (GST_ELEMENT (demux),
1004 gst_message_new_duration_changed (GST_OBJECT (demux)));
1007 /* Cache the first fragments */
1008 for (i = 0; i < demux->fragments_cache; i++) {
1009 gst_element_post_message (GST_ELEMENT (demux),
1010 gst_message_new_buffering (GST_OBJECT (demux),
1011 100 * i / demux->fragments_cache));
1012 g_get_current_time (&demux->next_update);
1013 if (!gst_hls_demux_get_next_fragment (demux, TRUE)) {
1014 if (demux->end_of_playlist)
1016 if (!demux->cancelled)
1017 GST_ERROR_OBJECT (demux, "Error caching the first fragments");
1020 /* make sure we stop caching fragments if something cancelled it */
1021 if (demux->cancelled)
1023 gst_hls_demux_switch_playlist (demux);
1025 gst_element_post_message (GST_ELEMENT (demux),
1026 gst_message_new_buffering (GST_OBJECT (demux), 100));
1028 g_get_current_time (&demux->next_update);
1030 demux->need_cache = FALSE;
1036 gst_hls_src_buf_to_utf8_playlist (GstBuffer * buf)
1041 if (!gst_buffer_map (buf, &info, GST_MAP_READ))
1044 if (!g_utf8_validate ((gchar *) info.data, info.size, NULL))
1045 goto validate_error;
1047 /* alloc size + 1 to end with a null character */
1048 playlist = g_malloc0 (info.size + 1);
1049 memcpy (playlist, info.data, info.size);
1051 gst_buffer_unmap (buf, &info);
1052 gst_buffer_unref (buf);
1056 gst_buffer_unmap (buf, &info);
1058 gst_buffer_unref (buf);
1063 gst_hls_demux_update_playlist (GstHLSDemux * demux, gboolean update)
1065 GstFragment *download;
1068 gboolean updated = FALSE;
1070 const gchar *uri = gst_m3u8_client_get_current_uri (demux->client);
1072 download = gst_uri_downloader_fetch_uri (demux->downloader, uri);
1074 if (download == NULL)
1077 buf = gst_fragment_get_buffer (download);
1078 playlist = gst_hls_src_buf_to_utf8_playlist (buf);
1079 g_object_unref (download);
1081 if (playlist == NULL) {
1082 GST_WARNING_OBJECT (demux, "Couldn't not validate playlist encoding");
1086 updated = gst_m3u8_client_update (demux->client, playlist);
1088 /* If it's a live source, do not let the sequence number go beyond
1089 * three fragments before the end of the list */
1090 if (updated && update == FALSE && demux->client->current &&
1091 gst_m3u8_client_is_live (demux->client)) {
1092 guint last_sequence;
1094 GST_M3U8_CLIENT_LOCK (demux->client);
1096 GST_M3U8_MEDIA_FILE (g_list_last (demux->client->current->
1097 files)->data)->sequence;
1099 if (demux->client->sequence >= last_sequence - 3) {
1100 GST_DEBUG_OBJECT (demux, "Sequence is beyond playlist. Moving back to %d",
1102 demux->need_segment = TRUE;
1103 demux->client->sequence = last_sequence - 3;
1105 GST_M3U8_CLIENT_UNLOCK (demux->client);
1112 gst_hls_demux_change_playlist (GstHLSDemux * demux, guint max_bitrate)
1114 GList *previous_variant, *current_variant;
1115 gint old_bandwidth, new_bandwidth;
1117 /* If user specifies a connection speed never use a playlist with a bandwidth
1118 * superior than it */
1119 if (demux->connection_speed != 0 && max_bitrate > demux->connection_speed)
1120 max_bitrate = demux->connection_speed;
1122 previous_variant = demux->client->main->current_variant;
1123 current_variant = gst_m3u8_client_get_playlist_for_bitrate (demux->client,
1126 retry_failover_protection:
1127 old_bandwidth = GST_M3U8 (previous_variant->data)->bandwidth;
1128 new_bandwidth = GST_M3U8 (current_variant->data)->bandwidth;
1130 /* Don't do anything else if the playlist is the same */
1131 if (new_bandwidth == old_bandwidth) {
1135 demux->client->main->current_variant = current_variant;
1136 GST_M3U8_CLIENT_UNLOCK (demux->client);
1138 gst_m3u8_client_set_current (demux->client, current_variant->data);
1140 GST_INFO_OBJECT (demux, "Client was on %dbps, max allowed is %dbps, switching"
1141 " to bitrate %dbps", old_bandwidth, max_bitrate, new_bandwidth);
1143 if (gst_hls_demux_update_playlist (demux, FALSE)) {
1146 s = gst_structure_new ("playlist",
1147 "uri", G_TYPE_STRING, gst_m3u8_client_get_current_uri (demux->client),
1148 "bitrate", G_TYPE_INT, new_bandwidth, NULL);
1149 gst_element_post_message (GST_ELEMENT_CAST (demux),
1150 gst_message_new_element (GST_OBJECT_CAST (demux), s));
1152 GList *failover = NULL;
1154 GST_INFO_OBJECT (demux, "Unable to update playlist. Switching back");
1155 GST_M3U8_CLIENT_LOCK (demux->client);
1157 failover = g_list_previous (current_variant);
1158 if (failover && new_bandwidth == GST_M3U8 (failover->data)->bandwidth) {
1159 current_variant = failover;
1160 goto retry_failover_protection;
1163 demux->client->main->current_variant = previous_variant;
1164 GST_M3U8_CLIENT_UNLOCK (demux->client);
1165 gst_m3u8_client_set_current (demux->client, previous_variant->data);
1166 /* Try a lower bitrate (or stop if we just tried the lowest) */
1167 if (new_bandwidth ==
1168 GST_M3U8 (g_list_first (demux->client->main->lists)->data)->bandwidth)
1171 return gst_hls_demux_change_playlist (demux, new_bandwidth - 1);
1174 /* Force typefinding since we might have changed media type */
1175 demux->do_typefind = TRUE;
1181 gst_hls_demux_schedule (GstHLSDemux * demux)
1183 gfloat update_factor;
1186 /* As defined in §6.3.4. Reloading the Playlist file:
1187 * "If the client reloads a Playlist file and finds that it has not
1188 * changed then it MUST wait for a period of time before retrying. The
1189 * minimum delay is a multiple of the target duration. This multiple is
1190 * 0.5 for the first attempt, 1.5 for the second, and 3.0 thereafter."
1192 count = demux->client->update_failed_count;
1194 update_factor = update_interval_factor[count];
1196 update_factor = update_interval_factor[3];
1198 /* schedule the next update using the target duration field of the
1200 g_time_val_add (&demux->next_update,
1201 gst_m3u8_client_get_target_duration (demux->client)
1202 / GST_SECOND * G_USEC_PER_SEC * update_factor);
1203 GST_DEBUG_OBJECT (demux, "Next update scheduled at %s",
1204 g_time_val_to_iso8601 (&demux->next_update));
1210 gst_hls_demux_switch_playlist (GstHLSDemux * demux)
1216 GstFragment *fragment;
1219 GST_M3U8_CLIENT_LOCK (demux->client);
1220 fragment = g_queue_peek_tail (demux->queue);
1221 if (!demux->client->main->lists || !fragment) {
1222 GST_M3U8_CLIENT_UNLOCK (demux->client);
1225 GST_M3U8_CLIENT_UNLOCK (demux->client);
1227 /* compare the time when the fragment was downloaded with the time when it was
1229 g_get_current_time (&now);
1230 diff = (GST_TIMEVAL_TO_TIME (now) - GST_TIMEVAL_TO_TIME (demux->next_update));
1231 buffer = gst_fragment_get_buffer (fragment);
1232 size = gst_buffer_get_size (buffer);
1233 bitrate = (size * 8) / ((double) diff / GST_SECOND);
1235 GST_DEBUG ("Downloaded %d bytes in %" GST_TIME_FORMAT ". Bitrate is : %d",
1236 (guint) size, GST_TIME_ARGS (diff), bitrate);
1238 gst_buffer_unref (buffer);
1239 return gst_hls_demux_change_playlist (demux, bitrate * demux->bitrate_limit);
1242 static GstFragment *
1243 gst_hls_demux_decrypt_fragment (GstHLSDemux * demux,
1244 GstFragment * encrypted_fragment, const gchar * key, const guint8 * iv)
1246 GstFragment *key_fragment, *ret = NULL;
1247 GstBuffer *key_buffer, *encrypted_buffer, *decrypted_buffer;
1248 GstMapInfo key_info, encrypted_info, decrypted_info;
1249 gcry_cipher_hd_t aes_ctx = NULL;
1250 gcry_error_t err = 0;
1251 gsize unpadded_size;
1253 GST_INFO_OBJECT (demux, "Fetching key %s", key);
1254 key_fragment = gst_uri_downloader_fetch_uri (demux->downloader, key);
1255 if (key_fragment == NULL)
1258 key_buffer = gst_fragment_get_buffer (key_fragment);
1259 encrypted_buffer = gst_fragment_get_buffer (encrypted_fragment);
1261 gst_buffer_new_allocate (NULL, gst_buffer_get_size (encrypted_buffer),
1264 gst_buffer_map (key_buffer, &key_info, GST_MAP_READ);
1265 gst_buffer_map (encrypted_buffer, &encrypted_info, GST_MAP_READ);
1266 gst_buffer_map (decrypted_buffer, &decrypted_info, GST_MAP_WRITE);
1269 gcry_cipher_open (&aes_ctx, GCRY_CIPHER_AES128, GCRY_CIPHER_MODE_CBC, 0);
1272 err = gcry_cipher_setkey (aes_ctx, key_info.data, 16);
1275 err = gcry_cipher_setiv (aes_ctx, iv, 16);
1278 err = gcry_cipher_decrypt (aes_ctx, decrypted_info.data, decrypted_info.size,
1279 encrypted_info.data, encrypted_info.size);
1282 gcry_cipher_close (aes_ctx);
1284 /* Handle pkcs7 unpadding here */
1286 decrypted_info.size - decrypted_info.data[decrypted_info.size - 1];
1288 gst_buffer_unmap (decrypted_buffer, &decrypted_info);
1289 gst_buffer_unmap (encrypted_buffer, &encrypted_info);
1290 gst_buffer_unmap (key_buffer, &key_info);
1292 gst_buffer_resize (decrypted_buffer, 0, unpadded_size);
1294 gst_buffer_unref (key_buffer);
1295 gst_buffer_unref (encrypted_buffer);
1296 g_object_unref (key_fragment);
1298 ret = gst_fragment_new ();
1299 gst_fragment_add_buffer (ret, decrypted_buffer);
1300 ret->completed = TRUE;
1302 g_object_unref (encrypted_fragment);
1306 GST_ERROR_OBJECT (demux, "Failed to decrypt fragment: %s",
1307 gpg_strerror (err));
1310 gcry_cipher_close (aes_ctx);
1312 gst_buffer_unref (key_buffer);
1313 gst_buffer_unref (encrypted_buffer);
1314 gst_buffer_unref (decrypted_buffer);
1316 gst_buffer_unmap (decrypted_buffer, &decrypted_info);
1317 gst_buffer_unmap (encrypted_buffer, &encrypted_info);
1318 gst_buffer_unmap (key_buffer, &key_info);
1320 g_object_unref (encrypted_fragment);
1325 gst_hls_demux_get_next_fragment (GstHLSDemux * demux, gboolean caching)
1327 GstFragment *download;
1328 const gchar *next_fragment_uri;
1329 GstClockTime duration;
1330 GstClockTime timestamp;
1333 const gchar *key = NULL;
1334 const guint8 *iv = NULL;
1336 if (!gst_m3u8_client_get_next_fragment (demux->client, &discont,
1337 &next_fragment_uri, &duration, ×tamp, &key, &iv)) {
1338 GST_INFO_OBJECT (demux, "This playlist doesn't contain more fragments");
1339 demux->end_of_playlist = TRUE;
1340 gst_task_start (demux->stream_task);
1344 GST_INFO_OBJECT (demux, "Fetching next fragment %s", next_fragment_uri);
1346 download = gst_uri_downloader_fetch_uri (demux->downloader,
1349 if (download && key)
1350 download = gst_hls_demux_decrypt_fragment (demux, download, key, iv);
1352 if (download == NULL)
1355 buf = gst_fragment_get_buffer (download);
1357 GST_BUFFER_DURATION (buf) = duration;
1358 GST_BUFFER_PTS (buf) = timestamp;
1360 /* We actually need to do this every time we switch bitrate */
1361 if (G_UNLIKELY (demux->do_typefind)) {
1362 GstCaps *caps = gst_fragment_get_caps (download);
1364 if (!demux->input_caps || !gst_caps_is_equal (caps, demux->input_caps)) {
1365 gst_caps_replace (&demux->input_caps, caps);
1366 /* gst_pad_set_caps (demux->srcpad, demux->input_caps); */
1367 GST_INFO_OBJECT (demux, "Input source caps: %" GST_PTR_FORMAT,
1369 demux->do_typefind = FALSE;
1371 gst_caps_unref (caps);
1373 gst_fragment_set_caps (download, demux->input_caps);
1377 GST_DEBUG_OBJECT (demux, "Marking fragment as discontinuous");
1378 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
1381 /* The buffer ref is still kept inside the fragment download */
1382 gst_buffer_unref (buf);
1384 GST_DEBUG_OBJECT (demux, "Pushing fragment in queue");
1385 g_queue_push_tail (demux->queue, download);
1387 GST_TASK_SIGNAL (demux->updates_task);
1388 gst_task_start (demux->stream_task);