bioformats 0.1.3

Pure Rust reimplementation of Bio-Formats — read/write scientific image formats
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
//! Gatan DM3 / DM4 format reader (electron microscopy).
//!
//! Supports DM3 (version 3) and DM4 (version 4) Digital Micrograph files.
//! Reads the tag tree to find the primary image data (ImageList entry 1).

use std::collections::HashMap;
use std::fs::File;
use std::io::{BufReader, Read, Seek, SeekFrom};
use std::path::{Path, PathBuf};

use crate::common::error::{BioFormatsError, Result};
use crate::common::metadata::{DimensionOrder, ImageMetadata, MetadataValue};
use crate::common::pixel_type::PixelType;
use crate::common::reader::FormatReader;
use crate::common::region::crop_full_plane;

// ── DM image data types ───────────────────────────────────────────────────────
fn dm_pixel_type_and_bytes(dm_type: i32) -> Result<(PixelType, usize)> {
    match dm_type {
        1 => Ok((PixelType::Int16, 2)),
        2 => Ok((PixelType::Float32, 4)),
        6 => Ok((PixelType::Uint8, 1)),
        7 => Ok((PixelType::Int32, 4)),
        9 => Ok((PixelType::Int8, 1)),
        10 => Ok((PixelType::Uint16, 2)),
        11 => Ok((PixelType::Uint32, 4)),
        12 => Ok((PixelType::Float64, 8)),
        23 => Ok((PixelType::Uint8, 1)),
        other => Err(BioFormatsError::UnsupportedFormat(format!(
            "Gatan DM unsupported data type {other}"
        ))),
    }
}

/// Whether a DM DataType code denotes signed integer/float pixels.
///
/// The DM `DataType` codes encode signedness for the normal path: 1=Int16,
/// 9=Int8, 7=Int32 and 2/12 (float/double) are signed; 6=UInt8, 10=UInt16,
/// 11=UInt32 are unsigned. Java instead reads sign from the `LowLimit` tag
/// (`signed = LowLimit < 0`, GatanReader.java:719-720); gatan.rs does not
/// capture that tag, so we fall back to the DataType's own signedness. For
/// the RGB-ish DataType 23 (Java's `getNumBytes(23)==0`) signedness is
/// unknown, so we treat it as unsigned (matching the Uint8 default).
fn dm_data_type_is_signed(dm_type: i32) -> bool {
    matches!(dm_type, 1 | 2 | 7 | 9 | 12)
}

/// Map (bytes-per-pixel, signed) to a PixelType, mirroring
/// `FormatTools.pixelTypeFromBytes(bytes, signed, /*fp=*/false)`
/// (GatanReader.java:258). Used to reconcile the DataType-derived
/// bytes-per-pixel with the bpp implied by the stored payload length.
fn dm_pixel_type_from_bytes(bytes: usize, signed: bool) -> Result<PixelType> {
    let pt = match (bytes, signed) {
        (1, true) => PixelType::Int8,
        (1, false) => PixelType::Uint8,
        (2, true) => PixelType::Int16,
        (2, false) => PixelType::Uint16,
        (4, true) => PixelType::Int32,
        (4, false) => PixelType::Uint32,
        // 8 bytes: FormatTools maps to DOUBLE when fp, else to the widest
        // available integer. With fp=false and our PixelType set lacking a
        // 64-bit integer, fall back to Float64 to preserve the stride.
        (8, _) => PixelType::Float64,
        _ => {
            return Err(BioFormatsError::UnsupportedFormat(format!(
                "Gatan DM: cannot derive pixel type from {bytes} bytes/pixel (signed={signed})"
            )))
        }
    };
    Ok(pt)
}

// ── Tag value types (DM encoding) ─────────────────────────────────────────────
// info[0] encodes the tag data type:
const DM_TYPE_INT16: u32 = 2;
const DM_TYPE_INT32: u32 = 3;
const DM_TYPE_UINT16: u32 = 4;
const DM_TYPE_UINT32: u32 = 5;
const DM_TYPE_FLOAT32: u32 = 6;
const DM_TYPE_FLOAT64: u32 = 7;
const DM_TYPE_INT8: u32 = 8;
const DM_TYPE_UINT8: u32 = 9;
const DM_TYPE_CHAR: u32 = 10;
const DM_TYPE_INT64: u32 = 11;
const DM_TYPE_UINT64: u32 = 12;
const DM_TYPE_STRUCT: u32 = 15;
const DM_TYPE_ARRAY: u32 = 20;

#[derive(Debug, Clone)]
#[allow(dead_code)]
enum DmValue {
    Int(i64),
    Uint(u64),
    Float(f64),
    Bool(bool),
    Str(String),
    Group(Vec<(String, DmValue)>),
    Array(Vec<DmValue>),
    Bytes(Vec<u8>), // raw image data
}

impl DmValue {
    fn as_i64(&self) -> Option<i64> {
        match self {
            DmValue::Int(v) => Some(*v),
            DmValue::Uint(v) => Some(*v as i64),
            _ => None,
        }
    }

    fn as_u64(&self) -> Option<u64> {
        match self {
            DmValue::Uint(v) => Some(*v),
            DmValue::Int(v) => Some(*v as u64),
            _ => None,
        }
    }

    fn as_group(&self) -> Option<&[(String, DmValue)]> {
        match self {
            DmValue::Group(v) => Some(v),
            _ => None,
        }
    }

    fn get(&self, key: &str) -> Option<&DmValue> {
        self.as_group()?
            .iter()
            .find(|(k, _)| k == key)
            .map(|(_, v)| v)
    }
}

// ── Binary reader helpers ─────────────────────────────────────────────────────
struct DmReader<R: Read + Seek> {
    r: R,
    dm4: bool,
    le: bool, // declared file byte order (m.littleEndian in Java)
    // Java: when adjust_endianness is true, 4/8-byte structural scalars and the
    // Dimensions ints are read with the opposite byte order (in.order(!le)).
    adjust_endianness: bool,
}

