File: pyslow5.pyx

package info (click to toggle)
libslow5lib 0.7.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 25,092 kB
  • sloc: ansic: 11,825; python: 1,179; sh: 547; makefile: 91; cpp: 40
file content (2039 lines) | stat: -rw-r--r-- 95,956 bytes parent folder | download | duplicates (2)
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
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
# distutils: language = c
# cython: language_level=3
# cython: profile=True
import sys
import time
import logging
import copy
from itertools import chain
from libc.stdlib cimport malloc, free
from libc.string cimport strdup
cimport pyslow5
# Import the Python-level symbols of numpy
import numpy as np
# Import the C-level symbols of numpy
cimport numpy as np
# Numpy must be initialized. When using numpy from C or Cython you must
# _always_ do that, or you will have segfaults
np.import_array()

#
# Class Open for reading and writing slow5/blow5 files
# m attribute sets the read/write state and file extension of p sets the type
#

cdef class Open:
    cdef pyslow5.slow5_file_t *s5
    cdef pyslow5.slow5_rec_t *rec
    cdef pyslow5.slow5_rec_t *read
    cdef pyslow5.slow5_rec_t *write
    cdef pyslow5.slow5_rec_t **twrite
    cdef pyslow5.slow5_rec_t **trec
    cdef char **rid
    cdef char **rids
    cdef pyslow5.uint64_t rids_len
    cdef bint index_state
    cdef bint header_state
    cdef bint header_add_attr_state
    cdef bint close_state
    cdef pyslow5.uint64_t head_len
    cdef pyslow5.uint64_t aux_len
    cdef pyslow5.slow5_aux_type *s5_aux_type
    cdef int aux_get_err
    cdef pyslow5.uint64_t aux_get_len
    cdef np.npy_intp shape_get[1]
    cdef np.npy_intp shape_seq[1]
    cdef char* p
    cdef str path
    cdef char* m
    cdef str mode
    cdef str rec_press
    cdef str sig_press
    cdef int state
    cdef int V
    cdef object logger
    cdef list aux_names
    cdef list aux_types
    cdef dict error_codes
    cdef dict slow5_press_method
    cdef pyslow5.int8_t e0
    cdef pyslow5.int16_t e1
    cdef pyslow5.int32_t e2
    cdef pyslow5.int64_t e3
    cdef pyslow5.uint8_t e4
    cdef pyslow5.uint16_t e5
    cdef pyslow5.uint32_t e6
    cdef pyslow5.uint64_t e7
    cdef pyslow5.float e8
    cdef double e9
    cdef char e10
    cdef int e11
    cdef pyslow5.int8_t *e12
    cdef pyslow5.int16_t *e13
    cdef pyslow5.int32_t *e14
    cdef pyslow5.int64_t *e15
    cdef pyslow5.uint8_t *e16
    cdef pyslow5.uint16_t *e17
    cdef pyslow5.uint32_t *e18
    cdef pyslow5.uint64_t *e19
    cdef float *e20
    cdef double *e21
    cdef char *e22 # meant to be string, not sure about this
    cdef char *channel_number
    cdef char *median_before
    cdef char *read_number
    cdef char *start_mux
    cdef char *start_time
    cdef char *end_reason # need to add end_reason_val
    cdef char *channel_number_val
    cdef double median_before_val
    cdef pyslow5.int32_t read_number_val
    cdef pyslow5.uint8_t start_mux_val
    cdef pyslow5.uint64_t start_time_val
    cdef char **channel_number_val_array
    cdef double *median_before_val_array
    cdef pyslow5.int32_t *read_number_val_array
    cdef pyslow5.uint8_t *start_mux_val_array
    cdef pyslow5.uint64_t *start_time_val_array

    cdef pyslow5.float total_time_slow5_get_next
    cdef pyslow5.float total_time_yield_reads
    cdef pyslow5.float total_single_write_time
    cdef pyslow5.float total_multi_write_signal_time
    cdef pyslow5.float total_multi_write_time

    def __cinit__(self, pathname, mode, rec_press="zlib", sig_press="svb_zd", DEBUG=0):
        # Set to default NULL type
        self.s5 = NULL
        self.rec = NULL
        self.read = NULL
        self.write = NULL
        self.twrite = NULL
        self.path = ""
        self.p = ""
        self.mode = ""
        self.m = ""
        self.rec_press = ""
        self.sig_press = ""
        # state for read/write. -1=null, 0=read, 1=write, 2=append
        self.state = -1
        self.trec = NULL
        self.rid = NULL
        self.rids = NULL
        self.rids_len = 0
        self.index_state = False
        self.header_state = False
        self.header_add_attr_state = False
        self.close_state = False
        self.s5_aux_type = NULL
        self.aux_get_err = 1
        self.aux_get_len = 0
        self.head_len = 0
        self.aux_len = 0
        self.shape_seq[0] = 0
        self.shape_get[0] = 0
        self.e0 = -1
        self.e1 = -1
        self.e2 = -1
        self.e3 = -1
        self.e4 = -1
        self.e5 = -1
        self.e6 = -1
        self.e7 = -1
        self.e8 = -1.0
        self.e9 = -1.0
        self.e10 = 0
        self.e11 = 0
        self.e12 = NULL
        self.e13 = NULL
        self.e14 = NULL
        self.e15 = NULL
        self.e16 = NULL
        self.e17 = NULL
        self.e18 = NULL
        self.e19 = NULL
        self.e20 = NULL
        self.e21 = NULL
        self.e22 = NULL
        self.channel_number = strdup("channel_number")
        self.median_before = strdup("median_before")
        self.read_number = strdup("read_number")
        self.start_mux = strdup("start_mux")
        self.start_time = strdup("start_time")
        self.end_reason = strdup("end_reason")
        channel_number_val = NULL
        median_before_val = -1.0
        read_number_val = -1
        start_mux_val = -1
        start_time_val = -1
        channel_number_val_array = NULL
        median_before_val_array = NULL
        read_number_val_array = NULL
        start_mux_val_array = NULL
        start_time_val_array = NULL


        # cdef something end_reason # some enum
        self.total_time_slow5_get_next = 0.0
        self.total_time_yield_reads = 0.0
        self.total_single_write_time = 0.0
        self.total_multi_write_signal_time = 0.0
        self.total_multi_write_time = 0.0

        # sets up logging level/verbosity
        self.V = DEBUG
        self.logger = logging.getLogger(__name__)
        if self.V == 1:
            lev = logging.DEBUG
        else:
            lev = logging.WARNING

        logging.basicConfig(format='%(asctime)s - [%(levelname)s]: %(message)s',
                            datefmt='%d-%b-%y %H:%M:%S', level=lev)

        # This should match slow5_defs.h error codes
        self.error_codes = {-1: ["SLOW5_ERR_EOF", "End Of File reached"],
                            -2: ["SLOW5_ERR_ARG", "bad argument (NULL)"],
                            -3: ["SLOW5_ERR_TRUNC", "file truncated"],
                            -4: ["SLOW5_ERR_RECPARSE", "record parsing error"],
                            -5: ["SLOW5_ERR_IO", "other file I/O error"],
                            -6: ["SLOW5_ERR_NOIDX", "index not loaded"],
                            -7: ["SLOW5_ERR_NOTFOUND", "read id not found"],
                            -8: ["SLOW5_ERR_OTH", "other error (big endian, internal error, etc.)"],
                            -9: ["SLOW5_ERR_UNK", "file format unknown"],
                            -10: ["SLOW5_ERR_MEM", "memory (re)allocation error"],
                            -11: ["SLOW5_ERR_NOAUX", "no auxiliary map"],
                            -12: ["SLOW5_ERR_NOFLD", "field not found"],
                            -13: ["SLOW5_ERR_PRESS", "(de)compression failure"],
                            -14: ["SLOW5_ERR_MAGIC", "magic number invalid"],
                            -15: ["SLOW5_ERR_VERSION", "version incompatible"],
                            -16: ["SLOW5_ERR_HDRPARSE", "header parsing error"],
                            -17: ["SLOW5_ERR_TYPE", "error relating to slow5 type"]}
        # slow5_press_method from slow5_press.h
        # enum slow5_press_method {
        #     SLOW5_COMPRESS_NONE,
        #     SLOW5_COMPRESS_ZLIB,
        #     SLOW5_COMPRESS_SVB_ZD, /* streamvbyte zigzag delta */
        #     SLOW5_COMPRESS_ZSTD,
        # };
        self.slow5_press_method = {"none": 0,
                                   "zlib": 1,
                                   "svb_zd": 2,
                                   "zstd": 3}

        p = str.encode(pathname)
        self.path = pathname
        self.p = strdup(p)
        m = str.encode(mode)
        self.mode = mode
        self.m = strdup(m)
        self.logger.debug("FILE: {}, mode: {}".format(self.path, self.mode))
        self.logger.debug("FILE: {}, mode: {}".format(self.p, self.m))
        # Set state based on mode for file opening
        # state for read/write. -1=null, 0=read, 1=write, 2=append
        if mode == "r":
            self.state = 0
        elif mode == "w":
            self.state = 1
            self.rec_press = rec_press
            self.sig_press = sig_press
        elif mode == "a":
            self.state = 2
        else:
            self.state = -1
        # opens file and creates slow5 object for reading
        if self.state == 0:
            self.s5 = pyslow5.slow5_open(self.p, self.m)
            self.logger.debug("Number of read_groups: {}".format(self.s5.header.num_read_groups))
        elif self.state == 1:
            self.s5 = pyslow5.slow5_open(self.p, self.m)
            if self.s5 is NULL:
                self.logger.error("File '{}' could not be opened for writing.".format(self.path))
            if "blow5" in self.path.split(".")[-1]:
                if self.rec_press in self.slow5_press_method.keys() and self.sig_press in self.slow5_press_method.keys():
                    ret = pyslow5.slow5_set_press(self.s5, self.slow5_press_method[self.rec_press], self.slow5_press_method[self.sig_press])
                    if ret != 0:
                        self.logger.error("slow5_set_press return not 0: {}".format(ret))
                        raise RuntimeError("Unable to set compression")
                else:
                    self.logger.error("Compression type rec_press: {}, sig_press: {} could not be found.".format(self.rec_press, self.sig_press))
                    self.logger.error("Please use only the following: {}".format(",".join(press for press in self.slow5_press_method.keys())))
                    raise KeyError
            else:
                self.logger.debug("Not writing blow5, skipping compression steps")
        elif self.state == 2:
            self.s5 = pyslow5.slow5_open(self.p, self.m)
            if self.s5 is NULL:
                self.logger.error("File '{}' could not be opened for writing - appending.".format(self.path))
        else:
            self.logger.error("File '{}' unknown open method: {}".format(self.path, self.mode))
        # check object was actually created.
        if self.s5 is NULL:
            raise MemoryError()


    def __init__(self, pathname, mode, rec_press="zlib", sig_press="svb_zd", DEBUG=0):
        self.aux_names = []
        self.aux_types = []


    def __dealloc__(self):
        if self.p is not NULL:
            free(self.p)
        if self.m is not NULL:
            free(self.m)
        if self.rec is not NULL:
            slow5_rec_free(self.rec)
        if self.read is not NULL:
            slow5_rec_free(self.read)
        if self.write is not NULL:
            slow5_rec_free(self.write)
        if self.state in [1, 2]:
            if not self.close_state:
                if self.s5 is not NULL:
                    slow5_close(self.s5)
                    self.close_state = True
                    self.logger.debug("{} closed".format(self.path))
            else:
                self.logger.debug("{} already closed".format(self.path))
        if self.state == 0:
            if not self.close_state:
                if self.s5 is not NULL:
                    slow5_idx_unload(self.s5)
                    slow5_close(self.s5)
                    self.close_state = True
                    self.logger.debug("{} closed".format(self.path))

        free(self.channel_number)
        free(self.median_before)
        free(self.read_number)
        free(self.start_mux)
        free(self.start_time)
        free(self.end_reason)

        self.logger.debug("pathname: {}".format(self.path))
        self.logger.debug("total_time_slow5_get_next: {} seconds".format(self.total_time_slow5_get_next))
        self.logger.debug("total_time_yield_reads: {} seconds".format(self.total_time_yield_reads))
        self.logger.debug("total_single_write_time: {} seconds".format(self.total_single_write_time))
        self.logger.debug("total_multi_write_signal_time: {} seconds".format(self.total_multi_write_signal_time))
        self.logger.debug("total_multi_write_time: {} seconds".format(self.total_multi_write_time))


    def _convert_to_pA(self, d):
        '''
        convert raw signal data to pA using digitisation, offset, and range
        float raw_unit = range / digitisation;
        for (int32_t j = 0; j < nsample; j++) {
            rawptr[j] = (rawptr[j] + offset) * raw_unit;
        }
        TODO: Use memory view for the loop so it's faster
        '''
        digitisation = d['digitisation']
        range = d['range']
        offset = d['offset']
        raw_unit = range / digitisation
        # new_raw = []
        # for i in d['signal']:
        #     j = (i + offset) * raw_unit
        #     new_raw.append(float("{0:.2f}".format(round(j,2))))
        # new_raw = np.array(raw_unit * (d['signal'] + offset), dtype=np.float32)
        new_raw = (raw_unit * (d['signal'] + offset)).astype(np.float32)
        return new_raw

    # ==========================================================================
    #      Read SLOW5 file
    # ==========================================================================

    def _get_read(self, read_id, pA, aux):
        '''
        read_id = readID of individual read as a string, get's converted to b'str'
        pA = Bool for converting signal to picoamps
        aux = str 'name'/'all' or list of names of auxiliary fields added to return dictionary
        returns dic = dictionary of main fields for read_id, with any aux fields added
        '''
        if not self.index_state:
            self.logger.debug("FILE: {}, mode: {}".format(self.path, self.mode))
            # self.logger.debug("FILE: {}, mode: {}".format(self.path, self.m))
            self.logger.debug("Creating/loading index...")
            ret = slow5_idx_load(self.s5)
            if ret != 0:
                self.logger.warning("slow5_idx_load return not 0: {}: {}".format(ret, self.error_codes[ret]))
            else:
                self.index_state = True
        dic = {}
        aux_dic = {}
        ID = str.encode(read_id)
        # rec = NULL
        ret = slow5_get(ID, &self.rec, self.s5)
        if ret != 0:
            self.logger.debug("get_read return not 0: {}".format(ret))
            return None

        # check for aux fields
        if aux is not None:
            if not self.aux_names or not self.aux_types:
                self.aux_names = self.get_aux_names()
                self.aux_types = self.get_aux_types()
            if type(aux) is str:
                # special type 'all'
                if aux == "all":
                    aux_dic = self._get_read_aux(self.aux_names, self.aux_types)
                else:
                    found_single_aux = False
                    for n, t in zip(self.aux_names, self.aux_types):
                        if n == aux:
                            found_single_aux = True
                            aux_dic = self._get_read_aux([n], [t])
                            break
                    if not found_single_aux:
                        self.logger.warning("get_read unknown aux name: {}".format(aux))
                        aux_dic.update({aux: None})
            elif type(aux) is list:
                n_list = []
                t_list = []
                for n, t in zip(self.aux_names, self.aux_types):
                    if n in aux:
                        n_list.append(n)
                        t_list.append(t)

                aux_dic = self._get_read_aux(n_list, t_list)
                # Check for items given that did not exist
                n_set = set(n_list)
                aux_set = set(aux)
                if len(aux_set.difference(n_set)) > 0:
                    for i in aux_set.difference(n_set):
                        self.logger.warning("get_read unknown aux name: {}".format(i))
                        aux_dic.update({i: None})

            else:
                self.logger.debug("get_read aux type unknown, accepts str or list: {}".format(aux))

        # get read data
        if type(self.rec.read_id) is bytes:
            dic['read_id'] = self.rec.read_id.decode()
        else:
            dic['read_id'] = self.rec.read_id
        dic['read_group'] = self.rec.read_group
        dic['digitisation'] = self.rec.digitisation
        dic['offset'] = self.rec.offset
        dic['range'] = self.rec.range
        dic['sampling_rate'] = self.rec.sampling_rate
        dic['len_raw_signal'] = self.rec.len_raw_signal
        # This could be handled by numpy.fromiter() or similar
        # Probably MUCH faster
        # https://stackoverflow.com/questions/7543675/how-to-convert-pointer-to-c-array-to-python-array
        # https://groups.google.com/g/cython-users/c/KnjF7ViaHUM
        # dic['signal'] = [self.rec.raw_signal[i] for i in range(self.rec.len_raw_signal)]
        # cdef np.npy_intp shape_get[1]
        self.shape_get[0] = <np.npy_intp> self.rec.len_raw_signal
        signal = copy.deepcopy(np.PyArray_SimpleNewFromData(1, self.shape_get,
                    np.NPY_INT16, <void *> self.rec.raw_signal))
        np.PyArray_UpdateFlags(signal, signal.flags.num | np.NPY_OWNDATA)
        dic['signal'] = signal

        # if pA=True, convert signal to pA
        if pA:
            dic['signal'] = self._convert_to_pA(dic)
        # if aux data, add to main dic
        if aux_dic:
            dic.update(aux_dic)
        return dic

    def _get_batches(self, read_list, size):
        """
        batchify readIDs
        """
        for i in range(0, len(read_list), size):
            yield read_list[i:i+size]

    def _get_read_multi(self, read_list, threads, batchsize, pA, aux):
        '''
        read_list = list of readIDs
        pA = Bool for converting signal to picoamps
        aux = str 'name'/'all' or list of names of auxiliary fields added to return dictionary
        returns dic = dictionary of main fields for read_id, with any aux fields added
        threads = how many threads to use to go fast
        '''
        if not self.index_state:
            self.logger.debug("FILE: {}, mode: {}".format(self.path, self.mode))
            self.logger.debug("Creating/loading index...")
            ret = slow5_idx_load(self.s5)
            if ret != 0:
                self.logger.warning("slow5_idx_load return not 0: {}: {}".format(ret, self.error_codes[ret]))
            else:
                self.index_state = True

        self.logger.debug("Setting up batching...")
        self.logger.debug("read_list: {}".format([i for i in read_list]))
        num_reads = len(read_list)
        if num_reads > batchsize:
            batches = self._get_batches(read_list, size=batchsize)
        else:
            batches = self._get_batches(read_list, size=num_reads)

        self.logger.debug("batch for loop start")
        for batch in chain(batches):
            self.logger.debug("Batch: {}".format(",".join([i for i in batch])))
            batch_len = len(batch)
            self.logger.debug("Starting rid assignment")
            self.rid = <char **> malloc(sizeof(char*)*batch_len)
            for i in range(batch_len):
                self.logger.debug("readID: {}, bin: {}".format(batch[i], batch[i].encode()))
                self.rid[i] = strdup(batch[i].encode())
            self.logger.debug("rid assignment complete")


            self.logger.debug("slow5_get_batch: num_reads: {}".format(batch_len))
            ret = slow5_get_batch(&self.trec, self.s5, self.rid, batch_len, threads);
            self.logger.debug("get_read_multi slow5_get_batch ret: {}".format(ret))
            if ret < 0:
                self.logger.error("slow5_get_next error code: {}: {}".format(ret, self.error_codes[ret]))
                break
            if ret == 0:
                self.logger.debug("No more reads: {}".format(ret))
                break

            for i in range(ret):
                python_parse_read_start = time.time()
                self.rec = self.trec[i]
                dic = {}
                aux_dic = {}

                # check for aux fields
                if aux is not None:
                    if not self.aux_names or not self.aux_types:
                        self.aux_names = self.get_aux_names()
                        self.aux_types = self.get_aux_types()
                    if type(aux) is str:
                        # special type 'all'
                        if aux == "all":
                            aux_dic = self._get_read_aux(self.aux_names, self.aux_types)
                        else:
                            found_single_aux = False
                            for n, t in zip(self.aux_names, self.aux_types):
                                if n == aux:
                                    found_single_aux = True
                                    aux_dic = self._get_read_aux([n], [t])
                                    break
                            if not found_single_aux:
                                self.logger.warning("get_read unknown aux name: {}".format(aux))
                                aux_dic.update({aux: None})
                    elif type(aux) is list:
                        n_list = []
                        t_list = []
                        for n, t in zip(self.aux_names, self.aux_types):
                            if n in aux:
                                n_list.append(n)
                                t_list.append(t)

                        aux_dic = self._get_read_aux(n_list, t_list)
                        # Check for items given that did not exist
                        n_set = set(n_list)
                        aux_set = set(aux)
                        if len(aux_set.difference(n_set)) > 0:
                            for i in aux_set.difference(n_set):
                                self.logger.warning("get_read unknown aux name: {}".format(i))
                                aux_dic.update({i: None})

                    else:
                        self.logger.debug("get_read aux type unknown, accepts str or list: {}".format(aux))

                # get read data
                if type(self.rec.read_id) is bytes:
                    dic['read_id'] = self.rec.read_id.decode()
                else:
                    dic['read_id'] = self.rec.read_id
                dic['read_group'] = self.rec.read_group
                dic['digitisation'] = self.rec.digitisation
                dic['offset'] = self.rec.offset
                dic['range'] = self.rec.range
                dic['sampling_rate'] = self.rec.sampling_rate
                dic['len_raw_signal'] = self.rec.len_raw_signal
                # This could be handled by numpy.fromiter() or similar
                # Probably MUCH faster
                # https://stackoverflow.com/questions/7543675/how-to-convert-pointer-to-c-array-to-python-array
                # https://groups.google.com/g/cython-users/c/KnjF7ViaHUM
                # dic['signal'] = [self.rec.raw_signal[i] for i in range(self.rec.len_raw_signal)]
                # cdef np.npy_intp shape_get[1]
                self.shape_get[0] = <np.npy_intp> self.rec.len_raw_signal
                signal = copy.deepcopy(np.PyArray_SimpleNewFromData(1, self.shape_get,
                            np.NPY_INT16, <void *> self.rec.raw_signal))
                np.PyArray_UpdateFlags(signal, signal.flags.num | np.NPY_OWNDATA)
                dic['signal'] = signal

                # if pA=True, convert signal to pA
                if pA:
                    dic['signal'] = self._convert_to_pA(dic)
                # if aux data, add to main dic
                if aux_dic:
                    dic.update(aux_dic)
                yield dic

            slow5_free_batch(&self.trec, ret)
            for i in range(batch_len):
                free(self.rid[i])
            free(self.rid)
        self.rec = NULL
        self.logger.debug("seq_reads_multi timings:")


    def _get_read_aux(self, aux_names, aux_types):
        '''
        get aux field for read
        aux_names and aux_types need to be lists, even if a single element
        both names and types need to be in the same order, to ensure correct type function is called
        This ensures correct C -> python object conversion
        Returns dictionary with dic[name] = value
        '''
        dic = {}
        # treat all input as list to simplify
        for name, atype in zip(aux_names, aux_types):
            a_name = str.encode(name)
            if atype == 0:
                self.e0 = slow5_aux_get_int8(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e0
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 1:
                self.e1 = slow5_aux_get_int16(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e1
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 2:
                self.e2 = slow5_aux_get_int32(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e2
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 3:
                self.e3 = slow5_aux_get_int64(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e3
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 4:
                self.e4 = slow5_aux_get_uint8(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e4
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 5:
                self.e5 = slow5_aux_get_uint16(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e5
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 6:
                self.e6 = slow5_aux_get_uint32(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e6
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 7:
                self.e7 = slow5_aux_get_uint64(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e7
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 8:
                self.e8 = slow5_aux_get_float(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e8
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 9:
                self.e9 = slow5_aux_get_double(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e9
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 10:
                self.e10 = slow5_aux_get_char(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e10
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 11:
                self.e11 = slow5_aux_get_enum(self.rec, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e11
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype), self.aux_get_err, self.error_codes[self.aux_get_err])
                    dic[name] = None
            elif atype == 12:
                self.e12 = slow5_aux_get_int8_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e12[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 13:
                self.e13 = slow5_aux_get_int16_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e13[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 14:
                self.e14 = slow5_aux_get_int32_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e14[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 15:
                self.e15 = slow5_aux_get_int64_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e15[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 16:
                self.e16 = slow5_aux_get_uint8_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e16[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 17:
                self.e17 = slow5_aux_get_uint16_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e17[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 18:
                self.e18 = slow5_aux_get_uint32_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e18[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 19:
                self.e19 = slow5_aux_get_uint64_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e19[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 20:
                self.e20 = slow5_aux_get_float_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e20[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 21:
                self.e21 = slow5_aux_get_double_array(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e21[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 22:
                self.e22 = slow5_aux_get_string(self.rec, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    s = ""
                    for i in range(self.aux_get_len):
                        l.append(chr(self.e22[i]))
                        s = "".join(l)
                    dic[name] = s
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 22:
                self.logger.debug("NOT IMPLEMENTED YET: get_aux_types {} self.aux_get_err is {}: {}".format(atype), self.aux_get_err, self.error_codes[self.aux_get_err])
                dic[name] = None
            else:
                self.logger.debug("get_read_aux atype not known, skipping: {}".format(atype))

        return dic


    def _get_seq_read_aux(self, aux_names, aux_types):
        '''
        get aux field for read - when doing sequential read, because of separate self.read (vs rec) call
        aux_names and aux_types need to be lists, even if a single element
        both names and types need to be in the same order, to ensure correct type function is called
        This ensures correct C -> python object conversion
        Returns dictionary with dic[name] = value
        '''
        dic = {}
        # treat all input as a list to simplify
        for name, atype in zip(aux_names, aux_types):
            a_name = str.encode(name)
            if atype == 0:
                self.e0 = slow5_aux_get_int8(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e0
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 1:
                self.e1 = slow5_aux_get_int16(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e1
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 2:
                self.e2 = slow5_aux_get_int32(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e2
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 3:
                self.e3 = slow5_aux_get_int64(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e3
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 4:
                self.e4 = slow5_aux_get_uint8(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e4
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 5:
                self.e5 = slow5_aux_get_uint16(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e5
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 6:
                self.e6 = slow5_aux_get_uint32(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e6
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 7:
                self.e7 = slow5_aux_get_uint64(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e7
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 8:
                self.e8 = slow5_aux_get_float(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e8
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 9:
                self.e9 = slow5_aux_get_double(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e9
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 10:
                self.e10 = slow5_aux_get_char(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e10
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 11:
                self.e11 = slow5_aux_get_enum(self.read, a_name, &self.aux_get_err)
                if self.aux_get_err == 0:
                    dic[name] = self.e11
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype), self.aux_get_err, self.error_codes[self.aux_get_err])
                    dic[name] = None
            elif atype == 12:
                self.e12 = slow5_aux_get_int8_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e12[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 13:
                self.e13 = slow5_aux_get_int16_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e13[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 14:
                self.e14 = slow5_aux_get_int32_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e14[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 15:
                self.e15 = slow5_aux_get_int64_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e15[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 16:
                self.e16 = slow5_aux_get_uint8_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e16[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 17:
                self.e17 = slow5_aux_get_uint16_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e17[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 18:
                self.e18 = slow5_aux_get_uint32_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e18[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 19:
                self.e19 = slow5_aux_get_uint64_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e19[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 20:
                self.e20 = slow5_aux_get_float_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e20[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 21:
                self.e21 = slow5_aux_get_double_array(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    for i in range(self.aux_get_len):
                        l.append(self.e21[i])
                    dic[name] = l
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 22:
                self.e22 = slow5_aux_get_string(self.read, a_name, &self.aux_get_len, &self.aux_get_err)
                if self.aux_get_err == 0:
                    l = []
                    s = ""
                    for i in range(self.aux_get_len):
                        l.append(chr(self.e22[i]))
                        s = "".join(l)
                    dic[name] = s
                else:
                    self.logger.debug("get_aux_types {} self.aux_get_err is {}: {}".format(atype, self.aux_get_err, self.error_codes[self.aux_get_err]))
                    dic[name] = None
            elif atype == 22:
                self.logger.debug("NOT IMPLEMENTED YET: get_aux_types {} self.aux_get_err is {}: {}".format(atype), self.aux_get_err, self.error_codes[self.aux_get_err])
                dic[name] = None
            else:
                self.logger.debug("get_read_aux atype not known, skipping: {}".format(atype))

        return dic


    def get_read_ids(self):
        '''
        get all read_ids from index
        if no index, build it then get read_ids
        No idea why this is needed but whatever
        '''
        rids = []
        if not self.index_state:
            self.logger.debug("FILE: {}, mode: {}".format(self.path, self.mode))
            # self.logger.debug("FILE: {}, mode: {}".format(self.path, self.m))
            self.logger.debug("Creating/loading index...")
            ret = slow5_idx_load(self.s5)
            if ret != 0:
                self.logger.warning("slow5_idx_load return not 0: {}: {}".format(ret, self.error_codes[ret]))
            else:
                self.index_state = True
        self.rids = slow5_get_rids(self.s5, &self.rids_len)

        if self.rids_len == 0:
            self.logger.error("get_read_ids: length of read_ids is 0, something when wrong")

        if self.rids is NULL:
            self.logger.error("get_read_ids: returned rids is NULL, something when wrong")
        else:
            for i in range(self.rids_len):
                rids.append(self.rids[i].decode())
        rids_len = self.rids_len
        return rids, rids_len


    def get_read(self, read_id, pA=False, aux=None):
        return self._get_read(read_id, pA, aux)


    def seq_reads(self, pA=False, aux=None):
        '''
        returns generator for sequential reading of slow5 file
        for pA and aux, see _get_read
        '''
        aux_dic = {}
        row = {}
        ret = 0
        # While loops check ret of previous read for errors as fail safe
        while ret >= 0:
            start_slow5_get_next = time.time()
            ret = slow5_get_next(&self.read, self.s5)
            self.total_time_slow5_get_next = self.total_time_slow5_get_next + (time.time() - start_slow5_get_next)

            self.logger.debug("slow5_get_next return: {}".format(ret))
            # check for EOF or other errors
            if ret < 0:
                if ret == -1:
                    self.logger.debug("slow5_get_next reached end of file (EOF)(-1): {}: {}".format(ret, self.error_codes[ret]))
                else:
                    self.logger.error("slow5_get_next error code: {}: {}".format(ret, self.error_codes[ret]))

                break

            aux_dic = {}
            row = {}
            # get aux fields
            if aux is not None:
                if not self.aux_names or not self.aux_types:
                    self.aux_names = self.get_aux_names()
                    self.aux_types = self.get_aux_types()
                if type(aux) is str:
                    if aux == "all":
                        aux_dic = self._get_seq_read_aux(self.aux_names, self.aux_types)
                    else:
                        found_single_aux = False
                        for n, t in zip(self.aux_names, self.aux_types):
                            if n == aux:
                                found_single_aux = True
                                aux_dic = self._get_seq_read_aux([n], [t])
                                break
                        if not found_single_aux:
                            self.logger.warning("get_read unknown aux name: {}".format(aux))
                            aux_dic.update({aux: None})
                elif type(aux) is list:
                    n_list = []
                    t_list = []
                    for n, t in zip(self.aux_names, self.aux_types):
                        if n in aux:
                            n_list.append(n)
                            t_list.append(t)

                    aux_dic = self._get_seq_read_aux(n_list, t_list)
                    # check for items in given list that do not exist
                    n_set = set(n_list)
                    aux_set = set(aux)
                    if len(aux_set.difference(n_set)) > 0:
                        for i in aux_set.difference(n_set):
                            self.logger.warning("get_read unknown aux name: {}".format(i))
                            aux_dic.update({i: None})

                else:
                    self.logger.debug("get_read aux type unknown, accepts str or list: {}".format(aux))

            # Get read data
            if type(self.read.read_id) is bytes:
                row['read_id'] = self.read.read_id.decode()
            else:
                row['read_id'] = self.read.read_id
            row['read_group'] = self.read.read_group
            row['digitisation'] = self.read.digitisation
            row['offset'] = self.read.offset
            row['range'] = self.read.range
            row['sampling_rate'] = self.read.sampling_rate
            row['len_raw_signal'] = self.read.len_raw_signal
            self.shape_seq[0] = <np.npy_intp> self.read.len_raw_signal
            signal = copy.deepcopy(np.PyArray_SimpleNewFromData(1, self.shape_seq,
                        np.NPY_INT16, <void *> self.read.raw_signal))
            np.PyArray_UpdateFlags(signal, signal.flags.num | np.NPY_OWNDATA)
            row['signal'] = signal

            # if pA=True, convert signal to pA
            if pA:
                row['signal'] = self._convert_to_pA(row)
            # if aux data update main dic
            if aux_dic:
                row.update(aux_dic)
            self.total_time_yield_reads = self.total_time_yield_reads + (time.time() - start_slow5_get_next)
            yield row


    def seq_reads_multi(self, threads=4, batchsize=4096, pA=False, aux=None):
        '''
        returns generator for sequential reading of slow5 file
        for pA and aux, see _get_read
        threads: number of threads to use
        batchsize: Number of reads to process with thread pool in parallel
        '''
        aux_dic = {}
        row = {}
        ret = 1
        timedic = {"aux_total_time": 0,
                   "primary_total_time": 0,
                   "pA_total_time": 0,
                   "signal_total_time": 0}

        # While loops check ret of previous read for errors as fail safe
        while ret > 0:
            start_slow5_get_next = time.time()
            ret = slow5_get_next_batch(&self.trec, self.s5, batchsize, threads)
            self.total_time_slow5_get_next = self.total_time_slow5_get_next + (time.time() - start_slow5_get_next)
            self.logger.debug("slow5_get_next_multi return: {}".format(ret))
            # check for EOF or other errors
            if ret < 0:
                if ret == -1:
                    self.logger.debug("slow5_get_next_multi reached end of file (EOF)(-1): {}: {}".format(ret, self.error_codes[ret]))
                else:
                    self.logger.error("slow5_get_next_multi error code: {}: {}".format(ret, self.error_codes[ret]))

                break
            for i in range(ret):
                python_parse_read_start = time.time()
                self.read = self.trec[i]
                aux_dic = {}
                row = {}
                # get aux fields
                aux_time_start = time.time()
                if aux is not None:
                    if not self.aux_names or not self.aux_types:
                        self.aux_names = self.get_aux_names()
                        self.aux_types = self.get_aux_types()
                    if type(aux) is str:
                        if aux == "all":
                            aux_dic = self._get_seq_read_aux(self.aux_names, self.aux_types)
                        else:
                            found_single_aux = False
                            for n, t in zip(self.aux_names, self.aux_types):
                                if n == aux:
                                    found_single_aux = True
                                    aux_dic = self._get_seq_read_aux([n], [t])
                                    break
                            if not found_single_aux:
                                self.logger.warning("slow5_get_next_multi unknown aux name: {}".format(aux))
                                aux_dic.update({aux: None})
                    elif type(aux) is list:
                        n_list = []
                        t_list = []
                        for n, t in zip(self.aux_names, self.aux_types):
                            if n in aux:
                                n_list.append(n)
                                t_list.append(t)

                        aux_dic = self._get_seq_read_aux(n_list, t_list)
                        # check for items in given list that do not exist
                        n_set = set(n_list)
                        aux_set = set(aux)
                        if len(aux_set.difference(n_set)) > 0:
                            for i in aux_set.difference(n_set):
                                self.logger.warning("slow5_get_next_multi unknown aux name: {}".format(i))
                                aux_dic.update({i: None})

                    else:
                        self.logger.debug("slow5_get_next_multi aux type unknown, accepts str or list: {}".format(aux))
                timedic["aux_total_time"] = timedic["aux_total_time"] + (time.time() - aux_time_start)
                # Get read data
                primary_start_time = time.time()
                if type(self.read.read_id) is bytes:
                    row['read_id'] = self.read.read_id.decode()
                else:
                    row['read_id'] = self.read.read_id
                # row['read_id'] = self.read.read_id.decode()
                row['read_group'] = self.read.read_group
                row['digitisation'] = self.read.digitisation
                row['offset'] = self.read.offset
                row['range'] = self.read.range
                row['sampling_rate'] = self.read.sampling_rate
                row['len_raw_signal'] = self.read.len_raw_signal
                signal_start_time = time.time()
                self.shape_seq[0] = <np.npy_intp> self.read.len_raw_signal
                signal = copy.deepcopy(np.PyArray_SimpleNewFromData(1, self.shape_seq,
                            np.NPY_INT16, <void *> self.read.raw_signal))
                np.PyArray_UpdateFlags(signal, signal.flags.num | np.NPY_OWNDATA)
                row['signal'] = signal
                timedic["signal_total_time"] = timedic["signal_total_time"] + (time.time() - signal_start_time)
                timedic["primary_total_time"] = timedic["primary_total_time"] + (time.time() - primary_start_time)
                # if pA=True, convert signal to pA
                if pA:
                    pA_start_time = time.time()
                    row['signal'] = self._convert_to_pA(row)
                    timedic["pA_total_time"] = timedic["pA_total_time"] + (time.time() - pA_start_time)
                # if aux data update main dic
                if aux_dic:
                    row.update(aux_dic)
                self.total_time_yield_reads = self.total_time_yield_reads + (time.time() - python_parse_read_start)
                yield row
            slow5_free_batch(&self.trec, ret)
            if ret < batchsize:
                self.logger.debug("slow5_get_next_multi has no more batches - batchsize:{} ret:{}".format(batchsize, ret))
                break
        self.read = NULL
        self.logger.debug("seq_reads_multi timings:")
        for i in timedic:
            self.logger.debug("{}: {}".format(i, timedic[i]))


    def get_read_list(self, read_list, pA=False, aux=None):
        '''
        returns generator for random access of slow5 file
        read_list = list of readIDs, if readID not in file, None type returned (need EOF to work)
        for pA and aux see _get_read
        '''
        for r in read_list:
            yield self._get_read(r, pA, aux)


    def get_read_list_multi(self, read_list, threads=4, batchsize=100, pA=False, aux=None):
        '''
        returns generator for random access of slow5 file
        read_list = list of readIDs, if readID not in file, None type returned (need EOF to work)
        for pA and aux see _get_read
        threads = number of threads to use to do batched random access
        '''
        for r in self._get_read_multi(read_list, threads, batchsize, pA, aux):
            yield r


    def get_header_names(self):
        '''
        get all header names and return list
        '''
        headers = []
        ret = slow5_get_hdr_keys(self.s5.header, &self.head_len)

        self.logger.debug("slow5_get_hdr_keys head_len: {}".format(self.head_len))
        if ret == NULL:
            self.logger.debug("slow5_get_hdr_keys ret is NULL")
            return headers

        headers = [ret[i].decode() for i in range(self.head_len)]
        free(ret)
        return headers


    def get_header_value(self, attr, read_group=0):
        '''
        get header attribute value
        '''
        a = str.encode(attr)
        ret = ''
        ret = slow5_hdr_get(a, read_group, self.s5.header).decode()
        if not ret:
            self.logger.warning("get_header_value header value not found: {} - rg: {}".format(attr, read_group))
            return None
        return ret


    def get_all_headers(self, read_group=0):
        '''
        get all headers present and return dictionary
        '''
        dic = {}
        headers = self.get_header_names()
        for header in headers:
            val = self.get_header_value(header, read_group=read_group)
            dic[header] = val
        return dic


    def get_aux_names(self):
        '''
        get all aux field names, returns list
        '''
        self.logger.debug("get_aux_names starting")
        aux_names = []
        ret = slow5_get_aux_names(self.s5.header, &self.aux_len)

        self.logger.debug("get_aux_names aux_len: {}".format(self.aux_len))
        if ret == NULL:
            self.logger.warning("get_aux_names ret is NULL")
            return aux_names

        aux_names = [ret[i].decode() for i in range(self.aux_len)]
        return aux_names


    def get_aux_types(self):
        '''
        get aux attribute type
        '''
        self.logger.debug("get_aux_types starting")
        aux_types = []
        self.s5_aux_type = slow5_get_aux_types(self.s5.header, &self.aux_len)

        self.logger.debug("get_aux_types aux_len: {}".format(self.aux_len))
        if self.s5_aux_type == NULL:
            self.logger.warning("get_aux_types self.s5_aux_type is NULL")
            return aux_types

        aux_types = [self.s5_aux_type[i] for i in range(self.aux_len)]
        return aux_types

    # ==========================================================================
    #      Write SLOW5 file
    # ==========================================================================

    def get_empty_header(self):
        '''
        returns example empty header dic for user to populate
        Any values not populated will be skipped
        '''
        header = {"asic_id": None,
                  "asic_id_eeprom": None,
                  "asic_temp": None,
                  "asic_version": None,
                  "auto_update": None,
                  "auto_update_source": None,
                  "barcoding_enabled": None,
                  "bream_is_standard": None,
                  "configuration_version": None,
                  "device_id": None,
                  "device_type": None,
                  "distribution_status": None,
                  "distribution_version": None,
                  "exp_script_name": None,
                  "exp_script_purpose": None,
                  "exp_start_time": None,
                  "experiment_duration_set": None,
                  "flow_cell_id": None,
                  "flow_cell_product_code": None,
                  "guppy_version": None,
                  "heatsink_temp": None,
                  "hostname": None,
                  "installation_type": None,
                  "local_basecalling": None,
                  "operating_system": None,
                  "package": None,
                  "protocol_group_id": None,
                  "protocol_run_id": None,
                  "protocol_start_time": None,
                  "protocols_version": None,
                  "run_id": None,
                  "sample_frequency": None,
                  "sample_id": None,
                  "sequencing_kit": None,
                  "usb_config": None,
                  "version": None,
                  "hublett_board_id": None,
                  "satellite_firmware_version": None}

        return header

    def get_empty_record(self, aux=False):
        '''
        Return a dictionary of empty record and types
        if axu=True, a second dictionary will be returned with optional aux record
        '''
        record = {"read_id": None,
                  "read_group": 0,
                  "digitisation": None,
                  "offset": None,
                  "range": None,
                  "sampling_rate": None,
                  "len_raw_signal": None,
                  "signal": None}

        aux_rec = {"channel_number": None,
               "median_before": None,
               "read_number": None,
               "start_mux": None,
               "start_time": None}

        if aux:
            return record, aux_rec
        return record


    def _header_type_validation(self, header):
        '''
        internal function to validate header types before pushing to C side
        '''
        for h in header:
            if header[h] is not None:
                t = type(header[h])
                if t is not type("string"):
                    self.logger.warning("_header_type_validation {}: {} is not a string type, attempting to convert".format(h, header[h]))
                    #try and convert
                    try:
                        s = str(header[h])
                        header[h] = s
                        self.logger.warning("_header_type_validation {}: {} conversion successful".format(h, s))
                    except:
                        self.logger.error("_header_type_validation {}: {} could not convert value to string".format(h, header[h]))
                        raise
        return header


    def _aux_header_type_validation(self, user_aux_types):
        '''
        internal function to validate and convert aux types before pushing to C side
        '''
        slow5_aux_types = {}

        py_aux_types = {"channel_number": type("string"),
                     "median_before": type(1.0),
                     "read_number": type(10),
                     "start_mux": type(1),
                     "start_time": type(100),
                     "end_reason": None}

        C_aux_types = {"channel_number": SLOW5_STRING,
                     "median_before":SLOW5_DOUBLE,
                     "read_number": SLOW5_INT32_T,
                     "start_mux": SLOW5_UINT8_T,
                     "start_time": SLOW5_UINT64_T,
                     "end_reason": None}

        for a in user_aux_types:
            if user_aux_types[a] is None:
                continue
            if a not in py_aux_types:
                self.logger.error("_aux_type_validation {}: {} user aux field not in pyslow5 aux_types".format(a, user_aux_types[a]))
                return None
            if user_aux_types[a] == py_aux_types[a]:
                slow5_aux_types[a] = C_aux_types[a]
            else:
                self.logger.error("_aux_type_validation {}: {} user aux field type mismatch with pyslow5 aux_types".format(a, user_aux_types[a]))
                return None
        return slow5_aux_types


    def _record_type_validation(self, user_record, aux=None):
        '''
        internal function to validate and convert aux types before pushing to C side
        returns None, None on error
        '''

        py_record_types = {"read_id": type("string"),
                           "read_group": type(1),
                           "digitisation": type(1.0),
                           "offset": type(1.0),
                           "range": type(1.0),
                           "sampling_rate": type(1.0),
                           "len_raw_signal": type(10),
                           "signal": type(np.array([1, 2, 3], np.int16))}

        py_aux_types = {"channel_number": type("string"),
                        "median_before": type(1.0),
                        "read_number": type(10),
                        "start_mux": type(1),
                        "start_time": type(100),
                        "end_reason": None}

        new_aux = {}

        for a in user_record:
            if user_record[a] is None:
                continue
            if a not in py_record_types:
                self.logger.error("_record_type_validation {}: {} user primary field not in pyslow5 record_types".format(a, user_record[a]))
                return None, None

            if type(user_record[a]) != py_record_types[a]:
                self.logger.error("_record_type_validation {}: {} user primary field type mismatch with pyslow5 record_types".format(a, user_record[a]))
                return None, None

        # check aux if given
        if aux is not None:
            self.logger.debug("_record_type_validation: doing aux stuff...")
            for a in aux:
                if a not in py_aux_types:
                    self.logger.error("_record_type_validation {}: {} user aux field not in pyslow5 aux_types".format(a, aux[a]))
                    return None, None
                if aux[a] is None:
                    continue
                if type(aux[a]) != py_aux_types[a]:
                    self.logger.error("_record_type_validation {}: {} user aux field type mismatch with pyslow5 aux_types".format(a, aux[a]))
                    return None, None
                else:
                    self.logger.debug("_record_type_validation: aux passed tests...")
                    if a == "channel_number":
                        self.channel_number_val=strdup(aux[a].encode())
                        new_aux[a] = aux[a]
                    elif a == "median_before":
                        self.median_before_val = <double>aux[a]
                        new_aux[a] = aux[a]
                    elif a == "read_number":
                        self.read_number_val = <int32_t>aux[a]
                        new_aux[a] = aux[a]
                    elif a == "start_mux":
                        self.start_mux_val = <uint8_t>aux[a]
                        new_aux[a] = aux[a]
                    elif a == "start_time":
                        self.start_time_val = <uint64_t>aux[a]
                        new_aux[a] = aux[a]
                    elif a == "end_reason":
                        continue
            self.logger.debug("_record_type_validation: doing aux stuff...")

        return user_record, new_aux


    def _multi_record_type_validation(self, user_record, aux=None):
        '''
        internal function to validate and convert aux types before pushing to C side
        returns None, None on error
        '''

        py_record_types = {"read_id": type("string"),
                           "read_group": type(1),
                           "digitisation": type(1.0),
                           "offset": type(1.0),
                           "range": type(1.0),
                           "sampling_rate": type(1.0),
                           "len_raw_signal": type(10),
                           "signal": type(np.array([1, 2, 3], np.int16))}

        py_aux_types = {"channel_number": type("string"),
                        "median_before": type(1.0),
                        "read_number": type(10),
                        "start_mux": type(1),
                        "start_time": type(100),
                        "end_reason": None}

        new_aux = {}

        for a in user_record:
            if user_record[a] is None:
                continue
            if a not in py_record_types:
                self.logger.error("_record_type_validation {}: {} user primary field not in pyslow5 record_types".format(a, user_record[a]))
                return None, None

            if type(user_record[a]) != py_record_types[a]:
                self.logger.error("_record_type_validation {}: {} user primary field type mismatch with pyslow5 record_types".format(a, user_record[a]))
                return None, None

        # check aux if given
        if aux is not None:
            self.logger.debug("_record_type_validation: doing aux stuff...")
            for a in aux:
                if a not in py_aux_types:
                    self.logger.error("_record_type_validation {}: {} user aux field not in pyslow5 aux_types".format(a, aux[a]))
                    return None, None
                if aux[a] is None:
                    continue
                if type(aux[a]) != py_aux_types[a]:
                    self.logger.error("_record_type_validation {}: {} user aux field type mismatch with pyslow5 aux_types".format(a, aux[a]))
                    return None, None
                else:
                    self.logger.debug("_record_type_validation: aux passed tests...")
                    if a == "channel_number":
                        new_aux[a] = aux[a]
                    elif a == "median_before":
                        new_aux[a] = aux[a]
                    elif a == "read_number":
                        new_aux[a] = aux[a]
                    elif a == "start_mux":
                        new_aux[a] = aux[a]
                    elif a == "start_time":
                        new_aux[a] = aux[a]
                    elif a == "end_reason":
                        continue

            self.logger.debug("_record_type_validation: aux stuff done")


        return user_record, new_aux


    def write_header(self, header, read_group=0):
        '''
        write slow5 header to file.
        takes header dic for attributes, then write once.
        Must write readgroup 0 before 1, 1 before 2, etc
        '''
        checked_header = self._header_type_validation(header)

        errors = False
        if not self.header_add_attr_state:
            if read_group > 0:
                self.logger.error("write_header: You must set read_group=0 first")
                self.logger.error("write_header: headers failed to initialise.")
                return -1
            for h in checked_header:
                ret = slow5_hdr_add_attr(h.encode(), self.s5.header)
                if ret < 0:
                    self.logger.error("write_header: slow5_hdr_add_attr {}: {} could not initialise to C s5.header struct".format(h, checked_header[h]))
                    errors = True
                else:
                    self.header_add_attr_state = True

        if read_group > 0 and self.header_add_attr_state:
            ret = slow5_hdr_add_rg(self.s5.header)
            if ret < 0:
                self.logger.error("write_header: slow5_hdr_add_rg failed for read_group: {}".format(read_group))
                errors = True

        if errors:
            self.logger.error("write_header: headers failed to initialise.")
            return -1

        for h in checked_header:
            ret = slow5_hdr_set(h.encode(), checked_header[h].encode(), read_group, self.s5.header)
            if ret < 0:
                self.logger.error("write_header: slow5_hdr_set {}: {} could not set to C s5.header struct".format(h, checked_header[h]))
                errors = True

        if not errors:
            return 0
        else:
            self.logger.error("write_header: errors encountered setting up header, aborting write")
            # sys.exit(1)
            return -1

    def write_record(self, record, aux=None):
        '''
        write a single record
        check self.header_state, if False, header needs to be written. Use aux types to do first check.
        if the validation works, then write the header just before the first record is written.
        This should make the user experience a lot less complicated and have less steps
        '''

        aux_types = {"channel_number": type("string"),
                     "median_before": type(1.0),
                     "read_number": type(10),
                     "start_mux": type(1),
                     "start_time": type(100),
                     "end_reason": None}

        self.logger.debug("write_record: _record_type_validation running")
        checked_record, checked_aux = self._record_type_validation(record, aux)
        self.logger.debug("write_record: _record_type_validation done")

        # check if in append state
        # if so, we can skip header setup
        if self.state == 2:
            self.header_state = True

        # if all checks are good, test self.header_state for 1 time write
        if not self.header_state:
            self.logger.debug("write_record: checking header stuff...")
            error = False
            if aux is not None:
                if checked_aux is not None:
                    slow5_aux_types = self._aux_header_type_validation(aux_types)
                    for a in slow5_aux_types:
                        if slow5_aux_types[a] is None:
                            continue
                        ret = slow5_aux_add(a.encode(), slow5_aux_types[a], self.s5.header)
                        if ret < 0:
                            self.logger.error("write_record: slow5_aux_add {}: {} could not set to C s5.header.aux_meta struct".format(a, checked_aux[a]))
                            error = True
                else:
                    error = True

            if error:
                self.logger.error("write_record: aux_meta fields failed to initialise")
                return -1
            # write the header
            self.logger.debug("write_record: writting header...")
            ret = slow5_hdr_write(self.s5)
            if ret < 0:
                self.logger.error("write_record: slow5_hdr_write could not write header")
                return -1
            # set state true so only done once
            self.header_state = True
            self.logger.debug("write_record: header written")

        # Add values to read struct
        self.logger.debug("write_record: slow5_rec_init()")
        self.write = slow5_rec_init()
        if self.write == NULL:
            self.logger.error("write_record: failed to allocate space for slow5 record (self.write)")
            return -1

        self.logger.debug("write_record: self.write assignments...")
        checked_record["read_id"] = checked_record["read_id"].encode()
        self.write.read_id = strdup(checked_record["read_id"])
        self.write.read_id_len = len(checked_record["read_id"])
        self.write.read_group = checked_record["read_group"]
        self.write.digitisation = checked_record["digitisation"]
        self.write.offset = checked_record["offset"]
        self.write.range = checked_record["range"]
        self.write.sampling_rate = checked_record["sampling_rate"]
        self.write.len_raw_signal = checked_record["len_raw_signal"]
        self.logger.debug("write_record: self.write.raw_signal malloc...")
        self.write.raw_signal = <int16_t *> malloc(sizeof(int16_t)*checked_record["len_raw_signal"])
        self.logger.debug("write_record: self.write.raw_signal malloc done")
        self.logger.debug("write_record: self.write assignments done")

        self.logger.debug("write_record: self.write processing raw_signal")
        start_write_copy_signal = time.time()
        # grabs buffer of numby array so the for loop operats in C not python = super fast
        memview = memoryview(checked_record["signal"])
        for i in range(checked_record["len_raw_signal"]):
            self.write.raw_signal[i] = memview[i]
        # for i in range(checked_record["len_raw_signal"]):
        #     self.write.raw_signal[i] = checked_record["signal"][i]
        end_write_copy_signal = (time.time() - start_write_copy_signal)
        self.total_single_write_time = self.total_single_write_time + end_write_copy_signal
        self.logger.debug("write_record: self.write raw_signal done")

        if aux:
            self.logger.debug("write_record: aux stuff...")
            if checked_aux is None:
                self.logger.error("write_record: checked_aux is None".format(a, checked_aux[a]))
                return -1

            for a in checked_aux:
                self.logger.debug("write_record: checked_aux: {}: {}".format(a, checked_aux[a]))
                if checked_aux[a] is None:
                    continue
                if a == "channel_number":
                    self.logger.debug("write_record: slow5_aux_set_string running...")
                    self.logger.debug("write_record: slow5_aux_set_string type: {}".format(type(checked_aux[a])))
                    ret = slow5_aux_set_string(self.write, self.channel_number, <const char *>self.channel_number_val, self.s5.header)
                    self.logger.debug("write_record: slow5_aux_set_string running done: ret = {}".format(ret))
                    if ret < 0:
                        self.logger.error("write_record: slow5_aux_set_string could not write aux value {}: {}".format(a, checked_aux[a]))
                        #### We should free here
                        return -1
                elif a == "median_before":
                    ret = slow5_aux_set(self.write, self.median_before, <const void *>&self.median_before_val, self.s5.header)
                elif a == "read_number":
                    ret = slow5_aux_set(self.write, self.read_number, <const void *>&self.read_number_val, self.s5.header)
                elif a == "start_mux":
                    ret = slow5_aux_set(self.write, self.start_mux, <const void *>&self.start_mux_val, self.s5.header)
                elif a == "start_time":
                    ret = slow5_aux_set(self.write, self.start_time, <const void *>&self.start_time_val, self.s5.header)
                elif a == "end_reason":
                    # not implemented yet becuase of variability in ONT versioning
                    ret = 0
                if ret < 0:
                    self.logger.error("write_record: slow5_aux_set could not write aux value {}: {}".format(a, checked_aux[a]))
                    return -1

            self.logger.debug("write_record: aux stuff done")


        self.logger.debug("write_record: slow5_write()")
        # write the record
        ret = slow5_write(self.write, self.s5)
        self.logger.debug("write_record: slow5_write() ret: {}".format(ret))

        if aux is not None:
            free(self.channel_number_val)
            self.channel_number_val = NULL
            self.median_before_val = -1.0
            self.read_number_val = -1
            self.start_mux_val = -1
            self.start_time_val = -1


        # free memory
        self.logger.debug("write_record: slow5_rec_free()")
        slow5_rec_free(self.write)
        self.write = NULL

        self.logger.debug("write_record: function complete, returning 0")
        return 0


    def write_record_batch(self, records, threads=4, batchsize=4096, aux=None):
        '''
        write a batch of records
        same as write_record, but in batches
        records = dic of read rics, where the key for each is the readID
        if aux, aux is also a dic of dics, whhere the key for each is teh readID
        records = {readID_0: {read_dic}, readID_1: {read_dic}}
        '''
        start_multi_write = time.time()
        aux_types = {"channel_number": type("string"),
                     "median_before": type(1.0),
                     "read_number": type(10),
                     "start_mux": type(1),
                     "start_time": type(100),
                     "end_reason": None}
        # check an empty dic wasn't given
        if aux is not None:
            if len(aux) == 0:
                aux = None
        self.logger.debug("write_record_batch: Setting up batching...")
        num_reads = len(records)
        read_list = list(records.keys())
        if num_reads > batchsize:
            batches = self._get_batches(read_list, size=batchsize)
        else:
            batches = self._get_batches(read_list, size=num_reads)


        self.logger.debug("write_record_batch: batch for loop start")
        for batch in chain(batches):
            batch_len = len(batch)
            self.twrite = <slow5_rec_t **> malloc(sizeof(slow5_rec_t*)*batch_len)
            self.logger.debug("write_record_batch: _record_type_validation running")
            checked_records = {}
            checked_auxs = {}
            self.channel_number_val_array = <char **> malloc(sizeof(char*)*batch_len)
            self.median_before_val_array = <double *> malloc(sizeof(double)*batch_len)
            self.read_number_val_array = <int32_t *> malloc(sizeof(int32_t)*batch_len)
            self.start_mux_val_array = <uint8_t *> malloc(sizeof(uint8_t)*batch_len)
            self.start_time_val_array = <uint64_t *> malloc(sizeof(uint64_t)*batch_len)
            for i, idx in enumerate(batch):
                if aux is not None:
                    checked_record, checked_aux = self._multi_record_type_validation(records[idx], aux[idx])
                    checked_records[idx] = checked_record
                    for a in checked_aux:
                        if a == "channel_number":
                            self.channel_number_val_array[i] = strdup(checked_aux[a].encode())
                        elif a == "median_before":
                            self.median_before_val_array[i] = <double>checked_aux[a]
                        elif a == "read_number":
                            self.read_number_val_array[i] = <int32_t>checked_aux[a]
                        elif a == "start_mux":
                            self.start_mux_val_array[i] = <uint8_t>checked_aux[a]
                        elif a == "start_time":
                            self.start_time_val_array[i] = <uint64_t>checked_aux[a]
                    checked_auxs[idx] = checked_aux
                else:
                    checked_record, checked_aux = self._record_type_validation(records[idx], aux)
                    checked_records[idx] = checked_record
            self.logger.debug("write_record_batch: _record_type_validation done")
            if len(checked_aux) == 0:
                checked_aux = None
            for idx in range(batch_len):

                # check if in append state
                # if so, we can skip header setup
                if self.state == 2:
                    self.header_state = True

                # if all checks are good, test self.header_state for 1 time write
                if not self.header_state:
                    self.logger.debug("write_record_batch: checking header stuff...")
                    error = False
                    if aux is not None:
                        if checked_aux is not None:
                            slow5_aux_types = self._aux_header_type_validation(aux_types)
                            for a in slow5_aux_types:
                                if slow5_aux_types[a] is None:
                                    continue
                                ret = slow5_aux_add(a.encode(), slow5_aux_types[a], self.s5.header)
                                if ret < 0:
                                    self.logger.error("write_record_batch: slow5_aux_add {}: {} could not set to C s5.header.aux_meta struct".format(a, checked_aux[a]))
                                    error = True
                        else:
                            error = True

                    if error:
                        self.logger.error("write_record_batch: aux_meta fields failed to initialise")
                        return -1
                    # write the header
                    self.logger.debug("write_record_batch: writting header...")
                    ret = slow5_hdr_write(self.s5)
                    if ret < 0:
                        self.logger.error("write_record_batch: slow5_hdr_write could not write header")
                        return -1
                    # set state true so only done once
                    self.header_state = True
                    self.logger.debug("write_record_batch: header written")

                # Add values to read struct
                self.logger.debug("write_record_batch: slow5_rec_init()")

                self.twrite[idx] = slow5_rec_init()
                if self.twrite[idx] == NULL:
                    self.logger.error("write_record_batch: failed to allocate space for slow5 record (self.twrite[idx])")
                    return -1

                self.logger.debug("write_record_batch: self.write assignments...")
                checked_records[batch[idx]]["read_id"] = checked_records[batch[idx]]["read_id"].encode()
                self.twrite[idx].read_id = strdup(checked_records[batch[idx]]["read_id"])
                self.twrite[idx].read_id_len = len(checked_records[batch[idx]]["read_id"])
                self.twrite[idx].read_group = checked_records[batch[idx]]["read_group"]
                self.twrite[idx].digitisation = checked_records[batch[idx]]["digitisation"]
                self.twrite[idx].offset = checked_records[batch[idx]]["offset"]
                self.twrite[idx].range = checked_records[batch[idx]]["range"]
                self.twrite[idx].sampling_rate = checked_records[batch[idx]]["sampling_rate"]
                self.twrite[idx].len_raw_signal = checked_records[batch[idx]]["len_raw_signal"]
                self.logger.debug("write_record_batch: self.write.raw_signal malloc...")
                self.twrite[idx].raw_signal = <int16_t *> malloc(sizeof(int16_t)*checked_records[batch[idx]]["len_raw_signal"])
                self.logger.debug("write_record_batch: self.write.raw_signal malloc done")
                self.logger.debug("write_record_batch: self.write assignments done")

                self.logger.debug("write_record_batch: self.write processing raw_signal")
                start_write_copy_signal = time.time()
                # grabs buffer of numby array so the for loop operats in C not python = super fast
                memview = memoryview(checked_records[batch[idx]]["signal"])
                for i in range(checked_records[batch[idx]]["len_raw_signal"]):
                    self.twrite[idx].raw_signal[i] = memview[i]
                # for i in range(checked_records[batch[idx]]["len_raw_signal"]):
                #     self.twrite[idx].raw_signal[i] = checked_records[batch[idx]]["signal"][i]
                end_write_copy_signal = (time.time() - start_write_copy_signal)
                self.total_multi_write_signal_time = self.total_multi_write_signal_time + end_write_copy_signal

                self.logger.debug("write_record_batch: self.write raw_signal done")

                if aux is not None:
                    self.logger.debug("write_record_batch: aux stuff...")
                    if checked_auxs[batch[idx]] is None:
                        self.logger.error("write_record_batch: checked_aux is None".format(a, checked_auxs[batch[idx]][a]))
                        return -1

                    for a in checked_auxs[batch[idx]]:
                        self.logger.debug("write_record_batch: checked_aux: {}: {}".format(a, checked_auxs[batch[idx]][a]))
                        if checked_auxs[batch[idx]][a] is None:
                            continue
                        if a == "channel_number":
                            self.logger.debug("write_record_batch: slow5_aux_set_string running...")
                            self.logger.debug("write_record_batch: slow5_aux_set_string type: {}".format(type(checked_auxs[batch[idx]][a])))
                            ret = slow5_aux_set_string(self.twrite[idx], self.channel_number, <const char *>self.channel_number_val_array[idx], self.s5.header)
                            self.logger.debug("write_record_batch: slow5_aux_set_string running done: ret = {}".format(ret))
                            if ret < 0:
                                self.logger.error("write_record_batch: slow5_aux_set_string could not write aux value {}: {}".format(a, checked_auxs[batch[idx]][a]))
                                #### We should free here
                                return -1
                        elif a == "median_before":
                            ret = slow5_aux_set(self.twrite[idx], self.median_before, <const void *>&self.median_before_val_array[idx], self.s5.header)
                        elif a == "read_number":
                            ret = slow5_aux_set(self.twrite[idx], self.read_number, <const void *>&self.read_number_val_array[idx], self.s5.header)
                        elif a == "start_mux":
                            ret = slow5_aux_set(self.twrite[idx], self.start_mux, <const void *>&self.start_mux_val_array[idx], self.s5.header)
                        elif a == "start_time":
                            ret = slow5_aux_set(self.twrite[idx], self.start_time, <const void *>&self.start_time_val_array[idx], self.s5.header)
                        elif a == "end_reason":
                            # not implemented yet becuase of variability in ONT versioning
                            ret = 0
                        if ret < 0:
                            self.logger.error("write_record_batch: slow5_aux_set could not write aux value {}: {}".format(a, checked_aux[a]))
                            return -1

                    self.logger.debug("write_record_batch: aux stuff done")

            self.logger.debug("write_record_batch: slow5_write_batch()")

            # write the record
            if batch_len <= 0:
                self.logger.debug("write_record_batch: batch_len 0 or less")
                break

            ret = slow5_write_batch(self.twrite, self.s5, batch_len, threads)
            if ret < batch_len:
                self.logger.error("write_record_batch: write failed")
                return -1

            self.logger.debug("write_record_batch: free()")
            for i in range(batch_len):
                slow5_rec_free(self.twrite[i])
            free(self.twrite)


            self.logger.debug("write_record_batch: free() aux")
            if aux is not None:
                for i in range(batch_len):
                    free(self.channel_number_val_array[i])

                free(self.channel_number_val_array)
                free(self.median_before_val_array)
                free(self.read_number_val_array)
                free(self.start_mux_val_array)
                free(self.start_time_val_array)

        end_multi_write = time.time() - start_multi_write
        self.total_multi_write_time = self.total_multi_write_time + end_multi_write
        # free memory
        # self.twrite = NULL
        self.logger.debug("write_record_batch: function complete, returning 0")
        return 0

    def close(self):
        '''
        close file so EOF is written
        '''
        if self.state in [1,2]:
            if not self.close_state:
                if self.s5 is not NULL:
                    slow5_close(self.s5)
                    self.close_state = True
                    self.logger.debug("{} closed".format(self.path))
            else:
                self.logger.warning("{} already closed".format(self.path))
        elif self.state == 0:
            if not self.close_state:
                if self.s5 is not NULL:
                    slow5_close(self.s5)
                    self.close_state = True
                    self.logger.debug("{} closed".format(self.path))
            else:
                self.logger.warning("{} already closed".format(self.path))
        else:
            self.logger.error("{} not open for writing, remake class object to refresh".format(self.path))
        return