-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathindex.d.ts
More file actions
769 lines (727 loc) · 21.5 KB
/
Copy pathindex.d.ts
File metadata and controls
769 lines (727 loc) · 21.5 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
export type RawPixelData = Uint8Array | Uint16Array;
/**
* Settings used when decoding a RAW image.
*
* The package exposes an asynchronous API and processes decoding in a Web Worker,
* which helps avoid blocking the main UI thread.
*/
export interface LibRawSettings {
/** Brightness, mapped to `-b <float>`. */
bright?: number;
/** Wavelet denoise threshold, mapped to `-n <float>`. */
threshold?: number;
/** Portion of clipped pixels used for auto-brightening. */
autoBrightThr?: number;
/** Auto-adjust max if channel overflow is above the threshold. */
adjustMaximumThr?: number;
/** Exposure shift in linear scale; requires `expCorrec = true`. */
expShift?: number;
/** Preserve highlights when `expShift > 1` (`0..1`). */
expPreser?: number;
/** Output at half size, mapped to `-h`. */
halfSize?: boolean;
/** Separate interpolation for the two green channels, mapped to `-f`. */
fourColorRgb?: boolean;
/** Highlight mode, mapped to `-H` (`0..9`). */
highlight?: number;
/** Use auto white balance, mapped to `-a`. */
useAutoWb?: boolean;
/** Use the camera's recorded white balance, mapped to `-w`. */
useCameraWb?: boolean;
/** Color profile usage, mapped to `+M/-M` (`0=off, 1=on if WB, 3=always`). */
useCameraMatrix?: number;
/** Output colorspace, mapped to `-o` (`0..8`). */
outputColor?: number;
/** Output bits per sample, mapped to `-4` (`8` or `16`). */
outputBps?: number;
/** Output TIFF if `true`, otherwise PPM, mapped to `-T`. */
outputTiff?: boolean;
/** Bitfield for custom output flags. */
outputFlags?: number;
/** Flip or rotate output, mapped to `-t` (`0..7`, `-1` uses RAW value). */
userFlip?: number;
/** Interpolation quality, mapped to `-q` (`0..12`). */
userQual?: number;
/** User black level, mapped to `-k`. */
userBlack?: number;
/** Per-channel black offsets: red, green, blue, green2. */
userCblack?: [number, number, number, number];
/** Saturation level, mapped to `-S`. */
userSat?: number;
/** Median filter passes, mapped to `-m`. */
medPasses?: number;
/** Disable auto brightness, mapped to `-W`. */
noAutoBright?: boolean;
/** Fuji sensor rotation, mapped to `-j` (`-1` use, `0` off, `1` on). */
useFujiRotate?: number;
/** Fix green channel imbalance. */
greenMatching?: boolean;
/** Additional DCB passes (`-1` disables). */
dcbIterations?: number;
/** Enhance color fidelity in DCB. */
dcbEnhanceFl?: boolean;
/** FBDD denoise strength (`0` off, `1` light, `2` full). */
fbddNoiserd?: number;
/** Enable exposure correction so `expShift` and `expPreser` apply. */
expCorrec?: boolean;
/** Skip `scale_colors`, which affects white balance. */
noAutoScale?: boolean;
/** Skip demosaic entirely and output the raw mosaic. */
noInterpolation?: boolean;
/** WB calculation rectangle: `x, y, width, height`. */
greybox?: [number, number, number, number] | null;
/** Cropping rectangle: `left, top, width, height`, applied before rotation. */
cropbox?: [number, number, number, number] | null;
/** Red and blue channel multipliers. */
aber?: [number, number, number] | null;
/** Tone curve values: `power`, `toe_slope`. */
gamm?: [number, number] | null;
/** User white-balance multipliers: red, green, blue, green2. */
userMul?: [number, number, number, number] | null;
/** Output ICC profile filename, if compiled with LCMS. */
outputProfile?: string | null;
/** Camera ICC profile filename, or `embed`. */
cameraProfile?: string | null;
/** Bad-pixels map filename. */
badPixels?: string | null;
/** Dark-frame filename, expected to be a 16-bit PGM. */
darkFrame?: string | null;
}
/**
* GPS coordinates returned by the metadata wrapper.
*
* The `latitude` and `longitude` properties are 3-number tuples representing
* degrees, minutes and seconds: `[degrees, minutes, seconds]`.
* - `degrees`: integer degrees (latitude 0..90, longitude 0..180)
* - `minutes`: integer minutes (0..59)
* - `seconds`: seconds and fractional seconds (may be a float, e.g. 40.12)
*
* Example: `[51, 28, 40.12]` === 51°28'40.12".
*
* The hemisphere / reference indicators are exposed directly: `latref`
* ('N'/'S'), `longref` ('E'/'W') and `altref` (0 = above sea level, 1 = below).
* `altitude` is expressed in metres. Reference chars are `null` when unset;
* use `gpsparsed` to tell "no GPS in file" from "GPS at 0,0".
*/
export interface GpsData {
latitude: [number, number, number];
longitude: [number, number, number];
altitude: number;
/** Latitude hemisphere: 'N' or 'S'. `null` when unset. */
latref: string | null;
/** Longitude hemisphere: 'E' or 'W'. `null` when unset. */
longref: string | null;
/** Altitude reference: 0 = above sea level, 1 = below sea level. */
altref: number;
/** GPS status: 'A' = valid/active, 'V' = void. `null` when unset. */
gpsstatus: string | null;
/** True when LibRaw populated parsed GPS data for this file. */
gpsparsed: boolean;
}
/** Default-crop rectangle (`imgdata.sizes.raw_inset_crops`). */
export interface RawInsetCrop {
cleft: number;
ctop: number;
cwidth: number;
cheight: number;
}
/** Lens information from `imgdata.lens` (present with full metadata). */
export interface LensInfo {
/** Lens model name. */
Lens: string;
LensMake: string;
LensSerial: string;
InternalLensSerial: string;
MinFocal: number;
MaxFocal: number;
MaxAp4MinFocal: number;
MaxAp4MaxFocal: number;
EXIF_MaxAp: number;
/** Focal length in 35mm-equivalent terms. */
FocalLengthIn35mmFormat: number;
/** Maker-note lens block (`imgdata.lens.makernotes`). */
makernotes: {
Lens: string;
LensID: number;
MinFocal: number;
MaxFocal: number;
MaxAp: number;
MinAp: number;
CurFocal: number;
CurAp: number;
FocalLengthIn35mmFormat: number;
MinFocusDistance: number;
LensMount: number;
CameraMount: number;
body: string;
};
}
/** Normalized shooting info from `imgdata.shootinginfo` (full metadata). */
export interface ShootingInfo {
DriveMode: number;
FocusMode: number;
MeteringMode: number;
AFPoint: number;
ExposureMode: number;
ExposureProgram: number;
ImageStabilization: number;
/** Camera body serial number. */
BodySerial: string;
/** Internal body serial (may be PCB/sensor serial; make/model dependent). */
InternalBodySerial: string;
}
/** Per-illuminant DNG color block (`imgdata.color.dng_color`). */
export interface DngColor {
illuminant: number;
/** 4x3 color matrix. */
colormatrix: number[][];
/** 3x4 forward matrix. */
forwardmatrix: number[][];
/** 4x4 calibration matrix. */
calibration: number[][];
}
/** Curated DNG levels subset (`imgdata.color.dng_levels`). */
export interface DngLevels {
dng_whitelevel: number[];
default_crop: number[];
asshotneutral: number[];
analogbalance: number[];
baseline_exposure: number;
LinearResponseLimit: number;
dng_black: number;
}
/** Color data from `imgdata.color` (present with full metadata). */
export interface ColorData {
black: number;
data_maximum: number;
maximum: number;
fmaximum: number;
fnorm: number;
cam_mul: number[];
pre_mul: number[];
flash_used: number;
canon_ev: number;
model2: string;
UniqueCameraModel: string;
LocalizedCameraModel: string;
ImageUniqueID: string;
RawDataUniqueID: string;
raw_bps: number;
ExifColorSpace: number;
/** 3x4 camera color matrix. */
cmatrix: number[][];
/** 3x4 camera-to-sRGB matrix. */
rgb_cam: number[][];
/** 4x3 camera-to-XYZ matrix. */
cam_xyz: number[][];
/** Embedded ICC profile bytes, or `null` when none is present. */
profile: Uint8Array | null;
profile_length: number;
dng_color: DngColor[];
dng_levels: DngLevels;
}
/**
* Minimal AF item shape exposed through `metadata_common.afdata`.
*/
export interface AfInfoDataItem {
AFInfoData_tag: number;
AFInfoData_order: number;
AFInfoData_version: number;
AFInfoData_length: number;
}
/**
* Shared metadata block emitted by the wrapper.
*/
export interface MetadataCommon {
/** Flash exposure compensation (EC): adjustment to flash output level. */
FlashEC?: number;
/** Flash guide number (GN): indicates flash power rating (typically for ISO 100). */
FlashGN?: number;
CameraTemperature?: number;
SensorTemperature?: number;
SensorTemperature2?: number;
LensTemperature?: number;
AmbientTemperature?: number;
BatteryTemperature?: number;
exifAmbientTemperature?: number;
exifHumidity?: number;
exifPressure?: number;
exifWaterDepth?: number;
exifAcceleration?: number;
exifCameraElevationAngle?: number;
real_ISO?: number;
exifExposureIndex?: number;
ColorSpace?: number;
firmware?: string;
ExposureCalibrationShift?: number;
afdata?: AfInfoDataItem[];
[key: string]: unknown;
}
export type Vec2 = [number, number];
export type Vec3 = [number, number, number];
export type Vec4 = [number, number, number, number];
export type Vec5 = [number, number, number, number, number];
export type Vec6 = [number, number, number, number, number, number];
export type Vec7 = [number, number, number, number, number, number, number];
export type Vec8 = [number, number, number, number, number, number, number, number];
export type Vec9 = [number, number, number, number, number, number, number, number, number];
export type Vec11 = [number, number, number, number, number, number, number, number, number, number, number];
export type Matrix4x3 = [Vec3, Vec3, Vec3, Vec3];
export interface CanonMetadata {
ColorDataVer?: number;
ColorDataSubVer?: number;
SpecularWhiteLevel?: number;
NormalWhiteLevel?: number;
ChannelBlackLevel?: Vec4;
AverageBlackLevel?: number;
multishot?: Vec4;
MeteringMode?: number;
SpotMeteringMode?: number;
FlashMeteringMode?: number;
FlashExposureLock?: number;
ExposureMode?: number;
AESetting?: number;
ImageStabilization?: number;
FlashMode?: number;
FlashActivity?: number;
FlashBits?: number;
ManualFlashOutput?: number;
FlashOutput?: number;
FlashGuideNumber?: number;
ContinuousDrive?: number;
SensorWidth?: number;
SensorHeight?: number;
AFMicroAdjMode?: number;
AFMicroAdjValue?: number;
MakernotesFlip?: number;
RecordMode?: number;
SRAWQuality?: number;
wbi?: number;
RF_lensID?: number;
AutoLightingOptimizer?: number;
HighlightTonePriority?: number;
Quality?: number;
CanonLog?: number;
ISOgain?: Vec2;
}
export interface NikonSensorHighSpeedCrop {
cleft?: number;
ctop?: number;
cwidth?: number;
cheight?: number;
}
export interface NikonMetadata {
NEFBitDepth?: Vec4;
HighSpeedCropFormat?: number;
SensorHighSpeedCrop?: NikonSensorHighSpeedCrop;
SensorWidth?: number;
SensorHeight?: number;
Active_D_Lighting?: number;
ShotInfoVersion?: number;
MakernotesFlip?: number;
RollAngle?: number;
PitchAngle?: number;
YawAngle?: number;
FlashControlCommanderMode?: number;
FlashOutputAndCompensation?: number;
FlashFocalLength?: number;
FlashGNDistance?: number;
FlashGroupOutputAndCompensation?: Vec4;
FlashGroupControlMode0?: number;
FlashGroupControlMode1?: number;
FlashGroupControlMode2?: number;
FlashGroupControlMode3?: number;
FlashColorFilter?: number;
NEFCompression?: number;
ExposureMode?: number;
ExposureProgram?: number;
nMEshots?: number;
MEgainOn?: number;
ME_WB?: Vec4;
AFFineTune?: number;
AFFineTuneIndex?: number;
AFFineTuneAdj?: number;
LensDataVersion?: number | string;
FlashInfoVersion?: number | string;
ColorBalanceVersion?: number | string;
key?: number;
ExposureBracketValue?: number;
ActiveDLighting?: number;
ShootingMode?: number;
ImageStabilization?: Vec7;
VibrationReduction?: number;
FlashSetting?: string;
FlashType?: string;
FlashExposureCompensation?: number[];
ExternalFlashExposureComp?: Vec4;
FlashExposureBracketValue0?: number;
FlashExposureBracketValue1?: number;
FlashExposureBracketValue2?: number;
FlashExposureBracketValue3?: number;
}
export interface FujiMetadata {
ExpoMidPointShift?: number;
DynamicRange?: number;
FilmMode?: number;
DynamicRangeSetting?: number;
DevelopmentDynamicRange?: number;
AutoDynamicRange?: number;
DRangePriority?: number;
DRangePriorityAuto?: number;
DRangePriorityFixed?: number;
ImageStabilization?: Vec3;
FlashMode?: number;
WB_Preset?: number;
ShutterType?: number;
ExrMode?: number;
Macro?: number;
Rating?: number;
CropMode?: number;
SerialSignature?: string;
SensorID?: string;
RAFVersion?: string;
RAFDataGeneration?: number;
RAFDataVersion?: number;
isTSNERDTS?: number;
DriveMode?: number;
BlackLevel?: Vec9;
RAFData_ImageSizeTable?: number[];
AutoBracketing?: number;
SequenceNumber?: number;
SeriesLength?: number;
PixelShiftOffset?: Vec2;
ImageCount?: number;
BrightnessCompensation?: number;
FocusMode?: number;
AFMode?: number;
FocusPixel?: Vec2;
PrioritySettings?: number;
FocusSettings?: number;
AF_C_Settings?: number;
FocusWarning?: number;
}
export interface SonyMetadata {
CameraType?: number;
Sony0x9400_version?: number;
Sony0x9400_ReleaseMode2?: number;
Sony0x9400_SequenceImageNumber?: number;
Sony0x9400_SequenceLength1?: number;
Sony0x9400_SequenceFileNumber?: number;
Sony0x9400_SequenceLength2?: number;
AFAreaModeSetting?: number;
AFAreaMode?: number;
FlexibleSpotPosition?: Vec2;
AFPointSelected?: number;
AFPointSelected_0x201e?: number;
AFType?: number;
FocusLocation?: Vec4;
FocusPosition?: number;
AFMicroAdjValue?: number;
AFMicroAdjOn?: number;
AFMicroAdjRegisteredLenses?: number;
VariableLowPassFilter?: number;
LongExposureNoiseReduction?: number;
HighISONoiseReduction?: number;
numInPixelShiftGroup?: number;
prd_ImageHeight?: number;
prd_ImageWidth?: number;
prd_Total_bps?: number;
prd_Active_bps?: number;
prd_StorageMethod?: number;
prd_BayerPattern?: number;
SonyRawFileType?: number;
RAWFileType?: number;
RawSizeType?: number;
ImageCount3_offset?: number;
ImageCount3?: number;
ElectronicFrontCurtainShutter?: number;
MeteringMode2?: number;
SonyDateTime?: string;
ShotNumberSincePowerUp?: number;
PixelShiftGroupPrefix?: string;
PixelShiftGroupID?: string;
nShotsInPixelShiftGroup?: number;
HDR?: Vec2;
group2010?: number;
group9050?: number;
real_iso_offset?: number;
MeteringMode_offset?: number;
ExposureProgram_offset?: number;
ReleaseMode2_offset?: number;
MinoltaCamID?: number;
firmware?: string;
Quality?: number;
FileFormat?: number;
MetaVersion?: string;
}
export interface PanasonicMetadata {
Compression?: number;
BlackLevelDim?: number;
BlackLevel?: Vec8;
Multishot?: number;
gamma?: number;
HighISOMultiplier?: Vec3;
FocusStepNear?: number;
FocusStepCount?: number;
ZoomPosition?: number;
LensManufacturer?: number;
}
export interface OlympusMetadata {
CameraType2?: Vec6;
ValidBits?: number;
DriveMode?: Vec5;
ColorSpace?: number;
FocusMode?: Vec2;
AutoFocus?: number;
AFPoint?: number;
AFAreas?: number[];
AFPointSelected?: Vec2;
AFResult?: number;
AFFineTune?: number;
AFFineTuneAdj?: Vec3;
AspectFrameLeft?: number;
AspectFrameTop?: number;
AspectFrameWidth?: number;
AspectFrameHeight?: number;
Panorama_mode?: number;
Panorama_frameNum?: number;
}
export interface PentaxMetadata {
DriveMode?: Vec4;
FocusMode?: Vec2;
AFPointSelected?: Vec2;
AFPointSelected_Area?: number;
AFPointsInFocus_version?: number;
AFPointsInFocus?: number;
FocusPosition?: number;
AFAdjustment?: number;
AFPointMode?: number;
MultiExposure?: number;
Quality?: number;
}
export interface HasselbladMetadata {
BaseISO?: number;
Gain?: number;
Sensor?: string;
SensorUnit?: string;
HostBody?: string;
SensorCode?: number;
SensorSubCode?: number;
CoatingCode?: number;
uncropped?: number;
CaptureSequenceInitiator?: string;
SensorUnitConnector?: string;
format?: number;
nIFD_CM?: Vec2;
RecommendedCrop?: Vec2;
mnColorMatrix?: Matrix4x3;
}
export interface RicohMetadata {
AFStatus?: number;
AFAreaXPosition?: Vec2;
AFAreaYPosition?: Vec2;
AFAreaMode?: number;
SensorWidth?: number;
SensorHeight?: number;
CroppedImageWidth?: number;
CroppedImageHeight?: number;
WideAdapter?: number;
CropMode?: number;
NDFilter?: number;
AutoBracketing?: number;
MacroMode?: number;
FlashMode?: number;
FlashExposureComp?: number;
ManualFlashOutput?: number;
}
export interface KodakMetadata {
BlackLevelTop?: number;
BlackLevelBottom?: number;
offset_left?: number;
offset_top?: number;
clipBlack?: number;
clipWhite?: number;
val018percent?: number;
val100percent?: number;
val170percent?: number;
MakerNoteKodak8a?: number;
ISOCalibrationGain?: number;
AnalogISO?: number;
}
export interface PhaseOneMetadata {
Software?: string;
SystemType?: string;
FirmwareString?: string;
SystemModel?: string;
}
export interface SamsungMetadata {
ImageSizeFull?: Vec4;
ImageSizeCrop?: Vec4;
key?: Vec11;
ColorSpace0?: number;
ColorSpace1?: number;
DigitalGain?: number;
DeviceType?: number;
LensFirmware?: string;
}
/**
* Decoded metadata returned by the wrapper.
*/
export interface Metadata {
width: number;
height: number;
raw_width: number;
raw_height: number;
top_margin: number;
left_margin: number;
/** EXIF orientation (0..7). */
flip: number;
camera_make: string;
camera_model: string;
iso_speed: number;
shutter: number;
aperture: number;
focal_len: number;
timestamp: Date;
shot_order: number;
desc: string;
artist: string;
thumb_width: number;
thumb_height: number;
thumb_format: 'unknown' | 'jpeg' | 'bitmap' | 'bitmap16' | 'layer' | 'rollei' | 'h265';
gps_data?: GpsData;
color_data?: ColorData;
metadata_common?: MetadataCommon;
/** Lens info (`imgdata.lens`) — present with full metadata. */
lens?: LensInfo;
/** Normalized shooting info & body serials — present with full metadata. */
shootinginfo?: ShootingInfo;
// Extra identification params (imgdata.idata) — present with full metadata.
software?: string;
normalized_make?: string;
normalized_model?: string;
maker_index?: number;
raw_count?: number;
dng_version?: number;
is_foveon?: number;
colors?: number;
/** Bayer/X-Trans filter pattern bitmask. */
filters?: number;
/** Color channel description, e.g. "RGBG". */
cdesc?: string;
// Extra size params (imgdata.sizes) — present with full metadata.
iwidth?: number;
iheight?: number;
raw_pitch?: number;
pixel_aspect?: number;
raw_aspect?: number;
raw_inset_crops?: RawInsetCrop[];
canon?: CanonMetadata;
nikon?: NikonMetadata;
fuji?: FujiMetadata;
sony?: SonyMetadata;
panasonic?: PanasonicMetadata;
olympus?: OlympusMetadata;
pentax?: PentaxMetadata;
hasselblad?: HasselbladMetadata;
ricoh?: RicohMetadata;
kodak?: KodakMetadata;
p1?: PhaseOneMetadata;
samsung?: SamsungMetadata;
[key: string]: unknown;
}
/**
* Processed RAW image data returned by `imageData()`.
*/
export interface RawImageData {
width: number;
height: number;
colors: number;
bits: number;
dataSize: number;
data: RawPixelData;
}
/**
* Raw, undebayered sensor data returned by `rawImageData()`.
*
* `data` is the 16-bit mosaic straight from the sensor (no demosaicing applied).
* `width`/`height` are the visible image dimensions; `raw_width`/`raw_height`
* include the masked/border pixels, and `top_margin`/`left_margin` give the
* offset of the visible area within the raw frame.
*/
export interface RawSensorData {
raw_width: number;
raw_height: number;
top_margin: number;
left_margin: number;
width: number;
height: number;
data: Uint16Array;
}
/**
* Thumbnail image data returned by `thumbnailData()`.
*/
export interface ThumbnailImageData {
data: Uint8Array;
width: number;
height: number;
format: 'jpeg' | 'bitmap' | 'unknown';
}
/**
* Compatibility alias for metadata returned by {@link LibRaw.metadata}.
*/
export type LibRawMetadata = Metadata;
/**
* Compatibility alias for processed RAW image data.
*/
export type LibRawImageData = RawImageData;
/**
* Compatibility alias for thumbnail image data.
*/
export type LibRawThumbnailData = ThumbnailImageData;
/**
* Compatibility alias for settings used when decoding a RAW image.
*/
export type LibRawOptions = LibRawSettings;
/**
* LibRaw-Wasm decoder.
*
* The runtime is asynchronous: construct an instance, open a RAW buffer, then read
* metadata or decoded image data.
*/
export default class LibRaw {
/** Create a decoder instance. */
constructor();
/**
* Open and decode a RAW buffer.
*/
open(bytes: BufferSource, settings?: LibRawSettings): Promise<void>;
/**
* Fetch metadata extracted from the opened RAW file.
*
* @param fullOutput include vendor-specific metadata blocks (see {@link Metadata.canon}, {@link Metadata.nikon}, etc.)
*/
metadata(fullOutput?: boolean): Promise<LibRawMetadata | undefined>;
/**
* Fetch processed RAW image data for the opened file.
*
* The returned promise **rejects** if decoding fails — for example an
* `unpack()`/`dcraw_process()` error, or a compression format whose decoder is
* unavailable in this build. Wrap the call in `try/catch` (or `.catch()`) to
* handle those cases rather than assuming it always resolves.
*/
imageData(): Promise<LibRawImageData | undefined>;
/**
* Fetch the raw, undebayered sensor data (16-bit mosaic, no demosaicing).
*/
rawImageData(): Promise<RawSensorData | undefined>;
/**
* Fetch the embedded thumbnail preview, when available.
*/
thumbnailData(): Promise<LibRawThumbnailData | undefined>;
/**
* Terminate the underlying worker and reject any in-flight calls.
* The instance is unusable afterwards; create a new one to decode again.
*/
dispose(): void;
}