1 /*
2 * Apple HTTP Live Streaming demuxer
3 * Copyright (c) 2010 Martin Storsjo
4 * Copyright (c) 2013 Anssi Hannula
5 *
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23 /**
24 * @file
25 * Apple HTTP Live Streaming demuxer
26 * http://tools.ietf.org/html/draft-pantos-http-live-streaming
27 */
28
41
42 #define INITIAL_BUFFER_SIZE 32768
43
44 #define MAX_FIELD_LEN 64
45 #define MAX_CHARACTERISTICS_LEN 512
46
47 #define MPEG_TIME_BASE 90000
48 #define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}
49
50 /*
51 * An apple http stream consists of a playlist with media segment files,
52 * played sequentially. There may be several playlists with the same
53 * video content, in different bandwidth variants, that are played in
54 * parallel (preferably only one bandwidth variant at a time). In this case,
55 * the user supplied the url to a main playlist that only lists the variant
56 * playlists.
57 *
58 * If the main playlist doesn't point at any variants, we still create
59 * one anonymous toplevel variant for this, to maintain the structure.
60 */
61
66 };
67
76 };
77
79
84 };
85
86 /*
87 * Each playlist has its own demuxer. If it currently is active,
88 * it has an open AVIOContext too, and potentially an AVPacket
89 * containing the next packet from this stream.
90 */
101
112
115
116 /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
117 * (and possibly other ID3 tags) in the beginning of each segment) */
127
131
132 /* Renditions associated with this playlist, if any.
133 * Alternative rendition playlists have a single rendition associated
134 * with them, and variant main Media Playlists may have
135 * multiple (playlist-less) renditions associated with them. */
138 };
139
140 /*
141 * Renditions are e.g. alternative subtitle or audio streams.
142 * The rendition may either be an external playlist or it may be
143 * contained in the main Media Playlist of the variant (in which case
144 * playlist is NULL).
145 */
153 };
154
157
158 /* every variant contains at least the main Media Playlist in index 0 */
161
165 };
166
174
180 char *
user_agent;
///< holds HTTP user agent set as an AVOption to the HTTP protocol context
181 char *
cookies;
///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
182 char *
headers;
///< holds HTTP headers set as an AVOption to the HTTP protocol context
184
186 {
191 }
192
194 {
195 int i;
200 }
203 }
204
206 {
207 int i;
222 }
224 }
229 }
230
232 {
233 int i;
238 }
241 }
242
244 {
245 int i;
250 }
251
252 /*
253 * Used to reset a statically allocated AVPacket to a clean slate,
254 * containing no data.
255 */
257 {
260 }
261
263 const char *base)
264 {
266 if (!pls)
271
274
276 return pls;
277 }
278
281 /* variant group ids: */
285 };
286
288 const char *
url,
const char *base)
289 {
292
294 if (!pls)
296
298 if (!var)
300
301 if (info) {
306 }
307
310 return var;
311 }
312
314 int key_len, char **dest, int *dest_len)
315 {
316 if (!strncmp(key, "BANDWIDTH=", key_len)) {
319 } else if (!strncmp(key, "AUDIO=", key_len)) {
321 *dest_len =
sizeof(info->
audio);
322 } else if (!strncmp(key, "VIDEO=", key_len)) {
324 *dest_len =
sizeof(info->
video);
325 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
328 }
329 }
330
335 };
336
338 int key_len, char **dest, int *dest_len)
339 {
340 if (!strncmp(key, "METHOD=", key_len)) {
342 *dest_len =
sizeof(info->
method);
343 } else if (!strncmp(key, "URI=", key_len)) {
345 *dest_len =
sizeof(info->
uri);
346 } else if (!strncmp(key, "IV=", key_len)) {
348 *dest_len =
sizeof(info->
iv);
349 }
350 }
351
362 };
363
365 const char *url_base)
366 {
369 char *characteristic;
370 char *chr_ptr;
371 char *saveptr;
372
373 if (!strcmp(info->
type,
"AUDIO"))
375 else if (!strcmp(info->
type,
"VIDEO"))
377 else if (!strcmp(info->
type,
"SUBTITLES"))
379 else if (!strcmp(info->
type,
"CLOSED-CAPTIONS"))
380 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
381 * AVC SEI RBSP anyway */
383
386
387 /* URI is mandatory for subtitles as per spec */
390
391 /* TODO: handle subtitles (each segment has to parsed separately) */
394
396 if (!rend)
398
400
405
406 /* add the playlist if this is an external rendition */
412 }
413
415 int langlen = strlen(rend->
language);
416 if (langlen <
sizeof(rend->
language) - 3) {
419 sizeof(rend->
language) - langlen - 2);
420 }
421 }
422
425 if (!strcmp(info->
forced,
"YES"))
427
429 while ((characteristic =
av_strtok(chr_ptr,
",", &saveptr))) {
430 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
432 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
434
436 }
437
438 return rend;
439 }
440
442 int key_len, char **dest, int *dest_len)
443 {
444 if (!strncmp(key, "TYPE=", key_len)) {
446 *dest_len =
sizeof(info->
type);
447 } else if (!strncmp(key, "URI=", key_len)) {
449 *dest_len =
sizeof(info->
uri);
450 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
453 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
456 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
459 } else if (!strncmp(key, "NAME=", key_len)) {
461 *dest_len =
sizeof(info->
name);
462 } else if (!strncmp(key, "DEFAULT=", key_len)) {
465 } else if (!strncmp(key, "FORCED=", key_len)) {
467 *dest_len =
sizeof(info->
forced);
468 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
471 }
472 /*
473 * ignored:
474 * - AUTOSELECT: client may autoselect based on e.g. system language
475 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
476 */
477 }
478
479 /* used by parse_playlist to allocate a new variant+playlist when the
480 * playlist is detected to be a Media Playlist (not Master Playlist)
481 * and we have no parent Master Playlist (parsing of which would have
482 * allocated the variant and playlist already) */
484 {
485 if (*pls)
486 return 0;
490 return 0;
491 }
492
493 /* pls = NULL => Master Playlist or parentless Media Playlist
494 * pls = !NULL => parented Media Playlist, playlist+variant allocated */
497 {
498 int ret = 0, is_segment = 0, is_variant = 0;
502 int has_iv = 0;
505 const char *ptr;
506 int close_in = 0;
507 int64_t seg_offset = 0;
508 int64_t seg_size = -1;
512
513 if (!in) {
515 close_in = 1;
516 /* Some HLS servers don't like being sent the range header */
518
519 // broker prior HTTP options that should be consistent across requests
523
527 if (ret < 0)
529 }
530
532 url = new_url;
533
535 if (strcmp(line, "#EXTM3U")) {
537 goto fail;
538 }
539
540 if (pls) {
544 }
547 if (
av_strstart(line,
"#EXT-X-STREAM-INF:", &ptr)) {
548 is_variant = 1;
549 memset(&variant_info, 0, sizeof(variant_info));
551 &variant_info);
552 }
else if (
av_strstart(line,
"#EXT-X-KEY:", &ptr)) {
555 &info);
557 has_iv = 0;
558 if (!strcmp(info.
method,
"AES-128"))
560 if (!strcmp(info.
method,
"SAMPLE-AES"))
562 if (!strncmp(info.
iv,
"0x", 2) || !strncmp(info.
iv,
"0X", 2)) {
564 has_iv = 1;
565 }
567 }
else if (
av_strstart(line,
"#EXT-X-MEDIA:", &ptr)) {
570 &info);
572 }
else if (
av_strstart(line,
"#EXT-X-TARGETDURATION:", &ptr)) {
574 if (ret < 0)
575 goto fail;
577 }
else if (
av_strstart(line,
"#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
579 if (ret < 0)
580 goto fail;
582 }
else if (
av_strstart(line,
"#EXT-X-PLAYLIST-TYPE:", &ptr)) {
584 if (ret < 0)
585 goto fail;
586 if (!strcmp(ptr, "EVENT"))
588 else if (!strcmp(ptr, "VOD"))
590 }
else if (
av_strstart(line,
"#EXT-X-ENDLIST", &ptr)) {
591 if (pls)
594 is_segment = 1;
596 }
else if (
av_strstart(line,
"#EXT-X-BYTERANGE:", &ptr)) {
597 seg_size = atoi(ptr);
598 ptr = strchr(ptr, '@');
599 if (ptr)
600 seg_offset = atoi(ptr+1);
602 continue;
603 } else if (line[0]) {
604 if (is_variant) {
607 goto fail;
608 }
609 is_variant = 0;
610 }
611 if (is_segment) {
613 if (!pls) {
616 goto fail;
617 }
619 }
621 if (!seg) {
623 goto fail;
624 }
627 if (has_iv) {
628 memcpy(seg->
iv, iv,
sizeof(iv));
629 } else {
631 memset(seg->
iv, 0,
sizeof(seg->
iv));
633 }
634
641 goto fail;
642 }
643 } else {
645 }
646
653 goto fail;
654 }
655
657 is_segment = 0;
658
659 seg->
size = seg_size;
660 if (seg_size >= 0) {
662 seg_offset += seg_size;
663 seg_size = -1;
664 } else {
666 seg_offset = 0;
667 }
668 }
669 }
670 }
671 if (pls)
673
674 fail:
676 if (close_in)
679 }
680
684 };
685
686 /* read from URLContext, limiting read to current segment */
689 {
692
693 /* limit read if the segment was only a part of a file */
696
699 else
701
702 if (ret > 0)
704
706 }
707
708 /* Parse the raw ID3 data and pass contents to caller */
712 {
713 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
715
717 for (meta = *extra_meta; meta; meta = meta->
next) {
718 if (!strcmp(meta->
tag,
"PRIV")) {
720 if (priv->
datasize == 8 && !strcmp(priv->
owner, id3_priv_owner_ts)) {
721 /* 33-bit MPEG timestamp */
724 if ((ts & ~((1ULL << 33) - 1)) == 0)
725 *dts = ts;
726 else
728 }
729 }
else if (!strcmp(meta->
tag,
"APIC") && apic)
731 }
732 }
733
734 /* Check if the ID3 metadata contents have changed */
737 {
740 /* check that no keys have changed values */
743 if (!oldentry || strcmp(oldentry->
value, entry->
value) != 0)
744 return 1;
745 }
746
747 /* check if apic appeared */
749 return 1;
750
751 if (apic) {
754 return 1;
755
757 return 1;
758 }
759
760 return 0;
761 }
762
763 /* Parse ID3 data and handle the found data */
765 {
770
771 parse_id3(pls->
ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
772
776 }
777
779 /* initial ID3 tags */
782
783 /* get picture attachment and set text metadata */
786 else
787 /* demuxer not yet opened, defer picture attachment */
789
792
793 } else {
797 }
799 }
800
803 }
804
805 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
807 int buf_size,
int *
len)
808 {
809 /* intercept id3 tags, we do not want to pass them to the raw
810 * demuxer on all segment switches */
811 int bytes;
812 int id3_buf_pos = 0;
814
815 /* gather all the id3 tags */
816 while (1) {
817 /* see if we can retrieve enough data for ID3 header */
820 if (bytes > 0) {
821
823 /* no EOF yet, so fill the caller buffer again after
824 * we have stripped the ID3 tags */
825 fill_buf = 1;
826
827 *len += bytes;
828
829 } else if (*len <= 0) {
830 /* error/EOF */
831 *len = bytes;
832 fill_buf = 0;
833 }
834 }
835
837 break;
838
841 int64_t maxsize = seg->
size >= 0 ? seg->
size : 1024*1024;
843 int tag_got_bytes =
FFMIN(taglen, *len);
844 int remaining = taglen - tag_got_bytes;
845
846 if (taglen > maxsize) {
848 taglen, maxsize);
849 break;
850 }
851
852 /*
853 * Copy the id3 tag to our temporary id3 buffer.
854 * We could read a small id3 tag directly without memcpy, but
855 * we would still need to copy the large tags, and handling
856 * both of those cases together with the possibility for multiple
857 * tags would make the handling a bit complex.
858 */
861 break;
862 memcpy(pls->
id3_buf + id3_buf_pos, buf, tag_got_bytes);
863 id3_buf_pos += tag_got_bytes;
864
865 /* strip the intercepted bytes */
866 *len -= tag_got_bytes;
867 memmove(buf, buf + tag_got_bytes, *len);
869
870 if (remaining > 0) {
871 /* read the rest of the tag in */
873 break;
874 id3_buf_pos += remaining;
876 }
877
878 } else {
879 /* no more ID3 tags */
880 break;
881 }
882 }
883
884 /* re-fill buffer for the caller unless EOF */
885 if (*len >= 0 && (fill_buf || *len == 0)) {
887
888 /* ignore error if we already had some data */
889 if (bytes >= 0)
890 *len += bytes;
891 else if (*len == 0)
892 *len = bytes;
893 }
894
896 /* Now parse all the ID3 tags */
900 }
901
904 }
905
907 {
912
913 // broker prior HTTP options that should be consistent across requests
918
919 // Same opts for key request (ffurl_open mutilates the opts so it cannot be used twice)
921
922 if (seg->
size >= 0) {
923 /* try to restrict the HTTP request to the part we want
924 * (if this is in fact a HTTP request) */
927 }
928
931
935
943 !=
sizeof(pls->
key)) {
946 }
948 } else {
951 }
953 }
956 iv[32] = key[32] = '0円';
957 if (strstr(seg->
url,
"://"))
959 else
966
971 }
972 ret = 0;
975 "SAMPLE-AES encryption is not supported yet\n");
977 }
978 else
980
981 /* Seek to the requested position. If this was a HTTP request, the offset
982 * should already be where want it to, but this allows e.g. local testing
983 * without a HTTP server. */
986 if (seekret < 0) {
988 ret = seekret;
991 }
992 }
993
999 }
1000
1002 {
1006 }
1007
1009 {
1013 int just_opened = 0;
1014
1015 restart:
1018
1020 int64_t reload_interval;
1021
1022 /* Check that the playlist is still needed before opening a new
1023 * segment. */
1028 i++) {
1031 }
1032 }
1037 }
1038
1039 /* If this is a live stream and the reload interval has elapsed since
1040 * the last playlist reload, reload the playlists now. */
1042
1043 reload:
1050 }
1051 /* If we need to reload the playlist again below (if
1052 * there's still no more segments), switch to a reload
1053 * interval of half the target duration. */
1055 }
1058 "skipping %d segments ahead, expired from playlists\n",
1061 }
1069 }
1070 /* Enough time has elapsed since the last reload */
1071 goto reload;
1072 }
1073
1075 if (ret < 0) {
1079 }
1080 just_opened = 1;
1081 }
1082
1084 if (ret > 0) {
1086 /* Intercept ID3 tags here, elementary audio streams are required
1087 * to convey timestamps using them in the beginning of each segment. */
1089 }
1090
1092 }
1096
1098
1099 goto restart;
1100 }
1101
1103 {
1104 int variant_count = 0;
1105 int i, j;
1106
1107 for (i = 0; i < c->
n_variants && variant_count < 2; i++) {
1109
1112 variant_count++;
1113 break;
1114 }
1115 }
1116 }
1117
1118 return variant_count >= 2;
1119 }
1120
1123 {
1124 int i;
1125
1128
1129 if (rend->
type == type && !strcmp(rend->
group_id, group_id)) {
1130
1132 /* rendition is an external playlist
1133 * => add the playlist to the variant */
1135 else
1136 /* rendition is part of the variant main Media Playlist
1137 * => add the rendition to the main Media Playlist */
1140 rend);
1141 }
1142 }
1143 }
1144
1147 {
1148 int rend_idx = 0;
1149 int i;
1150
1153
1155 continue;
1156
1159
1160 if (rend->
type != type)
1161 continue;
1162
1167
1169 }
1171 break;
1172 }
1173 }
1174
1175 /* if timestamp was in valid range: returns 1 and sets seq_no
1176 * if not: returns 0 and sets seq_no to closest segment */
1178 int64_t timestamp, int *seq_no)
1179 {
1180 int i;
1183
1184 if (timestamp < pos) {
1186 return 0;
1187 }
1188
1191 if (diff > 0) {
1193 return 1;
1194 }
1196 }
1197
1199
1200 return 0;
1201 }
1202
1204 {
1205 int seq_no;
1206
1209 /* reload the playlist since it was suspended */
1211
1212 /* If playback is already in progress (we are just selecting a new
1213 * playlist) and this is a complete file, find the matching segment
1214 * by counting durations. */
1217 return seq_no;
1218 }
1219
1221 if (!c->
first_packet &&
/* we are doing a segment selection during playback */
1224 /* While spec 3.4.3 says that we cannot assume anything about the
1225 * content at the same sequence number on different playlists,
1226 * in practice this seems to work and doing it otherwise would
1227 * require us to download a segment to inspect its timestamps. */
1229
1230 /* If this is a live stream with more than 3 segments, start at the
1231 * third last segment. */
1234 }
1235
1236 /* Otherwise just start on the first segment. */
1238 }
1239
1241 {
1244 int ret = 0, i, j, stream_offset = 0;
1245
1247
1248 c->first_packet = 1;
1251
1252 // if the URL context is good, read important options we must broker later
1254 // get the previous user agent & set back to null if string size is zero
1257 if (
c->user_agent && !strlen(
c->user_agent))
1259
1260 // get the previous cookies & set back to null if string size is zero
1263 if (
c->cookies && !strlen(
c->cookies))
1265
1266 // get the previous headers & set back to null if string size is zero
1269 if (
c->headers && !strlen(
c->headers))
1271 }
1272
1274 goto fail;
1275
1276 if (
c->n_variants == 0) {
1279 goto fail;
1280 }
1281 /* If the playlist only contained playlists (Master Playlist),
1282 * parse each individual playlist. */
1283 if (
c->n_playlists > 1 ||
c->playlists[0]->n_segments == 0) {
1284 for (i = 0; i <
c->n_playlists; i++) {
1287 goto fail;
1288 }
1289 }
1290
1291 if (
c->variants[0]->playlists[0]->n_segments == 0) {
1294 goto fail;
1295 }
1296
1297 /* If this isn't a live stream, calculate the total duration of the
1298 * stream. */
1299 if (
c->variants[0]->playlists[0]->finished) {
1301 for (i = 0; i <
c->variants[0]->playlists[0]->n_segments; i++)
1302 duration +=
c->variants[0]->playlists[0]->segments[i]->duration;
1304 }
1305
1306 /* Associate renditions with variants */
1307 for (i = 0; i <
c->n_variants; i++) {
1308 struct variant *var =
c->variants[i];
1309
1316 }
1317
1318 /* Open the demuxer for each playlist */
1319 for (i = 0; i <
c->n_playlists; i++) {
1322
1325 goto fail;
1326 }
1327
1329 continue;
1330
1335
1343 /* Free the ctx - it isn't initialized properly at this point,
1344 * so avformat_close_input shouldn't be called. If
1345 * avformat_open_input fails below, it frees and zeros the
1346 * context, so it doesn't need any special treatment like this. */
1350 goto fail;
1351 }
1354
1356 goto fail;
1357
1360 goto fail;
1361
1367 }
1368
1372 goto fail;
1373
1376
1377 /* Create new AVStreams for each stream in this playlist */
1381 if (!st) {
1383 goto fail;
1384 }
1386
1388
1391 else
1393 }
1394
1398
1400 }
1401
1402 /* Create a program for each variant */
1403 for (i = 0; i <
c->n_variants; i++) {
1406
1408 if (!program)
1409 goto fail;
1411
1415 int k;
1416
1419
1421
1422 /* Set variant_bitrate for streams unique to this variant */
1425 }
1426 }
1427 }
1428
1429 return 0;
1430 fail:
1435 }
1436
1438 {
1440 int i, changed = 0;
1441
1442 /* Check if any new streams are needed */
1445
1451 }
1456 changed = 1;
1460 /* catch up */
1464 }
1471 changed = 1;
1473 }
1474 }
1475 return changed;
1476 }
1477
1479 {
1487 else
1489 } else {
1490 /* there have been packets with unknown duration
1491 * since the last id3 tag, should not normally happen */
1493 }
1494
1499
1501 }
1502
1504 {
1507
1509 }
1510
1512 int64_t ts_b,
struct playlist *pls_b)
1513 {
1516
1518 }
1519
1521 {
1523 int ret, i, minplaylist = -1;
1524
1526
1529 /* Make sure we've got one buffered packet from each open playlist
1530 * stream */
1532 while (1) {
1533 int64_t ts_diff;
1536 if (ret < 0) {
1540 break;
1541 } else {
1542 /* stream_index check prevents matching picture attachments etc. */
1544 /* audio elementary streams are id3 timestamped */
1546 }
1547
1552 }
1553
1555 break;
1556
1559
1562 break;
1563 }
1564
1572 break;
1573 }
1574 }
1577 }
1578 }
1579 /* Check if this stream has the packet with the lowest dts */
1581 struct playlist *minpls = minplaylist < 0 ?
1583 if (minplaylist < 0) {
1584 minplaylist = i;
1585 } else {
1586 int64_t dts = pls->
pkt.
dts;
1587 int64_t mindts = minpls->
pkt.
dts;
1588
1591 minplaylist = i;
1592 }
1593 }
1594 }
1595
1596 /* If we got a packet, return it */
1597 if (minplaylist >= 0) {
1602
1607
1608 return 0;
1609 }
1611 }
1612
1614 {
1616
1620 return 0;
1621 }
1622
1624 int64_t timestamp,
int flags)
1625 {
1628 int i, seq_no;
1630
1634
1637
1642
1645
1646 if (0 < duration && duration < seek_timestamp - first_timestamp)
1648
1649 /* find the playlist with the specified stream */
1654 seek_pls = pls;
1655 break;
1656 }
1657 }
1658 /* check if the timestamp is valid for the playlist with the
1659 * specified stream index */
1662
1663 /* set segment now so we do not need to search again below */
1666
1668 /* Reset reading */
1673 }
1677 /* Clear any buffered data */
1679 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1681 /* Flush the packet queue of the subdemuxer. */
1683
1686
1687 if (pls != seek_pls) {
1688 /* set closest segment seq_no for playlists not handled above */
1690 /* seek the playlist to the given position without taking
1691 * keyframes into account since this playlist does not have the
1692 * specified stream where we should look for the keyframes */
1695 }
1696 }
1697
1699
1700 return 0;
1701 }
1702
1704 {
1705 /* Require #EXTM3U at the start, and either one of the ones below
1706 * somewhere for a proper match. */
1707 if (strncmp(p->
buf,
"#EXTM3U", 7))
1708 return 0;
1709 if (strstr(p->
buf,
"#EXT-X-STREAM-INF:") ||
1710 strstr(p->
buf,
"#EXT-X-TARGETDURATION:") ||
1711 strstr(p->
buf,
"#EXT-X-MEDIA-SEQUENCE:"))
1713 return 0;
1714 }
1715
1717 .
name =
"hls,applehttp",
1725 };