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
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.impl.protocol.jabber;
import java.awt.*;
import java.beans.*;
import java.lang.reflect.*;
import java.util.*;
import java.util.List;
import net.java.sip.communicator.impl.protocol.jabber.extensions.colibri.*;
import net.java.sip.communicator.impl.protocol.jabber.extensions.jingle.*;
import net.java.sip.communicator.impl.protocol.jabber.extensions.jingle.ContentPacketExtension.SendersEnum;
import net.java.sip.communicator.impl.protocol.jabber.jinglesdp.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.service.protocol.media.*;
import net.java.sip.communicator.util.*;
import org.jitsi.service.libjitsi.*;
import org.jitsi.service.neomedia.*;
import org.jitsi.service.neomedia.device.*;
import org.jitsi.service.neomedia.format.*;
import org.jivesoftware.smackx.packet.*;
/**
* An XMPP specific extension of the generic media handler.
*
* @author Emil Ivov
* @author Lyubomir Marinov
* @author Hristo Terezov
* @author Boris Grozev
*/
public class CallPeerMediaHandlerJabberImpl
extends AbstractCallPeerMediaHandlerJabberGTalkImpl<CallPeerJabberImpl>
{
/**
* The <tt>Logger</tt> used by the <tt>CallPeerMediaHandlerJabberImpl</tt>
* class and its instances for logging output.
*/
private static final Logger logger
= Logger.getLogger(CallPeerMediaHandlerJabberImpl.class);
/**
* Determines whether a specific XMPP feature is supported by both a
* specific <tt>ScServiceDiscoveryManager</tt> (may be referred to as the
* local peer) and a specific <tt>DiscoverInfo</tt> (may be thought of as
* the remote peer).
*
* @param discoveryManager the <tt>ScServiceDiscoveryManager</tt> to be
* checked whether it includes the specified feature
* @param discoverInfo the <tt>DiscoveryInfo</tt> which is to be checked
* whether it contains the specified feature. If <tt>discoverInfo</tt> is
* <tt>null</tt>, it is considered to contain the specified feature.
* @param feature the feature to be determined whether it is supported by
* both the specified <tt>discoveryManager</tt> and the specified
* <tt>discoverInfo</tt>
* @return <tt>true</tt> if the specified <tt>feature</tt> is supported by
* both the specified <tt>discoveryManager</tt> and the specified
* <tt>discoverInfo</tt>; otherwise, <tt>false</tt>
*/
private static boolean isFeatureSupported(
ScServiceDiscoveryManager discoveryManager,
DiscoverInfo discoverInfo,
String feature)
{
return
discoveryManager.includesFeature(feature)
&& ((discoverInfo == null)
|| discoverInfo.containsFeature(feature));
}
/**
* The current description of the streams that we have going toward the
* remote side. We use {@link LinkedHashMap}s to make sure that we preserve
* the order of the individual content extensions.
*/
private final Map<String, ContentPacketExtension> localContentMap
= new LinkedHashMap<String, ContentPacketExtension>();
/**
* The <tt>QualityControl</tt> of this <tt>CallPeerMediaHandler</tt>.
*/
private final QualityControlWrapper qualityControls;
/**
* The current description of the streams that the remote side has with us.
* We use {@link LinkedHashMap}s to make sure that we preserve
* the order of the individual content extensions.
*/
private final Map<String, ContentPacketExtension> remoteContentMap
= new LinkedHashMap<String, ContentPacketExtension>();
/**
* Indicates whether the remote party has placed us on hold.
*/
private boolean remotelyOnHold = false;
/**
* Whether other party is able to change video quality settings.
* Normally its whether we have detected existence of imageattr in sdp.
*/
private boolean supportQualityControls = false;
/**
* The <tt>TransportManager</tt> implementation handling our address
* management.
*/
private TransportManagerJabberImpl transportManager;
/**
* The <tt>Object</tt> which is used for synchronization (e.g. <tt>wait</tt>
* and <tt>notify</tt>) related to {@link #transportManager}.
*/
private final Object transportManagerSyncRoot = new Object();
/**
* The ordered by preference array of the XML namespaces of the jingle
* transports that this peer supports. If it is non-null, it will be used
* instead of checking disco#info in order to select an appropriate
* transport manager.
*/
private String[] supportedTransports = null;
/**
* Object used to synchronize access to <tt>supportedTransports</tt>
*/
private final Object supportedTransportsSyncRoot = new Object();
/**
* Creates a new handler that will be managing media streams for
* <tt>peer</tt>.
*
* @param peer that <tt>CallPeerJabberImpl</tt> instance that we will be
* managing media for.
*/
public CallPeerMediaHandlerJabberImpl(CallPeerJabberImpl peer)
{
super(peer);
qualityControls = new QualityControlWrapper(peer);
}
/**
* Determines the direction that a stream, which has been placed on
* hold by the remote party, would need to go back to after being
* re-activated. If the stream is not currently on hold (i.e. it is still
* sending media), this method simply returns its current direction.
*
* @param stream the {@link MediaStreamTarget} whose post-hold direction
* we'd like to determine.
*
* @return the {@link MediaDirection} that we need to set on <tt>stream</tt>
* once it is reactivate.
*/
private MediaDirection calculatePostHoldDirection(MediaStream stream)
{
MediaDirection streamDirection = stream.getDirection();
if (streamDirection.allowsSending())
return streamDirection;
/*
* When calculating a direction we need to take into account 1) what
* direction the remote party had asked for before putting us on hold,
* 2) what the user preference is for the stream's media type, 3) our
* local hold status, 4) the direction supported by the device this
* stream is reading from.
*/
// 1. what the remote party originally told us (from our perspective)
ContentPacketExtension content = remoteContentMap.get(stream.getName());
MediaDirection postHoldDir
= JingleUtils.getDirection(content, !getPeer().isInitiator());
// 2. the user preference
MediaDevice device = stream.getDevice();
postHoldDir
= postHoldDir.and(
getDirectionUserPreference(device.getMediaType()));
// 3. our local hold status
if (isLocallyOnHold())
postHoldDir = postHoldDir.and(MediaDirection.SENDONLY);
// 4. the device direction
postHoldDir = postHoldDir.and(device.getDirection());
return postHoldDir;
}
/**
* Closes the <tt>CallPeerMediaHandler</tt>.
*/
@Override
public synchronized void close()
{
super.close();
OperationSetDesktopSharingClientJabberImpl client
= (OperationSetDesktopSharingClientJabberImpl)
getPeer().getProtocolProvider().getOperationSet(
OperationSetDesktopSharingClient.class);
if (client != null)
client.fireRemoteControlRevoked(getPeer());
}
/**
* Creates a {@link ContentPacketExtension}s of the streams for a
* specific <tt>MediaDevice</tt>.
*
* @param dev <tt>MediaDevice</tt>
* @return the {@link ContentPacketExtension}s of stream that this
* handler is prepared to initiate.
* @throws OperationFailedException if we fail to create the descriptions
* for reasons like problems with device interaction, allocating ports, etc.
*/
private ContentPacketExtension createContent(MediaDevice dev)
throws OperationFailedException
{
MediaType mediaType = dev.getMediaType();
//this is the direction to be used in the jingle session
MediaDirection direction = dev.getDirection();
CallPeerJabberImpl peer = getPeer();
/*
* In the case of RTP translation performed by the conference focus,
* the conference focus is not required to capture media.
*/
if (!(MediaType.VIDEO.equals(mediaType)
&& isRTPTranslationEnabled(mediaType)))
direction = direction.and(getDirectionUserPreference(mediaType));
/*
* Check if we need to announce sending on behalf of other peers
*/
CallJabberImpl call = peer.getCall();
if (call.isConferenceFocus())
{
for (CallPeerJabberImpl anotherPeer : call.getCallPeerList())
{
if ((anotherPeer != peer)
&& anotherPeer.getDirection(mediaType)
.allowsReceiving())
{
direction = direction.or(MediaDirection.SENDONLY);
break;
}
}
}
if (isLocallyOnHold())
direction = direction.and(MediaDirection.SENDONLY);
QualityPreset sendQualityPreset = null;
QualityPreset receiveQualityPreset = null;
if(qualityControls != null)
{
// the one we will send is the one the remote has announced as
// receive
sendQualityPreset = qualityControls.getRemoteReceivePreset();
// the one we want to receive is the one the remote can send
receiveQualityPreset = qualityControls.getRemoteSendMaxPreset();
}
if(direction != MediaDirection.INACTIVE)
{
ContentPacketExtension content
= createContentForOffer(
getLocallySupportedFormats(
dev,
sendQualityPreset,
receiveQualityPreset),
direction,
dev.getSupportedExtensions());
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
// DTLS-SRTP
setDtlsEncryptionOnContent(mediaType, content, null);
/*
* Neither SDES nor ZRTP is supported in telephony conferences
* utilizing the server-side technology Jitsi Videobridge yet.
*/
if (!call.getConference().isJitsiVideobridge())
{
// SDES
// It is important to set SDES before ZRTP in order to make
// GTALK application able to work with SDES.
setSDesEncryptionOnDescription(mediaType, description, null);
// ZRTP
setZrtpEncryptionOnDescription(mediaType, description, null);
}
return content;
}
return null;
}
/**
* Creates a {@link ContentPacketExtension} for a particular stream.
*
* @param mediaType <tt>MediaType</tt> of the content
* @return a {@link ContentPacketExtension}
* @throws OperationFailedException if we fail to create the descriptions
* for reasons like - problems with device interaction, allocating ports,
* etc.
*/
public ContentPacketExtension createContentForMedia(MediaType mediaType)
throws OperationFailedException
{
MediaDevice dev = getDefaultDevice(mediaType);
if(isDeviceActive(dev))
return createContent(dev);
return null;
}
/**
* Generates an Jingle {@link ContentPacketExtension} for the specified
* {@link MediaFormat} list, direction and RTP extensions taking account
* the local streaming preference for the corresponding media type.
*
* @param supportedFormats the list of <tt>MediaFormats</tt> that we'd
* like to advertise.
* @param direction the <tt>MediaDirection</tt> that we'd like to establish
* the stream in.
* @param supportedExtensions the list of <tt>RTPExtension</tt>s that we'd
* like to advertise in the <tt>MediaDescription</tt>.
*
* @return a newly created {@link ContentPacketExtension} representing
* streams that we'd be able to handle.
*/
private ContentPacketExtension createContentForOffer(
List<MediaFormat> supportedFormats,
MediaDirection direction,
List<RTPExtension> supportedExtensions)
{
ContentPacketExtension content
= JingleUtils.createDescription(
ContentPacketExtension.CreatorEnum.initiator,
supportedFormats.get(0).getMediaType().toString(),
JingleUtils.getSenders(direction, !getPeer().isInitiator()),
supportedFormats,
supportedExtensions,
getDynamicPayloadTypes(),
getRtpExtensionsRegistry());
this.localContentMap.put(content.getName(), content);
return content;
}
/**
* Creates a <tt>List</tt> containing the {@link ContentPacketExtension}s of
* the streams that this handler is prepared to initiate depending on
* available <tt>MediaDevice</tt>s and local on-hold and video transmission
* preferences.
*
* @return a {@link List} containing the {@link ContentPacketExtension}s of
* streams that this handler is prepared to initiate.
*
* @throws OperationFailedException if we fail to create the descriptions
* for reasons like problems with device interaction, allocating ports, etc.
*/
public List<ContentPacketExtension> createContentList()
throws OperationFailedException
{
// Describe the media.
List<ContentPacketExtension> mediaDescs
= new ArrayList<ContentPacketExtension>();
boolean jitsiVideobridge
= getPeer().getCall().getConference().isJitsiVideobridge();
for (MediaType mediaType : MediaType.values())
{
MediaDevice dev = getDefaultDevice(mediaType);
if (isDeviceActive(dev))
{
MediaDirection direction = dev.getDirection();
/*
* In the case of RTP translation performed by the conference
* focus, the conference focus is not required to capture media.
*/
if (!(MediaType.VIDEO.equals(mediaType)
&& isRTPTranslationEnabled(mediaType)))
{
direction
= direction.and(getDirectionUserPreference(mediaType));
}
if (isLocallyOnHold())
direction = direction.and(MediaDirection.SENDONLY);
/*
* If we're only able to receive, we don't have to offer it at
* all. For example, we have to offer audio and no video when we
* start an audio call.
*/
if (MediaDirection.RECVONLY.equals(direction))
direction = MediaDirection.INACTIVE;
if (direction != MediaDirection.INACTIVE)
{
ContentPacketExtension content
= createContentForOffer(
getLocallySupportedFormats(dev),
direction,
dev.getSupportedExtensions());
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
// DTLS-SRTP
setDtlsEncryptionOnContent(mediaType, content, null);
/*
* Neither SDES nor ZRTP is supported in telephony
* conferences utilizing the server-side technology Jitsi
* Videobridge yet.
*/
if (!jitsiVideobridge)
{
// SDES
// It is important to set SDES before ZRTP in order to
// make GTALK application able to work with SDES.
setSDesEncryptionOnDescription(
mediaType,
description,
null);
//ZRTP
setZrtpEncryptionOnDescription(
mediaType,
description,
null);
}
// we request a desktop sharing session so add the inputevt
// extension in the "video" content
if (description.getMedia().equals(
MediaType.VIDEO.toString())
&& getLocalInputEvtAware())
{
content.addChildExtension(
new InputEvtPacketExtension());
}
mediaDescs.add(content);
}
}
}
// Fail if no media is described (e.g. all devices are inactive).
if (mediaDescs.isEmpty())
{
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
"We couldn't find any active Audio/Video devices"
+ " and couldn't create a call",
OperationFailedException.GENERAL_ERROR,
null,
logger);
}
// Describe the transport(s).
return harvestCandidates(null, mediaDescs, null);
}
/**
* Creates a <tt>List</tt> containing the {@link ContentPacketExtension}s of
* the streams of a specific <tt>MediaType</tt> that this handler is
* prepared to initiate depending on available <tt>MediaDevice</tt>s and
* local on-hold and video transmission preferences.
*
* @param mediaType <tt>MediaType</tt> of the content
* @return a {@link List} containing the {@link ContentPacketExtension}s of
* streams that this handler is prepared to initiate.
*
* @throws OperationFailedException if we fail to create the descriptions
* for reasons like - problems with device interaction, allocating ports,
* etc.
*/
public List<ContentPacketExtension> createContentList(MediaType mediaType)
throws OperationFailedException
{
MediaDevice dev = getDefaultDevice(mediaType);
List<ContentPacketExtension> mediaDescs
= new ArrayList<ContentPacketExtension>();
if (isDeviceActive(dev))
{
ContentPacketExtension content = createContent(dev);
if (content != null)
mediaDescs.add(content);
}
// Fail if no media is described (e.g. all devices are inactive).
if (mediaDescs.isEmpty())
{
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
"We couldn't find any active Audio/Video devices and "
+ "couldn't create a call",
OperationFailedException.GENERAL_ERROR,
null,
logger);
}
// Describe the transport(s).
return harvestCandidates(null, mediaDescs, null);
}
/**
* Overrides to give access to the transport manager to send events
* about ICE state changes.
*
* @param property the name of the property of this
* <tt>PropertyChangeNotifier</tt> which had its value changed
* @param oldValue the value of the property with the specified name before
* the change
* @param newValue the value of the property with the specified name after
*/
@Override
protected void firePropertyChange(
String property,
Object oldValue, Object newValue)
{
super.firePropertyChange(property, oldValue, newValue);
}
/**
* Wraps up any ongoing candidate harvests and returns our response to the
* last offer we've received, so that the peer could use it to send a
* <tt>session-accept</tt>.
*
* @return the last generated list of {@link ContentPacketExtension}s that
* the call peer could use to send a <tt>session-accept</tt>.
*
* @throws OperationFailedException if we fail to configure the media stream
*/
public Iterable<ContentPacketExtension> generateSessionAccept()
throws OperationFailedException
{
TransportManagerJabberImpl transportManager = getTransportManager();
Iterable<ContentPacketExtension> sessAccept
= transportManager.wrapupCandidateHarvest();
CallPeerJabberImpl peer = getPeer();
//user answered an incoming call so we go through whatever content
//entries we are initializing and init their corresponding streams
// First parse content so we know how many streams and what type of
// content we have
Map<ContentPacketExtension,RtpDescriptionPacketExtension> contents
= new HashMap<ContentPacketExtension,RtpDescriptionPacketExtension>();
for(ContentPacketExtension ourContent : sessAccept)
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(ourContent);
contents.put(ourContent, description);
}
boolean masterStreamSet = false;
for(Map.Entry<ContentPacketExtension, RtpDescriptionPacketExtension> en
: contents.entrySet())
{
ContentPacketExtension ourContent = en.getKey();
RtpDescriptionPacketExtension description = en.getValue();
MediaType type = MediaType.parseString(description.getMedia());
// stream connector
StreamConnector connector
= transportManager.getStreamConnector(type);
//the device this stream would be reading from and writing to.
MediaDevice dev = getDefaultDevice(type);
if(!isDeviceActive(dev))
continue;
// stream target
MediaStreamTarget target = transportManager.getStreamTarget(type);
//stream direction
MediaDirection direction
= JingleUtils.getDirection(ourContent, !peer.isInitiator());
// if we answer with video, tell remote peer that video direction is
// sendrecv, and whether video device can capture/send
if (MediaType.VIDEO.equals(type)
&& (isLocalVideoTransmissionEnabled()
|| isRTPTranslationEnabled(type))
&& dev.getDirection().allowsSending())
{
direction = MediaDirection.SENDRECV;
ourContent.setSenders(ContentPacketExtension.SendersEnum.both);
}
//let's now see what was the format we announced as first and
//configure the stream with it.
String contentName = ourContent.getName();
ContentPacketExtension theirContent
= this.remoteContentMap.get(contentName);
RtpDescriptionPacketExtension theirDescription
= JingleUtils.getRtpDescription(theirContent);
MediaFormat format = null;
List<MediaFormat> localFormats = getLocallySupportedFormats(dev);
for(PayloadTypePacketExtension payload
: theirDescription.getPayloadTypes())
{
MediaFormat remoteFormat = JingleUtils.payloadTypeToMediaFormat(
payload, getDynamicPayloadTypes());
if(remoteFormat != null
&& (format = findMediaFormat(localFormats, remoteFormat))
!= null)
break;
}
if(format == null)
{
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
"No matching codec.",
OperationFailedException.ILLEGAL_ARGUMENT,
null,
logger);
}
//extract the extensions that we are advertising:
// check whether we will be exchanging any RTP extensions.
List<RTPExtension> rtpExtensions
= JingleUtils.extractRTPExtensions(
description,
this.getRtpExtensionsRegistry());
Map<String, String> adv = format.getAdvancedAttributes();
if(adv != null)
{
for(Map.Entry<String, String> f : adv.entrySet())
{
if(f.getKey().equals("imageattr"))
supportQualityControls = true;
}
}
boolean masterStream = false;
// if we have more than one stream, lets the audio be the master
if(!masterStreamSet)
{
if(contents.size() > 1)
{
if(type.equals(MediaType.AUDIO))
{
masterStream = true;
masterStreamSet = true;
}
}
else
{
masterStream = true;
masterStreamSet = true;
}
}
// create the corresponding stream...
MediaStream stream = initStream(contentName,
connector,
dev,
format,
target,
direction,
rtpExtensions,
masterStream);
long ourSsrc = stream.getLocalSourceID();
if (direction.allowsSending() && ourSsrc != -1)
{
description.setSsrc(Long.toString(ourSsrc));
addSourceExtension(description, ourSsrc);
}
}
return sessAccept;
}
/**
* Adds a <tt>SourcePacketExtension</tt> as a child element of
* <tt>description</tt>. See XEP-0339.
*
* @param description the <tt>RtpDescriptionPacketExtension</tt> to which
* a child element will be added.
* @param ssrc the SSRC for the <tt>SourcePacketExtension</tt> to use.
*/
private void addSourceExtension(RtpDescriptionPacketExtension description,
long ssrc)
{
MediaType type = MediaType.parseString(description.getMedia());
SourcePacketExtension sourcePacketExtension
= new SourcePacketExtension();
sourcePacketExtension.setSSRC(ssrc);
sourcePacketExtension.addChildExtension(
new ParameterPacketExtension("cname",
LibJitsi.getMediaService()
.getRtpCname()));
sourcePacketExtension.addChildExtension(
new ParameterPacketExtension("msid", getMsid(type)));
sourcePacketExtension.addChildExtension(
new ParameterPacketExtension("mslabel", getMsLabel()));
sourcePacketExtension.addChildExtension(
new ParameterPacketExtension("label", getLabel(type)));
description.addChildExtension(sourcePacketExtension);
}
/**
* Returns the local content of a specific content type (like audio or
* video).
*
* @param contentType content type name
* @return remote <tt>ContentPacketExtension</tt> or null if not found
*/
public ContentPacketExtension getLocalContent(String contentType)
{
for(String key : localContentMap.keySet())
{
ContentPacketExtension content = localContentMap.get(key);
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
if(description.getMedia().equals(contentType))
return content;
}
return null;
}
/**
* Returns a complete list of call currently known local content-s.
*
* @return a list of {@link ContentPacketExtension} <tt>null</tt> if not found
*/
public Iterable<ContentPacketExtension> getLocalContentList()
{
return localContentMap.values();
}
/**
* Returns the quality control for video calls if any.
*
* @return the implemented quality control.
*/
public QualityControl getQualityControl()
{
if(supportQualityControls)
{
return qualityControls;
}
else
{
// we have detected that its not supported and return null
// and control ui won't be visible
return null;
}
}
/**
* Get the remote content of a specific content type (like audio or video).
*
* @param contentType content type name
* @return remote <tt>ContentPacketExtension</tt> or null if not found
*/
public ContentPacketExtension getRemoteContent(String contentType)
{
for(String key : remoteContentMap.keySet())
{
ContentPacketExtension content = remoteContentMap.get(key);
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
if(description.getMedia().equals(contentType))
return content;
}
return null;
}
/**
* {@inheritDoc}
*
* In the case of a telephony conference organized by the local peer/user
* via the Jitsi Videobridge server-side technology, returns an SSRC
* reported by the server as received on the channel allocated by the local
* peer/user for the purposes of communicating with the <tt>CallPeer</tt>
* associated with this instance.
*/
@Override
public long getRemoteSSRC(MediaType mediaType)
{
int[] ssrcs = getRemoteSSRCs(mediaType);
/*
* A peer (regardless of whether it is local or remote) may send
* multiple RTP streams at any time. In such a case, it is not clear
* which one of their SSRCs is to be returned. Anyway, the super says
* that the returned is the last known. We will presume that the last
* known in the list reported by the Jitsi Videobridge server is the
* last.
*/
if (ssrcs.length != 0)
return 0xFFFFFFFFL & ssrcs[ssrcs.length - 1];
/*
* XXX In the case of Jitsi Videobridge, the super implementation of
* getRemoteSSRC(MediaType) cannot be trusted because there is a single
* VideoMediaStream with multiple ReceiveStreams.
*/
return
getPeer().isJitsiVideobridge()
? SSRC_UNKNOWN
: super.getRemoteSSRC(mediaType);
}
/**
* Gets the SSRCs of RTP streams with a specific <tt>MediaType</tt> known to
* be received by a <tt>MediaStream</tt> associated with this instance.
* <p>
* <b>Warning</b>: The method may return only one of the many possible
* remote SSRCs in the case of no utilization of the Jitsi Videobridge
* server-side technology because the super implementation does not
* currently provide support for keeping track of multiple remote SSRCs.
* </p>
*
* @param mediaType the <tt>MediaType</tt> of the RTP streams the SSRCs of
* which are to be returned
* @return an array of <tt>int</tt> values which represent the SSRCs of RTP
* streams with the specified <tt>mediaType</tt> known to be received by a
* <tt>MediaStream</tt> associated with this instance
*/
private int[] getRemoteSSRCs(MediaType mediaType)
{
/*
* If the Jitsi Videobridge server-side technology is utilized, a single
* MediaStream (per MediaType) is shared among the participating
* CallPeers and, consequently, the remote SSRCs cannot be associated
* with the CallPeers from which they are actually being sent. That's
* why the server will report them to the conference focus.
*/
ColibriConferenceIQ.Channel channel = getColibriChannel(mediaType);
if (channel != null)
return channel.getSSRCs();
/*
* XXX The fallback to the super implementation that follows may lead to
* unexpected behavior due to the lack of ability to keep track of
* multiple remote SSRCs.
*/
long ssrc = super.getRemoteSSRC(mediaType);
return
(ssrc == SSRC_UNKNOWN)
? ColibriConferenceIQ.NO_SSRCS
: new int[] { (int) ssrc };
}
/**
* Gets the <tt>TransportManager</tt> implementation handling our address
* management.
*
* TODO: this method can and should be simplified.
*
* @return the <tt>TransportManager</tt> implementation handling our address
* management
* @see CallPeerMediaHandler#getTransportManager()
*/
@Override
protected synchronized TransportManagerJabberImpl getTransportManager()
{
if (transportManager == null)
{
CallPeerJabberImpl peer = getPeer();
if (peer.isInitiator())
{
synchronized(transportManagerSyncRoot)
{
try
{
transportManagerSyncRoot.wait(5000);
}
catch(InterruptedException e)
{
}
}
if(transportManager == null)
{
throw new IllegalStateException(
"The initiator is expected to specify the transport"
+ " in their offer.");
}
else
return transportManager;
}
else
{
ProtocolProviderServiceJabberImpl protocolProvider
= peer.getProtocolProvider();
ScServiceDiscoveryManager discoveryManager
= protocolProvider.getDiscoveryManager();
DiscoverInfo peerDiscoverInfo = peer.getDiscoveryInfo();
/*
* If this.supportedTransports has been explicitly set, we use
* it to select the transport manager -- we use the first
* transport in the list which we recognize (e.g. the first
* that is either ice or raw-udp
*/
synchronized (supportedTransportsSyncRoot)
{
if (supportedTransports != null
&& supportedTransports.length > 0)
{
for (int i = 0; i < supportedTransports.length; i++)
{
if (ProtocolProviderServiceJabberImpl.
URN_XMPP_JINGLE_ICE_UDP_1.
equals(supportedTransports[i]))
{
transportManager
= new IceUdpTransportManager(peer);
break;
}
else if (ProtocolProviderServiceJabberImpl.
URN_XMPP_JINGLE_RAW_UDP_0.
equals(supportedTransports[i]))
{
transportManager
= new RawUdpTransportManager(peer);
break;
}
}
if (transportManager == null)
{
logger.warn(
"Could not find a supported"
+ " TransportManager in"
+ " supportedTransports. Will try to"
+ " select one based on disco#info.");
}
}
}
if (transportManager == null)
{
/*
* The list of possible transports ordered by decreasing
* preference.
*/
String[] transports
= new String[]
{
ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_ICE_UDP_1,
ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_RAW_UDP_0
};
/*
* If Jitsi Videobridge is to be employed, pick up a Jingle
* transport supported by it.
*/
if (peer.isJitsiVideobridge())
{
CallJabberImpl call = peer.getCall();
if (call != null)
{
String jitsiVideobridge
= peer.getCall().getJitsiVideobridge();
/*
* Jitsi Videobridge supports the Jingle Raw UDP
* transport from its inception. But that is not the
* case with the Jingle ICE-UDP transport.
*/
if ((jitsiVideobridge != null)
&& !protocolProvider.isFeatureSupported(
jitsiVideobridge,
ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_ICE_UDP_1))
{
for (int i = transports.length - 1; i >= 0; i--)
{
if (ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_ICE_UDP_1
.equals(transports[i]))
{
transports[i] = null;
}
}
}
}
}
/*
* Select the first transport from the list of possible
* transports ordered by decreasing preference which is
* supported by the local and the remote peers.
*/
for (String transport : transports)
{
if (transport == null)
continue;
if (isFeatureSupported(
discoveryManager,
peerDiscoverInfo,
transport))
{
if (ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_ICE_UDP_1
.equals(transport))
{
transportManager
= new IceUdpTransportManager(peer);
}
else if (ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_RAW_UDP_0
.equals(transport))
{
transportManager
= new RawUdpTransportManager(peer);
}
if (transportManager != null)
break;
}
}
if ((transportManager == null) && logger.isDebugEnabled())
{
logger.debug(
"No known Jingle transport supported by Jabber"
+ " call peer " + peer);
}
}
}
}
return transportManager;
}
/**
* {@inheritDoc}
*
* @see CallPeerMediaHandler#queryTransportManager()
*/
@Override
protected synchronized TransportManagerJabberImpl queryTransportManager()
{
return transportManager;
}
/**
* {@inheritDoc}
*
* In the case of utilization of the Jitsi Videobridge server-side
* technology, returns the visual <tt>Component</tt>s which display RTP
* video streams reported by the server to be sent by the remote peer
* represented by this instance.
*/
@Override
public List<Component> getVisualComponents()
{
/*
* TODO The super is currently unable to provide the complete set of
* remote SSRCs (i.e. in the case of no utilization of the Jitsi
* Videobridge server-side technology) so we have to explicitly check
* for Jitsi Videobridge instead of just relying on the implementation
* of the getRemoteSSRCs(MediaType) method to abstract away that detail.
*/
CallJabberImpl call;
MediaAwareCallConference conference;
if (((call = getPeer().getCall()) != null)
&& ((conference = call.getConference()) != null)
&& conference.isJitsiVideobridge())
{
MediaStream stream = getStream(MediaType.VIDEO);
if (stream == null)
return Collections.emptyList();
else
{
int[] remoteSSRCs = getRemoteSSRCs(MediaType.VIDEO);
if (remoteSSRCs.length == 0)
return Collections.emptyList();
else
{
VideoMediaStream videoStream = (VideoMediaStream) stream;
List<Component> visualComponents
= new LinkedList<Component>();
for (int i = 0; i < remoteSSRCs.length; i++)
{
int remoteSSRC = remoteSSRCs[i];
Component visualComponent
= videoStream.getVisualComponent(
0xFFFFFFFFL & remoteSSRC);
if (visualComponent != null)
visualComponents.add(visualComponent);
}
return visualComponents;
}
}
}
return super.getVisualComponents();
}
/**
* Gathers local candidate addresses.
*
* @param remote the media descriptions received from the remote peer if any
* or <tt>null</tt> if <tt>local</tt> represents an offer from the local
* peer to be sent to the remote peer
* @param local the media descriptions sent or to be sent from the local
* peer to the remote peer. If <tt>remote</tt> is <tt>null</tt>,
* <tt>local</tt> represents an offer from the local peer to be sent to the
* remote peer
* @param transportInfoSender the <tt>TransportInfoSender</tt> to be used by
* this <tt>TransportManagerJabberImpl</tt> to send <tt>transport-info</tt>
* <tt>JingleIQ</tt>s from the local peer to the remote peer if this
* <tt>TransportManagerJabberImpl</tt> wishes to utilize
* <tt>transport-info</tt>
* @return the media descriptions of the local peer after the local
* candidate addresses have been gathered as returned by
* {@link TransportManagerJabberImpl#wrapupCandidateHarvest()}
* @throws OperationFailedException if anything goes wrong while starting or
* wrapping up the gathering of local candidate addresses
*/
private List<ContentPacketExtension> harvestCandidates(
List<ContentPacketExtension> remote,
List<ContentPacketExtension> local,
TransportInfoSender transportInfoSender)
throws OperationFailedException
{
long startCandidateHarvestTime = System.currentTimeMillis();
TransportManagerJabberImpl transportManager = getTransportManager();
if (remote == null)
{
/*
* We'll be harvesting candidates in order to make an offer so it
* doesn't make sense to send them in transport-info.
*/
if (transportInfoSender != null)
throw new IllegalArgumentException("transportInfoSender");
transportManager.startCandidateHarvest(local, transportInfoSender);
}
else
{
transportManager.startCandidateHarvest(
remote,
local,
transportInfoSender);
}
long stopCandidateHarvestTime = System.currentTimeMillis();
if (logger.isInfoEnabled())
{
long candidateHarvestTime
= stopCandidateHarvestTime - startCandidateHarvestTime;
logger.info(
"End candidate harvest within " + candidateHarvestTime
+ " ms");
}
setDtlsEncryptionOnTransports(remote, local);
if (transportManager.startConnectivityEstablishmentWithJitsiVideobridge)
{
Map<String,IceUdpTransportPacketExtension> map
= new LinkedHashMap<String,IceUdpTransportPacketExtension>();
for (MediaType mediaType : MediaType.values())
{
ColibriConferenceIQ.Channel channel
= transportManager.getColibriChannel(
mediaType,
true /* local */);
if (channel != null)
{
IceUdpTransportPacketExtension transport
= channel.getTransport();
if (transport != null)
map.put(mediaType.toString(), transport);
}
}
if (!map.isEmpty())
{
transportManager
.startConnectivityEstablishmentWithJitsiVideobridge
= false;
transportManager.startConnectivityEstablishment(map);
}
}
/*
* TODO Ideally, we wouldn't wrap up that quickly. We need to revisit
* this.
*/
return transportManager.wrapupCandidateHarvest();
}
/**
* Creates if necessary, and configures the stream that this
* <tt>MediaHandler</tt> is using for the <tt>MediaType</tt> matching the
* one of the <tt>MediaDevice</tt>. This method extends the one already
* available by adding a stream name, corresponding to a stream's content
* name.
*
* @param streamName the name of the stream as indicated in the XMPP
* <tt>content</tt> element.
* @param connector the <tt>MediaConnector</tt> that we'd like to bind the
* newly created stream to.
* @param device the <tt>MediaDevice</tt> that we'd like to attach the newly
* created <tt>MediaStream</tt> to.
* @param format the <tt>MediaFormat</tt> that we'd like the new
* <tt>MediaStream</tt> to be set to transmit in.
* @param target the <tt>MediaStreamTarget</tt> containing the RTP and RTCP
* address:port couples that the new stream would be sending packets to.
* @param direction the <tt>MediaDirection</tt> that we'd like the new
* stream to use (i.e. sendonly, sendrecv, recvonly, or inactive).
* @param rtpExtensions the list of <tt>RTPExtension</tt>s that should be
* enabled for this stream.
* @param masterStream whether the stream to be used as master if secured
*
* @return the newly created <tt>MediaStream</tt>.
*
* @throws OperationFailedException if creating the stream fails for any
* reason (like for example accessing the device or setting the format).
*/
protected MediaStream initStream(String streamName,
StreamConnector connector,
MediaDevice device,
MediaFormat format,
MediaStreamTarget target,
MediaDirection direction,
List<RTPExtension> rtpExtensions,
boolean masterStream)
throws OperationFailedException
{
MediaStream stream
= super.initStream(
connector,
device,
format,
target,
direction,
rtpExtensions,
masterStream);
if (stream != null)
stream.setName(streamName);
return stream;
}
/**
* {@inheritDoc}
*
* In the case of a telephony conference organized by the local peer/user
* and utilizing the Jitsi Videobridge server-side technology, a single
* <tt>MediaHandler</tt> is shared by multiple
* <tt>CallPeerMediaHandler</tt>s in order to have a single
* <tt>AudioMediaStream</tt> and a single <tt>VideoMediaStream</tt>.
* However, <tt>CallPeerMediaHandlerJabberImpl</tt> has redefined the
* reading/getting the remote audio and video SSRCs. Consequently,
* <tt>CallPeerMediaHandlerJabberImpl</tt> has to COMPLETELY redefine the
* writing/setting as well i.e. it has to stop related
* <tt>PropertyChangeEvent</tt>s fired by the super.
*/
@Override
protected void mediaHandlerPropertyChange(PropertyChangeEvent ev)
{
String propertyName = ev.getPropertyName();
if ((AUDIO_REMOTE_SSRC.equals(propertyName)
|| VIDEO_REMOTE_SSRC.equals(propertyName))
&& getPeer().isJitsiVideobridge())
return;
super.mediaHandlerPropertyChange(ev);
}
/**
* Handles the specified <tt>answer</tt> by creating and initializing the
* corresponding <tt>MediaStream</tt>s.
*
* @param answer the Jingle answer
*
* @throws OperationFailedException if we fail to handle <tt>answer</tt> for
* reasons like failing to initialize media devices or streams.
* @throws IllegalArgumentException if there's a problem with the syntax or
* the semantics of <tt>answer</tt>. Method is synchronized in order to
* avoid closing mediaHandler when we are currently in process of
* initializing, configuring and starting streams and anybody interested
* in this operation can synchronize to the mediaHandler instance to wait
* processing to stop (method setState in CallPeer).
*/
public void processAnswer(List<ContentPacketExtension> answer)
throws OperationFailedException,
IllegalArgumentException
{
/*
* The answer given in session-accept may contain transport-related
* information compatible with that carried in transport-info.
*/
processTransportInfo(answer);
boolean masterStreamSet = false;
for (ContentPacketExtension content : answer)
{
remoteContentMap.put(content.getName(), content);
boolean masterStream = false;
// if we have more than one stream, let the audio be the master
if(!masterStreamSet)
{
if(answer.size() > 1)
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
if(MediaType.AUDIO.toString().equals(
description.getMedia()))
{
masterStream = true;
masterStreamSet = true;
}
}
else
{
masterStream = true;
masterStreamSet = true;
}
}
processContent(content, false, masterStream);
}
}
/**
* Notifies this instance that a specific <tt>ColibriConferenceIQ</tt> has
* been received. This <tt>CallPeerMediaHandler</tt> uses the part of the
* information provided in the specified <tt>conferenceIQ</tt> which
* concerns it only.
*
* @param conferenceIQ the <tt>ColibriConferenceIQ</tt> which has been
* received
*/
void processColibriConferenceIQ(ColibriConferenceIQ conferenceIQ)
{
/*
* This CallPeerMediaHandler stores the media information but it does
* not store the colibri Channels (which contain both media and transport
* information). The TransportManager associated with this instance
* stores the colibri Channels but does not store media information (such
* as the remote SSRCs). An design/implementation choice has to be made
* though and the present one is to have this CallPeerMediaHandler
* transparently (with respect to the TransportManager) store the media
* information inside the TransportManager.
*/
TransportManagerJabberImpl transportManager = this.transportManager;
if (transportManager != null)
{
long oldAudioRemoteSSRC = getRemoteSSRC(MediaType.AUDIO);
long oldVideoRemoteSSRC = getRemoteSSRC(MediaType.VIDEO);
for (MediaType mediaType : MediaType.values())
{
ColibriConferenceIQ.Channel dst
= transportManager.getColibriChannel(
mediaType,
false /* remote */);
if (dst != null)
{
ColibriConferenceIQ.Content content
= conferenceIQ.getContent(mediaType.toString());
if (content != null)
{
ColibriConferenceIQ.Channel src
= content.getChannel(dst.getID());
if (src != null)
{
int[] ssrcs = src.getSSRCs();
int[] dstSSRCs = dst.getSSRCs();
if (!Arrays.equals(dstSSRCs, ssrcs))
dst.setSSRCs(ssrcs);
}
}
}
}
/*
* Do fire new PropertyChangeEvents for the properties
* AUDIO_REMOTE_SSRC and VIDEO_REMOTE_SSRC if necessary.
*/
long newAudioRemoteSSRC = getRemoteSSRC(MediaType.AUDIO);
long newVideoRemoteSSRC = getRemoteSSRC(MediaType.VIDEO);
if (oldAudioRemoteSSRC != newAudioRemoteSSRC)
{
firePropertyChange(
AUDIO_REMOTE_SSRC,
oldAudioRemoteSSRC, newAudioRemoteSSRC);
}
if (oldVideoRemoteSSRC != newVideoRemoteSSRC)
{
firePropertyChange(
VIDEO_REMOTE_SSRC,
oldVideoRemoteSSRC, newVideoRemoteSSRC);
}
}
}
/**
* Process a <tt>ContentPacketExtension</tt> and initialize its
* corresponding <tt>MediaStream</tt>.
*
* @param content a <tt>ContentPacketExtension</tt>
* @param modify if it correspond to a content-modify for resolution change
* @param masterStream whether the stream to be used as master
* @throws OperationFailedException if we fail to handle <tt>content</tt>
* for reasons like failing to initialize media devices or streams.
* @throws IllegalArgumentException if there's a problem with the syntax or
* the semantics of <tt>content</tt>. The method is synchronized in order to
* avoid closing mediaHandler when we are currently in process of
* initializing, configuring and starting streams and anybody interested
* in this operation can synchronize to the mediaHandler instance to wait
* processing to stop (method setState in CallPeer).
*/
private void processContent(
ContentPacketExtension content,
boolean modify,
boolean masterStream)
throws OperationFailedException,
IllegalArgumentException
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
MediaType mediaType = JingleUtils.getMediaType(content);
//stream target
TransportManagerJabberImpl transportManager = getTransportManager();
MediaStreamTarget target = transportManager.getStreamTarget(mediaType);
if (target == null)
target = JingleUtils.extractDefaultTarget(content);
// no target port - try next media description
if((target == null) || (target.getDataAddress().getPort() == 0))
{
closeStream(mediaType);
return;
}
List<MediaFormat> supportedFormats = JingleUtils.extractFormats(
description, getDynamicPayloadTypes());
MediaDevice dev = getDefaultDevice(mediaType);
if(!isDeviceActive(dev))
{
closeStream(mediaType);
return;
}
MediaDirection devDirection
= (dev == null) ? MediaDirection.INACTIVE : dev.getDirection();
// Take the preference of the user with respect to streaming
// mediaType into account.
devDirection
= devDirection.and(getDirectionUserPreference(mediaType));
if (supportedFormats.isEmpty())
{
//remote party must have messed up our Jingle description.
//throw an exception.
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
"Remote party sent an invalid Jingle answer.",
OperationFailedException.ILLEGAL_ARGUMENT,
null,
logger);
}
CallJabberImpl call = getPeer().getCall();
CallConference conference
= (call == null) ? null : call.getConference();
/*
* Neither SDES nor ZRTP is supported in telephony conferences utilizing
* the server-side technology Jitsi Videobridge yet.
*/
if ((conference == null) || !conference.isJitsiVideobridge())
{
addZrtpAdvertisedEncryptions(true, description, mediaType);
addSDesAdvertisedEncryptions(true, description, mediaType);
}
addDtlsAdvertisedEncryptions(true, content, mediaType);
StreamConnector connector
= transportManager.getStreamConnector(mediaType);
//determine the direction that we need to announce.
MediaDirection remoteDirection
= JingleUtils.getDirection(content, getPeer().isInitiator());
/*
* If we are the focus of a conference, we need to take into account the
* other participants.
*/
if ((conference != null) && conference.isConferenceFocus())
{
for (CallPeerJabberImpl peer : call.getCallPeerList())
{
SendersEnum senders = peer.getSenders(mediaType);
boolean initiator = peer.isInitiator();
//check if the direction of the jingle session we have with
//this peer allows us receiving media. If senders is null,
//assume the default of 'both'
if ((senders == null)
|| (SendersEnum.both == senders)
|| (initiator && SendersEnum.initiator == senders)
|| (!initiator && SendersEnum.responder == senders))
{
remoteDirection
= remoteDirection.or(MediaDirection.SENDONLY);
}
}
}
MediaDirection direction
= devDirection.getDirectionForAnswer(remoteDirection);
// update the RTP extensions that we will be exchanging.
List<RTPExtension> remoteRTPExtensions
= JingleUtils.extractRTPExtensions(
description,
getRtpExtensionsRegistry());
List<RTPExtension> supportedExtensions
= getExtensionsForType(mediaType);
List<RTPExtension> rtpExtensions
= intersectRTPExtensions(remoteRTPExtensions, supportedExtensions);
Map<String, String> adv
= supportedFormats.get(0).getAdvancedAttributes();
if(adv != null)
{
for(Map.Entry<String, String> f : adv.entrySet())
{
if(f.getKey().equals("imageattr"))
supportQualityControls = true;
}
}
// check for options from remote party and set them locally
if(mediaType.equals(MediaType.VIDEO) && modify)
{
// update stream
MediaStream stream = getStream(MediaType.VIDEO);
if(stream != null && dev != null)
{
List<MediaFormat> fmts = supportedFormats;
if(fmts.size() > 0)
{
MediaFormat fmt = fmts.get(0);
((VideoMediaStream)stream).updateQualityControl(
fmt.getAdvancedAttributes());
}
}
if(qualityControls != null)
{
QualityPreset receiveQualityPreset
= qualityControls.getRemoteReceivePreset();
QualityPreset sendQualityPreset
= qualityControls.getRemoteSendMaxPreset();
supportedFormats
= (dev == null)
? null
: intersectFormats(
supportedFormats,
getLocallySupportedFormats(
dev,
sendQualityPreset,
receiveQualityPreset));
}
}
// create the corresponding stream...
initStream(
content.getName(),
connector,
dev,
supportedFormats.get(0),
target,
direction,
rtpExtensions,
masterStream);
}
/**
* Parses and handles the specified <tt>offer</tt> and returns a content
* extension representing the current state of this media handler. This
* method MUST only be called when <tt>offer</tt> is the first session
* description that this <tt>MediaHandler</tt> is seeing.
*
* @param offer the offer that we'd like to parse, handle and get an answer
* for.
*
* @throws OperationFailedException if we have a problem satisfying the
* description received in <tt>offer</tt> (e.g. failed to open a device or
* initialize a stream ...).
* @throws IllegalArgumentException if there's a problem with
* <tt>offer</tt>'s format or semantics.
*/
public void processOffer(List<ContentPacketExtension> offer)
throws OperationFailedException,
IllegalArgumentException
{
// prepare to generate answers to all the incoming descriptions
List<ContentPacketExtension> answer
= new ArrayList<ContentPacketExtension>(offer.size());
boolean atLeastOneValidDescription = false;
for (ContentPacketExtension content : offer)
{
remoteContentMap.put(content.getName(), content);
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
MediaType mediaType
= JingleUtils.getMediaType(content);
List<MediaFormat> remoteFormats
= JingleUtils.extractFormats(
description,
getDynamicPayloadTypes());
MediaDevice dev = getDefaultDevice(mediaType);
MediaDirection devDirection
= (dev == null) ? MediaDirection.INACTIVE : dev.getDirection();
// Take the preference of the user with respect to streaming
// mediaType into account.
devDirection
= devDirection.and(getDirectionUserPreference(mediaType));
// determine the direction that we need to announce.
MediaDirection remoteDirection = JingleUtils.getDirection(
content, getPeer().isInitiator());
MediaDirection direction
= devDirection.getDirectionForAnswer(remoteDirection);
// intersect the MediaFormats of our device with remote ones
List<MediaFormat> mutuallySupportedFormats
= intersectFormats(
remoteFormats,
getLocallySupportedFormats(dev));
// check whether we will be exchanging any RTP extensions.
List<RTPExtension> offeredRTPExtensions
= JingleUtils.extractRTPExtensions(
description, this.getRtpExtensionsRegistry());
List<RTPExtension> supportedExtensions
= getExtensionsForType(mediaType);
List<RTPExtension> rtpExtensions = intersectRTPExtensions(
offeredRTPExtensions, supportedExtensions);
// transport
/*
* RawUdpTransportPacketExtension extends
* IceUdpTransportPacketExtension so getting
* IceUdpTransportPacketExtension should suffice.
*/
IceUdpTransportPacketExtension transport
= content.getFirstChildOfType(
IceUdpTransportPacketExtension.class);
// stream target
MediaStreamTarget target = null;
try
{
target = JingleUtils.extractDefaultTarget(content);
}
catch(IllegalArgumentException e)
{
logger.warn("Fail to extract default target", e);
}
// according to XEP-176, transport element in session-initiate
// "MAY instead be empty (with each candidate to be sent as the
// payload of a transport-info message)".
int targetDataPort
= (target == null && transport != null)
? -1
: (target != null) ? target.getDataAddress().getPort() : 0;
/*
* TODO If the offered transport is not supported, attempt to fall
* back to a supported one using transport-replace.
*/
setTransportManager(transport.getNamespace());
if (mutuallySupportedFormats.isEmpty()
|| (devDirection == MediaDirection.INACTIVE)
|| (targetDataPort == 0))
{
// skip stream and continue. contrary to sip we don't seem to
// need to send per-stream disabling answer and only one at the
// end.
//close the stream in case it already exists
closeStream(mediaType);
continue;
}
SendersEnum senders = JingleUtils.getSenders(
direction,
!getPeer().isInitiator());
// create the answer description
ContentPacketExtension ourContent
= JingleUtils.createDescription(
content.getCreator(),
content.getName(),
senders,
mutuallySupportedFormats,
rtpExtensions,
getDynamicPayloadTypes(),
getRtpExtensionsRegistry());
/*
* Sets ZRTP, SDES or DTLS-SRTP depending on the preferences for
* this account.
*/
setAndAddPreferredEncryptionProtocol(
mediaType,
ourContent,
content);
// Got a content which has inputevt. It means that the peer requests
// a desktop sharing session so tell it we support inputevt.
if(content.getChildExtensionsOfType(InputEvtPacketExtension.class)
!= null)
{
ourContent.addChildExtension(new InputEvtPacketExtension());
}
answer.add(ourContent);
localContentMap.put(content.getName(), ourContent);
atLeastOneValidDescription = true;
}
if (!atLeastOneValidDescription)
{
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
"Offer contained no media formats"
+ " or no valid media descriptions.",
OperationFailedException.ILLEGAL_ARGUMENT,
null,
logger);
}
/*
* In order to minimize post-pickup delay, start establishing the
* connectivity prior to ringing.
*/
harvestCandidates(
offer,
answer,
new TransportInfoSender()
{
public void sendTransportInfo(
Iterable<ContentPacketExtension> contents)
{
getPeer().sendTransportInfo(contents);
}
});
/*
* While it may sound like we can completely eliminate the post-pickup
* delay by waiting for the connectivity establishment to finish, it may
* not be possible in all cases. We are the Jingle session responder so,
* in the case of the ICE UDP transport, we are not the controlling ICE
* Agent and we cannot be sure when the controlling ICE Agent will
* perform the nomination. It could, for example, choose to wait for our
* session-accept to perform the nomination which will deadlock us if we
* have chosen to wait for the connectivity establishment to finish
* before we begin ringing and send session-accept.
*/
getTransportManager().startConnectivityEstablishment(offer);
}
/**
* Processes the transport-related information provided by the remote
* <tt>peer</tt> in a specific set of <tt>ContentPacketExtension</tt>s.
*
* @param contents the <tt>ContentPacketExtenion</tt>s provided by the
* remote <tt>peer</tt> and containing the transport-related information to
* be processed
* @throws OperationFailedException if anything goes wrong while processing
* the transport-related information provided by the remote <tt>peer</tt> in
* the specified set of <tt>ContentPacketExtension</tt>s
*/
public void processTransportInfo(Iterable<ContentPacketExtension> contents)
throws OperationFailedException
{
if (getTransportManager().startConnectivityEstablishment(contents))
{
//Emil: why the heck is this here and why is it commented?
//wrapupConnectivityEstablishment();
}
}
/**
* Reinitialize all media contents.
*
* @throws OperationFailedException if we fail to handle <tt>content</tt>
* for reasons like failing to initialize media devices or streams.
* @throws IllegalArgumentException if there's a problem with the syntax or
* the semantics of <tt>content</tt>. Method is synchronized in order to
* avoid closing mediaHandler when we are currently in process of
* initializing, configuring and starting streams and anybody interested
* in this operation can synchronize to the mediaHandler instance to wait
* processing to stop (method setState in CallPeer).
*/
public void reinitAllContents()
throws OperationFailedException,
IllegalArgumentException
{
boolean masterStreamSet = false;
for(String key : remoteContentMap.keySet())
{
ContentPacketExtension ext = remoteContentMap.get(key);
boolean masterStream = false;
// if we have more than one stream, lets the audio be the master
if(!masterStreamSet)
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(ext);
MediaType mediaType
= MediaType.parseString( description.getMedia() );
if(remoteContentMap.size() > 1)
{
if(mediaType.equals(MediaType.AUDIO))
{
masterStream = true;
masterStreamSet = true;
}
}
else
{
masterStream = true;
masterStreamSet = true;
}
}
if(ext != null)
processContent(ext, false, masterStream);
}
}
/**
* Reinitialize a media content such as video.
*
* @param name name of the Jingle content
* @param content media content
* @param modify if it correspond to a content-modify for resolution change
* @throws OperationFailedException if we fail to handle <tt>content</tt>
* for reasons like failing to initialize media devices or streams.
* @throws IllegalArgumentException if there's a problem with the syntax or
* the semantics of <tt>content</tt>. Method is synchronized in order to
* avoid closing mediaHandler when we are currently in process of
* initializing, configuring and starting streams and anybody interested
* in this operation can synchronize to the mediaHandler instance to wait
* processing to stop (method setState in CallPeer).
*/
public void reinitContent(
String name,
ContentPacketExtension content,
boolean modify)
throws OperationFailedException,
IllegalArgumentException
{
ContentPacketExtension ext = remoteContentMap.get(name);
if(ext != null)
{
if(modify)
{
processContent(content, modify, false);
remoteContentMap.put(name, content);
}
else
{
ext.setSenders(content.getSenders());
processContent(ext, modify, false);
remoteContentMap.put(name, ext);
}
}
}
/**
* Removes a media content with a specific name from the session represented
* by this <tt>CallPeerMediaHandlerJabberImpl</tt> and closes its associated
* media stream.
*
* @param contentMap the <tt>Map</tt> in which the specified <tt>name</tt>
* has an association with the media content to be removed
* @param name the name of the media content to be removed from this session
*/
private void removeContent(
Map<String, ContentPacketExtension> contentMap,
String name)
{
ContentPacketExtension content = contentMap.remove(name);
if (content != null)
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(content);
String media = description.getMedia();
if (media != null)
closeStream(MediaType.parseString(media));
}
}
/**
* Removes a media content with a specific name from the session represented
* by this <tt>CallPeerMediaHandlerJabberImpl</tt> and closes its associated
* media stream.
*
* @param name the name of the media content to be removed from this session
*/
public void removeContent(String name)
{
removeContent(localContentMap, name);
removeContent(remoteContentMap, name);
TransportManagerJabberImpl transportManager = queryTransportManager();
if (transportManager != null)
transportManager.removeContent(name);
}
/**
* Acts upon a notification received from the remote party indicating that
* they've put us on/off hold.
*
* @param onHold <tt>true</tt> if the remote party has put us on hold
* and <tt>false</tt> if they've just put us off hold.
*/
public void setRemotelyOnHold(boolean onHold)
{
this.remotelyOnHold = onHold;
for (MediaType mediaType : MediaType.values())
{
MediaStream stream = getStream(mediaType);
if (stream == null)
continue;
if (getPeer().isJitsiVideobridge())
{
/*
* If we are the focus of a Videobridge conference, we need to
* ask the Videobridge to change the stream direction on our
* behalf.
*/
ColibriConferenceIQ.Channel channel
= getColibriChannel(mediaType);
MediaDirection direction;
if(remotelyOnHold)
{
direction = MediaDirection.INACTIVE;
}
else
{
// TODO Does SENDRECV always make sense?
direction = MediaDirection.SENDRECV;
}
getPeer().getCall().setChannelDirection(
channel.getID(),
mediaType,
direction);
}
else //no Videobridge
{
if (remotelyOnHold)
{
/*
* In conferences we use INACTIVE to prevent, for example,
* on-hold music from being played to all the participants.
*/
MediaDirection newDirection
= getPeer().getCall().isConferenceFocus()
? MediaDirection.INACTIVE
: stream.getDirection().and(
MediaDirection.RECVONLY);
stream.setDirection(newDirection);
}
else
{
stream.setDirection(calculatePostHoldDirection(stream));
}
}
}
}
/**
* Sometimes as initing a call with custom preset can set and we force
* that quality controls is supported.
*
* @param value whether quality controls is supported..
*/
public void setSupportQualityControls(boolean value)
{
this.supportQualityControls = value;
}
/**
* Sets the <tt>TransportManager</tt> implementation to handle our address
* management by Jingle transport XML namespace.
*
* @param xmlns the Jingle transport XML namespace specifying the
* <tt>TransportManager</tt> implementation type to be set on this instance
* to handle our address management
* @throws IllegalArgumentException if the specified <tt>xmlns</tt> does not
* specify a (supported) <tt>TransportManager</tt> implementation type
*/
private void setTransportManager(String xmlns)
throws IllegalArgumentException
{
// Is this really going to be an actual change?
if ((transportManager != null)
&& transportManager.getXmlNamespace().equals(xmlns))
{
return;
}
CallPeerJabberImpl peer = getPeer();
if (!peer.getProtocolProvider().getDiscoveryManager().includesFeature(
xmlns))
{
throw new IllegalArgumentException(
"Unsupported Jingle transport " + xmlns);
}
/*
* TODO The transportManager is going to be changed so it may need to be
* disposed of prior to the change.
*/
if (xmlns.equals(
ProtocolProviderServiceJabberImpl.URN_XMPP_JINGLE_ICE_UDP_1))
{
transportManager = new IceUdpTransportManager(peer);
}
else if (xmlns.equals(
ProtocolProviderServiceJabberImpl.URN_XMPP_JINGLE_RAW_UDP_0))
{
transportManager = new RawUdpTransportManager(peer);
}
else
{
throw new IllegalArgumentException(
"Unsupported Jingle transport " + xmlns);
}
synchronized(transportManagerSyncRoot)
{
transportManagerSyncRoot.notify();
}
}
/**
* Waits for the associated <tt>TransportManagerJabberImpl</tt> to conclude
* any started connectivity establishment and then starts this
* <tt>CallPeerMediaHandler</tt>.
*
* @throws IllegalStateException if no offer or answer has been provided or
* generated earlier
*/
@Override
public void start()
throws IllegalStateException
{
try
{
wrapupConnectivityEstablishment();
}
catch (OperationFailedException ofe)
{
throw new UndeclaredThrowableException(ofe);
}
super.start();
}
/**
* Lets the underlying implementation take note of this error and only
* then throws it to the using bundles.
*
* @param message the message to be logged and then wrapped in a new
* <tt>OperationFailedException</tt>
* @param errorCode the error code to be assigned to the new
* <tt>OperationFailedException</tt>
* @param cause the <tt>Throwable</tt> that has caused the necessity to log
* an error and have a new <tt>OperationFailedException</tt> thrown
*
* @throws OperationFailedException the exception that we wanted this method
* to throw.
*/
@Override
protected void throwOperationFailedException(
String message,
int errorCode,
Throwable cause)
throws OperationFailedException
{
ProtocolProviderServiceJabberImpl.throwOperationFailedException(
message,
errorCode,
cause,
logger);
}
/**
* Notifies the associated <tt>TransportManagerJabberImpl</tt> that it
* should conclude any connectivity establishment, waits for it to actually
* do so and sets the <tt>connector</tt>s and <tt>target</tt>s of the
* <tt>MediaStream</tt>s managed by this <tt>CallPeerMediaHandler</tt>.
*
* @throws OperationFailedException if anything goes wrong while setting the
* <tt>connector</tt>s and/or <tt>target</tt>s of the <tt>MediaStream</tt>s
* managed by this <tt>CallPeerMediaHandler</tt>
*/
private void wrapupConnectivityEstablishment()
throws OperationFailedException
{
TransportManagerJabberImpl transportManager = getTransportManager();
transportManager.wrapupConnectivityEstablishment();
for (MediaType mediaType : MediaType.values())
{
MediaStream stream = getStream(mediaType);
if (stream != null)
{
stream.setConnector(
transportManager.getStreamConnector(mediaType));
stream.setTarget(transportManager.getStreamTarget(mediaType));
}
}
}
/**
* If Jitsi Videobridge is in use, returns the
* <tt>ColibriConferenceIQ.Channel</tt> that this
* <tt>CallPeerMediaHandler</tt> uses for media of type <tt>mediaType</tt>.
* Otherwise, returns <tt>null</tt>
*
* @param mediaType the <tt>MediaType</tt> for which to return a
* <tt>ColibriConferenceIQ.Channel</tt>
* @return the <tt>ColibriConferenceIQ.Channel</tt> that this
* <tt>CallPeerMediaHandler</tt> uses for media of type <tt>mediaType</tt>
* or <tt>null</tt>.
*/
private ColibriConferenceIQ.Channel getColibriChannel(MediaType mediaType)
{
ColibriConferenceIQ.Channel channel = null;
if (getPeer().isJitsiVideobridge())
{
TransportManagerJabberImpl transportManager = this.transportManager;
if (transportManager != null)
{
channel
= transportManager.getColibriChannel(
mediaType,
false /* remote */);
}
}
return channel;
}
/**
* {@inheritDoc}
*
* The super implementation relies on the direction of the streams and is
* therefore not accurate when we use a Videobridge.
*/
@Override
public boolean isRemotelyOnHold()
{
return remotelyOnHold;
}
/**
* {@inheritDoc}
*
* Handles the case when a Videobridge is in use.
*
* @param locallyOnHold <tt>true</tt> if we are to make our streams
* stop transmitting and <tt>false</tt> if we are to start transmitting
*/
@Override
public void setLocallyOnHold(boolean locallyOnHold)
{
CallPeerJabberImpl peer = getPeer();
if (peer.isJitsiVideobridge())
{
this.locallyOnHold = locallyOnHold;
if (locallyOnHold
|| !CallPeerState.ON_HOLD_MUTUALLY.equals(peer.getState()))
{
for (MediaType mediaType : MediaType.values())
{
ColibriConferenceIQ.Channel channel
= getColibriChannel(mediaType);
if (channel != null)
{
MediaDirection direction
= locallyOnHold
? MediaDirection.INACTIVE
: MediaDirection.SENDRECV;
peer.getCall().setChannelDirection(
channel.getID(),
mediaType,
direction);
}
}
}
}
else
{
super.setLocallyOnHold(locallyOnHold);
}
}
/**
* Detects and adds DTLS-SRTP available encryption method present in the
* content (description) given in parameter.
*
* @param isInitiator <tt>true</tt> if the local call instance is the
* initiator of the call; <tt>false</tt>, otherwise.
* @param content The CONTENT element of the JINGLE element which contains
* the TRANSPORT element
* @param mediaType The type of media (AUDIO or VIDEO).
*/
private boolean addDtlsAdvertisedEncryptions(
boolean isInitiator,
ContentPacketExtension content,
MediaType mediaType)
{
if (getPeer().isJitsiVideobridge())
{
// TODO Auto-generated method stub
return false;
}
else
{
IceUdpTransportPacketExtension remoteTransport
= content.getFirstChildOfType(
IceUdpTransportPacketExtension.class);
return
addDtlsAdvertisedEncryptions(
isInitiator,
remoteTransport,
mediaType);
}
}
/**
* Detects and adds DTLS-SRTP available encryption method present in the
* transport (description) given in parameter.
*
* @param isInitiator <tt>true</tt> if the local call instance is the
* initiator of the call; <tt>false</tt>, otherwise.
* @param remoteTransport the TRANSPORT element
* @param mediaType The type of media (AUDIO or VIDEO).
*/
boolean addDtlsAdvertisedEncryptions(
boolean isInitiator,
IceUdpTransportPacketExtension remoteTransport,
MediaType mediaType)
{
SrtpControls srtpControls = getSrtpControls();
boolean b = false;
if (remoteTransport != null)
{
List<DtlsFingerprintPacketExtension> remoteFingerpintPEs
= remoteTransport.getChildExtensionsOfType(
DtlsFingerprintPacketExtension.class);
if (!remoteFingerpintPEs.isEmpty())
{
AccountID accountID
= getPeer().getProtocolProvider().getAccountID();
if (accountID.getAccountPropertyBoolean(
ProtocolProviderFactory.DEFAULT_ENCRYPTION,
true)
&& accountID.isEncryptionProtocolEnabled(
SrtpControlType.DTLS_SRTP))
{
Map<String,String> remoteFingerprints
= new LinkedHashMap<String,String>();
for (DtlsFingerprintPacketExtension remoteFingerprintPE
: remoteFingerpintPEs)
{
String remoteFingerprint
= remoteFingerprintPE.getFingerprint();
String remoteHash = remoteFingerprintPE.getHash();
remoteFingerprints.put(
remoteHash,
remoteFingerprint);
}
DtlsControl dtlsControl;
DtlsControl.Setup setup;
if (isInitiator)
{
dtlsControl
= (DtlsControl)
srtpControls.get(
mediaType,
SrtpControlType.DTLS_SRTP);
setup = DtlsControl.Setup.PASSIVE;
}
else
{
dtlsControl
= (DtlsControl)
srtpControls.getOrCreate(
mediaType,
SrtpControlType.DTLS_SRTP);
setup = DtlsControl.Setup.ACTIVE;
}
if (dtlsControl != null)
{
dtlsControl.setRemoteFingerprints(remoteFingerprints);
dtlsControl.setSetup(setup);
removeAndCleanupOtherSrtpControls(
mediaType,
SrtpControlType.DTLS_SRTP);
addAdvertisedEncryptionMethod(
SrtpControlType.DTLS_SRTP);
b = true;
}
}
}
}
/*
* If they haven't advertised DTLS-SRTP in their (media) description,
* then DTLS-SRTP shouldn't be functioning as far as we're concerned.
*/
if (!b)
{
SrtpControl dtlsControl
= srtpControls.get(mediaType, SrtpControlType.DTLS_SRTP);
if (dtlsControl != null)
{
srtpControls.remove(mediaType, SrtpControlType.DTLS_SRTP);
dtlsControl.cleanup(null);
}
}
return b;
}
/**
* Selects the preferred encryption protocol (only used by the callee).
*
* @param mediaType The type of media (AUDIO or VIDEO).
* @param localContent The element containing the media DESCRIPTION and
* its encryption.
* @param remoteContent The element containing the media DESCRIPTION and
* its encryption for the remote peer; <tt>null</tt> if the local peer is
* the initiator of the call.
*/
private void setAndAddPreferredEncryptionProtocol(
MediaType mediaType,
ContentPacketExtension localContent,
ContentPacketExtension remoteContent)
{
List<SrtpControlType> preferredEncryptionProtocols
= getPeer()
.getProtocolProvider()
.getAccountID()
.getSortedEnabledEncryptionProtocolList();
for (SrtpControlType srtpControlType : preferredEncryptionProtocols)
{
// DTLS-SRTP
if (srtpControlType == SrtpControlType.DTLS_SRTP)
{
addDtlsAdvertisedEncryptions(
false,
remoteContent,
mediaType);
if (setDtlsEncryptionOnContent(
mediaType,
localContent,
remoteContent))
{
// Stop once an encryption advertisement has been chosen.
return;
}
}
else
{
RtpDescriptionPacketExtension localDescription
= (localContent == null)
? null
: JingleUtils.getRtpDescription(localContent);
RtpDescriptionPacketExtension remoteDescription
= (remoteContent == null)
? null
: JingleUtils.getRtpDescription(remoteContent);
if (setAndAddPreferredEncryptionProtocol(
srtpControlType,
mediaType,
localDescription,
remoteDescription))
{
// Stop once an encryption advertisement has been chosen.
return;
}
}
}
}
/**
* Sets DTLS-SRTP element(s) to the TRANSPORT element of the CONTENT for a
* given media.
*
* @param mediaType The type of media we are modifying the CONTENT to
* integrate the DTLS-SRTP element(s).
* @param localContent The element containing the media CONTENT and its
* TRANSPORT.
* @param remoteContent The element containing the media CONTENT and its
* TRANSPORT for the remote peer. Null, if the local peer is the initiator
* of the call.
* @return <tt>true</tt> if any DTLS-SRTP element has been added to the
* specified <tt>localContent</tt>; <tt>false</tt>, otherwise.
*/
private boolean setDtlsEncryptionOnContent(
MediaType mediaType,
ContentPacketExtension localContent,
ContentPacketExtension remoteContent)
{
CallPeerJabberImpl peer = getPeer();
boolean b = false;
if (peer.isJitsiVideobridge())
{
b
= setDtlsEncryptionOnTransport(
mediaType,
localContent,
remoteContent);
return b;
}
ProtocolProviderServiceJabberImpl protocolProvider
= peer.getProtocolProvider();
AccountID accountID = protocolProvider.getAccountID();
SrtpControls srtpControls = getSrtpControls();
if (accountID.getAccountPropertyBoolean(
ProtocolProviderFactory.DEFAULT_ENCRYPTION,
true)
&& accountID.isEncryptionProtocolEnabled(
SrtpControlType.DTLS_SRTP))
{
boolean addFingerprintToLocalTransport;
if (remoteContent == null) // initiator
{
addFingerprintToLocalTransport
= protocolProvider.isFeatureSupported(
peer.getAddress(),
ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_DTLS_SRTP);
}
else // responder
{
addFingerprintToLocalTransport
= addDtlsAdvertisedEncryptions(
false,
remoteContent,
mediaType);
}
if (addFingerprintToLocalTransport)
{
DtlsControl dtlsControl
= (DtlsControl)
srtpControls.getOrCreate(
mediaType,
SrtpControlType.DTLS_SRTP);
if (dtlsControl != null)
{
DtlsControl.Setup setup
= (remoteContent == null)
? DtlsControl.Setup.PASSIVE
: DtlsControl.Setup.ACTIVE;
dtlsControl.setSetup(setup);
b = true;
setDtlsEncryptionOnTransport(
mediaType,
localContent,
remoteContent);
}
}
}
/*
* If we haven't advertised DTLS-SRTP in our (media) description, then
* DTLS-SRTP shouldn't be functioning as far as we're concerned.
*/
if (!b)
{
SrtpControl dtlsControl
= srtpControls.get(mediaType, SrtpControlType.DTLS_SRTP);
if (dtlsControl != null)
{
srtpControls.remove(mediaType, SrtpControlType.DTLS_SRTP);
dtlsControl.cleanup(null);
}
}
return b;
}
/**
* Sets DTLS-SRTP element(s) to the TRANSPORT element of the CONTENT for a
* given media.
*
* @param mediaType The type of media we are modifying the CONTENT to
* integrate the DTLS-SRTP element(s).
* @param localContent The element containing the media CONTENT and its
* TRANSPORT.
*/
private boolean setDtlsEncryptionOnTransport(
MediaType mediaType,
ContentPacketExtension localContent,
ContentPacketExtension remoteContent)
{
IceUdpTransportPacketExtension localTransport
= localContent.getFirstChildOfType(
IceUdpTransportPacketExtension.class);
boolean b = false;
if (localTransport == null)
return b;
CallPeerJabberImpl peer = getPeer();
if (peer.isJitsiVideobridge())
{
ProtocolProviderServiceJabberImpl protocolProvider
= peer.getProtocolProvider();
AccountID accountID = protocolProvider.getAccountID();
if (accountID.getAccountPropertyBoolean(
ProtocolProviderFactory.DEFAULT_ENCRYPTION,
true)
&& accountID.isEncryptionProtocolEnabled(
SrtpControlType.DTLS_SRTP))
{
// Gather the local fingerprints to be sent to the remote peer.
ColibriConferenceIQ.Channel channel
= getColibriChannel(mediaType);
List<DtlsFingerprintPacketExtension> localFingerprints = null;
if (channel != null)
{
IceUdpTransportPacketExtension transport
= channel.getTransport();
if (transport != null)
{
localFingerprints
= transport.getChildExtensionsOfType(
DtlsFingerprintPacketExtension.class);
}
}
/*
* Determine whether the local fingerprints are to be sent to
* the remote peer.
*/
if ((localFingerprints != null) && !localFingerprints.isEmpty())
{
if (remoteContent == null) // initiator
{
if (!protocolProvider.isFeatureSupported(
peer.getAddress(),
ProtocolProviderServiceJabberImpl
.URN_XMPP_JINGLE_DTLS_SRTP))
{
localFingerprints = null;
}
}
else // responder
{
IceUdpTransportPacketExtension transport
= remoteContent.getFirstChildOfType(
IceUdpTransportPacketExtension.class);
if (transport == null)
{
localFingerprints = null;
}
else
{
List<DtlsFingerprintPacketExtension>
remoteFingerprints
= transport.getChildExtensionsOfType(
DtlsFingerprintPacketExtension
.class);
if (remoteFingerprints.isEmpty())
localFingerprints = null;
}
}
// Send the local fingerprints to the remote peer.
if (localFingerprints != null)
{
List<DtlsFingerprintPacketExtension> fingerprintPEs
= localTransport.getChildExtensionsOfType(
DtlsFingerprintPacketExtension.class);
if (fingerprintPEs.isEmpty())
{
for (DtlsFingerprintPacketExtension localFingerprint
: localFingerprints)
{
DtlsFingerprintPacketExtension fingerprintPE
= new DtlsFingerprintPacketExtension();
fingerprintPE.setFingerprint(
localFingerprint.getFingerprint());
fingerprintPE.setHash(
localFingerprint.getHash());
localTransport.addChildExtension(fingerprintPE);
}
}
b = true;
}
}
}
}
else
{
SrtpControls srtpControls = getSrtpControls();
DtlsControl dtlsControl
= (DtlsControl)
srtpControls.get(mediaType, SrtpControlType.DTLS_SRTP);
if (dtlsControl != null)
{
CallJabberImpl.setDtlsEncryptionOnTransport(
dtlsControl,
localTransport);
b = true;
}
}
return b;
}
/**
* Sets DTLS-SRTP element(s) to the TRANSPORT element of a specified list of
* CONTENT elements.
*
* @param localContents The elements containing the media CONTENT elements
* and their respective TRANSPORT elements.
*/
private void setDtlsEncryptionOnTransports(
List<ContentPacketExtension> remoteContents,
List<ContentPacketExtension> localContents)
{
for (ContentPacketExtension localContent : localContents)
{
RtpDescriptionPacketExtension description
= JingleUtils.getRtpDescription(localContent);
if (description != null)
{
MediaType mediaType = JingleUtils.getMediaType(localContent);
if (mediaType != null)
{
ContentPacketExtension remoteContent
= (remoteContents == null)
? null
: TransportManagerJabberImpl.findContentByName(
remoteContents,
localContent.getName());
setDtlsEncryptionOnTransport(
mediaType,
localContent,
remoteContent);
}
}
}
}
/**
* Sets the jingle transports that this
* <tt>CallPeerMediaHandlerJabberImpl</tt> supports. Unknown transports are
* ignored, and the <tt>transports</tt> <tt>Collection</tt> is put into
* order depending on local preference.
*
* Currently only ice and raw-udp are recognized, with ice being preffered
* over raw-udp
*
* @param transports A <tt>Collection</tt> of XML namespaces of jingle
* transport elements to be set as the supported jingle transports for this
* <tt>CallPeerMediaHandlerJabberImpl</tt>
*/
public void setSupportedTransports(Collection<String> transports)
{
if (transports == null)
return;
String ice
= ProtocolProviderServiceJabberImpl.URN_XMPP_JINGLE_ICE_UDP_1;
String rawUdp
= ProtocolProviderServiceJabberImpl.URN_XMPP_JINGLE_RAW_UDP_0;
int size = 0;
for(String transport : transports)
if (ice.equals(transport) || rawUdp.equals(transport))
size++;
if (size > 0)
{
synchronized (supportedTransportsSyncRoot)
{
supportedTransports = new String[size];
int i = 0;
// we prefer ice over raw-udp
if (transports.contains(ice))
{
supportedTransports[i] = ice;
i++;
}
if (transports.contains(rawUdp))
{
supportedTransports[i] = rawUdp;
i++;
}
}
}
}
}
|