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
|
from unittest import TestCase
from aiortc.rate import (
AimdRateControl,
BandwidthUsage,
InterArrival,
OveruseDetector,
OveruseEstimator,
RateBucket,
RateControlState,
RateCounter,
RemoteBitrateEstimator,
)
from numpy import random
TIMESTAMP_GROUP_LENGTH_US = 5000
MIN_STEP_US = 20
TRIGGER_NEW_GROUP_US = TIMESTAMP_GROUP_LENGTH_US + MIN_STEP_US
BURST_THRESHOLD_MS = 5
START_RTP_TIMESTAMP_WRAP_US = 47721858827
START_ABS_SEND_TIME_WRAP_US = 63999995
def abs_send_time(us):
absolute_send_time = (((us << 18) + 500000) // 1000000) & 0xFFFFFF
return absolute_send_time << 8
def rtp_timestamp(us):
return ((us * 90 + 500) // 1000) & 0xFFFFFFFF
class AimdRateControlTest(TestCase):
def setUp(self):
self.rate_control = AimdRateControl()
def test_update_normal(self):
bitrate = 300000
now_ms = 0
self.rate_control.set_estimate(bitrate, now_ms)
estimate = self.rate_control.update(BandwidthUsage.NORMAL, bitrate, now_ms)
self.assertEqual(estimate, 301000)
self.assertEqual(self.rate_control.state, RateControlState.INCREASE)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, None)
self.assertEqual(self.rate_control.var_max_bitrate_kbps, 0.4)
def test_update_normal_no_estimated_throughput(self):
bitrate = 300000
now_ms = 0
self.rate_control.set_estimate(bitrate, now_ms)
estimate = self.rate_control.update(BandwidthUsage.NORMAL, None, now_ms)
self.assertEqual(estimate, 301000)
def test_update_overuse(self):
bitrate = 300000
now_ms = 0
self.rate_control.set_estimate(bitrate, now_ms)
estimate = self.rate_control.update(BandwidthUsage.OVERUSING, bitrate, now_ms)
self.assertEqual(estimate, 255000)
self.assertEqual(self.rate_control.state, RateControlState.HOLD)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, 300.0)
self.assertEqual(self.rate_control.var_max_bitrate_kbps, 0.4)
def test_update_underuse(self):
bitrate = 300000
now_ms = 0
self.rate_control.set_estimate(bitrate, now_ms)
estimate = self.rate_control.update(BandwidthUsage.UNDERUSING, bitrate, now_ms)
self.assertEqual(estimate, 300000)
self.assertEqual(self.rate_control.state, RateControlState.HOLD)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, None)
self.assertEqual(self.rate_control.var_max_bitrate_kbps, 0.4)
def test_additive_rate_increase(self):
acked_bitrate = 100000
self.rate_control.set_estimate(acked_bitrate, 0)
for now_ms in range(0, 20000, 100):
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate, now_ms
)
self.assertEqual(estimate, 160000)
self.assertEqual(self.rate_control.near_max, False)
# overuse -> hold
estimate = self.rate_control.update(
BandwidthUsage.OVERUSING, acked_bitrate, now_ms
)
self.assertEqual(estimate, 85000)
self.assertEqual(self.rate_control.near_max, True)
now_ms += 1000
# back to normal -> hold
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate, now_ms
)
self.assertEqual(estimate, 85000)
self.assertEqual(self.rate_control.near_max, True)
now_ms += 1000
# still normal -> additive increase
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate, now_ms
)
self.assertEqual(estimate, 94444)
self.assertEqual(self.rate_control.near_max, True)
now_ms += 1000
# overuse -> hold
estimate = self.rate_control.update(
BandwidthUsage.OVERUSING, acked_bitrate, now_ms
)
self.assertEqual(estimate, 85000)
self.assertEqual(self.rate_control.near_max, True)
now_ms += 1000
def test_clear_max_throughput(self):
normal_bitrate = 100000
high_bitrate = 150000
now_ms = 0
self.rate_control.set_estimate(normal_bitrate, now_ms)
self.rate_control.update(BandwidthUsage.NORMAL, normal_bitrate, now_ms)
now_ms += 1000
# overuse
self.rate_control.update(BandwidthUsage.OVERUSING, normal_bitrate, now_ms)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, 100.0)
now_ms += 1000
# stable
self.rate_control.update(BandwidthUsage.NORMAL, normal_bitrate, now_ms)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, 100.0)
now_ms += 1000
# large increase in throughput
self.rate_control.update(BandwidthUsage.NORMAL, high_bitrate, now_ms)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, None)
now_ms += 1000
# overuse
self.rate_control.update(BandwidthUsage.OVERUSING, high_bitrate, now_ms)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, 150.0)
now_ms += 1000
# overuse and large decrease in throughput
self.rate_control.update(BandwidthUsage.OVERUSING, normal_bitrate, now_ms)
self.assertEqual(self.rate_control.avg_max_bitrate_kbps, 100.0)
now_ms += 1000
def test_bwe_limited_by_acked_bitrate(self):
acked_bitrate = 10000
self.rate_control.set_estimate(acked_bitrate, 0)
for now_ms in range(0, 20000, 100):
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate, now_ms
)
self.assertEqual(estimate, 25000)
def test_bwe_not_limited_by_decreasing_acked_bitrate(self):
acked_bitrate = 100000
self.rate_control.set_estimate(acked_bitrate, 0)
for now_ms in range(0, 20000, 100):
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate, now_ms
)
self.assertEqual(estimate, 160000)
# estimate doesn't change
estimate = self.rate_control.update(
BandwidthUsage.NORMAL, acked_bitrate // 2, now_ms
)
self.assertEqual(estimate, 160000)
class InterArrivalTest(TestCase):
def setUp(self):
self.inter_arrival_ast = InterArrival(
abs_send_time(TIMESTAMP_GROUP_LENGTH_US), 1000 / (1 << 26)
)
self.inter_arrival_rtp = InterArrival(
rtp_timestamp(TIMESTAMP_GROUP_LENGTH_US), 1 / 9
)
def assertComputed(
self,
timestamp_us,
arrival_time_ms,
packet_size,
timestamp_delta_us,
arrival_time_delta_ms,
packet_size_delta,
timestamp_near=0,
):
# AbsSendTime
deltas = self.inter_arrival_ast.compute_deltas(
abs_send_time(timestamp_us), arrival_time_ms, packet_size
)
self.assertIsNotNone(deltas)
self.assertAlmostEqual(
deltas.timestamp,
abs_send_time(timestamp_delta_us),
delta=timestamp_near << 8,
)
self.assertEqual(deltas.arrival_time, arrival_time_delta_ms)
self.assertEqual(deltas.size, packet_size_delta)
# RtpTimestamp
deltas = self.inter_arrival_rtp.compute_deltas(
rtp_timestamp(timestamp_us), arrival_time_ms, packet_size
)
self.assertIsNotNone(deltas)
self.assertAlmostEqual(
deltas.timestamp, rtp_timestamp(timestamp_delta_us), delta=timestamp_near
)
self.assertEqual(deltas.arrival_time, arrival_time_delta_ms)
self.assertEqual(deltas.size, packet_size_delta)
def assertNotComputed(self, timestamp_us, arrival_time_ms, packet_size):
self.assertIsNone(
self.inter_arrival_ast.compute_deltas(
abs_send_time(timestamp_us), arrival_time_ms, packet_size
)
)
self.assertIsNone(
self.inter_arrival_rtp.compute_deltas(
rtp_timestamp(timestamp_us), arrival_time_ms, packet_size
)
)
def wrapTest(self, wrap_start_us, unorderly_within_group):
timestamp_near = 1
# G1
arrival_time = 17
self.assertNotComputed(0, arrival_time, 1)
# G2
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(wrap_start_us // 4, arrival_time, 1)
# G3
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
wrap_start_us // 2, arrival_time, 1, wrap_start_us // 4, 6, 0
)
# G4
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
wrap_start_us // 2 + wrap_start_us // 4,
arrival_time,
1,
wrap_start_us // 4,
6,
0,
timestamp_near,
)
g4_arrival_time = arrival_time
# G5
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
wrap_start_us, arrival_time, 2, wrap_start_us // 4, 6, 0, timestamp_near
)
for i in range(10):
arrival_time += BURST_THRESHOLD_MS + 1
if unorderly_within_group:
self.assertNotComputed(
wrap_start_us + (9 - i) * MIN_STEP_US, arrival_time, 1
)
else:
self.assertNotComputed(wrap_start_us + i * MIN_STEP_US, arrival_time, 1)
g5_arrival_time = arrival_time
# out of order
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(wrap_start_us - 100, arrival_time, 100)
# G6
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
wrap_start_us + TRIGGER_NEW_GROUP_US,
arrival_time,
10,
wrap_start_us // 4 + 9 * MIN_STEP_US,
g5_arrival_time - g4_arrival_time,
11,
timestamp_near,
)
g6_arrival_time = arrival_time
# out of order
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(
wrap_start_us + TIMESTAMP_GROUP_LENGTH_US, arrival_time, 100
)
# G7
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
wrap_start_us + 2 * TRIGGER_NEW_GROUP_US,
arrival_time,
10,
TRIGGER_NEW_GROUP_US - 9 * MIN_STEP_US,
g6_arrival_time - g5_arrival_time,
-2,
timestamp_near,
)
def test_first_packet(self):
self.assertNotComputed(0, 17, 1)
def test_first_group(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, arrival_time, 2)
g2_arrival_time = arrival_time
# G3
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
timestamp,
arrival_time,
1,
TRIGGER_NEW_GROUP_US,
g2_arrival_time - g1_arrival_time,
1,
)
def test_second_group(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, arrival_time, 2)
g2_arrival_time = arrival_time
# G3
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
timestamp,
arrival_time,
1,
TRIGGER_NEW_GROUP_US,
g2_arrival_time - g1_arrival_time,
1,
)
g3_arrival_time = arrival_time
# G4
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
timestamp,
arrival_time,
2,
TRIGGER_NEW_GROUP_US,
g3_arrival_time - g2_arrival_time,
-1,
)
def test_accumulated_group(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_timestamp = timestamp
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, 28, 2)
for i in range(10):
timestamp += MIN_STEP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, arrival_time, 1)
g2_timestamp = timestamp
g2_arrival_time = arrival_time
# G3
timestamp = 2 * TRIGGER_NEW_GROUP_US
arrival_time = 500
self.assertComputed(
timestamp,
arrival_time,
100,
g2_timestamp - g1_timestamp,
g2_arrival_time - g1_arrival_time,
11,
)
def test_out_of_order_packet(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_timestamp = timestamp
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += 11
self.assertNotComputed(timestamp, 28, 2)
for i in range(10):
timestamp += MIN_STEP_US
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, arrival_time, 1)
g2_timestamp = timestamp
g2_arrival_time = arrival_time
# out of order packet
arrival_time = 281
self.assertNotComputed(g1_timestamp, arrival_time, 1)
# G3
timestamp = 2 * TRIGGER_NEW_GROUP_US
arrival_time = 500
self.assertComputed(
timestamp,
arrival_time,
100,
g2_timestamp - g1_timestamp,
g2_arrival_time - g1_arrival_time,
11,
)
def test_out_of_order_within_group(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_timestamp = timestamp
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time += 11
self.assertNotComputed(timestamp, 28, 2)
timestamp += 10 * MIN_STEP_US
g2_timestamp = timestamp
for i in range(10):
arrival_time += BURST_THRESHOLD_MS + 1
self.assertNotComputed(timestamp, arrival_time, 1)
timestamp -= MIN_STEP_US
g2_arrival_time = arrival_time
# out of order packet
arrival_time = 281
self.assertNotComputed(g1_timestamp, arrival_time, 1)
# G3
timestamp = 2 * TRIGGER_NEW_GROUP_US
arrival_time = 500
self.assertComputed(
timestamp,
arrival_time,
100,
g2_timestamp - g1_timestamp,
g2_arrival_time - g1_arrival_time,
11,
)
def test_two_bursts(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_timestamp = timestamp
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time = 100
for i in range(10):
timestamp += 30000
arrival_time += BURST_THRESHOLD_MS
self.assertNotComputed(timestamp, arrival_time, 1)
g2_timestamp = timestamp
g2_arrival_time = arrival_time
# G3
timestamp += 30000
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
timestamp,
arrival_time,
100,
g2_timestamp - g1_timestamp,
g2_arrival_time - g1_arrival_time,
9,
)
def test_no_bursts(self):
# G1
timestamp = 0
arrival_time = 17
self.assertNotComputed(timestamp, arrival_time, 1)
g1_timestamp = timestamp
g1_arrival_time = arrival_time
# G2
timestamp += TRIGGER_NEW_GROUP_US
arrival_time = 28
self.assertNotComputed(timestamp, arrival_time, 2)
g2_timestamp = timestamp
g2_arrival_time = arrival_time
# G3
timestamp += 30000
arrival_time += BURST_THRESHOLD_MS + 1
self.assertComputed(
timestamp,
arrival_time,
100,
g2_timestamp - g1_timestamp,
g2_arrival_time - g1_arrival_time,
1,
)
def test_wrap_abs_send_time(self):
self.wrapTest(START_ABS_SEND_TIME_WRAP_US, False)
def test_wrap_abs_send_time_out_of_order_within_group(self):
self.wrapTest(START_ABS_SEND_TIME_WRAP_US, True)
def test_wrap_rtp_timestamp(self):
self.wrapTest(START_RTP_TIMESTAMP_WRAP_US, False)
def test_wrap_rtp_timestamp_out_of_order_within_group(self):
self.wrapTest(START_RTP_TIMESTAMP_WRAP_US, True)
class OveruseDetectorTest(TestCase):
def setUp(self):
self.timestamp_to_ms = 1 / 90
self.detector = OveruseDetector()
self.estimator = OveruseEstimator()
self.inter_arrival = InterArrival(5 * 90, 1 / 9)
self.packet_size = 1200
self.now_ms = 0
self.receive_time_ms = 0
self.rtp_timestamp = 900
random.seed(21)
def test_simple_non_overuse_30fps(self):
frame_duration_ms = 33
for i in range(1000):
self.update_detector(self.rtp_timestamp, self.now_ms)
self.now_ms += frame_duration_ms
self.rtp_timestamp += frame_duration_ms * 90
self.assertEqual(self.detector.state(), BandwidthUsage.NORMAL)
def test_simple_non_overuse_with_receive_variance(self):
frame_duration_ms = 10
for i in range(1000):
self.update_detector(self.rtp_timestamp, self.now_ms)
self.rtp_timestamp += frame_duration_ms * 90
if i % 2:
self.now_ms += frame_duration_ms - 5
else:
self.now_ms += frame_duration_ms + 5
self.assertEqual(self.detector.state(), BandwidthUsage.NORMAL)
def test_simple_non_overuse_with_rtp_timestamp_variance(self):
frame_duration_ms = 10
for i in range(1000):
self.update_detector(self.rtp_timestamp, self.now_ms)
self.now_ms += frame_duration_ms
if i % 2:
self.rtp_timestamp += (frame_duration_ms - 5) * 90
else:
self.rtp_timestamp += (frame_duration_ms + 5) * 90
self.assertEqual(self.detector.state(), BandwidthUsage.NORMAL)
def test_simple_overuse_2000Kbit_30fps(self):
packets_per_frame = 6
frame_duration_ms = 33
drift_per_frame_ms = 1
sigma_ms = 0
unique_overuse = self.run_100000_samples(
packets_per_frame, frame_duration_ms, sigma_ms
)
self.assertEqual(unique_overuse, 0)
frames_until_overuse = self.run_until_overuse(
packets_per_frame, frame_duration_ms, sigma_ms, drift_per_frame_ms
)
self.assertEqual(frames_until_overuse, 7)
def test_simple_overuse_100Kbit_10fps(self):
packets_per_frame = 1
frame_duration_ms = 100
drift_per_frame_ms = 1
sigma_ms = 0
unique_overuse = self.run_100000_samples(
packets_per_frame, frame_duration_ms, sigma_ms
)
self.assertEqual(unique_overuse, 0)
frames_until_overuse = self.run_until_overuse(
packets_per_frame, frame_duration_ms, sigma_ms, drift_per_frame_ms
)
self.assertEqual(frames_until_overuse, 7)
def test_overuse_with_low_variance_2000Kbit_30fps(self):
frame_duration_ms = 33
drift_per_frame_ms = 1
self.rtp_timestamp = frame_duration_ms * 90
offset = 0
# run 1000 samples to reach steady state
for i in range(1000):
for j in range(6):
self.update_detector(self.rtp_timestamp, self.now_ms)
self.rtp_timestamp += frame_duration_ms * 90
if i % 2:
offset = random.randint(0, 1)
self.now_ms += frame_duration_ms - offset
else:
self.now_ms += frame_duration_ms + offset
self.assertEqual(self.detector.state(), BandwidthUsage.NORMAL)
# simulate a higher send pace, that is too high.
for i in range(3):
for j in range(6):
self.update_detector(self.rtp_timestamp, self.now_ms)
self.now_ms += frame_duration_ms + drift_per_frame_ms * 6
self.rtp_timestamp += frame_duration_ms * 90
self.assertEqual(self.detector.state(), BandwidthUsage.NORMAL)
self.update_detector(self.rtp_timestamp, self.now_ms)
self.assertEqual(self.detector.state(), BandwidthUsage.OVERUSING)
def test_low_gaussian_variance_fast_drift_30Kbit_3fps(self):
packets_per_frame = 1
frame_duration_ms = 333
drift_per_frame_ms = 100
sigma_ms = 3
unique_overuse = self.run_100000_samples(
packets_per_frame, frame_duration_ms, sigma_ms
)
self.assertEqual(unique_overuse, 0)
frames_until_overuse = self.run_until_overuse(
packets_per_frame, frame_duration_ms, sigma_ms, drift_per_frame_ms
)
self.assertEqual(frames_until_overuse, 4)
def test_high_haussian_variance_30Kbit_3fps(self):
packets_per_frame = 1
frame_duration_ms = 333
drift_per_frame_ms = 1
sigma_ms = 10
unique_overuse = self.run_100000_samples(
packets_per_frame, frame_duration_ms, sigma_ms
)
self.assertEqual(unique_overuse, 0)
frames_until_overuse = self.run_until_overuse(
packets_per_frame, frame_duration_ms, sigma_ms, drift_per_frame_ms
)
self.assertEqual(frames_until_overuse, 44)
def run_100000_samples(self, packets_per_frame, mean_ms, standard_deviation_ms):
unique_overuse = 0
last_overuse = -1
for i in range(100000):
for j in range(packets_per_frame):
self.update_detector(self.rtp_timestamp, self.receive_time_ms)
self.rtp_timestamp += mean_ms * 90
self.now_ms += mean_ms
self.receive_time_ms = max(
self.receive_time_ms,
int(self.now_ms + random.normal(0, standard_deviation_ms) + 0.5),
)
if self.detector.state() == BandwidthUsage.OVERUSING:
if last_overuse + 1 != i:
unique_overuse += 1
last_overuse = i
return unique_overuse
def run_until_overuse(
self, packets_per_frame, mean_ms, standard_deviation_ms, drift_per_frame_ms
):
for i in range(100000):
for j in range(packets_per_frame):
self.update_detector(self.rtp_timestamp, self.receive_time_ms)
self.rtp_timestamp += mean_ms * 90
self.now_ms += mean_ms + drift_per_frame_ms
self.receive_time_ms = max(
self.receive_time_ms,
int(self.now_ms + random.normal(0, standard_deviation_ms) + 0.5),
)
if self.detector.state() == BandwidthUsage.OVERUSING:
return i + 1
return -1
def update_detector(self, timestamp, receive_time_ms):
deltas = self.inter_arrival.compute_deltas(
timestamp, receive_time_ms, self.packet_size
)
if deltas is not None:
timestamp_delta_ms = deltas.timestamp / 90
self.estimator.update(
deltas.arrival_time,
timestamp_delta_ms,
deltas.size,
self.detector.state(),
receive_time_ms,
)
self.detector.detect(
self.estimator.offset(),
timestamp_delta_ms,
self.estimator.num_of_deltas(),
receive_time_ms,
)
class RateCounterTest(TestCase):
def test_constructor(self):
counter = RateCounter(10)
self.assertEqual(
counter._buckets,
[
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
],
)
self.assertIsNone(counter._origin_ms)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._total, RateBucket())
self.assertIsNone(counter.rate(0))
def test_add(self):
counter = RateCounter(10)
counter.add(500, 123)
self.assertEqual(
counter._buckets,
[
RateBucket(1, 500),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
],
)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._origin_ms, 123)
self.assertEqual(counter._total, RateBucket(1, 500))
self.assertIsNone(counter.rate(123))
counter.add(501, 123)
self.assertEqual(
counter._buckets,
[
RateBucket(2, 1001),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
],
)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._origin_ms, 123)
self.assertEqual(counter._total, RateBucket(2, 1001))
self.assertIsNone(counter.rate(123))
counter.add(502, 125)
self.assertEqual(
counter._buckets,
[
RateBucket(2, 1001),
RateBucket(),
RateBucket(1, 502),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
],
)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._origin_ms, 123)
self.assertEqual(counter._total, RateBucket(3, 1503))
self.assertEqual(counter.rate(125), 4008000)
counter.add(503, 128)
self.assertEqual(
counter._buckets,
[
RateBucket(2, 1001),
RateBucket(),
RateBucket(1, 502),
RateBucket(),
RateBucket(),
RateBucket(1, 503),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(),
],
)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._origin_ms, 123)
self.assertEqual(counter._total, RateBucket(4, 2006))
self.assertEqual(counter.rate(128), 2674667)
counter.add(504, 132)
self.assertEqual(
counter._buckets,
[
RateBucket(2, 1001),
RateBucket(),
RateBucket(1, 502),
RateBucket(),
RateBucket(),
RateBucket(1, 503),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(1, 504),
],
)
self.assertEqual(counter._origin_index, 0)
self.assertEqual(counter._origin_ms, 123)
self.assertEqual(counter._total, RateBucket(5, 2510))
self.assertEqual(counter.rate(132), 2008000)
counter.add(505, 134)
self.assertEqual(
counter._buckets,
[
RateBucket(),
RateBucket(1, 505),
RateBucket(1, 502),
RateBucket(),
RateBucket(),
RateBucket(1, 503),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(1, 504),
],
)
self.assertEqual(counter._origin_index, 2)
self.assertEqual(counter._origin_ms, 125)
self.assertEqual(counter._total, RateBucket(4, 2014))
self.assertEqual(counter.rate(134), 1611200)
counter.add(506, 135)
self.assertEqual(
counter._buckets,
[
RateBucket(),
RateBucket(1, 505),
RateBucket(1, 506),
RateBucket(),
RateBucket(),
RateBucket(1, 503),
RateBucket(),
RateBucket(),
RateBucket(),
RateBucket(1, 504),
],
)
self.assertEqual(counter._origin_index, 3)
self.assertEqual(counter._origin_ms, 126)
self.assertEqual(counter._total, RateBucket(4, 2018))
self.assertEqual(counter.rate(135), 1614400)
class Stream:
def __init__(self, capacity):
self.capacity = capacity
self.framerate = 30
self.payload_size = 1500
self.send_time_us = 0
self.arrival_time_us = 0
def generate_frames(self, count):
for i in range(count):
abs_send_time = self.send_time_us * (1 << 18) // 1000000
self.arrival_time_us = max(self.arrival_time_us, self.send_time_us) + round(
(self.payload_size * 8000000) / self.capacity
)
self.send_time_us += 1000000 // self.framerate
yield abs_send_time, self.arrival_time_us // 1000, self.payload_size
class RemoteBitrateEstimatorTest(TestCase):
def test_capacity_drop(self):
estimator = RemoteBitrateEstimator()
stream = Stream(capacity=500000)
target_bitrate = None
for abs_send_time, arrival_time_ms, payload_size in stream.generate_frames(
1000
):
res = estimator.add(
abs_send_time=abs_send_time,
arrival_time_ms=arrival_time_ms,
payload_size=payload_size,
ssrc=1234,
)
if res is not None:
target_bitrate = res[0]
self.assertEqual(target_bitrate, 550000)
# reduce capacity
stream.capacity = 250000
for abs_send_time, arrival_time_ms, payload_size in stream.generate_frames(
1000
):
res = estimator.add(
abs_send_time=abs_send_time,
arrival_time_ms=arrival_time_ms,
payload_size=payload_size,
ssrc=1234,
)
if res is not None:
target_bitrate = res[0]
self.assertEqual(target_bitrate, 214200)
|