1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980
|
/*
* Copyright (C) 2007-2025 Apple Inc. All rights reserved.
* Copyright (C) 2014-2016 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "HTMLMediaElement.h"
#if ENABLE(VIDEO)
#include "ApplicationCacheHost.h"
#include "ApplicationCacheResource.h"
#include "Attribute.h"
#include "AudioTrackConfiguration.h"
#include "AudioTrackList.h"
#include "AudioTrackPrivate.h"
#include "Blob.h"
#include "BlobURL.h"
#include "CSSPropertyNames.h"
#include "CSSValueKeywords.h"
#include "Chrome.h"
#include "ChromeClient.h"
#include "CodecUtilities.h"
#include "CommonAtomStrings.h"
#include "CommonVM.h"
#include "ContentRuleListResults.h"
#include "ContentSecurityPolicy.h"
#include "ContentType.h"
#include "CookieJar.h"
#include "DNS.h"
#include "DeprecatedGlobalSettings.h"
#include "DiagnosticLoggingClient.h"
#include "DiagnosticLoggingKeys.h"
#include "DiagnosticLoggingResultType.h"
#include "Document.h"
#include "DocumentInlines.h"
#include "DocumentLoader.h"
#include "ElementChildIteratorInlines.h"
#include "EventLoop.h"
#include "EventNames.h"
#include "FourCC.h"
#include "FrameLoader.h"
#include "FullscreenManager.h"
#include "HTMLAudioElement.h"
#include "HTMLParserIdioms.h"
#include "HTMLSourceElement.h"
#include "HTMLTrackElement.h"
#include "HTMLVideoElement.h"
#include "ImageOverlay.h"
#include "InbandGenericTextTrack.h"
#include "InbandTextTrackPrivate.h"
#include "InbandWebVTTTextTrack.h"
#include "InspectorInstrumentation.h"
#include "JSDOMException.h"
#include "JSDOMPromiseDeferred.h"
#include "JSHTMLMediaElement.h"
#include "JSMediaControlsHost.h"
#include "LoadableTextTrack.h"
#include "LocalFrame.h"
#include "LocalFrameLoaderClient.h"
#include "LocalFrameView.h"
#include "Logging.h"
#include "MIMETypeRegistry.h"
#include "MediaController.h"
#include "MediaControlsHost.h"
#include "MediaDevices.h"
#include "MediaDocument.h"
#include "MediaError.h"
#include "MediaFragmentURIParser.h"
#include "MediaList.h"
#include "MediaPlayer.h"
#include "MediaQueryEvaluator.h"
#include "MediaResourceLoader.h"
#include "MediaResourceSniffer.h"
#include "NavigatorMediaDevices.h"
#include "NetworkingContext.h"
#include "NodeName.h"
#include "NowPlayingInfo.h"
#include "OriginAccessPatterns.h"
#include "PODIntervalTree.h"
#include "PageGroup.h"
#include "PageInlines.h"
#include "PictureInPictureSupport.h"
#include "PlatformMediaSessionManager.h"
#include "PlatformTextTrack.h"
#include "ProgressTracker.h"
#include "PseudoClassChangeInvalidation.h"
#include "Quirks.h"
#include "RegistrableDomain.h"
#include "RenderBoxInlines.h"
#include "RenderTheme.h"
#include "RenderVideo.h"
#include "RenderView.h"
#include "ResourceLoadInfo.h"
#include "ScriptController.h"
#include "ScriptDisallowedScope.h"
#include "ScriptSourceCode.h"
#include "SecurityOriginData.h"
#include "SecurityPolicy.h"
#include "Settings.h"
#include "ShadowRoot.h"
#include "SleepDisabler.h"
#include "SpatialVideoMetadata.h"
#include "SpeechSynthesis.h"
#include "TextTrackCueList.h"
#include "TextTrackList.h"
#include "TextTrackRepresentation.h"
#include "ThreadableBlobRegistry.h"
#include "TimeRanges.h"
#include "UserContentController.h"
#include "UserGestureIndicator.h"
#include "VideoPlaybackQuality.h"
#include "VideoTrack.h"
#include "VideoTrackConfiguration.h"
#include "VideoTrackList.h"
#include "VideoTrackPrivate.h"
#include "VisibilityAdjustment.h"
#include "WebCoreJSClientData.h"
#include <JavaScriptCore/Uint8Array.h>
#include <limits>
#include <pal/SessionID.h>
#include <wtf/Algorithms.h>
#include <wtf/JSONValues.h>
#include <wtf/Language.h>
#include <wtf/MathExtras.h>
#include <wtf/MemoryPressureHandler.h>
#include <wtf/NativePromise.h>
#include <wtf/Ref.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/text/CString.h>
#include <wtf/text/MakeString.h>
#if USE(AUDIO_SESSION)
#include "AudioSession.h"
#endif
#if ENABLE(WEB_AUDIO)
#include "AudioSourceProvider.h"
#include "MediaElementAudioSourceNode.h"
#endif
#if PLATFORM(IOS)
#include <pal/system/ios/UserInterfaceIdiom.h>
#endif
#if PLATFORM(IOS_FAMILY)
#include "VideoPresentationInterfaceIOS.h"
#include <wtf/RuntimeApplicationChecks.h>
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
#include "RemotePlayback.h"
#include "WebKitPlaybackTargetAvailabilityEvent.h"
#endif
#if ENABLE(MEDIA_SOURCE)
#include "MediaSource.h"
#include "MediaSourceInterfaceMainThread.h"
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
#include "MediaSourceHandle.h"
#include "MediaSourceInterfaceWorker.h"
#endif
#include "LocalDOMWindow.h"
#include "SourceBufferList.h"
#endif
#if ENABLE(MEDIA_STREAM)
#include "MediaStream.h"
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
#include "WebKitMediaKeyNeededEvent.h"
#include "WebKitMediaKeys.h"
#endif
#if ENABLE(ENCRYPTED_MEDIA)
#include "MediaEncryptedEvent.h"
#include "MediaKeys.h"
#endif
#if ENABLE(ENCRYPTED_MEDIA)
#include "NotImplemented.h"
#endif
#if ENABLE(VIDEO_PRESENTATION_MODE)
#include "VideoPresentationModel.h"
#endif
#if ENABLE(MEDIA_SESSION)
#include "MediaSession.h"
#endif
#if ENABLE(MEDIA_SESSION_COORDINATOR)
#include "MediaSessionCoordinator.h"
#endif
#define HTMLMEDIAELEMENT_RELEASE_LOG(fmt, ...) RELEASE_LOG_FORWARDABLE(Media, fmt, identifier().toUInt64(), ##__VA_ARGS__)
namespace WTF {
template <>
struct LogArgument<URL> {
static String toString(const URL& url)
{
#if !LOG_DISABLED
static const unsigned maximumURLLengthForLogging = 512;
if (url.string().length() < maximumURLLengthForLogging)
return url.string();
return makeString(StringView(url.string()).left(maximumURLLengthForLogging), "..."_s);
#else
UNUSED_PARAM(url);
return "[url]"_s;
#endif
}
};
}
namespace WebCore {
typedef PODIntervalTree<MediaTime, TextTrackCue*> TextTrackCueIntervalTree;
WTF_MAKE_TZONE_OR_ISO_ALLOCATED_IMPL(HTMLMediaElement);
static const Seconds SeekRepeatDelay { 100_ms };
static const double SeekTime = 0.2;
static const Seconds ScanRepeatDelay { 1.5_s };
static const double ScanMaximumRate = 8;
static const double AutoplayInterferenceTimeThreshold = 10;
static const Seconds hideMediaControlsAfterEndedDelay { 6_s };
static const Seconds WatchtimeTimerInterval { 5_min };
#if ENABLE(MEDIA_SOURCE)
// URL protocol used to signal that the media source API is being used.
static constexpr auto mediaSourceBlobProtocol = "blob"_s;
#endif
using namespace HTMLNames;
String convertEnumerationToString(HTMLMediaElement::ReadyState enumerationValue)
{
static const std::array<NeverDestroyed<String>, 5> values {
MAKE_STATIC_STRING_IMPL("HAVE_NOTHING"),
MAKE_STATIC_STRING_IMPL("HAVE_METADATA"),
MAKE_STATIC_STRING_IMPL("HAVE_CURRENT_DATA"),
MAKE_STATIC_STRING_IMPL("HAVE_FUTURE_DATA"),
MAKE_STATIC_STRING_IMPL("HAVE_ENOUGH_DATA"),
};
static_assert(static_cast<size_t>(HTMLMediaElementEnums::HAVE_NOTHING) == 0, "HTMLMediaElementEnums::HAVE_NOTHING is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::HAVE_METADATA) == 1, "HTMLMediaElementEnums::HAVE_METADATA is not 1 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::HAVE_CURRENT_DATA) == 2, "HTMLMediaElementEnums::HAVE_CURRENT_DATA is not 2 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::HAVE_FUTURE_DATA) == 3, "HTMLMediaElementEnums::HAVE_FUTURE_DATA is not 3 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::HAVE_ENOUGH_DATA) == 4, "HTMLMediaElementEnums::HAVE_ENOUGH_DATA is not 4 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
String convertEnumerationToString(HTMLMediaElement::NetworkState enumerationValue)
{
static const std::array<NeverDestroyed<String>, 4> values {
MAKE_STATIC_STRING_IMPL("NETWORK_EMPTY"),
MAKE_STATIC_STRING_IMPL("NETWORK_IDLE"),
MAKE_STATIC_STRING_IMPL("NETWORK_LOADING"),
MAKE_STATIC_STRING_IMPL("NETWORK_NO_SOURCE"),
};
static_assert(static_cast<size_t>(HTMLMediaElementEnums::NETWORK_EMPTY) == 0, "HTMLMediaElementEnums::NETWORK_EMPTY is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::NETWORK_IDLE) == 1, "HTMLMediaElementEnums::NETWORK_IDLE is not 1 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::NETWORK_LOADING) == 2, "HTMLMediaElementEnums::NETWORK_LOADING is not 2 as expected");
static_assert(static_cast<size_t>(HTMLMediaElementEnums::NETWORK_NO_SOURCE) == 3, "HTMLMediaElementEnums::NETWORK_NO_SOURCE is not 3 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
String convertEnumerationToString(HTMLMediaElement::AutoplayEventPlaybackState enumerationValue)
{
static const std::array<NeverDestroyed<String>, 4> values {
MAKE_STATIC_STRING_IMPL("None"),
MAKE_STATIC_STRING_IMPL("PreventedAutoplay"),
MAKE_STATIC_STRING_IMPL("StartedWithUserGesture"),
MAKE_STATIC_STRING_IMPL("StartedWithoutUserGesture"),
};
static_assert(static_cast<size_t>(HTMLMediaElement::AutoplayEventPlaybackState::None) == 0, "AutoplayEventPlaybackState::None is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::AutoplayEventPlaybackState::PreventedAutoplay) == 1, "AutoplayEventPlaybackState::PreventedAutoplay is not 1 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::AutoplayEventPlaybackState::StartedWithUserGesture) == 2, "AutoplayEventPlaybackState::StartedWithUserGesture is not 2 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::AutoplayEventPlaybackState::StartedWithoutUserGesture) == 3, "AutoplayEventPlaybackState::StartedWithoutUserGesture is not 3 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
String convertEnumerationToString(HTMLMediaElement::TextTrackVisibilityCheckType enumerationValue)
{
static const std::array<NeverDestroyed<String>, 2> values {
MAKE_STATIC_STRING_IMPL("CheckTextTrackVisibility"),
MAKE_STATIC_STRING_IMPL("AssumeTextTrackVisibilityChanged"),
};
static_assert(static_cast<size_t>(HTMLMediaElement::TextTrackVisibilityCheckType::CheckTextTrackVisibility) == 0, "TextTrackVisibilityCheckType::CheckTextTrackVisibility is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::TextTrackVisibilityCheckType::AssumeTextTrackVisibilityChanged) == 1, "TextTrackVisibilityCheckType::AssumeTextTrackVisibilityChanged is not 1 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
String convertEnumerationToString(HTMLMediaElement::SpeechSynthesisState enumerationValue)
{
static const std::array<NeverDestroyed<String>, 4> values {
MAKE_STATIC_STRING_IMPL("None"),
MAKE_STATIC_STRING_IMPL("Speaking"),
MAKE_STATIC_STRING_IMPL("CompletingExtendedDescription"),
MAKE_STATIC_STRING_IMPL("Paused"),
};
static_assert(static_cast<size_t>(HTMLMediaElement::SpeechSynthesisState::None) == 0, "SpeechSynthesisState::None is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::SpeechSynthesisState::Speaking) == 1, "SpeechSynthesisState::Speaking is not 1 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::SpeechSynthesisState::CompletingExtendedDescription) == 2, "SpeechSynthesisState::CompletingExtendedDescription is not 2 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::SpeechSynthesisState::Paused) == 3, "SpeechSynthesisState::Paused is not 3 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
String convertEnumerationToString(HTMLMediaElement::ControlsState enumerationValue)
{
// None, Initializing, Ready, PartiallyDeinitialized
static const std::array<NeverDestroyed<String>, 4> values {
MAKE_STATIC_STRING_IMPL("None"),
MAKE_STATIC_STRING_IMPL("Initializing"),
MAKE_STATIC_STRING_IMPL("Ready"),
MAKE_STATIC_STRING_IMPL("PartiallyDeinitialized"),
};
static_assert(!static_cast<size_t>(HTMLMediaElement::ControlsState::None), "HTMLMediaElement::None is not 0 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::ControlsState::Initializing) == 1, "HTMLMediaElement::Initializing is not 1 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::ControlsState::Ready) == 2, "HTMLMediaElement::Ready is not 2 as expected");
static_assert(static_cast<size_t>(HTMLMediaElement::ControlsState::PartiallyDeinitialized) == 3, "HTMLMediaElement::PartiallyDeinitialized is not 3 as expected");
ASSERT(static_cast<size_t>(enumerationValue) < std::size(values));
return values[static_cast<size_t>(enumerationValue)];
}
static JSC::JSValue controllerJSValue(JSC::JSGlobalObject& lexicalGlobalObject, JSDOMGlobalObject&, HTMLMediaElement&);
class TrackDisplayUpdateScope {
public:
TrackDisplayUpdateScope(HTMLMediaElement& element)
: m_element(element)
{
m_element->beginIgnoringTrackDisplayUpdateRequests();
}
~TrackDisplayUpdateScope()
{
m_element->endIgnoringTrackDisplayUpdateRequests();
}
private:
WeakRef<HTMLMediaElement> m_element;
};
struct HTMLMediaElement::TrackGroup {
enum GroupKind { CaptionsAndSubtitles, Description, Chapter, Metadata, Other };
TrackGroup(GroupKind kind)
: kind(kind)
{
}
Vector<RefPtr<TextTrack>> tracks;
RefPtr<TextTrack> visibleTrack;
RefPtr<TextTrack> defaultTrack;
GroupKind kind;
bool hasSrcLang { false };
};
HashSet<WeakRef<HTMLMediaElement>>& HTMLMediaElement::allMediaElements()
{
static NeverDestroyed<HashSet<WeakRef<HTMLMediaElement>>> elements;
return elements;
}
struct MediaElementSessionInfo {
WeakPtr<const MediaElementSession> session;
MediaElementSession::PlaybackControlsPurpose purpose;
MonotonicTime timeOfLastUserInteraction;
bool canShowControlsManager : 1;
bool isVisibleInViewportOrFullscreen : 1;
bool isLargeEnoughForMainContent : 1;
bool isLongEnoughForMainContent : 1;
bool isPlayingAudio : 1;
bool hasEverNotifiedAboutPlaying : 1;
};
static MediaElementSessionInfo mediaElementSessionInfoForSession(const MediaElementSession& session, MediaElementSession::PlaybackControlsPurpose purpose)
{
Ref element = session.element();
return {
&session,
purpose,
session.mostRecentUserInteractionTime(),
session.canShowControlsManager(purpose),
element->isFullscreen() || element->isVisibleInViewport(),
session.isLargeEnoughForMainContent(MediaSessionMainContentPurpose::MediaControls),
session.isLongEnoughForMainContent(),
element->isPlaying() && element->hasAudio() && !element->muted(),
element->hasEverNotifiedAboutPlaying()
};
}
static bool preferMediaControlsForCandidateSessionOverOtherCandidateSession(const MediaElementSessionInfo& session, const MediaElementSessionInfo& otherSession)
{
MediaElementSession::PlaybackControlsPurpose purpose = session.purpose;
ASSERT(purpose == otherSession.purpose);
// For the controls manager and MediaSession, prioritize visible media over offscreen media.
if ((purpose == MediaElementSession::PlaybackControlsPurpose::ControlsManager || purpose == MediaElementSession::PlaybackControlsPurpose::MediaSession)
&& session.isVisibleInViewportOrFullscreen != otherSession.isVisibleInViewportOrFullscreen)
return session.isVisibleInViewportOrFullscreen;
// For Now Playing and MediaSession, prioritize elements that would normally satisfy main content.
if ((purpose == MediaElementSession::PlaybackControlsPurpose::NowPlaying || purpose == MediaElementSession::PlaybackControlsPurpose::MediaSession)
&& session.isLargeEnoughForMainContent != otherSession.isLargeEnoughForMainContent)
return session.isLargeEnoughForMainContent;
// For MediaSession, prioritize elements that have been played before.
if (purpose == MediaElementSession::PlaybackControlsPurpose::MediaSession
&& session.hasEverNotifiedAboutPlaying != otherSession.hasEverNotifiedAboutPlaying)
return session.hasEverNotifiedAboutPlaying;
// As a tiebreaker, prioritize elements that the user recently interacted with.
return session.timeOfLastUserInteraction > otherSession.timeOfLastUserInteraction;
}
static bool mediaSessionMayBeConfusedWithMainContent(const MediaElementSessionInfo& session, MediaElementSession::PlaybackControlsPurpose purpose)
{
if (purpose == MediaElementSession::PlaybackControlsPurpose::MediaSession)
return false;
if (purpose == MediaElementSession::PlaybackControlsPurpose::NowPlaying)
return session.isPlayingAudio;
if (!session.isVisibleInViewportOrFullscreen)
return false;
if (!session.isLargeEnoughForMainContent)
return false;
// Even if this video is not a candidate, if it is visible to the user and large enough
// to be main content, it poses a risk for being confused with main content.
return true;
}
static bool defaultVolumeLocked()
{
#if PLATFORM(IOS)
return PAL::currentUserInterfaceIdiomIsSmallScreen();
#else
return false;
#endif
}
static bool isInWindowOrStandardFullscreen(HTMLMediaElementEnums::VideoFullscreenMode mode)
{
return mode == HTMLMediaElementEnums::VideoFullscreenModeStandard || mode == HTMLMediaElementEnums::VideoFullscreenModeInWindow;
}
struct HTMLMediaElement::CueData {
WTF_MAKE_STRUCT_FAST_ALLOCATED;
TextTrackCueIntervalTree cueTree;
CueList currentlyActiveCues;
};
class PausableIntervalTimer final : public TimerBase {
WTF_MAKE_TZONE_ALLOCATED(PausableIntervalTimer);
public:
PausableIntervalTimer(Seconds interval, Function<void()>&& function)
: m_interval { interval }
, m_function { WTFMove(function) }
, m_remainingInterval { interval }
{
}
void start()
{
m_startTime = MonotonicTime::now();
TimerBase::start(m_remainingInterval, m_interval);
}
void stop()
{
m_remainingInterval = m_interval;
TimerBase::stop();
}
void pause()
{
if (!isActive())
return;
auto partialInterval = MonotonicTime::now() - m_startTime;
m_remainingInterval -= partialInterval;
if (m_remainingInterval <= 0_s)
m_remainingInterval = m_interval;
TimerBase::stop();
}
Seconds secondsRemaining() const
{
if (!isActive())
return m_remainingInterval;
auto partialInterval = MonotonicTime::now() - m_startTime;
return std::max(0_s, m_remainingInterval - partialInterval);
}
Seconds secondsCompleted() const
{
return m_interval - secondsRemaining();
}
private:
void start(Seconds, Seconds) = delete;
void startRepeating(Seconds) = delete;
void startOneShot(Seconds) = delete;
void fired() final
{
m_remainingInterval = 0_s;
m_function();
m_remainingInterval = m_interval;
}
Seconds m_interval;
Function<void()> m_function;
Seconds m_remainingInterval;
MonotonicTime m_startTime;
};
WTF_MAKE_TZONE_ALLOCATED_IMPL(PausableIntervalTimer);
HTMLMediaElement::HTMLMediaElement(const QualifiedName& tagName, Document& document, bool createdByParser)
: HTMLElement(tagName, document, { TypeFlag::HasCustomStyleResolveCallbacks, TypeFlag::HasDidMoveToNewDocument })
, ActiveDOMObject(document)
, m_progressEventTimer(*this, &HTMLMediaElement::progressEventTimerFired)
, m_playbackProgressTimer(*this, &HTMLMediaElement::playbackProgressTimerFired)
, m_scanTimer(*this, &HTMLMediaElement::scanTimerFired)
, m_playbackControlsManagerBehaviorRestrictionsTimer(*this, &HTMLMediaElement::playbackControlsManagerBehaviorRestrictionsTimerFired)
, m_seekToPlaybackPositionEndedTimer(*this, &HTMLMediaElement::seekToPlaybackPositionEndedTimerFired)
, m_checkPlaybackTargetCompatibilityTimer(*this, &HTMLMediaElement::checkPlaybackTargetCompatibility)
, m_currentIdentifier(MediaUniqueIdentifier::generate())
, m_lastTimeUpdateEventMovieTime(MediaTime::positiveInfiniteTime())
, m_firstTimePlaying(true)
, m_playing(false)
, m_isWaitingUntilMediaCanStart(false)
, m_shouldDelayLoadEvent(false)
, m_haveFiredLoadedData(false)
, m_inActiveDocument(true)
, m_autoplaying(true)
, m_muted(false)
, m_explicitlyMuted(false)
, m_paused(true)
, m_seeking(false)
, m_seekRequested(false)
, m_wasPlayingBeforeSeeking(false)
, m_sentStalledEvent(false)
, m_sentEndEvent(false)
, m_pausedInternal(false)
, m_closedCaptionsVisible(false)
, m_completelyLoaded(false)
, m_havePreparedToPlay(false)
, m_parsingInProgress(createdByParser)
, m_elementIsHidden(document.hidden())
, m_receivedLayoutSizeChanged(false)
, m_hasEverNotifiedAboutPlaying(false)
, m_hasEverHadAudio(false)
, m_hasEverHadVideo(false)
, m_mediaControlsDependOnPageScaleFactor(false)
, m_haveSetUpCaptionContainer(false)
, m_isScrubbingRemotely(false)
, m_waitingToEnterFullscreen(false)
, m_changingVideoFullscreenMode(false)
, m_showPoster(true)
, m_tracksAreReady(true)
, m_haveVisibleTextTrack(false)
, m_processingPreferenceChange(false)
, m_volumeLocked(defaultVolumeLocked())
, m_opaqueRootProvider([this] { return opaqueRoot(); })
#if USE(AUDIO_SESSION)
, m_categoryAtMostRecentPlayback(AudioSessionCategory::None)
, m_modeAtMostRecentPlayback(AudioSessionMode::Default)
#endif
#if HAVE(SPATIAL_TRACKING_LABEL)
, m_defaultSpatialTrackingLabelChangedObserver([this] (const String& defaultSpatialTrackingLabel) { defaultSpatialTrackingLabelChanged(defaultSpatialTrackingLabel); })
#endif
#if !RELEASE_LOG_DISABLED
, m_logger(&document.logger())
, m_logIdentifier(uniqueLogIdentifier())
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
, m_remote(RemotePlayback::create(*this))
#endif
{
RefPtr protectedMainFrameDocument = document.mainFrameDocument();
if (protectedMainFrameDocument) {
m_shouldAudioPlaybackRequireUserGesture = protectedMainFrameDocument->requiresUserGestureForAudioPlayback() && !processingUserGestureForMedia();
m_shouldVideoPlaybackRequireUserGesture = protectedMainFrameDocument->requiresUserGestureForVideoPlayback() && !processingUserGestureForMedia();
}
allMediaElements().add(*this);
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_CONSTRUCTOR);
InspectorInstrumentation::addEventListenersToNode(*this);
}
void HTMLMediaElement::initializeMediaSession()
{
ASSERT(!m_mediaSession);
m_mediaSession = makeUnique<MediaElementSession>(*this);
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForFullscreen);
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePageConsentToLoadMedia);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToAutoplayToExternalDevice);
#endif
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePlaybackToControlControlsManager);
Ref document = this->document();
RefPtr page = document->page();
if (document->settings().invisibleAutoplayNotPermitted())
m_mediaSession->addBehaviorRestriction(MediaElementSession::InvisibleAutoplayNotPermitted);
if (document->settings().requiresPageVisibilityToPlayAudio())
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePageVisibilityToPlayAudio);
if (document->ownerElement() || !document->isMediaDocument()) {
if (m_shouldVideoPlaybackRequireUserGesture) {
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoRateChange);
if (document->settings().requiresUserGestureToLoadVideo())
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForLoad);
}
if (page && page->isLowPowerModeEnabled())
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoDueToLowPowerMode);
if (page && page->isAggressiveThermalMitigationEnabled())
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoDueToAggressiveThermalMitigation);
if (m_shouldAudioPlaybackRequireUserGesture)
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForAudioRateChange);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (m_shouldVideoPlaybackRequireUserGesture || m_shouldAudioPlaybackRequireUserGesture)
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToShowPlaybackTargetPicker);
#endif
if (!document->mediaDataLoadsAutomatically() && !document->quirks().needsPreloadAutoQuirk())
m_mediaSession->addBehaviorRestriction(MediaElementSession::AutoPreloadingNotPermitted);
if (document->settings().mainContentUserGestureOverrideEnabled())
m_mediaSession->addBehaviorRestriction(MediaElementSession::OverrideUserGestureRequirementForMainContent);
}
#if PLATFORM(IOS_FAMILY)
if (!document->requiresUserGestureForVideoPlayback() && !document->requiresUserGestureForAudioPlayback()) {
// Relax RequireUserGestureForFullscreen when requiresUserGestureForVideoPlayback and requiresUserGestureForAudioPlayback is not set:
m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequireUserGestureForFullscreen);
}
#endif
if (document->settings().requiresPageVisibilityForVideoToBeNowPlaying())
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePageVisibilityForVideoToBeNowPlaying);
registerWithDocument(document);
#if USE(AUDIO_SESSION) && PLATFORM(MAC)
AudioSession::sharedSession().addConfigurationChangeObserver(*this);
#endif
m_mediaSession->clientWillBeginAutoplaying();
}
HTMLMediaElement::~HTMLMediaElement()
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_DESTRUCTOR);
invalidateWatchtimeTimer();
invalidateBufferingStopwatch();
beginIgnoringTrackDisplayUpdateRequests();
if (RefPtr textTracks = m_textTracks) {
for (unsigned i = 0; i < textTracks->length(); ++i) {
RefPtr track = textTracks->item(i);
track->clearClient(*this);
}
}
if (RefPtr audioTracks = m_audioTracks) {
for (unsigned i = 0; i < audioTracks->length(); ++i) {
RefPtr track = audioTracks->item(i);
track->clearClient(*this);
}
}
if (RefPtr videoTracks = m_videoTracks) {
for (unsigned i = 0; i < videoTracks->length(); ++i) {
RefPtr track = videoTracks->item(i);
track->clearClient(*this);
}
}
allMediaElements().remove(*this);
setShouldDelayLoadEvent(false);
unregisterWithDocument(Ref<Document> { document() });
#if USE(AUDIO_SESSION) && PLATFORM(MAC)
AudioSession::sharedSession().removeConfigurationChangeObserver(*this);
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (hasTargetAvailabilityListeners()) {
m_hasPlaybackTargetAvailabilityListeners = false;
if (m_mediaSession)
m_mediaSession->setHasPlaybackTargetAvailabilityListeners(false);
updateMediaState();
}
#endif
if (RefPtr mediaController = m_mediaController) {
mediaController->removeMediaElement(*this);
m_mediaController = nullptr;
}
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = std::exchange(m_mediaSource, { }))
mediaSource->elementIsShuttingDown();
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
webkitSetMediaKeys(nullptr);
#endif
#if ENABLE(ENCRYPTED_MEDIA)
if (m_mediaKeys) {
m_mediaKeys->detachCDMClient(*this);
if (RefPtr player = m_player)
player->cdmInstanceDetached(m_mediaKeys->protectedCDMInstance());
}
#endif
if (m_isolatedWorld)
m_isolatedWorld->clearWrappers();
m_completelyLoaded = true;
cancelSniffer();
if (RefPtr player = m_player) {
player->invalidate();
m_player = nullptr;
}
m_mediaSession = nullptr;
schedulePlaybackControlsManagerUpdate();
}
std::optional<MediaPlayerIdentifier> HTMLMediaElement::playerIdentifier() const
{
return m_player ? std::optional { m_player->identifier() } : std::nullopt;
}
RefPtr<HTMLMediaElement> HTMLMediaElement::bestMediaElementForRemoteControls(MediaElementSession::PlaybackControlsPurpose purpose, const Document* document)
{
auto selectedSession = PlatformMediaSessionManager::singleton().bestEligibleSessionForRemoteControls([&document] (auto& session) {
auto* mediaElementSession = dynamicDowncast<MediaElementSession>(session);
return mediaElementSession && (!document || &mediaElementSession->element().document() == document);
}, purpose);
return selectedSession ? RefPtr { &downcast<MediaElementSession>(selectedSession.get())->element() } : nullptr;
}
bool HTMLMediaElement::isNowPlayingEligible() const
{
RefPtr page = document().page();
if (page && page->mediaPlaybackIsSuspended())
return false;
return m_mediaSession->hasNowPlayingInfo();
}
std::optional<NowPlayingInfo> HTMLMediaElement::nowPlayingInfo() const
{
return m_mediaSession->computeNowPlayingInfo();
}
WeakPtr<PlatformMediaSession> HTMLMediaElement::selectBestMediaSession(const Vector<WeakPtr<PlatformMediaSession>>& sessions, PlatformMediaSession::PlaybackControlsPurpose purpose)
{
if (!sessions.size())
return nullptr;
Vector<MediaElementSessionInfo> candidateSessions;
bool atLeastOneNonCandidateMayBeConfusedForMainContent = false;
for (auto& session : sessions) {
auto mediaElementSessionInfo = mediaElementSessionInfoForSession(*downcast<MediaElementSession>(session.get()), purpose);
if (mediaElementSessionInfo.canShowControlsManager)
candidateSessions.append(mediaElementSessionInfo);
else if (mediaSessionMayBeConfusedWithMainContent(mediaElementSessionInfo, purpose))
atLeastOneNonCandidateMayBeConfusedForMainContent = true;
}
if (!candidateSessions.size())
return nullptr;
std::sort(candidateSessions.begin(), candidateSessions.end(), preferMediaControlsForCandidateSessionOverOtherCandidateSession);
auto strongestSessionCandidate = candidateSessions.first();
if (!strongestSessionCandidate.isVisibleInViewportOrFullscreen && !strongestSessionCandidate.isPlayingAudio && atLeastOneNonCandidateMayBeConfusedForMainContent)
return nullptr;
return strongestSessionCandidate.session.get();
}
void HTMLMediaElement::registerWithDocument(Document& document)
{
document.registerMediaElement(*this);
mediaSession().registerWithDocument(document);
if (m_isWaitingUntilMediaCanStart)
document.addMediaCanStartListener(*this);
document.registerForVisibilityStateChangedCallbacks(*this);
if (m_requireCaptionPreferencesChangedCallbacks)
document.registerForCaptionPreferencesChangedCallbacks(*this);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
document.registerForDocumentSuspensionCallbacks(*this);
#endif
document.addAudioProducer(*this);
}
void HTMLMediaElement::unregisterWithDocument(Document& document)
{
document.unregisterMediaElement(*this);
#if ENABLE(SPEECH_SYNTHESIS)
if (RefPtr speechSynthesis = m_speechSynthesis) {
speechSynthesis->cancel();
m_speechSynthesis = nullptr;
}
#endif
if (m_mediaSession)
m_mediaSession->unregisterWithDocument(document);
if (m_isWaitingUntilMediaCanStart)
document.removeMediaCanStartListener(*this);
document.unregisterForVisibilityStateChangedCallbacks(*this);
if (m_requireCaptionPreferencesChangedCallbacks)
document.unregisterForCaptionPreferencesChangedCallbacks(*this);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
document.unregisterForDocumentSuspensionCallbacks(*this);
#endif
document.removeAudioProducer(*this);
}
void HTMLMediaElement::didMoveToNewDocument(Document& oldDocument, Document& newDocument)
{
ActiveDOMObject::didMoveToNewDocument(newDocument);
ALWAYS_LOG(LOGIDENTIFIER);
ASSERT_WITH_SECURITY_IMPLICATION(&document() == &newDocument);
if (m_shouldDelayLoadEvent) {
oldDocument.decrementLoadEventDelayCount();
newDocument.incrementLoadEventDelayCount();
}
if (RefPtr audioTracks = m_audioTracks)
audioTracks->didMoveToNewDocument(newDocument);
if (RefPtr textTracks = m_textTracks)
textTracks->didMoveToNewDocument(newDocument);
if (RefPtr videoTracks = m_videoTracks)
videoTracks->didMoveToNewDocument(newDocument);
unregisterWithDocument(oldDocument);
registerWithDocument(newDocument);
HTMLElement::didMoveToNewDocument(oldDocument, newDocument);
updateShouldAutoplay();
visibilityStateChanged();
}
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
void HTMLMediaElement::prepareForDocumentSuspension()
{
mediaSession().unregisterWithDocument(protectedDocument());
}
void HTMLMediaElement::resumeFromDocumentSuspension()
{
mediaSession().registerWithDocument(protectedDocument());
updateShouldAutoplay();
}
#endif
bool HTMLMediaElement::supportsFocus() const
{
if (document().isMediaDocument())
return false;
// If no controls specified, we should still be able to focus the element if it has tabIndex.
return controls() || HTMLElement::supportsFocus();
}
bool HTMLMediaElement::isInteractiveContent() const
{
return controls();
}
void HTMLMediaElement::removeAllEventListeners()
{
Element::removeAllEventListeners();
if (RefPtr audioTracks = m_audioTracks)
audioTracks->removeAllEventListeners();
if (RefPtr textTracks = m_textTracks)
textTracks->removeAllEventListeners();
if (RefPtr videoTracks = m_videoTracks)
videoTracks->removeAllEventListeners();
}
void HTMLMediaElement::attributeChanged(const QualifiedName& name, const AtomString& oldValue, const AtomString& newValue, AttributeModificationReason attributeModificationReason)
{
switch (name.nodeName()) {
case AttributeNames::idAttr:
m_id = newValue;
break;
case AttributeNames::srcAttr:
// https://html.spec.whatwg.org/multipage/embedded-content.html#location-of-the-media-resource
// Location of the Media Resource
// 12 February 2017
// If a src attribute of a media element is set or changed, the user
// agent must invoke the media element's media element load algorithm.
if (!newValue.isNull())
prepareForLoad();
return;
case AttributeNames::controlsAttr:
configureMediaControls();
return;
case AttributeNames::loopAttr:
updateSleepDisabling();
if (RefPtr player = m_player)
player->isLoopingChanged();
return;
case AttributeNames::preloadAttr:
if (equalLettersIgnoringASCIICase(newValue, "none"_s))
m_preload = MediaPlayer::Preload::None;
else if (equalLettersIgnoringASCIICase(newValue, "metadata"_s))
m_preload = MediaPlayer::Preload::MetaData;
else {
// The spec does not define an "invalid value default" but "auto" is suggested as the
// "missing value default", so use it for everything except "none" and "metadata"
m_preload = MediaPlayer::Preload::Auto;
}
// The attribute must be ignored if the autoplay attribute is present
if (!autoplay() && !m_havePreparedToPlay && m_player)
RefPtr { m_player }->setPreload(mediaSession().effectivePreloadForElement());
return;
case AttributeNames::mediagroupAttr:
setMediaGroup(newValue);
return;
case AttributeNames::autoplayAttr:
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture();
return;
case AttributeNames::titleAttr:
if (m_mediaSession)
m_mediaSession->clientCharacteristicsChanged(false);
return;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
case AttributeNames::webkitwirelessvideoplaybackdisabledAttr:
mediaSession().setWirelessVideoPlaybackDisabled(newValue != nullAtom());
FALLTHROUGH;
case AttributeNames::disableremoteplaybackAttr:
case AttributeNames::webkitairplayAttr:
isWirelessPlaybackTargetDisabledChanged();
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = m_mediaSource; mediaSource && isWirelessPlaybackTargetDisabled())
mediaSource->openIfDeferredOpen();
#endif
break;
#endif
default:
break;
}
HTMLElement::attributeChanged(name, oldValue, newValue, attributeModificationReason);
}
void HTMLMediaElement::finishParsingChildren()
{
HTMLElement::finishParsingChildren();
m_parsingInProgress = false;
if (childrenOfType<HTMLTrackElement>(*this).first())
scheduleConfigureTextTracks();
}
bool HTMLMediaElement::rendererIsNeeded(const RenderStyle& style)
{
return controls() && HTMLElement::rendererIsNeeded(style);
}
RenderPtr<RenderElement> HTMLMediaElement::createElementRenderer(RenderStyle&& style, const RenderTreePosition&)
{
return createRenderer<RenderMedia>(RenderObject::Type::Media, *this, WTFMove(style));
}
bool HTMLMediaElement::childShouldCreateRenderer(const Node& child) const
{
return hasShadowRootParent(child) && HTMLElement::childShouldCreateRenderer(child);
}
Node::InsertedIntoAncestorResult HTMLMediaElement::insertedIntoAncestor(InsertionType insertionType, ContainerNode& parentOfInsertedTree)
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_INSERTEDINTOANCESTOR);
HTMLElement::insertedIntoAncestor(insertionType, parentOfInsertedTree);
if (insertionType.connectedToDocument)
setInActiveDocument(true);
if (!insertionType.connectedToDocument)
return InsertedIntoAncestorResult::Done;
return InsertedIntoAncestorResult::NeedsPostInsertionCallback;
}
void HTMLMediaElement::didFinishInsertingNode()
{
Ref protectedThis { *this }; // prepareForLoad may result in a 'beforeload' event, which can make arbitrary DOM mutations.
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_DIDFINISHINSERTINGNODE);
if (m_inActiveDocument && m_networkState == NETWORK_EMPTY && !attributeWithoutSynchronization(srcAttr).isEmpty())
prepareForLoad();
visibilityAdjustmentStateDidChange();
if (!m_explicitlyMuted) {
m_explicitlyMuted = true;
m_muted = hasAttributeWithoutSynchronization(mutedAttr);
mediaSession().canProduceAudioChanged();
}
configureMediaControls();
}
void HTMLMediaElement::pauseAfterDetachedTask()
{
// If we were re-inserted into an active document, no need to pause.
if (m_inActiveDocument)
return;
if (m_videoFullscreenMode != VideoFullscreenModePictureInPicture && m_networkState > NETWORK_EMPTY && !m_wasInterruptedForInvisibleAutoplay)
pause();
if (m_videoFullscreenMode == VideoFullscreenModeStandard && !document().quirks().needsNowPlayingFullscreenSwapQuirk())
exitFullscreen();
if (m_controlsState == ControlsState::Initializing || m_controlsState == ControlsState::Ready) {
// Call MediaController.deinitialize() to get rid of circular references.
bool isDeinitialized = setupAndCallJS([this](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = controllerValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto functionValue = controllerObject->get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "deinitialize"_s));
if (UNLIKELY(scope.exception()) || functionValue.isUndefinedOrNull())
return false;
auto* function = functionValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto callData = JSC::getCallData(function);
if (callData.type == JSC::CallData::Type::None)
return false;
auto resultValue = JSC::call(&lexicalGlobalObject, function, callData, controllerObject, JSC::MarkedArgumentBuffer());
RETURN_IF_EXCEPTION(scope, false);
return resultValue.toBoolean(&lexicalGlobalObject);
});
m_controlsState = isDeinitialized ? ControlsState::PartiallyDeinitialized : m_controlsState;
}
if (!m_player)
return;
size_t extraMemoryCost = m_player->extraMemoryCost();
if (extraMemoryCost > m_reportedExtraMemoryCost) {
JSC::VM& vm = commonVM();
JSC::JSLockHolder lock(vm);
size_t extraMemoryCostDelta = extraMemoryCost - m_reportedExtraMemoryCost;
m_reportedExtraMemoryCost = extraMemoryCost;
// FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
// https://bugs.webkit.org/show_bug.cgi?id=142595
vm.heap.deprecatedReportExtraMemory(extraMemoryCostDelta);
}
}
void HTMLMediaElement::removedFromAncestor(RemovalType removalType, ContainerNode& oldParentOfRemovedTree)
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_REMOVEDFROMANCESTOR);
setInActiveDocument(false);
if (removalType.disconnectedFromDocument) {
// Pause asynchronously to let the operation that removed us finish, in case we get inserted back into a document.
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
if (!isContextStopped())
pauseAfterDetachedTask();
});
}
if (m_mediaSession)
m_mediaSession->clientCharacteristicsChanged(false);
HTMLElement::removedFromAncestor(removalType, oldParentOfRemovedTree);
visibilityAdjustmentStateDidChange();
}
void HTMLMediaElement::willAttachRenderers()
{
ASSERT(!renderer());
}
inline void HTMLMediaElement::updateRenderer()
{
if (CheckedPtr renderer = this->renderer())
renderer->updateFromElement();
if (RefPtr mediaControlsHost = m_mediaControlsHost)
mediaControlsHost->updateCaptionDisplaySizes();
if (RefPtr player = m_player)
player->playerContentBoxRectChanged(mediaPlayerContentBoxRect());
}
void HTMLMediaElement::didAttachRenderers()
{
if (CheckedPtr renderer = this->renderer()) {
renderer->updateFromElement();
if (m_mediaSession && m_mediaSession->wantsToObserveViewportVisibilityForAutoplay())
renderer->registerForVisibleInViewportCallback();
}
scheduleUpdateShouldAutoplay();
}
void HTMLMediaElement::willDetachRenderers()
{
if (CheckedPtr renderer = this->renderer())
renderer->unregisterForVisibleInViewportCallback();
}
void HTMLMediaElement::didDetachRenderers()
{
scheduleUpdateShouldAutoplay();
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
// If we detach a media element from a renderer, we may no longer need the MediaPlayerPrivate
// to vend a PlatformLayer. However, the renderer may be torn down and re-attached during a
// single run-loop as a result of layout or due to the element being re-parented.
computeAcceleratedRenderingStateAndUpdateMediaPlayer();
});
}
void HTMLMediaElement::didRecalcStyle(Style::Change)
{
updateRenderer();
}
void HTMLMediaElement::scheduleNextSourceChild()
{
// Schedule the timer to try the next <source> element WITHOUT resetting state ala prepareForLoad.
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resourceSelectionTaskCancellationGroup, std::bind(&HTMLMediaElement::loadNextSourceChild, this));
}
void HTMLMediaElement::mediaPlayerActiveSourceBuffersChanged()
{
checkForAudioAndVideo();
}
void HTMLMediaElement::scheduleEvent(const AtomString& eventName)
{
scheduleEvent(Event::create(eventName, Event::CanBubble::No, Event::IsCancelable::Yes));
}
void HTMLMediaElement::scheduleEvent(Ref<Event>&& event)
{
queueCancellableTaskToDispatchEvent(*this, TaskSource::MediaElement, m_asyncEventsCancellationGroup, WTFMove(event));
}
void HTMLMediaElement::scheduleResolvePendingPlayPromises()
{
if (m_pendingPlayPromises.isEmpty())
return;
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, pendingPlayPromises = WTFMove(m_pendingPlayPromises)] () mutable {
if (!isContextStopped())
resolvePendingPlayPromises(WTFMove(pendingPlayPromises));
});
}
void HTMLMediaElement::scheduleRejectPendingPlayPromises(Ref<DOMException>&& error)
{
if (m_pendingPlayPromises.isEmpty())
return;
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, error = WTFMove(error), pendingPlayPromises = WTFMove(m_pendingPlayPromises)] () mutable {
if (!isContextStopped())
rejectPendingPlayPromises(WTFMove(pendingPlayPromises), WTFMove(error));
});
}
void HTMLMediaElement::rejectPendingPlayPromises(PlayPromiseVector&& pendingPlayPromises, Ref<DOMException>&& error)
{
for (auto& promise : pendingPlayPromises)
promise.rejectType<IDLInterface<DOMException>>(error);
}
void HTMLMediaElement::resolvePendingPlayPromises(PlayPromiseVector&& pendingPlayPromises)
{
for (auto& promise : pendingPlayPromises)
promise.resolve();
}
void HTMLMediaElement::scheduleNotifyAboutPlaying()
{
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, pendingPlayPromises = WTFMove(m_pendingPlayPromises)] () mutable {
if (!isContextStopped())
notifyAboutPlaying(WTFMove(pendingPlayPromises));
});
}
void HTMLMediaElement::notifyAboutPlaying(PlayPromiseVector&& pendingPlayPromises)
{
Ref protectedThis { *this }; // The 'playing' event can make arbitrary DOM mutations.
m_playbackStartedTime = currentMediaTime().toDouble();
m_hasEverNotifiedAboutPlaying = true;
dispatchEvent(Event::create(eventNames().playingEvent, Event::CanBubble::No, Event::IsCancelable::Yes));
resolvePendingPlayPromises(WTFMove(pendingPlayPromises));
schedulePlaybackControlsManagerUpdate();
}
bool HTMLMediaElement::hasEverNotifiedAboutPlaying() const
{
return m_hasEverNotifiedAboutPlaying;
}
void HTMLMediaElement::checkPlaybackTargetCompatibility()
{
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (!m_isPlayingToWirelessTarget || m_player->canPlayToWirelessPlaybackTarget())
return;
auto tryToSwitchEngines = !m_remotePlaybackConfiguration && m_loadState == LoadingFromSourceElement;
if (tryToSwitchEngines) {
m_remotePlaybackConfiguration = { currentMediaTime(), playbackRate(), paused() };
tryToSwitchEngines = havePotentialSourceChild();
}
if (!tryToSwitchEngines) {
ERROR_LOG(LOGIDENTIFIER, "player incompatible, calling setShouldPlayToPlaybackTarget(false)");
m_failedToPlayToWirelessTarget = true;
m_remotePlaybackConfiguration = { };
RefPtr { m_player }->setShouldPlayToPlaybackTarget(false);
return;
}
scheduleNextSourceChild();
#endif
}
MediaError* HTMLMediaElement::error() const
{
return m_error.get();
}
void HTMLMediaElement::setSrcObject(MediaProvider&& mediaProvider)
{
// FIXME: Setting the srcObject attribute may cause other changes to the media element's internal state:
// Specifically, if srcObject is specified, the UA must use it as the source of media, even if the src
// attribute is also set or children are present. If the value of srcObject is replaced or set to null
// the UA must re-run the media element load algorithm.
//
// https://bugs.webkit.org/show_bug.cgi?id=124896
// https://www.w3.org/TR/html51/semantics-embedded-content.html#dom-htmlmediaelement-srcobject
// 4.7.14.2. Location of the media resource
// srcObject: On setting, it must set the element’s assigned media provider object to the new
// value, and then invoke the element’s media element load algorithm.
INFO_LOG(LOGIDENTIFIER);
m_mediaProvider = WTFMove(mediaProvider);
#if ENABLE(MEDIA_STREAM)
m_mediaStreamSrcObject = nullptr;
#endif
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
m_blob = nullptr;
#if ENABLE(MEDIA_SOURCE)
if (m_mediaProvider && std::holds_alternative<RefPtr<MediaSource>>(*m_mediaProvider)) {
RefPtr mediaSource = std::get<RefPtr<MediaSource>>(*m_mediaProvider);
mediaSource->setAsSrcObject(true);
}
#endif
prepareForLoad();
}
void HTMLMediaElement::setCrossOrigin(const AtomString& value)
{
setAttributeWithoutSynchronization(crossoriginAttr, value);
}
String HTMLMediaElement::crossOrigin() const
{
return parseCORSSettingsAttribute(attributeWithoutSynchronization(crossoriginAttr));
}
HTMLMediaElement::NetworkState HTMLMediaElement::networkState() const
{
return m_networkState;
}
String HTMLMediaElement::canPlayType(const String& mimeType) const
{
MediaEngineSupportParameters parameters;
ContentType contentType(mimeType);
parameters.type = contentType;
parameters.contentTypesRequiringHardwareSupport = mediaContentTypesRequiringHardwareSupport();
parameters.allowedMediaContainerTypes = allowedMediaContainerTypes();
parameters.allowedMediaCodecTypes = allowedMediaCodecTypes();
parameters.allowedMediaVideoCodecIDs = allowedMediaVideoCodecIDs();
parameters.allowedMediaAudioCodecIDs = allowedMediaAudioCodecIDs();
parameters.allowedMediaCaptionFormatTypes = allowedMediaCaptionFormatTypes();
parameters.supportsLimitedMatroska = limitedMatroskaSupportEnabled();
MediaPlayer::SupportsType support = MediaPlayer::supportsType(parameters);
String canPlay;
// 4.8.10.3
switch (support)
{
case MediaPlayer::SupportsType::IsNotSupported:
canPlay = emptyString();
break;
case MediaPlayer::SupportsType::MayBeSupported:
canPlay = "maybe"_s;
break;
case MediaPlayer::SupportsType::IsSupported:
canPlay = "probably"_s;
break;
}
ALWAYS_LOG(LOGIDENTIFIER, mimeType, ": ", canPlay);
return canPlay;
}
WallTime HTMLMediaElement::getStartDate() const
{
if (!m_player)
return WallTime::nan();
return WallTime::fromRawSeconds(m_player->getStartDate().toDouble());
}
void HTMLMediaElement::load()
{
Ref protectedThis { *this }; // prepareForLoad may result in a 'beforeload' event, which can make arbitrary DOM mutations.
INFO_LOG(LOGIDENTIFIER);
if (m_videoFullscreenMode == VideoFullscreenModePictureInPicture && document().quirks().requiresUserGestureToLoadInPictureInPicture() && !document().processingUserGestureForMedia())
return;
prepareForLoad();
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resourceSelectionTaskCancellationGroup, std::bind(&HTMLMediaElement::prepareToPlay, this));
}
void HTMLMediaElement::prepareForLoad()
{
// https://html.spec.whatwg.org/multipage/embedded-content.html#media-element-load-algorithm
// The Media Element Load Algorithm
// 12 February 2017
ALWAYS_LOG(LOGIDENTIFIER, "gesture = ", processingUserGestureForMedia());
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture();
// 1 - Abort any already-running instance of the resource selection algorithm for this element.
// Perform the cleanup required for the resource load algorithm to run.
stopPeriodicTimers();
m_resourceSelectionTaskCancellationGroup.cancel();
// FIXME: Figure out appropriate place to reset LoadTextTrackResource if necessary and set m_pendingActionFlags to 0 here.
m_sentEndEvent = false;
m_sentStalledEvent = false;
m_haveFiredLoadedData = false;
m_completelyLoaded = false;
m_havePreparedToPlay = false;
m_currentIdentifier = MediaUniqueIdentifier::generate();
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
m_failedToPlayToWirelessTarget = false;
#endif
m_loadState = WaitingForSource;
m_currentSourceNode = nullptr;
#if ENABLE(ENCRYPTED_MEDIA)
m_playbackBlockedWaitingForKey = false;
#endif
if (!document().hasBrowsingContext())
return;
createMediaPlayer();
// 2 - Let pending tasks be a list of all tasks from the media element's media element event task source in one of the task queues.
// 3 - For each task in pending tasks that would resolve pending play promises or reject pending play promises, immediately resolve or reject those promises in the order the corresponding tasks were queued.
// 4 - Remove each task in pending tasks from its task queue
cancelPendingEventsAndCallbacks();
// 5 - If the media element's networkState is set to NETWORK_LOADING or NETWORK_IDLE, queue
// a task to fire a simple event named abort at the media element.
if (m_networkState == NETWORK_LOADING || m_networkState == NETWORK_IDLE)
scheduleEvent(eventNames().abortEvent);
// 6 - If the media element's networkState is not set to NETWORK_EMPTY, then run these substeps
if (m_networkState != NETWORK_EMPTY) {
// 6.1 - Queue a task to fire a simple event named emptied at the media element.
scheduleEvent(eventNames().emptiedEvent);
// 6.2 - If a fetching process is in progress for the media element, the user agent should stop it.
m_networkState = NETWORK_EMPTY;
// 6.3 - If the media element’s assigned media provider object is a MediaSource object, then detach it.
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
// 6.4 - Forget the media element's media-resource-specific tracks.
forgetResourceSpecificTracks();
// 6.5 - If readyState is not set to HAVE_NOTHING, then set it to that state.
m_readyState = HAVE_NOTHING;
m_readyStateMaximum = HAVE_NOTHING;
// 6.6 - If the paused attribute is false, then set it to true.
setPaused(true);
setPlaying(false);
// 6.7 - If seeking is true, set it to false.
clearSeeking();
// 6.8 - Set the current playback position to 0.
// Set the official playback position to 0.
// If this changed the official playback position, then queue a task to fire a simple event named timeupdate at the media element.
m_lastSeekTime = MediaTime::zeroTime();
m_playedTimeRanges = TimeRanges::create();
// FIXME: Add support for firing this event. e.g., scheduleEvent(eventNames().timeUpdateEvent);
// 4.9 - Set the initial playback position to 0.
invalidateOfficialPlaybackPosition();
// 4.10 - Set the timeline offset to Not-a-Number (NaN).
// 4.11 - Update the duration attribute to Not-a-Number (NaN).
updateMediaController();
updateActiveTextTrackCues(MediaTime::zeroTime());
}
// 7 - Set the playbackRate attribute to the value of the defaultPlaybackRate attribute.
setPlaybackRate(defaultPlaybackRate());
// 8 - Set the error attribute to null and the autoplaying flag to true.
m_error = nullptr;
m_autoplaying = true;
mediaSession().clientWillBeginAutoplaying();
if (!MediaPlayer::isAvailable())
noneSupported();
else {
// 9 - Invoke the media element's resource selection algorithm.
// Note, unless the restriction on requiring user action has been removed,
// do not begin downloading data.
if (mediaSession().dataLoadingPermitted())
selectMediaResource();
}
// 10 - Note: Playback of any previously playing media resource for this element stops.
configureMediaControls();
}
void HTMLMediaElement::mediaPlayerReloadAndResumePlaybackIfNeeded()
{
auto previousMediaTime = m_player ? RefPtr { m_player }->currentTime() : MediaTime::zeroTime();
bool wasPaused = paused();
load();
if (m_videoFullscreenMode != VideoFullscreenModeNone)
enterFullscreen(m_videoFullscreenMode);
if (previousMediaTime) {
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resourceSelectionTaskCancellationGroup, [this, previousMediaTime] {
if (RefPtr player = m_player)
player->seekWhenPossible(previousMediaTime);
});
}
if (!wasPaused)
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resourceSelectionTaskCancellationGroup, std::bind(&HTMLMediaElement::playInternal, this));
}
void HTMLMediaElement::selectMediaResource()
{
// https://www.w3.org/TR/2016/REC-html51-20161101/semantics-embedded-content.html#resource-selection-algorithm
// The Resource Selection Algorithm
// 1. Set the element’s networkState attribute to the NETWORK_NO_SOURCE value.
m_networkState = NETWORK_NO_SOURCE;
// 2. Set the element’s show poster flag to true.
setShowPosterFlag(true);
// 3. Set the media element’s delaying-the-load-event flag to true (this delays the load event).
setShouldDelayLoadEvent(true);
// 4. in parallel await a stable state, allowing the task that invoked this algorithm to continue.
if (m_resourceSelectionTaskCancellationGroup.hasPendingTask())
return;
if (!mediaSession().pageAllowsDataLoading()) {
ALWAYS_LOG(LOGIDENTIFIER, "not allowed to load in background, waiting");
setShouldDelayLoadEvent(false);
if (m_isWaitingUntilMediaCanStart)
return;
m_isWaitingUntilMediaCanStart = true;
protectedDocument()->addMediaCanStartListener(*this);
return;
}
// Once the page has allowed an element to load media, it is free to load at will. This allows a
// playlist that starts in a foreground tab to continue automatically if the tab is subsequently
// put into the background.
mediaSession().removeBehaviorRestriction(MediaElementSession::RequirePageConsentToLoadMedia);
auto logSiteIdentifier = LOGIDENTIFIER;
UNUSED_PARAM(logSiteIdentifier);
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resourceSelectionTaskCancellationGroup, [this, logSiteIdentifier] {
ALWAYS_LOG(logSiteIdentifier, "lambda(), task fired");
// 5. If the media element’s blocked-on-parser flag is false, then populate the list of pending text tracks.
// HTMLMediaElement::textTracksAreReady will need "... the text tracks whose mode was not in the
// disabled state when the element's resource selection algorithm last started".
// FIXME: Update this to match "populate the list of pending text tracks" step.
m_textTracksWhenResourceSelectionBegan.clear();
if (RefPtr textTracks = m_textTracks) {
for (unsigned i = 0; i < textTracks->length(); ++i) {
RefPtr<TextTrack> track = textTracks->item(i);
if (track->mode() != TextTrack::Mode::Disabled)
m_textTracksWhenResourceSelectionBegan.append(track);
}
}
enum Mode { None, Object, Attribute, Children };
Mode mode = None;
if (m_mediaProvider) {
// 6. If the media element has an assigned media provider object, then let mode be object.
mode = Object;
} else if (hasAttributeWithoutSynchronization(srcAttr)) {
// Otherwise, if the media element has no assigned media provider object but has a src attribute, then let mode be attribute.
mode = Attribute;
ASSERT(m_player);
if (!m_player) {
ERROR_LOG(logSiteIdentifier, "has srcAttr but m_player is not created");
return;
}
} else if (auto firstSource = childrenOfType<HTMLSourceElement>(*this).first()) {
// Otherwise, if the media element does not have an assigned media provider object and does not have a src attribute,
// but does have a source element child, then let mode be children and let candidate be the first such source element
// child in tree order.
mode = Children;
m_nextChildNodeToConsider = firstSource;
m_currentSourceNode = nullptr;
} else {
// Otherwise the media element has no assigned media provider object and has neither a src attribute nor a source
// element child: set the networkState to NETWORK_EMPTY, and abort these steps; the synchronous section ends.
m_loadState = WaitingForSource;
setShouldDelayLoadEvent(false);
m_networkState = NETWORK_EMPTY;
ALWAYS_LOG(logSiteIdentifier, "nothing to load");
if (m_videoFullscreenMode == HTMLMediaElementEnums::VideoFullscreenModePictureInPicture)
exitFullscreen();
return;
}
// 7. Set the media element’s networkState to NETWORK_LOADING.
m_networkState = NETWORK_LOADING;
// 8. Queue a task to fire a simple event named loadstart at the media element.
scheduleEvent(eventNames().loadstartEvent);
// 9. Run the appropriate steps from the following list:
// ↳ If mode is object
if (mode == Object) {
m_loadState = LoadingFromSrcAttr;
// 1. Set the currentSrc attribute to the empty string.
setCurrentSrc(URL());
// 2. End the synchronous section, continuing the remaining steps in parallel.
// 3. Run the resource fetch algorithm with the assigned media provider object.
switchOn(m_mediaProvider.value(),
#if ENABLE(MEDIA_STREAM)
[this](RefPtr<MediaStream> stream) { m_mediaStreamSrcObject = stream; },
#endif
#if ENABLE(MEDIA_SOURCE)
[this](RefPtr<MediaSource> source) { m_mediaSource = MediaSourceInterfaceMainThread::create(source.releaseNonNull()); },
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
[this, &logSiteIdentifier](RefPtr<MediaSourceHandle> handle) {
// If the media provider object is a MediaSourceHandle whose [[Detached]] internal slot is true
// Run the "If the media data cannot be fetched at all, due to network errors, causing the user agent to give up trying to fetch the resource" steps of the resource fetch algorithm's media data processing steps list.
// If the media provider object is a MediaSourceHandle whose underlying MediaSource's [[has ever been attached]] internal slot is true
// Run the "If the media data cannot be fetched at all, due to network errors, causing the user agent to give up trying to fetch the resource" steps of the resource fetch algorithm's media data processing steps list.
if (!handle->isDetached() && !handle->hasEverBeenAssignedAsSrcObject())
m_mediaSource = MediaSourceInterfaceWorker::create(handle.releaseNonNull());
else
ALWAYS_LOG(logSiteIdentifier, "Attempting to use a detached or a previously attached MediaSourceHandle");
},
#endif
[this](RefPtr<Blob> blob) { m_blob = blob; }
);
ContentType contentType;
loadResource(URL(), contentType);
ALWAYS_LOG(logSiteIdentifier, "using 'srcObject' property");
// If that algorithm returns without aborting this one, then the load failed.
// 4. Failed with media provider: Reaching this step indicates that the media resource
// failed to load. Queue a task to run the dedicated media source failure steps.
// 5. Wait for the task queued by the previous step to have executed.
// 6. Abort these steps. The element won’t attempt to load another resource until this
// algorithm is triggered again.
return;
}
// ↳ If mode is attribute
if (mode == Attribute) {
m_loadState = LoadingFromSrcAttr;
// 1. If the src attribute’s value is the empty string, then end the synchronous section,
// and jump down to the failed with attribute step below.
// 2. Let absolute URL be the absolute URL that would have resulted from parsing the URL
// specified by the src attribute’s value relative to the media element when the src
// attribute was last changed.
auto& srcValue = attributeWithoutSynchronization(srcAttr);
if (srcValue.isEmpty()) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
ALWAYS_LOG(logSiteIdentifier, "empty 'src'");
return;
}
auto absoluteURL = document().completeURL(srcValue);
if (!isSafeToLoadURL(absoluteURL, InvalidURLAction::Complain)) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
// 3. If absolute URL was obtained successfully, set the currentSrc attribute to absolute URL.
setCurrentSrc(absoluteURL);
// 4. End the synchronous section, continuing the remaining steps in parallel.
// 5. If absolute URL was obtained successfully, run the resource fetch algorithm with absolute
// URL. If that algorithm returns without aborting this one, then the load failed.
// No type or key system information is available when the url comes
// from the 'src' attribute so MediaPlayer
// will have to pick a media engine based on the file extension.
ContentType contentType;
loadResource(absoluteURL, contentType);
ALWAYS_LOG(logSiteIdentifier, "using 'src' attribute url");
// 6. Failed with attribute: Reaching this step indicates that the media resource failed to load
// or that the given URL could not be resolved. Queue a task to run the dedicated media source failure steps.
// 7. Wait for the task queued by the previous step to have executed.
// 8. Abort these steps. The element won’t attempt to load another resource until this algorithm is triggered again.
return;
}
// ↳ Otherwise (mode is children)
// (Ctd. in loadNextSourceChild())
loadNextSourceChild();
});
}
void HTMLMediaElement::loadNextSourceChild()
{
ContentType contentType;
auto mediaURL = selectNextSourceChild(&contentType, InvalidURLAction::Complain);
if (!mediaURL.isValid()) {
waitForSourceChange();
return;
}
// Recreate the media player for the new url
createMediaPlayer();
m_loadState = LoadingFromSourceElement;
loadResource(mediaURL, contentType);
}
void HTMLMediaElement::loadResource(const URL& initialURL, const ContentType& initialContentType)
{
ASSERT(initialURL.isEmpty() || isSafeToLoadURL(initialURL, InvalidURLAction::Complain));
INFO_LOG(LOGIDENTIFIER, initialURL, initialContentType);
RefPtr frame = document().frame();
if (!frame) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
RefPtr page = frame->page();
if (!page) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
if (!m_player) {
ASSERT_NOT_REACHED("It should not be possible to enter loadResource without a valid m_player object");
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
URL url = initialURL;
#if PLATFORM(COCOA)
if (url.protocolIsFile() && !frame->loader().willLoadMediaElementURL(url, *this)) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
#elif USE(GSTREAMER)
if (!url.isEmpty() && !frame->loader().willLoadMediaElementURL(url, *this)) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
#endif
#if ENABLE(CONTENT_EXTENSIONS)
if (RefPtr documentLoader = frame->loader().documentLoader()) {
if (page->protectedUserContentProvider()->processContentRuleListsForLoad(*page, url, ContentExtensions::ResourceType::Media, *documentLoader).summary.blockedLoad) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
}
#endif
// The resource fetch algorithm
m_networkState = NETWORK_LOADING;
// If the URL should be loaded from the application cache, pass the URL of the cached file to the media engine.
RefPtr<ApplicationCacheResource> resource;
if (!url.isEmpty() && frame->loader().documentLoader()->applicationCacheHost().shouldLoadResourceFromApplicationCache(ResourceRequest(url), resource)) {
// Resources that are not present in the manifest will always fail to load (at least, after the
// cache has been primed the first time), making the testing of offline applications simpler.
if (!resource || resource->path().isEmpty()) {
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
return;
}
}
// Log that we started loading a media element.
page->diagnosticLoggingClient().logDiagnosticMessage(isVideo() ? DiagnosticLoggingKeys::videoKey() : DiagnosticLoggingKeys::audioKey(), DiagnosticLoggingKeys::loadingKey(), ShouldSample::No);
m_firstTimePlaying = true;
// Set m_currentSrc *before* changing to the cache URL, the fact that we are loading from the app
// cache is an internal detail not exposed through the media element API.
setCurrentSrc(url);
if (resource) {
url = ApplicationCacheHost::createFileURL(resource->path());
INFO_LOG(LOGIDENTIFIER, "will load from app cache ", url);
}
INFO_LOG(LOGIDENTIFIER, "m_currentSrc is ", m_currentSrc);
startProgressEventTimer();
bool privateMode = document().page() && document().page()->usesEphemeralSession();
RefPtr player = m_player;
player->setPrivateBrowsingMode(privateMode);
if (!autoplay() && !m_havePreparedToPlay)
player->setPreload(mediaSession().effectivePreloadForElement());
player->setPreservesPitch(m_preservesPitch);
player->setPitchCorrectionAlgorithm(document().settings().pitchCorrectionAlgorithm());
if (!m_explicitlyMuted) {
m_explicitlyMuted = true;
m_muted = hasAttributeWithoutSynchronization(mutedAttr);
mediaSession().canProduceAudioChanged();
}
updateVolume();
auto contentType = initialContentType;
if (m_blob && !m_remotePlaybackConfiguration) {
ALWAYS_LOG(LOGIDENTIFIER, "loading generic blob");
if (!m_blobURLForReading.isEmpty())
ThreadableBlobRegistry::unregisterBlobURL(m_blobURLForReading);
m_blobURLForReading = { BlobURL::createPublicURL(document().protectedSecurityOrigin().ptr()), document().topOrigin().data() };
ThreadableBlobRegistry::registerBlobURL(document().protectedSecurityOrigin().ptr(), document().policyContainer(), m_blobURLForReading, m_blob->url());
url = m_blobURLForReading;
if (contentType.isEmpty())
contentType = ContentType { m_blob->type() };
}
auto completionHandler = [url, player = m_player, weakThis = WeakPtr { *this }, this](SnifferPromise::Result&& result) {
RefPtr protectedThis = weakThis.get();
if (!protectedThis)
return;
if (!result) {
if (result.error() != PlatformMediaError::Cancelled)
mediaLoadingFailed(MediaPlayer::NetworkState::NetworkError);
return;
}
MediaPlayer::LoadOptions options = {
.contentType = *result,
.requiresRemotePlayback = !!m_remotePlaybackConfiguration,
.supportsLimitedMatroska = limitedMatroskaSupportEnabled()
};
#if ENABLE(MEDIA_SOURCE)
if (!m_mediaSource && url.protocolIs(mediaSourceBlobProtocol) && !m_remotePlaybackConfiguration) {
if (RefPtr mediaSource = MediaSource::lookup(url.string()))
m_mediaSource = MediaSourceInterfaceMainThread::create(mediaSource.releaseNonNull());
}
if (m_mediaSource) {
ALWAYS_LOG(LOGIDENTIFIER, "loading MSE blob");
if (url.protocolIs(mediaSourceBlobProtocol) && m_mediaSource->detachable()) {
document().addConsoleMessage(MessageSource::MediaSource, MessageLevel::Error, makeString("Unable to attach detachable MediaSource via blob URL, use srcObject attribute"_s));
return mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
}
if (!m_mediaSource->attachToElement(*this)) {
// Forget our reference to the MediaSource, so we leave it alone
// while processing remainder of load failure.
m_mediaSource = nullptr;
} else if (RefPtr mediaSource = m_mediaSource; !mediaSource->client() || !player->load(url, options, *mediaSource->client())) {
// We have to detach the MediaSource before we forget the reference to it.
mediaSource->detachFromElement();
m_mediaSource = nullptr;
}
if (!m_mediaSource)
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
else
mediaPlayerRenderingModeChanged();
return;
}
#endif
#if ENABLE(MEDIA_STREAM)
if (m_mediaStreamSrcObject && !m_remotePlaybackConfiguration) {
ALWAYS_LOG(LOGIDENTIFIER, "loading media stream blob ", m_mediaStreamSrcObject->logIdentifier());
if (!player->load(m_mediaStreamSrcObject->protectedPrivateStream()))
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
else
mediaPlayerRenderingModeChanged();
return;
}
#endif
if (!player->load(url, options))
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
else
mediaPlayerRenderingModeChanged();
};
if (needsContentTypeToPlay() && !url.isEmpty()) {
if (contentType.isEmpty() && url.protocolIsData())
contentType = ContentType(mimeTypeFromDataURL(url.string()));
else {
// If the MIME type is missing or is not meaningful, try to figure it out from the URL.
AtomString containerType { contentType.containerType() };
if (containerType.isEmpty() || containerType == applicationOctetStreamAtom() || containerType == textPlainContentTypeAtom())
contentType = ContentType::fromURL(url);
}
m_lastContentTypeUsed = contentType;
}
completionHandler(WTFMove(contentType));
}
bool HTMLMediaElement::needsContentTypeToPlay() const
{
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource || (currentSrc().protocolIs(mediaSourceBlobProtocol) && MediaSource::lookup(currentSrc().string())))
return false;
#endif
#if ENABLE(MEDIA_STREAM)
if (m_mediaStreamSrcObject)
return false;
#endif
return !m_remotePlaybackConfiguration;
}
Ref<HTMLMediaElement::SnifferPromise> HTMLMediaElement::sniffForContentType(const URL& url)
{
ResourceRequest request(url);
request.setAllowCookies(true);
// https://mimesniff.spec.whatwg.org/#reading-the-resource-header defines a maximum size of 1445 bytes fetch.
m_sniffer = MediaResourceSniffer::create(mediaPlayerCreateResourceLoader(), WTFMove(request), 1445);
return m_sniffer->promise();
}
void HTMLMediaElement::mediaSourceWasDetached()
{
// The steps on what happen when a MediaSource goes missing are not defined in the current spec.
// https://github.com/w3c/media-source/issues/348 ; we do what's the most sensible for now.
userCancelledLoad();
}
static bool trackIndexCompare(const RefPtr<TextTrack>& a, const RefPtr<TextTrack>& b)
{
return a->trackIndex() - b->trackIndex() < 0;
}
static bool eventTimeCueCompare(const std::pair<MediaTime, RefPtr<TextTrackCue>>& a, const std::pair<MediaTime, RefPtr<TextTrackCue>>& b)
{
// 12 - Sort the tasks in events in ascending time order (tasks with earlier
// times first).
if (a.first != b.first)
return a.first - b.first < MediaTime::zeroTime();
// If the cues belong to different text tracks, it doesn't make sense to
// compare the two tracks by the relative cue order, so return the relative
// track order.
if (a.second->track() != b.second->track())
return trackIndexCompare(a.second->protectedTrack().get(), b.second->protectedTrack().get());
// 12 - Further sort tasks in events that have the same time by the
// relative text track cue order of the text track cues associated
// with these tasks.
return a.second->isOrderedBefore(b.second.get());
}
static bool compareCueInterval(const CueInterval& one, const CueInterval& two)
{
return RefPtr { one.data() }->isOrderedBefore(RefPtr { two.data() }.get());
}
static bool compareCueIntervalEndTime(const CueInterval& one, const CueInterval& two)
{
return one.data()->endMediaTime() > two.data()->endMediaTime();
}
bool HTMLMediaElement::ignoreTrackDisplayUpdateRequests() const
{
return m_ignoreTrackDisplayUpdate > 0 || !m_textTracks || !m_cueData || m_cueData->cueTree.isEmpty();
}
void HTMLMediaElement::updateActiveTextTrackCues(const MediaTime& movieTime)
{
if (m_seeking)
return;
// 4.8.10.8 Playing the media resource
// If the current playback position changes while the steps are running,
// then the user agent must wait for the steps to complete, and then must
// immediately rerun the steps.
if (ignoreTrackDisplayUpdateRequests())
return;
// 1 - Let current cues be a list of cues, initialized to contain all the
// cues of all the hidden, showing, or showing by default text tracks of the
// media element (not the disabled ones) whose start times are less than or
// equal to the current playback position and whose end times are greater
// than the current playback position.
CueList currentCues;
// The user agent must synchronously unset [the text track cue active] flag
// whenever ... the media element's readyState is changed back to HAVE_NOTHING.
if (m_readyState != HAVE_NOTHING && m_player) {
for (auto& cue : m_cueData->cueTree.allOverlaps({ movieTime, movieTime })) {
if (cue.low() <= movieTime && cue.high() > movieTime)
currentCues.append(cue);
}
if (currentCues.size() > 1)
std::sort(currentCues.begin(), currentCues.end(), &compareCueInterval);
}
CueList previousCues;
CueList missedCues;
// 2 - Let other cues be a list of cues, initialized to contain all the cues
// of hidden, showing, and showing by default text tracks of the media
// element that are not present in current cues.
previousCues = m_cueData->currentlyActiveCues;
// 3 - Let last time be the current playback position at the time this
// algorithm was last run for this media element, if this is not the first
// time it has run.
MediaTime lastTime = m_lastTextTrackUpdateTime;
// 4 - If the current playback position has, since the last time this
// algorithm was run, only changed through its usual monotonic increase
// during normal playback, then let missed cues be the list of cues in other
// cues whose start times are greater than or equal to last time and whose
// end times are less than or equal to the current playback position.
// Otherwise, let missed cues be an empty list.
if (lastTime >= MediaTime::zeroTime() && m_lastSeekTime < movieTime) {
for (auto& cue : m_cueData->cueTree.allOverlaps({ lastTime, movieTime })) {
// Consider cues that may have been missed since the last seek time.
if (cue.low() > std::max(m_lastSeekTime, lastTime) && cue.high() < movieTime)
missedCues.append(cue);
}
}
m_lastTextTrackUpdateTime = movieTime;
// 5 - If the time was reached through the usual monotonic increase of the
// current playback position during normal playback, and if the user agent
// has not fired a timeupdate event at the element in the past 15 to 250ms
// and is not still running event handlers for such an event, then the user
// agent must queue a task to fire a simple event named timeupdate at the
// element. (In the other cases, such as explicit seeks, relevant events get
// fired as part of the overall process of changing the current playback
// position.)
if (!m_paused && m_lastSeekTime <= lastTime)
scheduleTimeupdateEvent(true);
// Explicitly cache vector sizes, as their content is constant from here.
size_t currentCuesSize = currentCues.size();
size_t missedCuesSize = missedCues.size();
size_t previousCuesSize = previousCues.size();
// 6 - If all of the cues in current cues have their text track cue active
// flag set, none of the cues in other cues have their text track cue active
// flag set, and missed cues is empty, then abort these steps.
bool activeSetChanged = missedCuesSize;
for (size_t i = 0; !activeSetChanged && i < previousCuesSize; ++i)
if (!currentCues.contains(previousCues[i]) && previousCues[i].data()->isActive())
activeSetChanged = true;
for (size_t i = 0; i < currentCuesSize; ++i) {
RefPtr cue = currentCues[i].data();
cue->updateDisplayTree(movieTime);
if (!cue->isActive())
activeSetChanged = true;
}
MediaTime nextInterestingTime = MediaTime::invalidTime();
if (auto nearestEndingCue = std::min_element(currentCues.begin(), currentCues.end(), compareCueIntervalEndTime))
nextInterestingTime = nearestEndingCue->data()->endMediaTime();
std::optional<CueInterval> nextCue = m_cueData->cueTree.nextIntervalAfter(movieTime);
if (nextCue)
nextInterestingTime = std::min(nextInterestingTime, nextCue->low());
auto identifier = LOGIDENTIFIER;
INFO_LOG(identifier, "nextInterestingTime:", nextInterestingTime);
if (RefPtr player = m_player; nextInterestingTime.isValid() && player) {
player->performTaskAtTime([this, weakThis = WeakPtr { *this }, identifier] {
RefPtr protectedThis = weakThis.get();
if (!protectedThis)
return;
auto currentMediaTime = this->currentMediaTime();
INFO_LOG(identifier, "lambda(), currentMediaTime: ", currentMediaTime);
updateActiveTextTrackCues(currentMediaTime);
}, nextInterestingTime);
}
if (!activeSetChanged)
return;
// 7 - If the time was reached through the usual monotonic increase of the
// current playback position during normal playback, and there are cues in
// other cues that have their text track cue pause-on-exi flag set and that
// either have their text track cue active flag set or are also in missed
// cues, then immediately pause the media element.
for (size_t i = 0; !m_paused && i < previousCuesSize; ++i) {
if (previousCues[i].data()->pauseOnExit()
&& previousCues[i].data()->isActive()
&& !currentCues.contains(previousCues[i]))
pause();
}
for (size_t i = 0; !m_paused && i < missedCuesSize; ++i) {
if (missedCues[i].data()->pauseOnExit())
pause();
}
// 8 - Let events be a list of tasks, initially empty. Each task in this
// list will be associated with a text track, a text track cue, and a time,
// which are used to sort the list before the tasks are queued.
Vector<std::pair<MediaTime, RefPtr<TextTrackCue>>> eventTasks;
// 8 - Let affected tracks be a list of text tracks, initially empty.
Vector<RefPtr<TextTrack>> affectedTracks;
for (size_t i = 0; i < missedCuesSize; ++i) {
// 9 - For each text track cue in missed cues, prepare an event named enter
// for the TextTrackCue object with the text track cue start time.
eventTasks.append({ missedCues[i].data()->startMediaTime(), missedCues[i].data() });
// 10 - For each text track [...] in missed cues, prepare an event
// named exit for the TextTrackCue object with the with the later of
// the text track cue end time and the text track cue start time.
// Note: An explicit task is added only if the cue is NOT a zero or
// negative length cue. Otherwise, the need for an exit event is
// checked when these tasks are actually queued below. This doesn't
// affect sorting events before dispatch either, because the exit
// event has the same time as the enter event.
if (missedCues[i].data()->startMediaTime() < missedCues[i].data()->endMediaTime())
eventTasks.append({ missedCues[i].data()->endMediaTime(), missedCues[i].data() });
}
for (size_t i = 0; i < previousCuesSize; ++i) {
// 10 - For each text track cue in other cues that has its text
// track cue active flag set prepare an event named exit for the
// TextTrackCue object with the text track cue end time.
if (!currentCues.contains(previousCues[i]))
eventTasks.append({ previousCues[i].data()->endMediaTime(), previousCues[i].data() });
}
for (size_t i = 0; i < currentCuesSize; ++i) {
// 11 - For each text track cue in current cues that does not have its
// text track cue active flag set, prepare an event named enter for the
// TextTrackCue object with the text track cue start time.
if (!previousCues.contains(currentCues[i]))
eventTasks.append({ currentCues[i].data()->startMediaTime(), currentCues[i].data() });
}
// 12 - Sort the tasks in events in ascending time order (tasks with earlier
// times first).
std::sort(eventTasks.begin(), eventTasks.end(), eventTimeCueCompare);
for (auto& eventTask : eventTasks) {
auto& [eventTime, eventCue] = eventTask;
if (!affectedTracks.contains(eventCue->track()))
affectedTracks.append(eventCue->track());
// 13 - Queue each task in events, in list order.
// Each event in eventTasks may be either an enterEvent or an exitEvent,
// depending on the time that is associated with the event. This
// correctly identifies the type of the event, if the startTime is
// less than the endTime in the cue.
if (eventCue->startTime() >= eventCue->endTime()) {
executeCueEnterOrExitActionForTime(*eventCue, CueAction::Enter);
executeCueEnterOrExitActionForTime(*eventCue, CueAction::Exit);
} else {
CueAction action = eventTime == eventCue->startMediaTime() ? CueAction::Enter : CueAction::Exit;
executeCueEnterOrExitActionForTime(*eventCue, action);
}
}
// 14 - Sort affected tracks in the same order as the text tracks appear in
// the media element's list of text tracks, and remove duplicates.
std::sort(affectedTracks.begin(), affectedTracks.end(), trackIndexCompare);
// 15 - For each text track in affected tracks, in the list order, queue a
// task to fire a simple event named cuechange at the TextTrack object, and, ...
for (auto& affectedTrack : affectedTracks) {
Ref event = Event::create(eventNames().cuechangeEvent, Event::CanBubble::No, Event::IsCancelable::No);
scheduleEventOn(*affectedTrack, WTFMove(event));
// ... if the text track has a corresponding track element, to then fire a
// simple event named cuechange at the track element as well.
if (RefPtr loadableTextTrack = dynamicDowncast<LoadableTextTrack>(*affectedTrack)) {
Ref event = Event::create(eventNames().cuechangeEvent, Event::CanBubble::No, Event::IsCancelable::No);
RefPtr trackElement = loadableTextTrack->trackElement();
ASSERT(trackElement);
scheduleEventOn(*trackElement, WTFMove(event));
}
}
// 16 - Set the text track cue active flag of all the cues in the current
// cues, and unset the text track cue active flag of all the cues in the
// other cues.
for (size_t i = 0; i < currentCuesSize; ++i)
currentCues[i].data()->setIsActive(true);
for (size_t i = 0; i < previousCuesSize; ++i)
if (!currentCues.contains(previousCues[i]))
previousCues[i].data()->setIsActive(false);
// Update the current active cues.
m_cueData->currentlyActiveCues = currentCues;
if (activeSetChanged)
updateTextTrackDisplay();
}
void HTMLMediaElement::setSpeechSynthesisState(SpeechSynthesisState state)
{
#if ENABLE(SPEECH_SYNTHESIS)
constexpr double volumeMultiplierWhenSpeakingCueText = .4;
if (m_changingSynthesisState || state == m_speechState)
return;
if (m_cueBeingSpoken)
ALWAYS_LOG(LOGIDENTIFIER, "changing state from ", m_speechState, " to ", state, ", at time ", currentMediaTime(), ", for cue ", m_cueBeingSpoken->startTime(), "..", m_cueBeingSpoken->endTime());
else
ALWAYS_LOG(LOGIDENTIFIER, "changing state from ", m_speechState, " to ", state, ", at time ", currentMediaTime());
SetForScope<bool> changingState { m_changingSynthesisState, true };
auto setSpeechVolumeMultiplier = [this] (double multiplier) {
m_volumeMultiplierForSpeechSynthesis = multiplier;
updateVolume();
};
auto oldState = m_speechState;
m_speechState = state;
switch (state) {
case SpeechSynthesisState::None:
setSpeechVolumeMultiplier(1);
if (oldState == SpeechSynthesisState::CompletingExtendedDescription && m_paused)
play();
if (!m_cueBeingSpoken)
return;
m_cueBeingSpoken->cancelSpeaking();
m_cueBeingSpoken = nullptr;
break;
case SpeechSynthesisState::Speaking:
ASSERT(m_cueBeingSpoken);
setSpeechVolumeMultiplier(volumeMultiplierWhenSpeakingCueText);
m_cueBeingSpoken->beginSpeaking();
break;
case SpeechSynthesisState::CompletingExtendedDescription:
if (m_cueBeingSpoken)
pauseInternal();
break;
case SpeechSynthesisState::Paused:
if (m_cueBeingSpoken)
m_cueBeingSpoken->pauseSpeaking();
break;
}
#else
UNUSED_PARAM(state);
#endif
}
void HTMLMediaElement::speakCueText(TextTrackCue& cue)
{
#if ENABLE(SPEECH_SYNTHESIS)
if (m_cueBeingSpoken && m_cueBeingSpoken->isEqual(cue, TextTrackCue::MatchAllFields))
return;
ALWAYS_LOG(LOGIDENTIFIER, cue);
if (m_speechState != SpeechSynthesisState::None)
cancelSpeakingCueText();
m_cueBeingSpoken = &cue;
RefPtr { m_cueBeingSpoken }->prepareToSpeak(protectedSpeechSynthesis(), m_reportedPlaybackRate ? m_reportedPlaybackRate : m_requestedPlaybackRate, volume(), [weakThis = WeakPtr { *this }](const TextTrackCue&) {
ASSERT(isMainThread());
RefPtr<HTMLMediaElement> protectedThis = weakThis.get();
if (!protectedThis)
return;
protectedThis->setSpeechSynthesisState(SpeechSynthesisState::None);
});
if (m_pausedInternal || m_paused)
setSpeechSynthesisState(SpeechSynthesisState::Paused);
else
setSpeechSynthesisState(SpeechSynthesisState::Speaking);
#else
UNUSED_PARAM(cue);
#endif
}
#if ENABLE(SPEECH_SYNTHESIS)
Ref<SpeechSynthesis> HTMLMediaElement::protectedSpeechSynthesis()
{
return speechSynthesis();
}
#endif
void HTMLMediaElement::pauseSpeakingCueText()
{
#if ENABLE(SPEECH_SYNTHESIS)
if (m_speechState != SpeechSynthesisState::Speaking && m_speechState != SpeechSynthesisState::CompletingExtendedDescription)
return;
ALWAYS_LOG(LOGIDENTIFIER);
setSpeechSynthesisState(SpeechSynthesisState::Paused);
#endif
}
void HTMLMediaElement::resumeSpeakingCueText()
{
#if ENABLE(SPEECH_SYNTHESIS)
if (m_speechState != SpeechSynthesisState::Paused && m_speechState != SpeechSynthesisState::CompletingExtendedDescription)
return;
ALWAYS_LOG(LOGIDENTIFIER);
setSpeechSynthesisState(SpeechSynthesisState::Speaking);
#endif
}
void HTMLMediaElement::cancelSpeakingCueText()
{
#if ENABLE(SPEECH_SYNTHESIS)
if (m_speechState == SpeechSynthesisState::None)
return;
ALWAYS_LOG(LOGIDENTIFIER);
setSpeechSynthesisState(SpeechSynthesisState::None);
#endif
}
void HTMLMediaElement::pausePlaybackForExtendedTextDescription()
{
#if ENABLE(SPEECH_SYNTHESIS)
if (m_speechState != SpeechSynthesisState::Speaking)
return;
ALWAYS_LOG(LOGIDENTIFIER);
setSpeechSynthesisState(SpeechSynthesisState::CompletingExtendedDescription);
#endif
}
bool HTMLMediaElement::shouldSpeakCueTextForTime(const MediaTime& time)
{
#if ENABLE(SPEECH_SYNTHESIS)
if (!m_cueBeingSpoken)
return false;
auto result = time.toDouble() >= m_cueBeingSpoken->startTime() && time.toDouble() < m_cueBeingSpoken->endTime();
ALWAYS_LOG(LOGIDENTIFIER, "time = ", time, ", returning ", result);
return result;
#else
UNUSED_PARAM(time);
return false;
#endif
}
RefPtr<TextTrackCue> HTMLMediaElement::cueBeingSpoken() const
{
return m_cueBeingSpoken;
}
#if ENABLE(SPEECH_SYNTHESIS)
SpeechSynthesis& HTMLMediaElement::speechSynthesis()
{
if (!m_speechSynthesis) {
m_speechSynthesis = SpeechSynthesis::create(protectedDocument());
RefPtr { m_speechSynthesis }->removeBehaviorRestriction(SpeechSynthesis::RequireUserGestureForSpeechStartRestriction);
}
return *m_speechSynthesis;
}
#endif
void HTMLMediaElement::executeCueEnterOrExitActionForTime(TextTrackCue& cue, CueAction type)
{
ASSERT(cue.track());
if (!cue.track())
return;
if (m_userPrefersTextDescriptions && cue.track()->isSpoken() && cue.startTime() < cue.endTime()) {
if (type == CueAction::Enter)
speakCueText(cue);
else if (m_userPrefersExtendedDescriptions)
pausePlaybackForExtendedTextDescription();
}
Ref event = Event::create(type == CueAction::Enter ? eventNames().enterEvent : eventNames().exitEvent, Event::CanBubble::No, Event::IsCancelable::No);
scheduleEventOn(cue, WTFMove(event));
}
void HTMLMediaElement::audioTrackEnabledChanged(AudioTrack& track)
{
if (RefPtr audioTracks = m_audioTracks; audioTracks && audioTracks->contains(track))
audioTracks->scheduleChangeEvent();
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
checkForAudioAndVideo();
}
void HTMLMediaElement::audioTrackKindChanged(AudioTrack& track)
{
if (RefPtr audioTracks = m_audioTracks; audioTracks && audioTracks->contains(track))
audioTracks->scheduleChangeEvent();
}
void HTMLMediaElement::audioTrackLabelChanged(AudioTrack& track)
{
if (RefPtr audioTracks = m_audioTracks; audioTracks && audioTracks->contains(track))
audioTracks->scheduleChangeEvent();
}
void HTMLMediaElement::audioTrackLanguageChanged(AudioTrack& track)
{
if (RefPtr audioTracks = m_audioTracks; audioTracks && audioTracks->contains(track))
audioTracks->scheduleChangeEvent();
}
void HTMLMediaElement::willRemoveAudioTrack(AudioTrack& track)
{
removeAudioTrack(track);
}
void HTMLMediaElement::textTrackModeChanged(TextTrack& track)
{
bool trackIsLoaded = true;
if (track.trackType() == TextTrack::TrackElement) {
trackIsLoaded = false;
for (auto& trackElement : childrenOfType<HTMLTrackElement>(*this)) {
if (&trackElement.track() == &track) {
if (trackElement.readyState() == HTMLTrackElement::LOADING || trackElement.readyState() == HTMLTrackElement::LOADED)
trackIsLoaded = true;
break;
}
}
}
// If this is the first added track, create the list of text tracks.
ensureTextTracks();
// Mark this track as "configured" so configureTextTracks won't change the mode again.
track.setHasBeenConfigured(true);
if (track.mode() != TextTrack::Mode::Disabled && trackIsLoaded)
textTrackAddCues(track, *track.protectedCues());
configureTextTrackDisplay(AssumeTextTrackVisibilityChanged);
if (RefPtr textTracks = m_textTracks; textTracks && textTracks->contains(track))
textTracks->scheduleChangeEvent();
if (track.trackType() == TextTrack::TrackElement && m_player)
RefPtr { m_player }->notifyTrackModeChanged();
}
void HTMLMediaElement::textTrackKindChanged(TextTrack& track)
{
if (track.kind() != TextTrack::Kind::Captions && track.kind() != TextTrack::Kind::Subtitles && track.mode() == TextTrack::Mode::Showing)
track.setMode(TextTrack::Mode::Hidden);
if (RefPtr textTracks = m_textTracks; textTracks && textTracks->contains(track))
textTracks->scheduleChangeEvent();
}
void HTMLMediaElement::textTrackLabelChanged(TextTrack& track)
{
if (RefPtr textTracks = m_textTracks; textTracks && textTracks->contains(track))
textTracks->scheduleChangeEvent();
}
void HTMLMediaElement::textTrackLanguageChanged(TextTrack& track)
{
if (RefPtr textTracks = m_textTracks; textTracks && textTracks->contains(track))
textTracks->scheduleChangeEvent();
}
void HTMLMediaElement::willRemoveTextTrack(TextTrack& track)
{
if (track.trackType() == TextTrack::InBand)
removeTextTrack(track);
}
void HTMLMediaElement::videoTrackSelectedChanged(VideoTrack& track)
{
if (RefPtr videoTracks = m_videoTracks; videoTracks && videoTracks->contains(track))
videoTracks->scheduleChangeEvent();
checkForAudioAndVideo();
}
void HTMLMediaElement::videoTrackKindChanged(VideoTrack& track)
{
if (RefPtr videoTracks = m_videoTracks; videoTracks && videoTracks->contains(track))
videoTracks->scheduleChangeEvent();
}
void HTMLMediaElement::videoTrackLabelChanged(VideoTrack& track)
{
if (RefPtr videoTracks = m_videoTracks; videoTracks && videoTracks->contains(track))
videoTracks->scheduleChangeEvent();
}
void HTMLMediaElement::videoTrackLanguageChanged(VideoTrack& track)
{
if (RefPtr videoTracks = m_videoTracks; videoTracks && videoTracks->contains(track))
videoTracks->scheduleChangeEvent();
}
void HTMLMediaElement::willRemoveVideoTrack(VideoTrack& track)
{
removeVideoTrack(track);
}
void HTMLMediaElement::beginIgnoringTrackDisplayUpdateRequests()
{
++m_ignoreTrackDisplayUpdate;
}
void HTMLMediaElement::endIgnoringTrackDisplayUpdateRequests()
{
ASSERT(m_ignoreTrackDisplayUpdate);
--m_ignoreTrackDisplayUpdate;
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_updateTextTracksTaskCancellationGroup, [this] {
if (!m_ignoreTrackDisplayUpdate && m_inActiveDocument)
updateActiveTextTrackCues(currentMediaTime());
});
}
void HTMLMediaElement::textTrackAddCues(TextTrack& track, const TextTrackCueList& cues)
{
if (track.mode() == TextTrack::Mode::Disabled)
return;
TrackDisplayUpdateScope scope { *this };
for (unsigned i = 0; i < cues.length(); ++i)
textTrackAddCue(track, Ref { *cues.item(i) });
}
void HTMLMediaElement::textTrackRemoveCues(TextTrack&, const TextTrackCueList& cues)
{
TrackDisplayUpdateScope scope { *this };
for (unsigned i = 0; i < cues.length(); ++i) {
Ref cue = *cues.item(i);
textTrackRemoveCue(*cue->protectedTrack(), cue);
}
}
void HTMLMediaElement::textTrackAddCue(TextTrack& track, TextTrackCue& cue)
{
if (track.mode() == TextTrack::Mode::Disabled)
return;
if (!m_cueData)
m_cueData = makeUnique<CueData>();
// Negative duration cues need be treated in the interval tree as
// zero-length cues.
MediaTime endTime = std::max(cue.startMediaTime(), cue.endMediaTime());
CueInterval interval(cue.startMediaTime(), endTime, &cue);
if (!m_cueData->cueTree.contains(interval))
m_cueData->cueTree.add(interval);
updateActiveTextTrackCues(currentMediaTime());
}
void HTMLMediaElement::textTrackRemoveCue(TextTrack&, TextTrackCue& cue)
{
if (!m_cueData)
m_cueData = makeUnique<CueData>();
// Negative duration cues need to be treated in the interval tree as
// zero-length cues.
MediaTime endTime = std::max(cue.startMediaTime(), cue.endMediaTime());
CueInterval interval(cue.startMediaTime(), endTime, &cue);
m_cueData->cueTree.remove(interval);
// Since the cue will be removed from the media element and likely the
// TextTrack might also be destroyed, notifying the region of the cue
// removal shouldn't be done.
RefPtr vttCue = dynamicDowncast<VTTCue>(cue);
if (vttCue)
vttCue->notifyRegionWhenRemovingDisplayTree(false);
size_t index = m_cueData->currentlyActiveCues.find(interval);
if (index != notFound) {
cue.setIsActive(false);
m_cueData->currentlyActiveCues.remove(index);
}
cue.removeDisplayTree();
updateActiveTextTrackCues(currentMediaTime());
if (vttCue)
vttCue->notifyRegionWhenRemovingDisplayTree(true);
}
CueList HTMLMediaElement::currentlyActiveCues() const
{
if (!m_cueData)
return { };
return m_cueData->currentlyActiveCues;
}
static inline bool isAllowedToLoadMediaURL(const HTMLMediaElement& element, const URL& url, bool isInUserAgentShadowTree)
{
// Elements in user agent show tree should load whatever the embedding document policy is.
if (isInUserAgentShadowTree)
return true;
ASSERT(element.document().contentSecurityPolicy());
return element.protectedDocument()->checkedContentSecurityPolicy()->allowMediaFromSource(url);
}
bool HTMLMediaElement::isSafeToLoadURL(const URL& url, InvalidURLAction actionIfInvalid, bool shouldLog) const
{
if (!url.isValid()) {
if (shouldLog)
ERROR_LOG(LOGIDENTIFIER, url, " is invalid");
return false;
}
RefPtr frame = document().frame();
if (!frame || !document().protectedSecurityOrigin()->canDisplay(url, OriginAccessPatternsForWebProcess::singleton())) {
if (actionIfInvalid == InvalidURLAction::Complain) {
FrameLoader::reportLocalLoadFailed(frame.get(), url.stringCenterEllipsizedToLength());
if (shouldLog)
ERROR_LOG(LOGIDENTIFIER, url , " was rejected by SecurityOrigin");
}
return false;
}
if (!portAllowed(url) || isIPAddressDisallowed(url)) {
if (actionIfInvalid == InvalidURLAction::Complain) {
if (frame)
FrameLoader::reportBlockedLoadFailed(*frame, url);
if (shouldLog) {
if (isIPAddressDisallowed(url))
ERROR_LOG(LOGIDENTIFIER, url , " was rejected because the address not allowed");
else
ERROR_LOG(LOGIDENTIFIER, url , " was rejected because the port is not allowed");
}
}
return false;
}
if (!isAllowedToLoadMediaURL(*this, url, isInUserAgentShadowTree())) {
if (shouldLog)
ERROR_LOG(LOGIDENTIFIER, url, " was rejected by Content Security Policy");
return false;
}
return true;
}
void HTMLMediaElement::startProgressEventTimer()
{
if (m_progressEventTimer.isActive())
return;
m_previousProgressTime = MonotonicTime::now();
// 350ms is not magic, it is in the spec!
m_progressEventTimer.startRepeating(350_ms);
}
void HTMLMediaElement::waitForSourceChange()
{
ALWAYS_LOG(LOGIDENTIFIER);
stopPeriodicTimers();
m_loadState = WaitingForSource;
// 6.17 - Waiting: Set the element's networkState attribute to the NETWORK_NO_SOURCE value
m_networkState = NETWORK_NO_SOURCE;
// 6.18 - Set the element's show poster flag to true.
setShowPosterFlag(true);
// 6.19 - Queue a media element task given the media element given the element to set the
// element's delaying-the-load-event flag to false. This stops delaying the load event.
// FIXME: this should be done in a task queue
setShouldDelayLoadEvent(false);
updateRenderer();
}
void HTMLMediaElement::noneSupported()
{
if (m_error)
return;
ALWAYS_LOG(LOGIDENTIFIER);
stopPeriodicTimers();
m_loadState = WaitingForSource;
m_currentSourceNode = nullptr;
// 4.8.10.5
// 6 - Reaching this step indicates that the media resource failed to load or that the given
// URL could not be resolved. In one atomic operation, run the following steps:
// 6.1 - Set the error attribute to a new MediaError object whose code attribute is set to
// MEDIA_ERR_SRC_NOT_SUPPORTED.
m_error = m_player
? MediaError::create(MediaError::MEDIA_ERR_SRC_NOT_SUPPORTED, m_player->lastErrorMessage())
: MediaError::create(MediaError::MEDIA_ERR_SRC_NOT_SUPPORTED, "Unsupported source type"_s);
// 6.2 - Forget the media element's media-resource-specific text tracks.
forgetResourceSpecificTracks();
// 6.3 - Set the element's networkState attribute to the NETWORK_NO_SOURCE value.
m_networkState = NETWORK_NO_SOURCE;
// 6.4 - Set the element's show poster flag to true.
setShowPosterFlag(true);
// 7 - Queue a task to fire a simple event named error at the media element.
scheduleEvent(eventNames().errorEvent);
rejectPendingPlayPromises(WTFMove(m_pendingPlayPromises), DOMException::create(ExceptionCode::NotSupportedError));
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
// 8 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
setShouldDelayLoadEvent(false);
// 9 - Abort these steps. Until the load() method is invoked or the src attribute is changed,
// the element won't attempt to load another resource.
updateRenderer();
}
void HTMLMediaElement::mediaLoadingFailedFatally(MediaPlayer::NetworkState error)
{
// https://html.spec.whatwg.org/#loading-the-media-resource:dom-media-have_nothing-2
// 17 March 2021
// 1 - The user agent should cancel the fetching process.
stopPeriodicTimers();
m_loadState = WaitingForSource;
const auto getErrorMessage = [&] (String&& defaultMessage) {
String message = WTFMove(defaultMessage);
if (!m_player)
return message;
auto lastErrorMessage = m_player->lastErrorMessage();
if (!lastErrorMessage)
return message;
return makeString(message, ": "_s, lastErrorMessage);
};
// 2 - Set the error attribute to a new MediaError object whose code attribute is
// set to MEDIA_ERR_NETWORK/MEDIA_ERR_DECODE.
if (error == MediaPlayer::NetworkState::NetworkError)
m_error = MediaError::create(MediaError::MEDIA_ERR_NETWORK, getErrorMessage("Media failed to load"_s));
else if (error == MediaPlayer::NetworkState::DecodeError)
m_error = MediaError::create(MediaError::MEDIA_ERR_DECODE, getErrorMessage("Media failed to decode"_s));
else
ASSERT_NOT_REACHED();
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
// 3 - Set the element's networkState attribute to the NETWORK_IDLE value.
m_networkState = NETWORK_IDLE;
// 4 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
setShouldDelayLoadEvent(false);
// 5 - Fire an event named error at the media element.
scheduleEvent(eventNames().errorEvent);
// 6 - Abort the overall resource selection algorithm.
m_currentSourceNode = nullptr;
}
void HTMLMediaElement::cancelPendingEventsAndCallbacks()
{
INFO_LOG(LOGIDENTIFIER);
m_asyncEventsCancellationGroup.cancel();
for (Ref source : childrenOfType<HTMLSourceElement>(*this))
source->cancelPendingErrorEvent();
rejectPendingPlayPromises(WTFMove(m_pendingPlayPromises), DOMException::create(ExceptionCode::AbortError));
}
void HTMLMediaElement::mediaPlayerNetworkStateChanged()
{
beginProcessingMediaPlayerCallback();
setNetworkState(m_player->networkState());
endProcessingMediaPlayerCallback();
}
static void logMediaLoadRequest(Page* page, const String& mediaEngine, const String& errorMessage, bool succeeded)
{
if (!page)
return;
DiagnosticLoggingClient& diagnosticLoggingClient = page->diagnosticLoggingClient();
if (!succeeded) {
diagnosticLoggingClient.logDiagnosticMessageWithResult(DiagnosticLoggingKeys::mediaLoadingFailedKey(), errorMessage, DiagnosticLoggingResultFail, ShouldSample::No);
return;
}
diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::mediaLoadedKey(), mediaEngine, ShouldSample::No);
if (!page->hasSeenAnyMediaEngine())
diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsAtLeastOneMediaEngineKey(), emptyString(), ShouldSample::No);
if (!page->hasSeenMediaEngine(mediaEngine))
diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsMediaEngineKey(), mediaEngine, ShouldSample::No);
page->sawMediaEngine(mediaEngine);
}
void HTMLMediaElement::mediaLoadingFailed(MediaPlayer::NetworkState error)
{
stopPeriodicTimers();
// If we failed while trying to load a <source> element, the movie was never parsed, and there are more
// <source> children, schedule the next one
if (m_readyState < HAVE_METADATA && m_loadState == LoadingFromSourceElement) {
// resource selection algorithm
// Step 9.Otherwise.9 - Failed with elements: Queue a task, using the DOM manipulation task source, to fire a simple event named error at the candidate element.
if (RefPtr currentSourceNode = m_currentSourceNode)
currentSourceNode->scheduleErrorEvent();
else
ALWAYS_LOG(LOGIDENTIFIER, "error event not sent, <source> was removed");
// 9.Otherwise.10 - Asynchronously await a stable state. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended.
// 9.Otherwise.11 - Forget the media element's media-resource-specific tracks.
forgetResourceSpecificTracks();
if (havePotentialSourceChild()) {
ALWAYS_LOG(LOGIDENTIFIER, "scheduling next <source>");
scheduleNextSourceChild();
} else {
ALWAYS_LOG(LOGIDENTIFIER, "no more <source> elements, waiting");
waitForSourceChange();
}
return;
}
if ((error == MediaPlayer::NetworkState::NetworkError && m_readyState >= HAVE_METADATA) || error == MediaPlayer::NetworkState::DecodeError)
mediaLoadingFailedFatally(error);
else if ((error == MediaPlayer::NetworkState::FormatError || error == MediaPlayer::NetworkState::NetworkError) && m_loadState == LoadingFromSrcAttr)
noneSupported();
ERROR_LOG(LOGIDENTIFIER, "error = ", static_cast<int>(error));
logMediaLoadRequest(document().protectedPage().get(), String(), convertEnumerationToString(error), false);
mediaSession().clientCharacteristicsChanged(false);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (!m_hasPlaybackTargetAvailabilityListeners)
mediaSession().setActive(false);
#else
mediaSession().setActive(false);
#endif
}
void HTMLMediaElement::setNetworkState(MediaPlayer::NetworkState state)
{
if (static_cast<int>(state) != static_cast<int>(m_networkState))
ALWAYS_LOG(LOGIDENTIFIER, "new state = ", state, ", current state = ", m_networkState);
if (state == MediaPlayer::NetworkState::Empty) {
// Just update the cached state and leave, we can't do anything.
m_networkState = NETWORK_EMPTY;
updateBufferingState();
updateStalledState();
return;
}
if (state == MediaPlayer::NetworkState::FormatError && m_readyState < HAVE_METADATA && m_loadState == LoadingFromSrcAttr && needsContentTypeToPlay() && m_firstTimePlaying && !m_sniffer && !m_networkErrorOccured && m_lastContentTypeUsed) {
// We couldn't find a suitable MediaPlayer, this could be due to the content-type having been initially set incorrectly.
auto url = m_blob ? m_blobURLForReading.url() : currentSrc();
sniffForContentType(url)->whenSettled(RunLoop::protectedMain(), [weakThis = WeakPtr { *this }, this, url, player = m_player, lastContentType = *m_lastContentTypeUsed](auto&& result) {
RefPtr protectedThis = weakThis.get();
if (!protectedThis)
return;
if (!result) {
if (result.error() != PlatformMediaError::Cancelled)
mediaLoadingFailed(MediaPlayer::NetworkState::NetworkError);
return;
}
player->reset();
MediaPlayer::LoadOptions options = {
.contentType = *result,
.requiresRemotePlayback = !!m_remotePlaybackConfiguration,
.supportsLimitedMatroska = limitedMatroskaSupportEnabled()
};
if (result->isEmpty() || lastContentType == *result || !player->load(url, options))
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
else
mediaPlayerRenderingModeChanged();
});
return;
}
if (state == MediaPlayer::NetworkState::FormatError || state == MediaPlayer::NetworkState::NetworkError || state == MediaPlayer::NetworkState::DecodeError) {
mediaLoadingFailed(state);
return;
}
if (state == MediaPlayer::NetworkState::Idle) {
if (m_networkState > NETWORK_IDLE) {
changeNetworkStateFromLoadingToIdle();
setShouldDelayLoadEvent(false);
} else {
m_networkState = NETWORK_IDLE;
}
}
if (state == MediaPlayer::NetworkState::Loading) {
if (m_networkState < NETWORK_LOADING || m_networkState == NETWORK_NO_SOURCE)
startProgressEventTimer();
m_networkState = NETWORK_LOADING;
}
if (state == MediaPlayer::NetworkState::Loaded) {
if (m_networkState != NETWORK_IDLE)
changeNetworkStateFromLoadingToIdle();
m_completelyLoaded = true;
}
updateBufferingState();
updateStalledState();
}
void HTMLMediaElement::changeNetworkStateFromLoadingToIdle()
{
m_progressEventTimer.stop();
// Schedule one last progress event so we guarantee that at least one is fired
// for files that load very quickly.
scheduleEvent(eventNames().progressEvent);
scheduleEvent(eventNames().suspendEvent);
m_networkState = NETWORK_IDLE;
}
void HTMLMediaElement::mediaPlayerReadyStateChanged()
{
if (isSuspended()) {
// FIXME: In some situations the MediaSource closing procedure triggerring a readyState
// update on the player, while the media element is suspended would lead to infinite
// recursion. The workaround is to attempt a fixed amount of recursions.
if (!m_isChangingReadyStateWhileSuspended) {
m_isChangingReadyStateWhileSuspended = true;
m_remainingReadyStateChangedAttempts.store(128);
}
if (m_remainingReadyStateChangedAttempts.exchangeSub(1)) {
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
mediaPlayerReadyStateChanged();
});
}
return;
}
beginProcessingMediaPlayerCallback();
setReadyState(m_player->readyState());
endProcessingMediaPlayerCallback();
m_isChangingReadyStateWhileSuspended = false;
m_remainingReadyStateChangedAttempts.store(0);
}
Expected<void, MediaPlaybackDenialReason> HTMLMediaElement::canTransitionFromAutoplayToPlay() const
{
if (m_readyState != HAVE_ENOUGH_DATA) {
ALWAYS_LOG(LOGIDENTIFIER, "m_readyState != HAVE_ENOUGH_DATA");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (!isAutoplaying()) {
ALWAYS_LOG(LOGIDENTIFIER, "!isAutoplaying");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (!mediaSession().autoplayPermitted()) {
ALWAYS_LOG(LOGIDENTIFIER, "!mediaSession().autoplayPermitted");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (!paused()) {
ALWAYS_LOG(LOGIDENTIFIER, "!paused");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (!autoplay()) {
ALWAYS_LOG(LOGIDENTIFIER, "!autoplay");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (pausedForUserInteraction()) {
ALWAYS_LOG(LOGIDENTIFIER, "pausedForUserInteraction");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
if (document().isSandboxed(SandboxFlag::AutomaticFeatures)) {
ALWAYS_LOG(LOGIDENTIFIER, "isSandboxed");
return makeUnexpected(MediaPlaybackDenialReason::PageConsentRequired);
}
auto permitted = mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing);
#if !RELEASE_LOG_DISABLED
if (!permitted)
ALWAYS_LOG(LOGIDENTIFIER, permitted.error());
else
ALWAYS_LOG(LOGIDENTIFIER, "can transition!");
#endif
return permitted;
}
void HTMLMediaElement::dispatchPlayPauseEventsIfNeedsQuirks()
{
if (!document().quirks().needsAutoplayPlayPauseEvents())
return;
ALWAYS_LOG(LOGIDENTIFIER);
scheduleEvent(eventNames().playingEvent);
scheduleEvent(eventNames().pauseEvent);
}
void HTMLMediaElement::durationChanged()
{
if (RefPtr textTracks = m_textTracks)
textTracks->setDuration(durationMediaTime());
scheduleEvent(eventNames().durationchangeEvent);
}
void HTMLMediaElement::applyConfiguration(const RemotePlaybackConfiguration& configuration)
{
ALWAYS_LOG(LOGIDENTIFIER);
if (configuration.currentTime)
setCurrentTime(configuration.currentTime);
if (configuration.rate != 1)
setPlaybackRate(configuration.rate);
if (!configuration.paused)
resumeAutoplaying();
}
void HTMLMediaElement::setReadyState(MediaPlayer::ReadyState state)
{
// Set "wasPotentiallyPlaying" BEFORE updating m_readyState, potentiallyPlaying() uses it
bool wasPotentiallyPlaying = potentiallyPlaying();
ReadyState oldState = m_readyState;
ReadyState newState = static_cast<ReadyState>(state);
bool tracksAreReady = textTracksAreReady();
if (newState == oldState && m_tracksAreReady == tracksAreReady)
return;
m_tracksAreReady = tracksAreReady;
ALWAYS_LOG(LOGIDENTIFIER, "new state = ", state, ", current state = ", m_readyState);
if (tracksAreReady)
m_readyState = newState;
else {
// If a media file has text tracks the readyState may not progress beyond HAVE_FUTURE_DATA until
// the text tracks are ready, regardless of the state of the media file.
if (newState <= HAVE_METADATA)
m_readyState = newState;
else
m_readyState = HAVE_CURRENT_DATA;
}
if (oldState > m_readyStateMaximum)
m_readyStateMaximum = oldState;
if (m_networkState == NETWORK_EMPTY)
return;
if (m_seeking) {
// 4.8.10.9, step 11
if (wasPotentiallyPlaying && m_readyState < HAVE_FUTURE_DATA) {
ALWAYS_LOG(LOGIDENTIFIER, "queuing waiting event, currentTime = ", currentMediaTime());
scheduleEvent(eventNames().waitingEvent);
}
// 4.8.10.10 step 14 & 15.
if (m_seekRequested && !m_player->seeking() && m_readyState >= HAVE_CURRENT_DATA)
finishSeek();
} else {
if (wasPotentiallyPlaying && m_readyState < HAVE_FUTURE_DATA) {
// 4.8.10.8
invalidateOfficialPlaybackPosition();
scheduleTimeupdateEvent(false);
scheduleEvent(eventNames().waitingEvent);
}
}
// Apply the first applicable set of substeps from the following list:
do {
// FIXME: The specification seems to only say HAVE_METADATA
// explicitly (rather than or higher) for this state. It's unclear
// if/how things like loadedmetadataEvent should happen if
// we go directly from below HAVE_METADATA to higher than
// HAVE_METADATA.
if (m_readyState >= HAVE_METADATA && oldState < HAVE_METADATA) {
prepareMediaFragmentURI();
durationChanged();
scheduleResizeEvent(m_player->naturalSize());
scheduleEvent(eventNames().loadedmetadataEvent);
if (m_defaultPlaybackStartPosition > MediaTime::zeroTime()) {
// We reset it before to cause currentMediaTime() to return the actual current time (not
// defaultPlaybackPosition) and avoid the seek code to think that the seek was already done.
MediaTime seekTarget = m_defaultPlaybackStartPosition;
m_defaultPlaybackStartPosition = MediaTime::zeroTime();
seekInternal(seekTarget);
}
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (hasEnabledTargetAvailabilityListeners())
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::OnlyWhenChanged);
#endif
updateRenderer();
if (RefPtr mediaDocument = dynamicDowncast<MediaDocument>(document()))
mediaDocument->mediaElementNaturalSizeChanged(expandedIntSize(m_player->naturalSize()));
logMediaLoadRequest(document().protectedPage().get(), m_player->engineDescription(), String(), true);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
scheduleUpdateMediaState();
#endif
mediaSession().clientCharacteristicsChanged(false);
// As the spec only mentiones HAVE_METADATA, run the later
// steps if we are moving to a higher state.
if (m_readyState == HAVE_METADATA)
break;
}
if (m_readyState >= HAVE_CURRENT_DATA && oldState < HAVE_CURRENT_DATA) {
if (!m_haveFiredLoadedData) {
m_haveFiredLoadedData = true;
scheduleEvent(eventNames().loadeddataEvent);
// FIXME: It's not clear that it's correct to skip these this operation just
// because m_haveFiredLoadedData is already true. At one time we were skipping
// the call to setShouldDelayLoadEvent, which was definitely incorrect.
applyMediaFragmentURI();
}
setShouldDelayLoadEvent(false);
// If the new ready state is HAVE_FUTURE_DATA or HAVE_ENOUGH_DATA, then the relevant steps below must then be run also.
if (m_readyState < HAVE_FUTURE_DATA)
break;
}
if (!tracksAreReady)
break;
if (oldState < HAVE_FUTURE_DATA && m_readyState >= HAVE_FUTURE_DATA) {
if (m_remotePlaybackConfiguration) {
applyConfiguration(*m_remotePlaybackConfiguration);
m_remotePlaybackConfiguration = { };
}
}
if (m_readyState == HAVE_FUTURE_DATA && oldState <= HAVE_CURRENT_DATA) {
scheduleEvent(eventNames().canplayEvent);
// If the element’s paused attribute is false, the user agent must queue a task to fire a simple event named playing at the element.
if (!paused())
scheduleNotifyAboutPlaying();
break;
}
if (m_readyState == HAVE_ENOUGH_DATA && oldState < HAVE_ENOUGH_DATA) {
// If the previous ready state was HAVE_CURRENT_DATA or less,
// the user agent must queue a media element task given the media element to fire an event named canplay at the element,
// and, if the element's paused attribute is false, notify about playing for the element.
if (oldState <= HAVE_CURRENT_DATA) {
scheduleEvent(eventNames().canplayEvent);
if (!paused())
scheduleNotifyAboutPlaying();
}
// The user agent must queue a media element task given the media element to fire an event named canplaythrough at the element.
scheduleEvent(eventNames().canplaythroughEvent);
// If the element is not eligible for autoplay, then the user agent must abort these substeps.
// The user agent may run the following substeps:
// Set the paused attribute to false.
// If the element's show poster flag is true, set it to false and run the time marches on steps.
// Queue a media element task given the element to fire an event named play at the element.
// Notify about playing for the element.
auto canTransition = canTransitionFromAutoplayToPlay();
if (canTransition) {
setPaused(false);
setShowPosterFlag(false);
invalidateOfficialPlaybackPosition();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::StartedWithoutUserGesture);
m_playbackStartedTime = currentMediaTime().toDouble();
scheduleEvent(eventNames().playEvent);
scheduleNotifyAboutPlaying();
} else if (canTransition.error() == MediaPlaybackDenialReason::UserGestureRequired) {
ALWAYS_LOG(LOGIDENTIFIER, "Autoplay blocked, user gesture required");
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
}
}
} while (false);
// If we transition to the Future Data state and we're about to begin playing, ensure playback is actually permitted first,
// honoring any playback denial reasons such as the requirement of a user gesture.
if (m_readyState == HAVE_FUTURE_DATA && oldState < HAVE_FUTURE_DATA && potentiallyPlaying() && !mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing)) {
auto canTransition = canTransitionFromAutoplayToPlay();
if (!canTransition && canTransition.error() == MediaPlaybackDenialReason::UserGestureRequired)
ALWAYS_LOG(LOGIDENTIFIER, "Autoplay blocked, user gesture required");
pauseInternal();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
}
updatePlayState();
updateMediaController();
updateActiveTextTrackCues(currentMediaTime());
updateBufferingState();
updateStalledState();
}
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
#if ENABLE(ENCRYPTED_MEDIA)
void HTMLMediaElement::updateShouldContinueAfterNeedKey()
{
if (!m_player)
return;
bool shouldContinue = hasEventListeners(eventNames().webkitneedkeyEvent) || (document().settings().encryptedMediaAPIEnabled() && !document().quirks().hasBrokenEncryptedMediaAPISupportQuirk());
RefPtr { m_player }->setShouldContinueAfterKeyNeeded(shouldContinue);
}
#endif
RefPtr<ArrayBuffer> HTMLMediaElement::mediaPlayerCachedKeyForKeyId(const String& keyId) const
{
return m_webKitMediaKeys ? m_webKitMediaKeys->cachedKeyForKeyId(keyId) : nullptr;
}
void HTMLMediaElement::mediaPlayerKeyNeeded(const SharedBuffer& initData)
{
if (!document().settings().legacyEncryptedMediaAPIEnabled())
return;
if (!hasEventListeners(eventNames().webkitneedkeyEvent)
#if ENABLE(ENCRYPTED_MEDIA)
// Only fire an error if ENCRYPTED_MEDIA is not enabled, to give clients of the
// "encrypted" event a chance to handle it without resulting in a synthetic error.
&& (!document().settings().encryptedMediaAPIEnabled() || document().quirks().hasBrokenEncryptedMediaAPISupportQuirk())
#endif
) {
m_error = MediaError::create(MediaError::MEDIA_ERR_ENCRYPTED, "Media is encrypted"_s);
scheduleEvent(eventNames().errorEvent);
return;
}
WebKitMediaKeyNeededEvent::Init init;
if (auto initDataBuffer = initData.tryCreateArrayBuffer())
init.initData = Uint8Array::create(initDataBuffer.releaseNonNull());
Ref event = WebKitMediaKeyNeededEvent::create(eventNames().webkitneedkeyEvent, init);
scheduleEvent(WTFMove(event));
}
String HTMLMediaElement::mediaPlayerMediaKeysStorageDirectory() const
{
return document().mediaKeysStorageDirectory();
}
void HTMLMediaElement::webkitSetMediaKeys(WebKitMediaKeys* mediaKeys)
{
if (!document().settings().legacyEncryptedMediaAPIEnabled())
return;
if (m_webKitMediaKeys == mediaKeys)
return;
if (RefPtr webKitMediaKeys = m_webKitMediaKeys)
webKitMediaKeys->setMediaElement(nullptr);
m_webKitMediaKeys = mediaKeys;
if (RefPtr webKitMediaKeys = m_webKitMediaKeys)
webKitMediaKeys->setMediaElement(this);
}
void HTMLMediaElement::keyAdded()
{
if (!document().settings().legacyEncryptedMediaAPIEnabled())
return;
if (RefPtr player = m_player)
player->keyAdded();
}
#endif
#if ENABLE(ENCRYPTED_MEDIA)
MediaKeys* HTMLMediaElement::mediaKeys() const
{
return m_mediaKeys.get();
}
void HTMLMediaElement::setMediaKeys(MediaKeys* mediaKeys, Ref<DeferredPromise>&& promise)
{
// https://w3c.github.io/encrypted-media/#dom-htmlmediaelement-setmediakeys
// W3C Editor's Draft 23 June 2017
// 1. If this object's attaching media keys value is true, return a promise rejected with an InvalidStateError.
if (m_attachingMediaKeys) {
promise->reject(ExceptionCode::InvalidStateError);
return;
}
// 2. If mediaKeys and the mediaKeys attribute are the same object, return a resolved promise.
if (mediaKeys == m_mediaKeys) {
promise->resolve();
return;
}
// 3. Let this object's attaching media keys value be true.
m_attachingMediaKeys = true;
// 4. Let promise be a new promise.
// 5. Run the following steps in parallel:
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, mediaKeys = RefPtr { mediaKeys }, promise = WTFMove(promise)]() mutable {
if (isContextStopped())
return;
// 5.1. If all the following conditions hold:
// - mediaKeys is not null,
// - the CDM instance represented by mediaKeys is already in use by another media element
// - the user agent is unable to use it with this element
// then let this object's attaching media keys value be false and reject promise with a QuotaExceededError.
// FIXME: ^
// 5.2. If the mediaKeys attribute is not null, run the following steps:
if (m_mediaKeys) {
// 5.2.1. If the user agent or CDM do not support removing the association, let this object's attaching media keys value be false and reject promise with a NotSupportedError.
// 5.2.2. If the association cannot currently be removed, let this object's attaching media keys value be false and reject promise with an InvalidStateError.
// 5.2.3. Stop using the CDM instance represented by the mediaKeys attribute to decrypt media data and remove the association with the media element.
// 5.2.4. If the preceding step failed, let this object's attaching media keys value be false and reject promise with the appropriate error name.
// FIXME: ^
m_mediaKeys->detachCDMClient(*this);
if (RefPtr player = m_player)
player->cdmInstanceDetached(m_mediaKeys->protectedCDMInstance());
}
// 5.3. If mediaKeys is not null, run the following steps:
if (mediaKeys) {
// 5.3.1. Associate the CDM instance represented by mediaKeys with the media element for decrypting media data.
mediaKeys->attachCDMClient(*this);
if (RefPtr player = m_player)
player->cdmInstanceAttached(mediaKeys->protectedCDMInstance());
// 5.3.2. If the preceding step failed, run the following steps:
// 5.3.2.1. Set the mediaKeys attribute to null.
// 5.3.2.2. Let this object's attaching media keys value be false.
// 5.3.2.3. Reject promise with a new DOMException whose name is the appropriate error name.
// FIXME: ^
// 5.3.3. Queue a task to run the Attempt to Resume Playback If Necessary algorithm on the media element.
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
if (!isContextStopped())
attemptToResumePlaybackIfNecessary();
});
}
// 5.4. Set the mediaKeys attribute to mediaKeys.
// 5.5. Let this object's attaching media keys value be false.
// 5.6. Resolve promise.
m_mediaKeys = WTFMove(mediaKeys);
m_attachingMediaKeys = false;
promise->resolve();
});
// 6. Return promise.
}
void HTMLMediaElement::mediaPlayerInitializationDataEncountered(const String& initDataType, RefPtr<ArrayBuffer>&& initData)
{
if (!document().settings().encryptedMediaAPIEnabled() || document().quirks().hasBrokenEncryptedMediaAPISupportQuirk())
return;
// https://w3c.github.io/encrypted-media/#initdata-encountered
// W3C Editor's Draft 23 June 2017
// 1. Let the media element be the specified HTMLMediaElement object.
// 2. Let initDataType be the empty string.
// 3. Let initData be null.
// 4. If the media data is CORS-same-origin and not mixed content, run the following steps:
// 4.1. Let initDataType be the string representing the Initialization Data Type of the Initialization Data.
// 4.2. Let initData be the Initialization Data.
// FIXME: ^
// 5. Queue a task to create an event named encrypted that does not bubble and is not cancellable using the
// MediaEncryptedEvent interface with its type attribute set to encrypted and its isTrusted attribute
// initialized to true, and dispatch it at the media element.
// The event interface MediaEncryptedEvent has:
// initDataType = initDataType
// initData = initData
MediaEncryptedEventInit initializer { initDataType, WTFMove(initData) };
scheduleEvent(MediaEncryptedEvent::create(eventNames().encryptedEvent, initializer, Event::IsTrusted::Yes));
}
void HTMLMediaElement::mediaPlayerWaitingForKeyChanged()
{
if (!m_player)
return;
if (!m_player->waitingForKey() && m_playbackBlockedWaitingForKey) {
// https://w3c.github.io/encrypted-media/#resume-playback
// W3C Editor's Draft 23 June 2017
// NOTE: continued from HTMLMediaElement::attemptToDecrypt().
// 4. If the user agent can advance the current playback position in the direction of playback:
// 4.1. Set the media element's decryption blocked waiting for key value to false.
// FIXME: ^
// 4.2. Set the media element's playback blocked waiting for key value to false.
m_playbackBlockedWaitingForKey = false;
// 4.3. Set the media element's readyState value to HAVE_CURRENT_DATA, HAVE_FUTURE_DATA or HAVE_ENOUGH_DATA as appropriate.
setReadyState(m_player->readyState());
return;
}
// https://www.w3.org/TR/encrypted-media/#wait-for-key
// W3C Recommendation 18 September 2017
// The Wait for Key algorithm queues a waitingforkey event and
// updates readyState. It should only be called when the
// HTMLMediaElement object is potentially playing and its
// readyState is equal to HAVE_FUTURE_DATA or greater. Requests to
// run this algorithm include a target HTMLMediaElement object.
// The following steps are run:
// 1. Let the media element be the specified HTMLMediaElement
// object.
// 2. If the media element's playback blocked waiting for key
// value is true, abort these steps.
if (m_playbackBlockedWaitingForKey)
return;
// 3. Set the media element's playback blocked waiting for key
// value to true.
m_playbackBlockedWaitingForKey = true;
// NOTE
// As a result of the above step, the media element will become a
// blocked media element if it wasn't already. In that case, the
// media element will stop playback.
// 4. Follow the steps for the first matching condition from the
// following list:
// If data for the immediate current playback position is
// available
// Set the readyState of media element to HAVE_CURRENT_DATA.
// Otherwise
// Set the readyState of media element to HAVE_METADATA.
ReadyState nextReadyState = buffered()->contain(currentTime()) ? HAVE_CURRENT_DATA : HAVE_METADATA;
if (nextReadyState < m_readyState)
setReadyState(static_cast<MediaPlayer::ReadyState>(nextReadyState));
// NOTE
// In other words, if the video frame and audio data for the
// current playback position have been decoded because they were
// unencrypted and/or successfully decrypted, set readyState to
// HAVE_CURRENT_DATA. Otherwise, including if this was previously
// the case but the data is no longer available, set readyState to
// HAVE_METADATA.
// 5. Queue a task to fire a simple event named waitingforkey at the
// media element.
scheduleEvent(eventNames().waitingforkeyEvent);
// 6. Suspend playback.
// GStreamer handles this without suspending explicitly.
}
void HTMLMediaElement::attemptToDecrypt()
{
// https://w3c.github.io/encrypted-media/#attempt-to-decrypt
// W3C Editor's Draft 23 June 2017
// 1. Let the media element be the specified HTMLMediaElement object.
// 2. If the media element's encrypted block queue is empty, abort these steps.
// FIXME: ^
// 3. If the media element's mediaKeys attribute is not null, run the following steps:
if (m_mediaKeys) {
// 3.1. Let media keys be the MediaKeys object referenced by that attribute.
// 3.2. Let cdm be the CDM instance represented by media keys's cdm instance value.
Ref cdmInstance = m_mediaKeys->cdmInstance();
// 3.3. If cdm is no longer usable for any reason, run the following steps:
// 3.3.1. Run the media data is corrupted steps of the resource fetch algorithm.
// 3.3.2. Run the CDM Unavailable algorithm on media keys.
// 3.3.3. Abort these steps.
// FIXME: ^
// 3.4. If there is at least one MediaKeySession created by the media keys that is not closed, run the following steps:
if (m_mediaKeys->hasOpenSessions()) {
// Continued in MediaPlayer::attemptToDecryptWithInstance().
if (RefPtr player = m_player)
player->attemptToDecryptWithInstance(cdmInstance);
}
}
// 4. Set the media element's decryption blocked waiting for key value to true.
// FIXME: ^
}
void HTMLMediaElement::attemptToResumePlaybackIfNecessary()
{
// https://w3c.github.io/encrypted-media/#resume-playback
// W3C Editor's Draft 23 June 2017
// 1. Let the media element be the specified HTMLMediaElement object.
// 2. If the media element's playback blocked waiting for key is false, abort these steps.
if (!m_playbackBlockedWaitingForKey)
return;
// 3. Run the Attempt to Decrypt algorithm on the media element.
attemptToDecrypt();
// NOTE: continued in HTMLMediaElement::waitingForKeyChanged()
}
void HTMLMediaElement::cdmClientAttemptToResumePlaybackIfNecessary()
{
attemptToResumePlaybackIfNecessary();
}
void HTMLMediaElement::cdmClientUnrequestedInitializationDataReceived(const String& initDataType, Ref<SharedBuffer>&& initData)
{
mediaPlayerInitializationDataEncountered(initDataType, initData->tryCreateArrayBuffer());
}
#endif // ENABLE(ENCRYPTED_MEDIA)
void HTMLMediaElement::progressEventTimerFired()
{
ASSERT(m_player);
if (m_networkState != NETWORK_LOADING)
return;
updateSleepDisabling();
if (!m_player->supportsProgressMonitoring())
return;
m_player->didLoadingProgress([this, weakThis = WeakPtr { *this }](bool progress) {
RefPtr protectedThis = weakThis.get();
if (!protectedThis)
return;
MonotonicTime time = MonotonicTime::now();
Seconds timedelta = time - m_previousProgressTime;
if (progress) {
scheduleEvent(eventNames().progressEvent);
m_previousProgressTime = time;
if (m_sentStalledEvent) {
m_sentStalledEvent = false;
updateStalledState();
}
updateRenderer();
} else if (timedelta > 3_s && !m_sentStalledEvent) {
scheduleEvent(eventNames().stalledEvent);
m_sentStalledEvent = true;
updateStalledState();
setShouldDelayLoadEvent(false);
}
});
}
void HTMLMediaElement::rewind(double timeDelta)
{
setCurrentTime(std::max(currentMediaTime() - MediaTime::createWithDouble(timeDelta), minTimeSeekable()));
}
void HTMLMediaElement::returnToRealtime()
{
setCurrentTime(maxTimeSeekable());
}
void HTMLMediaElement::addPlayedRange(const MediaTime& start, const MediaTime& end)
{
DEBUG_LOG(LOGIDENTIFIER, MediaTimeRange { start, end });
if (!m_playedTimeRanges)
m_playedTimeRanges = TimeRanges::create();
m_playedTimeRanges->ranges().add(start, end);
}
bool HTMLMediaElement::supportsScanning() const
{
return m_player ? m_player->supportsScanning() : false;
}
void HTMLMediaElement::prepareToPlay()
{
ScriptDisallowedScope::InMainThread scriptDisallowedScope;
INFO_LOG(LOGIDENTIFIER);
if (m_havePreparedToPlay || !document().hasBrowsingContext())
return;
m_havePreparedToPlay = true;
if (RefPtr player = m_player)
player->prepareToPlay();
}
void HTMLMediaElement::fastSeek(double time)
{
fastSeek(MediaTime::createWithDouble(time));
}
void HTMLMediaElement::fastSeek(const MediaTime& time)
{
ALWAYS_LOG(LOGIDENTIFIER, time);
// 4.7.10.9 Seeking
// 9. If the approximate-for-speed flag is set, adjust the new playback position to a value that will
// allow for playback to resume promptly. If new playback position before this step is before current
// playback position, then the adjusted new playback position must also be before the current playback
// position. Similarly, if the new playback position before this step is after current playback position,
// then the adjusted new playback position must also be after the current playback position.
invalidateOfficialPlaybackPosition();
MediaTime delta = time - currentMediaTime();
MediaTime negativeTolerance = delta < MediaTime::zeroTime() ? MediaTime::positiveInfiniteTime() : delta;
seekWithTolerance({ time, negativeTolerance, MediaTime::zeroTime() }, true);
}
#if ENABLE(MEDIA_STREAM)
void HTMLMediaElement::setAudioOutputDevice(String&& deviceId, DOMPromiseDeferred<void>&& promise)
{
RefPtr window = document().domWindow();
RefPtr mediaDevices = window ? NavigatorMediaDevices::mediaDevices(window->navigator()) : nullptr;
if (!mediaDevices) {
promise.reject(Exception { ExceptionCode::NotAllowedError });
return;
}
if (!document().processingUserGestureForMedia() && document().settings().speakerSelectionRequiresUserGesture()) {
promise.reject(Exception { ExceptionCode::NotAllowedError, "A user gesture is required"_s });
return;
}
if (deviceId.isEmpty())
deviceId = { };
if (deviceId == m_audioOutputHashedDeviceId) {
promise.resolve();
return;
}
String persistentId;
if (!deviceId.isNull()) {
persistentId = mediaDevices->deviceIdToPersistentId(deviceId);
if (persistentId.isNull()) {
promise.reject(Exception { ExceptionCode::NotFoundError });
return;
}
}
m_audioOutputPersistentDeviceId = WTFMove(persistentId);
if (RefPtr player = m_player)
player->audioOutputDeviceChanged();
protectedScriptExecutionContext()->checkedEventLoop()->queueTask(TaskSource::MediaElement, [this, protectedThis = Ref { *this }, deviceId = WTFMove(deviceId), promise = WTFMove(promise)]() mutable {
m_audioOutputHashedDeviceId = WTFMove(deviceId);
promise.resolve();
});
}
#endif
void HTMLMediaElement::seek(const MediaTime& time)
{
ALWAYS_LOG(LOGIDENTIFIER, time);
seekWithTolerance({ time, MediaTime::zeroTime(), MediaTime::zeroTime() }, true);
}
void HTMLMediaElement::seekInternal(const MediaTime& time)
{
ALWAYS_LOG(LOGIDENTIFIER, time);
seekWithTolerance({ time, MediaTime::zeroTime(), MediaTime::zeroTime() }, false);
}
void HTMLMediaElement::seekWithTolerance(const SeekTarget& target, bool fromDOM)
{
ALWAYS_LOG(LOGIDENTIFIER, "SeekTarget = ", target);
// 4.8.10.9 Seeking
// 1 - Set the media element's show poster flag to false.
setShowPosterFlag(false);
// 2 - If the media element's readyState is HAVE_NOTHING, abort these steps.
if (m_readyState == HAVE_NOTHING || !m_player)
return;
// If the media engine has been told to postpone loading data, let it go ahead now.
if (m_preload < MediaPlayer::Preload::Auto && m_readyState < HAVE_FUTURE_DATA)
prepareToPlay();
// Get the current time before setting m_seeking, m_lastSeekTime is returned once it is set.
invalidateOfficialPlaybackPosition();
MediaTime now = currentMediaTime();
// 3 - If the element's seeking IDL attribute is true, then another instance of this algorithm is
// already running. Abort that other instance of the algorithm without waiting for the step that
// it is running to complete.
if (m_seekTaskCancellationGroup.hasPendingTask()) {
INFO_LOG(LOGIDENTIFIER, "cancelling pending seeks");
m_seekTaskCancellationGroup.cancel();
if (m_pendingSeek) {
now = m_pendingSeek->now;
m_pendingSeek = nullptr;
}
m_pendingSeekType = NoSeek;
}
// 4 - Set the seeking IDL attribute to true.
// The flag will be cleared when the engine tells us the time has actually changed.
setSeeking(true);
if (m_playing) {
if (m_lastSeekTime < now)
addPlayedRange(m_lastSeekTime, now);
}
m_lastSeekTime = std::min(target.time, durationMediaTime());
if (m_player)
m_player->willSeekToTarget(target.time);
// 5 - If the seek was in response to a DOM method call or setting of an IDL attribute, then continue
// the script. The remainder of these steps must be run asynchronously.
m_pendingSeek = makeUnique<PendingSeek>(now, target);
if (fromDOM) {
ALWAYS_LOG(LOGIDENTIFIER, "enqueuing seek from ", now, " to ", target.time);
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_seekTaskCancellationGroup, std::bind(&HTMLMediaElement::seekTask, this));
} else
seekTask();
if (processingUserGestureForMedia())
mediaSession().removeBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
ImageOverlay::removeOverlaySoonIfNeeded(*this);
}
void HTMLMediaElement::seekTask()
{
INFO_LOG(LOGIDENTIFIER);
if (!m_player) {
clearSeeking();
return;
}
ASSERT(m_pendingSeek);
MediaTime now = m_pendingSeek->now;
MediaTime time = m_pendingSeek->target.time;
MediaTime negativeTolerance = m_pendingSeek->target.negativeThreshold;
MediaTime positiveTolerance = m_pendingSeek->target.positiveThreshold;
m_pendingSeek = nullptr;
ASSERT(negativeTolerance.isValid());
ASSERT(negativeTolerance >= MediaTime::zeroTime());
ASSERT(positiveTolerance.isValid());
ASSERT(positiveTolerance >= MediaTime::zeroTime());
// 6 - If the new playback position is later than the end of the media resource, then let it be the end
// of the media resource instead.
time = std::min(time, durationMediaTime());
// 7 - If the new playback position is less than the earliest possible position, let it be that position instead.
MediaTime earliestTime = m_player->startTime();
time = std::max(time, earliestTime);
// Ask the media engine for the time value in the movie's time scale before comparing with current time. This
// is necessary because if the seek time is not equal to currentTime but the delta is less than the movie's
// time scale, we will ask the media engine to "seek" to the current movie time, which may be a noop and
// not generate a timechanged callback. This means m_seeking will never be cleared and we will never
// fire a 'seeked' event.
if (willLog(WTFLogLevel::Info)) {
MediaTime mediaTime = m_player->mediaTimeForTimeValue(time);
if (time != mediaTime)
INFO_LOG(LOGIDENTIFIER, time, " media timeline equivalent is ", mediaTime);
}
time = m_player->mediaTimeForTimeValue(time);
// 8 - If the (possibly now changed) new playback position is not in one of the ranges given in the
// seekable attribute, then let it be the position in one of the ranges given in the seekable attribute
// that is the nearest to the new playback position. ... If there are no ranges given in the seekable
// attribute then set the seeking IDL attribute to false and abort these steps.
RefPtr seekableRanges = seekable();
bool noSeekRequired = !seekableRanges->length();
// Short circuit seeking to the current time by just firing the events if no seek is required.
// Don't skip calling the media engine if 1) we are in poster mode (because a seek should always cancel
// poster display), or 2) if there is a pending fast seek, or 3) if this seek is not an exact seek
SeekType thisSeekType = (negativeTolerance == MediaTime::zeroTime() && positiveTolerance == MediaTime::zeroTime()) ? Precise : Fast;
if (!noSeekRequired && time == now && thisSeekType == Precise && m_pendingSeekType != Fast && !showPosterFlag())
noSeekRequired = true;
#if ENABLE(MEDIA_SOURCE)
// Always notify the media engine of a seek if the source is not closed and there is seekable ranges.
// This ensures that the source is always in a flushed state when the 'seeking' event fires.
if (m_mediaSource && !m_mediaSource->isClosed() && seekableRanges->length())
noSeekRequired = false;
#endif
if (noSeekRequired) {
ALWAYS_LOG(LOGIDENTIFIER, "ignored seek to ", time);
if (time == now) {
scheduleEvent(eventNames().seekingEvent);
scheduleTimeupdateEvent(false);
scheduleEvent(eventNames().seekedEvent);
if (document().quirks().needsCanPlayAfterSeekedQuirk() && m_readyState > HAVE_CURRENT_DATA)
scheduleEvent(eventNames().canplayEvent);
}
clearSeeking();
return;
}
time = seekableRanges->ranges().nearest(time);
m_sentEndEvent = false;
m_lastSeekTime = time;
m_pendingSeekType = thisSeekType;
setSeeking(true);
// 10 - Queue a task to fire a simple event named seeking at the element.
scheduleEvent(eventNames().seekingEvent);
// 11 - Set the current playback position to the given new playback position
m_seekRequested = true;
RefPtr { m_player }->seekToTarget({ time, negativeTolerance, positiveTolerance });
// 12 - Wait until the user agent has established whether or not the media data for the new playback
// position is available, and, if it is, until it has decoded enough data to play back that position.
// 13 - Await a stable state. The synchronous section consists of all the remaining steps of this algorithm.
if (!shouldSpeakCueTextForTime(time))
cancelSpeakingCueText();
}
void HTMLMediaElement::clearSeeking()
{
if (m_player)
m_player->willSeekToTarget(MediaTime::invalidTime());
setSeeking(false);
m_seekRequested = false;
m_pendingSeekType = NoSeek;
m_wasPlayingBeforeSeeking = false;
invalidateOfficialPlaybackPosition();
}
void HTMLMediaElement::finishSeek()
{
bool wasPlayingBeforeSeeking = m_wasPlayingBeforeSeeking;
// 4.8.10.9 Seeking
// 14 - Set the seeking IDL attribute to false.
clearSeeking();
ALWAYS_LOG(LOGIDENTIFIER, "current time = ", currentMediaTime(), ", pending seek = ", !!m_pendingSeek);
if (!m_pendingSeek) {
// Don't update text track cues immediately because there are frequently several seeks in quick
// succession when time is changed by clicking in the media controls.
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_updateTextTracksTaskCancellationGroup, [this] {
if (!m_ignoreTrackDisplayUpdate && m_inActiveDocument)
updateActiveTextTrackCues(currentMediaTime());
});
}
// 15 - Run the time maches on steps.
// Handled by mediaPlayerTimeChanged().
// 16 - Queue a task to fire a simple event named timeupdate at the element.
scheduleEvent(eventNames().timeupdateEvent);
// 17 - Queue a task to fire a simple event named seeked at the element.
scheduleEvent(eventNames().seekedEvent);
if (document().quirks().needsCanPlayAfterSeekedQuirk() && m_readyState > HAVE_CURRENT_DATA)
scheduleEvent(eventNames().canplayEvent);
if (m_mediaSession)
m_mediaSession->clientCharacteristicsChanged(true);
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = m_mediaSource)
mediaSource->monitorSourceBuffers();
#endif
if (wasPlayingBeforeSeeking)
playInternal();
}
HTMLMediaElement::ReadyState HTMLMediaElement::readyState() const
{
return m_readyState;
}
MediaPlayer::MovieLoadType HTMLMediaElement::movieLoadType() const
{
return m_player ? m_player->movieLoadType() : MediaPlayer::MovieLoadType::Unknown;
}
std::optional<MediaSessionGroupIdentifier> HTMLMediaElement::mediaSessionGroupIdentifier() const
{
return document().page() ? document().page()->mediaSessionGroupIdentifier() : std::nullopt;
}
bool HTMLMediaElement::hasAudio() const
{
return m_player ? m_player->hasAudio() : false;
}
bool HTMLMediaElement::seeking() const
{
return m_seeking;
}
void HTMLMediaElement::setSeeking(bool seeking)
{
if (m_seeking == seeking)
return;
Style::PseudoClassChangeInvalidation styleInvalidation(*this, CSSSelector::PseudoClass::Seeking, seeking);
m_seeking = seeking;
}
void HTMLMediaElement::invalidateOfficialPlaybackPosition()
{
m_officialPlaybackPosition = MediaTime::invalidTime();
}
// playback state
double HTMLMediaElement::currentTime() const
{
return currentMediaTime().toDouble();
}
MediaTime HTMLMediaElement::currentMediaTime() const
{
if (!m_player)
return MediaTime::zeroTime();
if (m_defaultPlaybackStartPosition != MediaTime::zeroTime())
return m_defaultPlaybackStartPosition;
if (m_seeking) {
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_CURRENTMEDIATIME_SEEKING, m_lastSeekTime.toFloat());
return m_lastSeekTime;
}
if (m_officialPlaybackPosition.isValid() && m_paused)
return m_officialPlaybackPosition;
m_officialPlaybackPosition = m_player->currentTime();
if (m_officialPlaybackPosition.isInvalid())
return MediaTime::zeroTime();
return m_officialPlaybackPosition;
}
void HTMLMediaElement::setCurrentTime(double time)
{
setCurrentTime(MediaTime::createWithDouble(time));
}
void HTMLMediaElement::setCurrentTimeWithTolerance(double time, double toleranceBefore, double toleranceAfter)
{
seekWithTolerance({ MediaTime::createWithDouble(time), MediaTime::createWithDouble(toleranceBefore), MediaTime::createWithDouble(toleranceAfter) }, true);
}
void HTMLMediaElement::setCurrentTime(const MediaTime& time)
{
if (m_mediaController)
return;
seekInternal(time);
}
ExceptionOr<void> HTMLMediaElement::setCurrentTimeForBindings(double time)
{
if (m_mediaController)
return Exception { ExceptionCode::InvalidStateError };
time = clampTo(time, 0.0);
if (m_readyState == HAVE_NOTHING || !m_player) {
m_defaultPlaybackStartPosition = MediaTime::createWithDouble(time);
return { };
}
seek(MediaTime::createWithDouble(time));
return { };
}
double HTMLMediaElement::duration() const
{
return durationMediaTime().toDouble();
}
MediaTime HTMLMediaElement::durationMediaTime() const
{
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource)
return m_mediaSource->duration();
#endif
if (m_player && m_readyState >= HAVE_METADATA)
return m_player->duration();
return MediaTime::invalidTime();
}
bool HTMLMediaElement::paused() const
{
// As of this writing, JavaScript garbage collection calls this function directly. In the past
// we had problems where this was called on an object after a bad cast. The assertion below
// made our regression test detect the problem, so we should keep it because of that. But note
// that the value of the assertion relies on the compiler not being smart enough to know that
// isHTMLUnknownElement is guaranteed to return false for an HTMLMediaElement.
ASSERT(!isHTMLUnknownElement());
return m_paused;
}
void HTMLMediaElement::setPaused(bool paused)
{
if (m_paused == paused)
return;
Style::PseudoClassChangeInvalidation styleInvalidation(*this, {
{ CSSSelector::PseudoClass::Paused, paused },
{ CSSSelector::PseudoClass::Playing, !paused },
});
m_paused = paused;
updateBufferingState();
updateStalledState();
}
double HTMLMediaElement::defaultPlaybackRate() const
{
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "defaultPlaybackRate" - On setting: ignored. On getting: return 1.0
// A MediaStream is not seekable. Therefore, this attribute must always have the
// value 1.0 and any attempt to alter it must be ignored. Note that this also means
// that the ratechange event will not fire.
if (m_mediaStreamSrcObject)
return 1;
#endif
return m_defaultPlaybackRate;
}
void HTMLMediaElement::setDefaultPlaybackRate(double rate)
{
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "defaultPlaybackRate" - On setting: ignored. On getting: return 1.0
// A MediaStream is not seekable. Therefore, this attribute must always have the
// value 1.0 and any attempt to alter it must be ignored. Note that this also means
// that the ratechange event will not fire.
if (m_mediaStreamSrcObject)
return;
#endif
if (m_defaultPlaybackRate == rate)
return;
ALWAYS_LOG(LOGIDENTIFIER, rate);
m_defaultPlaybackRate = rate;
scheduleEvent(eventNames().ratechangeEvent);
}
double HTMLMediaElement::effectivePlaybackRate() const
{
return m_mediaController ? m_mediaController->playbackRate() : m_reportedPlaybackRate;
}
double HTMLMediaElement::requestedPlaybackRate() const
{
return m_mediaController ? m_mediaController->playbackRate() : m_requestedPlaybackRate;
}
double HTMLMediaElement::playbackRate() const
{
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "playbackRate" - A MediaStream is not seekable. Therefore, this attribute must always
// have the value 1.0 and any attempt to alter it must be ignored. Note that this also
// means that the ratechange event will not fire.
if (m_mediaStreamSrcObject)
return 1;
#endif
return m_requestedPlaybackRate;
}
void HTMLMediaElement::setPlaybackRate(double rate)
{
ALWAYS_LOG(LOGIDENTIFIER, rate);
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "playbackRate" - A MediaStream is not seekable. Therefore, this attribute must always
// have the value 1.0 and any attempt to alter it must be ignored. Note that this also
// means that the ratechange event will not fire.
if (m_mediaStreamSrcObject)
return;
#endif
if (m_player && potentiallyPlaying() && !m_mediaController)
RefPtr { m_player }->setRate(rate);
if (m_requestedPlaybackRate != rate) {
m_reportedPlaybackRate = m_requestedPlaybackRate = rate;
scheduleEvent(eventNames().ratechangeEvent);
}
}
void HTMLMediaElement::updatePlaybackRate()
{
double requestedRate = requestedPlaybackRate();
if (m_player && potentiallyPlaying() && m_player->rate() != requestedRate)
RefPtr { m_player }->setRate(requestedRate);
}
bool HTMLMediaElement::preservesPitch() const
{
return m_preservesPitch;
}
void HTMLMediaElement::setPreservesPitch(bool preservesPitch)
{
INFO_LOG(LOGIDENTIFIER, preservesPitch);
m_preservesPitch = preservesPitch;
if (!m_player)
return;
RefPtr { m_player }->setPreservesPitch(preservesPitch);
}
bool HTMLMediaElement::ended() const
{
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// When the MediaStream state moves from the active to the inactive state, the User Agent
// must raise an ended event on the HTMLMediaElement and set its ended attribute to true.
if (m_mediaStreamSrcObject && m_player && m_player->ended())
return true;
#endif
// 4.8.10.8 Playing the media resource
// The ended attribute must return true if the media element has ended
// playback and the direction of playback is forwards, and false otherwise.
return endedPlayback() && requestedPlaybackRate() > 0;
}
bool HTMLMediaElement::autoplay() const
{
return hasAttributeWithoutSynchronization(autoplayAttr);
}
String HTMLMediaElement::preload() const
{
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "preload" - On getting: none. On setting: ignored.
if (m_mediaStreamSrcObject)
return noneAtom();
#endif
switch (m_preload) {
case MediaPlayer::Preload::None:
return noneAtom();
case MediaPlayer::Preload::MetaData:
return "metadata"_s;
case MediaPlayer::Preload::Auto:
return autoAtom();
}
ASSERT_NOT_REACHED();
return String();
}
void HTMLMediaElement::setPreload(const AtomString& preload)
{
ALWAYS_LOG(LOGIDENTIFIER, preload);
#if ENABLE(MEDIA_STREAM)
// http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
// "preload" - On getting: none. On setting: ignored.
if (m_mediaStreamSrcObject)
return;
#endif
setAttributeWithoutSynchronization(preloadAttr, preload);
}
void HTMLMediaElement::play(DOMPromiseDeferred<void>&& promise)
{
ALWAYS_LOG(LOGIDENTIFIER);
auto permitted = mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing);
if (!permitted) {
if (permitted.error() == MediaPlaybackDenialReason::UserGestureRequired)
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
ERROR_LOG(LOGIDENTIFIER, "rejecting promise: ", permitted.error());
promise.reject(ExceptionCode::NotAllowedError);
return;
}
if (m_error && m_error->code() == MediaError::MEDIA_ERR_SRC_NOT_SUPPORTED) {
ERROR_LOG(LOGIDENTIFIER, "rejecting promise because of error");
promise.reject(ExceptionCode::NotSupportedError, "The operation is not supported."_s);
return;
}
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture();
else {
// If we are allowed to explicitly play without a user gesture, remove the restriction
// preventing invisible autoplay, as that will cause explicit playback to be interrupted
// by updateShouldAutoplay().
mediaSession().removeBehaviorRestriction(MediaElementSession::InvisibleAutoplayNotPermitted);
}
m_pendingPlayPromises.append(WTFMove(promise));
playInternal();
}
void HTMLMediaElement::play()
{
ALWAYS_LOG(LOGIDENTIFIER);
auto permitted = mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing);
if (!permitted) {
ERROR_LOG(LOGIDENTIFIER, "playback not permitted: ", permitted.error());
if (permitted.error() == MediaPlaybackDenialReason::UserGestureRequired)
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
return;
}
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture();
playInternal();
}
void HTMLMediaElement::playInternal()
{
ALWAYS_LOG(LOGIDENTIFIER);
if (isSuspended()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because context is suspended");
return;
}
if (!document().hasBrowsingContext()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because there is no browsing context");
return;
}
mediaSession().setActive(true);
if (!mediaSession().clientWillBeginPlayback()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because of interruption");
return;
}
// 4.8.10.9. Playing the media resource
if (!m_player || m_networkState == NETWORK_EMPTY)
selectMediaResource();
if (endedPlayback())
seekInternal(MediaTime::zeroTime());
if (RefPtr mediaController = m_mediaController)
mediaController->bringElementUpToSpeed(*this);
if (m_paused) {
setPaused(false);
setShowPosterFlag(false);
invalidateOfficialPlaybackPosition();
// This avoids the first timeUpdated event after playback starts, when currentTime is still
// the same as it was when the video was paused (and the time hasn't changed yet).
m_lastTimeUpdateEventMovieTime = currentMediaTime();
m_playbackStartedTime = m_lastTimeUpdateEventMovieTime.toDouble();
scheduleEvent(eventNames().playEvent);
// If the media element's readyState attribute has the value HAVE_NOTHING, HAVE_METADATA, or HAVE_CURRENT_DATA,
// queue a media element task given the media element to fire an event named waiting at the element.
// Otherwise, the media element's readyState attribute has the value HAVE_FUTURE_DATA or HAVE_ENOUGH_DATA:
// notify about playing for the element.
if (m_readyState <= HAVE_CURRENT_DATA)
scheduleEvent(eventNames().waitingEvent);
else
scheduleNotifyAboutPlaying();
} else if (m_readyState >= HAVE_FUTURE_DATA)
scheduleResolvePendingPlayPromises();
if (processingUserGestureForMedia()) {
if (m_autoplayEventPlaybackState == AutoplayEventPlaybackState::PreventedAutoplay) {
handleAutoplayEvent(AutoplayEvent::DidPlayMediaWithUserGesture);
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
} else
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::StartedWithUserGesture);
} else
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::StartedWithoutUserGesture);
m_autoplaying = false;
updatePlayState();
ImageOverlay::removeOverlaySoonIfNeeded(*this);
}
void HTMLMediaElement::pause()
{
ALWAYS_LOG(LOGIDENTIFIER);
m_temporarilyAllowingInlinePlaybackAfterFullscreen = false;
if (m_waitingToEnterFullscreen)
m_waitingToEnterFullscreen = false;
if (!mediaSession().playbackStateChangePermitted(MediaPlaybackState::Paused))
return;
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::RequireUserGestureToControlControlsManager);
pauseInternal();
// If we have a pending seek, ensure playback doesn't resume.
m_wasPlayingBeforeSeeking = false;
}
void HTMLMediaElement::pauseInternal()
{
ALWAYS_LOG(LOGIDENTIFIER);
if (isSuspended()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because context is suspended");
return;
}
if (!document().hasBrowsingContext()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because there is no browsing context");
return;
}
if (!mediaSession().clientWillPausePlayback()) {
ALWAYS_LOG(LOGIDENTIFIER, "returning because of interruption");
return;
}
// 4.8.10.9. Playing the media resource
if (!m_player || m_networkState == NETWORK_EMPTY) {
// Unless the restriction on media requiring user action has been lifted
// don't trigger loading if a script calls pause().
if (!mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing))
return;
selectMediaResource();
}
m_autoplaying = false;
if (processingUserGestureForMedia())
userDidInterfereWithAutoplay();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
if (!m_paused && !m_pausedInternal) {
setPaused(true);
scheduleTimeupdateEvent(false);
scheduleEvent(eventNames().pauseEvent);
scheduleRejectPendingPlayPromises(DOMException::create(ExceptionCode::AbortError));
if (MemoryPressureHandler::singleton().isUnderMemoryPressure())
purgeBufferedDataIfPossible();
}
updatePlayState();
}
bool HTMLMediaElement::hasMediaSource() const
{
#if ENABLE(MEDIA_SOURCE)
return m_mediaSource;
#else
return false;
#endif
}
bool HTMLMediaElement::hasManagedMediaSource() const
{
#if ENABLE(MEDIA_SOURCE)
return m_mediaSource && m_mediaSource->isManaged();
#else
return false;
#endif
}
#if ENABLE(MEDIA_SOURCE)
void HTMLMediaElement::detachMediaSource()
{
if (RefPtr mediaSource = std::exchange(m_mediaSource, { })) {
mediaSource->detachFromElement();
mediaSource->setAsSrcObject(false);
}
}
bool HTMLMediaElement::deferredMediaSourceOpenCanProgress() const
{
#if !ENABLE(WIRELESS_PLAYBACK_TARGET)
return true;
#else
return !document().settings().managedMediaSourceNeedsAirPlay()
|| isWirelessPlaybackTargetDisabled()
|| hasWirelessPlaybackTargetAlternative();
#endif
}
#endif
bool HTMLMediaElement::loop() const
{
return hasAttributeWithoutSynchronization(loopAttr);
}
void HTMLMediaElement::setLoop(bool loop)
{
ALWAYS_LOG(LOGIDENTIFIER, loop);
setBooleanAttribute(loopAttr, loop);
if (RefPtr player = m_player)
player->isLoopingChanged();
}
bool HTMLMediaElement::controls() const
{
RefPtr frame = document().frame();
// always show controls when scripting is disabled
if (frame && !frame->script().canExecuteScripts(ReasonForCallingCanExecuteScripts::NotAboutToExecuteScript))
return true;
return hasAttributeWithoutSynchronization(controlsAttr);
}
void HTMLMediaElement::setControls(bool controls)
{
ALWAYS_LOG(LOGIDENTIFIER, controls);
setBooleanAttribute(controlsAttr, controls);
}
double HTMLMediaElement::volume() const
{
if (implicitlyMuted())
return 0;
return m_volume;
}
ExceptionOr<void> HTMLMediaElement::setVolume(double volume)
{
ALWAYS_LOG(LOGIDENTIFIER, volume);
if (!(volume >= 0 && volume <= 1))
return Exception { ExceptionCode::IndexSizeError };
auto quirkVolumeZero = !m_volumeLocked && document().quirks().implicitMuteWhenVolumeSetToZero();
auto muteImplicitly = quirkVolumeZero && !volume;
if (m_volume == volume && (!m_implicitlyMuted || *m_implicitlyMuted == muteImplicitly))
return { };
if (quirkVolumeZero) {
if (implicitlyMuted() != muteImplicitly) {
m_implicitlyMuted = muteImplicitly;
setMutedInternal(m_muted, ForceMuteChange::True);
if (volume)
m_implicitlyMuted = std::nullopt;
}
}
if (!m_volumeLocked) {
if (volume && processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
m_volume = volume;
m_volumeInitialized = true;
updateVolume();
scheduleEvent(eventNames().volumechangeEvent);
if (isPlaying() && !mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing)) {
scheduleRejectPendingPlayPromises(DOMException::create(ExceptionCode::NotAllowedError));
pauseInternal();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
}
return { };
}
auto oldVolume = m_volume;
m_volume = volume;
if (m_volumeRevertTaskCancellationGroup.hasPendingTask())
return { };
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_volumeRevertTaskCancellationGroup, [this, oldVolume] {
m_volume = oldVolume;
});
return { };
}
bool HTMLMediaElement::muted() const
{
if (implicitlyMuted())
return true;
if (m_explicitlyMuted)
return m_muted;
return hasAttributeWithoutSynchronization(mutedAttr);
}
void HTMLMediaElement::setMuted(bool muted)
{
auto muteIsImplicit = implicitlyMuted();
m_implicitlyMuted = std::nullopt;
setMutedInternal(muted, muteIsImplicit ? ForceMuteChange::True : ForceMuteChange::False);
}
void HTMLMediaElement::setMutedInternal(bool muted, ForceMuteChange forceChange)
{
ALWAYS_LOG(LOGIDENTIFIER, muted);
bool mutedStateChanged = m_muted != muted || forceChange == ForceMuteChange::True;
if (mutedStateChanged || !m_explicitlyMuted) {
if (processingUserGestureForMedia()) {
removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
if (hasAudio() && muted)
userDidInterfereWithAutoplay();
}
Style::PseudoClassChangeInvalidation styleInvalidation(*this, CSSSelector::PseudoClass::Muted, muted);
m_muted = muted;
if (!m_explicitlyMuted && !implicitlyMuted())
m_explicitlyMuted = !m_explicitlyMuted && !implicitlyMuted();
// Avoid recursion when the player reports volume changes.
if (!processingMediaPlayerCallback()) {
if (RefPtr player = m_player)
player->setMuted(effectiveMuted());
}
if (mutedStateChanged) {
scheduleEvent(eventNames().volumechangeEvent);
scheduleUpdateShouldAutoplay();
}
updateShouldPlay();
protectedDocument()->updateIsPlayingMedia();
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
scheduleUpdateMediaState();
#endif
mediaSession().canProduceAudioChanged();
updateSleepDisabling();
}
schedulePlaybackControlsManagerUpdate();
}
void HTMLMediaElement::setVolumeLocked(bool volumeLocked)
{
if (m_volumeLocked == volumeLocked)
return;
Style::PseudoClassChangeInvalidation styleInvalidation(*this, CSSSelector::PseudoClass::VolumeLocked, volumeLocked);
m_volumeLocked = volumeLocked;
m_player->setVolumeLocked(volumeLocked);
}
void HTMLMediaElement::updateBufferingState()
{
// CSS Selectors Level 4; Editor's Draft, 2 July 2021
// <https://drafts.csswg.org/selectors/>
// 11.2. Media Loading State: the :buffering and :stalled pseudo-classes
//
// The :buffering pseudo-class represents an element that is capable of being “played” or “paused”,
// when that element cannot continue playing because it is actively attempting to obtain media data
// but has not yet obtained enough data to resume playback. (Note that the element is still considered
// to be “playing” when it is “buffering”. Whenever :buffering matches an element, :playing also
// matches the element.)
bool buffering = !paused() && m_networkState == NETWORK_LOADING && m_readyState <= HAVE_CURRENT_DATA;
if (m_buffering == buffering)
return;
Style::PseudoClassChangeInvalidation styleInvalidation(*this, CSSSelector::PseudoClass::Buffering, buffering);
m_buffering = buffering;
if (m_buffering)
startBufferingStopwatch();
else
invalidateBufferingStopwatch();
}
void HTMLMediaElement::updateStalledState()
{
// CSS Selectors Level 4; Editor's Draft, 2 July 2021
// <https://drafts.csswg.org/selectors/>
// 11.2. Media Loading State: the :buffering and :stalled pseudo-classes
//
// The :stalled pseudo-class represents an element when that element cannot continue playing because
// it is actively attempting to obtain media data but it has failed to receive any data for some
// amount of time. For the audio and video elements of HTML, this amount of time is the media element
// stall timeout. [HTML] (Note that, like with the :buffering pseudo-class, the element is still
// considered to be “playing” when it is “stalled”. Whenever :stalled matches an element, :playing
// also matches the element.)
bool stalled = !paused() && m_networkState == NETWORK_LOADING && m_readyState <= HAVE_CURRENT_DATA && m_sentStalledEvent;
if (m_stalled != stalled) {
Style::PseudoClassChangeInvalidation styleInvalidation(*this, CSSSelector::PseudoClass::Stalled, stalled);
m_stalled = stalled;
}
}
#if USE(AUDIO_SESSION) && PLATFORM(MAC)
void HTMLMediaElement::hardwareMutedStateDidChange(const AudioSession& session)
{
if (!session.isMuted())
return;
if (!hasAudio())
return;
if (effectiveMuted() || !volume())
return;
ALWAYS_LOG(LOGIDENTIFIER);
userDidInterfereWithAutoplay();
}
#endif
void HTMLMediaElement::togglePlayState()
{
INFO_LOG(LOGIDENTIFIER, "canPlay() is ", canPlay());
// We can safely call the internal play/pause methods, which don't check restrictions, because
// this method is only called from the built-in media controller
if (canPlay()) {
updatePlaybackRate();
playInternal();
} else
pauseInternal();
}
void HTMLMediaElement::beginScrubbing()
{
INFO_LOG(LOGIDENTIFIER, "paused() is ", paused());
if (!paused()) {
if (ended()) {
// Because a media element stays in non-paused state when it reaches end, playback resumes
// when the slider is dragged from the end to another position unless we pause first. Do
// a "hard pause" so an event is generated, since we want to stay paused after scrubbing finishes.
pause();
} else {
// Not at the end but we still want to pause playback so the media engine doesn't try to
// continue playing during scrubbing. Pause without generating an event as we will
// unpause after scrubbing finishes.
setPausedInternal(true);
}
}
mediaSession().removeBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
}
void HTMLMediaElement::endScrubbing()
{
INFO_LOG(LOGIDENTIFIER, "m_pausedInternal is", m_pausedInternal);
if (m_pausedInternal)
setPausedInternal(false);
}
void HTMLMediaElement::beginScanning(ScanDirection direction)
{
m_scanType = supportsScanning() ? Scan : Seek;
m_scanDirection = direction;
if (m_scanType == Seek) {
// Scanning by seeking requires the video to be paused during scanning.
m_actionAfterScan = paused() ? Nothing : Play;
pause();
} else {
// Scanning by scanning requires the video to be playing during scanninging.
m_actionAfterScan = paused() ? Pause : Nothing;
play();
setPlaybackRate(nextScanRate());
}
m_scanTimer.start(0_s, m_scanType == Seek ? SeekRepeatDelay : ScanRepeatDelay);
}
void HTMLMediaElement::endScanning()
{
if (m_scanType == Scan)
setPlaybackRate(defaultPlaybackRate());
if (m_actionAfterScan == Play)
play();
else if (m_actionAfterScan == Pause)
pause();
if (m_scanTimer.isActive())
m_scanTimer.stop();
}
double HTMLMediaElement::nextScanRate()
{
double rate = std::min(ScanMaximumRate, std::abs(playbackRate() * 2));
if (m_scanDirection == Backward)
rate *= -1;
#if PLATFORM(IOS_FAMILY)
rate = std::min(std::max(rate, minFastReverseRate()), maxFastForwardRate());
#endif
return rate;
}
void HTMLMediaElement::scanTimerFired()
{
if (m_scanType == Seek) {
double seekTime = m_scanDirection == Forward ? SeekTime : -SeekTime;
setCurrentTime(currentTime() + seekTime);
} else
setPlaybackRate(nextScanRate());
}
// The spec says to fire periodic timeupdate events (those sent while playing) every
// "15 to 250ms", we choose the slowest frequency
static const Seconds maxTimeupdateEventFrequency { 250_ms };
void HTMLMediaElement::startPlaybackProgressTimer()
{
if (m_playbackProgressTimer.isActive())
return;
m_previousProgressTime = MonotonicTime::now();
m_playbackProgressTimer.startRepeating(maxTimeupdateEventFrequency);
}
void HTMLMediaElement::playbackProgressTimerFired()
{
ASSERT(m_player);
if (m_fragmentEndTime.isValid() && currentMediaTime() >= m_fragmentEndTime && requestedPlaybackRate() > 0) {
m_fragmentEndTime = MediaTime::invalidTime();
if (!m_mediaController && !m_paused) {
// changes paused to true and fires a simple event named pause at the media element.
pauseInternal();
}
}
scheduleTimeupdateEvent(true);
if (!requestedPlaybackRate())
return;
updateActiveTextTrackCues(currentMediaTime());
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = m_mediaSource)
mediaSource->monitorSourceBuffers();
#endif
bool playbackStarted = m_autoplayEventPlaybackState == AutoplayEventPlaybackState::StartedWithUserGesture || m_autoplayEventPlaybackState == AutoplayEventPlaybackState::StartedWithoutUserGesture;
if (!seeking() && playbackStarted && currentTime() - playbackStartedTime() > AutoplayInterferenceTimeThreshold) {
handleAutoplayEvent(m_autoplayEventPlaybackState == AutoplayEventPlaybackState::StartedWithoutUserGesture ? AutoplayEvent::DidAutoplayMediaPastThresholdWithoutUserInterference : AutoplayEvent::DidPlayMediaWithUserGesture);
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
}
}
void HTMLMediaElement::scheduleTimeupdateEvent(bool periodicEvent)
{
MonotonicTime now = MonotonicTime::now();
Seconds timedelta = now - m_clockTimeAtLastUpdateEvent;
// throttle the periodic events
if (periodicEvent && timedelta < maxTimeupdateEventFrequency) {
// Reschedule the timer to fire at the correct time, ensuring that no full cycles are skipped
m_playbackProgressTimer.start(maxTimeupdateEventFrequency - timedelta, maxTimeupdateEventFrequency);
return;
}
// Some media engines make multiple "time changed" callbacks at the same time, but we only want one
// event at a given time so filter here
MediaTime movieTime = currentMediaTime();
if (movieTime != m_lastTimeUpdateEventMovieTime) {
scheduleEvent(eventNames().timeupdateEvent);
m_clockTimeAtLastUpdateEvent = now;
m_lastTimeUpdateEventMovieTime = movieTime;
}
}
bool HTMLMediaElement::canPlay() const
{
return paused() || ended() || m_readyState < HAVE_METADATA;
}
void HTMLMediaElement::mediaPlayerDidAddAudioTrack(AudioTrackPrivate& track)
{
if (isPlaying() && !mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing)) {
scheduleRejectPendingPlayPromises(DOMException::create(ExceptionCode::NotAllowedError));
pauseInternal();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
}
addAudioTrack(AudioTrack::create(protectedScriptExecutionContext().get(), track));
}
void HTMLMediaElement::mediaPlayerDidAddTextTrack(InbandTextTrackPrivate& track)
{
// 4.8.10.12.2 Sourcing in-band text tracks
// 1. Associate the relevant data with a new text track and its corresponding new TextTrack object.
Ref textTrack = InbandTextTrack::create(protectedDocument(), track);
// 2. Set the new text track's kind, label, and language based on the semantics of the relevant data,
// as defined by the relevant specification. If there is no label in that data, then the label must
// be set to the empty string.
// 3. Associate the text track list of cues with the rules for updating the text track rendering appropriate
// for the format in question.
// 4. If the new text track's kind is metadata, then set the text track in-band metadata track dispatch type
// as follows, based on the type of the media resource:
// 5. Populate the new text track's list of cues with the cues parsed so far, folllowing the guidelines for exposing
// cues, and begin updating it dynamically as necessary.
// - Thess are all done by the media engine.
// 6. Set the new text track's readiness state to loaded.
textTrack->setReadinessState(TextTrack::Loaded);
// 7. Set the new text track's mode to the mode consistent with the user's preferences and the requirements of
// the relevant specification for the data.
// - This will happen in configureTextTracks()
scheduleConfigureTextTracks();
// 8. Add the new text track to the media element's list of text tracks.
// 9. Fire an event with the name addtrack, that does not bubble and is not cancelable, and that uses the TrackEvent
// interface, with the track attribute initialized to the text track's TextTrack object, at the media element's
// textTracks attribute's TextTrackList object.
addTextTrack(WTFMove(textTrack));
}
void HTMLMediaElement::mediaPlayerDidAddVideoTrack(VideoTrackPrivate& track)
{
addVideoTrack(VideoTrack::create(protectedScriptExecutionContext().get(), track));
}
void HTMLMediaElement::mediaPlayerDidRemoveAudioTrack(AudioTrackPrivate& track)
{
track.willBeRemoved();
}
void HTMLMediaElement::mediaPlayerDidRemoveTextTrack(InbandTextTrackPrivate& track)
{
track.willBeRemoved();
}
void HTMLMediaElement::mediaPlayerDidRemoveVideoTrack(VideoTrackPrivate& track)
{
track.willBeRemoved();
}
void HTMLMediaElement::addAudioTrack(Ref<AudioTrack>&& track)
{
#if !RELEASE_LOG_DISABLED
track->setLogger(protectedLogger(), logIdentifier());
#endif
track->addClient(*this);
ensureAudioTracks().append(WTFMove(track));
}
void HTMLMediaElement::addTextTrack(Ref<TextTrack>&& track)
{
#if !RELEASE_LOG_DISABLED
track->setLogger(protectedLogger(), logIdentifier());
#endif
if (!m_requireCaptionPreferencesChangedCallbacks) {
m_requireCaptionPreferencesChangedCallbacks = true;
Ref document = this->document();
document->registerForCaptionPreferencesChangedCallbacks(*this);
if (RefPtr page = document->page()) {
auto& captionPreferences = page->group().ensureCaptionPreferences();
m_captionDisplayMode = captionPreferences.captionDisplayMode();
m_userPrefersTextDescriptions = captionPreferences.userPrefersTextDescriptions();
m_userPrefersExtendedDescriptions = m_userPrefersTextDescriptions && document->settings().extendedAudioDescriptionsEnabled();
}
}
track->addClient(*this);
ensureTextTracks().append(WTFMove(track));
}
void HTMLMediaElement::addVideoTrack(Ref<VideoTrack>&& track)
{
#if !RELEASE_LOG_DISABLED
track->setLogger(protectedLogger(), logIdentifier());
#endif
track->addClient(*this);
ensureVideoTracks().append(WTFMove(track));
}
void HTMLMediaElement::removeAudioTrack(Ref<AudioTrack>&& track)
{
if (!m_audioTracks || !m_audioTracks->contains(track))
return;
track->clearClient(*this);
m_audioTracks->remove(track.get());
}
void HTMLMediaElement::removeAudioTrack(TrackID trackID)
{
if (!m_audioTracks)
return;
if (RefPtr track = m_audioTracks->find(trackID))
removeAudioTrack(downcast<AudioTrack>(*track));
}
void HTMLMediaElement::removeTextTrack(TextTrack& track, bool scheduleEvent)
{
if (!m_textTracks || !m_textTracks->contains(track))
return;
TrackDisplayUpdateScope scope { *this };
if (RefPtr cues = track.cues())
textTrackRemoveCues(track, *cues);
track.clearClient(*this);
if (RefPtr textTracks = m_textTracks)
textTracks->remove(track, scheduleEvent);
}
void HTMLMediaElement::removeTextTrack(TrackID trackID, bool scheduleEvent)
{
if (!m_textTracks)
return;
if (RefPtr track = m_textTracks->find(trackID))
removeTextTrack(downcast<TextTrack>(*track), scheduleEvent);
}
void HTMLMediaElement::removeVideoTrack(Ref<VideoTrack>&& track)
{
if (!m_videoTracks || !m_videoTracks->contains(track))
return;
track->clearClient(*this);
RefPtr { m_videoTracks }->remove(track);
}
void HTMLMediaElement::removeVideoTrack(TrackID trackID)
{
if (!m_videoTracks)
return;
if (RefPtr track = m_videoTracks->find(trackID))
removeVideoTrack(downcast<VideoTrack>(*track));
}
void HTMLMediaElement::forgetResourceSpecificTracks()
{
while (m_audioTracks && m_audioTracks->length())
removeAudioTrack(*m_audioTracks->lastItem());
if (m_textTracks) {
TrackDisplayUpdateScope scope { *this };
for (int i = m_textTracks->length() - 1; i >= 0; --i) {
Ref track = *m_textTracks->item(i);
if (track->trackType() == TextTrack::InBand)
removeTextTrack(track, false);
}
}
while (m_videoTracks && m_videoTracks->length())
removeVideoTrack(*m_videoTracks->lastItem());
}
#if !RELEASE_LOG_DISABLED
Ref<Logger> HTMLMediaElement::protectedLogger() const
{
return *m_logger;
}
#endif
#if ENABLE(WEB_AUDIO)
MediaElementAudioSourceNode* HTMLMediaElement::audioSourceNode()
{
return m_audioSourceNode.get();
}
#endif
ExceptionOr<Ref<TextTrack>> HTMLMediaElement::addTextTrack(const AtomString& kind, const AtomString& label, const AtomString& language)
{
// 4.8.10.12.4 Text track API
// The addTextTrack(kind, label, language) method of media elements, when invoked, must run the following steps:
// 1. If kind is not one of the following strings, then throw a SyntaxError exception and abort these steps
if (!TextTrack::isValidKindKeyword(kind))
return Exception { ExceptionCode::TypeError };
// 2. If the label argument was omitted, let label be the empty string.
// 3. If the language argument was omitted, let language be the empty string.
// 4. Create a new TextTrack object.
// 5. Create a new text track corresponding to the new object, and set its text track kind to kind, its text
// track label to label, its text track language to language...
Ref track = TextTrack::create(protectedDocument().ptr(), kind, emptyAtom(), label, language);
#if !RELEASE_LOG_DISABLED
track->setLogger(protectedLogger(), logIdentifier());
#endif
// Note, due to side effects when changing track parameters, we have to
// first append the track to the text track list.
// 6. Add the new text track to the media element's list of text tracks.
addTextTrack(track.copyRef());
// ... its text track readiness state to the text track loaded state ...
track->setReadinessState(TextTrack::Loaded);
// ... its text track mode to the text track hidden mode, and its text track list of cues to an empty list ...
track->setMode(TextTrack::Mode::Hidden);
return track;
}
AudioTrackList& HTMLMediaElement::ensureAudioTracks()
{
if (!m_audioTracks) {
m_audioTracks = AudioTrackList::create(ActiveDOMObject::protectedScriptExecutionContext().get());
RefPtr { m_audioTracks }->setOpaqueRootObserver(m_opaqueRootProvider);
}
return *m_audioTracks;
}
TextTrackList& HTMLMediaElement::ensureTextTracks()
{
if (!m_textTracks) {
Ref textTracks = TextTrackList::create(ActiveDOMObject::protectedScriptExecutionContext().get());
m_textTracks = textTracks.copyRef();
textTracks->setOpaqueRootObserver(m_opaqueRootProvider);
textTracks->setDuration(durationMediaTime());
}
return *m_textTracks;
}
VideoTrackList& HTMLMediaElement::ensureVideoTracks()
{
if (!m_videoTracks) {
m_videoTracks = VideoTrackList::create(ActiveDOMObject::protectedScriptExecutionContext().get());
RefPtr { m_videoTracks }->setOpaqueRootObserver(m_opaqueRootProvider);
}
return *m_videoTracks;
}
void HTMLMediaElement::didAddTextTrack(HTMLTrackElement& trackElement)
{
ASSERT(trackElement.hasTagName(trackTag));
// 4.8.10.12.3 Sourcing out-of-band text tracks
// When a track element's parent element changes and the new parent is a media element,
// then the user agent must add the track element's corresponding text track to the
// media element's list of text tracks ... [continues in TextTrackList::append]
addTextTrack(trackElement.track());
// Do not schedule the track loading until parsing finishes so we don't start before all tracks
// in the markup have been added.
if (!m_parsingInProgress)
scheduleConfigureTextTracks();
}
void HTMLMediaElement::didRemoveTextTrack(HTMLTrackElement& trackElement)
{
ASSERT(trackElement.hasTagName(trackTag));
Ref textTrack = trackElement.track();
textTrack->setHasBeenConfigured(false);
if (!m_textTracks)
return;
// 4.8.10.12.3 Sourcing out-of-band text tracks
// When a track element's parent element changes and the old parent was a media element,
// then the user agent must remove the track element's corresponding text track from the
// media element's list of text tracks.
removeTextTrack(textTrack);
m_textTracksWhenResourceSelectionBegan.removeFirst(textTrack.ptr());
}
void HTMLMediaElement::configureMetadataTextTrackGroup(const TrackGroup& group)
{
ASSERT(group.tracks.size());
// https://html.spec.whatwg.org/multipage/embedded-content.html#honor-user-preferences-for-automatic-text-track-selection
// 3. If there are any text tracks in the media element's list of text tracks whose text track kind is
// chapters or metadata that correspond to track elements with a default attribute set whose text track mode
// is set to disabled, then set the text track mode of all such tracks to hidden.
for (auto& textTrack : group.tracks) {
if (textTrack->mode() != TextTrack::Mode::Disabled)
continue;
if (!textTrack->isDefault())
continue;
textTrack->setMode(TextTrack::Mode::Hidden);
}
}
void HTMLMediaElement::configureTextTrackGroup(const TrackGroup& group)
{
ASSERT(group.tracks.size());
RefPtr page = document().page();
CaptionUserPreferences* captionPreferences = page ? &page->group().ensureCaptionPreferences() : nullptr;
CaptionUserPreferences::CaptionDisplayMode displayMode = captionPreferences ? captionPreferences->captionDisplayMode() : CaptionUserPreferences::CaptionDisplayMode::Automatic;
// First, find the track in the group that should be enabled (if any).
Vector<RefPtr<TextTrack>> currentlyEnabledTracks;
RefPtr<TextTrack> trackToEnable;
RefPtr<TextTrack> defaultTrack;
RefPtr<TextTrack> fallbackTrack;
RefPtr<TextTrack> forcedSubitleTrack;
int highestTrackScore = 0;
int highestForcedScore = 0;
// If there is a visible track, it has already been configured so it won't be considered in the loop below. We don't want to choose another
// track if it is less suitable, and we do want to disable it if another track is more suitable.
int alreadyVisibleTrackScore = 0;
if (group.visibleTrack && captionPreferences) {
alreadyVisibleTrackScore = captionPreferences->textTrackSelectionScore(group.visibleTrack.get(), this);
currentlyEnabledTracks.append(group.visibleTrack);
}
for (size_t i = 0; i < group.tracks.size(); ++i) {
RefPtr textTrack = group.tracks[i];
if (m_processingPreferenceChange && textTrack->mode() == TextTrack::Mode::Showing)
currentlyEnabledTracks.append(textTrack);
int trackScore = captionPreferences ? captionPreferences->textTrackSelectionScore(textTrack.get(), this) : 0;
ALWAYS_LOG(LOGIDENTIFIER, "'", textTrack->kindKeyword(), "' track with language '", textTrack->language(), "' and BCP 47 language '", textTrack->validBCP47Language(), "' has score ", trackScore);
if (trackScore) {
// * If the text track kind is { [subtitles or captions] [descriptions] } and the user has indicated an interest in having a
// track with this text track kind, text track language, and text track label enabled, and there is no
// other text track in the media element's list of text tracks with a text track kind of either subtitles
// or captions whose text track mode is showing
// ...
// * If the text track kind is chapters and the text track language is one that the user agent has reason
// to believe is appropriate for the user, and there is no other text track in the media element's list of
// text tracks with a text track kind of chapters whose text track mode is showing
// Let the text track mode be showing.
if (trackScore > highestTrackScore && trackScore > alreadyVisibleTrackScore) {
highestTrackScore = trackScore;
trackToEnable = textTrack;
}
if (!defaultTrack && textTrack->isDefault())
defaultTrack = textTrack;
if (!defaultTrack && !fallbackTrack)
fallbackTrack = textTrack;
if (textTrack->containsOnlyForcedSubtitles() && trackScore > highestForcedScore) {
forcedSubitleTrack = textTrack;
highestForcedScore = trackScore;
}
} else if (!group.visibleTrack && !defaultTrack && textTrack->isDefault()) {
// * If the track element has a default attribute specified, and there is no other text track in the media
// element's list of text tracks whose text track mode is showing or showing by default
// Let the text track mode be showing by default.
if (group.kind != TrackGroup::CaptionsAndSubtitles || displayMode != CaptionUserPreferences::CaptionDisplayMode::ForcedOnly)
defaultTrack = textTrack;
} else if (group.kind == TrackGroup::Description) {
if (!defaultTrack && !fallbackTrack && m_userPrefersTextDescriptions)
fallbackTrack = textTrack;
}
}
if (displayMode != CaptionUserPreferences::CaptionDisplayMode::Manual) {
if (!trackToEnable && defaultTrack)
trackToEnable = defaultTrack;
// If no track matches the user's preferred language, none was marked as 'default', and there is a forced subtitle track
// in the same language as the language of the primary audio track, enable it.
if (!trackToEnable && forcedSubitleTrack)
trackToEnable = forcedSubitleTrack;
// If no track matches, don't disable an already visible track unless preferences say they all should be off.
if (group.kind != TrackGroup::CaptionsAndSubtitles || displayMode != CaptionUserPreferences::CaptionDisplayMode::ForcedOnly) {
if (!trackToEnable && !defaultTrack && group.visibleTrack)
trackToEnable = group.visibleTrack;
}
// If no track matches the user's preferred language and non was marked 'default', enable the first track
// because the user has explicitly stated a preference for this kind of track.
if (!trackToEnable && fallbackTrack)
trackToEnable = fallbackTrack;
if (trackToEnable)
m_subtitleTrackLanguage = trackToEnable->language();
else
m_subtitleTrackLanguage = emptyString();
}
if (currentlyEnabledTracks.size()) {
for (size_t i = 0; i < currentlyEnabledTracks.size(); ++i) {
RefPtr<TextTrack> textTrack = currentlyEnabledTracks[i];
if (textTrack != trackToEnable)
textTrack->setMode(TextTrack::Mode::Disabled);
}
}
if (trackToEnable) {
trackToEnable->setMode(TextTrack::Mode::Showing);
}
}
static JSC::JSValue controllerJSValue(JSC::JSGlobalObject& lexicalGlobalObject, JSDOMGlobalObject& globalObject, HTMLMediaElement& media)
{
JSC::VM& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto mediaJSWrapper = toJS(&lexicalGlobalObject, &globalObject, media);
// Retrieve the controller through the JS object graph
JSC::JSObject* mediaJSWrapperObject = JSC::jsDynamicCast<JSC::JSObject*>(mediaJSWrapper);
if (!mediaJSWrapperObject)
return JSC::jsNull();
JSC::Identifier controlsHost = JSC::Identifier::fromString(vm, "controlsHost"_s);
JSC::JSValue controlsHostJSWrapper = mediaJSWrapperObject->get(&lexicalGlobalObject, controlsHost);
RETURN_IF_EXCEPTION(scope, JSC::jsNull());
JSC::JSObject* controlsHostJSWrapperObject = JSC::jsDynamicCast<JSC::JSObject*>(controlsHostJSWrapper);
if (!controlsHostJSWrapperObject)
return JSC::jsNull();
JSC::Identifier controllerID = builtinNames(vm).controllerPublicName();
JSC::JSValue controllerJSWrapper = controlsHostJSWrapperObject->get(&lexicalGlobalObject, controllerID);
RETURN_IF_EXCEPTION(scope, JSC::jsNull());
return controllerJSWrapper;
}
bool HTMLMediaElement::setupAndCallJS(const JSSetupFunction& task)
{
RefPtr page = document().page();
if (!page)
return false;
auto pendingActivity = makePendingActivity(*this);
auto& world = ensureIsolatedWorld();
Ref protectedFrame = *document().frame();
auto& scriptController = protectedFrame->script();
auto* globalObject = JSC::jsCast<JSDOMGlobalObject*>(scriptController.globalObject(world));
auto& vm = globalObject->vm();
JSC::JSLockHolder lock(vm);
auto scope = DECLARE_CATCH_SCOPE(vm);
auto* lexicalGlobalObject = globalObject;
auto reportExceptionAndReturnFalse = [&] () -> bool {
auto* exception = scope.exception();
scope.clearException();
reportException(globalObject, exception);
return false;
};
auto result = task(*globalObject, *lexicalGlobalObject, scriptController, world);
RETURN_IF_EXCEPTION(scope, reportExceptionAndReturnFalse());
return result;
}
void HTMLMediaElement::updateCaptionContainer()
{
if (m_haveSetUpCaptionContainer)
return;
if (!ensureMediaControls())
return;
setupAndCallJS([this](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = JSC::jsDynamicCast<JSC::JSObject*>(controllerValue);
if (!controllerObject)
return false;
// The media controls script must provide a method on the Controller object with the following details.
// Name: updateCaptionContainer
// Parameters:
// None
// Return value:
// None
auto methodValue = controllerObject->get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "updateCaptionContainer"_s));
RETURN_IF_EXCEPTION(scope, false);
auto* methodObject = JSC::jsDynamicCast<JSC::JSObject*>(methodValue);
if (!methodObject)
return false;
auto callData = JSC::getCallData(methodObject);
if (callData.type == JSC::CallData::Type::None)
return false;
JSC::MarkedArgumentBuffer noArguments;
ASSERT(!noArguments.hasOverflowed());
JSC::call(&lexicalGlobalObject, methodObject, callData, controllerObject, noArguments);
RETURN_IF_EXCEPTION(scope, false);
m_haveSetUpCaptionContainer = true;
return true;
});
}
void HTMLMediaElement::layoutSizeChanged()
{
auto task = [this] {
if (isContextStopped())
return;
if (RefPtr root = userAgentShadowRoot())
root->dispatchEvent(Event::create(eventNames().resizeEvent, Event::CanBubble::No, Event::IsCancelable::No));
if (RefPtr mediaControlsHost = m_mediaControlsHost)
mediaControlsHost->updateCaptionDisplaySizes();
};
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, WTFMove(task));
if (!m_receivedLayoutSizeChanged) {
m_receivedLayoutSizeChanged = true;
schedulePlaybackControlsManagerUpdate();
}
// If the video is a candidate for main content, we should register it for viewport visibility callbacks
// if it hasn't already been registered.
if (renderer() && m_mediaSession && !m_mediaSession->wantsToObserveViewportVisibilityForAutoplay() && m_mediaSession->wantsToObserveViewportVisibilityForMediaControls())
checkedRenderer()->registerForVisibleInViewportCallback();
}
void HTMLMediaElement::visibilityDidChange()
{
scheduleUpdateShouldAutoplay();
}
void HTMLMediaElement::setSelectedTextTrack(TextTrack* trackToSelect)
{
RefPtr trackList = textTracks();
if (!trackList || !trackList->length())
return;
if (trackToSelect == &TextTrack::captionMenuAutomaticItem()) {
if (captionDisplayMode() != CaptionUserPreferences::CaptionDisplayMode::Automatic)
RefPtr { m_textTracks }->scheduleChangeEvent();
} else if (trackToSelect == &TextTrack::captionMenuOffItem()) {
for (int i = 0, length = trackList->length(); i < length; ++i)
RefPtr { trackList->item(i) }->setMode(TextTrack::Mode::Disabled);
if (captionDisplayMode() != CaptionUserPreferences::CaptionDisplayMode::ForcedOnly && !trackList->isChangeEventScheduled())
RefPtr { m_textTracks }->scheduleChangeEvent();
} else {
if (!trackToSelect || !trackList->contains(*trackToSelect))
return;
for (int i = 0, length = trackList->length(); i < length; ++i) {
Ref track = *trackList->item(i);
if (track.ptr() != trackToSelect)
track->setMode(TextTrack::Mode::Disabled);
else
track->setMode(TextTrack::Mode::Showing);
}
}
if (!document().page())
return;
auto& captionPreferences = document().page()->group().ensureCaptionPreferences();
CaptionUserPreferences::CaptionDisplayMode displayMode;
if (trackToSelect == &TextTrack::captionMenuOffItem())
displayMode = CaptionUserPreferences::CaptionDisplayMode::ForcedOnly;
else if (trackToSelect == &TextTrack::captionMenuAutomaticItem())
displayMode = CaptionUserPreferences::CaptionDisplayMode::Automatic;
else {
displayMode = CaptionUserPreferences::CaptionDisplayMode::AlwaysOn;
if (trackToSelect->validBCP47Language().length())
captionPreferences.setPreferredLanguage(trackToSelect->validBCP47Language());
}
captionPreferences.setCaptionDisplayMode(displayMode);
}
void HTMLMediaElement::scheduleConfigureTextTracks()
{
if (m_configureTextTracksTaskCancellationGroup.hasPendingTask())
return;
auto logSiteIdentifier = LOGIDENTIFIER;
ALWAYS_LOG(logSiteIdentifier, "task scheduled");
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_configureTextTracksTaskCancellationGroup, [this, logSiteIdentifier] {
UNUSED_PARAM(logSiteIdentifier);
ALWAYS_LOG(logSiteIdentifier, "lambda(), task fired");
Ref protectedThis { *this }; // configureTextTracks calls methods that can trigger arbitrary DOM mutations.
configureTextTracks();
});
}
void HTMLMediaElement::configureTextTracks()
{
TrackGroup captionAndSubtitleTracks(TrackGroup::CaptionsAndSubtitles);
TrackGroup descriptionTracks(TrackGroup::Description);
TrackGroup chapterTracks(TrackGroup::Chapter);
TrackGroup metadataTracks(TrackGroup::Metadata);
TrackGroup otherTracks(TrackGroup::Other);
if (!m_textTracks)
return;
for (size_t i = 0; i < m_textTracks->length(); ++i) {
RefPtr textTrack = m_textTracks->item(i);
if (!textTrack)
continue;
auto kind = textTrack->kind();
TrackGroup* currentGroup;
if (kind == TextTrack::Kind::Subtitles || kind == TextTrack::Kind::Captions || kind == TextTrack::Kind::Forced)
currentGroup = &captionAndSubtitleTracks;
else if (kind == TextTrack::Kind::Descriptions)
currentGroup = &descriptionTracks;
else if (kind == TextTrack::Kind::Chapters)
currentGroup = &chapterTracks;
else if (kind == TextTrack::Kind::Metadata)
currentGroup = &metadataTracks;
else
currentGroup = &otherTracks;
if (!currentGroup->visibleTrack && textTrack->mode() == TextTrack::Mode::Showing)
currentGroup->visibleTrack = textTrack;
if (!currentGroup->defaultTrack && textTrack->isDefault())
currentGroup->defaultTrack = textTrack;
// Do not add this track to the group if it has already been automatically configured
// as we only want to call configureTextTrack once per track so that adding another
// track after the initial configuration doesn't reconfigure every track - only those
// that should be changed by the new addition. For example all metadata tracks are
// disabled by default, and we don't want a track that has been enabled by script
// to be disabled automatically when a new metadata track is added later.
if (textTrack->hasBeenConfigured())
continue;
if (textTrack->language().length())
currentGroup->hasSrcLang = true;
currentGroup->tracks.append(textTrack);
}
if (captionAndSubtitleTracks.tracks.size())
configureTextTrackGroup(captionAndSubtitleTracks);
if (descriptionTracks.tracks.size())
configureTextTrackGroup(descriptionTracks);
if (chapterTracks.tracks.size())
configureTextTrackGroup(chapterTracks);
if (metadataTracks.tracks.size())
configureMetadataTextTrackGroup(metadataTracks);
if (otherTracks.tracks.size())
configureTextTrackGroup(otherTracks);
m_processingPreferenceChange = false;
updateCaptionContainer();
configureTextTrackDisplay();
}
bool HTMLMediaElement::havePotentialSourceChild()
{
// Stash the current <source> node and next nodes so we can restore them after checking
// to see there is another potential.
RefPtr currentSourceNode = m_currentSourceNode;
RefPtr nextNode = m_nextChildNodeToConsider;
auto nextURL = selectNextSourceChild(nullptr, InvalidURLAction::DoNothing);
m_currentSourceNode = currentSourceNode;
m_nextChildNodeToConsider = nextNode;
return nextURL.isValid();
}
URL HTMLMediaElement::selectNextSourceChild(ContentType* contentType, InvalidURLAction actionIfInvalid)
{
// Don't log if this was just called to find out if there are any valid <source> elements.
bool shouldLog = willLog(WTFLogLevel::Always) && actionIfInvalid != InvalidURLAction::DoNothing;
if (shouldLog)
INFO_LOG(LOGIDENTIFIER);
if (!m_nextChildNodeToConsider) {
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, "end of list, stopping");
return URL();
}
// Because the DOM may be mutated in the course of the following algorithm,
// keep strong references to each of the child source nodes, and verify that
// each still is a child of this media element before using.
Vector<Ref<HTMLSourceElement>> potentialSourceNodes;
auto sources = childrenOfType<HTMLSourceElement>(*this);
for (auto next = m_nextChildNodeToConsider ? sources.beginAt(*m_nextChildNodeToConsider.copyRef()) : sources.begin(); next; ++next)
potentialSourceNodes.append(*next);
for (auto& source : potentialSourceNodes) {
if (source->parentNode() != this)
continue;
// 2. If candidate does not have a src attribute, or if its src
// attribute's value is the empty string ... jump down to the failed
// step below
auto& srcValue = source->attributeWithoutSynchronization(srcAttr);
URL mediaURL;
String type;
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, "'src' is ", srcValue);
if (srcValue.isEmpty())
goto CheckAgain;
// 3. Let urlString be the resulting URL string that would have resulted
// from parsing the URL specified by candidate's src attribute's value
// relative to the candidate's node document when the src attribute was
// last changed.
mediaURL = source->document().completeURL(srcValue);
if (auto mediaQueryList = source->parsedMediaAttribute(protectedDocument()); !mediaQueryList.isEmpty()) {
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, "'media' is ", source->attributeWithoutSynchronization(mediaAttr));
auto* renderer = this->renderer();
LOG(MediaQueries, "HTMLMediaElement %p selectNextSourceChild evaluating media queries", this);
if (!MQ::MediaQueryEvaluator { screenAtom(), protectedDocument(), renderer ? &renderer->style() : nullptr }.evaluate(mediaQueryList))
goto CheckAgain;
}
// 4. If urlString was not obtained successfully, then end the synchronous section,
// and jump down to the failed with elements step below.
if (!isSafeToLoadURL(mediaURL, actionIfInvalid))
goto CheckAgain;
// 5. If candidate has a type attribute whose value, when parsed as a
// MIME type ...
type = source->attributeWithoutSynchronization(typeAttr);
if (type.isEmpty() && mediaURL.protocolIsData())
type = mimeTypeFromDataURL(mediaURL.string());
if (!type.isEmpty()) {
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, "'type' is ", type);
MediaEngineSupportParameters parameters;
parameters.type = ContentType(type);
parameters.url = mediaURL;
#if ENABLE(MEDIA_SOURCE)
parameters.isMediaSource = mediaURL.protocolIs(mediaSourceBlobProtocol) && MediaSource::lookup(mediaURL.string());
#endif
parameters.requiresRemotePlayback = !!m_remotePlaybackConfiguration;
if (!document().settings().allowMediaContentTypesRequiringHardwareSupportAsFallback() || Traversal<HTMLSourceElement>::nextSkippingChildren(source))
parameters.contentTypesRequiringHardwareSupport = mediaContentTypesRequiringHardwareSupport();
parameters.supportsLimitedMatroska = limitedMatroskaSupportEnabled();
if (MediaPlayer::supportsType(parameters) == MediaPlayer::SupportsType::IsNotSupported)
goto CheckAgain;
}
// A 'beforeload' event handler can mutate the DOM, so check to see if the source element is still a child node.
if (source->parentNode() != this) {
INFO_LOG(LOGIDENTIFIER, "'beforeload' removed current element");
continue;
}
// Making it this far means the <source> looks reasonable.
if (contentType)
*contentType = ContentType(type);
m_nextChildNodeToConsider = Traversal<HTMLSourceElement>::nextSkippingChildren(source);
m_currentSourceNode = WTFMove(source);
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, " = ", mediaURL);
return mediaURL;
CheckAgain:
if (actionIfInvalid == InvalidURLAction::Complain)
source->scheduleErrorEvent();
}
m_currentSourceNode = nullptr;
m_nextChildNodeToConsider = nullptr;
#if !LOG_DISABLED
if (shouldLog)
INFO_LOG(LOGIDENTIFIER, "failed");
#endif
return URL();
}
void HTMLMediaElement::sourceWasAdded(HTMLSourceElement& source)
{
if (willLog(WTFLogLevel::Info) && source.hasTagName(sourceTag)) {
URL url = source.getNonEmptyURLAttribute(srcAttr);
INFO_LOG(LOGIDENTIFIER, "'src' is ", url);
}
if (!document().hasBrowsingContext()) {
INFO_LOG(LOGIDENTIFIER, "<source> inserted inside a document without a browsing context is not loaded");
return;
}
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = m_mediaSource)
mediaSource->openIfDeferredOpen();
#endif
// We should only consider a <source> element when there is not src attribute at all.
if (hasAttributeWithoutSynchronization(srcAttr))
return;
// 4.8.8 - If a source element is inserted as a child of a media element that has no src
// attribute and whose networkState has the value NETWORK_EMPTY, the user agent must invoke
// the media element's resource selection algorithm.
if (m_networkState == NETWORK_EMPTY) {
m_nextChildNodeToConsider = &source;
#if PLATFORM(IOS_FAMILY)
if (mediaSession().dataLoadingPermitted())
#endif
selectMediaResource();
return;
}
if (m_currentSourceNode && &source == Traversal<HTMLSourceElement>::nextSibling(*m_currentSourceNode.copyRef())) {
INFO_LOG(LOGIDENTIFIER, "<source> inserted immediately after current source");
m_nextChildNodeToConsider = &source;
return;
}
if (m_nextChildNodeToConsider)
return;
// 4.8.9.5, resource selection algorithm, source elements section:
// 21. Wait until the node after pointer is a node other than the end of the list. (This step might wait forever.)
// 22. Asynchronously await a stable state...
// 23. Set the element's delaying-the-load-event flag back to true (this delays the load event again, in case
// it hasn't been fired yet).
setShouldDelayLoadEvent(true);
// 24. Set the networkState back to NETWORK_LOADING.
m_networkState = NETWORK_LOADING;
// 25. Jump back to the find next candidate step above.
m_nextChildNodeToConsider = &source;
scheduleNextSourceChild();
}
void HTMLMediaElement::sourceWasRemoved(HTMLSourceElement& source)
{
if (willLog(WTFLogLevel::Info) && source.hasTagName(sourceTag)) {
URL url = source.getNonEmptyURLAttribute(srcAttr);
INFO_LOG(LOGIDENTIFIER, "'src' is ", url);
}
if (&source != m_currentSourceNode && &source != m_nextChildNodeToConsider)
return;
if (&source == m_nextChildNodeToConsider) {
m_nextChildNodeToConsider = m_currentSourceNode ? Traversal<HTMLSourceElement>::nextSibling(*m_currentSourceNode.copyRef()) : nullptr;
INFO_LOG(LOGIDENTIFIER);
} else if (&source == m_currentSourceNode) {
// Clear the current source node pointer, but don't change the movie as the spec says:
// 4.8.8 - Dynamically modifying a source element and its attribute when the element is already
// inserted in a video or audio element will have no effect.
m_currentSourceNode = nullptr;
INFO_LOG(LOGIDENTIFIER, "m_currentSourceNode cleared");
}
}
void HTMLMediaElement::mediaPlayerTimeChanged()
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_MEDIAPLAYERTIMECHANGED);
updateActiveTextTrackCues(currentMediaTime());
beginProcessingMediaPlayerCallback();
invalidateOfficialPlaybackPosition();
bool wasSeeking = seeking();
// 4.8.10.9 step 14 & 15. Needed if no ReadyState change is associated with the seek.
if (m_seekRequested && m_readyState >= HAVE_CURRENT_DATA && !m_player->seeking())
finishSeek();
// Always call scheduleTimeupdateEvent when the media engine reports a time discontinuity,
// it will only queue a 'timeupdate' event if we haven't already posted one at the current
// movie time.
else
scheduleTimeupdateEvent(false);
MediaTime now = currentMediaTime();
MediaTime dur = durationMediaTime();
double playbackRate = requestedPlaybackRate();
// When the current playback position reaches the end of the media resource then the user agent must follow these steps:
if ((dur || (!dur && !now)) && dur.isValid() && !dur.isPositiveInfinite() && !dur.isNegativeInfinite()) {
// If the media element has a loop attribute specified and does not have a current media controller,
if (loop() && !m_mediaController && playbackRate > 0) {
m_sentEndEvent = false;
// then seek to the earliest possible position of the media resource and abort these steps when the direction of
// playback is forwards,
if (now >= dur && (now + dur) > MediaTime::zeroTime()) {
ALWAYS_LOG(LOGIDENTIFIER, "current time (", now, ") is greater then duration (", dur, "), looping");
seekInternal(MediaTime::zeroTime());
}
} else if ((now <= MediaTime::zeroTime() && playbackRate < 0) || (now >= dur && playbackRate > 0)) {
ALWAYS_LOG(LOGIDENTIFIER, "current time (", now, ") is greater then duration (", dur, ") or <= 0, pausing");
// If the media element does not have a current media controller, and the media element
// has still ended playback and paused is false,
if (!m_mediaController && !m_paused) {
// changes paused to true and fires a simple event named pause at the media element.
setPaused(true);
scheduleEvent(eventNames().pauseEvent);
mediaSession().clientWillPausePlayback();
}
// Queue a task to fire a simple event named ended at the media element.
if (!m_sentEndEvent) {
m_sentEndEvent = true;
scheduleEvent(eventNames().endedEvent);
if (!wasSeeking)
addBehaviorRestrictionsOnEndIfNecessary();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
if (now > m_lastSeekTime)
addPlayedRange(m_lastSeekTime, now);
}
setPlaying(false);
// If the media element has a current media controller, then report the controller state
// for the media element's current media controller.
updateMediaController();
} else
m_sentEndEvent = false;
} else {
#if ENABLE(MEDIA_STREAM)
if (m_mediaStreamSrcObject) {
// http://w3c.github.io/mediacapture-main/#event-mediastream-inactive
// 6. MediaStreams in Media Elements
// When the MediaStream state moves from the active to the inactive state, the User Agent
// must raise an ended event on the HTMLMediaElement and set its ended attribute to true.
// Note that once ended equals true the HTMLMediaElement will not play media even if new
// MediaStreamTrack's are added to the MediaStream (causing it to return to the active
// state) unless autoplay is true or the web application restarts the element, e.g.,
// by calling play()
if (!m_sentEndEvent && m_player && m_player->ended()) {
m_sentEndEvent = true;
scheduleEvent(eventNames().endedEvent);
if (!wasSeeking)
addBehaviorRestrictionsOnEndIfNecessary();
setPaused(true);
setPlaying(false);
}
} else
#endif
m_sentEndEvent = false;
}
scheduleUpdatePlayState();
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::addBehaviorRestrictionsOnEndIfNecessary()
{
if (isFullscreen())
return;
mediaSession().addBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
m_playbackControlsManagerBehaviorRestrictionsTimer.stop();
m_playbackControlsManagerBehaviorRestrictionsTimer.startOneShot(hideMediaControlsAfterEndedDelay);
}
void HTMLMediaElement::handleSeekToPlaybackPosition(double position)
{
#if PLATFORM(MAC)
// FIXME: This should ideally use faskSeek, but this causes MediaRemote's playhead to flicker upon release.
// Please see <rdar://problem/28457219> for more details.
seek(MediaTime::createWithDouble(position));
m_seekToPlaybackPositionEndedTimer.stop();
m_seekToPlaybackPositionEndedTimer.startOneShot(500_ms);
if (!m_isScrubbingRemotely) {
m_isScrubbingRemotely = true;
if ((m_wasPlayingBeforeSeeking = !paused()))
pauseInternal();
}
#else
fastSeek(position);
#endif
}
void HTMLMediaElement::seekToPlaybackPositionEndedTimerFired()
{
#if PLATFORM(MAC)
if (!m_isScrubbingRemotely)
return;
PlatformMediaSessionManager::singleton().sessionDidEndRemoteScrubbing(mediaSession());
m_isScrubbingRemotely = false;
m_seekToPlaybackPositionEndedTimer.stop();
#endif
}
void HTMLMediaElement::mediaPlayerVolumeChanged()
{
ALWAYS_LOG(LOGIDENTIFIER);
beginProcessingMediaPlayerCallback();
if (m_player) {
double vol = m_player->volume();
if (vol != m_volume) {
m_volume = vol;
updateVolume();
scheduleEvent(eventNames().volumechangeEvent);
}
}
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerMuteChanged()
{
ALWAYS_LOG(LOGIDENTIFIER);
beginProcessingMediaPlayerCallback();
if (m_player)
setMuted(m_player->muted());
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerSeeked(const MediaTime&)
{
ALWAYS_LOG(LOGIDENTIFIER);
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource)
m_mediaSource->monitorSourceBuffers(); // Update readyState.
#endif
}
void HTMLMediaElement::mediaPlayerDurationChanged()
{
beginProcessingMediaPlayerCallback();
durationChanged();
mediaPlayerCharacteristicChanged();
MediaTime now = currentMediaTime();
MediaTime dur = durationMediaTime();
ALWAYS_LOG(LOGIDENTIFIER, "duration = ", dur, ", current time = ", now);
if (now > dur)
seekInternal(dur);
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerRateChanged()
{
beginProcessingMediaPlayerCallback();
// Stash the rate in case the one we tried to set isn't what the engine is
// using (eg. it can't handle the rate we set)
m_reportedPlaybackRate = m_player->effectiveRate();
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_MEDIAPLAYERRATECHANGED, m_reportedPlaybackRate);
if (m_reportedPlaybackRate)
startWatchtimeTimer();
else
pauseWatchtimeTimer();
updateSleepDisabling();
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerPlaybackStateChanged()
{
if (!m_player || m_pausedInternal)
return;
updateSleepDisabling();
auto playerPaused = m_player->paused();
bool shouldBePaused = !potentiallyPlaying();
ALWAYS_LOG(LOGIDENTIFIER, "playerPaused: ", playerPaused, ", shouldBePaused: ", shouldBePaused);
if (playerPaused == shouldBePaused)
return;
beginProcessingMediaPlayerCallback();
if (playerPaused)
pauseInternal();
else
playInternal();
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerResourceNotSupported()
{
ALWAYS_LOG(LOGIDENTIFIER);
// The MediaPlayer came across content which no installed engine supports.
mediaLoadingFailed(MediaPlayer::NetworkState::FormatError);
}
// MediaPlayerPresentation methods
void HTMLMediaElement::mediaPlayerRepaint()
{
beginProcessingMediaPlayerCallback();
if (CheckedPtr renderer = this->renderer())
renderer->repaint();
endProcessingMediaPlayerCallback();
}
void HTMLMediaElement::mediaPlayerSizeChanged()
{
ASSERT(m_player);
if (!m_player)
return;
auto naturalSize = m_player->naturalSize();
ALWAYS_LOG(LOGIDENTIFIER, naturalSize);
if (RefPtr mediaDocument = dynamicDowncast<MediaDocument>(document()))
mediaDocument->mediaElementNaturalSizeChanged(expandedIntSize(naturalSize));
beginProcessingMediaPlayerCallback();
if (m_readyState > HAVE_NOTHING)
scheduleResizeEventIfSizeChanged(naturalSize);
updateRenderer();
endProcessingMediaPlayerCallback();
}
bool HTMLMediaElement::mediaPlayerAcceleratedCompositingEnabled()
{
return document().settings().acceleratedCompositingEnabled();
}
void HTMLMediaElement::scheduleMediaEngineWasUpdated()
{
if (m_mediaEngineUpdatedTaskCancellationGroup.hasPendingTask())
return;
auto logSiteIdentifier = LOGIDENTIFIER;
ALWAYS_LOG(logSiteIdentifier, "task scheduled");
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_mediaEngineUpdatedTaskCancellationGroup, [this, logSiteIdentifier] {
UNUSED_PARAM(logSiteIdentifier);
ALWAYS_LOG(logSiteIdentifier, "lambda(), task fired");
Ref protectedThis { *this }; // mediaEngineWasUpdated calls methods that can trigger arbitrary DOM mutations.
mediaEngineWasUpdated();
});
}
void HTMLMediaElement::mediaEngineWasUpdated()
{
ALWAYS_LOG(LOGIDENTIFIER);
beginProcessingMediaPlayerCallback();
updateRenderer();
endProcessingMediaPlayerCallback();
mediaSession().mediaEngineUpdated();
#if ENABLE(ENCRYPTED_MEDIA)
if (RefPtr player = m_player; player && m_mediaKeys)
player->cdmInstanceAttached(m_mediaKeys->protectedCDMInstance());
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
if (RefPtr player = m_player; player && m_webKitMediaKeys)
player->setCDM(&m_webKitMediaKeys->cdm());
#endif
#if ENABLE(VIDEO_PRESENTATION_MODE)
if (RefPtr player = m_player) {
player->setVideoFullscreenFrame(m_videoFullscreenFrame);
player->setVideoFullscreenGravity(m_videoFullscreenGravity);
player->setVideoFullscreenLayer(m_videoFullscreenLayer.get());
}
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
scheduleUpdateMediaState();
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA) && ENABLE(ENCRYPTED_MEDIA)
updateShouldContinueAfterNeedKey();
#endif
if (RefPtr page = document().page())
page->mediaEngineChanged(*this);
}
void HTMLMediaElement::mediaPlayerEngineUpdated()
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_MEDIAPLAYERENGINEUPDATED, m_player->engineDescription().utf8().data());
#if ENABLE(MEDIA_SOURCE)
m_droppedVideoFrames = 0;
#endif
m_havePreparedToPlay = false;
scheduleMediaEngineWasUpdated();
}
// Use WTF_IGNORES_THREAD_SAFETY_ANALYSIS since this function does conditional locking, which is not
// supported by analysis.
void HTMLMediaElement::mediaPlayerWillInitializeMediaEngine() WTF_IGNORES_THREAD_SAFETY_ANALYSIS
{
ASSERT(isMainThread());
#if ENABLE(WEB_AUDIO)
// Make sure the MediaElementAudioSourceNode's process function does not try and access the media player while its engine is getting updated.
if (RefPtr audioSourceNode = m_audioSourceNode.get())
audioSourceNode->processLock().lock();
#endif
}
// Use WTF_IGNORES_THREAD_SAFETY_ANALYSIS since this function does conditional unlocking, which is not
// supported by analysis.
void HTMLMediaElement::mediaPlayerDidInitializeMediaEngine() WTF_IGNORES_THREAD_SAFETY_ANALYSIS
{
ASSERT(isMainThread());
#if ENABLE(WEB_AUDIO)
if (RefPtr audioSourceNode = m_audioSourceNode.get()) {
if (auto* provider = audioSourceProvider())
provider->setClient(audioSourceNode.get());
audioSourceNode->processLock().unlock();
}
#endif
}
void HTMLMediaElement::mediaPlayerCharacteristicChanged()
{
ALWAYS_LOG(LOGIDENTIFIER, m_mediaSession ? m_mediaSession->description() : emptyString());
beginProcessingMediaPlayerCallback();
if (captionDisplayMode() == CaptionUserPreferences::CaptionDisplayMode::Automatic) {
auto languageOfPrimaryAudioTrack = m_player->languageOfPrimaryAudioTrack();
auto audioLanguageChanged = !m_languageOfPrimaryAudioTrack || *m_languageOfPrimaryAudioTrack != languageOfPrimaryAudioTrack;
if (audioLanguageChanged && m_subtitleTrackLanguage != languageOfPrimaryAudioTrack) {
m_languageOfPrimaryAudioTrack = languageOfPrimaryAudioTrack;
markCaptionAndSubtitleTracksAsUnconfigured(AfterDelay);
}
}
if (potentiallyPlaying())
mediaPlayerRenderingModeChanged();
updateRenderer();
if (!paused() && !mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing)) {
scheduleRejectPendingPlayPromises(DOMException::create(ExceptionCode::NotAllowedError));
pauseInternal();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
}
protectedDocument()->updateIsPlayingMedia();
checkForAudioAndVideo();
updateSleepDisabling();
endProcessingMediaPlayerCallback();
}
Ref<TimeRanges> HTMLMediaElement::buffered() const
{
if (!m_player)
return TimeRanges::create();
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource)
return TimeRanges::create(m_mediaSource->buffered());
#endif
return TimeRanges::create(m_player->buffered());
}
double HTMLMediaElement::maxBufferedTime() const
{
auto bufferedRanges = buffered();
unsigned numRanges = bufferedRanges->length();
if (!numRanges)
return 0;
return bufferedRanges.get().ranges().end(numRanges - 1).toDouble();
}
Ref<TimeRanges> HTMLMediaElement::played()
{
if (m_playing) {
MediaTime time = currentMediaTime();
if (time > m_lastSeekTime)
addPlayedRange(m_lastSeekTime, time);
}
if (!m_playedTimeRanges)
m_playedTimeRanges = TimeRanges::create();
return m_playedTimeRanges->copy();
}
Ref<TimeRanges> HTMLMediaElement::seekable() const
{
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource)
return m_mediaSource->seekable();
#endif
if (m_player)
return TimeRanges::create(m_player->seekable());
return TimeRanges::create();
}
double HTMLMediaElement::seekableTimeRangesLastModifiedTime() const
{
return m_player ? m_player->seekableTimeRangesLastModifiedTime() : 0;
}
double HTMLMediaElement::liveUpdateInterval() const
{
return m_player ? m_player->liveUpdateInterval() : 0;
}
bool HTMLMediaElement::potentiallyPlaying() const
{
if (isBlockedOnMediaController())
return false;
if (!couldPlayIfEnoughData())
return false;
if (m_readyState >= HAVE_FUTURE_DATA)
return true;
return m_readyStateMaximum >= HAVE_FUTURE_DATA && m_readyState < HAVE_FUTURE_DATA;
}
bool HTMLMediaElement::couldPlayIfEnoughData() const
{
if (paused())
return false;
if (endedPlayback())
return false;
if (stoppedDueToErrors())
return false;
if (pausedForUserInteraction())
return false;
if (!canProduceAudio() || PlatformMediaSessionManager::singleton().hasActiveAudioSession())
return true;
if (mediaSession().activeAudioSessionRequired() && mediaSession().blockedBySystemInterruption())
return false;
return true;
}
bool HTMLMediaElement::endedPlayback() const
{
MediaTime dur = durationMediaTime();
if (!m_player || !dur.isValid())
return false;
// 4.8.10.8 Playing the media resource
// A media element is said to have ended playback when the element's
// readyState attribute is HAVE_METADATA or greater,
if (m_readyState < HAVE_METADATA)
return false;
// and the current playback position is the end of the media resource and the direction
// of playback is forwards, Either the media element does not have a loop attribute specified,
// or the media element has a current media controller.
MediaTime now = currentMediaTime();
if (requestedPlaybackRate() > 0)
return dur > MediaTime::zeroTime() && now >= dur && (!loop() || m_mediaController);
// or the current playback position is the earliest possible position and the direction
// of playback is backwards
if (requestedPlaybackRate() < 0)
return now <= MediaTime::zeroTime();
return false;
}
bool HTMLMediaElement::stoppedDueToErrors() const
{
if (m_readyState >= HAVE_METADATA && m_error) {
RefPtr seekableRanges = seekable();
if (!seekableRanges->contain(currentTime()))
return true;
}
return false;
}
bool HTMLMediaElement::pausedForUserInteraction() const
{
if (mediaSession().state() == PlatformMediaSession::State::Interrupted)
return true;
return false;
}
MediaTime HTMLMediaElement::minTimeSeekable() const
{
return m_player ? m_player->minTimeSeekable() : MediaTime::zeroTime();
}
MediaTime HTMLMediaElement::maxTimeSeekable() const
{
return m_player ? m_player->maxTimeSeekable() : MediaTime::zeroTime();
}
void HTMLMediaElement::updateVolume()
{
if (!m_player)
return;
if (!m_volumeLocked) {
// Avoid recursion when the player reports volume changes.
if (!processingMediaPlayerCallback()) {
RefPtr player = m_player;
player->setVolumeLocked(m_volumeLocked);
player->setMuted(effectiveMuted());
player->setVolume(effectiveVolume());
}
protectedDocument()->updateIsPlayingMedia();
return;
}
// Only the user can change audio volume so update the cached volume and post the changed event.
float volume = m_player->volume();
if (m_volume != volume) {
m_volume = volume;
scheduleEvent(eventNames().volumechangeEvent);
}
}
void HTMLMediaElement::scheduleUpdatePlayState()
{
if (m_updatePlayStateTaskCancellationGroup.hasPendingTask())
return;
auto logSiteIdentifier = LOGIDENTIFIER;
INFO_LOG(logSiteIdentifier, "task scheduled");
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_updatePlayStateTaskCancellationGroup, [this, logSiteIdentifier] {
UNUSED_PARAM(logSiteIdentifier);
INFO_LOG(logSiteIdentifier, "lambda(), task fired");
updatePlayState();
});
}
void HTMLMediaElement::updatePlayState()
{
if (!m_player)
return;
if (m_pausedInternal) {
if (!m_player->paused())
pausePlayer();
invalidateOfficialPlaybackPosition();
m_playbackProgressTimer.stop();
return;
}
bool shouldBePlaying = potentiallyPlaying();
bool playerPaused = m_player->paused();
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_UPDATEPLAYSTATE, shouldBePlaying, playerPaused);
if (shouldBePlaying && playerPaused && mediaSession().requiresFullscreenForVideoPlayback() && (m_waitingToEnterFullscreen || !isFullscreen())) {
if (!m_waitingToEnterFullscreen)
enterFullscreen();
#if PLATFORM(WATCHOS)
// FIXME: Investigate doing this for all builds.
return;
#endif
}
schedulePlaybackControlsManagerUpdate();
if (shouldBePlaying) {
invalidateOfficialPlaybackPosition();
if (playerPaused) {
mediaSession().clientWillBeginPlayback();
// Set rate, muted and volume before calling play in case they were set before the media engine was set up.
// The media engine should just stash the rate, muted and volume values since it isn't already playing.
RefPtr player = m_player;
player->setRate(requestedPlaybackRate());
player->setVolumeLocked(m_volumeLocked);
player->setMuted(effectiveMuted());
player->setVolume(effectiveVolume());
if (m_firstTimePlaying) {
// Log that a media element was played.
if (RefPtr page = document().page())
page->diagnosticLoggingClient().logDiagnosticMessage(isVideo() ? DiagnosticLoggingKeys::videoKey() : DiagnosticLoggingKeys::audioKey(), DiagnosticLoggingKeys::playedKey(), ShouldSample::No);
m_firstTimePlaying = false;
}
playPlayer();
resumeSpeakingCueText();
}
startPlaybackProgressTimer();
setPlaying(true);
} else {
if (!playerPaused) {
pausePlayer();
pauseSpeakingCueText();
}
m_playbackProgressTimer.stop();
setPlaying(false);
MediaTime time = currentMediaTime();
if (time > m_lastSeekTime)
addPlayedRange(m_lastSeekTime, time);
if (couldPlayIfEnoughData())
prepareToPlay();
}
updateMediaController();
updateRenderer();
checkForAudioAndVideo();
}
void HTMLMediaElement::playPlayer()
{
RefPtr player = m_player;
ASSERT(player);
if (!player)
return;
#if USE(AUDIO_SESSION)
m_categoryAtMostRecentPlayback = AudioSession::sharedSession().category();
m_modeAtMostRecentPlayback = AudioSession::sharedSession().mode();
#endif
#if ENABLE(MEDIA_SESSION) && ENABLE(MEDIA_SESSION_COORDINATOR)
do {
if (!player->supportsPlayAtHostTime())
break;
RefPtr mediaSession = this->mediaSession().mediaSession();
if (!mediaSession)
break;
if (mediaSession->activeMediaElement() != this)
break;
auto currentPlaySessionCommand = mediaSession->coordinator().takeCurrentPlaySessionCommand();
if (!currentPlaySessionCommand)
break;
if (!currentPlaySessionCommand->hostTime)
break;
player->playAtHostTime(*currentPlaySessionCommand->hostTime);
return;
} while (false);
#endif
player->play();
}
void HTMLMediaElement::pausePlayer()
{
RefPtr player = m_player;
ASSERT(player);
if (!player)
return;
player->pause();
}
void HTMLMediaElement::checkForAudioAndVideo()
{
m_hasEverHadAudio |= hasAudio();
m_hasEverHadVideo |= hasVideo();
mediaSession().canProduceAudioChanged();
}
void HTMLMediaElement::setPlaying(bool playing)
{
if (playing && m_mediaSession)
m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequirePlaybackToControlControlsManager);
if (m_playing == playing)
return;
m_playing = playing;
protectedDocument()->updateIsPlayingMedia();
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
scheduleUpdateMediaState();
#endif
}
void HTMLMediaElement::setPausedInternal(bool paused)
{
ALWAYS_LOG(LOGIDENTIFIER, paused);
m_pausedInternal = paused;
scheduleUpdatePlayState();
}
void HTMLMediaElement::pauseAndUpdatePlayStateImmediately()
{
m_pausedInternal = true;
updatePlayState();
}
void HTMLMediaElement::stopPeriodicTimers()
{
m_progressEventTimer.stop();
m_playbackProgressTimer.stop();
m_checkPlaybackTargetCompatibilityTimer.stop();
}
void HTMLMediaElement::cancelPendingTasks()
{
m_configureTextTracksTaskCancellationGroup.cancel();
m_updateTextTracksTaskCancellationGroup.cancel();
m_updateMediaStateTaskCancellationGroup.cancel();
m_mediaEngineUpdatedTaskCancellationGroup.cancel();
m_updatePlayStateTaskCancellationGroup.cancel();
m_resumeTaskCancellationGroup.cancel();
m_seekTaskCancellationGroup.cancel();
m_playbackControlsManagerBehaviorRestrictionsTaskCancellationGroup.cancel();
m_updateShouldAutoplayTaskCancellationGroup.cancel();
if (m_volumeLocked)
m_volumeRevertTaskCancellationGroup.cancel();
cancelSniffer();
}
void HTMLMediaElement::cancelSniffer()
{
if (auto sniffer = std::exchange(m_sniffer, { }))
sniffer->cancel();
}
void HTMLMediaElement::userCancelledLoad()
{
INFO_LOG(LOGIDENTIFIER);
// FIXME: We should look to reconcile the iOS and non-iOS code (below).
#if PLATFORM(IOS_FAMILY)
if (m_networkState == NETWORK_EMPTY || m_readyState >= HAVE_METADATA)
return;
#else
if (m_networkState == NETWORK_EMPTY || m_completelyLoaded)
return;
#endif
// If the media data fetching process is aborted by the user:
// 1 - The user agent should cancel the fetching process.
clearMediaPlayer();
// 2 - Set the error attribute to a new MediaError object whose code attribute is set to MEDIA_ERR_ABORTED.
m_error = MediaError::create(MediaError::MEDIA_ERR_ABORTED, "Load was aborted"_s);
// 3 - Queue a task to fire a simple event named error at the media element.
scheduleEvent(eventNames().abortEvent);
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
// 4 - If the media element's readyState attribute has a value equal to HAVE_NOTHING, set the
// element's networkState attribute to the NETWORK_EMPTY value, set the element's show poster
// flag to true, and fire an event named emptied at the element.
if (m_readyState == HAVE_NOTHING) {
m_networkState = NETWORK_EMPTY;
setShowPosterFlag(true);
scheduleEvent(eventNames().emptiedEvent);
}
else
m_networkState = NETWORK_IDLE;
// 5 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
setShouldDelayLoadEvent(false);
// 6 - Abort the overall resource selection algorithm.
m_currentSourceNode = nullptr;
// Reset m_readyState since m_player is gone.
m_readyState = HAVE_NOTHING;
updateMediaController();
if (isSuspended())
return; // Document is about to be destructed. Avoid updating layout in updateActiveTextTrackCues.
updateActiveTextTrackCues(MediaTime::zeroTime());
}
void HTMLMediaElement::clearMediaPlayer()
{
invalidateWatchtimeTimer();
invalidateBufferingStopwatch();
#if ENABLE(MEDIA_STREAM)
if (!m_settingMediaStreamSrcObject)
m_mediaStreamSrcObject = nullptr;
#endif
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
m_blob = nullptr;
forgetResourceSpecificTracks();
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (hasTargetAvailabilityListeners()) {
m_hasPlaybackTargetAvailabilityListeners = false;
if (m_mediaSession)
m_mediaSession->setHasPlaybackTargetAvailabilityListeners(false);
// Send an availability event in case scripts want to hide the picker when the element
// doesn't support playback to a target.
if (!isWirelessPlaybackTargetDisabled())
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::Always);
}
if (m_isPlayingToWirelessTarget)
setIsPlayingToWirelessTarget(false);
#endif
if (m_isWaitingUntilMediaCanStart) {
m_isWaitingUntilMediaCanStart = false;
protectedDocument()->removeMediaCanStartListener(*this);
}
if (RefPtr player = m_player) {
player->invalidate();
m_player = nullptr;
}
schedulePlaybackControlsManagerUpdate();
stopPeriodicTimers();
cancelPendingTasks();
m_loadState = WaitingForSource;
if (m_textTracks)
configureTextTrackDisplay();
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
if (m_mediaSession) {
m_mediaSession->clientCharacteristicsChanged(false);
m_mediaSession->canProduceAudioChanged();
}
});
m_resourceSelectionTaskCancellationGroup.cancel();
updateSleepDisabling();
updateRenderer();
}
void HTMLMediaElement::stopWithoutDestroyingMediaPlayer()
{
INFO_LOG(LOGIDENTIFIER);
invalidateWatchtimeTimer();
invalidateBufferingStopwatch();
if (m_videoFullscreenMode != VideoFullscreenModeNone)
exitFullscreen();
setPreparedToReturnVideoLayerToInline(true);
schedulePlaybackControlsManagerUpdate();
setInActiveDocument(false);
// Stop the playback without generating events
setPlaying(false);
pauseAndUpdatePlayStateImmediately();
if (m_mediaSession)
m_mediaSession->clientWillBeDOMSuspended();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
userCancelledLoad();
updateRenderer();
stopPeriodicTimers();
updateSleepDisabling();
}
void HTMLMediaElement::closeTaskQueues()
{
cancelPendingTasks();
m_resourceSelectionTaskCancellationGroup.cancel();
m_asyncEventsCancellationGroup.cancel();
}
void HTMLMediaElement::contextDestroyed()
{
closeTaskQueues();
m_pendingPlayPromises.clear();
ActiveDOMObject::contextDestroyed();
}
void HTMLMediaElement::stop()
{
ALWAYS_LOG(LOGIDENTIFIER);
Ref protectedThis { *this };
stopWithoutDestroyingMediaPlayer();
closeTaskQueues();
// Once an active DOM object has been stopped it can not be restarted, so we can deallocate
// the media player now. Note that userCancelledLoad will already called clearMediaPlayer
// if the media was not fully loaded, but we need the same cleanup if the file was completely
// loaded and calling it again won't cause any problems.
clearMediaPlayer();
if (m_mediaSession)
m_mediaSession->stopSession();
}
void HTMLMediaElement::suspend(ReasonForSuspension reason)
{
ALWAYS_LOG(LOGIDENTIFIER);
Ref protectedThis { *this };
m_resumeTaskCancellationGroup.cancel();
switch (reason) {
case ReasonForSuspension::BackForwardCache:
stopWithoutDestroyingMediaPlayer();
setBufferingPolicy(BufferingPolicy::MakeResourcesPurgeable);
if (m_mediaSession)
m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePageConsentToResumeMedia);
break;
case ReasonForSuspension::PageWillBeSuspended:
case ReasonForSuspension::JavaScriptDebuggerPaused:
case ReasonForSuspension::WillDeferLoading:
// Do nothing, we don't pause media playback in these cases.
break;
}
}
void HTMLMediaElement::resume()
{
ALWAYS_LOG(LOGIDENTIFIER);
setInActiveDocument(true);
if (m_mediaSession && !m_mediaSession->pageAllowsPlaybackAfterResuming())
document().addMediaCanStartListener(*this);
else
setPausedInternal(false);
if (m_mediaSession) {
m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequirePageConsentToResumeMedia);
m_mediaSession->updateBufferingPolicy();
}
if (m_error && m_error->code() == MediaError::MEDIA_ERR_ABORTED && !m_resumeTaskCancellationGroup.hasPendingTask()) {
// Restart the load if it was aborted in the middle by moving the document to the back/forward cache.
// m_error is only left at MEDIA_ERR_ABORTED when the document becomes inactive (it is set to
// MEDIA_ERR_ABORTED while the abortEvent is being sent, but cleared immediately afterwards).
// This behavior is not specified but it seems like a sensible thing to do.
// As it is not safe to immedately start loading now, let's schedule a load.
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_resumeTaskCancellationGroup, std::bind(&HTMLMediaElement::prepareForLoad, this));
}
updateRenderer();
}
bool HTMLMediaElement::virtualHasPendingActivity() const
{
// NOTE: This method will be called from a non-main thread.
// A media element has pending activity if:
// * It is initializing its media controls
if (m_controlsState == ControlsState::Initializing)
return true;
// A paused media element may become a playing media element
// if it was paused due to an interruption:
bool isPlayingOrPossbilyCouldPlay = [&] {
if (isPlaying())
return true;
auto* mediaSession = this->mediaSessionIfExists();
if (!mediaSession)
return false;
if (mediaSession->state() != PlatformMediaSession::State::Interrupted)
return false;
auto stateToRestore = mediaSession->stateToRestore();
return stateToRestore == PlatformMediaSession::State::Autoplaying
|| stateToRestore == PlatformMediaSession::State::Playing;
}();
// * It is playing, and is audible to the user:
if (isPlayingOrPossbilyCouldPlay && canProduceAudio())
return true;
// If a media element is not directly observable by the user, it cannot
// have pending activity if it does not have event listeners:
if (!hasEventListeners())
return false;
// A media element has pending activity if it has event listeners and:
// * The load algorithm is pending, and will thus fire "loadstart" events:
if (m_resourceSelectionTaskCancellationGroup.hasPendingTask())
return true;
// * It has a media engine and:
if (m_player && m_player->hasMediaEngine()) {
// * It is playing, and will thus fire "timeupdate" and "ended" events:
if (isPlayingOrPossbilyCouldPlay)
return true;
// * It is seeking, and will thus fire "seeked" events:
if (seeking())
return true;
// * It is loading, and will thus fire "progress" or "stalled" events:
if (m_networkState == NETWORK_LOADING)
return true;
#if ENABLE(MEDIA_STREAM)
// * It has a live MediaStream object:
if (m_mediaStreamSrcObject)
return true;
#endif
}
// Otherwise, the media element will fire no events at event listeners, and
// thus does not have observable pending activity.
return false;
}
void HTMLMediaElement::mediaVolumeDidChange()
{
// FIXME: We should try to reconcile this so there's no difference for m_volumeLocked.
if (m_volumeLocked)
return;
INFO_LOG(LOGIDENTIFIER);
updateVolume();
}
bool HTMLMediaElement::elementIsHidden() const
{
#if ENABLE(FULLSCREEN_API)
auto* fullscreenManager = document().fullscreenManagerIfExists();
if (isVideo() && fullscreenManager && fullscreenManager->isFullscreen() && fullscreenManager->fullscreenElement())
return false;
#endif
if (m_videoFullscreenMode != VideoFullscreenModeNone)
return false;
return document().hidden() && (!m_player || !m_player->isVisibleForCanvas());
}
void HTMLMediaElement::visibilityStateChanged()
{
bool elementIsHidden = this->elementIsHidden();
if (elementIsHidden == m_elementIsHidden)
return;
m_elementIsHidden = elementIsHidden;
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_VISIBILITYSTATECHANGED, !m_elementIsHidden);
updateSleepDisabling();
mediaSession().visibilityChanged();
if (RefPtr player = m_player)
player->setPageIsVisible(!m_elementIsHidden);
#if HAVE(SPATIAL_TRACKING_LABEL)
updateSpatialTrackingLabel();
#endif
}
void HTMLMediaElement::setTextTrackRepresentataionBounds(const IntRect& bounds)
{
m_textTrackRepresentationBounds = bounds;
if (!m_requiresTextTrackRepresentation)
return;
if (!ensureMediaControls())
return;
if (auto* textTrackRepresentation = m_mediaControlsHost->textTrackRepresentation())
textTrackRepresentation->setBounds(bounds);
}
void HTMLMediaElement::setRequiresTextTrackRepresentation(bool requiresTextTrackRepresentation)
{
if (m_requiresTextTrackRepresentation == requiresTextTrackRepresentation)
return;
m_requiresTextTrackRepresentation = requiresTextTrackRepresentation;
if (!ensureMediaControls())
return;
m_mediaControlsHost->requiresTextTrackRepresentationChanged();
if (m_textTrackRepresentationBounds.isEmpty() || !m_requiresTextTrackRepresentation)
return;
if (auto* textTrackRepresentation = m_mediaControlsHost->textTrackRepresentation())
textTrackRepresentation->setBounds(m_textTrackRepresentationBounds);
}
bool HTMLMediaElement::requiresTextTrackRepresentation() const
{
return m_requiresTextTrackRepresentation;
}
void HTMLMediaElement::setTextTrackRepresentation(TextTrackRepresentation* representation)
{
if (RefPtr player = m_player)
player->setTextTrackRepresentation(representation);
if (!representation) {
protectedDocument()->clearMediaElementShowingTextTrack();
return;
}
#if ENABLE(VIDEO_PRESENTATION_MODE)
if (representation->bounds().isEmpty())
representation->setBounds(enclosingIntRect(m_videoFullscreenFrame));
#endif
protectedDocument()->setMediaElementShowingTextTrack(*this);
}
void HTMLMediaElement::syncTextTrackBounds()
{
if (RefPtr player = m_player)
player->syncTextTrackBounds();
}
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
void HTMLMediaElement::webkitShowPlaybackTargetPicker()
{
ALWAYS_LOG(LOGIDENTIFIER);
if (processingUserGestureForMedia())
removeBehaviorRestrictionsAfterFirstUserGesture();
mediaSession().showPlaybackTargetPicker();
}
void HTMLMediaElement::wirelessRoutesAvailableDidChange()
{
if (isWirelessPlaybackTargetDisabled())
return;
bool hasTargets = mediaSession().hasWirelessPlaybackTargets();
Ref { m_remote }->availabilityChanged(hasTargets);
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::OnlyWhenChanged);
}
void HTMLMediaElement::mediaPlayerCurrentPlaybackTargetIsWirelessChanged(bool isCurrentPlayBackTargetWireless)
{
setIsPlayingToWirelessTarget(m_player && isCurrentPlayBackTargetWireless);
}
void HTMLMediaElement::setIsPlayingToWirelessTarget(bool isPlayingToWirelessTarget)
{
auto logSiteIdentifier = LOGIDENTIFIER;
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, isPlayingToWirelessTarget, logSiteIdentifier] {
if (isContextStopped())
return;
auto newValue = isPlayingToWirelessTarget && m_player && m_player->isCurrentPlaybackTargetWireless();
if (newValue == m_isPlayingToWirelessTarget)
return;
UNUSED_PARAM(logSiteIdentifier);
m_isPlayingToWirelessTarget = newValue;
Ref { m_remote }->isPlayingToRemoteTargetChanged(m_isPlayingToWirelessTarget);
ALWAYS_LOG(logSiteIdentifier, m_isPlayingToWirelessTarget);
configureMediaControls();
mediaSession().isPlayingToWirelessPlaybackTargetChanged(m_isPlayingToWirelessTarget);
mediaSession().canProduceAudioChanged();
scheduleUpdateMediaState();
updateSleepDisabling();
m_failedToPlayToWirelessTarget = false;
m_checkPlaybackTargetCompatibilityTimer.startOneShot(500_ms);
if (!isContextStopped())
dispatchEvent(Event::create(eventNames().webkitcurrentplaybacktargetiswirelesschangedEvent, Event::CanBubble::No, Event::IsCancelable::Yes));
});
}
void HTMLMediaElement::enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior behavior)
{
bool hasTargets = !isWirelessPlaybackTargetDisabled() && m_mediaSession && mediaSession().hasWirelessPlaybackTargets();
if (behavior == EnqueueBehavior::OnlyWhenChanged && hasTargets == m_lastTargetAvailabilityEventState)
return;
ALWAYS_LOG(LOGIDENTIFIER, "hasTargets = ", hasTargets);
m_lastTargetAvailabilityEventState = hasTargets;
#if ENABLE(WIRELESS_PLAYBACK_TARGET_AVAILABILITY_API)
Ref event = WebKitPlaybackTargetAvailabilityEvent::create(eventNames().webkitplaybacktargetavailabilitychangedEvent, hasTargets);
scheduleEvent(WTFMove(event));
#endif
scheduleUpdateMediaState();
}
void HTMLMediaElement::setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&& device)
{
bool hasActiveRoute = device->hasActiveRoute();
ALWAYS_LOG(LOGIDENTIFIER, hasActiveRoute);
if (RefPtr player = m_player)
player->setWirelessPlaybackTarget(WTFMove(device));
Ref { m_remote }->shouldPlayToRemoteTargetChanged(hasActiveRoute);
}
void HTMLMediaElement::setShouldPlayToPlaybackTarget(bool shouldPlay)
{
if (RefPtr player = m_player) {
player->setShouldPlayToPlaybackTarget(shouldPlay);
setIsPlayingToWirelessTarget(player->isCurrentPlaybackTargetWireless());
}
}
void HTMLMediaElement::playbackTargetPickerWasDismissed()
{
Ref { m_remote }->playbackTargetPickerWasDismissed();
}
void HTMLMediaElement::remoteHasAvailabilityCallbacksChanged()
{
bool hasListeners = hasEnabledTargetAvailabilityListeners();
if (m_hasPlaybackTargetAvailabilityListeners == hasListeners)
return;
ALWAYS_LOG(LOGIDENTIFIER, "hasListeners: ", hasListeners);
m_hasPlaybackTargetAvailabilityListeners = hasListeners;
mediaSession().setHasPlaybackTargetAvailabilityListeners(hasListeners);
scheduleUpdateMediaState();
}
bool HTMLMediaElement::hasWirelessPlaybackTargetAlternative() const
{
if (m_loadState != LoadingFromSourceElement)
return false;
for (auto& source : childrenOfType<HTMLSourceElement>(*this)) {
auto mediaURL = source.getNonEmptyURLAttribute(srcAttr);
bool maybeSuitable = !mediaURL.isEmpty();
#if ENABLE(MEDIA_SOURCE)
maybeSuitable &= !mediaURL.protocolIs(mediaSourceBlobProtocol);
#endif
if (!maybeSuitable || !isSafeToLoadURL(mediaURL, InvalidURLAction::DoNothing, false))
continue;
return true;
}
return false;
}
bool HTMLMediaElement::hasTargetAvailabilityListeners()
{
return hasEventListeners(eventNames().webkitplaybacktargetavailabilitychangedEvent) || m_remote->hasAvailabilityCallbacks();
}
bool HTMLMediaElement::hasEnabledTargetAvailabilityListeners()
{
return !m_wirelessPlaybackTargetDisabled && hasTargetAvailabilityListeners();
}
void HTMLMediaElement::isWirelessPlaybackTargetDisabledChanged()
{
bool disabled = equalLettersIgnoringASCIICase(attributeWithoutSynchronization(HTMLNames::webkitairplayAttr), "deny"_s)
|| hasAttributeWithoutSynchronization(HTMLNames::webkitwirelessvideoplaybackdisabledAttr)
|| hasAttributeWithoutSynchronization(HTMLNames::disableremoteplaybackAttr);
if (m_wirelessPlaybackTargetDisabled == disabled)
return;
m_wirelessPlaybackTargetDisabled = disabled;
if (!m_wirelessPlaybackTargetDisabled && hasTargetAvailabilityListeners()) {
m_hasPlaybackTargetAvailabilityListeners = true;
mediaSession().setActive(true);
mediaSession().setHasPlaybackTargetAvailabilityListeners(true);
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::Always);
} else if (m_wirelessPlaybackTargetDisabled && hasTargetAvailabilityListeners()) {
m_hasPlaybackTargetAvailabilityListeners = false;
mediaSession().setHasPlaybackTargetAvailabilityListeners(false);
// If the client has disabled remote playback, also has availability listeners,
// and the last state sent to the client was that targets were available,
// fire one last event indicating no pickable targets exist. This has the effect
// of having players disable their remote playback picker buttons.
if (m_lastTargetAvailabilityEventState)
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::Always);
}
scheduleUpdateMediaState();
}
bool HTMLMediaElement::isWirelessPlaybackTargetDisabled() const
{
return m_wirelessPlaybackTargetDisabled;
}
#endif // ENABLE(WIRELESS_PLAYBACK_TARGET)
void HTMLMediaElement::dispatchEvent(Event& event)
{
DEBUG_LOG(LOGIDENTIFIER, event.type());
if (event.type() == eventNames().endedEvent) {
if (m_removedBehaviorRestrictionsAfterFirstUserGesture)
protectedDocument()->userActivatedMediaFinishedPlaying();
updateSleepDisabling();
}
HTMLElement::dispatchEvent(event);
// Forward the fullscreenchange event to the UserAgentShadowRoot so that
// the media controls code can add "fullscreenchange" listeners without
// changing the behavior of existing clients listening for the prefixed
// "webkitfullscreenchange" event.
if (event.type() == eventNames().fullscreenchangeEvent) {
if (RefPtr root = userAgentShadowRoot())
root->dispatchEvent(Event::create(eventNames().fullscreenchangeEvent, Event::CanBubble::No, Event::IsCancelable::No));
}
// Some pages may change the position/size of an inline video element
// when/after the video element enters fullscreen (rdar://problem/55814988).
// We need to fire the end fullscreen event to notify the page
// to change the position/size back *before* exiting fullscreen.
// Otherwise, the exit fullscreen animation will be incorrect.
if (!m_videoFullscreenStandby && m_videoFullscreenMode == VideoFullscreenModeNone && event.type() == eventNames().webkitendfullscreenEvent)
document().protectedPage()->chrome().client().exitVideoFullscreenForVideoElement(downcast<HTMLVideoElement>(*this));
}
bool HTMLMediaElement::addEventListener(const AtomString& eventType, Ref<EventListener>&& listener, const AddEventListenerOptions& options)
{
#if ENABLE(LEGACY_ENCRYPTED_MEDIA) && ENABLE(ENCRYPTED_MEDIA)
if (eventType == eventNames().webkitneedkeyEvent)
updateShouldContinueAfterNeedKey();
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (eventType != eventNames().webkitplaybacktargetavailabilitychangedEvent)
return Node::addEventListener(eventType, WTFMove(listener), options);
bool isFirstAvailabilityChangedListener = !hasTargetAvailabilityListeners();
if (!Node::addEventListener(eventType, WTFMove(listener), options))
return false;
if (isWirelessPlaybackTargetDisabled())
return true;
if (isFirstAvailabilityChangedListener) {
m_hasPlaybackTargetAvailabilityListeners = true;
mediaSession().setActive(true);
mediaSession().setHasPlaybackTargetAvailabilityListeners(true);
}
ALWAYS_LOG(LOGIDENTIFIER, "'webkitplaybacktargetavailabilitychanged'");
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::Always); // Ensure the event listener gets at least one event.
return true;
#else
return Node::addEventListener(eventType, WTFMove(listener), options);
#endif // ENABLE(WIRELESS_PLAYBACK_TARGET)
}
bool HTMLMediaElement::removeEventListener(const AtomString& eventType, EventListener& listener, const EventListenerOptions& options)
{
#if ENABLE(LEGACY_ENCRYPTED_MEDIA) && ENABLE(ENCRYPTED_MEDIA)
if (eventType == eventNames().webkitneedkeyEvent)
updateShouldContinueAfterNeedKey();
#endif
bool listenerWasRemoved = Node::removeEventListener(eventType, listener, options);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (eventType != eventNames().webkitplaybacktargetavailabilitychangedEvent)
return listenerWasRemoved;
if (!listenerWasRemoved)
return false;
bool didRemoveLastAvailabilityChangedListener = !hasTargetAvailabilityListeners();
ALWAYS_LOG(LOGIDENTIFIER, "removed last listener = ", didRemoveLastAvailabilityChangedListener);
if (didRemoveLastAvailabilityChangedListener) {
m_hasPlaybackTargetAvailabilityListeners = false;
mediaSession().setHasPlaybackTargetAvailabilityListeners(false);
scheduleUpdateMediaState();
}
#endif // ENABLE(WIRELESS_PLAYBACK_TARGET)
return listenerWasRemoved;
}
bool HTMLMediaElement::webkitCurrentPlaybackTargetIsWireless() const
{
INFO_LOG(LOGIDENTIFIER, m_isPlayingToWirelessTarget);
return m_isPlayingToWirelessTarget;
}
void HTMLMediaElement::setPlayingOnSecondScreen(bool value)
{
if (value == m_playingOnSecondScreen)
return;
m_playingOnSecondScreen = value;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
scheduleUpdateMediaState();
#endif
}
double HTMLMediaElement::minFastReverseRate() const
{
return m_player ? m_player->minFastReverseRate() : 0;
}
double HTMLMediaElement::maxFastForwardRate() const
{
return m_player ? m_player->maxFastForwardRate() : 0;
}
bool HTMLMediaElement::taintsOrigin(const SecurityOrigin& origin) const
{
if (didPassCORSAccessCheck())
return false;
return m_player && m_player->isCrossOrigin(origin);
}
bool HTMLMediaElement::isFullscreen() const
{
#if ENABLE(FULLSCREEN_API)
CheckedPtr fullscreenManager = document().fullscreenManagerIfExists();
if (fullscreenManager && fullscreenManager->isFullscreen() && fullscreenManager->fullscreenElement() == this)
return true;
#endif
return m_videoFullscreenMode != VideoFullscreenModeNone;
}
bool HTMLMediaElement::isStandardFullscreen() const
{
#if ENABLE(FULLSCREEN_API)
CheckedPtr fullscreenManager = document().fullscreenManagerIfExists();
if (fullscreenManager && fullscreenManager->isFullscreen() && fullscreenManager->fullscreenElement() == this)
return true;
#endif
return m_videoFullscreenMode == VideoFullscreenModeStandard;
}
void HTMLMediaElement::toggleStandardFullscreenState()
{
if (isStandardFullscreen())
exitFullscreen();
else
enterFullscreen();
}
bool HTMLMediaElement::videoUsesElementFullscreen() const
{
#if ENABLE(FULLSCREEN_API)
#if ENABLE(LINEAR_MEDIA_PLAYER)
if (document().settings().linearMediaPlayerEnabled()) {
if (RefPtr player = m_player; player && player->supportsLinearMediaPlayer())
return false;
}
#endif
#if PLATFORM(IOS_FAMILY)
if (document().settings().videoFullscreenRequiresElementFullscreen())
return true;
#else
return true;
#endif // PLATFORM(IOS_FAMILY)
#endif
return false;
}
void HTMLMediaElement::setPlayerIdentifierForVideoElement()
{
ALWAYS_LOG(LOGIDENTIFIER);
RefPtr page = document().page();
if (!page || page->mediaPlaybackIsSuspended())
return;
RefPtr window = document().domWindow();
if (!window)
return;
if (RefPtr asVideo = dynamicDowncast<HTMLVideoElement>(*this)) {
auto& client = document().page()->chrome().client();
client.setPlayerIdentifierForVideoElement(*asVideo);
}
}
void HTMLMediaElement::enterFullscreen(VideoFullscreenMode mode)
{
ALWAYS_LOG(LOGIDENTIFIER, ", m_videoFullscreenMode = ", m_videoFullscreenMode, ", mode = ", mode);
ASSERT(mode != VideoFullscreenModeNone);
RefPtr page = document().page();
if (!page || page->mediaPlaybackIsSuspended())
return;
RefPtr window = document().domWindow();
if (!window)
return;
if (m_videoFullscreenMode == mode)
return;
if (m_waitingToEnterFullscreen)
return;
m_changingVideoFullscreenMode = true;
#if ENABLE(FULLSCREEN_API) && ENABLE(VIDEO_USES_ELEMENT_FULLSCREEN)
if (videoUsesElementFullscreen() && page->isFullscreenManagerEnabled() && isInWindowOrStandardFullscreen(mode)) {
m_temporarilyAllowingInlinePlaybackAfterFullscreen = false;
m_waitingToEnterFullscreen = true;
FullscreenManager::FullscreenCheckType fullscreenCheckType = m_ignoreFullscreenPermissionsPolicy ? FullscreenManager::ExemptIFrameAllowFullscreenRequirement : FullscreenManager::EnforceIFrameAllowFullscreenRequirement;
m_ignoreFullscreenPermissionsPolicy = false;
protectedDocument()->checkedFullscreenManager()->requestFullscreenForElement(*this, fullscreenCheckType, [weakThis = WeakPtr { *this }](ExceptionOr<void> result) {
RefPtr protectedThis = weakThis.get();
if (!protectedThis || !result.hasException())
return;
protectedThis->m_changingVideoFullscreenMode = false;
protectedThis->m_waitingToEnterFullscreen = false;
}, mode);
return;
}
#endif
if (mediaSession().hasBehaviorRestriction(MediaElementSession::RequireUserGestureForFullscreen))
window->consumeTransientActivation();
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this, mode, logIdentifier = LOGIDENTIFIER] {
if (isContextStopped())
return;
if (document().hidden() && mode != HTMLMediaElementEnums::VideoFullscreenModePictureInPicture) {
ALWAYS_LOG(logIdentifier, " returning because document is hidden");
m_changingVideoFullscreenMode = false;
return;
}
if (auto* asVideo = dynamicDowncast<HTMLVideoElement>(*this)) {
auto& client = document().page()->chrome().client();
auto supportsFullscreen = client.supportsVideoFullscreen(mode);
auto canEnterFullscreen = client.canEnterVideoFullscreen(mode);
if (supportsFullscreen && canEnterFullscreen) {
ALWAYS_LOG(logIdentifier, "Entering fullscreen mode ", mode, ", m_videoFullscreenStandby = ", m_videoFullscreenStandby);
m_temporarilyAllowingInlinePlaybackAfterFullscreen = false;
if (isInWindowOrStandardFullscreen(mode))
m_waitingToEnterFullscreen = true;
auto oldMode = m_videoFullscreenMode;
setFullscreenMode(mode);
configureMediaControls();
client.enterVideoFullscreenForVideoElement(*asVideo, m_videoFullscreenMode, m_videoFullscreenStandby);
if (m_videoFullscreenStandby)
return;
if (isInWindowOrStandardFullscreen(mode))
scheduleEvent(eventNames().webkitbeginfullscreenEvent);
else if (isInWindowOrStandardFullscreen(oldMode) && !document().quirks().shouldDisableEndFullscreenEventWhenEnteringPictureInPictureFromFullscreenQuirk())
scheduleEvent(eventNames().webkitendfullscreenEvent);
return;
}
ALWAYS_LOG(logIdentifier, "Could not enter fullscreen mode ", mode, ", support = ", supportsFullscreen, ", canEnter = ", canEnterFullscreen);
}
m_changingVideoFullscreenMode = false;
});
}
void HTMLMediaElement::enterFullscreen()
{
enterFullscreen(VideoFullscreenModeStandard);
}
void HTMLMediaElement::exitFullscreen()
{
ALWAYS_LOG(LOGIDENTIFIER);
m_waitingToEnterFullscreen = false;
#if ENABLE(FULLSCREEN_API)
if (document().fullscreenManager().fullscreenElement() == this) {
if (document().fullscreenManager().isFullscreen()) {
m_changingVideoFullscreenMode = true;
protectedDocument()->checkedFullscreenManager()->fullyExitFullscreen();
}
if (isInWindowOrStandardFullscreen(m_videoFullscreenMode))
return;
}
#endif
ASSERT(m_videoFullscreenMode != VideoFullscreenModeNone);
VideoFullscreenMode oldVideoFullscreenMode = m_videoFullscreenMode;
if (!document().page())
return;
auto* videoElement = dynamicDowncast<HTMLVideoElement>(*this);
if (!videoElement)
return;
if (!paused() && mediaSession().requiresFullscreenForVideoPlayback()) {
if (!document().settings().allowsInlineMediaPlaybackAfterFullscreen() || isVideoTooSmallForInlinePlayback())
pauseInternal();
else {
// Allow inline playback, but set a flag so pausing and starting again (e.g. when scrubbing or looping) won't go back to fullscreen.
// Also set the controls attribute so the user will be able to control playback.
m_temporarilyAllowingInlinePlaybackAfterFullscreen = true;
setControls(true);
}
}
if (isSuspended()) {
setFullscreenMode(VideoFullscreenModeNone);
document().protectedPage()->chrome().client().exitVideoFullscreenToModeWithoutAnimation(*videoElement, VideoFullscreenModeNone);
} else if (document().protectedPage()->chrome().client().supportsVideoFullscreen(oldVideoFullscreenMode)) {
if (m_videoFullscreenStandby) {
setFullscreenMode(VideoFullscreenModeNone);
m_changingVideoFullscreenMode = true;
document().protectedPage()->chrome().client().enterVideoFullscreenForVideoElement(*videoElement, m_videoFullscreenMode, m_videoFullscreenStandby);
return;
}
m_changingVideoFullscreenMode = true;
if (isInWindowOrStandardFullscreen(oldVideoFullscreenMode)) {
setFullscreenMode(VideoFullscreenModeNone);
// The exit fullscreen request will be sent in dispatchEvent().
scheduleEvent(eventNames().webkitendfullscreenEvent);
return;
}
setFullscreenMode(VideoFullscreenModeNone);
if (RefPtr page = document().page())
page->chrome().client().exitVideoFullscreenForVideoElement(*videoElement);
}
}
void HTMLMediaElement::prepareForVideoFullscreenStandby()
{
#if ENABLE(VIDEO_PRESENTATION_MODE)
if (!document().page())
return;
document().protectedPage()->chrome().client().prepareForVideoFullscreen();
#endif
}
void HTMLMediaElement::willBecomeFullscreenElement(VideoFullscreenMode mode)
{
#if PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE)
HTMLMediaElementEnums::VideoFullscreenMode oldVideoFullscreenMode = m_videoFullscreenMode;
#endif
if (!isInWindowOrStandardFullscreen(m_videoFullscreenMode))
setFullscreenMode(mode);
#if PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE)
if (oldVideoFullscreenMode == VideoFullscreenModePictureInPicture) {
if (RefPtr video = dynamicDowncast<HTMLVideoElement>(*this)) {
if (RefPtr page = document().page(); page && mode == VideoFullscreenModeInWindow)
page->chrome().client().exitVideoFullscreenForVideoElement(*video);
else
video->exitToFullscreenModeWithoutAnimationIfPossible(oldVideoFullscreenMode, mode);
}
}
#endif
Element::willBecomeFullscreenElement();
}
void HTMLMediaElement::didBecomeFullscreenElement()
{
ALWAYS_LOG(LOGIDENTIFIER, ", fullscreen mode = ", fullscreenMode());
m_waitingToEnterFullscreen = false;
m_changingVideoFullscreenMode = false;
scheduleUpdatePlayState();
}
void HTMLMediaElement::willStopBeingFullscreenElement()
{
if (isInWindowOrStandardFullscreen(fullscreenMode()))
setFullscreenMode(VideoFullscreenModeNone);
}
void HTMLMediaElement::didStopBeingFullscreenElement()
{
m_changingVideoFullscreenMode = false;
}
PlatformLayer* HTMLMediaElement::platformLayer() const
{
return m_player ? m_player->platformLayer() : nullptr;
}
void HTMLMediaElement::setPreparedToReturnVideoLayerToInline(bool value)
{
m_preparedForInline = value;
if (m_preparedForInline && m_preparedForInlineCompletionHandler) {
m_preparedForInlineCompletionHandler();
m_preparedForInlineCompletionHandler = nullptr;
}
}
void HTMLMediaElement::waitForPreparedForInlineThen(Function<void()>&& completionHandler)
{
INFO_LOG(LOGIDENTIFIER);
ASSERT(!m_preparedForInlineCompletionHandler);
if (m_preparedForInline) {
completionHandler();
return;
}
m_preparedForInlineCompletionHandler = WTFMove(completionHandler);
}
#if ENABLE(VIDEO_PRESENTATION_MODE)
void HTMLMediaElement::willExitFullscreen()
{
if (RefPtr player = m_player)
player->updateVideoFullscreenInlineImage();
}
bool HTMLMediaElement::isVideoLayerInline()
{
return !m_videoFullscreenLayer;
}
RetainPtr<PlatformLayer> HTMLMediaElement::createVideoFullscreenLayer()
{
if (RefPtr player = m_player)
return player->createVideoFullscreenLayer();
return nullptr;
}
void HTMLMediaElement::setVideoFullscreenLayer(PlatformLayer* platformLayer, Function<void()>&& completionHandler)
{
INFO_LOG(LOGIDENTIFIER);
m_videoFullscreenLayer = platformLayer;
if (!m_player) {
completionHandler();
return;
}
RefPtr { m_player }->setVideoFullscreenLayer(platformLayer, WTFMove(completionHandler));
invalidateStyleAndLayerComposition();
updateTextTrackDisplay();
}
void HTMLMediaElement::setVideoFullscreenFrame(const FloatRect& frame)
{
m_videoFullscreenFrame = frame;
if (RefPtr player = m_player)
player->setVideoFullscreenFrame(frame);
}
void HTMLMediaElement::setVideoFullscreenGravity(MediaPlayer::VideoGravity gravity)
{
m_videoFullscreenGravity = gravity;
if (RefPtr player = m_player)
player->setVideoFullscreenGravity(gravity);
}
#else
bool HTMLMediaElement::isVideoLayerInline()
{
return true;
};
#endif
bool HTMLMediaElement::hasClosedCaptions() const
{
if (m_player && m_player->hasClosedCaptions())
return true;
if (!m_textTracks)
return false;
for (unsigned i = 0; i < m_textTracks->length(); ++i) {
auto& track = *m_textTracks->item(i);
if (track.readinessState() == TextTrack::FailedToLoad)
continue;
if (track.kind() == TextTrack::Kind::Captions || track.kind() == TextTrack::Kind::Subtitles)
return true;
}
return false;
}
bool HTMLMediaElement::closedCaptionsVisible() const
{
return m_closedCaptionsVisible;
}
bool HTMLMediaElement::textTracksAreReady() const
{
// 4.8.10.12.1 Text track model
// ...
// The text tracks of a media element are ready if all the text tracks whose mode was not
// in the disabled state when the element's resource selection algorithm last started now
// have a text track readiness state of loaded or failed to load.
for (unsigned i = 0; i < m_textTracksWhenResourceSelectionBegan.size(); ++i) {
if (m_textTracksWhenResourceSelectionBegan[i]->readinessState() == TextTrack::Loading
|| m_textTracksWhenResourceSelectionBegan[i]->readinessState() == TextTrack::NotLoaded)
return false;
}
return true;
}
void HTMLMediaElement::textTrackReadyStateChanged(TextTrack* track)
{
if (track->readinessState() != TextTrack::Loading
&& track->mode() != TextTrack::Mode::Disabled) {
// The display trees exist as long as the track is active, in this case,
// and if the same track is loaded again (for example if the src attribute was changed),
// cues can be accumulated with the old ones, that's why they needs to be flushed
updateTextTrackDisplay();
}
if (m_player && m_textTracksWhenResourceSelectionBegan.contains(track)) {
if (track->readinessState() != TextTrack::Loading)
setReadyState(m_player->readyState());
}
}
void HTMLMediaElement::configureTextTrackDisplay(TextTrackVisibilityCheckType checkType)
{
ALWAYS_LOG(LOGIDENTIFIER, checkType);
ASSERT(m_textTracks);
if (m_processingPreferenceChange)
return;
if (isSuspended() || isContextStopped())
return;
bool haveVisibleTextTrack = false;
for (unsigned i = 0; i < m_textTracks->length(); ++i) {
if (m_textTracks->item(i)->mode() == TextTrack::Mode::Showing) {
haveVisibleTextTrack = true;
break;
}
}
if (checkType == CheckTextTrackVisibility && m_haveVisibleTextTrack == haveVisibleTextTrack) {
updateActiveTextTrackCues(currentMediaTime());
return;
}
m_haveVisibleTextTrack = haveVisibleTextTrack;
m_closedCaptionsVisible = m_haveVisibleTextTrack;
if (!m_haveVisibleTextTrack)
return;
updateTextTrackDisplay();
}
void HTMLMediaElement::updateTextTrackDisplay()
{
if (ensureMediaControls())
m_mediaControlsHost->updateTextTrackContainer();
}
void HTMLMediaElement::updateTextTrackRepresentationImageIfNeeded()
{
if (ensureMediaControls())
m_mediaControlsHost->updateTextTrackRepresentationImageIfNeeded();
}
void HTMLMediaElement::setClosedCaptionsVisible(bool closedCaptionVisible)
{
ALWAYS_LOG(LOGIDENTIFIER, closedCaptionVisible);
m_closedCaptionsVisible = false;
if (!m_player || !hasClosedCaptions())
return;
m_closedCaptionsVisible = closedCaptionVisible;
RefPtr { m_player }->setClosedCaptionsVisible(closedCaptionVisible);
markCaptionAndSubtitleTracksAsUnconfigured(Immediately);
updateTextTrackDisplay();
}
#if ENABLE(MEDIA_STATISTICS)
unsigned HTMLMediaElement::webkitAudioDecodedByteCount() const
{
if (!m_player)
return 0;
return m_player->audioDecodedByteCount();
}
unsigned HTMLMediaElement::webkitVideoDecodedByteCount() const
{
if (!m_player)
return 0;
return m_player->videoDecodedByteCount();
}
#endif
void HTMLMediaElement::mediaCanStart(Document& document)
{
ASSERT_UNUSED(document, &document == &this->document());
ALWAYS_LOG(LOGIDENTIFIER, "waiting = ", m_isWaitingUntilMediaCanStart, ", paused = ", m_pausedInternal);
ASSERT(m_isWaitingUntilMediaCanStart || m_pausedInternal);
if (m_isWaitingUntilMediaCanStart) {
m_isWaitingUntilMediaCanStart = false;
selectMediaResource();
}
if (m_pausedInternal)
setPausedInternal(false);
}
bool HTMLMediaElement::isURLAttribute(const Attribute& attribute) const
{
return attribute.name() == srcAttr || HTMLElement::isURLAttribute(attribute);
}
void HTMLMediaElement::setShouldDelayLoadEvent(bool shouldDelay)
{
if (m_shouldDelayLoadEvent == shouldDelay)
return;
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_SETSHOULDDELAYLOADEVENT, shouldDelay);
m_shouldDelayLoadEvent = shouldDelay;
if (shouldDelay)
protectedDocument()->incrementLoadEventDelayCount();
else
protectedDocument()->decrementLoadEventDelayCount();
}
static String& sharedMediaCacheDirectory()
{
static NeverDestroyed<String> sharedMediaCacheDirectory;
return sharedMediaCacheDirectory;
}
void HTMLMediaElement::setMediaCacheDirectory(const String& path)
{
sharedMediaCacheDirectory() = path;
}
const String& HTMLMediaElement::mediaCacheDirectory()
{
return sharedMediaCacheDirectory();
}
HashSet<SecurityOriginData> HTMLMediaElement::originsInMediaCache(const String& path)
{
return MediaPlayer::originsInMediaCache(path);
}
void HTMLMediaElement::clearMediaCache(const String& path, WallTime modifiedSince)
{
MediaPlayer::clearMediaCache(path, modifiedSince);
}
void HTMLMediaElement::clearMediaCacheForOrigins(const String& path, const HashSet<SecurityOriginData>& origins)
{
MediaPlayer::clearMediaCacheForOrigins(path, origins);
}
void HTMLMediaElement::privateBrowsingStateDidChange(PAL::SessionID sessionID)
{
if (RefPtr player = m_player)
player->setPrivateBrowsingMode(sessionID.isEphemeral());
}
bool HTMLMediaElement::shouldForceControlsDisplay() const
{
if (isFullscreen() && videoUsesElementFullscreen())
return true;
// Always create controls for autoplay video that requires user gesture due to being in low power mode.
return isVideo() && autoplay() && (mediaSession().hasBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoDueToLowPowerMode) || mediaSession().hasBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoDueToAggressiveThermalMitigation));
}
void HTMLMediaElement::configureMediaControls()
{
bool requireControls = controls();
// Always create controls for video when fullscreen playback is required.
if (isVideo() && mediaSession().requiresFullscreenForVideoPlayback())
requireControls = true;
if (shouldForceControlsDisplay())
requireControls = true;
// Always create controls when in full screen mode.
if (isFullscreen() && videoUsesElementFullscreen())
requireControls = true;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (m_isPlayingToWirelessTarget)
requireControls = true;
#endif
if (!requireControls || !isConnected() || !inActiveDocument())
return;
ensureMediaControls();
}
void HTMLMediaElement::captionPreferencesChanged()
{
if (!isVideo())
return;
if (RefPtr mediaControlsHost = m_mediaControlsHost)
mediaControlsHost->updateCaptionDisplaySizes(MediaControlsHost::ForceUpdate::Yes);
if (RefPtr player = m_player)
player->tracksChanged();
if (!document().page())
return;
auto& captionPreferences = document().page()->group().ensureCaptionPreferences();
m_userPrefersTextDescriptions = captionPreferences.userPrefersTextDescriptions();
m_userPrefersExtendedDescriptions = m_userPrefersTextDescriptions && document().settings().extendedAudioDescriptionsEnabled();
CaptionUserPreferences::CaptionDisplayMode displayMode = captionPreferences.captionDisplayMode();
if (captionDisplayMode() == displayMode)
return;
m_captionDisplayMode = displayMode;
setClosedCaptionsVisible(captionDisplayMode() == CaptionUserPreferences::CaptionDisplayMode::AlwaysOn);
}
CaptionUserPreferences::CaptionDisplayMode HTMLMediaElement::captionDisplayMode()
{
if (!m_captionDisplayMode) {
if (document().page())
m_captionDisplayMode = document().page()->group().ensureCaptionPreferences().captionDisplayMode();
else
m_captionDisplayMode = CaptionUserPreferences::CaptionDisplayMode::Automatic;
}
return m_captionDisplayMode.value();
}
void HTMLMediaElement::markCaptionAndSubtitleTracksAsUnconfigured(ReconfigureMode mode)
{
if (!m_textTracks)
return;
INFO_LOG(LOGIDENTIFIER);
// Mark all tracks as not "configured" so that configureTextTracks()
// will reconsider which tracks to display in light of new user preferences
// (e.g. default tracks should not be displayed if the user has turned off
// captions and non-default tracks should be displayed based on language
// preferences if the user has turned captions on).
for (unsigned i = 0; i < m_textTracks->length(); ++i) {
auto& track = *m_textTracks->item(i);
auto kind = track.kind();
if (kind == TextTrack::Kind::Subtitles || kind == TextTrack::Kind::Captions)
track.setHasBeenConfigured(false);
}
m_processingPreferenceChange = true;
m_configureTextTracksTaskCancellationGroup.cancel();
if (mode == Immediately) {
Ref protectedThis { *this }; // configureTextTracks calls methods that can trigger arbitrary DOM mutations.
configureTextTracks();
}
else
scheduleConfigureTextTracks();
}
// Use WTF_IGNORES_THREAD_SAFETY_ANALYSIS because this function does conditional locking of m_audioSourceNode->processLock()
// which analysis doesn't support.
void HTMLMediaElement::createMediaPlayer() WTF_IGNORES_THREAD_SAFETY_ANALYSIS
{
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_CREATEMEDIAPLAYER);
invalidateWatchtimeTimer();
invalidateBufferingStopwatch();
mediaSession().setActive(true);
#if ENABLE(WEB_AUDIO)
RefPtr protectedAudioSourceNode = m_audioSourceNode.get();
std::optional<Locker<Lock>> audioSourceNodeLocker;
if (m_audioSourceNode)
audioSourceNodeLocker.emplace(m_audioSourceNode->processLock());
#endif
#if ENABLE(MEDIA_SOURCE)
detachMediaSource();
#endif
forgetResourceSpecificTracks();
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (m_isPlayingToWirelessTarget)
setIsPlayingToWirelessTarget(false);
#endif
m_networkErrorOccured = false;
m_lastContentTypeUsed.reset();
if (RefPtr player = std::exchange(m_player, { })) {
// The sniffer completionHandler would have taken a reference to the old MediaPlayer.
cancelSniffer();
player->invalidate();
}
m_player = MediaPlayer::create(*this);
RefPtr player = m_player;
player->setBufferingPolicy(m_bufferingPolicy);
player->setPreferredDynamicRangeMode(m_overrideDynamicRangeMode.value_or(preferredDynamicRangeMode(document().protectedView().get())));
player->setShouldDisableHDR(shouldDisableHDR());
player->setVolumeLocked(m_volumeLocked);
player->setMuted(effectiveMuted());
RefPtr page = document().page();
player->setPageIsVisible(!m_elementIsHidden);
player->setVisibleInViewport(isVisibleInViewport());
#if USE(AVFOUNDATION) && ENABLE(MEDIA_SOURCE)
player->setDecompressionSessionPreferences(document().settings().mediaSourcePrefersDecompressionSession(), document().settings().mediaSourceCanFallbackToDecompressionSession());
#endif
schedulePlaybackControlsManagerUpdate();
#if ENABLE(LEGACY_ENCRYPTED_MEDIA) && ENABLE(ENCRYPTED_MEDIA)
updateShouldContinueAfterNeedKey();
#endif
#if HAVE(SPATIAL_TRACKING_LABEL)
updateSpatialTrackingLabel();
#endif
#if ENABLE(WEB_AUDIO)
if (m_audioSourceNode) {
// When creating the player, make sure its AudioSourceProvider knows about the MediaElementAudioSourceNode.
if (audioSourceProvider())
audioSourceProvider()->setClient(m_audioSourceNode.get());
}
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (hasEnabledTargetAvailabilityListeners()) {
m_hasPlaybackTargetAvailabilityListeners = true;
mediaSession().setHasPlaybackTargetAvailabilityListeners(true);
enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior::Always); // Ensure the event listener gets at least one event.
}
#endif
updateSleepDisabling();
updateRenderer();
}
#if ENABLE(WEB_AUDIO)
void HTMLMediaElement::setAudioSourceNode(MediaElementAudioSourceNode* sourceNode)
{
m_audioSourceNode = sourceNode;
if (audioSourceProvider())
audioSourceProvider()->setClient(m_audioSourceNode.get());
}
// This may get called on the audio thread by MediaElementAudioSourceNode.
AudioSourceProvider* HTMLMediaElement::audioSourceProvider()
{
if (m_player)
return m_player->audioSourceProvider();
return nullptr;
}
#endif
const String& HTMLMediaElement::mediaGroup() const
{
return m_mediaGroup;
}
void HTMLMediaElement::setMediaGroup(const String& group)
{
if (m_mediaGroup == group)
return;
m_mediaGroup = group;
// When a media element is created with a mediagroup attribute, and when a media element's mediagroup
// attribute is set, changed, or removed, the user agent must run the following steps:
// 1. Let m [this] be the media element in question.
// 2. Let m have no current media controller, if it currently has one.
setController(nullptr);
// 3. If m's mediagroup attribute is being removed, then abort these steps.
if (group.isEmpty())
return;
// 4. If there is another media element whose Document is the same as m's Document (even if one or both
// of these elements are not actually in the Document),
// FIXME: It does not seem OK that this algorithm iterates the media elements in a random order.
protectedDocument()->forEachMediaElement([&] (HTMLMediaElement& element) {
// and which also has a mediagroup attribute, and whose mediagroup attribute has the same value as
// the new value of m's mediagroup attribute,
if (&element != this && !controller() && element.mediaGroup() == group) {
// then let controller be that media element's current media controller.
setController(element.controller());
}
});
// Otherwise, let controller be a newly created MediaController.
if (!controller())
setController(MediaController::create(protectedDocument()));
}
MediaController* HTMLMediaElement::controller() const
{
return m_mediaController.get();
}
void HTMLMediaElement::setController(RefPtr<MediaController>&& controller)
{
if (RefPtr mediaController = m_mediaController)
mediaController->removeMediaElement(*this);
m_mediaController = WTFMove(controller);
if (RefPtr mediaController = m_mediaController)
mediaController->addMediaElement(*this);
}
void HTMLMediaElement::setControllerForBindings(MediaController* controller)
{
// 4.8.10.11.2 Media controllers: controller attribute.
// On setting, it must first remove the element's mediagroup attribute, if any,
setMediaGroup({ });
// and then set the current media controller to the given value.
setController(controller);
}
void HTMLMediaElement::updateMediaController()
{
if (RefPtr mediaController = m_mediaController)
mediaController->reportControllerState();
}
bool HTMLMediaElement::isBlocked() const
{
// A media element is a blocked media element if its readyState attribute is in the
// HAVE_NOTHING state, the HAVE_METADATA state, or the HAVE_CURRENT_DATA state,
if (m_readyState <= HAVE_CURRENT_DATA)
return true;
// or if the element has paused for user interaction.
return pausedForUserInteraction();
}
bool HTMLMediaElement::isBlockedOnMediaController() const
{
if (!m_mediaController)
return false;
// A media element is blocked on its media controller if the MediaController is a blocked
// media controller,
if (m_mediaController->isBlocked())
return true;
// or if its media controller position is either before the media resource's earliest possible
// position relative to the MediaController's timeline or after the end of the media resource
// relative to the MediaController's timeline.
double mediaControllerPosition = m_mediaController->currentTime();
if (mediaControllerPosition < 0 || mediaControllerPosition > duration())
return true;
return false;
}
void HTMLMediaElement::prepareMediaFragmentURI()
{
MediaFragmentURIParser fragmentParser(m_currentSrc);
MediaTime dur = durationMediaTime();
MediaTime start = fragmentParser.startTime();
if (start.isValid() && start > MediaTime::zeroTime()) {
m_fragmentStartTime = start;
if (m_fragmentStartTime > dur)
m_fragmentStartTime = dur;
} else
m_fragmentStartTime = MediaTime::invalidTime();
MediaTime end = fragmentParser.endTime();
if (end.isValid() && end > MediaTime::zeroTime() && (!m_fragmentStartTime.isValid() || end > m_fragmentStartTime)) {
m_fragmentEndTime = end;
if (m_fragmentEndTime > dur)
m_fragmentEndTime = dur;
} else
m_fragmentEndTime = MediaTime::invalidTime();
if (m_fragmentStartTime.isValid() && m_readyState < HAVE_FUTURE_DATA)
prepareToPlay();
}
void HTMLMediaElement::applyMediaFragmentURI()
{
if (m_fragmentStartTime.isValid()) {
m_sentEndEvent = false;
seek(m_fragmentStartTime);
}
}
void HTMLMediaElement::updateSleepDisabling()
{
SleepType shouldDisableSleep = this->shouldDisableSleep();
if (shouldDisableSleep == SleepType::None && m_sleepDisabler)
m_sleepDisabler = nullptr;
else if (shouldDisableSleep != SleepType::None) {
auto type = shouldDisableSleep == SleepType::Display ? PAL::SleepDisabler::Type::Display : PAL::SleepDisabler::Type::System;
if (!m_sleepDisabler || m_sleepDisabler->type() != type)
m_sleepDisabler = makeUnique<SleepDisabler>("com.apple.WebCore: HTMLMediaElement playback"_s, type, document().pageID());
}
if (RefPtr player = m_player)
player->setShouldDisableSleep(shouldDisableSleep == SleepType::Display);
}
#if ENABLE(MEDIA_STREAM)
static inline bool isRemoteMediaStreamVideoTrack(const Ref<MediaStreamTrack>& item)
{
auto& track = item.get();
return track.privateTrack().type() == RealtimeMediaSource::Type::Video && !track.isCaptureTrack() && !track.isCanvas();
}
#endif
HTMLMediaElement::SleepType HTMLMediaElement::shouldDisableSleep() const
{
#if !PLATFORM(COCOA) && !PLATFORM(GTK) && !PLATFORM(WPE)
return SleepType::None;
#endif
if (m_sentEndEvent || !m_player || !m_player->timeIsProgressing() || loop())
return SleepType::None;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
// If the media is playing remotely, we can't know definitively whether it has audio or video tracks.
if (m_isPlayingToWirelessTarget)
return SleepType::System;
#endif
if (PlatformMediaSessionManager::singleton().processIsSuspended())
return SleepType::None;
bool shouldBeAbleToSleep = mediaType() != PlatformMediaSession::MediaType::VideoAudio;
#if ENABLE(MEDIA_STREAM)
// Remote media stream video tracks may have their corresponding audio tracks being played outside of the media element. Let's ensure to not IDLE the screen in that case.
// FIXME: We should check that audio is being/to be played. Ideally, we would come up with a media stream agnostic heuristisc.
shouldBeAbleToSleep = shouldBeAbleToSleep && !(m_mediaStreamSrcObject && m_mediaStreamSrcObject->hasMatchingTrack(isRemoteMediaStreamVideoTrack));
#endif
if (shouldBeAbleToSleep)
return SleepType::None;
#if HAVE(IDLE_SLEEP_STATE)
if (m_elementIsHidden)
return SleepType::System;
#endif
return SleepType::Display;
}
String HTMLMediaElement::mediaPlayerReferrer() const
{
RefPtr frame = document().frame();
if (!frame)
return String();
return SecurityPolicy::generateReferrerHeader(document().referrerPolicy(), m_currentSrc, frame->loader().outgoingReferrerURL(), OriginAccessPatternsForWebProcess::singleton());
}
String HTMLMediaElement::mediaPlayerUserAgent() const
{
RefPtr frame = document().frame();
if (!frame)
return String();
return frame->loader().userAgent(m_currentSrc);
}
static inline PlatformTextTrackData::TrackKind toPlatform(TextTrack::Kind kind)
{
switch (kind) {
case TextTrack::Kind::Captions:
return PlatformTextTrackData::TrackKind::Caption;
case TextTrack::Kind::Chapters:
return PlatformTextTrackData::TrackKind::Chapter;
case TextTrack::Kind::Descriptions:
return PlatformTextTrackData::TrackKind::Description;
case TextTrack::Kind::Forced:
return PlatformTextTrackData::TrackKind::Forced;
case TextTrack::Kind::Metadata:
return PlatformTextTrackData::TrackKind::MetaData;
case TextTrack::Kind::Subtitles:
return PlatformTextTrackData::TrackKind::Subtitle;
}
ASSERT_NOT_REACHED();
return PlatformTextTrackData::TrackKind::Caption;
}
static inline PlatformTextTrackData::TrackMode toPlatform(TextTrack::Mode mode)
{
switch (mode) {
case TextTrack::Mode::Disabled:
return PlatformTextTrackData::TrackMode::Disabled;
case TextTrack::Mode::Hidden:
return PlatformTextTrackData::TrackMode::Hidden;
case TextTrack::Mode::Showing:
return PlatformTextTrackData::TrackMode::Showing;
}
ASSERT_NOT_REACHED();
return PlatformTextTrackData::TrackMode::Disabled;
}
Vector<RefPtr<PlatformTextTrack>> HTMLMediaElement::outOfBandTrackSources()
{
Vector<RefPtr<PlatformTextTrack>> outOfBandTrackSources;
for (auto& trackElement : childrenOfType<HTMLTrackElement>(*this)) {
URL url = trackElement.getNonEmptyURLAttribute(srcAttr);
if (url.isEmpty())
continue;
if (!isAllowedToLoadMediaURL(*this, url, trackElement.isInUserAgentShadowTree()))
continue;
auto& track = trackElement.track();
auto kind = track.kind();
// FIXME: The switch statement below preserves existing behavior where we ignore chapters and metadata tracks.
// If we confirm this behavior is valuable, we should remove this comment. Otherwise, remove both comment and switch.
switch (kind) {
case TextTrack::Kind::Captions:
case TextTrack::Kind::Descriptions:
case TextTrack::Kind::Forced:
case TextTrack::Kind::Subtitles:
break;
case TextTrack::Kind::Chapters:
case TextTrack::Kind::Metadata:
continue;
}
outOfBandTrackSources.append(PlatformTextTrack::createOutOfBand(trackElement.label(), trackElement.srclang(), url.string(), toPlatform(track.mode()), toPlatform(kind), track.uniqueId(), trackElement.isDefault()));
}
return outOfBandTrackSources;
}
bool HTMLMediaElement::mediaPlayerIsFullscreen() const
{
return isFullscreen();
}
bool HTMLMediaElement::mediaPlayerIsFullscreenPermitted() const
{
return mediaSession().fullscreenPermitted();
}
bool HTMLMediaElement::mediaPlayerIsVideo() const
{
return isVideo();
}
LayoutRect HTMLMediaElement::mediaPlayerContentBoxRect() const
{
auto* renderer = this->renderer();
if (!renderer)
return { };
return renderer->enclosingBox().contentBoxRect();
}
float HTMLMediaElement::mediaPlayerContentsScale() const
{
if (auto page = document().page())
return page->pageScaleFactor() * page->deviceScaleFactor();
return 1;
}
bool HTMLMediaElement::mediaPlayerPlatformVolumeConfigurationRequired() const
{
return !m_volumeInitialized;
}
bool HTMLMediaElement::mediaPlayerIsLooping() const
{
return loop();
}
CachedResourceLoader* HTMLMediaElement::mediaPlayerCachedResourceLoader()
{
return &document().cachedResourceLoader();
}
Ref<PlatformMediaResourceLoader> HTMLMediaElement::mediaPlayerCreateResourceLoader()
{
auto destination = isVideo() ? FetchOptions::Destination::Video : FetchOptions::Destination::Audio;
Ref mediaResourceLoader = MediaResourceLoader::create(document(), *this, crossOrigin(), destination);
m_lastMediaResourceLoaderForTesting = mediaResourceLoader.get();
return mediaResourceLoader;
}
const MediaResourceLoader* HTMLMediaElement::lastMediaResourceLoaderForTesting() const
{
return m_lastMediaResourceLoaderForTesting.get();
}
bool HTMLMediaElement::mediaPlayerShouldUsePersistentCache() const
{
if (Page* page = document().page())
return !page->usesEphemeralSession() && !page->isResourceCachingDisabledByWebInspector();
return false;
}
const String& HTMLMediaElement::mediaPlayerMediaCacheDirectory() const
{
return mediaCacheDirectory();
}
String HTMLMediaElement::sourceApplicationIdentifier() const
{
if (RefPtr frame = document().frame()) {
if (NetworkingContext* networkingContext = frame->loader().networkingContext())
return networkingContext->sourceApplicationIdentifier();
}
return emptyString();
}
void HTMLMediaElement::setPreferredDynamicRangeMode(DynamicRangeMode mode)
{
if (!m_player || m_overrideDynamicRangeMode)
return;
Ref player = *m_player;
player->setPreferredDynamicRangeMode(mode);
player->setShouldDisableHDR(shouldDisableHDR());
}
void HTMLMediaElement::setOverridePreferredDynamicRangeMode(DynamicRangeMode mode)
{
m_overrideDynamicRangeMode = mode;
if (!m_player)
return;
Ref player = *m_player;
player->setPreferredDynamicRangeMode(mode);
player->setShouldDisableHDR(shouldDisableHDR());
}
Vector<String> HTMLMediaElement::mediaPlayerPreferredAudioCharacteristics() const
{
if (Page* page = document().page())
return page->group().ensureCaptionPreferences().preferredAudioCharacteristics();
return Vector<String>();
}
#if PLATFORM(IOS_FAMILY)
String HTMLMediaElement::mediaPlayerNetworkInterfaceName() const
{
return DeprecatedGlobalSettings::networkInterfaceName();
}
void HTMLMediaElement::mediaPlayerGetRawCookies(const URL& url, MediaPlayerClient::GetRawCookiesCallback&& completionHandler) const
{
RefPtr page = document().page();
if (!page) {
completionHandler({ });
return;
}
Vector<Cookie> cookies;
page->cookieJar().getRawCookies(document(), url, cookies);
completionHandler(WTFMove(cookies));
}
#endif
void HTMLMediaElement::mediaPlayerEngineFailedToLoad()
{
if (!m_player)
return;
if (m_player->networkState() == MediaPlayer::NetworkState::NetworkError)
m_networkErrorOccured = true;
if (RefPtr page = document().page())
page->diagnosticLoggingClient().logDiagnosticMessageWithValue(DiagnosticLoggingKeys::engineFailedToLoadKey(), m_player->engineDescription(), m_player->platformErrorCode(), 4, ShouldSample::No);
}
double HTMLMediaElement::mediaPlayerRequestedPlaybackRate() const
{
return potentiallyPlaying() ? requestedPlaybackRate() : 0;
}
const Vector<ContentType>& HTMLMediaElement::mediaContentTypesRequiringHardwareSupport() const
{
return document().settings().mediaContentTypesRequiringHardwareSupport();
}
bool HTMLMediaElement::mediaPlayerShouldCheckHardwareSupport() const
{
if (!document().settings().allowMediaContentTypesRequiringHardwareSupportAsFallback())
return true;
if (m_loadState == LoadingFromSourceElement && m_currentSourceNode && !m_nextChildNodeToConsider)
return false;
if (m_loadState == LoadingFromSrcAttr)
return false;
return true;
}
const std::optional<Vector<String>>& HTMLMediaElement::allowedMediaContainerTypes() const
{
return document().settings().allowedMediaContainerTypes();
}
const std::optional<Vector<String>>& HTMLMediaElement::allowedMediaCodecTypes() const
{
return document().settings().allowedMediaCodecTypes();
}
const std::optional<Vector<FourCC>>& HTMLMediaElement::allowedMediaVideoCodecIDs() const
{
return document().settings().allowedMediaVideoCodecIDs();
}
const std::optional<Vector<FourCC>>& HTMLMediaElement::allowedMediaAudioCodecIDs() const
{
return document().settings().allowedMediaAudioCodecIDs();
}
const std::optional<Vector<FourCC>>& HTMLMediaElement::allowedMediaCaptionFormatTypes() const
{
return document().settings().allowedMediaCaptionFormatTypes();
}
void HTMLMediaElement::mediaPlayerBufferedTimeRangesChanged()
{
if (!m_textTracks || m_readyState < HAVE_ENOUGH_DATA || m_bufferedTimeRangesChangedTaskCancellationGroup.hasPendingTask())
return;
auto duration = durationMediaTime();
if (!duration.isValid() || duration.toDouble() < 60.)
return;
auto logSiteIdentifier = LOGIDENTIFIER;
ALWAYS_LOG(logSiteIdentifier, "task scheduled");
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_bufferedTimeRangesChangedTaskCancellationGroup, [this, logSiteIdentifier] {
UNUSED_PARAM(logSiteIdentifier);
ALWAYS_LOG(logSiteIdentifier, "lambda(), task fired");
if (!m_player || !m_textTracks)
return;
for (unsigned i = 0; i < m_textTracks->length(); ++i) {
Ref track = *m_textTracks->item(i);
if (!track->shouldPurgeCuesFromUnbufferedRanges())
continue;
track->removeCuesNotInTimeRanges(
#if ENABLE(MEDIA_SOURCE)
m_mediaSource ? m_mediaSource->buffered() :
#endif
m_player->buffered());
}
});
}
bool HTMLMediaElement::mediaPlayerPrefersSandboxedParsing() const
{
return document().settings().preferSandboxedMediaParsing();
}
void HTMLMediaElement::removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::BehaviorRestrictions mask)
{
MediaElementSession::BehaviorRestrictions restrictionsToRemove = mask &
(MediaElementSession::RequireUserGestureForLoad
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
| MediaElementSession::RequireUserGestureToShowPlaybackTargetPicker
| MediaElementSession::RequireUserGestureToAutoplayToExternalDevice
#endif
| MediaElementSession::RequireUserGestureForVideoRateChange
| MediaElementSession::RequireUserGestureForAudioRateChange
| MediaElementSession::RequireUserGestureForFullscreen
| MediaElementSession::RequireUserGestureForVideoDueToLowPowerMode
| MediaElementSession::RequireUserGestureForVideoDueToAggressiveThermalMitigation
| MediaElementSession::InvisibleAutoplayNotPermitted
| MediaElementSession::RequireUserGestureToControlControlsManager);
m_removedBehaviorRestrictionsAfterFirstUserGesture = true;
mediaSession().removeBehaviorRestriction(restrictionsToRemove);
if (RefPtr mainFrameDocument = document().protectedMainFrameDocument())
mainFrameDocument->noteUserInteractionWithMediaElement();
else
LOG_ONCE(SiteIsolation, "Unable to fully perform HTMLMediaElement::removeBehaviorRestrictionsAfterFirstUserGesture() without access to the main frame document ");
}
void HTMLMediaElement::updateRateChangeRestrictions()
{
const auto& document = this->document();
if (!document.ownerElement() && document.isMediaDocument())
return;
RefPtr mainFrameDocument = document.protectedMainFrameDocument();
if (!mainFrameDocument) {
LOG_ONCE(SiteIsolation, "Unable to fully perform HTMLMediaElement::updateRateChangeRestrictions() without access to the main frame document ");
return;
}
if (mainFrameDocument->requiresUserGestureForVideoPlayback())
mediaSession().addBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoRateChange);
else
mediaSession().removeBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoRateChange);
if (mainFrameDocument->requiresUserGestureForAudioPlayback())
mediaSession().addBehaviorRestriction(MediaElementSession::RequireUserGestureForAudioRateChange);
else
mediaSession().removeBehaviorRestriction(MediaElementSession::RequireUserGestureForAudioRateChange);
}
RefPtr<VideoPlaybackQuality> HTMLMediaElement::getVideoPlaybackQuality() const
{
RefPtr domWindow = document().domWindow();
double timestamp = domWindow ? domWindow->nowTimestamp().milliseconds() : 0;
VideoPlaybackQualityMetrics currentVideoPlaybackQuality;
#if ENABLE(MEDIA_SOURCE)
currentVideoPlaybackQuality.totalVideoFrames = m_droppedVideoFrames;
currentVideoPlaybackQuality.droppedVideoFrames = m_droppedVideoFrames;
#endif
if (auto metrics = m_player ? m_player->videoPlaybackQualityMetrics() : std::nullopt)
currentVideoPlaybackQuality += *metrics;
return VideoPlaybackQuality::create(timestamp, currentVideoPlaybackQuality);
}
DOMWrapperWorld& HTMLMediaElement::ensureIsolatedWorld()
{
if (!m_isolatedWorld)
m_isolatedWorld = DOMWrapperWorld::create(Ref { commonVM() }, DOMWrapperWorld::Type::Internal, makeString("Media Controls ("_s, localName(), ')'));
return *m_isolatedWorld;
}
void HTMLMediaElement::updatePageScaleFactorJSProperty()
{
Page* page = document().page();
if (!page)
return;
setControllerJSProperty("pageScaleFactor"_s, JSC::jsNumber(page->pageScaleFactor()));
}
void HTMLMediaElement::updateUsesLTRUserInterfaceLayoutDirectionJSProperty()
{
Page* page = document().page();
if (!page)
return;
bool usesLTRUserInterfaceLayoutDirectionProperty = page->userInterfaceLayoutDirection() == UserInterfaceLayoutDirection::LTR;
setControllerJSProperty("usesLTRUserInterfaceLayoutDirection"_s, JSC::jsBoolean(usesLTRUserInterfaceLayoutDirectionProperty));
}
void HTMLMediaElement::setControllerJSProperty(ASCIILiteral propertyName, JSC::JSValue propertyValue)
{
setupAndCallJS([this, propertyName, propertyValue](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
EXCEPTION_ASSERT_UNUSED(scope, !scope.exception() || controllerValue.isNull());
if (controllerValue.isNull())
return false;
JSC::PutPropertySlot propertySlot(controllerValue);
auto* controllerObject = controllerValue.toObject(&lexicalGlobalObject);
if (!controllerObject)
return false;
scope.release();
controllerObject->methodTable()->put(controllerObject, &lexicalGlobalObject, JSC::Identifier::fromString(vm, propertyName), propertyValue, propertySlot);
return true;
});
}
bool HTMLMediaElement::ensureMediaControls()
{
if (m_controlsState == ControlsState::Ready)
return true;
auto mediaControlsScripts = RenderTheme::singleton().mediaControlsScripts();
if (mediaControlsScripts.isEmpty() || isSuspended())
return false;
INFO_LOG(LOGIDENTIFIER);
ControlsState oldControlsState = m_controlsState;
m_controlsState = ControlsState::Initializing;
auto controlsReady = false;
if (oldControlsState == ControlsState::None) {
controlsReady = setupAndCallJS([this, mediaControlsScripts = WTFMove(mediaControlsScripts)](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController& scriptController, DOMWrapperWorld& world) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
for (auto& mediaControlsScript : mediaControlsScripts) {
if (mediaControlsScript.isEmpty())
continue;
scriptController.evaluateInWorldIgnoringException(ScriptSourceCode(mediaControlsScript, JSC::SourceTaintedOrigin::Untainted), world);
RETURN_IF_EXCEPTION(scope, false);
}
// The media controls script must provide a method with the following details.
// Name: createControls
// Parameters:
// 1. The ShadowRoot element that will hold the controls.
// 2. This object (and HTMLMediaElement).
// 3. The MediaControlsHost object.
// Return value:
// A reference to the created media controller instance.
auto functionValue = globalObject.get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "createControls"_s));
if (functionValue.isUndefinedOrNull())
return false;
if (!m_mediaControlsHost)
m_mediaControlsHost = MediaControlsHost::create(*this);
auto mediaJSWrapper = toJS(&lexicalGlobalObject, &globalObject, *this);
auto mediaControlsHostJSWrapper = toJS(&lexicalGlobalObject, &globalObject, *m_mediaControlsHost.copyRef());
JSC::MarkedArgumentBuffer argList;
argList.append(toJS(&lexicalGlobalObject, &globalObject, Ref { ensureUserAgentShadowRoot() }));
argList.append(mediaJSWrapper);
argList.append(mediaControlsHostJSWrapper);
ASSERT(!argList.hasOverflowed());
auto* function = functionValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto callData = JSC::getCallData(function);
if (callData.type == JSC::CallData::Type::None)
return false;
auto controllerValue = JSC::call(&lexicalGlobalObject, function, callData, &globalObject, argList);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = JSC::jsDynamicCast<JSC::JSObject*>(controllerValue);
if (!controllerObject)
return false;
// Connect the Media, MediaControllerHost, and Controller so the GC knows about their relationship
auto* mediaJSWrapperObject = mediaJSWrapper.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto controlsHost = JSC::Identifier::fromString(vm, "controlsHost"_s);
ASSERT(!mediaJSWrapperObject->hasProperty(&lexicalGlobalObject, controlsHost));
mediaJSWrapperObject->putDirect(vm, controlsHost, mediaControlsHostJSWrapper, JSC::PropertyAttribute::DontDelete | JSC::PropertyAttribute::DontEnum | JSC::PropertyAttribute::ReadOnly);
auto* mediaControlsHostJSWrapperObject = JSC::jsDynamicCast<JSC::JSObject*>(mediaControlsHostJSWrapper);
if (!mediaControlsHostJSWrapperObject)
return false;
auto controller = builtinNames(vm).controllerPublicName();
ASSERT(!controllerObject->hasProperty(&lexicalGlobalObject, controller));
mediaControlsHostJSWrapperObject->putDirect(vm, controller, controllerValue, JSC::PropertyAttribute::DontDelete | JSC::PropertyAttribute::DontEnum | JSC::PropertyAttribute::ReadOnly);
if (m_mediaControlsDependOnPageScaleFactor)
updatePageScaleFactorJSProperty();
RETURN_IF_EXCEPTION(scope, false);
updateUsesLTRUserInterfaceLayoutDirectionJSProperty();
RETURN_IF_EXCEPTION(scope, false);
return true;
});
} else if (oldControlsState == ControlsState::PartiallyDeinitialized) {
controlsReady = setupAndCallJS([this](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = controllerValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto functionValue = controllerObject->get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "reinitialize"_s));
if (UNLIKELY(scope.exception()) || functionValue.isUndefinedOrNull())
return false;
if (!m_mediaControlsHost)
m_mediaControlsHost = MediaControlsHost::create(*this);
auto mediaJSWrapper = toJS(&lexicalGlobalObject, &globalObject, *this);
auto mediaControlsHostJSWrapper = toJS(&lexicalGlobalObject, &globalObject, *m_mediaControlsHost.copyRef());
JSC::MarkedArgumentBuffer argList;
argList.append(toJS(&lexicalGlobalObject, &globalObject, Ref { ensureUserAgentShadowRoot() }));
argList.append(mediaJSWrapper);
argList.append(mediaControlsHostJSWrapper);
ASSERT(!argList.hasOverflowed());
auto* function = functionValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto callData = JSC::getCallData(function);
if (callData.type == JSC::CallData::Type::None)
return false;
auto resultValue = JSC::call(&lexicalGlobalObject, function, callData, controllerObject, argList);
RETURN_IF_EXCEPTION(scope, false);
return resultValue.toBoolean(&lexicalGlobalObject);
});
} else
ASSERT_NOT_REACHED();
m_controlsState = controlsReady ? ControlsState::Ready : oldControlsState;
return controlsReady;
}
void HTMLMediaElement::setMediaControlsDependOnPageScaleFactor(bool dependsOnPageScale)
{
INFO_LOG(LOGIDENTIFIER, dependsOnPageScale);
if (document().settings().mediaControlsScaleWithPageZoom() || (is<HTMLAudioElement>(*this) && document().settings().audioControlsScaleWithPageZoom())) {
INFO_LOG(LOGIDENTIFIER, "forced to false by Settings value");
m_mediaControlsDependOnPageScaleFactor = false;
return;
}
m_mediaControlsDependOnPageScaleFactor = dependsOnPageScale;
}
void HTMLMediaElement::pageScaleFactorChanged()
{
if (m_mediaControlsDependOnPageScaleFactor) {
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
updatePageScaleFactorJSProperty();
});
}
}
void HTMLMediaElement::userInterfaceLayoutDirectionChanged()
{
updateUsesLTRUserInterfaceLayoutDirectionJSProperty();
}
String HTMLMediaElement::getCurrentMediaControlsStatus()
{
ensureMediaControls();
String status;
setupAndCallJS([this, &status](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = controllerValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto functionValue = controllerObject->get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "getCurrentControlsStatus"_s));
if (UNLIKELY(scope.exception()) || functionValue.isUndefinedOrNull())
return false;
auto* function = functionValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto callData = JSC::getCallData(function);
JSC::MarkedArgumentBuffer argList;
ASSERT(!argList.hasOverflowed());
if (callData.type == JSC::CallData::Type::None)
return false;
auto outputValue = JSC::call(&lexicalGlobalObject, function, callData, controllerObject, argList);
RETURN_IF_EXCEPTION(scope, false);
status = outputValue.getString(&lexicalGlobalObject);
return true;
});
return status;
}
void HTMLMediaElement::setMediaControlsMaximumRightContainerButtonCountOverride(size_t count)
{
setControllerJSProperty("maximumRightContainerButtonCountOverride"_s, JSC::jsNumber(count));
}
void HTMLMediaElement::setMediaControlsHidePlaybackRates(bool hidePlaybackRates)
{
setControllerJSProperty("hidePlaybackRates"_s, JSC::jsBoolean(hidePlaybackRates));
}
unsigned long long HTMLMediaElement::fileSize() const
{
if (m_player)
return m_player->fileSize();
return 0;
}
PlatformMediaSession::MediaType HTMLMediaElement::mediaType() const
{
if (m_player && m_readyState >= HAVE_METADATA) {
auto hasVideo = this->hasVideo();
if (hasVideo && canProduceAudio())
return PlatformMediaSession::MediaType::VideoAudio;
return hasVideo ? PlatformMediaSession::MediaType::Video : PlatformMediaSession::MediaType::Audio;
}
return presentationType();
}
PlatformMediaSession::MediaType HTMLMediaElement::presentationType() const
{
if (hasTagName(HTMLNames::videoTag))
return muted() ? PlatformMediaSession::MediaType::Video : PlatformMediaSession::MediaType::VideoAudio;
return PlatformMediaSession::MediaType::Audio;
}
PlatformMediaSession::DisplayType HTMLMediaElement::displayType() const
{
if (m_videoFullscreenMode == VideoFullscreenModeStandard)
return PlatformMediaSession::Fullscreen;
if (m_videoFullscreenMode & VideoFullscreenModePictureInPicture)
return PlatformMediaSession::Optimized;
if (m_videoFullscreenMode == VideoFullscreenModeNone)
return PlatformMediaSession::Normal;
ASSERT_NOT_REACHED();
return PlatformMediaSession::Normal;
}
bool HTMLMediaElement::canProduceAudio() const
{
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
// Because the remote target could unmute playback without notifying us, we must assume
// that we may be playing audio.
if (m_isPlayingToWirelessTarget)
return true;
#endif
if (isSuspended())
return false;
if (!volume())
return false;
// For GStreamer ports the semantics of IsPlayingAudio slightly differ from Apple ports. The
// webkit_web_view_is_playing_audio() API is expected to return true if a page is producing
// audio even though it might be muted.
#if !USE(GSTREAMER)
if (muted())
return false;
#endif
if (m_player && m_readyState >= HAVE_METADATA)
return hasAudio();
return hasEverHadAudio();
}
bool HTMLMediaElement::isSuspended() const
{
ASSERT(Node::scriptExecutionContext() == ActiveDOMObject::scriptExecutionContext());
return document().activeDOMObjectsAreSuspended() || document().activeDOMObjectsAreStopped();
}
void HTMLMediaElement::suspendPlayback()
{
ALWAYS_LOG(LOGIDENTIFIER, "paused = ", paused());
if (!paused())
pauseInternal();
}
void HTMLMediaElement::resumeAutoplaying()
{
ALWAYS_LOG(LOGIDENTIFIER, "paused = ", paused());
m_autoplaying = true;
if (canTransitionFromAutoplayToPlay())
play();
}
void HTMLMediaElement::mayResumePlayback(bool shouldResume)
{
ALWAYS_LOG(LOGIDENTIFIER, "paused = ", paused());
if (!ended() && paused() && shouldResume)
play();
}
String HTMLMediaElement::mediaSessionTitle() const
{
RefPtr page = document().page();
if (!page)
return emptyString();
if (page->usesEphemeralSession() && !document().settings().allowPrivacySensitiveOperationsInNonPersistentDataStores())
return emptyString();
auto title = String(attributeWithoutSynchronization(titleAttr)).trim(deprecatedIsSpaceOrNewline).simplifyWhiteSpace(deprecatedIsSpaceOrNewline);
if (!title.isEmpty())
return title;
title = document().title().trim(deprecatedIsSpaceOrNewline).simplifyWhiteSpace(deprecatedIsSpaceOrNewline);
if (!title.isEmpty())
return title;
auto domain = RegistrableDomain { m_currentSrc };
if (!domain.isEmpty())
title = domain.string();
return title;
}
void HTMLMediaElement::setCurrentSrc(const URL& src)
{
m_currentSrc = src;
m_currentIdentifier = MediaUniqueIdentifier::generate();
}
MediaUniqueIdentifier HTMLMediaElement::mediaUniqueIdentifier() const
{
return m_currentIdentifier;
}
void HTMLMediaElement::didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType command, const PlatformMediaSession::RemoteCommandArgument& argument)
{
ALWAYS_LOG(LOGIDENTIFIER, command);
UserGestureIndicator remoteControlUserGesture(IsProcessingUserGesture::Yes, &document());
const double defaultSkipAmount = 15;
switch (command) {
case PlatformMediaSession::RemoteControlCommandType::PlayCommand:
play();
break;
case PlatformMediaSession::RemoteControlCommandType::StopCommand:
case PlatformMediaSession::RemoteControlCommandType::PauseCommand:
pause();
break;
case PlatformMediaSession::RemoteControlCommandType::TogglePlayPauseCommand:
canPlay() ? play() : pause();
break;
case PlatformMediaSession::RemoteControlCommandType::BeginSeekingBackwardCommand:
beginScanning(Backward);
break;
case PlatformMediaSession::RemoteControlCommandType::BeginSeekingForwardCommand:
beginScanning(Forward);
break;
case PlatformMediaSession::RemoteControlCommandType::EndSeekingBackwardCommand:
case PlatformMediaSession::RemoteControlCommandType::EndSeekingForwardCommand:
endScanning();
break;
case PlatformMediaSession::RemoteControlCommandType::BeginScrubbingCommand:
beginScrubbing();
break;
case PlatformMediaSession::RemoteControlCommandType::EndScrubbingCommand:
endScrubbing();
break;
case PlatformMediaSession::RemoteControlCommandType::SkipForwardCommand: {
auto delta = argument.time ? argument.time.value() : defaultSkipAmount;
handleSeekToPlaybackPosition(std::min(currentTime() + delta, duration()));
break;
}
case PlatformMediaSession::RemoteControlCommandType::SkipBackwardCommand: {
auto delta = argument.time ? argument.time.value() : defaultSkipAmount;
handleSeekToPlaybackPosition(std::max(currentTime() - delta, 0.));
break;
}
case PlatformMediaSession::RemoteControlCommandType::SeekToPlaybackPositionCommand:
ASSERT(argument.time);
if (argument.time)
handleSeekToPlaybackPosition(argument.time.value());
break;
default:
{ } // Do nothing
}
}
bool HTMLMediaElement::supportsSeeking() const
{
return !document().quirks().needsSeekingSupportDisabled();
}
bool HTMLMediaElement::shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType type) const
{
if (type == PlatformMediaSession::InterruptionType::EnteringBackground) {
if (isPlayingToExternalTarget()) {
INFO_LOG(LOGIDENTIFIER, "returning true because isPlayingToExternalTarget() is true");
return true;
}
if (PlatformMediaSessionManager::singleton().isPlayingToAutomotiveHeadUnit()) {
INFO_LOG(LOGIDENTIFIER, "returning true because isPlayingToAutomotiveHeadUnit() is true");
return true;
}
#if ENABLE(VIDEO_PRESENTATION_MODE)
if (m_videoFullscreenMode == VideoFullscreenModePictureInPicture) {
INFO_LOG(LOGIDENTIFIER, "returning true, in PiP");
return true;
}
#endif
#if PLATFORM(VISION) && ENABLE(WEBXR)
if (RefPtr page = document().page()) {
if (page->hasActiveImmersiveSession()) {
INFO_LOG(LOGIDENTIFIER, "returning true due to active immersive session");
return true;
}
}
#endif
#if ENABLE(MEDIA_STREAM)
if (hasMediaStreamSrcObject() && mediaState().containsAny(MediaProducerMediaState::IsPlayingAudio) && document().mediaState().containsAny(MediaProducerMediaState::HasActiveAudioCaptureDevice)) {
INFO_LOG(LOGIDENTIFIER, "returning true because playing an audio MediaStreamTrack");
return true;
}
#endif
} else if (type == PlatformMediaSession::InterruptionType::SuspendedUnderLock) {
if (isPlayingToExternalTarget()) {
INFO_LOG(LOGIDENTIFIER, "returning true because isPlayingToExternalTarget() is true");
return true;
}
if (PlatformMediaSessionManager::singleton().isPlayingToAutomotiveHeadUnit()) {
INFO_LOG(LOGIDENTIFIER, "returning true because isPlayingToAutomotiveHeadUnit() is true");
return true;
}
#if ENABLE(MEDIA_STREAM)
if (hasMediaStreamSrcObject() && mediaState().containsAny(MediaProducerMediaState::IsPlayingAudio) && document().mediaState().containsAny(MediaProducerMediaState::HasActiveAudioCaptureDevice)) {
INFO_LOG(LOGIDENTIFIER, "returning true because playing an audio MediaStreamTrack");
return true;
}
#endif
}
return false;
}
bool HTMLMediaElement::processingUserGestureForMedia() const
{
return document().processingUserGestureForMedia();
}
void HTMLMediaElement::processIsSuspendedChanged()
{
updateSleepDisabling();
}
bool HTMLMediaElement::shouldOverridePauseDuringRouteChange() const
{
#if ENABLE(MEDIA_STREAM)
return hasMediaStreamSrcObject();
#else
return false;
#endif
}
void HTMLMediaElement::requestHostingContextID(Function<void(LayerHostingContextID)>&& completionHandler)
{
if (RefPtr player = m_player) {
player->requestHostingContextID(WTFMove(completionHandler));
return;
}
completionHandler({ });
}
LayerHostingContextID HTMLMediaElement::layerHostingContextID()
{
if (m_player)
return m_player->hostingContextID();
return { };
}
FloatSize HTMLMediaElement::naturalSize()
{
if (m_player)
return m_player->naturalSize();
return { };
}
FloatSize HTMLMediaElement::videoLayerSize() const
{
return m_videoLayerSize;
}
void HTMLMediaElement::setVideoLayerSizeFenced(const FloatSize& size, WTF::MachSendRight&& fence)
{
if (m_videoLayerSize == size)
return;
m_videoLayerSize = size;
if (RefPtr player = m_player)
player->setVideoLayerSizeFenced(size, WTFMove(fence));
}
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
void HTMLMediaElement::scheduleUpdateMediaState()
{
if (m_updateMediaStateTaskCancellationGroup.hasPendingTask())
return;
auto logSiteIdentifier = LOGIDENTIFIER;
INFO_LOG(logSiteIdentifier, "task scheduled");
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_updateMediaStateTaskCancellationGroup, [this, logSiteIdentifier] {
UNUSED_PARAM(logSiteIdentifier);
INFO_LOG(logSiteIdentifier, "lambda(), task fired");
updateMediaState();
});
}
#endif
void HTMLMediaElement::updateMediaState()
{
MediaProducerMediaStateFlags state = mediaState();
if (m_mediaState == state)
return;
m_mediaState = state;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
mediaSession().mediaStateDidChange(m_mediaState);
#endif
protectedDocument()->updateIsPlayingMedia();
}
MediaProducerMediaStateFlags HTMLMediaElement::mediaState() const
{
MediaStateFlags state;
bool hasActiveVideo = isVideo() && hasVideo();
bool hasAudio = this->hasAudio();
if (isPlayingToExternalTarget())
state.add(MediaProducerMediaState::IsPlayingToExternalDevice);
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
if (m_hasPlaybackTargetAvailabilityListeners) {
state.add(MediaProducerMediaState::HasPlaybackTargetAvailabilityListener);
if (!mediaSession().wirelessVideoPlaybackDisabled())
state.add(MediaProducerMediaState::RequiresPlaybackTargetMonitoring);
}
bool requireUserGesture = m_mediaSession && mediaSession().hasBehaviorRestriction(MediaElementSession::RequireUserGestureToAutoplayToExternalDevice);
if (m_readyState >= HAVE_METADATA && !requireUserGesture && !m_failedToPlayToWirelessTarget)
state.add(MediaProducerMediaState::ExternalDeviceAutoPlayCandidate);
if (hasActiveVideo || hasAudio)
state.add(MediaProducerMediaState::HasAudioOrVideo);
if (hasActiveVideo && endedPlayback())
state.add(MediaProducerMediaState::DidPlayToEnd);
#else
UNUSED_VARIABLE(hasAudio);
#endif
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource && m_mediaSource->isStreamingContent())
state.add(MediaProducerMediaState::HasStreamingActivity);
#endif
if (!isPlaying())
return state;
if (canProduceAudio())
state.add(MediaProducerMediaState::IsPlayingAudio);
if (hasActiveVideo)
state.add(MediaProducerMediaState::IsPlayingVideo);
return state;
}
void HTMLMediaElement::handleAutoplayEvent(AutoplayEvent event)
{
if (RefPtr page = document().page()) {
bool hasAudio = this->hasAudio() && !muted() && volume();
bool wasPlaybackPrevented = m_autoplayEventPlaybackState == AutoplayEventPlaybackState::PreventedAutoplay;
bool hasMainContent = m_mediaSession && m_mediaSession->isMainContentForPurposesOfAutoplayEvents();
ALWAYS_LOG(LOGIDENTIFIER, "hasAudio = ", hasAudio, " wasPlaybackPrevented = ", wasPlaybackPrevented, " hasMainContent = ", hasMainContent);
OptionSet<AutoplayEventFlags> flags;
if (hasAudio)
flags.add(AutoplayEventFlags::HasAudio);
if (wasPlaybackPrevented)
flags.add(AutoplayEventFlags::PlaybackWasPrevented);
if (hasMainContent)
flags.add(AutoplayEventFlags::MediaIsMainContent);
page->chrome().client().handleAutoplayEvent(event, flags);
}
}
void HTMLMediaElement::userDidInterfereWithAutoplay()
{
if (m_autoplayEventPlaybackState != AutoplayEventPlaybackState::StartedWithoutUserGesture)
return;
// Only consider interference in the first 10 seconds of automatic playback.
if (currentTime() - playbackStartedTime() > AutoplayInterferenceTimeThreshold)
return;
ALWAYS_LOG(LOGIDENTIFIER);
handleAutoplayEvent(AutoplayEvent::UserDidInterfereWithPlayback);
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::None);
}
void HTMLMediaElement::setAutoplayEventPlaybackState(AutoplayEventPlaybackState reason)
{
ALWAYS_LOG(LOGIDENTIFIER, reason);
m_autoplayEventPlaybackState = reason;
if (reason == AutoplayEventPlaybackState::PreventedAutoplay) {
dispatchPlayPauseEventsIfNeedsQuirks();
handleAutoplayEvent(AutoplayEvent::DidPreventMediaFromPlaying);
}
}
void HTMLMediaElement::visibilityAdjustmentStateDidChange()
{
auto currentValue = isInVisibilityAdjustmentSubtree();
if (m_cachedIsInVisibilityAdjustmentSubtree == currentValue)
return;
bool wasMuted = effectiveMuted();
m_cachedIsInVisibilityAdjustmentSubtree = currentValue;
bool muted = effectiveMuted();
if (wasMuted == muted)
return;
RefPtr player = m_player;
if (!player)
return;
player->setMuted(muted);
}
void HTMLMediaElement::pageMutedStateDidChange()
{
if (RefPtr page = document().page()) {
// Propagate the new state to the platform player.
if (RefPtr player = m_player)
player->setMuted(effectiveMuted());
if (hasAudio() && !muted() && page->isAudioMuted())
userDidInterfereWithAutoplay();
}
}
double HTMLMediaElement::effectiveVolume() const
{
auto* page = document().page();
double volumeMultiplier = m_volumeMultiplierForSpeechSynthesis * (page ? page->mediaVolume() : 1);
if (m_mediaController)
volumeMultiplier *= m_mediaController->volume();
return m_volume * volumeMultiplier;
}
bool HTMLMediaElement::effectiveMuted() const
{
if (muted())
return true;
if (m_mediaController && m_mediaController->muted())
return true;
if (RefPtr page = document().page(); page && page->isAudioMuted())
return true;
if (m_cachedIsInVisibilityAdjustmentSubtree)
return true;
return false;
}
bool HTMLMediaElement::doesHaveAttribute(const AtomString& attribute, AtomString* value) const
{
QualifiedName attributeName(nullAtom(), attribute, nullAtom());
auto& elementValue = attributeWithoutSynchronization(attributeName);
if (elementValue.isNull())
return false;
if (attributeName == HTMLNames::x_itunes_inherit_uri_query_componentAttr && !document().settings().enableInheritURIQueryComponent())
return false;
if (value)
*value = elementValue;
return true;
}
void HTMLMediaElement::setBufferingPolicy(BufferingPolicy policy)
{
if (policy == m_bufferingPolicy)
return;
HTMLMEDIAELEMENT_RELEASE_LOG(HTMLMEDIAELEMENT_SETBUFFERINGPOLICY, static_cast<uint8_t>(policy));
m_bufferingPolicy = policy;
if (RefPtr player = m_player)
player->setBufferingPolicy(policy);
#if ENABLE(MEDIA_SOURCE)
if (RefPtr mediaSource = m_mediaSource; mediaSource && policy == BufferingPolicy::PurgeResources)
mediaSource->memoryPressure();
#endif
}
void HTMLMediaElement::purgeBufferedDataIfPossible()
{
ALWAYS_LOG(LOGIDENTIFIER);
bool isPausedOrMSE = [&] {
#if ENABLE(MEDIA_SOURCE)
if (m_mediaSource)
return true;
#endif
return paused();
}();
if (!isPausedOrMSE)
return;
if (!MemoryPressureHandler::singleton().isUnderMemoryPressure() && mediaSession().preferredBufferingPolicy() == BufferingPolicy::Default)
return;
if (isPlayingToExternalTarget()) {
ALWAYS_LOG(LOGIDENTIFIER, "early return because playing to wireless target");
return;
}
setBufferingPolicy(BufferingPolicy::PurgeResources);
}
bool HTMLMediaElement::canSaveMediaData() const
{
if (m_player)
return m_player->canSaveMediaData();
return false;
}
void HTMLMediaElement::allowsMediaDocumentInlinePlaybackChanged()
{
if (potentiallyPlaying() && mediaSession().requiresFullscreenForVideoPlayback() && !isFullscreen())
enterFullscreen();
}
bool HTMLMediaElement::isVideoTooSmallForInlinePlayback()
{
auto* renderer = dynamicDowncast<RenderVideo>(this->renderer());
if (!renderer)
return true;
IntRect videoBox = renderer->videoBox();
return videoBox.width() <= 1 || videoBox.height() <= 1;
}
void HTMLMediaElement::isVisibleInViewportChanged()
{
if (RefPtr player = m_player)
player->setVisibleInViewport(isVisibleInViewport());
queueTaskKeepingObjectAlive(*this, TaskSource::MediaElement, [this] {
if (isContextStopped())
return;
mediaSession().isVisibleInViewportChanged();
updateShouldAutoplay();
schedulePlaybackControlsManagerUpdate();
});
}
void HTMLMediaElement::scheduleUpdateShouldAutoplay()
{
if (m_updateShouldAutoplayTaskCancellationGroup.hasPendingTask())
return;
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_updateShouldAutoplayTaskCancellationGroup, [this] () {
updateShouldAutoplay();
});
}
void HTMLMediaElement::updateShouldAutoplay()
{
if (!autoplay())
return;
if (!mediaSession().hasBehaviorRestriction(MediaElementSession::InvisibleAutoplayNotPermitted) && !m_wasInterruptedForInvisibleAutoplay)
return;
bool canAutoplay = mediaSession().autoplayPermitted();
if (canAutoplay) {
if (m_wasInterruptedForInvisibleAutoplay) {
m_wasInterruptedForInvisibleAutoplay = false;
mediaSession().endInterruption(PlatformMediaSession::EndInterruptionFlags::MayResumePlaying);
return;
}
if (!isPlaying())
resumeAutoplaying();
return;
}
if (mediaSession().state() == PlatformMediaSession::State::Interrupted)
return;
if (m_wasInterruptedForInvisibleAutoplay) {
m_wasInterruptedForInvisibleAutoplay = false;
mediaSession().endInterruption(PlatformMediaSession::EndInterruptionFlags::NoFlags);
}
m_wasInterruptedForInvisibleAutoplay = true;
mediaSession().beginInterruption(PlatformMediaSession::InterruptionType::InvisibleAutoplay);
}
void HTMLMediaElement::updateShouldPlay()
{
if (!paused() && !mediaSession().playbackStateChangePermitted(MediaPlaybackState::Playing)) {
scheduleRejectPendingPlayPromises(DOMException::create(ExceptionCode::NotAllowedError));
pauseInternal();
setAutoplayEventPlaybackState(AutoplayEventPlaybackState::PreventedAutoplay);
} else if (canTransitionFromAutoplayToPlay())
play();
}
void HTMLMediaElement::resetPlaybackSessionState()
{
if (m_mediaSession)
m_mediaSession->resetPlaybackSessionState();
}
bool HTMLMediaElement::isVisibleInViewport() const
{
auto renderer = this->renderer();
return renderer && renderer->visibleInViewportState() == VisibleInViewportState::Yes;
}
void HTMLMediaElement::schedulePlaybackControlsManagerUpdate()
{
if (RefPtr<Page> page = document().page())
page->schedulePlaybackControlsManagerUpdate();
}
void HTMLMediaElement::playbackControlsManagerBehaviorRestrictionsTimerFired()
{
if (m_playbackControlsManagerBehaviorRestrictionsTaskCancellationGroup.hasPendingTask())
return;
if (!mediaSession().hasBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager))
return;
queueCancellableTaskKeepingObjectAlive(*this, TaskSource::MediaElement, m_playbackControlsManagerBehaviorRestrictionsTaskCancellationGroup, [this] () {
auto& mediaElementSession = mediaSession();
if (isPlaying() || mediaElementSession.state() == PlatformMediaSession::State::Autoplaying || mediaElementSession.state() == PlatformMediaSession::State::Playing)
return;
mediaElementSession.addBehaviorRestriction(MediaElementSession::RequirePlaybackToControlControlsManager);
schedulePlaybackControlsManagerUpdate();
});
}
bool HTMLMediaElement::shouldOverrideBackgroundLoadingRestriction() const
{
if (isPlayingToExternalTarget())
return true;
return m_videoFullscreenMode == VideoFullscreenModePictureInPicture;
}
void HTMLMediaElement::setFullscreenMode(VideoFullscreenMode mode)
{
INFO_LOG(LOGIDENTIFIER, "changed from ", fullscreenMode(), ", to ", mode);
#if ENABLE(VIDEO_PRESENTATION_MODE)
scheduleEvent(eventNames().webkitpresentationmodechangedEvent);
#endif
setPreparedToReturnVideoLayerToInline(mode != HTMLMediaElementEnums::VideoFullscreenModePictureInPicture);
#if ENABLE(VIDEO_PRESENTATION_MODE)
if (RefPtr player = this->player())
player->setVideoFullscreenMode(mode);
#endif
m_videoFullscreenMode = mode;
visibilityStateChanged();
schedulePlaybackControlsManagerUpdate();
computeAcceleratedRenderingStateAndUpdateMediaPlayer();
}
#if !RELEASE_LOG_DISABLED
WTFLogChannel& HTMLMediaElement::logChannel() const
{
return LogMedia;
}
#endif
bool HTMLMediaElement::willLog(WTFLogLevel level) const
{
#if !RELEASE_LOG_DISABLED
return m_logger->willLog(logChannel(), level);
#else
UNUSED_PARAM(level);
return false;
#endif
}
void HTMLMediaElement::applicationWillResignActive()
{
if (RefPtr player = m_player)
player->applicationWillResignActive();
}
void HTMLMediaElement::applicationDidBecomeActive()
{
if (RefPtr player = m_player)
player->applicationDidBecomeActive();
}
void HTMLMediaElement::setInActiveDocument(bool inActiveDocument)
{
if (inActiveDocument == m_inActiveDocument)
return;
m_inActiveDocument = inActiveDocument;
if (m_mediaSession)
m_mediaSession->inActiveDocumentChanged();
}
HTMLMediaElementEnums::BufferingPolicy HTMLMediaElement::bufferingPolicy() const
{
return m_bufferingPolicy;
}
MediaTime HTMLMediaElement::mediaSessionDuration() const
{
return loop() ? MediaTime::positiveInfiniteTime() : durationMediaTime();
}
bool HTMLMediaElement::hasMediaStreamSource() const
{
#if ENABLE(MEDIA_STREAM)
return hasMediaStreamSrcObject();
#else
return false;
#endif
}
#if ENABLE(MEDIA_STREAM)
void HTMLMediaElement::mediaStreamCaptureStarted()
{
if (canTransitionFromAutoplayToPlay())
play();
}
#endif
SecurityOriginData HTMLMediaElement::documentSecurityOrigin() const
{
return document().securityOrigin().data();
}
void HTMLMediaElement::setShowPosterFlag(bool flag)
{
if (m_showPoster == flag)
return;
ALWAYS_LOG(LOGIDENTIFIER, flag);
m_showPoster = flag;
invalidateStyleAndLayerComposition();
}
MediaElementSession& HTMLMediaElement::mediaSession() const
{
if (!m_mediaSession)
const_cast<HTMLMediaElement&>(*this).initializeMediaSession();
return *m_mediaSession;
}
void HTMLMediaElement::updateMediaPlayer(IntSize presentationSize, bool shouldMaintainAspectRatio)
{
INFO_LOG(LOGIDENTIFIER);
RefPtr player = m_player;
player->setPresentationSize(presentationSize);
visibilityStateChanged();
player->setVisibleInViewport(isVisibleInViewport());
if (document().quirks().needsVideoShouldMaintainAspectRatioQuirk())
shouldMaintainAspectRatio = true;
player->setShouldMaintainAspectRatio(shouldMaintainAspectRatio);
}
void HTMLMediaElement::mediaPlayerQueueTaskOnEventLoop(Function<void()>&& task)
{
protectedDocument()->checkedEventLoop()->queueTask(TaskSource::MediaElement, WTFMove(task));
}
template<typename T> void HTMLMediaElement::scheduleEventOn(T& target, Ref<Event>&& event)
{
target.queueCancellableTaskToDispatchEvent(target, TaskSource::MediaElement, m_asyncEventsCancellationGroup, WTFMove(event));
}
void HTMLMediaElement::setShowingStats(bool shouldShowStats)
{
if (m_showingStats == shouldShowStats)
return;
if (!ensureMediaControls())
return;
m_showingStats = setupAndCallJS([this, shouldShowStats](JSDOMGlobalObject& globalObject, JSC::JSGlobalObject& lexicalGlobalObject, ScriptController&, DOMWrapperWorld&) {
auto& vm = globalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
auto controllerValue = controllerJSValue(lexicalGlobalObject, globalObject, *this);
RETURN_IF_EXCEPTION(scope, false);
auto* controllerObject = controllerValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto functionValue = controllerObject->get(&lexicalGlobalObject, JSC::Identifier::fromString(vm, "setShowingStats"_s));
if (UNLIKELY(scope.exception()) || functionValue.isUndefinedOrNull())
return false;
auto* function = functionValue.toObject(&lexicalGlobalObject);
RETURN_IF_EXCEPTION(scope, false);
auto callData = JSC::getCallData(function);
if (callData.type == JSC::CallData::Type::None)
return false;
JSC::MarkedArgumentBuffer argList;
argList.append(JSC::jsBoolean(shouldShowStats));
ASSERT(!argList.hasOverflowed());
auto resultValue = JSC::call(&lexicalGlobalObject, function, callData, controllerObject, argList);
RETURN_IF_EXCEPTION(scope, false);
return resultValue.toBoolean(&lexicalGlobalObject);
});
}
bool HTMLMediaElement::shouldDisableHDR() const
{
return !screenSupportsHighDynamicRange(document().protectedView().get());
}
auto HTMLMediaElement::sourceType() const -> std::optional<SourceType>
{
if (hasMediaStreamSource())
return SourceType::MediaStream;
#if ENABLE(MEDIA_SOURCE)
if (hasManagedMediaSource())
return SourceType::ManagedMediaSource;
if (hasMediaSource())
return SourceType::MediaSource;
#endif
switch (movieLoadType()) {
case HTMLMediaElement::MovieLoadType::Unknown: return std::nullopt;
case HTMLMediaElement::MovieLoadType::Download: return SourceType::File;
case HTMLMediaElement::MovieLoadType::LiveStream: return SourceType::LiveStream;
case HTMLMediaElement::MovieLoadType::StoredStream: return SourceType::StoredStream;
case HTMLMediaElement::MovieLoadType::HttpLiveStream: return SourceType::HLS;
}
ASSERT_NOT_REACHED();
return std::nullopt;
}
String HTMLMediaElement::localizedSourceType() const
{
auto sourceType = this->sourceType();
if (!sourceType)
return { };
switch (*sourceType) {
case HTMLMediaElement::SourceType::File:
return WEB_UI_STRING_KEY("File", "File (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::HLS:
return WEB_UI_STRING_KEY("HLS", "HLS (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::MediaSource:
return WEB_UI_STRING_KEY("Media Source", "MediaSource (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::ManagedMediaSource:
return WEB_UI_STRING_KEY("Managed Media Source", "ManagedMediaSource (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::MediaStream:
return WEB_UI_STRING_KEY("Media Stream", "MediaStream (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::LiveStream:
return WEB_UI_STRING_KEY("Live Stream", "LiveStream (Media Element Source Type)", "Media Element Source Type");
case HTMLMediaElement::SourceType::StoredStream:
return WEB_UI_STRING_KEY("Stored Stream", "StoredStream (Media Element Source Type)", "Media Element Source Type");
}
ASSERT_NOT_REACHED();
return { };
}
bool HTMLMediaElement::isActiveNowPlayingSession() const
{
return m_mediaSession && m_mediaSession->isActiveNowPlayingSession();
}
void HTMLMediaElement::isActiveNowPlayingSessionChanged()
{
if (RefPtr page = protectedDocument()->protectedPage())
page->hasActiveNowPlayingSessionChanged();
}
ProcessID HTMLMediaElement::presentingApplicationPID() const
{
if (RefPtr page = protectedDocument()->protectedPage())
return page->presentingApplicationPID();
return { };
}
#if HAVE(SPATIAL_TRACKING_LABEL)
void HTMLMediaElement::updateSpatialTrackingLabel()
{
if (!m_player)
return;
m_player->setSpatialTrackingLabel(m_spatialTrackingLabel);
auto page = document().protectedPage();
if (!page)
return;
m_player->setDefaultSpatialTrackingLabel(page->defaultSpatialTrackingLabel());
}
const String& HTMLMediaElement::spatialTrackingLabel() const
{
return m_spatialTrackingLabel;
}
void HTMLMediaElement::setSpatialTrackingLabel(const String& spatialTrackingLabel)
{
if (m_spatialTrackingLabel == spatialTrackingLabel)
return;
m_spatialTrackingLabel = spatialTrackingLabel;
if (m_player)
m_player->setSpatialTrackingLabel(spatialTrackingLabel);
}
void HTMLMediaElement::defaultSpatialTrackingLabelChanged(const String& defaultSpatialTrackingLabel)
{
if (m_player)
m_player->setDefaultSpatialTrackingLabel(defaultSpatialTrackingLabel);
}
#endif
bool HTMLMediaElement::shouldLogWatchtimeEvent() const
{
// Autoplaying content should not produce watchtime diagnostics:
if (!m_mediaSession || m_mediaSession->hasBehaviorRestriction(MediaElementSession::RequireUserGestureForAudioRateChange))
return false;
return true;
}
void HTMLMediaElement::startWatchtimeTimer()
{
if (!m_watchtimeTimer) {
m_watchtimeTimer = makeUnique<PausableIntervalTimer>(WatchtimeTimerInterval, [weakThis = WeakPtr { *this }] {
if (RefPtr protectedThis = weakThis.get())
protectedThis->watchtimeTimerFired();
});
}
m_watchtimeTimer->start();
}
void HTMLMediaElement::pauseWatchtimeTimer()
{
if (m_watchtimeTimer)
m_watchtimeTimer->pause();
}
void HTMLMediaElement::invalidateWatchtimeTimer()
{
if (!m_watchtimeTimer)
return;
watchtimeTimerFired();
m_watchtimeTimer->stop();
m_watchtimeTimer = nullptr;
}
void HTMLMediaElement::logTextTrackDiagnostics(Ref<TextTrack> track, double numberOfSeconds)
{
if (track->mode() == TextTrack::Mode::Disabled)
return;
WebCore::DiagnosticLoggingClient::ValueDictionary textTrackDictionary;
textTrackDictionary.set(DiagnosticLoggingKeys::textTrackTypeKey(), static_cast<uint64_t>(track->trackType()));
textTrackDictionary.set(DiagnosticLoggingKeys::textTrackKindKey(), static_cast<uint64_t>(track->kind()));
textTrackDictionary.set(DiagnosticLoggingKeys::textTrackModeKey(), static_cast<uint64_t>(track->mode()));
textTrackDictionary.set(DiagnosticLoggingKeys::secondsKey(), numberOfSeconds);
document().protectedPage()->diagnosticLoggingClient().logDiagnosticMessageWithValueDictionary(DiagnosticLoggingKeys::mediaTextTrackWatchTimeKey(), "Media Watchtime Interval By Enabled Text Track"_s, textTrackDictionary, ShouldSample::Yes);
}
void HTMLMediaElement::watchtimeTimerFired()
{
if (!m_watchtimeTimer)
return;
if (!shouldLogWatchtimeEvent())
return;
auto page = document().protectedPage();
if (!page)
return;
// Bucket the watchtime seconds to the nearest 10s:
double numberOfSeconds = m_watchtimeTimer->secondsCompleted().seconds();
numberOfSeconds = round(numberOfSeconds / 10) * 10;
// First log watchtime messages per-source-type:
if (auto sourceType = this->sourceType()) {
WebCore::DiagnosticLoggingClient::ValueDictionary sourceTypeDictionary;
sourceTypeDictionary.set(DiagnosticLoggingKeys::sourceTypeKey(), static_cast<uint64_t>(*sourceType));
sourceTypeDictionary.set(DiagnosticLoggingKeys::secondsKey(), numberOfSeconds);
page->diagnosticLoggingClient().logDiagnosticMessageWithValueDictionary(DiagnosticLoggingKeys::mediaSourceTypeWatchTimeKey(), "Media Watchtime Interval By Source Type"_s, sourceTypeDictionary, ShouldSample::Yes);
}
// Then log watchtime messages per-video-codec-type:
[&] {
RefPtr videoTracks = this->videoTracks();
if (!videoTracks)
return;
RefPtr selectedVideoTrack = videoTracks->selectedItem();
if (!selectedVideoTrack)
return;
// Convert the codec string to a 4CC code representing the codec type, and log only the codec type
auto videoCodecString = selectedVideoTrack->configuration().codec();
if (videoCodecString.length() < 4)
return;
auto videoCodecType = FourCC::fromString(StringView(videoCodecString).substring(0, 4));
if (!videoCodecType)
return;
WebCore::DiagnosticLoggingClient::ValueDictionary videoCodecDictionary;
videoCodecDictionary.set(DiagnosticLoggingKeys::videoCodecKey(), static_cast<uint64_t>(videoCodecType->value));
videoCodecDictionary.set(DiagnosticLoggingKeys::secondsKey(), numberOfSeconds);
page->diagnosticLoggingClient().logDiagnosticMessageWithValueDictionary(DiagnosticLoggingKeys::mediaVideoCodecWatchTimeKey(), "Media Watchtime Interval By Video Codec"_s, videoCodecDictionary, ShouldSample::Yes);
}();
// Then log watchtime messages per-audio-codec-type:
[&] {
RefPtr audioTracks = this->audioTracks();
if (!audioTracks)
return;
RefPtr selectedAudioTrack = audioTracks->firstEnabled();
if (!selectedAudioTrack)
return;
// Convert the codec string to a 4CC code representing the codec type, and log only the codec type
auto audioCodecString = selectedAudioTrack->configuration().codec();
if (audioCodecString.length() < 4)
return;
auto audioCodecType = FourCC::fromString(StringView(audioCodecString).substring(0, 4));
if (!audioCodecType)
return;
WebCore::DiagnosticLoggingClient::ValueDictionary audioCodecDictionary;
audioCodecDictionary.set(DiagnosticLoggingKeys::audioCodecKey(), static_cast<uint64_t>(audioCodecType->value));
audioCodecDictionary.set(DiagnosticLoggingKeys::secondsKey(), numberOfSeconds);
page->diagnosticLoggingClient().logDiagnosticMessageWithValueDictionary(DiagnosticLoggingKeys::mediaAudioCodecWatchTimeKey(), "Media Watchtime Interval By Audio Codec"_s, audioCodecDictionary, ShouldSample::Yes);
}();
if (RefPtr textTracks = m_textTracks) {
for (unsigned i = 0; i < textTracks->length(); ++i)
logTextTrackDiagnostics(Ref { *textTracks->item(i) }, numberOfSeconds);
}
}
void HTMLMediaElement::startBufferingStopwatch()
{
if (!shouldLogWatchtimeEvent())
return;
// Do not log during the initial buffering period after playback is initiated,
// but before media data in advance of the current time has been loaded.
if (m_readyStateMaximum <= HAVE_CURRENT_DATA)
return;
m_bufferingStopwatch = Stopwatch::create();
m_bufferingStopwatch->start();
}
void HTMLMediaElement::invalidateBufferingStopwatch()
{
if (!m_bufferingStopwatch || !m_bufferingStopwatch->isActive())
return;
auto page = document().protectedPage();
if (!page)
return;
m_bufferingStopwatch->stop();
auto bufferingDuration = m_bufferingStopwatch->elapsedTime();
// Do not log when the source type is unknown (which should never happen).
auto sourceType = this->sourceType();
if (!sourceType)
return;
WebCore::DiagnosticLoggingClient::ValueDictionary bufferingDictionary;
bufferingDictionary.set(DiagnosticLoggingKeys::sourceTypeKey(), static_cast<uint64_t>(*sourceType));
bufferingDictionary.set(DiagnosticLoggingKeys::secondsKey(), bufferingDuration.seconds());
page->diagnosticLoggingClient().logDiagnosticMessageWithValueDictionary(DiagnosticLoggingKeys::mediaBufferingWatchTimeKey(), "Media Watchtime Buffering Event By Source Type"_s, bufferingDictionary, ShouldSample::Yes);
}
bool HTMLMediaElement::limitedMatroskaSupportEnabled() const
{
#if ENABLE(MEDIA_RECORDER_WEBM)
return document().quirks().needsLimitedMatroskaSupport() || document().settings().limitedMatroskaSupportEnabled();
#else
return false;
#endif
}
} // namespace WebCore
#endif // ENABLE(VIDEO)
|