Repository navigation
Expand file tree
/
Copy pathmtmd_cpp.py
More file actions
1429 lines (1194 loc) · 44.3 KB
/
Copy pathmtmd_cpp.py
File metadata and controls
1429 lines (1194 loc) · 44.3 KB
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
from __future__ import annotations
import os
import warnings
from ctypes import (
CFUNCTYPE,
c_bool,
c_char,
c_char_p,
c_int,
c_int32,
c_int64,
c_uint8,
c_uint32,
c_size_t,
c_float,
c_void_p,
POINTER,
_Pointer, # type: ignore
Structure,
byref,
)
import pathlib
from typing import (
Callable,
Union,
NewType,
Optional,
TYPE_CHECKING,
)
import llama_cpp.llama_cpp as llama_cpp
from llama_cpp._ctypes_extensions import (
load_shared_library,
ctypes_function_for_shared_library,
)
if TYPE_CHECKING:
from llama_cpp._ctypes_extensions import (
CtypesArray,
)
# Specify the base name of the shared library to load
_libmtmd_base_name = "mtmd"
_libmtmd_override_path = os.environ.get("MTMD_CPP_LIB")
_libmtmd_base_path = (
pathlib.Path(os.path.abspath(os.path.dirname(__file__))) / "lib"
if _libmtmd_override_path is None
else pathlib.Path(_libmtmd_override_path)
)
# Load the library
_libmtmd = load_shared_library(_libmtmd_base_name, _libmtmd_base_path)
ctypes_function = ctypes_function_for_shared_library(_libmtmd)
################################################
# mtmd.h types
################################################
# Opaque types
mtmd_context_p = NewType("mtmd_context_p", int)
mtmd_context_p_ctypes = c_void_p
mtmd_bitmap_p = NewType("mtmd_bitmap_p", int)
mtmd_bitmap_p_ctypes = c_void_p
mtmd_helper_video_p = NewType("mtmd_helper_video_p", int)
mtmd_helper_video_p_ctypes = c_void_p
mtmd_helper_gen_audio_p = NewType("mtmd_helper_gen_audio_p", int)
mtmd_helper_gen_audio_p_ctypes = c_void_p
mtmd_image_tokens_p = NewType("mtmd_image_tokens_p", int)
mtmd_image_tokens_p_ctypes = c_void_p
mtmd_input_chunk_p = NewType("mtmd_input_chunk_p", int)
mtmd_input_chunk_p_ctypes = c_void_p
mtmd_input_chunks_p = NewType("mtmd_input_chunks_p", int)
mtmd_input_chunks_p_ctypes = c_void_p
mtmd_batch_p = NewType("mtmd_batch_p", int)
mtmd_batch_p_ctypes = c_void_p
# Enums
MTMD_INPUT_CHUNK_TYPE_TEXT = 0
MTMD_INPUT_CHUNK_TYPE_IMAGE = 1
MTMD_INPUT_CHUNK_TYPE_AUDIO = 2
MTMD_INPUT_CHUNK_TYPE_COUNT = 3
MTMD_GEN_AUDIO_TYPE_NONE = 0
MTMD_GEN_AUDIO_TYPE_QWEN3TTS = 1
MTMD_GEN_AUDIO_TYPE_POCKETTTS = 2
MTMD_GEN_PROCESS_TYPE_GEN_CODE = 0
MTMD_GEN_PROCESS_TYPE_GEN_WAV = 1
MTMD_HELPER_GEN_AUDIO_OUTTYPE_PCM = 0
MTMD_HELPER_GEN_AUDIO_OUTTYPE_WAV = 1
mtmd_progress_callback = CFUNCTYPE(c_bool, c_float, c_void_p)
# Structures
class mtmd_context_params(Structure):
"""Context parameters for MTMD initialization.
`image_marker` is deprecated upstream and kept for compatibility; use
`media_marker` for multimodal prompt placeholders.
"""
if TYPE_CHECKING:
use_gpu: bool
print_timings: bool
n_threads: int
image_marker: Optional[bytes]
media_marker: Optional[bytes]
flash_attn_type: int
warmup: bool
image_min_tokens: int
image_max_tokens: int
cb_eval: llama_cpp.ggml_backend_sched_eval_callback
cb_eval_user_data: c_void_p
batch_max_tokens: int
progress_callback: Callable[[float, c_void_p], bool]
progress_callback_user_data: c_void_p
_fields_ = [
("use_gpu", c_bool),
("print_timings", c_bool),
("n_threads", c_int),
("image_marker", c_char_p),
("media_marker", c_char_p),
("flash_attn_type", c_int),
("warmup", c_bool),
("image_min_tokens", c_int),
("image_max_tokens", c_int),
("cb_eval", llama_cpp.ggml_backend_sched_eval_callback),
("cb_eval_user_data", c_void_p),
("batch_max_tokens", c_int),
("progress_callback", mtmd_progress_callback),
("progress_callback_user_data", c_void_p),
]
class mtmd_input_text(Structure):
"""Text input passed to `mtmd_tokenize`."""
if TYPE_CHECKING:
text: Optional[bytes]
text_len: int
add_special: bool
parse_special: bool
_fields_ = [
("text", c_char_p),
("text_len", c_size_t),
("add_special", c_bool),
("parse_special", c_bool),
]
class mtmd_decoder_pos(Structure):
"""Decoder attention position for M-RoPE models."""
_fields_ = [
("t", c_uint32),
("x", c_uint32),
("y", c_uint32),
("z", c_uint32),
]
# struct mtmd_caps {
# bool inp_vision;
# bool inp_audio;
# };
class mtmd_caps(Structure):
"""Capabilities exposed by an mmproj file."""
if TYPE_CHECKING:
inp_vision: bool
inp_audio: bool
_fields_ = [
("inp_vision", c_bool),
("inp_audio", c_bool),
]
# struct mtmd_gen_audio_info {
# enum mtmd_gen_audio_type type;
# int32_t sample_rate; // in Hz, for example 24000 for qwen3tts
# const char * model_variant; // name of the weight variant, can be None if not applicable
# };
class mtmd_gen_audio_info(Structure):
if TYPE_CHECKING:
type: int
sample_rate: int
model_variant: Optional[bytes]
_fields_ = [
("type", c_int),
("sample_rate", c_int32),
("model_variant", c_char_p),
]
# struct mtmd_gen_inp {
# enum mtmd_gen_process_type type;
#
# // for MTMD_GEN_PROCESS_TYPE_GEN_CODE
# int32_t code0; // the sampled codebook 0 entry from backbone
# float * embd; // the hidden state from backbone, must have n_text_embd elements
# int32_t top_k;
# float top_p;
# uint32_t seed; // UINT32_MAX for random
# float temp; // sampling temperature, or noise scale for flow-matching decoders
#
# // for MTMD_GEN_PROCESS_TYPE_GEN_WAV
# // pass either codes (discrete) or feats (continuous), depending on the pipeline
# int32_t * codes;
# size_t n_codes;
# const float * feats;
# size_t n_feats;
# const char * state_data;
# size_t state_size;
# };
class mtmd_gen_inp(Structure):
if TYPE_CHECKING:
type: int
code0: int
embd: Optional["_Pointer[c_float]"]
top_k: int
top_p: float
seed: int
temp: float
codes: Optional["_Pointer[c_int32]"]
n_codes: int
feats: Optional["_Pointer[c_float]"]
n_feats: int
state_data: Optional["_Pointer[c_char]"]
state_size: int
_fields_ = [
("type", c_int),
("code0", c_int32),
("embd", POINTER(c_float)),
("top_k", c_int32),
("top_p", c_float),
("seed", c_uint32),
("temp", c_float),
("codes", POINTER(c_int32)),
("n_codes", c_size_t),
("feats", POINTER(c_float)),
("n_feats", c_size_t),
("state_data", POINTER(c_char)),
("state_size", c_size_t),
]
# struct mtmd_gen_out {
# // note: output memory is allocated by the context, valid until next process() call
#
# // for MTMD_GEN_PROCESS_TYPE_GEN_CODE
# const int32_t * codes;
# size_t n_codes;
# const float * feats; // continuous counterpart of codes
# size_t n_feats;
# const float * embd; // the generated hidden state, to be fed back to backbone
# // it must have n_text_embd elements
# bool is_eos; // only set by pipelines having the EOS head inside mmproj
#
# // for MTMD_GEN_PROCESS_TYPE_GEN_WAV
# const float * audio;
# size_t n_samples;
# const char * state_data;
# size_t state_size;
# };
class mtmd_gen_out(Structure):
if TYPE_CHECKING:
codes: Optional["_Pointer[c_int32]"]
n_codes: int
feats: Optional["_Pointer[c_float]"]
n_feats: int
embd: Optional["_Pointer[c_float]"]
is_eos: bool
audio: Optional["_Pointer[c_float]"]
n_samples: int
state_data: Optional["_Pointer[c_char]"]
state_size: int
_fields_ = [
("codes", POINTER(c_int32)),
("n_codes", c_size_t),
("feats", POINTER(c_float)),
("n_feats", c_size_t),
("embd", POINTER(c_float)),
("is_eos", c_bool),
("audio", POINTER(c_float)),
("n_samples", c_size_t),
("state_data", POINTER(c_char)),
("state_size", c_size_t),
]
mtmd_bitmap_lazy_callback = CFUNCTYPE(
c_int,
c_size_t,
c_void_p,
POINTER(mtmd_bitmap_p_ctypes),
POINTER(c_char_p),
)
mtmd_helper_post_decode_callback = CFUNCTYPE(
c_int,
llama_cpp.llama_batch,
c_void_p,
)
class mtmd_helper_bitmap_wrapper(Structure):
"""Bitmap wrapper returned by MTMD helper media loaders."""
if TYPE_CHECKING:
bitmap: Optional[mtmd_bitmap_p]
video_ctx: Optional[mtmd_helper_video_p]
_fields_ = [
("bitmap", mtmd_bitmap_p_ctypes),
("video_ctx", mtmd_helper_video_p_ctypes),
]
class mtmd_helper_video_info(Structure):
"""Metadata for a decoded video stream."""
if TYPE_CHECKING:
width: int
height: int
fps: float
n_frames: int
_fields_ = [
("width", c_uint32),
("height", c_uint32),
("fps", c_float),
("n_frames", c_int),
]
class mtmd_helper_video_init_params(Structure):
"""Parameters for initializing an MTMD helper video stream."""
if TYPE_CHECKING:
fps_target: float
ffmpeg_bin_dir: Optional[bytes]
timestamp_interval_ms: int
_fields_ = [
("fps_target", c_float),
("ffmpeg_bin_dir", c_char_p),
("timestamp_interval_ms", c_int64),
]
# struct mtmd_helper_gen_audio_inp {
# llama_seq_id seq_id;
#
# const char * prompt;
# size_t prompt_len;
#
# mtmd_bitmap * speaker_ref; // optional, can be NULL
# const char * lang; // optional, can be NULL
#
# int32_t top_k;
# float top_p;
# uint32_t seed; // UINT32_MAX for random (default: random)
#
# enum mtmd_helper_gen_audio_outtype out_type;
# };
class mtmd_helper_gen_audio_inp(Structure):
if TYPE_CHECKING:
seq_id: int
prompt: Optional[bytes]
prompt_len: int
speaker_ref: Optional[mtmd_bitmap_p]
lang: Optional[bytes]
top_k: int
top_p: float
seed: int
out_type: int
_fields_ = [
("seq_id", llama_cpp.llama_seq_id),
("prompt", c_char_p),
("prompt_len", c_size_t),
("speaker_ref", mtmd_bitmap_p_ctypes),
("lang", c_char_p),
("top_k", c_int32),
("top_p", c_float),
("seed", c_uint32),
("out_type", c_int),
]
################################################
# mtmd.h functions
################################################
# MTMD_API const char * mtmd_default_marker(void);
@ctypes_function("mtmd_default_marker", [], c_char_p)
def mtmd_default_marker() -> bytes:
"""Return the default media marker."""
...
# MTMD_API struct mtmd_context_params mtmd_context_params_default(void);
@ctypes_function("mtmd_context_params_default", [], mtmd_context_params)
def mtmd_context_params_default() -> mtmd_context_params:
"""Return the default MTMD context parameters."""
...
# MTMD_API mtmd_context * mtmd_init_from_file(const char * mmproj_fname,
# const struct llama_model * text_model,
# const struct mtmd_context_params ctx_params);
@ctypes_function(
"mtmd_init_from_file",
[c_char_p, llama_cpp.llama_model_p_ctypes, mtmd_context_params],
mtmd_context_p_ctypes,
)
def mtmd_init_from_file(
mmproj_fname: bytes,
text_model: llama_cpp.llama_model_p,
ctx_params: mtmd_context_params,
/,
) -> Optional[mtmd_context_p]:
"""Initialize the MTMD context from a projector file. Returns None on failure."""
...
# MTMD_API void mtmd_free(mtmd_context * ctx);
@ctypes_function("mtmd_free", [mtmd_context_p_ctypes], None)
def mtmd_free(ctx: mtmd_context_p, /): ...
# MTMD_API bool mtmd_decode_use_non_causal(const mtmd_context * ctx, const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_decode_use_non_causal",
[mtmd_context_p_ctypes, mtmd_input_chunk_p_ctypes],
c_bool,
)
def mtmd_decode_use_non_causal(
ctx: mtmd_context_p, chunk: Optional[mtmd_input_chunk_p], /
) -> bool:
"""Check whether MTMD decoding uses non-causal attention."""
...
# MTMD_API bool mtmd_decode_use_mrope(const mtmd_context * ctx);
@ctypes_function("mtmd_decode_use_mrope", [mtmd_context_p_ctypes], c_bool)
def mtmd_decode_use_mrope(ctx: mtmd_context_p, /) -> bool:
"""Check whether MTMD decoding uses mRoPE."""
...
# MTMD_API bool mtmd_support_vision(const mtmd_context * ctx);
@ctypes_function("mtmd_support_vision", [mtmd_context_p_ctypes], c_bool)
def mtmd_support_vision(ctx: mtmd_context_p, /) -> bool:
"""Check whether the current model supports vision input."""
...
# MTMD_API bool mtmd_support_audio(const mtmd_context * ctx);
@ctypes_function("mtmd_support_audio", [mtmd_context_p_ctypes], c_bool)
def mtmd_support_audio(ctx: mtmd_context_p, /) -> bool:
"""Check whether MTMD supports audio."""
...
# MTMD_API int mtmd_get_audio_sample_rate(const mtmd_context * ctx);
@ctypes_function("mtmd_get_audio_sample_rate", [mtmd_context_p_ctypes], c_int)
def mtmd_get_audio_sample_rate(ctx: mtmd_context_p, /) -> int:
"""Get the audio sample rate in Hz. Returns -1 if audio is not supported."""
...
# MTMD_API const char * mtmd_get_marker(const mtmd_context * ctx);
@ctypes_function("mtmd_get_marker", [mtmd_context_p_ctypes], c_char_p)
def mtmd_get_marker(ctx: mtmd_context_p, /) -> Optional[bytes]:
"""Get the current media marker string."""
...
# Deprecated compatibility wrapper for the renamed mtmd_get_audio_sample_rate().
def mtmd_get_audio_bitrate(ctx: mtmd_context_p, /) -> int:
warnings.warn(
"mtmd_get_audio_bitrate is deprecated; use mtmd_get_audio_sample_rate instead",
DeprecationWarning,
stacklevel=2,
)
return mtmd_get_audio_sample_rate(ctx)
# MTMD_API mtmd_bitmap * mtmd_bitmap_init(uint32_t nx, uint32_t ny, const unsigned char * data);
@ctypes_function(
"mtmd_bitmap_init", [c_uint32, c_uint32, POINTER(c_uint8)], mtmd_bitmap_p_ctypes
)
def mtmd_bitmap_init(
nx: Union[c_uint32, int],
ny: Union[c_uint32, int],
data: CtypesArray[c_uint8],
/,
) -> Optional[mtmd_bitmap_p]: ...
# MTMD_API mtmd_bitmap * mtmd_bitmap_init_from_audio(size_t n_samples, const float * data);
@ctypes_function(
"mtmd_bitmap_init_from_audio",
[c_size_t, POINTER(c_float)],
mtmd_bitmap_p_ctypes,
)
def mtmd_bitmap_init_from_audio(
n_samples: Union[c_size_t, int],
data: CtypesArray[c_float],
/,
) -> Optional[mtmd_bitmap_p]:
"""Initialize an MTMD bitmap from audio samples."""
...
# MTMD_API void mtmd_bitmap_free(mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_free", [mtmd_bitmap_p_ctypes], None)
def mtmd_bitmap_free(bitmap: mtmd_bitmap_p, /): ...
# MTMD_API uint32_t mtmd_bitmap_get_nx(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_get_nx", [mtmd_bitmap_p_ctypes], c_uint32)
def mtmd_bitmap_get_nx(bitmap: mtmd_bitmap_p, /) -> int:
"""Get the bitmap width in pixels."""
...
# MTMD_API uint32_t mtmd_bitmap_get_ny(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_get_ny", [mtmd_bitmap_p_ctypes], c_uint32)
def mtmd_bitmap_get_ny(bitmap: mtmd_bitmap_p, /) -> int:
"""Get the bitmap height in pixels."""
...
# MTMD_API const unsigned char * mtmd_bitmap_get_data(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_get_data", [mtmd_bitmap_p_ctypes], POINTER(c_uint8))
def mtmd_bitmap_get_data(bitmap: mtmd_bitmap_p, /) -> Optional[CtypesArray[c_uint8]]:
"""Get the raw bitmap data buffer."""
...
# MTMD_API size_t mtmd_bitmap_get_n_bytes(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_get_n_bytes", [mtmd_bitmap_p_ctypes], c_size_t)
def mtmd_bitmap_get_n_bytes(bitmap: mtmd_bitmap_p, /) -> int:
"""Get the bitmap data size in bytes."""
...
# MTMD_API bool mtmd_bitmap_is_audio(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_is_audio", [mtmd_bitmap_p_ctypes], c_bool)
def mtmd_bitmap_is_audio(bitmap: mtmd_bitmap_p, /) -> bool:
"""Check whether the bitmap contains audio data."""
...
# MTMD_API const char * mtmd_bitmap_get_id(const mtmd_bitmap * bitmap);
@ctypes_function("mtmd_bitmap_get_id", [mtmd_bitmap_p_ctypes], c_char_p)
def mtmd_bitmap_get_id(bitmap: mtmd_bitmap_p, /) -> Optional[bytes]:
"""Get the optional bitmap identifier."""
...
# MTMD_API void mtmd_bitmap_set_id(mtmd_bitmap * bitmap, const char * id);
@ctypes_function("mtmd_bitmap_set_id", [mtmd_bitmap_p_ctypes, c_char_p], None)
def mtmd_bitmap_set_id(bitmap: mtmd_bitmap_p, id: Optional[bytes], /):
"""Set the optional bitmap identifier."""
...
# MTMD_API mtmd_bitmap * mtmd_bitmap_init_lazy(mtmd_context * ctx,
# const char * id,
# void * user_data,
# mtmd_bitmap_lazy_callback callback);
@ctypes_function(
"mtmd_bitmap_init_lazy",
[mtmd_context_p_ctypes, c_char_p, c_void_p, mtmd_bitmap_lazy_callback],
mtmd_bitmap_p_ctypes,
)
def mtmd_bitmap_init_lazy(
ctx: mtmd_context_p,
id: Optional[bytes],
user_data: c_void_p,
callback: mtmd_bitmap_lazy_callback,
/,
) -> Optional[mtmd_bitmap_p]:
"""Initialize a lazy MTMD bitmap."""
...
# MTMD_API mtmd_input_chunks * mtmd_input_chunks_init(void);
@ctypes_function("mtmd_input_chunks_init", [], mtmd_input_chunks_p_ctypes)
def mtmd_input_chunks_init() -> Optional[mtmd_input_chunks_p]: ...
# MTMD_API void mtmd_input_chunks_free(mtmd_input_chunks * chunks);
@ctypes_function("mtmd_input_chunks_free", [mtmd_input_chunks_p_ctypes], None)
def mtmd_input_chunks_free(chunks: mtmd_input_chunks_p, /): ...
# MTMD_API size_t mtmd_input_chunks_size(const mtmd_input_chunks * chunks);
@ctypes_function("mtmd_input_chunks_size", [mtmd_input_chunks_p_ctypes], c_size_t)
def mtmd_input_chunks_size(chunks: mtmd_input_chunks_p, /) -> int: ...
# MTMD_API const mtmd_input_chunk * mtmd_input_chunks_get(const mtmd_input_chunks * chunks, size_t idx);
@ctypes_function(
"mtmd_input_chunks_get",
[mtmd_input_chunks_p_ctypes, c_size_t],
mtmd_input_chunk_p_ctypes,
)
def mtmd_input_chunks_get(
chunks: mtmd_input_chunks_p, idx: Union[c_size_t, int], /
) -> Optional[mtmd_input_chunk_p]: ...
# MTMD_API int32_t mtmd_tokenize(mtmd_context * ctx,
# mtmd_input_chunks * output,
# const mtmd_input_text * text,
# const mtmd_bitmap ** bitmaps,
# size_t n_bitmaps);
@ctypes_function(
"mtmd_tokenize",
[
mtmd_context_p_ctypes,
mtmd_input_chunks_p_ctypes,
POINTER(mtmd_input_text),
POINTER(mtmd_bitmap_p_ctypes),
c_size_t,
],
c_int,
)
def mtmd_tokenize(
ctx: mtmd_context_p,
output: mtmd_input_chunks_p,
text: "_Pointer[mtmd_input_text]",
bitmaps: CtypesArray[mtmd_bitmap_p_ctypes],
n_bitmaps: Union[c_size_t, int],
/,
) -> int: ...
# MTMD_API size_t mtmd_input_chunk_get_n_tokens(const mtmd_input_chunk * chunk);
@ctypes_function("mtmd_input_chunk_get_n_tokens", [mtmd_input_chunk_p_ctypes], c_size_t)
def mtmd_input_chunk_get_n_tokens(chunk: mtmd_input_chunk_p, /) -> int: ...
# MTMD_API enum mtmd_input_chunk_type mtmd_input_chunk_get_type(const mtmd_input_chunk * chunk);
@ctypes_function("mtmd_input_chunk_get_type", [mtmd_input_chunk_p_ctypes], c_int)
def mtmd_input_chunk_get_type(chunk: mtmd_input_chunk_p, /) -> int: ...
# MTMD_API const llama_token * mtmd_input_chunk_get_tokens_text(const mtmd_input_chunk * chunk, size_t * n_tokens_output);
@ctypes_function(
"mtmd_input_chunk_get_tokens_text",
[mtmd_input_chunk_p_ctypes, POINTER(c_size_t)],
POINTER(llama_cpp.llama_token),
)
def mtmd_input_chunk_get_tokens_text(
chunk: mtmd_input_chunk_p, n_tokens_output: "_Pointer[c_size_t]", /
) -> Optional["_Pointer[llama_cpp.llama_token]"]: ...
# MTMD_API const mtmd_image_tokens * mtmd_input_chunk_get_tokens_image(const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_input_chunk_get_tokens_image",
[mtmd_input_chunk_p_ctypes],
mtmd_image_tokens_p_ctypes,
)
def mtmd_input_chunk_get_tokens_image(
chunk: mtmd_input_chunk_p, /
) -> Optional[mtmd_image_tokens_p]: ...
# MTMD_API const char * mtmd_input_chunk_get_id(const mtmd_input_chunk * chunk);
@ctypes_function("mtmd_input_chunk_get_id", [mtmd_input_chunk_p_ctypes], c_char_p)
def mtmd_input_chunk_get_id(chunk: mtmd_input_chunk_p, /) -> Optional[bytes]:
"""Get the optional chunk identifier."""
...
# MTMD_API llama_pos mtmd_input_chunk_get_n_pos(const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_input_chunk_get_n_pos",
[mtmd_input_chunk_p_ctypes],
llama_cpp.llama_pos,
)
def mtmd_input_chunk_get_n_pos(chunk: mtmd_input_chunk_p, /) -> int:
"""Get the number of positions consumed by the chunk."""
...
# MTMD_API mtmd_input_chunk * mtmd_input_chunk_copy(const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_input_chunk_copy", [mtmd_input_chunk_p_ctypes], mtmd_input_chunk_p_ctypes
)
def mtmd_input_chunk_copy(chunk: mtmd_input_chunk_p, /) -> Optional[mtmd_input_chunk_p]:
"""Copy an input chunk and transfer ownership to the caller."""
...
# MTMD_API void mtmd_input_chunk_free(mtmd_input_chunk * chunk);
@ctypes_function("mtmd_input_chunk_free", [mtmd_input_chunk_p_ctypes], None)
def mtmd_input_chunk_free(chunk: mtmd_input_chunk_p, /):
"""Free an owned input chunk."""
...
# // save/load an input chunk to/from a buffer (useful for KV save/load)
# // important: only chunk's metadata will be saved, the actual image/audio data will not be saved
# // the loaded chunk will always be a placeholder, cannot be used for mtmd_encode() or mtmd_batch_encode()
# // out_buf can be nullptr (to query expected_out_len)
# // returns 0 on success, non-zero on failure
# MTMD_API int32_t mtmd_input_chunk_save(const mtmd_input_chunk * chunk, char * out_buf, size_t out_len, size_t * expected_out_len);
@ctypes_function(
"mtmd_input_chunk_save",
[mtmd_input_chunk_p_ctypes, POINTER(c_char), c_size_t, POINTER(c_size_t)],
c_int32,
)
def mtmd_input_chunk_save(
chunk: mtmd_input_chunk_p,
out_buf: Optional[CtypesArray[c_char]],
out_len: Union[c_size_t, int],
expected_out_len: "_Pointer[c_size_t]",
/,
) -> int:
"""Save an input chunk's metadata to a buffer."""
...
# // returns nullptr on failure
# MTMD_API mtmd_input_chunk * mtmd_input_chunk_load(const char * buf, size_t len);
@ctypes_function(
"mtmd_input_chunk_load",
[c_char_p, c_size_t],
mtmd_input_chunk_p_ctypes,
)
def mtmd_input_chunk_load(
buf: bytes,
length: Union[c_size_t, int],
/,
) -> Optional[mtmd_input_chunk_p]:
"""Load an input chunk placeholder from saved metadata."""
...
# MTMD_API size_t mtmd_image_tokens_get_n_tokens(const mtmd_image_tokens * image_tokens);
@ctypes_function(
"mtmd_image_tokens_get_n_tokens", [mtmd_image_tokens_p_ctypes], c_size_t
)
def mtmd_image_tokens_get_n_tokens(image_tokens: mtmd_image_tokens_p, /) -> int:
"""Get the number of image tokens."""
...
# DEPRECATED(MTMD_API size_t mtmd_image_tokens_get_nx(const mtmd_image_tokens * image_tokens),
# "use mtmd_image_tokens_get_decoder_pos() instead");
@ctypes_function("mtmd_image_tokens_get_nx", [mtmd_image_tokens_p_ctypes], c_size_t)
def mtmd_image_tokens_get_nx(image_tokens: mtmd_image_tokens_p, /) -> int:
"""Get the image token grid width."""
...
# DEPRECATED(MTMD_API size_t mtmd_image_tokens_get_ny(const mtmd_image_tokens * image_tokens),
# "use mtmd_image_tokens_get_decoder_pos() instead");
@ctypes_function("mtmd_image_tokens_get_ny", [mtmd_image_tokens_p_ctypes], c_size_t)
def mtmd_image_tokens_get_ny(image_tokens: mtmd_image_tokens_p, /) -> int:
"""Get the image token grid height."""
...
# MTMD_API const char * mtmd_image_tokens_get_id(const mtmd_image_tokens * image_tokens);
@ctypes_function("mtmd_image_tokens_get_id", [mtmd_image_tokens_p_ctypes], c_char_p)
def mtmd_image_tokens_get_id(image_tokens: mtmd_image_tokens_p, /) -> Optional[bytes]:
"""Get the optional image token identifier."""
...
# MTMD_API llama_pos mtmd_image_tokens_get_n_pos(const mtmd_image_tokens * image_tokens);
@ctypes_function(
"mtmd_image_tokens_get_n_pos",
[mtmd_image_tokens_p_ctypes],
llama_cpp.llama_pos,
)
def mtmd_image_tokens_get_n_pos(image_tokens: mtmd_image_tokens_p, /) -> int:
"""Get the number of positions consumed by the image tokens."""
...
# MTMD_API struct mtmd_decoder_pos mtmd_image_tokens_get_decoder_pos(
# const mtmd_image_tokens * image_tokens, llama_pos pos_0, size_t i);
@ctypes_function(
"mtmd_image_tokens_get_decoder_pos",
[mtmd_image_tokens_p_ctypes, llama_cpp.llama_pos, c_size_t],
mtmd_decoder_pos,
)
def mtmd_image_tokens_get_decoder_pos(
image_tokens: mtmd_image_tokens_p,
pos_0: llama_cpp.llama_pos,
i: Union[c_size_t, int],
/,
) -> mtmd_decoder_pos:
"""Get decoder attention position for an image embedding token."""
...
# MTMD_API int32_t mtmd_encode(mtmd_context * ctx, const mtmd_image_tokens * image_tokens);
@ctypes_function(
"mtmd_encode",
[mtmd_context_p_ctypes, mtmd_image_tokens_p_ctypes],
c_int,
)
def mtmd_encode(ctx: mtmd_context_p, image_tokens: mtmd_image_tokens_p, /) -> int:
"""Run a deprecated MTMD encode pass for image tokens."""
...
# MTMD_API int32_t mtmd_encode_chunk(mtmd_context * ctx, const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_encode_chunk",
[mtmd_context_p_ctypes, mtmd_input_chunk_p_ctypes],
c_int,
)
def mtmd_encode_chunk(ctx: mtmd_context_p, chunk: mtmd_input_chunk_p, /) -> int:
"""Run an MTMD encode pass for a single chunk."""
...
# MTMD_API float * mtmd_get_output_embd(mtmd_context * ctx);
@ctypes_function("mtmd_get_output_embd", [mtmd_context_p_ctypes], POINTER(c_float))
def mtmd_get_output_embd(ctx: mtmd_context_p, /) -> Optional[CtypesArray[c_float]]:
"""Get output embeddings from the last encode pass."""
...
# MTMD_API mtmd_batch * mtmd_batch_init(mtmd_context * ctx);
@ctypes_function("mtmd_batch_init", [mtmd_context_p_ctypes], mtmd_batch_p_ctypes)
def mtmd_batch_init(ctx: mtmd_context_p, /) -> Optional[mtmd_batch_p]:
"""Initialize an MTMD media chunk batch for a context."""
...
# MTMD_API void mtmd_batch_free(mtmd_batch * batch);
@ctypes_function("mtmd_batch_free", [mtmd_batch_p_ctypes], None)
def mtmd_batch_free(batch: mtmd_batch_p, /): ...
# MTMD_API int32_t mtmd_batch_add_chunk(mtmd_batch * batch, const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_batch_add_chunk",
[mtmd_batch_p_ctypes, mtmd_input_chunk_p_ctypes],
c_int,
)
def mtmd_batch_add_chunk(
batch: mtmd_batch_p,
chunk: mtmd_input_chunk_p,
/,
) -> int:
"""Add a media chunk to an MTMD batch."""
...
# MTMD_API int32_t mtmd_batch_encode(mtmd_batch * batch);
@ctypes_function("mtmd_batch_encode", [mtmd_batch_p_ctypes], c_int)
def mtmd_batch_encode(batch: mtmd_batch_p, /) -> int:
"""Run an MTMD encode pass for all chunks in a batch."""
...
# MTMD_API float * mtmd_batch_get_output_embd(mtmd_batch * batch, const mtmd_input_chunk * chunk);
@ctypes_function(
"mtmd_batch_get_output_embd",
[mtmd_batch_p_ctypes, mtmd_input_chunk_p_ctypes],
POINTER(c_float),
)
def mtmd_batch_get_output_embd(
batch: mtmd_batch_p,
chunk: mtmd_input_chunk_p,
/,
) -> Optional[CtypesArray[c_float]]:
"""Get output embeddings for a chunk from the last batch encode pass."""
...
# MTMD_API struct mtmd_caps mtmd_get_cap_from_file(const char * mmproj_fname);
@ctypes_function("mtmd_get_cap_from_file", [c_char_p], mtmd_caps)
def mtmd_get_cap_from_file(mmproj_fname: bytes, /) -> mtmd_caps:
"""Get mmproj capabilities without initializing a full MTMD context."""
...
# MTMD_API struct mtmd_gen_audio_info mtmd_gen_audio_get_info(const mtmd_context * ctx);
@ctypes_function(
"mtmd_gen_audio_get_info",
[mtmd_context_p_ctypes],
mtmd_gen_audio_info,
)
def mtmd_gen_audio_get_info(ctx: mtmd_context_p, /) -> mtmd_gen_audio_info:
"""Get audio generation information for an MTMD context."""
...
# // defaults tuned for the loaded pipeline, callers override only what they care about
# MTMD_API struct mtmd_gen_inp mtmd_gen_inp_default(const mtmd_context * ctx);
@ctypes_function(
"mtmd_gen_inp_default",
[mtmd_context_p_ctypes],
mtmd_gen_inp,
)
def mtmd_gen_inp_default(ctx: mtmd_context_p, /) -> mtmd_gen_inp:
"""Get default audio generation input parameters for an MTMD context."""
...
# // note: this API is stateless, caller must handle state management and audio frame accumulation
# MTMD_API int32_t mtmd_gen_audio_process(mtmd_context * ctx,
# const struct mtmd_gen_inp * inp,
# struct mtmd_gen_out * out);
@ctypes_function(
"mtmd_gen_audio_process",
[mtmd_context_p_ctypes, POINTER(mtmd_gen_inp), POINTER(mtmd_gen_out)],
c_int32,
)
def mtmd_gen_audio_process(
ctx: mtmd_context_p,
inp: "_Pointer[mtmd_gen_inp]",
out: "_Pointer[mtmd_gen_out]",
/,
) -> int:
"""Process one audio generation step."""
...
# MTMD_API mtmd_input_chunks * mtmd_test_create_input_chunks(void);
@ctypes_function("mtmd_test_create_input_chunks", [], mtmd_input_chunks_p_ctypes)
def mtmd_test_create_input_chunks() -> Optional[mtmd_input_chunks_p]:
"""Create MTMD test chunks for the C API tests."""
...
################################################
# mtmd-helper.h functions
################################################
# MTMD_API bool mtmd_helper_support_video(mtmd_context * ctx);
@ctypes_function(
"mtmd_helper_support_video",
[mtmd_context_p_ctypes],
c_bool,
)
def mtmd_helper_support_video(ctx: mtmd_context_p, /) -> bool:
"""Check whether MTMD helper video support is available."""
...
# MTMD_API struct mtmd_helper_bitmap_wrapper mtmd_helper_bitmap_init_from_file(mtmd_context * ctx, const char * fname, bool placeholder);
@ctypes_function(
"mtmd_helper_bitmap_init_from_file",
[mtmd_context_p_ctypes, c_char_p, c_bool],
mtmd_helper_bitmap_wrapper,
)
def mtmd_helper_bitmap_init_from_file_wrapper(
ctx: mtmd_context_p, fname: bytes, placeholder: Union[c_bool, bool], /
) -> mtmd_helper_bitmap_wrapper:
"""Initialize an MTMD bitmap wrapper from a file."""
...
def mtmd_helper_bitmap_init_from_file(
ctx: mtmd_context_p, fname: bytes, placeholder: Union[c_bool, bool], /
) -> Optional[mtmd_bitmap_p]:
"""Initialize an MTMD bitmap from a file."""
return mtmd_helper_bitmap_init_from_file_wrapper(ctx, fname, placeholder).bitmap
# MTMD_API struct mtmd_helper_bitmap_wrapper mtmd_helper_bitmap_init_from_buf(mtmd_context * ctx, const unsigned char * buf, size_t len, bool placeholder);
@ctypes_function(
"mtmd_helper_bitmap_init_from_buf",
[mtmd_context_p_ctypes, POINTER(c_uint8), c_size_t, c_bool],