vllm.multimodal.video ¶
Classes:
-
DynamicVideoBackend–Duration-aware dynamic-sampling video backend.
-
GLM46VVideoBackend–GLM-4.6V dynamic FPS video backend.
-
Glm5NextVideoBackend–GLM-5.3-Flash fps-interval video backend.
-
Molmo2VideoBackend– -
OpenCVDynamicOpenPanguVideoBackend– -
PyNvVideoCodecVideoBackend–Hardware-accelerated video backend using PyNvVideoCodec.
-
Qwen2VLVideoBackend–Qwen2-VL / Qwen2.5-VL fps-based video backend.
-
VideoBackend–Uniform-sampling video backend.
-
VideoLoader– -
VideoLoaderRegistry–
Attributes:
-
DecodedFrames(TypeAlias) –Decoded video frames: a host
np.ndarray, or a devicetorch.Tensor
DecodedFrames = npt.NDArray | torch.Tensor module-attribute ¶
Decoded video frames: a host np.ndarray, or a device torch.Tensor when a GPU decoding codec is used (e.g. torchcodec with device="cuda").
DynamicVideoBackend ¶
Bases: VideoBackend
Duration-aware dynamic-sampling video backend.
Samples at fps up to max_duration seconds, falling back to uniform sampling across the full duration when the video is longer than max_duration. Codec is selectable the same way as :class:VideoBackend.
Source code in vllm/multimodal/video.py
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 | |
GLM46VVideoBackend ¶
Bases: VideoBackend
GLM-4.6V dynamic FPS video backend.
Faithfully replicates the frame sampling logic from transformers' Glm46VVideoProcessor.sample_frames:
- Dynamic FPS thresholds based on effective video duration:
{≤30s: 3fps, ≤300s: 1fps, >300s: 0.5fps} temporal_patch_sizemultiplier (default 2) applied to extract count- Duration capped at 2400s, frame count capped at 640
- Even frame count enforced (append last frame if odd)
Source code in vllm/multimodal/video.py
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 | |
Glm5NextVideoBackend ¶
Bases: VideoBackend
GLM-5.3-Flash fps-interval video backend.
Selects frames with the same glm_sample_frame_indices sampler the processor falls back to, so only the sampled frames are materialized. fps_interval semantics (default 2.0) with a temporal-patch-scaled greedy walk, frame count capped at 2048, temporal pairs kept even. Request overrides: fps -> fps interval, max_frames -> frame cap, temporal_patch_size (default 2).
Source code in vllm/multimodal/video.py
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 | |
Molmo2VideoBackend ¶
Bases: VideoLoader
Methods:
-
get_candidate_target_fps–Return the subset of
video_fpsfactors that remain multiples -
get_target_fps–Get the target fps that best spans the videoand has the most frames sampled
Source code in vllm/multimodal/video.py
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 | |
get_candidate_target_fps(video_fps, sampling_fps, max_fps=8.0) classmethod ¶
Return the subset of video_fps factors that remain multiples of sampling_fps.
Examples:
>>> get_candidate_target_fps(video_fps=6, sampling_fps=2)
[2, 6]
>>> get_candidate_target_fps(video_fps=5, sampling_fps=1)
[1, 5]
>>> get_candidate_target_fps(video_fps=2, sampling_fps=2)
[2]
>>> get_candidate_target_fps(video_fps=5, sampling_fps=2)
Traceback (most recent call last):
...
ValueError: sampling_fps=2 must divide video_fps=5 to produce
consistent frame steps.
Source code in vllm/multimodal/video.py
get_target_fps(video_fps, max_frames, total_frames, frame_sample_mode, candidate_target_fps) classmethod ¶
Get the target fps that best spans the videoand has the most frames sampled
Source code in vllm/multimodal/video.py
OpenCVDynamicOpenPanguVideoBackend ¶
Bases: VideoLoader
Methods:
-
load_bytes–Load video frames with dynamic sampling based on duration.
Source code in vllm/multimodal/video.py
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 | |
load_bytes(data, num_frames=-1, fps=2, max_duration=300, frame_recovery=False, **kwargs) classmethod ¶
Load video frames with dynamic sampling based on duration.
Parameters:
-
(data¶bytes) –Raw video bytes
-
(num_frames¶int, default:-1) –Not used in dynamic backend
-
(fps¶int, default:2) –Target FPS for sampling (default: 2)
-
(max_duration¶int, default:300) –Maximum video duration to process (default: 300s)
-
(frame_recovery¶bool, default:False) –Enable forward-scan recovery for failed frames
Returns:
Source code in vllm/multimodal/video.py
PyNvVideoCodecVideoBackend ¶
Bases: VideoBackend
Hardware-accelerated video backend using PyNvVideoCodec.
The backend first opens the stream only to read metadata and compute the sampled frame indices. It then acquires the raw decoded RGB byte count from the process-local multimodal GPU memory pool before decoding the selected frames into VRAM. Decoded frames are copied into pinned host memory before the lease is released, so downstream preprocessing continues to receive a CPU np.ndarray in NHWC RGB format.
Source code in vllm/multimodal/video.py
Qwen2VLVideoBackend ¶
Bases: VideoBackend
Qwen2-VL / Qwen2.5-VL fps-based video backend.
Ports transformers' Qwen2VLVideoProcessor.sample_frames (fps mode), shared by Qwen2-VL and Qwen2.5-VL (the latter has no video processor of its own): sample total / original_fps * fps frames, clamp to [min_frames, max_frames] (4 and 768), floor to a multiple of temporal_patch_size (2), and take indices with the exact torch.arange(0, total, total / n) call so they match HF byte-for-byte.
num_frames is ignored (fps-driven, like the Qwen3-VL loader). The float32 step can emit an out-of-range tail index (e.g. 451 for a 451-frame clip); it is clamped to the last valid frame.
Source code in vllm/multimodal/video.py
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 | |
VideoBackend ¶
Bases: VideoLoader
Uniform-sampling video backend.
Samples num_frames uniformly across the video (or one frame every 1/fps seconds, whichever produces fewer frames). The decoding codec is selected via the backend kwarg ("opencv", "torchcodec", "pynvvideocodec", or "deepstream"), which can be passed through --media-io-kwargs. Defaults to "opencv".
Methods:
-
load_bytes–Load sampled frames from raw video bytes.
Source code in vllm/multimodal/video.py
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 | |
load_bytes(data, num_frames=-1, fps=-1, max_duration=300, frame_recovery=False, *, backend='opencv', **kwargs) classmethod ¶
Load sampled frames from raw video bytes.
Parameters:
-
(data¶bytes) –Raw video bytes.
-
(num_frames¶int, default:-1) –Target number of frames to sample (
-1for all). -
(fps¶int, default:-1) –Target FPS for sampling (
-1for original). -
(max_duration¶int, default:300) –Maximum duration in seconds — only used by the dynamic subclass; ignored here.
-
(frame_recovery¶bool, default:False) –Enable forward-scan recovery for failed frames. Only honored by the OpenCV codec.
-
(backend¶VideoDecoderBackend, default:'opencv') –Decoding codec —
"opencv","torchcodec","pynvvideocodec"or"deepstream". -
(kwargs¶Any, default:{}) –Codec-specific options, validated against and forwarded to
backend:num_ffmpeg_threads(TorchCodec): number of FFmpeg decoding threads;0(default) relies on the FFmpeg default value which ismin(cpu_count + 1, 16). OpenCV will always usemin(cpu_count, 16).seek_mode(TorchCodec):"exact"(default) guarantees frame-accurate sampling by scanning the file on creation, while"approximate"skips that scan for faster decoder creation at the cost of relying on the file's metadata. See https://meta-pytorch.org/torchcodec/stable/generated_examples/decoding/approximate_mode.html for details.device(TorchCodec):"cpu"(default) decodes on the host and returns anp.ndarray;"cuda"decodes with NVDEC and returns the frames as a CUDAtorch.Tensor, which a device-side HF video processor can consume without a host round-trip.hw_decoders(PyNvVideoCodec): maximum number of concurrent decoder slots. Defaults to 2 and must be a positive integer.pool_size/timeout_sec(DeepStream): decoder pool size and pool acquisition timeout in seconds.
Returns:
-
DecodedFrames–Tuple of
(frames, metadata_dict), whereframesis a -
dict[str, Any]–CPU
np.ndarrayunless TorchCodec decodes ondevice="cuda".
Source code in vllm/multimodal/video.py
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 | |
VideoLoader ¶
Methods:
-
compute_frames_index_to_sample–Return the list of frame indices to sample from the video.
-
load_bytes–Load video frames from bytes and return (frames, metadata_dict).
Source code in vllm/multimodal/video.py
_prepare_source(source) classmethod ¶
compute_frames_index_to_sample(source, target, **kwargs) classmethod ¶
Return the list of frame indices to sample from the video.
Source code in vllm/multimodal/video.py
load_bytes(data, **kwargs) abstractmethod classmethod ¶
Load video frames from bytes and return (frames, metadata_dict).
frames is a CPU np.ndarray unless a GPU decoding codec is used (e.g. torchcodec with device="cuda"), in which case it is a torch.Tensor living on that device.
Source code in vllm/multimodal/video.py
VideoLoaderRegistry ¶
Bases: ExtensionManager
Methods:
-
register_gpu_codec–Mark a codec name as requiring GPU without registering a loader.