impl<R: Read + Seek> DmReader<R> {
    // Header fields are big-endian regardless of data endianness
    fn read_u8(&mut self) -> std::io::Result<u8> {
        let mut b = [0u8];
        self.r.read_exact(&mut b)?;
        Ok(b[0])
    }
    #[allow(dead_code)]
    fn read_be_u16(&mut self) -> std::io::Result<u16> {
        let mut b = [0u8; 2];
        self.r.read_exact(&mut b)?;
        Ok(u16::from_be_bytes(b))
    }
    #[allow(dead_code)]
    fn read_be_u32(&mut self) -> std::io::Result<u32> {
        let mut b = [0u8; 4];
        self.r.read_exact(&mut b)?;
        Ok(u32::from_be_bytes(b))
    }
    #[allow(dead_code)]
    fn read_be_u64(&mut self) -> std::io::Result<u64> {
        let mut b = [0u8; 8];
        self.r.read_exact(&mut b)?;
        Ok(u64::from_be_bytes(b))
    }
    // Structural integers (tag length/type, n_info, data_type, array/struct
    // counts) are read in the file's declared byte order. Java sets
    // in.order(isLittleEndian()) before parseTags and reads these with
    // readShort/readInt/readLong. Standard DM3/DM4 are big-endian (le=false),
    // so these match read_be_*; for LE-declared files they read little-endian.
    fn read_struct_u16(&mut self) -> std::io::Result<u16> {
        let mut b = [0u8; 2];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            u16::from_le_bytes(b)
        } else {
            u16::from_be_bytes(b)
        })
    }
    fn read_struct_u32(&mut self) -> std::io::Result<u32> {
        let mut b = [0u8; 4];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            u32::from_le_bytes(b)
        } else {
            u32::from_be_bytes(b)
        })
    }
    fn read_struct_u64(&mut self) -> std::io::Result<u64> {
        let mut b = [0u8; 8];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            u64::from_le_bytes(b)
        } else {
            u64::from_be_bytes(b)
        })
    }
    fn skip_dm4_padding(&mut self) -> std::io::Result<()> {
        if self.dm4 {
            self.r.seek(SeekFrom::Current(4))?;
        }
        Ok(())
    }

    fn skip_bytes(&mut self, n: u64) -> std::io::Result<()> {
        self.r.seek(SeekFrom::Current(n as i64))?;
        Ok(())
    }

    fn stream_len(&mut self) -> std::io::Result<u64> {
        let pos = self.r.stream_position()?;
        let len = self.r.seek(SeekFrom::End(0))?;
        self.r.seek(SeekFrom::Start(pos))?;
        Ok(len)
    }

    /// Effective endianness for a 4/8-byte structural scalar value: Java flips
    /// the byte order (in.order(!le)) when adjust_endianness is set.
    fn flipped_le(&self) -> bool {
        if self.adjust_endianness {
            !self.le
        } else {
            self.le
        }
    }

    // Data values respect the file's declared endianness
    fn read_data_i16(&mut self) -> std::io::Result<i16> {
        let mut b = [0u8; 2];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            i16::from_le_bytes(b)
        } else {
            i16::from_be_bytes(b)
        })
    }
    #[allow(dead_code)]
    fn read_data_i32(&mut self) -> std::io::Result<i32> {
        let mut b = [0u8; 4];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            i32::from_le_bytes(b)
        } else {
            i32::from_be_bytes(b)
        })
    }
    fn read_data_u16(&mut self) -> std::io::Result<u16> {
        let mut b = [0u8; 2];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            u16::from_le_bytes(b)
        } else {
            u16::from_be_bytes(b)
        })
    }
    #[allow(dead_code)]
    fn read_data_u32(&mut self) -> std::io::Result<u32> {
        let mut b = [0u8; 4];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            u32::from_le_bytes(b)
        } else {
            u32::from_be_bytes(b)
        })
    }
    #[allow(dead_code)]
    fn read_data_f32(&mut self) -> std::io::Result<f32> {
        let mut b = [0u8; 4];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            f32::from_le_bytes(b)
        } else {
            f32::from_be_bytes(b)
        })
    }
    #[allow(dead_code)]
    fn read_data_f64(&mut self) -> std::io::Result<f64> {
        let mut b = [0u8; 8];
        self.r.read_exact(&mut b)?;
        Ok(if self.le {
            f64::from_le_bytes(b)
        } else {
            f64::from_be_bytes(b)
        })
    }
    fn read_data_u8(&mut self) -> std::io::Result<u8> {
        self.read_u8()
    }
    fn read_data_i8(&mut self) -> std::io::Result<i8> {
        Ok(self.read_u8()? as i8)
    }

    /// Read a scalar value given its DM type code, matching Java readValue().
    /// 1/2-byte values use the base byte order; 4/8-byte values are read with
    /// the flipped order when adjust_endianness is set.
    fn read_scalar(&mut self, type_code: u32) -> std::io::Result<DmValue> {
        let flip = self.flipped_le();
        match type_code {
            // 2-byte: base order (no flip)
            DM_TYPE_INT16 => Ok(DmValue::Int(self.read_data_i16()? as i64)),
            DM_TYPE_UINT16 => Ok(DmValue::Uint(self.read_data_u16()? as u64)),
            // 4-byte: flipped order
            DM_TYPE_INT32 => {
                let mut b = [0u8; 4];
                self.r.read_exact(&mut b)?;
                let v = if flip {
                    i32::from_le_bytes(b)
                } else {
                    i32::from_be_bytes(b)
                };
                Ok(DmValue::Int(v as i64))
            }
            DM_TYPE_UINT32 => {
                let mut b = [0u8; 4];
                self.r.read_exact(&mut b)?;
                let v = if flip {
                    u32::from_le_bytes(b)
                } else {
                    u32::from_be_bytes(b)
                };
                Ok(DmValue::Uint(v as u64))
            }
            DM_TYPE_FLOAT32 => {
                let mut b = [0u8; 4];
                self.r.read_exact(&mut b)?;
                let v = if flip {
                    f32::from_le_bytes(b)
                } else {
                    f32::from_be_bytes(b)
                };
                Ok(DmValue::Float(v as f64))
            }
            // 8-byte: flipped order
            DM_TYPE_FLOAT64 => {
                let mut b = [0u8; 8];
                self.r.read_exact(&mut b)?;
                let v = if flip {
                    f64::from_le_bytes(b)
                } else {
                    f64::from_be_bytes(b)
                };
                Ok(DmValue::Float(v))
            }
            // 1-byte: base order (no flip)
            DM_TYPE_INT8 => Ok(DmValue::Int(self.read_data_i8()? as i64)),
            DM_TYPE_UINT8 => Ok(DmValue::Uint(self.read_data_u8()? as u64)),
            DM_TYPE_CHAR => Ok(DmValue::Uint(self.read_data_u8()? as u64)),
            // 8-byte unknown types: flipped order
            DM_TYPE_INT64 => {
                let mut b = [0u8; 8];
                self.r.read_exact(&mut b)?;
                Ok(DmValue::Int(if flip {
                    i64::from_le_bytes(b)
                } else {
                    i64::from_be_bytes(b)
                }))
            }
            DM_TYPE_UINT64 => {
                let mut b = [0u8; 8];
                self.r.read_exact(&mut b)?;
                Ok(DmValue::Uint(if flip {
                    u64::from_le_bytes(b)
                } else {
                    u64::from_be_bytes(b)
                }))
            }
            other => Err(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                format!("unsupported DM scalar type {other}"),
            )),
        }
    }

    fn type_size(type_code: u32) -> usize {
        match type_code {
            DM_TYPE_INT8 | DM_TYPE_UINT8 | DM_TYPE_CHAR => 1,
            DM_TYPE_INT16 | DM_TYPE_UINT16 => 2,
            DM_TYPE_INT32 | DM_TYPE_UINT32 | DM_TYPE_FLOAT32 => 4,
            DM_TYPE_FLOAT64 | DM_TYPE_INT64 | DM_TYPE_UINT64 => 8,
            _ => 4,
        }
    }

    /// Parse a tag leaf data block.
    fn parse_tag_data(&mut self, label: &str) -> std::io::Result<DmValue> {
        self.skip_dm4_padding()?;
        self.skip_dm4_padding()?;

        // "%%%%"  (4 bytes delimiter)
        let mut delim = [0u8; 4];
        self.r.read_exact(&mut delim)?;

        self.skip_dm4_padding()?;
        let n_info = self.read_struct_u32()?;
        self.skip_dm4_padding()?;
        let data_type = self.read_struct_u32()?;

        match n_info {
            0 => Ok(DmValue::Int(0)),
            1 => self.read_scalar(data_type),
            2 => {
                let len = self.read_struct_u32()? as usize;
                let mut bytes = vec![0u8; len];
                self.r.read_exact(&mut bytes)?;
                Ok(DmValue::Str(String::from_utf8_lossy(&bytes).to_string()))
            }
            3 if data_type == DM_TYPE_ARRAY => {
                self.skip_dm4_padding()?;
                let elem_type = self.read_struct_u32()?;
                let elem_count = if self.dm4 {
                    self.read_struct_u64()?
                } else {
                    self.read_struct_u32()? as u64
                };
                let total_bytes = elem_count
                    .checked_mul(Self::type_size(elem_type) as u64)
                    .ok_or_else(|| {
                        std::io::Error::new(
                            std::io::ErrorKind::InvalidData,
                            "DM array byte overflow",
                        )
                    })?;
                let pos = self.r.stream_position()?;
                let len = self.stream_len()?;
                if total_bytes > len.saturating_sub(pos) {
                    return Err(std::io::Error::new(
                        std::io::ErrorKind::InvalidData,
                        "DM array length exceeds remaining file bytes",
                    ));
                }

                if label == "Data" {
                    let mut data = vec![0u8; total_bytes as usize];
                    self.r.read_exact(&mut data)?;
                    Ok(DmValue::Bytes(data))
                } else {
                    self.skip_bytes(total_bytes)?;
                    Ok(DmValue::Int(0))
                }
            }
            _ if data_type == DM_TYPE_STRUCT => {
                self.skip_bytes(4)?;
                self.skip_dm4_padding()?;
                self.skip_dm4_padding()?;
                let n_fields = self.read_struct_u32()? as usize;
                let start_fp = self.r.stream_position()?;
                self.skip_bytes(4)?;
                self.skip_dm4_padding()?;
                let mut base_fp = self.r.stream_position()?;
                if self.dm4 {
                    base_fp += 4;
                }
                let width = if self.dm4 { 16 } else { 8 };
                let mut field_types = Vec::with_capacity(n_fields);
                for i in 0..n_fields {
                    self.r.seek(SeekFrom::Start(base_fp + i as u64 * width))?;
                    field_types.push(self.read_struct_u32()?);
                }
                self.r
                    .seek(SeekFrom::Start(start_fp + n_fields as u64 * width))?;
                let mut fields = Vec::with_capacity(n_fields);
                for (i, type_code) in field_types.into_iter().enumerate() {
                    let val = self.read_scalar(type_code)?;
                    fields.push((format!("field{}", i), val));
                }
                Ok(DmValue::Group(fields))
            }
            _ if data_type == DM_TYPE_ARRAY => {
                self.skip_dm4_padding()?;
                let nested_type = self.read_struct_u32()?;
                if nested_type == DM_TYPE_STRUCT {
                    self.skip_bytes(4)?;
                    self.skip_dm4_padding()?;
                    self.skip_dm4_padding()?;
                    let n_fields = self.read_struct_u32()? as usize;
                    let mut field_types = Vec::with_capacity(n_fields);
                    let mut base_fp = self.r.stream_position()? + 12;
                    if self.dm4 {
                        base_fp = self.r.stream_position()? + 12;
                    }
                    for i in 0..n_fields {
                        self.skip_bytes(4)?;
                        if self.dm4 {
                            self.r.seek(SeekFrom::Start(base_fp + i as u64 * 16))?;
                        }
                        field_types.push(self.read_struct_u32()?);
                    }
                    self.skip_dm4_padding()?;
                    let len = self.read_struct_u32()? as usize;
                    for _ in 0..len {
                        for &type_code in &field_types {
                            let _ = self.read_scalar(type_code)?;
                        }
                    }
                }
                Ok(DmValue::Int(0))
            }
            _ => Ok(DmValue::Int(0)),
        }
    }

    /// Parse a TagGroup (branch node).
    fn parse_tag_group(&mut self, depth: usize) -> std::io::Result<DmValue> {
        if depth > 20 {
            return Ok(DmValue::Group(vec![]));
        }
        let _is_sorted = self.read_u8()?;
        let _is_open = self.read_u8()?;
        self.skip_dm4_padding()?;
        if depth > 0 {
            self.skip_dm4_padding()?;
            self.skip_dm4_padding()?;
        }
        let n_tags = self.read_struct_u32()? as u64;

        // Java: if numTags > in.length() the declared byte order is wrong, so
        // flip m.littleEndian and disable adjust_endianness.
        if depth == 0 {
            let len = self.stream_len()?;
            if n_tags > len {
                self.le = !self.le;
                self.adjust_endianness = false;
            }
        }

        let stream_len = self.stream_len()?;
        let mut entries = Vec::new();
        // Java uses a `for (int i; i<numTags; i++)` loop where type-23 tags do
        // `i--` to re-read the index; mirror that with an explicit counter.
        let mut i: u64 = 0;
        while i < n_tags {
            // Java: if (in.getFilePointer() + 3 >= in.length()) break;
            if self.r.stream_position()? + 3 >= stream_len {
                break;
            }

            let tag_type = self.read_u8()?;

            // Java GatanReader.java:637-640: type 23 tags consume only 5 bytes
            // and re-read the same index (i--), instead of carrying a name.
            if tag_type == 23 {
                self.skip_bytes(5)?;
                continue;
            }

            let name_len = self.read_struct_u16()? as usize;
            let mut name_bytes = vec![0u8; name_len];
            self.r.read_exact(&mut name_bytes)?;
            let name = String::from_utf8_lossy(&name_bytes).to_string();

            let val = match tag_type {
                20 => self.parse_tag_group(depth + 1)?, // group/branch
                21 => self.parse_tag_data(&name)?,      // leaf
                _ => DmValue::Int(0),
            };
            entries.push((name, val));
            i += 1;
        }
        Ok(DmValue::Group(entries))
    }
}

