-
Notifications
You must be signed in to change notification settings - Fork 215
/
Copy pathogmacam.h
1741 lines (1579 loc) · 114 KB
/
ogmacam.h
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
#ifndef __ogmacam_h__
#define __ogmacam_h__
/* Version: 57.27591.20250122 */
/*
Platform & Architecture:
(1) Win32:
(a) x64: Win7 or above
(b) x86: XP SP3 or above; CPU supports SSE2 instruction set or above
(c) arm64: Win10 or above
(d) arm: Win10 or above
(2) WinRT: x64, x86, arm64, arm; Win10 or above
(3) macOS:
(a) x64+x86: macOS 10.10 or above
(b) x64+arm64: macOS 11.0 or above, support x64 and Apple silicon (such as M1, M2, etc)
(4) Linux: kernel 2.6.27 or above
(a) x64: GLIBC 2.14 or above
(b) x86: CPU supports SSE3 instruction set or above; GLIBC 2.8 or above
(c) arm64: GLIBC 2.17 or above; built by toolchain aarch64-linux-gnu (version 5.4.0)
(d) armhf: GLIBC 2.8 or above; built by toolchain arm-linux-gnueabihf (version 5.4.0)
(e) armel: GLIBC 2.8 or above; built by toolchain arm-linux-gnueabi (version 5.4.0)
(5) Android: __ANDROID_API__ >= 24 (Android 7.0); built by android-ndk-r18b; see https://developer.android.com/ndk/guides/abis
(a) arm64: arm64-v8a
(b) arm: armeabi-v7a
(c) x64: x86_64
(d) x86
*/
/*
doc:
(1) en.html, English
(2) hans.html, Simplified Chinese
*/
/*
Please distinguish between camera ID (camId) and camera SN:
(a) SN is unique and persistent, fixed inside the camera and remains unchanged, and does not change with connection or system restart.
(b) Camera ID (camId) may change due to connection or system restart. Enumerate the cameras to get the camera ID, and then call the Open function to pass in the camId parameter to open the camera.
*/
#if defined(_WIN32)
#ifndef _INC_WINDOWS
#include <windows.h>
#endif
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if defined(__cplusplus) && (__cplusplus >= 201402L)
#define OGMACAM_DEPRECATED [[deprecated]]
#elif defined(_MSC_VER)
#define OGMACAM_DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__) || defined(__clang__)
#define OGMACAM_DEPRECATED __attribute__((deprecated))
#else
#define OGMACAM_DEPRECATED
#endif
#if defined(_WIN32) /* Windows */
#pragma pack(push, 8)
#ifdef OGMACAM_EXPORTS
#define OGMACAM_API(x) __declspec(dllexport) x __stdcall /* in Windows, we use __stdcall calling convention, see https://docs.microsoft.com/en-us/cpp/cpp/stdcall */
#elif !defined(OGMACAM_NOIMPORTS)
#define OGMACAM_API(x) __declspec(dllimport) x __stdcall
#else
#define OGMACAM_API(x) x __stdcall
#endif
#else /* Linux or macOS */
#define OGMACAM_API(x) x
#if (!defined(HRESULT)) && (!defined(__COREFOUNDATION_CFPLUGINCOM__)) /* CFPlugInCOM.h */
#define HRESULT int
#endif
#ifndef SUCCEEDED
#define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0)
#endif
#ifndef FAILED
#define FAILED(hr) (((HRESULT)(hr)) < 0)
#endif
#ifndef __stdcall
#define __stdcall
#endif
#endif
#ifndef TDIBWIDTHBYTES
#define TDIBWIDTHBYTES(bits) ((unsigned)(((bits) + 31) & (~31)) / 8)
#endif
/********************************************************************************/
/* HRESULT: error code */
/* Please note that the return value >= 0 means success */
/* (especially S_FALSE is also successful, indicating that the internal value and the value set by the user is equivalent, which means "no operation"). */
/* Therefore, the SUCCEEDED and FAILED macros should generally be used to determine whether the return value is successful or failed. */
/* (Unless there are special needs, do not use "==S_OK" or "==0" to judge the return value) */
/* */
/* #define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0) */
/* #define FAILED(hr) (((HRESULT)(hr)) < 0) */
/* */
/********************************************************************************/
#if defined(OGMACAM_HRESULT_ERRORCODE_NEEDED)
#define S_OK (HRESULT)(0x00000000) /* Success */
#define S_FALSE (HRESULT)(0x00000001) /* Yet another success */ /* Remark: Different from S_OK, such as internal values and user-set values have coincided, equivalent to noop */
#define E_UNEXPECTED (HRESULT)(0x8000ffff) /* Catastrophic failure */ /* Remark: Generally indicates that the conditions are not met, such as calling put_Option setting some options that do not support modification when the camera is running, and so on */
#define E_NOTIMPL (HRESULT)(0x80004001) /* Not supported or not implemented */ /* Remark: This feature is not supported on this model of camera */
#define E_NOINTERFACE (HRESULT)(0x80004002)
#define E_ACCESSDENIED (HRESULT)(0x80070005) /* Permission denied */ /* Remark: The program on Linux does not have permission to open the USB device, please enable udev rules file or run as root */
#define E_OUTOFMEMORY (HRESULT)(0x8007000e) /* Out of memory */
#define E_INVALIDARG (HRESULT)(0x80070057) /* One or more arguments are not valid */
#define E_POINTER (HRESULT)(0x80004003) /* Pointer that is not valid */ /* Remark: Pointer is NULL */
#define E_FAIL (HRESULT)(0x80004005) /* Generic failure */
#define E_WRONG_THREAD (HRESULT)(0x8001010e) /* Call function in the wrong thread */
#define E_GEN_FAILURE (HRESULT)(0x8007001f) /* Device not functioning */ /* Remark: It is generally caused by hardware errors, such as cable problems, USB port problems, poor contact, camera hardware damage, etc */
#define E_BUSY (HRESULT)(0x800700aa) /* The requested resource is in use */ /* Remark: The camera is already in use, such as duplicated opening/starting the camera, or being used by other application, etc */
#define E_PENDING (HRESULT)(0x8000000a) /* The data necessary to complete this operation is not yet available */ /* Remark: No data is available at this time */
#define E_TIMEOUT (HRESULT)(0x8001011f) /* This operation returned because the timeout period expired */
#endif
/* handle */
typedef struct Ogmacam_t { int unused; } *HOgmacam;
#define OGMACAM_MAX 128
#define OGMACAM_FLAG_CMOS 0x00000001 /* cmos sensor */
#define OGMACAM_FLAG_CCD_PROGRESSIVE 0x00000002 /* progressive ccd sensor */
#define OGMACAM_FLAG_CCD_INTERLACED 0x00000004 /* interlaced ccd sensor */
#define OGMACAM_FLAG_ROI_HARDWARE 0x00000008 /* support hardware ROI */
#define OGMACAM_FLAG_MONO 0x00000010 /* monochromatic */
#define OGMACAM_FLAG_BINSKIP_SUPPORTED 0x00000020 /* support bin/skip mode, see Ogmacam_put_Mode and Ogmacam_get_Mode */
#define OGMACAM_FLAG_USB30 0x00000040 /* usb3.0 */
#define OGMACAM_FLAG_TEC 0x00000080 /* Thermoelectric Cooler */
#define OGMACAM_FLAG_USB30_OVER_USB20 0x00000100 /* usb3.0 camera connected to usb2.0 port */
#define OGMACAM_FLAG_ST4 0x00000200 /* ST4 port */
#define OGMACAM_FLAG_GETTEMPERATURE 0x00000400 /* support to get the temperature of the sensor */
#define OGMACAM_FLAG_HIGH_FULLWELL 0x00000800 /* high fullwell capacity */
#define OGMACAM_FLAG_RAW10 0x00001000 /* pixel format, RAW 10bits */
#define OGMACAM_FLAG_RAW12 0x00002000 /* pixel format, RAW 12bits */
#define OGMACAM_FLAG_RAW14 0x00004000 /* pixel format, RAW 14bits */
#define OGMACAM_FLAG_RAW16 0x00008000 /* pixel format, RAW 16bits */
#define OGMACAM_FLAG_FAN 0x00010000 /* cooling fan */
#define OGMACAM_FLAG_TEC_ONOFF 0x00020000 /* Thermoelectric Cooler can be turn on or off, support to set the target temperature of TEC */
#define OGMACAM_FLAG_ISP 0x00040000 /* ISP (Image Signal Processing) chip */
#define OGMACAM_FLAG_TRIGGER_SOFTWARE 0x00080000 /* support software trigger */
#define OGMACAM_FLAG_TRIGGER_EXTERNAL 0x00100000 /* support external trigger */
#define OGMACAM_FLAG_TRIGGER_SINGLE 0x00200000 /* only support trigger single: one trigger, one image */
#define OGMACAM_FLAG_BLACKLEVEL 0x00400000 /* support set and get the black level */
#define OGMACAM_FLAG_AUTO_FOCUS 0x00800000 /* support auto focus */
#define OGMACAM_FLAG_BUFFER 0x01000000 /* frame buffer */
#define OGMACAM_FLAG_DDR 0x02000000 /* use very large capacity DDR (Double Data Rate SDRAM) for frame buffer. The capacity is not less than one full frame */
#define OGMACAM_FLAG_CG 0x04000000 /* Conversion Gain: HCG, LCG */
#define OGMACAM_FLAG_YUV411 0x08000000 /* pixel format, yuv411 */
#define OGMACAM_FLAG_VUYY 0x10000000 /* pixel format, yuv422, VUYY */
#define OGMACAM_FLAG_YUV444 0x20000000 /* pixel format, yuv444 */
#define OGMACAM_FLAG_RGB888 0x40000000 /* pixel format, RGB888 */
#define OGMACAM_FLAG_RAW8 0x80000000 /* pixel format, RAW 8 bits */
#define OGMACAM_FLAG_GMCY8 0x0000000100000000 /* pixel format, GMCY, 8bits */
#define OGMACAM_FLAG_GMCY12 0x0000000200000000 /* pixel format, GMCY, 12bits */
#define OGMACAM_FLAG_UYVY 0x0000000400000000 /* pixel format, yuv422, UYVY */
#define OGMACAM_FLAG_CGHDR 0x0000000800000000 /* Conversion Gain: HCG, LCG, HDR */
#define OGMACAM_FLAG_GLOBALSHUTTER 0x0000001000000000 /* global shutter */
#define OGMACAM_FLAG_FOCUSMOTOR 0x0000002000000000 /* support focus motor */
#define OGMACAM_FLAG_PRECISE_FRAMERATE 0x0000004000000000 /* support precise framerate & bandwidth, see OGMACAM_OPTION_PRECISE_FRAMERATE & OGMACAM_OPTION_BANDWIDTH */
#define OGMACAM_FLAG_HEAT 0x0000008000000000 /* support heat to prevent fogging up */
#define OGMACAM_FLAG_LOW_NOISE 0x0000010000000000 /* support low noise mode (Higher signal noise ratio, lower frame rate) */
#define OGMACAM_FLAG_LEVELRANGE_HARDWARE 0x0000020000000000 /* hardware level range, put(get)_LevelRangeV2 */
#define OGMACAM_FLAG_EVENT_HARDWARE 0x0000040000000000 /* hardware event, such as exposure start & stop */
#define OGMACAM_FLAG_LIGHTSOURCE 0x0000080000000000 /* embedded light source */
#define OGMACAM_FLAG_FILTERWHEEL 0x0000100000000000 /* astro filter wheel */
#define OGMACAM_FLAG_GIGE 0x0000200000000000 /* 1 Gigabit GigE */
#define OGMACAM_FLAG_10GIGE 0x0000400000000000 /* 10 Gigabit GigE */
#define OGMACAM_FLAG_5GIGE 0x0000800000000000 /* 5 Gigabit GigE */
#define OGMACAM_FLAG_25GIGE 0x0001000000000000 /* 2.5 Gigabit GigE */
#define OGMACAM_FLAG_AUTOFOCUSER 0x0002000000000000 /* astro auto focuser */
#define OGMACAM_FLAG_LIGHT_SOURCE 0x0004000000000000 /* stand alone light source */
#define OGMACAM_FLAG_CAMERALINK 0x0008000000000000 /* camera link */
#define OGMACAM_FLAG_CXP 0x0010000000000000 /* CXP: CoaXPress */
#define OGMACAM_FLAG_RAW12PACK 0x0020000000000000 /* pixel format, RAW 12bits packed */
#define OGMACAM_FLAG_SELFTRIGGER 0x0040000000000000 /* self trigger */
#define OGMACAM_FLAG_RAW11 0x0080000000000000 /* pixel format, RAW 11bits */
#define OGMACAM_FLAG_GHOPTO 0x0100000000000000 /* ghopto sensor */
#define OGMACAM_EXPOGAIN_DEF 100 /* exposure gain, default value */
#define OGMACAM_EXPOGAIN_MIN 100 /* exposure gain, minimum value */
#define OGMACAM_TEMP_DEF 6503 /* color temperature, default value */
#define OGMACAM_TEMP_MIN 2000 /* color temperature, minimum value */
#define OGMACAM_TEMP_MAX 15000 /* color temperature, maximum value */
#define OGMACAM_TINT_DEF 1000 /* tint */
#define OGMACAM_TINT_MIN 200 /* tint */
#define OGMACAM_TINT_MAX 2500 /* tint */
#define OGMACAM_HUE_DEF 0 /* hue */
#define OGMACAM_HUE_MIN (-180) /* hue */
#define OGMACAM_HUE_MAX 180 /* hue */
#define OGMACAM_SATURATION_DEF 128 /* saturation */
#define OGMACAM_SATURATION_MIN 0 /* saturation */
#define OGMACAM_SATURATION_MAX 255 /* saturation */
#define OGMACAM_BRIGHTNESS_DEF 0 /* brightness */
#define OGMACAM_BRIGHTNESS_MIN (-255) /* brightness */
#define OGMACAM_BRIGHTNESS_MAX 255 /* brightness */
#define OGMACAM_CONTRAST_DEF 0 /* contrast */
#define OGMACAM_CONTRAST_MIN (-255) /* contrast */
#define OGMACAM_CONTRAST_MAX 255 /* contrast */
#define OGMACAM_GAMMA_DEF 100 /* gamma */
#define OGMACAM_GAMMA_MIN 20 /* gamma */
#define OGMACAM_GAMMA_MAX 180 /* gamma */
#define OGMACAM_AETARGET_DEF 120 /* target of auto exposure */
#define OGMACAM_AETARGET_MIN 16 /* target of auto exposure */
#define OGMACAM_AETARGET_MAX 220 /* target of auto exposure */
#define OGMACAM_WBGAIN_DEF 0 /* white balance gain */
#define OGMACAM_WBGAIN_MIN (-127) /* white balance gain */
#define OGMACAM_WBGAIN_MAX 127 /* white balance gain */
#define OGMACAM_BLACKLEVEL_MIN 0 /* minimum black level */
#define OGMACAM_BLACKLEVEL8_MAX 31 /* maximum black level for bitdepth = 8 */
#define OGMACAM_BLACKLEVEL10_MAX (31 * 4) /* maximum black level for bitdepth = 10 */
#define OGMACAM_BLACKLEVEL11_MAX (31 * 8) /* maximum black level for bitdepth = 11 */
#define OGMACAM_BLACKLEVEL12_MAX (31 * 16) /* maximum black level for bitdepth = 12 */
#define OGMACAM_BLACKLEVEL14_MAX (31 * 64) /* maximum black level for bitdepth = 14 */
#define OGMACAM_BLACKLEVEL16_MAX (31 * 256) /* maximum black level for bitdepth = 16 */
#define OGMACAM_SHARPENING_STRENGTH_DEF 0 /* sharpening strength */
#define OGMACAM_SHARPENING_STRENGTH_MIN 0 /* sharpening strength */
#define OGMACAM_SHARPENING_STRENGTH_MAX 500 /* sharpening strength */
#define OGMACAM_SHARPENING_RADIUS_DEF 2 /* sharpening radius */
#define OGMACAM_SHARPENING_RADIUS_MIN 1 /* sharpening radius */
#define OGMACAM_SHARPENING_RADIUS_MAX 10 /* sharpening radius */
#define OGMACAM_SHARPENING_THRESHOLD_DEF 0 /* sharpening threshold */
#define OGMACAM_SHARPENING_THRESHOLD_MIN 0 /* sharpening threshold */
#define OGMACAM_SHARPENING_THRESHOLD_MAX 255 /* sharpening threshold */
#define OGMACAM_AUTOEXPO_THRESHOLD_DEF 5 /* auto exposure threshold */
#define OGMACAM_AUTOEXPO_THRESHOLD_MIN 2 /* auto exposure threshold */
#define OGMACAM_AUTOEXPO_THRESHOLD_MAX 15 /* auto exposure threshold */
#define OGMACAM_AUTOEXPO_DAMP_DEF 0 /* auto exposure damping coefficient: thousandths */
#define OGMACAM_AUTOEXPO_DAMP_MIN 0 /* auto exposure damping coefficient: thousandths */
#define OGMACAM_AUTOEXPO_DAMP_MAX 1000 /* auto exposure damping coefficient: thousandths */
#define OGMACAM_BANDWIDTH_DEF 100 /* bandwidth */
#define OGMACAM_BANDWIDTH_MIN 1 /* bandwidth */
#define OGMACAM_BANDWIDTH_MAX 100 /* bandwidth */
#define OGMACAM_DENOISE_DEF 0 /* denoise */
#define OGMACAM_DENOISE_MIN 0 /* denoise */
#define OGMACAM_DENOISE_MAX 100 /* denoise */
#define OGMACAM_HEARTBEAT_MIN 100 /* millisecond */
#define OGMACAM_HEARTBEAT_MAX 10000 /* millisecond */
#define OGMACAM_AE_PERCENT_MIN 0 /* auto exposure percent; 0 or 100 => full roi average, means "disabled" */
#define OGMACAM_AE_PERCENT_MAX 100
#define OGMACAM_AE_PERCENT_DEF 10 /* auto exposure percent: enabled, percentage = 10% */
#define OGMACAM_NOPACKET_TIMEOUT_MIN 500 /* no packet timeout minimum: 500ms */
#define OGMACAM_NOFRAME_TIMEOUT_MIN 500 /* no frame timeout minimum: 500ms */
#define OGMACAM_DYNAMIC_DEFECT_T1_MIN 0 /* dynamic defect pixel correction, dead pixel ratio: the smaller the dead ratio is, the more stringent the conditions for processing dead pixels are, and fewer pixels will be processed */
#define OGMACAM_DYNAMIC_DEFECT_T1_MAX 100 /* means: 1.0 */
#define OGMACAM_DYNAMIC_DEFECT_T1_DEF 90 /* means: 0.9 */
#define OGMACAM_DYNAMIC_DEFECT_T2_MIN 0 /* dynamic defect pixel correction, hot pixel ratio: the smaller the hot ratio is, the more stringent the conditions for processing hot pixels are, and fewer pixels will be processed */
#define OGMACAM_DYNAMIC_DEFECT_T2_MAX 100
#define OGMACAM_DYNAMIC_DEFECT_T2_DEF 90
#define OGMACAM_HDR_K_MIN 1 /* HDR synthesize */
#define OGMACAM_HDR_K_MAX 25500
#define OGMACAM_HDR_B_MIN 0
#define OGMACAM_HDR_B_MAX 65535
#define OGMACAM_HDR_THRESHOLD_MIN 0
#define OGMACAM_HDR_THRESHOLD_MAX 4094
#define OGMACAM_CDS_MIN 0 /* Correlated Double Sampling */
#define OGMACAM_CDS_MAX 100
typedef struct {
unsigned width;
unsigned height;
} OgmacamResolution;
/* In Windows platform, we always use UNICODE wchar_t */
/* In Linux or macOS, we use char */
typedef struct {
#if defined(_WIN32)
const wchar_t* name; /* model name, in Windows, we use unicode */
#else
const char* name; /* model name */
#endif
unsigned long long flag; /* OGMACAM_FLAG_xxx, 64 bits */
unsigned maxspeed; /* number of speed level, same as Ogmacam_get_MaxSpeed(), speed range = [0, maxspeed], closed interval */
unsigned preview; /* number of preview resolution, same as Ogmacam_get_ResolutionNumber() */
unsigned still; /* number of still resolution, same as Ogmacam_get_StillResolutionNumber() */
unsigned maxfanspeed; /* maximum fan speed, fan speed range = [0, max], closed interval */
unsigned ioctrol; /* number of input/output control */
float xpixsz; /* physical pixel size in micrometer */
float ypixsz; /* physical pixel size in micrometer */
OgmacamResolution res[16];
} OgmacamModelV2; /* device model v2 */
typedef struct {
#if defined(_WIN32)
wchar_t displayname[64]; /* display name: model name or user-defined name (if any and Ogmacam_EnumWithName) */
wchar_t id[64]; /* unique and opaque id of a connected camera, for Ogmacam_Open */
#else
char displayname[64]; /* display name: model name or user-defined name (if any and Ogmacam_EnumWithName) */
char id[64]; /* unique and opaque id of a connected camera, for Ogmacam_Open */
#endif
const OgmacamModelV2* model;
} OgmacamDeviceV2; /* device instance for enumerating */
/*
get the version of this dll/so/dylib, which is: 57.27591.20250122
*/
#if defined(_WIN32)
OGMACAM_API(const wchar_t*) Ogmacam_Version();
#else
OGMACAM_API(const char*) Ogmacam_Version();
#endif
/*
enumerate the cameras connected to the computer, return the number of enumerated.
OgmacamDeviceV2 arr[OGMACAM_MAX];
unsigned cnt = Ogmacam_EnumV2(arr);
for (unsigned i = 0; i < cnt; ++i)
...
if arr == NULL, then, only the number is returned.
Ogmacam_Enum is obsolete.
*/
OGMACAM_API(unsigned) Ogmacam_EnumV2(OgmacamDeviceV2 arr[OGMACAM_MAX]);
/* use the camId of OgmacamDeviceV2, which is enumerated by Ogmacam_EnumV2.
if camId is NULL, Ogmacam_Open will open the first enumerated camera.
For the issue of opening the camera on Android, please refer to the documentation
*/
#if defined(_WIN32)
OGMACAM_API(HOgmacam) Ogmacam_Open(const wchar_t* camId);
#else
OGMACAM_API(HOgmacam) Ogmacam_Open(const char* camId);
#endif
/*
the same with Ogmacam_Open, but use the index as the parameter. such as:
index == 0, open the first camera,
index == 1, open the second camera,
etc
*/
OGMACAM_API(HOgmacam) Ogmacam_OpenByIndex(unsigned index);
/* close the handle. After it is closed, never use the handle any more. */
OGMACAM_API(void) Ogmacam_Close(HOgmacam h);
#define OGMACAM_EVENT_EXPOSURE 0x0001 /* exposure time or gain changed */
#define OGMACAM_EVENT_TEMPTINT 0x0002 /* white balance changed, Temp/Tint mode */
#define OGMACAM_EVENT_IMAGE 0x0004 /* live image arrived, use Ogmacam_PullImageXXXX to get this image */
#define OGMACAM_EVENT_STILLIMAGE 0x0005 /* snap (still) frame arrived, use Ogmacam_PullStillImageXXXX to get this frame */
#define OGMACAM_EVENT_WBGAIN 0x0006 /* white balance changed, RGB Gain mode */
#define OGMACAM_EVENT_TRIGGERFAIL 0x0007 /* trigger failed */
#define OGMACAM_EVENT_BLACK 0x0008 /* black balance changed */
#define OGMACAM_EVENT_FFC 0x0009 /* flat field correction status changed */
#define OGMACAM_EVENT_DFC 0x000a /* dark field correction status changed */
#define OGMACAM_EVENT_ROI 0x000b /* roi changed */
#define OGMACAM_EVENT_LEVELRANGE 0x000c /* level range changed */
#define OGMACAM_EVENT_AUTOEXPO_CONV 0x000d /* auto exposure convergence */
#define OGMACAM_EVENT_AUTOEXPO_CONVFAIL 0x000e /* auto exposure once mode convergence failed */
#define OGMACAM_EVENT_FPNC 0x000f /* fix pattern noise correction status changed */
#define OGMACAM_EVENT_ERROR 0x0080 /* generic error */
#define OGMACAM_EVENT_DISCONNECTED 0x0081 /* camera disconnected */
#define OGMACAM_EVENT_NOFRAMETIMEOUT 0x0082 /* no frame timeout error */
#define OGMACAM_EVENT_FOCUSPOS 0x0084 /* focus positon */
#define OGMACAM_EVENT_NOPACKETTIMEOUT 0x0085 /* no packet timeout */
#define OGMACAM_EVENT_EXPO_START 0x4000 /* hardware event: exposure start */
#define OGMACAM_EVENT_EXPO_STOP 0x4001 /* hardware event: exposure stop */
#define OGMACAM_EVENT_TRIGGER_ALLOW 0x4002 /* hardware event: next trigger allow */
#define OGMACAM_EVENT_HEARTBEAT 0x4003 /* hardware event: heartbeat, can be used to monitor whether the camera is alive */
#define OGMACAM_EVENT_TRIGGER_IN 0x4004 /* hardware event: trigger in */
#define OGMACAM_EVENT_FACTORY 0x8001 /* restore factory settings */
#if defined(_WIN32)
OGMACAM_API(HRESULT) Ogmacam_StartPullModeWithWndMsg(HOgmacam h, HWND hWnd, UINT nMsg);
#endif
/* Do NOT call Ogmacam_Close, Ogmacam_Stop in this callback context, it deadlocks. */
/* Do NOT call Ogmacam_put_Option with OGMACAM_OPTION_TRIGGER, OGMACAM_OPTION_BITDEPTH, OGMACAM_OPTION_PIXEL_FORMAT, OGMACAM_OPTION_BINNING, OGMACAM_OPTION_ROTATE, it will fail with error code E_WRONG_THREAD */
typedef void (__stdcall* POGMACAM_EVENT_CALLBACK)(unsigned nEvent, void* ctxEvent);
OGMACAM_API(HRESULT) Ogmacam_StartPullModeWithCallback(HOgmacam h, POGMACAM_EVENT_CALLBACK funEvent, void* ctxEvent);
#define OGMACAM_FRAMEINFO_FLAG_SEQ 0x00000001 /* frame sequence number */
#define OGMACAM_FRAMEINFO_FLAG_TIMESTAMP 0x00000002 /* timestamp */
#define OGMACAM_FRAMEINFO_FLAG_EXPOTIME 0x00000004 /* exposure time */
#define OGMACAM_FRAMEINFO_FLAG_EXPOGAIN 0x00000008 /* exposure gain */
#define OGMACAM_FRAMEINFO_FLAG_BLACKLEVEL 0x00000010 /* black level */
#define OGMACAM_FRAMEINFO_FLAG_SHUTTERSEQ 0x00000020 /* sequence shutter counter */
#define OGMACAM_FRAMEINFO_FLAG_GPS 0x00000040 /* GPS */
#define OGMACAM_FRAMEINFO_FLAG_AUTOFOCUS 0x00000080 /* auto focus: uLum & uFV */
#define OGMACAM_FRAMEINFO_FLAG_COUNT 0x00000100 /* timecount, framecount, tricount */
#define OGMACAM_FRAMEINFO_FLAG_MECHANICALSHUTTER 0x00000200 /* Mechanical shutter: closed */
#define OGMACAM_FRAMEINFO_FLAG_STILL 0x00008000 /* still image */
typedef struct {
unsigned width;
unsigned height;
unsigned flag; /* OGMACAM_FRAMEINFO_FLAG_xxxx */
unsigned seq; /* frame sequence number */
unsigned long long timestamp; /* microsecond */
unsigned shutterseq; /* sequence shutter counter */
unsigned expotime; /* exposure time */
unsigned short expogain; /* exposure gain */
unsigned short blacklevel; /* black level */
} OgmacamFrameInfoV3;
typedef struct {
unsigned long long utcstart; /* exposure start time: nanosecond since epoch (00:00:00 UTC on Thursday, 1 January 1970, see https://en.wikipedia.org/wiki/Unix_time) */
unsigned long long utcend; /* exposure end time */
int longitude; /* millionth of a degree, 0.000001 degree */
int latitude;
int altitude; /* millimeter */
unsigned short satellite; /* number of satellite */
unsigned short reserved; /* not used */
} OgmacamGps;
typedef struct {
OgmacamFrameInfoV3 v3;
unsigned reserved; /* not used */
unsigned uLum;
unsigned long long uFV;
unsigned long long timecount;
unsigned framecount, tricount;
OgmacamGps gps;
} OgmacamFrameInfoV4;
/*
nWaitMS: The timeout interval, in milliseconds. If a nonzero value is specified, the function waits until the image is ok or the interval elapses.
If nWaitMS is zero, the function does not enter a wait state if the image is not available; it always returns immediately; this is equal to Ogmacam_PullImageV4.
bStill: to pull still image, set to 1, otherwise 0
bits: 24 (RGB24), 32 (RGB32), 48 (RGB48), 8 (Grey), 16 (Grey), 64 (RGB64).
In RAW mode, this parameter is ignored.
bits = 0 means using default bits base on OGMACAM_OPTION_RGB.
When bits and OGMACAM_OPTION_RGB are inconsistent, format conversion will have to be performed, resulting in loss of efficiency.
See the following bits and OGMACAM_OPTION_RGB correspondence table:
----------------------------------------------------------------------------------------------------------------------
| OGMACAM_OPTION_RGB | 0 (RGB24) | 1 (RGB48) | 2 (RGB32) | 3 (Grey8) | 4 (Grey16) | 5 (RGB64) |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 0 | 24 | 48 | 32 | 8 | 16 | 64 |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 24 | 24 | NA | Convert to 24 | Convert to 24 | NA | NA |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 32 | Convert to 32 | NA | 32 | Convert to 32 | NA | NA |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 48 | NA | 48 | NA | NA | Convert to 48 | Convert to 48 |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 8 | Convert to 8 | NA | Convert to 8 | 8 | NA | NA |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 16 | NA | Convert to 16 | NA | NA | 16 | Convert to 16 |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
| bits = 64 | NA | Convert to 64 | NA | NA | Convert to 64 | 64 |
|--------------------|---------------|---------------|---------------|---------------|---------------|---------------|
rowPitch: The distance from one row to the next row. rowPitch = 0 means using the default row pitch. rowPitch = -1 means zero padding, see below:
----------------------------------------------------------------------------------------------
| format | 0 means default row pitch | -1 means zero padding |
|------------------------------------|-------------------------------|-----------------------|
| RGB | RGB24 | TDIBWIDTHBYTES(24 * Width) | Width * 3 |
| | RGB32 | Width * 4 | Width * 4 |
| | RGB48 | TDIBWIDTHBYTES(48 * Width) | Width * 6 |
| | GREY8 | TDIBWIDTHBYTES(8 * Width) | Width |
| | GREY16 | TDIBWIDTHBYTES(16 * Width) | Width * 2 |
| | RGB64 | Width * 8 | Width * 8 |
|-----------|------------------------|-------------------------------|-----------------------|
| RAW | 8bits Mode | Width | Width |
| | 10/12/14/16bits Mode | Width * 2 | Width * 2 |
|-----------|------------------------|-------------------------------|-----------------------|
*/
OGMACAM_API(HRESULT) Ogmacam_PullImageV4(HOgmacam h, void* pImageData, int bStill, int bits, int rowPitch, OgmacamFrameInfoV4* pInfo);
OGMACAM_API(HRESULT) Ogmacam_WaitImageV4(HOgmacam h, unsigned nWaitMS, void* pImageData, int bStill, int bits, int rowPitch, OgmacamFrameInfoV4* pInfo);
OGMACAM_API(HRESULT) Ogmacam_PullImageV3(HOgmacam h, void* pImageData, int bStill, int bits, int rowPitch, OgmacamFrameInfoV3* pInfo);
OGMACAM_API(HRESULT) Ogmacam_WaitImageV3(HOgmacam h, unsigned nWaitMS, void* pImageData, int bStill, int bits, int rowPitch, OgmacamFrameInfoV3* pInfo);
typedef struct {
unsigned width;
unsigned height;
unsigned flag; /* OGMACAM_FRAMEINFO_FLAG_xxxx */
unsigned seq; /* frame sequence number */
unsigned long long timestamp; /* microsecond */
} OgmacamFrameInfoV2;
OGMACAM_API(HRESULT) Ogmacam_PullImageV2(HOgmacam h, void* pImageData, int bits, OgmacamFrameInfoV2* pInfo);
OGMACAM_API(HRESULT) Ogmacam_PullStillImageV2(HOgmacam h, void* pImageData, int bits, OgmacamFrameInfoV2* pInfo);
OGMACAM_API(HRESULT) Ogmacam_PullImageWithRowPitchV2(HOgmacam h, void* pImageData, int bits, int rowPitch, OgmacamFrameInfoV2* pInfo);
OGMACAM_API(HRESULT) Ogmacam_PullStillImageWithRowPitchV2(HOgmacam h, void* pImageData, int bits, int rowPitch, OgmacamFrameInfoV2* pInfo);
OGMACAM_API(HRESULT) Ogmacam_PullImage(HOgmacam h, void* pImageData, int bits, unsigned* pnWidth, unsigned* pnHeight);
OGMACAM_API(HRESULT) Ogmacam_PullStillImage(HOgmacam h, void* pImageData, int bits, unsigned* pnWidth, unsigned* pnHeight);
OGMACAM_API(HRESULT) Ogmacam_PullImageWithRowPitch(HOgmacam h, void* pImageData, int bits, int rowPitch, unsigned* pnWidth, unsigned* pnHeight);
OGMACAM_API(HRESULT) Ogmacam_PullStillImageWithRowPitch(HOgmacam h, void* pImageData, int bits, int rowPitch, unsigned* pnWidth, unsigned* pnHeight);
/*
(NULL == pData) means something error
ctxData is the callback context which is passed by Ogmacam_StartPushModeV3
bSnap: TRUE if Ogmacam_Snap
funData is callbacked by an internal thread of ogmacam.dll, so please pay attention to multithread problem.
Do NOT call Ogmacam_Close, Ogmacam_Stop in this callback context, it deadlocks.
*/
typedef void (__stdcall* POGMACAM_DATA_CALLBACK_V4)(const void* pData, const OgmacamFrameInfoV3* pInfo, int bSnap, void* ctxData);
OGMACAM_API(HRESULT) Ogmacam_StartPushModeV4(HOgmacam h, POGMACAM_DATA_CALLBACK_V4 funData, void* ctxData, POGMACAM_EVENT_CALLBACK funEvent, void* ctxEvent);
typedef void (__stdcall* POGMACAM_DATA_CALLBACK_V3)(const void* pData, const OgmacamFrameInfoV2* pInfo, int bSnap, void* ctxData);
OGMACAM_API(HRESULT) Ogmacam_StartPushModeV3(HOgmacam h, POGMACAM_DATA_CALLBACK_V3 funData, void* ctxData, POGMACAM_EVENT_CALLBACK funEvent, void* ctxEvent);
OGMACAM_API(HRESULT) Ogmacam_Stop(HOgmacam h);
OGMACAM_API(HRESULT) Ogmacam_Pause(HOgmacam h, int bPause); /* 1 => pause, 0 => continue */
/* for pull mode: OGMACAM_EVENT_STILLIMAGE, and then Ogmacam_PullStillImageXXXX/Ogmacam_PullImageV4
for push mode: the snapped image will be return by POGMACAM_DATA_CALLBACK(V2/V3), with the parameter 'bSnap' set to 'TRUE'
nResolutionIndex = 0xffffffff means use the cureent preview resolution
*/
OGMACAM_API(HRESULT) Ogmacam_Snap(HOgmacam h, unsigned nResolutionIndex); /* still image snap */
OGMACAM_API(HRESULT) Ogmacam_SnapN(HOgmacam h, unsigned nResolutionIndex, unsigned nNumber); /* multiple still image snap */
OGMACAM_API(HRESULT) Ogmacam_SnapR(HOgmacam h, unsigned nResolutionIndex, unsigned nNumber); /* multiple RAW still image snap */
/*
soft trigger:
nNumber: 0xffff: trigger continuously
0: cancel trigger, see OGMACAM_OPTION_TRIGGER_CANCEL_MODE
others: number of images to be triggered
*/
OGMACAM_API(HRESULT) Ogmacam_Trigger(HOgmacam h, unsigned short nNumber);
/*
trigger synchronously
nWaitMS: 0: by default, exposure * 102% + 4000 milliseconds
0xffffffff: wait infinite
other: milliseconds to wait
*/
OGMACAM_API(HRESULT) Ogmacam_TriggerSyncV4(HOgmacam h, unsigned nWaitMS, void* pImageData, int bits, int rowPitch, OgmacamFrameInfoV4* pInfo);
OGMACAM_API(HRESULT) Ogmacam_TriggerSync(HOgmacam h, unsigned nWaitMS, void* pImageData, int bits, int rowPitch, OgmacamFrameInfoV3* pInfo);
/*
put_Size, put_eSize, can be used to set the video output resolution BEFORE Ogmacam_StartXXXX.
put_Size use width and height parameters, put_eSize use the index parameter.
for example, UCMOS03100KPA support the following resolutions:
index 0: 2048, 1536
index 1: 1024, 768
index 2: 680, 510
so, we can use put_Size(h, 1024, 768) or put_eSize(h, 1). Both have the same effect.
*/
OGMACAM_API(HRESULT) Ogmacam_put_Size(HOgmacam h, int nWidth, int nHeight);
OGMACAM_API(HRESULT) Ogmacam_get_Size(HOgmacam h, int* pWidth, int* pHeight);
OGMACAM_API(HRESULT) Ogmacam_put_eSize(HOgmacam h, unsigned nResolutionIndex);
OGMACAM_API(HRESULT) Ogmacam_get_eSize(HOgmacam h, unsigned* pnResolutionIndex);
/*
final image size after ROI, rotate, binning
*/
OGMACAM_API(HRESULT) Ogmacam_get_FinalSize(HOgmacam h, int* pWidth, int* pHeight);
OGMACAM_API(HRESULT) Ogmacam_get_ResolutionNumber(HOgmacam h);
OGMACAM_API(HRESULT) Ogmacam_get_Resolution(HOgmacam h, unsigned nResolutionIndex, int* pWidth, int* pHeight);
/*
numerator/denominator, such as: 1/1, 1/2, 1/3
*/
OGMACAM_API(HRESULT) Ogmacam_get_ResolutionRatio(HOgmacam h, unsigned nResolutionIndex, int* pNumerator, int* pDenominator);
OGMACAM_API(HRESULT) Ogmacam_get_Field(HOgmacam h);
/*
see: http://www.siliconimaging.com/RGB%20Bayer.htm
FourCC:
MAKEFOURCC('G', 'B', 'R', 'G')
MAKEFOURCC('R', 'G', 'G', 'B')
MAKEFOURCC('B', 'G', 'G', 'R')
MAKEFOURCC('G', 'R', 'B', 'G')
MAKEFOURCC('Y', 'Y', 'Y', 'Y'), monochromatic sensor
MAKEFOURCC('Y', '4', '1', '1'), yuv411
MAKEFOURCC('V', 'U', 'Y', 'Y'), yuv422
MAKEFOURCC('U', 'Y', 'V', 'Y'), yuv422
MAKEFOURCC('Y', '4', '4', '4'), yuv444
MAKEFOURCC('R', 'G', 'B', '8'), RGB888
#ifndef MAKEFOURCC
#define MAKEFOURCC(a, b, c, d) ((unsigned)(unsigned char)(a) | ((unsigned)(unsigned char)(b) << 8) | ((unsigned)(unsigned char)(c) << 16) | ((unsigned)(unsigned char)(d) << 24))
#endif
*/
OGMACAM_API(HRESULT) Ogmacam_get_RawFormat(HOgmacam h, unsigned* pFourCC, unsigned* pBitsPerPixel);
/*
------------------------------------------------------------------|
| Parameter | Range | Default |
|-----------------------------------------------------------------|
| Auto Exposure Target | 10~220 | 120 |
| Exposure Gain | 100~ | 100 |
| Temp | 1000~25000 | 6503 |
| Tint | 100~2500 | 1000 |
| LevelRange | 0~255 | Low = 0, High = 255 |
| Contrast | -255~255 | 0 |
| Hue | -180~180 | 0 |
| Saturation | 0~255 | 128 |
| Brightness | -255~255 | 0 |
| Gamma | 20~180 | 100 |
| WBGain | -127~127 | 0 |
------------------------------------------------------------------|
*/
#ifndef __OGMACAM_CALLBACK_DEFINED__
#define __OGMACAM_CALLBACK_DEFINED__
typedef void (__stdcall* PIOGMACAM_EXPOSURE_CALLBACK)(void* ctxExpo); /* auto exposure */
typedef void (__stdcall* PIOGMACAM_WHITEBALANCE_CALLBACK)(const int aGain[3], void* ctxWB); /* once white balance, RGB Gain mode */
typedef void (__stdcall* PIOGMACAM_BLACKBALANCE_CALLBACK)(const unsigned short aSub[3], void* ctxBB); /* once black balance */
typedef void (__stdcall* PIOGMACAM_TEMPTINT_CALLBACK)(const int nTemp, const int nTint, void* ctxTT); /* once white balance, Temp/Tint Mode */
typedef void (__stdcall* PIOGMACAM_HISTOGRAM_CALLBACK)(const float aHistY[256], const float aHistR[256], const float aHistG[256], const float aHistB[256], void* ctxHistogram);
typedef void (__stdcall* PIOGMACAM_CHROME_CALLBACK)(void* ctxChrome);
typedef void (__stdcall* PIOGMACAM_PROGRESS)(int percent, void* ctxProgress);
#endif
/*
* nFlag & 0x00008000: mono or color
* nFlag & 0x0f: bitdepth
* so the size of aHist is:
int arraySize = 1 << (nFlag & 0x0f);
if ((nFlag & 0x00008000) == 0)
arraySize *= 3;
*/
typedef void (__stdcall* PIOGMACAM_HISTOGRAM_CALLBACKV2)(const unsigned* aHist, unsigned nFlag, void* ctxHistogramV2);
/*
* bAutoExposure:
* 0: disable auto exposure
* 1: auto exposure continue mode
* 2: auto exposure once mode
*/
OGMACAM_API(HRESULT) Ogmacam_get_AutoExpoEnable(HOgmacam h, int* bAutoExposure);
OGMACAM_API(HRESULT) Ogmacam_put_AutoExpoEnable(HOgmacam h, int bAutoExposure);
OGMACAM_API(HRESULT) Ogmacam_get_AutoExpoTarget(HOgmacam h, unsigned short* Target);
OGMACAM_API(HRESULT) Ogmacam_put_AutoExpoTarget(HOgmacam h, unsigned short Target);
/* set the maximum/minimal auto exposure time and agin. The default maximum auto exposure time is 350ms */
OGMACAM_API(HRESULT) Ogmacam_put_AutoExpoRange(HOgmacam h, unsigned maxTime, unsigned minTime, unsigned short maxGain, unsigned short minGain);
OGMACAM_API(HRESULT) Ogmacam_get_AutoExpoRange(HOgmacam h, unsigned* maxTime, unsigned* minTime, unsigned short* maxGain, unsigned short* minGain);
OGMACAM_API(HRESULT) Ogmacam_put_MaxAutoExpoTimeAGain(HOgmacam h, unsigned maxTime, unsigned short maxGain);
OGMACAM_API(HRESULT) Ogmacam_get_MaxAutoExpoTimeAGain(HOgmacam h, unsigned* maxTime, unsigned short* maxGain);
OGMACAM_API(HRESULT) Ogmacam_put_MinAutoExpoTimeAGain(HOgmacam h, unsigned minTime, unsigned short minGain);
OGMACAM_API(HRESULT) Ogmacam_get_MinAutoExpoTimeAGain(HOgmacam h, unsigned* minTime, unsigned short* minGain);
OGMACAM_API(HRESULT) Ogmacam_get_ExpoTime(HOgmacam h, unsigned* Time); /* in microseconds */
OGMACAM_API(HRESULT) Ogmacam_put_ExpoTime(HOgmacam h, unsigned Time); /* in microseconds */
OGMACAM_API(HRESULT) Ogmacam_get_RealExpoTime(HOgmacam h, unsigned* Time); /* actual exposure time */
OGMACAM_API(HRESULT) Ogmacam_get_ExpTimeRange(HOgmacam h, unsigned* nMin, unsigned* nMax, unsigned* nDef);
OGMACAM_API(HRESULT) Ogmacam_get_ExpoAGain(HOgmacam h, unsigned short* Gain); /* percent, such as 300 */
OGMACAM_API(HRESULT) Ogmacam_put_ExpoAGain(HOgmacam h, unsigned short Gain); /* percent */
OGMACAM_API(HRESULT) Ogmacam_get_ExpoAGainRange(HOgmacam h, unsigned short* nMin, unsigned short* nMax, unsigned short* nDef);
/* Auto White Balance "Once", Temp/Tint Mode */
OGMACAM_API(HRESULT) Ogmacam_AwbOnce(HOgmacam h, PIOGMACAM_TEMPTINT_CALLBACK funTT, void* ctxTT); /* auto white balance "once". This function must be called AFTER Ogmacam_StartXXXX */
/* Auto White Balance "Once", RGB Gain Mode */
OGMACAM_API(HRESULT) Ogmacam_AwbInit(HOgmacam h, PIOGMACAM_WHITEBALANCE_CALLBACK funWB, void* ctxWB);
/* White Balance, Temp/Tint mode */
OGMACAM_API(HRESULT) Ogmacam_put_TempTint(HOgmacam h, int nTemp, int nTint);
OGMACAM_API(HRESULT) Ogmacam_get_TempTint(HOgmacam h, int* nTemp, int* nTint);
/* White Balance, RGB Gain mode */
OGMACAM_API(HRESULT) Ogmacam_put_WhiteBalanceGain(HOgmacam h, int aGain[3]);
OGMACAM_API(HRESULT) Ogmacam_get_WhiteBalanceGain(HOgmacam h, int aGain[3]);
/* Black Balance */
OGMACAM_API(HRESULT) Ogmacam_AbbOnce(HOgmacam h, PIOGMACAM_BLACKBALANCE_CALLBACK funBB, void* ctxBB); /* auto black balance "once". This function must be called AFTER Ogmacam_StartXXXX */
OGMACAM_API(HRESULT) Ogmacam_put_BlackBalance(HOgmacam h, unsigned short aSub[3]);
OGMACAM_API(HRESULT) Ogmacam_get_BlackBalance(HOgmacam h, unsigned short aSub[3]);
/* Flat Field Correction */
OGMACAM_API(HRESULT) Ogmacam_FfcOnce(HOgmacam h);
#if defined(_WIN32)
OGMACAM_API(HRESULT) Ogmacam_FfcExport(HOgmacam h, const wchar_t* filePath);
OGMACAM_API(HRESULT) Ogmacam_FfcImport(HOgmacam h, const wchar_t* filePath);
#else
OGMACAM_API(HRESULT) Ogmacam_FfcExport(HOgmacam h, const char* filePath);
OGMACAM_API(HRESULT) Ogmacam_FfcImport(HOgmacam h, const char* filePath);
#endif
/* Dark Field Correction */
OGMACAM_API(HRESULT) Ogmacam_DfcOnce(HOgmacam h);
#if defined(_WIN32)
OGMACAM_API(HRESULT) Ogmacam_DfcExport(HOgmacam h, const wchar_t* filePath);
OGMACAM_API(HRESULT) Ogmacam_DfcImport(HOgmacam h, const wchar_t* filePath);
#else
OGMACAM_API(HRESULT) Ogmacam_DfcExport(HOgmacam h, const char* filePath);
OGMACAM_API(HRESULT) Ogmacam_DfcImport(HOgmacam h, const char* filePath);
#endif
/* Fix Pattern Noise Correction */
OGMACAM_API(HRESULT) Ogmacam_FpncOnce(HOgmacam h);
#if defined(_WIN32)
OGMACAM_API(HRESULT) Ogmacam_FpncExport(HOgmacam h, const wchar_t* filePath);
OGMACAM_API(HRESULT) Ogmacam_FpncImport(HOgmacam h, const wchar_t* filePath);
#else
OGMACAM_API(HRESULT) Ogmacam_FpncExport(HOgmacam h, const char* filePath);
OGMACAM_API(HRESULT) Ogmacam_FpncImport(HOgmacam h, const char* filePath);
#endif
OGMACAM_API(HRESULT) Ogmacam_put_Hue(HOgmacam h, int Hue);
OGMACAM_API(HRESULT) Ogmacam_get_Hue(HOgmacam h, int* Hue);
OGMACAM_API(HRESULT) Ogmacam_put_Saturation(HOgmacam h, int Saturation);
OGMACAM_API(HRESULT) Ogmacam_get_Saturation(HOgmacam h, int* Saturation);
OGMACAM_API(HRESULT) Ogmacam_put_Brightness(HOgmacam h, int Brightness);
OGMACAM_API(HRESULT) Ogmacam_get_Brightness(HOgmacam h, int* Brightness);
OGMACAM_API(HRESULT) Ogmacam_get_Contrast(HOgmacam h, int* Contrast);
OGMACAM_API(HRESULT) Ogmacam_put_Contrast(HOgmacam h, int Contrast);
OGMACAM_API(HRESULT) Ogmacam_get_Gamma(HOgmacam h, int* Gamma); /* percent */
OGMACAM_API(HRESULT) Ogmacam_put_Gamma(HOgmacam h, int Gamma); /* percent */
OGMACAM_API(HRESULT) Ogmacam_get_Chrome(HOgmacam h, int* bChrome); /* 1 => monochromatic mode, 0 => color mode */
OGMACAM_API(HRESULT) Ogmacam_put_Chrome(HOgmacam h, int bChrome);
OGMACAM_API(HRESULT) Ogmacam_get_VFlip(HOgmacam h, int* bVFlip); /* vertical flip */
OGMACAM_API(HRESULT) Ogmacam_put_VFlip(HOgmacam h, int bVFlip);
OGMACAM_API(HRESULT) Ogmacam_get_HFlip(HOgmacam h, int* bHFlip);
OGMACAM_API(HRESULT) Ogmacam_put_HFlip(HOgmacam h, int bHFlip); /* horizontal flip */
OGMACAM_API(HRESULT) Ogmacam_get_Negative(HOgmacam h, int* bNegative); /* negative film */
OGMACAM_API(HRESULT) Ogmacam_put_Negative(HOgmacam h, int bNegative);
OGMACAM_API(HRESULT) Ogmacam_put_Speed(HOgmacam h, unsigned short nSpeed);
OGMACAM_API(HRESULT) Ogmacam_get_Speed(HOgmacam h, unsigned short* pSpeed);
OGMACAM_API(HRESULT) Ogmacam_get_MaxSpeed(HOgmacam h); /* get the maximum speed, see "Frame Speed Level", the speed range = [0, max], closed interval */
OGMACAM_API(HRESULT) Ogmacam_get_FanMaxSpeed(HOgmacam h); /* get the maximum fan speed, the fan speed range = [0, max], closed interval */
OGMACAM_API(HRESULT) Ogmacam_get_MaxBitDepth(HOgmacam h); /* get the max bitdepth of this camera, such as 8, 10, 12, 14, 16 */
/* power supply of lighting:
0 => 60HZ AC
1 => 50Hz AC
2 => DC
*/
OGMACAM_API(HRESULT) Ogmacam_put_HZ(HOgmacam h, int nHZ);
OGMACAM_API(HRESULT) Ogmacam_get_HZ(HOgmacam h, int* nHZ);
OGMACAM_API(HRESULT) Ogmacam_put_Mode(HOgmacam h, int bSkip); /* skip or bin */
OGMACAM_API(HRESULT) Ogmacam_get_Mode(HOgmacam h, int* bSkip); /* If the model don't support bin/skip mode, return E_NOTIMPL */
#if !defined(_WIN32)
#ifndef __RECT_DEFINED__
#define __RECT_DEFINED__
typedef struct {
int left;
int top;
int right;
int bottom;
} RECT, *PRECT;
#endif
#endif
OGMACAM_API(HRESULT) Ogmacam_put_AWBAuxRect(HOgmacam h, const RECT* pAuxRect); /* auto white balance ROI */
OGMACAM_API(HRESULT) Ogmacam_get_AWBAuxRect(HOgmacam h, RECT* pAuxRect);
OGMACAM_API(HRESULT) Ogmacam_put_AEAuxRect(HOgmacam h, const RECT* pAuxRect); /* auto exposure ROI */
OGMACAM_API(HRESULT) Ogmacam_get_AEAuxRect(HOgmacam h, RECT* pAuxRect);
OGMACAM_API(HRESULT) Ogmacam_put_ABBAuxRect(HOgmacam h, const RECT* pAuxRect); /* auto black balance ROI */
OGMACAM_API(HRESULT) Ogmacam_get_ABBAuxRect(HOgmacam h, RECT* pAuxRect);
/*
S_FALSE: color mode
S_OK: mono mode, such as EXCCD00300KMA and UHCCD01400KMA
*/
OGMACAM_API(HRESULT) Ogmacam_get_MonoMode(HOgmacam h);
OGMACAM_API(HRESULT) Ogmacam_get_StillResolutionNumber(HOgmacam h);
OGMACAM_API(HRESULT) Ogmacam_get_StillResolution(HOgmacam h, unsigned nResolutionIndex, int* pWidth, int* pHeight);
/* 0: no realtime
stop grab frame when frame buffer deque is full, until the frames in the queue are pulled away and the queue is not full
1: realtime
use minimum frame buffer. When new frame arrive, drop all the pending frame regardless of whether the frame buffer is full.
If DDR present, also limit the DDR frame buffer to only one frame.
2: soft realtime
Drop the oldest frame when the queue is full and then enqueue the new frame
default: 0
*/
OGMACAM_API(HRESULT) Ogmacam_put_RealTime(HOgmacam h, int val);
OGMACAM_API(HRESULT) Ogmacam_get_RealTime(HOgmacam h, int* val);
/* discard the current internal frame cache.
If DDR present, also discard the frames in the DDR.
Ogmacam_Flush is obsolete, recommend using Ogmacam_put_Option(h, OGMACAM_OPTION_FLUSH, 3)
*/
OGMACAM_DEPRECATED
OGMACAM_API(HRESULT) Ogmacam_Flush(HOgmacam h);
/* get the temperature of the sensor, in 0.1 degrees Celsius (32 means 3.2 degrees Celsius, -35 means -3.5 degree Celsius)
return E_NOTIMPL if not supported
*/
OGMACAM_API(HRESULT) Ogmacam_get_Temperature(HOgmacam h, short* pTemperature);
/* set the target temperature of the sensor or TEC, in 0.1 degrees Celsius (32 means 3.2 degrees Celsius, -35 means -3.5 degree Celsius)
set "-2730" or below means using the default value of this model
return E_NOTIMPL if not supported
*/
OGMACAM_API(HRESULT) Ogmacam_put_Temperature(HOgmacam h, short nTemperature);
/*
get the revision
*/
OGMACAM_API(HRESULT) Ogmacam_get_Revision(HOgmacam h, unsigned short* pRevision);
/*
get the serial number which is always 32 chars which is zero-terminated such as "TP110826145730ABCD1234FEDC56787"
*/
OGMACAM_API(HRESULT) Ogmacam_get_SerialNumber(HOgmacam h, char sn[32]);
/*
get the camera firmware version, such as: 3.2.1.20140922
*/
OGMACAM_API(HRESULT) Ogmacam_get_FwVersion(HOgmacam h, char fwver[16]);
/*
get the camera hardware version, such as: 3.12
*/
OGMACAM_API(HRESULT) Ogmacam_get_HwVersion(HOgmacam h, char hwver[16]);
/*
get the production date, such as: 20150327, YYYYMMDD, (YYYY: year, MM: month, DD: day)
*/
OGMACAM_API(HRESULT) Ogmacam_get_ProductionDate(HOgmacam h, char pdate[10]);
/*
get the FPGA version, such as: 1.13
*/
OGMACAM_API(HRESULT) Ogmacam_get_FpgaVersion(HOgmacam h, char fpgaver[16]);
/*
get the sensor pixel size, such as: 2.4um x 2.4um
*/
OGMACAM_API(HRESULT) Ogmacam_get_PixelSize(HOgmacam h, unsigned nResolutionIndex, float* x, float* y);
/* software level range */
OGMACAM_API(HRESULT) Ogmacam_put_LevelRange(HOgmacam h, unsigned short aLow[4], unsigned short aHigh[4]);
OGMACAM_API(HRESULT) Ogmacam_get_LevelRange(HOgmacam h, unsigned short aLow[4], unsigned short aHigh[4]);
/* hardware level range mode */
#define OGMACAM_LEVELRANGE_MANUAL 0x0000 /* manual */
#define OGMACAM_LEVELRANGE_ONCE 0x0001 /* once */
#define OGMACAM_LEVELRANGE_CONTINUE 0x0002 /* continue */
#define OGMACAM_LEVELRANGE_ROI 0xffff /* update roi rect only */
OGMACAM_API(HRESULT) Ogmacam_put_LevelRangeV2(HOgmacam h, unsigned short mode, const RECT* pRoiRect, unsigned short aLow[4], unsigned short aHigh[4]);
OGMACAM_API(HRESULT) Ogmacam_get_LevelRangeV2(HOgmacam h, unsigned short* pMode, RECT* pRoiRect, unsigned short aLow[4], unsigned short aHigh[4]);
/*
The following functions must be called AFTER Ogmacam_StartPushMode or Ogmacam_StartPullModeWithWndMsg or Ogmacam_StartPullModeWithCallback
*/
OGMACAM_API(HRESULT) Ogmacam_LevelRangeAuto(HOgmacam h); /* software level range */
OGMACAM_API(HRESULT) Ogmacam_GetHistogram(HOgmacam h, PIOGMACAM_HISTOGRAM_CALLBACK funHistogram, void* ctxHistogram);
OGMACAM_API(HRESULT) Ogmacam_GetHistogramV2(HOgmacam h, PIOGMACAM_HISTOGRAM_CALLBACKV2 funHistogramV2, void* ctxHistogramV2);
/* led state:
iLed: Led index, (0, 1, 2, ...)
iState: 1 => Ever bright; 2 => Flashing; other => Off
iPeriod: Flashing Period (>= 500ms)
*/
OGMACAM_API(HRESULT) Ogmacam_put_LEDState(HOgmacam h, unsigned short iLed, unsigned short iState, unsigned short iPeriod);
OGMACAM_API(HRESULT) Ogmacam_write_EEPROM(HOgmacam h, unsigned addr, const unsigned char* pBuffer, unsigned nBufferLen);
OGMACAM_API(HRESULT) Ogmacam_read_EEPROM(HOgmacam h, unsigned addr, unsigned char* pBuffer, unsigned nBufferLen);
OGMACAM_API(HRESULT) Ogmacam_read_Pipe(HOgmacam h, unsigned pipeId, void* pBuffer, unsigned nBufferLen);
OGMACAM_API(HRESULT) Ogmacam_write_Pipe(HOgmacam h, unsigned pipeId, const void* pBuffer, unsigned nBufferLen);
OGMACAM_API(HRESULT) Ogmacam_feed_Pipe(HOgmacam h, unsigned pipeId);
#define OGMACAM_OPTION_NOFRAME_TIMEOUT 0x01 /* no frame timeout: 0 => disable, positive value (>= OGMACAM_NOFRAME_TIMEOUT_MIN) => timeout milliseconds. default: disable */
#define OGMACAM_OPTION_THREAD_PRIORITY 0x02 /* set the priority of the internal thread which grab data from the usb device.
Win: iValue: 0 => THREAD_PRIORITY_NORMAL; 1 => THREAD_PRIORITY_ABOVE_NORMAL; 2 => THREAD_PRIORITY_HIGHEST; 3 => THREAD_PRIORITY_TIME_CRITICAL; default: 1; see: https://docs.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-setthreadpriority
Linux & macOS: The high 16 bits for the scheduling policy, and the low 16 bits for the priority; see: https://linux.die.net/man/3/pthread_setschedparam
*/
#define OGMACAM_OPTION_PROCESSMODE 0x03 /* obsolete & useless, noop. 0 = better image quality, more cpu usage. this is the default value; 1 = lower image quality, less cpu usage */
#define OGMACAM_OPTION_RAW 0x04 /* raw data mode, read the sensor "raw" data. This can be set only while camea is NOT running. 0 = rgb, 1 = raw, default value: 0 */
#define OGMACAM_OPTION_HISTOGRAM 0x05 /* 0 = only one, 1 = continue mode */
#define OGMACAM_OPTION_BITDEPTH 0x06 /* 0 = 8 bits mode, 1 = 16 bits mode, subset of OGMACAM_OPTION_PIXEL_FORMAT */
#define OGMACAM_OPTION_FAN 0x07 /* 0 = turn off the cooling fan, [1, max] = fan speed, , set to "-1" means to use default fan speed */
#define OGMACAM_OPTION_TEC 0x08 /* 0 = turn off the thermoelectric cooler, 1 = turn on the thermoelectric cooler */
#define OGMACAM_OPTION_LINEAR 0x09 /* 0 = turn off the builtin linear tone mapping, 1 = turn on the builtin linear tone mapping, default value: 1 */
#define OGMACAM_OPTION_CURVE 0x0a /* 0 = turn off the builtin curve tone mapping, 1 = turn on the builtin polynomial curve tone mapping, 2 = logarithmic curve tone mapping, default value: 2 */
#define OGMACAM_OPTION_TRIGGER 0x0b /* 0 = video mode, 1 = software or simulated trigger mode, 2 = external trigger mode, 3 = external + software trigger, 4 = self trigger, default value = 0 */
#define OGMACAM_OPTION_RGB 0x0c /* 0 => RGB24; 1 => enable RGB48 format when bitdepth > 8; 2 => RGB32; 3 => 8 Bits Grey (only for mono camera); 4 => 16 Bits Grey (only for mono camera when bitdepth > 8); 5 => 64(RGB64) */
#define OGMACAM_OPTION_COLORMATIX 0x0d /* enable or disable the builtin color matrix, default value: 1 */
#define OGMACAM_OPTION_WBGAIN 0x0e /* enable or disable the builtin white balance gain, default value: 1 */
#define OGMACAM_OPTION_TECTARGET 0x0f /* get or set the target temperature of the thermoelectric cooler, in 0.1 degree Celsius. For example, 125 means 12.5 degree Celsius, -35 means -3.5 degree Celsius. Set "-2730" or below means using the default for that model */
#define OGMACAM_OPTION_AUTOEXP_POLICY 0x10 /* auto exposure policy:
0: Exposure Only
1: Exposure Preferred
2: Gain Only
3: Gain Preferred
default value: 1
*/
#define OGMACAM_OPTION_FRAMERATE 0x11 /* limit the frame rate, the default value 0 means no limit */
#define OGMACAM_OPTION_DEMOSAIC 0x12 /* demosaic method for both video and still image: BILINEAR = 0, VNG(Variable Number of Gradients) = 1, PPG(Patterned Pixel Grouping) = 2, AHD(Adaptive Homogeneity Directed) = 3, EA(Edge Aware) = 4, see https://en.wikipedia.org/wiki/Demosaicing
In terms of CPU usage, EA is the lowest, followed by BILINEAR, and the others are higher.
default value: 0
*/
#define OGMACAM_OPTION_DEMOSAIC_VIDEO 0x13 /* demosaic method for video */
#define OGMACAM_OPTION_DEMOSAIC_STILL 0x14 /* demosaic method for still image */
#define OGMACAM_OPTION_BLACKLEVEL 0x15 /* black level */
#define OGMACAM_OPTION_MULTITHREAD 0x16 /* multithread image processing */
#define OGMACAM_OPTION_BINNING 0x17 /* binning
0x01: (no binning)
n: (saturating add, n*n), 0x02(2*2), 0x03(3*3), 0x04(4*4), 0x05(5*5), 0x06(6*6), 0x07(7*7), 0x08(8*8). The Bitdepth of the data remains unchanged.
0x40 | n: (unsaturated add, n*n, works only in RAW mode), 0x42(2*2), 0x43(3*3), 0x44(4*4), 0x45(5*5), 0x46(6*6), 0x47(7*7), 0x48(8*8). The Bitdepth of the data is increased. For example, the original data with bitdepth of 12 will increase the bitdepth by 2 bits and become 14 after 2*2 binning.
0x80 | n: (average, n*n), 0x82(2*2), 0x83(3*3), 0x84(4*4), 0x85(5*5), 0x86(6*6), 0x87(7*7), 0x88(8*8). The Bitdepth of the data remains unchanged.
The final image size is rounded down to an even number, such as 640/3 to get 212
*/
#define OGMACAM_OPTION_ROTATE 0x18 /* rotate clockwise: 0, 90, 180, 270 */
#define OGMACAM_OPTION_CG 0x19 /* Conversion Gain:
0 = LCG
1 = HCG
2 = HDR (for camera with flag OGMACAM_FLAG_CGHDR)
2 = MCG (for camera with flag OGMACAM_FLAG_GHOPTO)
*/
#define OGMACAM_OPTION_PIXEL_FORMAT 0x1a /* pixel format, OGMACAM_PIXELFORMAT_xxxx */
#define OGMACAM_OPTION_FFC 0x1b /* flat field correction
set:
0: disable
1: enable
-1: reset
(0xff000000 | n): set the average number to n, [1~255]
get:
(val & 0xff): 0 => disable, 1 => enable, 2 => inited
((val & 0xff00) >> 8): sequence
((val & 0xff0000) >> 16): average number
*/
#define OGMACAM_OPTION_DDR_DEPTH 0x1c /* the number of the frames that DDR can cache
1: DDR cache only one frame
0: Auto:
=> one for video mode when auto exposure is enabled
=> full capacity for others
-1: DDR can cache frames to full capacity
*/
#define OGMACAM_OPTION_DFC 0x1d /* dark field correction
set:
0: disable
1: enable
-1: reset
(0xff000000 | n): set the average number to n, [1~255]
get:
(val & 0xff): 0 => disable, 1 => enable, 2 => inited
((val & 0xff00) >> 8): sequence
((val & 0xff0000) >> 16): average number
*/
#define OGMACAM_OPTION_SHARPENING 0x1e /* Sharpening: (threshold << 24) | (radius << 16) | strength)
strength: [0, 500], default: 0 (disable)
radius: [1, 10]
threshold: [0, 255]
*/
#define OGMACAM_OPTION_FACTORY 0x1f /* restore the factory settings */
#define OGMACAM_OPTION_TEC_VOLTAGE 0x20 /* get the current TEC voltage in 0.1V, 59 mean 5.9V; readonly */
#define OGMACAM_OPTION_TEC_VOLTAGE_MAX 0x21 /* TEC maximum voltage in 0.1V */
#define OGMACAM_OPTION_DEVICE_RESET 0x22 /* reset usb device, simulate a replug */
#define OGMACAM_OPTION_UPSIDE_DOWN 0x23 /* upsize down:
1: yes
0: no
default: 1 (win), 0 (linux/macos)
*/
#define OGMACAM_OPTION_FOCUSPOS 0x24 /* focus positon */
#define OGMACAM_OPTION_AFMODE 0x25 /* auto focus mode, see OgmacamAFMode */
#define OGMACAM_OPTION_AFSTATUS 0x27 /* auto focus status, see OgmacamAFStaus */
#define OGMACAM_OPTION_TESTPATTERN 0x28 /* test pattern:
0: off
3: monochrome diagonal stripes
5: monochrome vertical stripes
7: monochrome horizontal stripes
9: chromatic diagonal stripes
*/
#define OGMACAM_OPTION_AUTOEXP_THRESHOLD 0x29 /* threshold of auto exposure, default value: 5, range = [2, 15] */
#define OGMACAM_OPTION_BYTEORDER 0x2a /* Byte order, BGR or RGB: 0 => RGB, 1 => BGR, default value: 1(Win), 0(macOS, Linux, Android) */
#define OGMACAM_OPTION_NOPACKET_TIMEOUT 0x2b /* no packet timeout: 0 => disable, positive value (>= OGMACAM_NOPACKET_TIMEOUT_MIN) => timeout milliseconds. default: disable */
#define OGMACAM_OPTION_MAX_PRECISE_FRAMERATE 0x2c /* get the precise frame rate maximum value in 0.1 fps, such as 115 means 11.5 fps */
#define OGMACAM_OPTION_PRECISE_FRAMERATE 0x2d /* precise frame rate current value in 0.1 fps. use OGMACAM_OPTION_MAX_PRECISE_FRAMERATE, OGMACAM_OPTION_MIN_PRECISE_FRAMERATE to get the range. if the set value is out of range, E_INVALIDARG will be returned */
#define OGMACAM_OPTION_BANDWIDTH 0x2e /* bandwidth, [1-100]% */
#define OGMACAM_OPTION_RELOAD 0x2f /* reload the last frame in trigger mode */
#define OGMACAM_OPTION_CALLBACK_THREAD 0x30 /* dedicated thread for callback: 0 => disable, 1 => enable, default: 0 */
#define OGMACAM_OPTION_FRONTEND_DEQUE_LENGTH 0x31 /* frontend (raw) frame buffer deque length, range: [2, 1024], default: 4
All the memory will be pre-allocated when the camera starts, so, please attention to memory usage
*/
#define OGMACAM_OPTION_FRAME_DEQUE_LENGTH 0x31 /* alias of OGMACAM_OPTION_FRONTEND_DEQUE_LENGTH */
#define OGMACAM_OPTION_MIN_PRECISE_FRAMERATE 0x32 /* get the precise frame rate minimum value in 0.1 fps, such as 15 means 1.5 fps */
#define OGMACAM_OPTION_SEQUENCER_ONOFF 0x33 /* sequencer trigger: on/off */
#define OGMACAM_OPTION_SEQUENCER_NUMBER 0x34 /* sequencer trigger: number, range = [1, 255] */
#define OGMACAM_OPTION_SEQUENCER_EXPOTIME 0x01000000 /* sequencer trigger: exposure time, iOption = OGMACAM_OPTION_SEQUENCER_EXPOTIME | index, iValue = exposure time
For example, to set the exposure time of the third group to 50ms, call:
Ogmacam_put_Option(OGMACAM_OPTION_SEQUENCER_EXPOTIME | 3, 50000)
*/
#define OGMACAM_OPTION_SEQUENCER_EXPOGAIN 0x02000000 /* sequencer trigger: exposure gain, iOption = OGMACAM_OPTION_SEQUENCER_EXPOGAIN | index, iValue = gain */
#define OGMACAM_OPTION_DENOISE 0x35 /* denoise, strength range: [0, 100], 0 means disable */
#define OGMACAM_OPTION_HEAT_MAX 0x36 /* get maximum level: heat to prevent fogging up */
#define OGMACAM_OPTION_HEAT 0x37 /* heat to prevent fogging up */
#define OGMACAM_OPTION_LOW_NOISE 0x38 /* low noise mode (Higher signal noise ratio, lower frame rate): 1 => enable */
#define OGMACAM_OPTION_POWER 0x39 /* get power consumption, unit: milliwatt */
#define OGMACAM_OPTION_GLOBAL_RESET_MODE 0x3a /* global reset mode */
#define OGMACAM_OPTION_OPEN_ERRORCODE 0x3b /* get the open camera error code */
#define OGMACAM_OPTION_FLUSH 0x3d /* 1 = hard flush, discard frames cached by camera DDR (if any)
2 = soft flush, discard frames cached by ogmacam.dll (if any)
3 = both flush
Ogmacam_Flush means 'both flush'
return the number of soft flushed frames if successful, HRESULT if failed
*/
#define OGMACAM_OPTION_NUMBER_DROP_FRAME 0x3e /* get the number of frames that have been grabbed from the USB but dropped by the software */
#define OGMACAM_OPTION_DUMP_CFG 0x3f /* 0 = when camera is stopped, do not dump configuration automatically
1 = when camera is stopped, dump configuration automatically
-1 = explicitly dump configuration once
default: 1
*/
#define OGMACAM_OPTION_DEFECT_PIXEL 0x40 /* Defect Pixel Correction: 0 => disable, 1 => enable; default: 1 */
#define OGMACAM_OPTION_BACKEND_DEQUE_LENGTH 0x41 /* backend (pipelined) frame buffer deque length (Only available in pull mode), range: [2, 1024], default: 3