// ── Parsed image info ─────────────────────────────────────────────────────────
struct DmImage {
    width: u32,
    height: u32,
    depth: u32, // Z planes
    dm_data_type: i32,
    pixel_data: Vec<u8>,
    name: String,
}

fn find_image_data(root: &DmValue) -> Result<DmImage> {
    // Navigate: root → "ImageList" → entry 1 (or first if 1 is absent)
    let image_list = root
        .get("ImageList")
        .ok_or_else(|| BioFormatsError::Format("DM3/DM4: ImageList missing".into()))?;
    let entries = image_list
        .as_group()
        .ok_or_else(|| BioFormatsError::Format("DM3/DM4: ImageList is not a group".into()))?;

    // Try entry at index 1 first (index 0 is often a thumbnail/reference)
    // entries are in order, try index 1 (if present) then 0
    let candidates: Vec<usize> = if entries.len() > 1 {
        vec![1, 0]
    } else {
        vec![0]
    };

    for &idx in &candidates {
        if let Some((_, image_entry)) = entries.get(idx) {
            match extract_image(image_entry)? {
                Some(result) => return Ok(result),
                None => {}
            }
        }
    }
    Err(BioFormatsError::Format(
        "DM3/DM4: could not find image data in tag tree".into(),
    ))
}

fn extract_image(entry: &DmValue) -> Result<Option<DmImage>> {
    let img_data = match entry.get("ImageData") {
        Some(value) => value,
        None => return Ok(None),
    };

    // Get dimensions
    let dims = img_data.get("Dimensions").ok_or_else(|| {
        BioFormatsError::UnsupportedFormat("Gatan DM ImageData has no Dimensions".into())
    })?;
    let dim_entries = dims.as_group().ok_or_else(|| {
        BioFormatsError::UnsupportedFormat("Gatan DM Dimensions is not a group".into())
    })?;
    let width = dim_entries
        .first()
        .and_then(|(_, v)| v.as_u64())
        .ok_or_else(|| BioFormatsError::UnsupportedFormat("Gatan DM width missing".into()))?;
    let height = dim_entries
        .get(1)
        .and_then(|(_, v)| v.as_u64())
        .ok_or_else(|| BioFormatsError::UnsupportedFormat("Gatan DM height missing".into()))?;
    let depth = dim_entries
        .get(2)
        .and_then(|(_, v)| v.as_u64())
        .unwrap_or(1);
    if width == 0 || height == 0 || depth == 0 {
        return Err(BioFormatsError::UnsupportedFormat(
            "Gatan DM image has non-positive dimensions".into(),
        ));
    }
    let width = u32::try_from(width)
        .map_err(|_| BioFormatsError::Format("Gatan DM width overflows".into()))?;
    let height = u32::try_from(height)
        .map_err(|_| BioFormatsError::Format("Gatan DM height overflows".into()))?;
    let depth = u32::try_from(depth)
        .map_err(|_| BioFormatsError::Format("Gatan DM depth overflows".into()))?;

    // Get data type
    let dm_data_type = i32::try_from(
        img_data
            .get("DataType")
            .and_then(|v| v.as_i64())
            .ok_or_else(|| {
                BioFormatsError::UnsupportedFormat("Gatan DM ImageData has no DataType".into())
            })?,
    )
    .map_err(|_| BioFormatsError::Format("Gatan DM data type overflows".into()))?;

    // Get pixel data
    let data_tag = img_data.get("Data").ok_or_else(|| {
        BioFormatsError::UnsupportedFormat("Gatan DM ImageData has no Data".into())
    })?;
    let pixel_data = match data_tag {
        DmValue::Bytes(b) => b.clone(),
        _ => return Ok(None),
    };

    // Get image name
    let name = entry
        .get("Name")
        .and_then(|v| {
            if let DmValue::Str(s) = v {
                Some(s.clone())
            } else {
                None
            }
        })
        .unwrap_or_default();

    Ok(Some(DmImage {
        width,
        height,
        depth,
        dm_data_type,
        pixel_data,
        name,
    }))
}

// ── Reader ────────────────────────────────────────────────────────────────────

pub struct GatanReader {
    path: Option<PathBuf>,
    meta: Option<ImageMetadata>,
    pixel_data: Option<Vec<u8>>,
    dm_data_type: i32,
}

impl GatanReader {
    pub fn new() -> Self {
        GatanReader {
            path: None,
            meta: None,
            pixel_data: None,
            dm_data_type: 23,
        }
    }
}

impl Default for GatanReader {
    fn default() -> Self {
        Self::new()
    }
}

impl FormatReader for GatanReader {
    fn is_this_type_by_name(&self, path: &Path) -> bool {
        let ext = path
            .extension()
            .and_then(|e| e.to_str())
            .map(|e| e.to_ascii_lowercase());
        matches!(ext.as_deref(), Some("dm3") | Some("dm4") | Some("dm2"))
    }

    fn is_this_type_by_bytes(&self, header: &[u8]) -> bool {
        if header.len() < 16 {
            return false;
        }
        // DM3: first 4 bytes big-endian = 3
        // DM4: first 4 bytes big-endian = 4
        let v = u32::from_be_bytes([header[0], header[1], header[2], header[3]]);
        match v {
            3 => {
                let byte_order = u32::from_be_bytes([header[8], header[9], header[10], header[11]]);
                byte_order <= 1
            }
            4 => {
                let byte_order =
                    u32::from_be_bytes([header[12], header[13], header[14], header[15]]);
                byte_order <= 1
            }
            _ => false,
        }
    }

    fn set_id(&mut self, path: &Path) -> Result<()> {
        self.close()?;
        let f = File::open(path).map_err(BioFormatsError::Io)?;
        let r = BufReader::new(f);

        // Read header
        let mut header = [0u8; 16];
        {
            let mut rf = File::open(path).map_err(BioFormatsError::Io)?;
            rf.read_exact(&mut header).map_err(BioFormatsError::Io)?;
        }

        let version = u32::from_be_bytes([header[0], header[1], header[2], header[3]]);
        let dm4 = version == 4;

        // Byte order field: Java does `m.littleEndian = in.readInt() != 1`.
        // So a value of 1 means big-endian; anything else means little-endian.
        let bo_off = if dm4 { 12 } else { 8 };
        let byte_order = u32::from_be_bytes([
            header[bo_off],
            header[bo_off + 1],
            header[bo_off + 2],
            header[bo_off + 3],
        ]);
        let le = byte_order != 1;

        // `adjustEndianness` is true unless the tag count looks invalid (see Java
        // GatanReader.initFile). When set, 4/8-byte structural scalars and the
        // Dimensions ints are read with the opposite byte order via flip helpers.
        let mut dm = DmReader {
            r,
            dm4,
            le,
            adjust_endianness: true,
        };

        // Seek past the file header to the root tag group
        let _root_offset = if dm4 { 24u64 } else { 16u64 }; // version(4) + size(4/8) + byteorder(4)
                                                            // Actually:
                                                            // DM3: version(4) + filesize(4) + byteorder(4) = 12 bytes → root at 12
                                                            // DM4: version(4) + filesize(8) + byteorder(4) = 16 bytes → root at 16
        let root_off = if dm4 { 16u64 } else { 12u64 };
        dm.r.seek(SeekFrom::Start(root_off))
            .map_err(BioFormatsError::Io)?;

        let root = dm.parse_tag_group(0).map_err(BioFormatsError::Io)?;

        let img = find_image_data(&root)?;

        let (mut pixel_type, mut bytes_per_pixel) =
            dm_pixel_type_and_bytes(img.dm_data_type)?;
        let image_count = img.depth;

        // Reconcile the DataType-derived bytes-per-pixel with the bpp implied by
        // the stored payload. Java: bytes = numPixelBytes / (sizeX*sizeY*imageCount)
        // and, if that disagrees with FormatTools.getBytesPerPixel(pixelType),
        // overrides via FormatTools.pixelTypeFromBytes(bytes, signed, false)
        // (GatanReader.java:256-259). This rescues files whose payload implies a
        // different bpp than the DataType (e.g. RGB DataType 23, where Java's
        // getNumBytes(23)==0).
        let pixel_count = (img.width as usize)
            .checked_mul(img.height as usize)
            .and_then(|px| px.checked_mul(image_count as usize))
            .ok_or_else(|| BioFormatsError::Format("Gatan DM pixel count overflows".into()))?;
        if pixel_count == 0 {
            return Err(BioFormatsError::UnsupportedFormat(
                "Gatan DM image has zero pixels".into(),
            ));
        }
        let derived_bytes = img.pixel_data.len() / pixel_count;
        if derived_bytes != bytes_per_pixel {
            // Java sources `signed` from the LowLimit tag; gatan.rs does not
            // capture it, so fall back to the DataType's own signedness.
            let signed = dm_data_type_is_signed(img.dm_data_type);
            pixel_type = dm_pixel_type_from_bytes(derived_bytes, signed)?;
            bytes_per_pixel = derived_bytes;
        }

        // Ensure the payload is large enough for the (possibly reconciled) stride.
        let expected_len = pixel_count
            .checked_mul(bytes_per_pixel)
            .ok_or_else(|| BioFormatsError::Format("Gatan DM pixel payload overflows".into()))?;
        if img.pixel_data.len() < expected_len {
            return Err(BioFormatsError::UnsupportedFormat(format!(
                "Gatan DM pixel payload is shorter than declared ({} < {expected_len})",
                img.pixel_data.len()
            )));
        }

        let mut meta_map: HashMap<String, MetadataValue> = HashMap::new();
        if !img.name.is_empty() {
            meta_map.insert("name".into(), MetadataValue::String(img.name));
        }
        meta_map.insert("dm_version".into(), MetadataValue::Int(version as i64));
        meta_map.insert(
            "dm_data_type".into(),
            MetadataValue::Int(img.dm_data_type as i64),
        );

        let meta = ImageMetadata {
            size_x: img.width,
            size_y: img.height,
            size_z: image_count,
            size_c: 1,
            size_t: 1,
            pixel_type,
            bits_per_pixel: (bytes_per_pixel * 8) as u8,
            image_count,
            dimension_order: DimensionOrder::XYZCT,
            is_rgb: false,
            is_interleaved: false,
            is_indexed: false,
            // Java forces m.littleEndian = true before populating pixels
            // (GatanReader.initFile line 242); pixel data is always little-endian.
            is_little_endian: true,
            resolution_count: 1,
            series_metadata: meta_map,
            lookup_table: None,
            modulo_z: None,
            modulo_c: None,
            modulo_t: None,
        };

        self.meta = Some(meta);
        self.pixel_data = Some(img.pixel_data);
        self.dm_data_type = img.dm_data_type;
        self.path = Some(path.to_path_buf());
        Ok(())
    }

    fn close(&mut self) -> Result<()> {
        self.path = None;
        self.meta = None;
        self.pixel_data = None;
        Ok(())
    }

    fn series_count(&self) -> usize {
        usize::from(self.meta.is_some())
    }

    fn set_series(&mut self, s: usize) -> Result<()> {
        if self.meta.is_none() {
            return Err(BioFormatsError::NotInitialized);
        }
        if s != 0 {
            Err(BioFormatsError::SeriesOutOfRange(s))
        } else {
            Ok(())
        }
    }

    fn series(&self) -> usize {
        0
    }

    fn metadata(&self) -> &ImageMetadata {
        self.meta
            .as_ref()
            .unwrap_or(crate::common::reader::uninitialized_metadata())
    }

    fn open_bytes(&mut self, plane_index: u32) -> Result<Vec<u8>> {
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        if plane_index >= meta.image_count {
            return Err(BioFormatsError::PlaneOutOfRange(plane_index));
        }
        let data = self
            .pixel_data
            .as_ref()
            .ok_or(BioFormatsError::NotInitialized)?;
        let bps = meta.pixel_type.bytes_per_sample();
        let plane_bytes = (meta.size_x * meta.size_y) as usize * bps;
        let start = plane_index as usize * plane_bytes;
        let end = start + plane_bytes;
        if end > data.len() {
            return Err(BioFormatsError::InvalidData(
                "DM plane out of range in data".into(),
            ));
        }
        Ok(data[start..end].to_vec())
    }

    fn open_bytes_region(
        &mut self,
        plane_index: u32,
        x: u32,
        y: u32,
        w: u32,
        h: u32,
    ) -> Result<Vec<u8>> {
        let full = self.open_bytes(plane_index)?;
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        crop_full_plane("Gatan", &full, meta, 1, x, y, w, h)
    }

    fn open_thumb_bytes(&mut self, plane_index: u32) -> Result<Vec<u8>> {
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        let (tw, th) = (meta.size_x.min(256), meta.size_y.min(256));
        let (tx, ty) = ((meta.size_x - tw) / 2, (meta.size_y - th) / 2);
        self.open_bytes_region(plane_index, tx, ty, tw, th)
    }

    fn ome_metadata(&self) -> Option<crate::common::ome_metadata::OmeMetadata> {
        use crate::common::metadata::MetadataValue;
        use crate::common::ome_metadata::OmeMetadata;
        let meta = self.meta.as_ref()?;
        let mut ome = OmeMetadata::from_image_metadata(meta);
        let img = &mut ome.images[0];
        if let Some(MetadataValue::String(n)) = meta.series_metadata.get("name") {
            img.name = Some(n.clone());
        }
        Some(ome)
    }
}

// ── Gatan DM2 Reader ──────────────────────────────────────────────────────────

/// Magic int at the start of a DM2 file (big-endian): 0x003d0000.
const DM2_MAGIC_BYTES: i32 = 0x3d_0000;
/// DM2 pixel data offset (GatanDM2Reader.HEADER_SIZE).
const DM2_HEADER_SIZE: u64 = 24;

/// Map (bytes-per-pixel, signed) to a PixelType, matching
/// FormatTools.pixelTypeFromBytes(bpp, signed, /*fp=*/true) for the byte sizes
/// that occur in DM2 (the fp flag only selects float for 4/8-byte data).
fn dm2_pixel_type_from_bytes(bpp: i32, signed: bool) -> Result<PixelType> {
    match (bpp, signed) {
        (1, false) => Ok(PixelType::Uint8),
        (1, true) => Ok(PixelType::Int8),
        (2, false) => Ok(PixelType::Uint16),
        (2, true) => Ok(PixelType::Int16),
        // GatanDM2Reader passes fp=true, so 4-byte data is treated as float.
        (4, _) => Ok(PixelType::Float32),
        other => Err(BioFormatsError::Format(format!(
            "DM2: unsupported bytes-per-pixel/signed combination {other:?}"
        ))),
    }
}

/// Cursor over a big-endian byte slice mirroring the subset of
/// RandomAccessInputStream operations used by GatanDM2Reader.
struct Be<'a> {
    data: &'a [u8],
    pos: usize,
}

impl<'a> Be<'a> {
    fn new(data: &'a [u8], pos: usize) -> Self {
        Be { data, pos }
    }
    fn len(&self) -> usize {
        self.data.len()
    }
    fn pointer(&self) -> usize {
        self.pos
    }
    fn seek(&mut self, p: usize) {
        self.pos = p.min(self.data.len());
    }
    fn skip(&mut self, n: usize) {
        self.pos = (self.pos + n).min(self.data.len());
    }
    fn read_u8(&mut self) -> i32 {
        if self.pos >= self.data.len() {
            return -1;
        }
        let v = self.data[self.pos] as i32;
        self.pos += 1;
        v
    }
    fn read_short(&mut self) -> i32 {
        if self.pos + 2 > self.data.len() {
            self.pos = self.data.len();
            return 0;
        }
        let v = i16::from_be_bytes([self.data[self.pos], self.data[self.pos + 1]]) as i32;
        self.pos += 2;
        v
    }
    fn read_int(&mut self) -> i32 {
        if self.pos + 4 > self.data.len() {
            self.pos = self.data.len();
            return 0;
        }
        let v = i32::from_be_bytes([
            self.data[self.pos],
            self.data[self.pos + 1],
            self.data[self.pos + 2],
            self.data[self.pos + 3],
        ]);
        self.pos += 4;
        v
    }
    /// Read `len` bytes as an ISO-8859-1 string.
    fn read_string(&mut self, len: usize) -> String {
        let end = (self.pos + len).min(self.data.len());
        let s: String = self.data[self.pos..end]
            .iter()
            .map(|&b| b as char)
            .collect();
        self.pos = end;
        s
    }
}

/// Port of the GatanDM2Reader.initFile label/value scan plus parseExtraTags.
/// Collects all label/value pairs into `meta` and returns (name, date, time).
fn parse_dm2_metadata(
    bytes: &[u8],
    start: usize,
    meta: &mut HashMap<String, MetadataValue>,
) -> (Option<String>, Option<String>, Option<String>) {
    let mut s = Be::new(bytes, start);
    let mut date: Option<String> = None;
    let mut time: Option<String> = None;
    let mut name: Option<String> = None;

    while s.pointer() < s.len() {
        let mut strlen = s.read_short();
        if strlen == 0 || strlen > 255 {
            s.skip(35);
            strlen = s.read_short();
            if strlen < 0 || (strlen as usize) + s.pointer() >= s.len() {
                let back = s.pointer().saturating_sub(10);
                s.seek(back);
                strlen = s.read_short();
            }
        }
        if strlen < 0 || (strlen as usize) + s.pointer() >= s.len() {
            break;
        }
        let mut label = s.read_string(strlen as usize);
        let mut value = String::new();

        let mut block = s.read_int();
        if block == 5 {
            s.skip(33);
            if s.read_short() == 0 {
                if s.read_short() == 39 {
                    s.skip(1);
                } else {
                    s.skip(2);
                }
            } else {
                let back = s.pointer().saturating_sub(2);
                s.seek(back);
                continue;
            }
        } else if block == 0 || (block as i64 > 0xffff && block < 0x0100_0000) {
            if block != 0 && strlen > 0 {
                let back = s.pointer().saturating_sub(4);
                s.seek(back);
                value.push_str(&label);
                label = "Description".to_string();
                meta.insert(label.clone(), MetadataValue::String(value.clone()));
            } else if block != 0 {
                s.skip(15);
            }
            parse_dm2_extra_tags(&mut s, meta);
            continue;
        } else if block >= 0x0100_0000 {
            s.skip(34);
            strlen = s.read_short();
            if strlen < 0 || (strlen as usize) + s.pointer() >= s.len() {
                break;
            }
            label = s.read_string(strlen as usize);
            block = s.read_int();
            if block == 5 {
                s.skip(33);
                continue;
            }
        }

        let len = s.read_int();
        if len < 0 || (len as usize) + s.pointer() >= s.len() {
            break;
        }
        let type_str = s.read_string(len as usize);
        let _extra = s.read_int() - 2;
        let mut count = s.read_int();

        match type_str.as_str() {
            "TEXT" => {
                value.push_str(&s.read_string(count.max(0) as usize));
                if block == 5 {
                    s.skip(22);
                    if s.read_int() == 4 {
                        if s.read_string(4) == "TEXT" {
                            s.skip(4);
                            count = s.read_int();
                            value.push_str(", ");
                            value.push_str(&s.read_string(count.max(0) as usize));
                            s.skip(37);
                        } else {
                            s.skip(7);
                        }
                    } else {
                        s.skip(11);
                    }
                }
            }
            "long" => {
                count /= 8;
                for i in 0..count {
                    if s.pointer() + 8 > s.len() {
                        break;
                    }
                    let v = i64::from_be_bytes([
                        bytes[s.pointer()],
                        bytes[s.pointer() + 1],
                        bytes[s.pointer() + 2],
                        bytes[s.pointer() + 3],
                        bytes[s.pointer() + 4],
                        bytes[s.pointer() + 5],
                        bytes[s.pointer() + 6],
                        bytes[s.pointer() + 7],
                    ]);
                    s.skip(8);
                    value.push_str(&v.to_string());
                    if i < count - 1 {
                        value.push_str(", ");
                    }
                }
                s.skip(4);
            }
            "bool" => {
                for i in 0..count {
                    let v = s.read_u8() == 1;
                    value.push_str(&v.to_string());
                    if i < count - 1 {
                        value.push_str(", ");
                    }
                }
            }
            "shor" => {
                count /= 2;
                for i in 0..count {
                    value.push_str(&s.read_short().to_string());
                    if i < count - 1 {
                        value.push_str(", ");
                    }
                }
            }
            "sing" => {
                count /= 4;
                for i in 0..count {
                    if s.pointer() + 4 > s.len() {
                        break;
                    }
                    let v = f32::from_be_bytes([
                        bytes[s.pointer()],
                        bytes[s.pointer() + 1],
                        bytes[s.pointer() + 2],
                        bytes[s.pointer() + 3],
                    ]);
                    s.skip(4);
                    value.push_str(&v.to_string());
                    if i < count - 1 {
                        value.push_str(", ");
                    }
                }
            }
            _ => {
                if count < 0 || (count as usize) + s.pointer() > s.len() {
                    break;
                }
                s.skip(count as usize);
            }
        }

        s.skip(16);
        meta.insert(label.clone(), MetadataValue::String(value.clone()));

        match label.as_str() {
            "Acquisition Date" => {
                let mut d = value.clone();
                if let Some(slash) = d.rfind('/') {
                    let year = &d[slash + 1..];
                    if year.len() < 2 {
                        d = format!("{}0{}", &d[..slash + 1], year);
                    }
                }
                date = Some(d);
            }
            "Acquisition Time" => time = Some(value.clone()),
            "Name" => name = Some(value.clone()),
            _ => {}
        }
    }

    (name, date, time)
}

/// Port of GatanDM2Reader.parseExtraTags (reads to EOF).
fn parse_dm2_extra_tags(s: &mut Be<'_>, meta: &mut HashMap<String, MetadataValue>) {
    while s.pointer() < s.len() {
        let tag = s.read_short();
        let length = s.read_int();
        let value = if length == 4 {
            let p = s.pointer();
            if p + 4 > s.len() {
                break;
            }
            let v = f32::from_be_bytes([s.data[p], s.data[p + 1], s.data[p + 2], s.data[p + 3]]);
            s.skip(4);
            v.to_string()
        } else if length == 2 {
            s.read_short().to_string()
        } else if length == 1 {
            s.read_u8().to_string()
        } else {
            if length < 0 {
                break;
            }
            let raw = s.read_string(length as usize);
            match raw.find('\0') {
                Some(i) => raw[..i].to_string(),
                None => raw,
            }
        };
        let value = value.trim().to_string();

        let label = match tag {
            17 => "BlackContrastLimit".to_string(),
            18 => "WhiteContrastLimit".to_string(),
            22 => "Scale".to_string(),
            27 => "MaxPixelValue".to_string(),
            28 => "MinPixelValue".to_string(),
            31 => "Physical width".to_string(),
            32 => "Physical height".to_string(),
            37 => "Image label".to_string(),
            38 => "MinimumContrast".to_string(),
            53 => "Physical size units".to_string(),
            62 => "Origin".to_string(),
            other => format!("Tag {:x}", other),
        };
        meta.insert(label, MetadataValue::String(value));
    }
}

pub struct Dm2Reader {
    path: Option<PathBuf>,
    meta: Option<ImageMetadata>,
    data_offset: u64,
}

impl Dm2Reader {
    pub fn new() -> Self {
        Dm2Reader {
            path: None,
            meta: None,
            data_offset: DM2_HEADER_SIZE,
        }
    }
}

impl Default for Dm2Reader {
    fn default() -> Self {
        Self::new()
    }
}

impl FormatReader for Dm2Reader {
    fn is_this_type_by_name(&self, path: &Path) -> bool {
        path.extension()
            .and_then(|e| e.to_str())
            .map(|e| e.eq_ignore_ascii_case("dm2"))
            .unwrap_or(false)
    }

    fn is_this_type_by_bytes(&self, header: &[u8]) -> bool {
        // GatanDM2Reader.isThisType: first big-endian int equals DM2_MAGIC_BYTES.
        header.len() >= 4
            && i32::from_be_bytes([header[0], header[1], header[2], header[3]]) == DM2_MAGIC_BYTES
    }

    fn set_id(&mut self, path: &Path) -> Result<()> {
        self.close()?;
        // Port of GatanDM2Reader.initFile (big-endian, ISO-8859-1 strings).
        let bytes = std::fs::read(path).map_err(BioFormatsError::Io)?;
        if bytes.len() < 24 {
            return Err(BioFormatsError::Format("DM2 file is too short".into()));
        }

        let magic = i32::from_be_bytes([bytes[0], bytes[1], bytes[2], bytes[3]]);
        if magic != DM2_MAGIC_BYTES {
            return Err(BioFormatsError::Format("Invalid DM2 file".into()));
        }

        // readInt() magic (4) + skipBytes(8) -> offset 12: footerOffset int + 16.
        // Then sizeX short(16), sizeY short(18), bpp short(20), signed short(22).
        let width_i = i16::from_be_bytes([bytes[16], bytes[17]]);
        let height_i = i16::from_be_bytes([bytes[18], bytes[19]]);
        if width_i <= 0 || height_i <= 0 {
            return Err(BioFormatsError::UnsupportedFormat(
                "DM2 header has non-positive image dimensions".into(),
            ));
        }
        let width = width_i as u32;
        let height = height_i as u32;
        let bpp = i16::from_be_bytes([bytes[20], bytes[21]]) as i32;
        let signed = i16::from_be_bytes([bytes[22], bytes[23]]) == 1;

        let pixel_type = dm2_pixel_type_from_bytes(bpp, signed)?;
        let bps = pixel_type.bytes_per_sample();

        let mut meta_map: HashMap<String, MetadataValue> = HashMap::new();

        // Tag/metadata scan, starting after the pixel plane plus the 35-byte gap
        // that GatanDM2Reader skips (skipBytes(planeSize + 35)).
        let plane_size = (width as usize)
            .checked_mul(height as usize)
            .and_then(|px| px.checked_mul(bps))
            .ok_or_else(|| BioFormatsError::Format("DM2 plane size overflows".into()))?;
        let required_len = (DM2_HEADER_SIZE as usize)
            .checked_add(plane_size)
            .ok_or_else(|| BioFormatsError::Format("DM2 file size overflows".into()))?;
        if bytes.len() < required_len {
            return Err(BioFormatsError::UnsupportedFormat(format!(
                "DM2 pixel payload is shorter than declared ({} < {required_len})",
                bytes.len()
            )));
        }
        let scan_start = DM2_HEADER_SIZE as usize + plane_size + 35;
        let (name, date, time) = parse_dm2_metadata(&bytes, scan_start, &mut meta_map);
        if let Some(n) = name {
            meta_map.insert("Name".into(), MetadataValue::String(n));
        }
        if let Some(d) = date {
            meta_map.insert("Acquisition Date".into(), MetadataValue::String(d));
        }
        if let Some(t) = time {
            meta_map.insert("Acquisition Time".into(), MetadataValue::String(t));
        }

        let meta = ImageMetadata {
            size_x: width,
            size_y: height,
            size_z: 1,
            size_c: 1,
            size_t: 1,
            pixel_type,
            bits_per_pixel: (bps * 8) as u8,
            image_count: 1,
            dimension_order: DimensionOrder::XYZCT,
            is_rgb: false,
            is_interleaved: false,
            is_indexed: false,
            // GatanDM2Reader sets m.littleEndian = false.
            is_little_endian: false,
            resolution_count: 1,
            series_metadata: meta_map,
            lookup_table: None,
            modulo_z: None,
            modulo_c: None,
            modulo_t: None,
        };

        self.meta = Some(meta);
        self.data_offset = DM2_HEADER_SIZE;
        self.path = Some(path.to_path_buf());
        Ok(())
    }

    fn close(&mut self) -> Result<()> {
        self.path = None;
        self.meta = None;
        self.data_offset = DM2_HEADER_SIZE;
        Ok(())
    }

    fn series_count(&self) -> usize {
        usize::from(self.meta.is_some())
    }
    fn set_series(&mut self, s: usize) -> Result<()> {
        if self.meta.is_none() {
            return Err(BioFormatsError::NotInitialized);
        }
        if s != 0 {
            Err(BioFormatsError::SeriesOutOfRange(s))
        } else {
            Ok(())
        }
    }
    fn series(&self) -> usize {
        0
    }

    fn metadata(&self) -> &ImageMetadata {
        self.meta
            .as_ref()
            .unwrap_or(crate::common::reader::uninitialized_metadata())
    }

    fn open_bytes(&mut self, plane_index: u32) -> Result<Vec<u8>> {
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        if plane_index >= meta.image_count {
            return Err(BioFormatsError::PlaneOutOfRange(plane_index));
        }
        let bps = meta.pixel_type.bytes_per_sample();
        let plane_bytes = meta.size_x as usize * meta.size_y as usize * bps;
        let file_offset = self.data_offset + plane_index as u64 * plane_bytes as u64;
        let path = self.path.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        let mut f = std::fs::File::open(path).map_err(BioFormatsError::Io)?;
        use std::io::Seek;
        f.seek(std::io::SeekFrom::Start(file_offset))
            .map_err(BioFormatsError::Io)?;
        let mut buf = vec![0u8; plane_bytes];
        f.read_exact(&mut buf).map_err(BioFormatsError::Io)?;
        Ok(buf)
    }

    fn open_bytes_region(
        &mut self,
        plane_index: u32,
        x: u32,
        y: u32,
        w: u32,
        h: u32,
    ) -> Result<Vec<u8>> {
        let full = self.open_bytes(plane_index)?;
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        crop_full_plane("DM2", &full, meta, 1, x, y, w, h)
    }

    fn open_thumb_bytes(&mut self, plane_index: u32) -> Result<Vec<u8>> {
        let meta = self.meta.as_ref().ok_or(BioFormatsError::NotInitialized)?;
        let (tw, th) = (meta.size_x.min(256), meta.size_y.min(256));
        let (tx, ty) = ((meta.size_x - tw) / 2, (meta.size_y - th) / 2);
        self.open_bytes_region(plane_index, tx, ty, tw, th)
    }
}