From 353645afac2eb92d4a511a13a2d4ddf765ffc9b9 Mon Sep 17 00:00:00 2001 From: Chad Trabant Date: Sun, 23 Jul 2023 14:46:48 -0700 Subject: [PATCH] Update to libmseed v3 (#3) --- ChangeLog | 12 +- LICENSE | 875 +- Makefile | 30 +- README.md | 18 +- doc/msi.1 | 121 +- doc/msi.md | 58 +- libmseed/.gitignore | 2 + libmseed/ChangeLog | 350 +- libmseed/INSTALL.md | 42 +- libmseed/LICENSE | 201 + libmseed/LICENSE.txt | 847 -- libmseed/Makefile | 96 +- libmseed/Makefile.wat | 71 - libmseed/Makefile.win | 56 +- libmseed/README.byteorder | 70 +- libmseed/README.md | 68 +- libmseed/crc32c.c | 410 + libmseed/doc/Doxyfile | 2739 +++++ libmseed/doc/DoxygenLayout.xml | 196 + libmseed/doc/build-push-docs.sh | 100 + libmseed/doc/capabilities.dox | 78 + libmseed/doc/customdoxygen.css | 20 + libmseed/doc/examples.dox | 96 + libmseed/doc/faq.dox | 110 + libmseed/doc/footer.html | 8 + libmseed/doc/libmseed-UsersGuide | 460 - libmseed/doc/mainpage.dox | 73 + libmseed/doc/ms_addselect.3 | 1 - libmseed/doc/ms_addselect_comp.3 | 1 - libmseed/doc/ms_bigendianhost.3 | 30 - libmseed/doc/ms_blktdesc.3 | 1 - libmseed/doc/ms_blktlen.3 | 1 - libmseed/doc/ms_btime2isotimestr.3 | 1 - libmseed/doc/ms_btime2mdtimestr.3 | 1 - libmseed/doc/ms_btime2seedtimestr.3 | 1 - libmseed/doc/ms_btime3hptime.3 | 1 - libmseed/doc/ms_detect.3 | 1 - libmseed/doc/ms_doy2md.3 | 41 - libmseed/doc/ms_encodingstr.3 | 1 - libmseed/doc/ms_errorstr.3 | 1 - libmseed/doc/ms_find_reclen.3 | 52 - libmseed/doc/ms_freeselections.3 | 1 - libmseed/doc/ms_genfactmult.3 | 54 - libmseed/doc/ms_gswap.3 | 38 - libmseed/doc/ms_gswap2.3 | 1 - libmseed/doc/ms_gswap2a.3 | 1 - libmseed/doc/ms_gswap3.3 | 1 - libmseed/doc/ms_gswap4.3 | 1 - libmseed/doc/ms_gswap4a.3 | 1 - libmseed/doc/ms_gswap8.3 | 1 - libmseed/doc/ms_gswap8a.3 | 1 - libmseed/doc/ms_hptime2btime.3 | 1 - libmseed/doc/ms_hptime2isotimestr.3 | 1 - libmseed/doc/ms_hptime2mdtimestr.3 | 1 - libmseed/doc/ms_hptime2seedtimestr.3 | 1 - libmseed/doc/ms_intro.3 | 566 - libmseed/doc/ms_log.3 | 125 - libmseed/doc/ms_log_l.3 | 1 - libmseed/doc/ms_loginit.3 | 1 - libmseed/doc/ms_loginit_l.3 | 1 - libmseed/doc/ms_lookup.3 | 82 - libmseed/doc/ms_matchselect.3 | 1 - libmseed/doc/ms_md2doy.3 | 1 - libmseed/doc/ms_parse_raw.3 | 46 - libmseed/doc/ms_printselections.3 | 1 - libmseed/doc/ms_ratapprox.3 | 1 - libmseed/doc/ms_readleapsecondfile.3 | 1 - libmseed/doc/ms_readleapseconds.3 | 48 - libmseed/doc/ms_readmsr.3 | 226 - libmseed/doc/ms_readmsr_r.3 | 1 - libmseed/doc/ms_readselectionsfile.3 | 1 - libmseed/doc/ms_readtracelist.3 | 1 - libmseed/doc/ms_readtracelist_selection.3 | 1 - libmseed/doc/ms_readtracelist_timewin.3 | 1 - libmseed/doc/ms_readtraces.3 | 1 - libmseed/doc/ms_readtraces_selection.3 | 1 - libmseed/doc/ms_readtraces_timewin.3 | 1 - libmseed/doc/ms_recsrcname.3 | 1 - libmseed/doc/ms_samplesize.3 | 1 - libmseed/doc/ms_seedtimestr2hptime.3 | 1 - libmseed/doc/ms_selection.3 | 196 - libmseed/doc/ms_splitsrcname.3 | 86 - libmseed/doc/ms_srcname.3 | 56 - libmseed/doc/ms_strncpclean.3 | 40 - libmseed/doc/ms_strncpopen.3 | 1 - libmseed/doc/ms_time.3 | 202 - libmseed/doc/ms_time2hptime.3 | 1 - libmseed/doc/ms_timestr2hptime.3 | 1 - libmseed/doc/ms_writemseed.3 | 99 - libmseed/doc/msr_addblockette.3 | 46 - libmseed/doc/msr_duplicate.3 | 30 - libmseed/doc/msr_endtime.3 | 1 - libmseed/doc/msr_free.3 | 1 - libmseed/doc/msr_free_blktchain.3 | 1 - libmseed/doc/msr_host_latency.3 | 35 - libmseed/doc/msr_init.3 | 43 - libmseed/doc/msr_nomsamprate.3 | 1 - libmseed/doc/msr_normalize_header.3 | 41 - libmseed/doc/msr_pack.3 | 195 - libmseed/doc/msr_pack_header.3 | 1 - libmseed/doc/msr_parse.3 | 128 - libmseed/doc/msr_parse_selection.3 | 1 - libmseed/doc/msr_print.3 | 34 - libmseed/doc/msr_samprate.3 | 45 - libmseed/doc/msr_srcname.3 | 1 - libmseed/doc/msr_starttime.3 | 59 - libmseed/doc/msr_starttime_uc.3 | 1 - libmseed/doc/msr_unpack.3 | 131 - libmseed/doc/msr_writemseed.3 | 1 - libmseed/doc/mst_addmsr.3 | 73 - libmseed/doc/mst_addmsrtogroup.3 | 1 - libmseed/doc/mst_addspan.3 | 1 - libmseed/doc/mst_addtracetogroup.3 | 1 - libmseed/doc/mst_convertsamples.3 | 48 - libmseed/doc/mst_findadjacent.3 | 1 - libmseed/doc/mst_findmatch.3 | 69 - libmseed/doc/mst_free.3 | 1 - libmseed/doc/mst_freegroup.3 | 1 - libmseed/doc/mst_groupheal.3 | 1 - libmseed/doc/mst_groupsort.3 | 50 - libmseed/doc/mst_init.3 | 51 - libmseed/doc/mst_initgroup.3 | 1 - libmseed/doc/mst_pack.3 | 171 - libmseed/doc/mst_packgroup.3 | 1 - libmseed/doc/mst_printgaplist.3 | 1 - libmseed/doc/mst_printsynclist.3 | 1 - libmseed/doc/mst_printtracelist.3 | 79 - libmseed/doc/mst_srcname.3 | 1 - libmseed/doc/mst_writemseed.3 | 1 - libmseed/doc/mst_writemseedgroup.3 | 1 - libmseed/doc/mstl_addmsr.3 | 49 - libmseed/doc/mstl_convertsamples.3 | 1 - libmseed/doc/mstl_free.3 | 1 - libmseed/doc/mstl_init.3 | 36 - libmseed/doc/mstl_printgaplist.3 | 1 - libmseed/doc/mstl_printsynclist.3 | 1 - libmseed/doc/mstl_printtracelist.3 | 79 - libmseed/doc/porting.dox | 179 + libmseed/doc/tutorial.dox | 191 + libmseed/example/Makefile | 38 +- libmseed/example/Makefile.wat | 37 - libmseed/example/Makefile.win | 29 +- libmseed/example/README | 18 +- libmseed/example/lm_pack.c | 353 + libmseed/example/lm_pack_rollingbuffer.c | 147 + libmseed/example/lm_pararead.c | 188 + .../lmtestparse.c => example/lm_parse.c} | 126 +- libmseed/example/lm_read_buffer.c | 107 + libmseed/example/lm_read_recordlist.c | 204 + libmseed/example/lm_read_selection.c | 117 + libmseed/example/lm_sids.c | 87 + libmseed/example/lm_timestr.c | 118 + libmseed/example/{msview.c => mseedview.c} | 115 +- libmseed/example/msrepack.c | 622 -- libmseed/example/test.mseed | Bin 18432 -> 0 bytes libmseed/extraheaders.c | 1157 +++ libmseed/extraheaders.h | 50 + libmseed/fileutils.c | 1438 ++- libmseed/genutils.c | 2501 ++--- libmseed/gmtime64.c | 185 + libmseed/gmtime64.h | 22 + libmseed/gswap.c | 142 - libmseed/libmseed.def | 185 +- libmseed/libmseed.h | 2073 ++-- libmseed/libmseed.map | 16 +- libmseed/lmplatform.c | 51 - libmseed/lmplatform.h | 166 - libmseed/logging.c | 625 +- libmseed/lookup.c | 303 +- libmseed/matlab/Makefile | 19 - libmseed/matlab/README | 17 - libmseed/matlab/mexMsReadTraces.c | 154 - libmseed/matlab/mexMsReadTracesNative.c | 157 - libmseed/mseed.pc.in | 15 +- libmseed/mseedformat.h | 658 ++ libmseed/msio.c | 830 ++ libmseed/msio.h | 44 + libmseed/msrutils.c | 1287 +-- libmseed/pack.c | 2321 +++-- libmseed/packdata.c | 198 +- libmseed/packdata.h | 31 +- libmseed/parseutils.c | 1290 +-- libmseed/selection.c | 685 +- libmseed/steimdata.h | 51 - libmseed/test/Makefile | 53 +- libmseed/test/Makefile.win | 22 + libmseed/test/README | 13 - libmseed/test/data/Float32-encoded.mseed | Bin 4096 -> 0 bytes libmseed/test/data/Float64-encoded.mseed | Bin 4096 -> 0 bytes libmseed/test/data/Int16-encoded.mseed | Bin 4096 -> 0 bytes libmseed/test/data/Int32-1024byte.mseed | Bin 1024 -> 0 bytes libmseed/test/data/Int32-128byte.mseed | Bin 128 -> 0 bytes libmseed/test/data/Int32-2048byte.mseed | Bin 2048 -> 0 bytes libmseed/test/data/Int32-256byte.mseed | Bin 256 -> 0 bytes libmseed/test/data/Int32-4096byte.mseed | Bin 4096 -> 0 bytes libmseed/test/data/Int32-512byte.mseed | Bin 512 -> 0 bytes libmseed/test/data/Int32-8192byte.mseed | Bin 8192 -> 0 bytes .../test/data/Steim1-AllDifferences-BE.mseed | Bin 4096 -> 0 bytes .../test/data/Steim1-AllDifferences-LE.mseed | Bin 4096 -> 0 bytes .../test/data/Steim2-AllDifferences-BE.mseed | Bin 4096 -> 0 bytes .../test/data/Steim2-AllDifferences-LE.mseed | Bin 4096 -> 0 bytes .../data/corrupt-blockettes-wrongnext.mseed | Bin 512 -> 0 bytes .../test/data/invalid-blockette-offset.mseed | Bin 18459 -> 0 bytes .../data/reference-testdata-float32.mseed2 | Bin 0 -> 2560 bytes .../data/reference-testdata-float32.mseed3 | Bin 0 -> 2295 bytes .../data/reference-testdata-float64.mseed2 | Bin 0 -> 4608 bytes .../data/reference-testdata-float64.mseed3 | Bin 0 -> 4531 bytes .../test/data/reference-testdata-int16.mseed2 | Bin 0 -> 512 bytes .../test/data/reference-testdata-int16.mseed3 | Bin 0 -> 499 bytes .../test/data/reference-testdata-int32.mseed2 | Bin 0 -> 2560 bytes .../test/data/reference-testdata-int32.mseed3 | Bin 0 -> 2295 bytes .../data/reference-testdata-steim1-LE.mseed2 | Bin 0 -> 2049 bytes .../data/reference-testdata-steim1.mseed2 | Bin 0 -> 2048 bytes .../data/reference-testdata-steim1.mseed3 | Bin 0 -> 1836 bytes .../data/reference-testdata-steim2-LE.mseed2 | Bin 0 -> 2049 bytes .../data/reference-testdata-steim2.mseed2 | Bin 0 -> 2048 bytes .../data/reference-testdata-steim2.mseed3 | Bin 0 -> 1836 bytes .../test/data/reference-testdata-text.mseed2 | Bin 0 -> 512 bytes .../test/data/reference-testdata-text.mseed3 | Bin 0 -> 294 bytes .../test/data/testdata-3channel-signal.mseed2 | Bin 0 -> 54784 bytes .../test/data/testdata-3channel-signal.mseed3 | Bin 0 -> 56906 bytes ...mseed => testdata-detection.record.mseed2} | Bin ...ed.mseed => testdata-encoding-CDSN.mseed2} | Bin ....mseed => testdata-encoding-DWWSSN.mseed2} | Bin ...coding-GEOSCOPE-16bit-3exp-encoded.mseed2} | Bin ...ded.mseed => testdata-encoding-SRO.mseed2} | Bin .../testdata-invalid-blockette-offsets.mseed2 | Bin 0 -> 1536 bytes ...> testdata-no-blockette1000-steim1.mseed2} | Bin ...-oneseries-mixedlengths-mixedorder.mseed2} | Bin ...a-oneseries-mixedlengths-mixedorder.mseed3 | Bin 0 -> 16452 bytes ... testdata-unapplied-timecorrection.mseed2} | Bin libmseed/test/data/text-encoded.mseed | Bin 4096 -> 0 bytes libmseed/test/lm_pack.c | 1 + libmseed/test/lm_pack_rollingbuffer.c | 1 + libmseed/test/lm_parse.c | 1 + libmseed/test/lm_read_buffer.c | 1 + libmseed/test/lm_read_recordlist.c | 1 + libmseed/test/lm_read_selection.c | 1 + libmseed/test/lm_sids.c | 1 + libmseed/test/lm_timestr.c | 1 + libmseed/test/lmtestpack.c | 292 - libmseed/test/pack-Float32-encoded.test | 4 - libmseed/test/pack-Float32-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-Float64-encoded.test | 4 - libmseed/test/pack-Float64-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-Int16-encoded.test | 4 - libmseed/test/pack-Int16-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-Int32-encoded.test | 4 - libmseed/test/pack-Int32-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-Steim1-encoded.test | 4 - libmseed/test/pack-Steim1-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-Steim2-encoded.test | 4 - libmseed/test/pack-Steim2-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/pack-text-encoded.test | 4 - libmseed/test/pack-text-encoded.test.ref | Bin 4096 -> 0 bytes libmseed/test/read-CDSN-encoded.test | 4 - libmseed/test/read-CDSN-encoded.test.ref | 338 - libmseed/test/read-DWWSSN-encoded.test | 4 - libmseed/test/read-DWWSSN-encoded.test.ref | 338 - libmseed/test/read-Float32-encoded.test | 4 - libmseed/test/read-Float32-encoded.test.ref | 170 - libmseed/test/read-Float64-encoded.test | 4 - libmseed/test/read-Float64-encoded.test.ref | 86 - libmseed/test/read-GEOSCOPE163-encoded.test | 4 - .../test/read-GEOSCOPE163-encoded.test.ref | 338 - libmseed/test/read-Int16-encoded.test | 4 - libmseed/test/read-Int16-encoded.test.ref | 338 - .../test/read-Int32-1024byte-encoded.test | 4 - .../test/read-Int32-1024byte-encoded.test.ref | 42 - libmseed/test/read-Int32-128byte-encoded.test | 4 - .../test/read-Int32-128byte-encoded.test.ref | 4 - .../test/read-Int32-2048byte-encoded.test | 4 - .../test/read-Int32-2048byte-encoded.test.ref | 84 - libmseed/test/read-Int32-256byte-encoded.test | 4 - .../test/read-Int32-256byte-encoded.test.ref | 10 - .../test/read-Int32-4096byte-encoded.test | 4 - .../test/read-Int32-4096byte-encoded.test.ref | 170 - libmseed/test/read-Int32-512byte-encoded.test | 4 - .../test/read-Int32-512byte-encoded.test.ref | 20 - .../test/read-Int32-8192byte-encoded.test | 4 - .../test/read-Int32-8192byte-encoded.test.ref | 340 - libmseed/test/read-SRO-encoded.test | 4 - libmseed/test/read-SRO-encoded.test.ref | 332 - libmseed/test/read-Steim1-bigendian.test | 4 - libmseed/test/read-Steim1-bigendian.test.ref | 105 - libmseed/test/read-Steim1-littleendian.test | 4 - .../test/read-Steim1-littleendian.test.ref | 105 - libmseed/test/read-Steim2-bigendian.test | 4 - libmseed/test/read-Steim2-bigendian.test.ref | 518 - libmseed/test/read-Steim2-littleendian.test | 4 - .../test/read-Steim2-littleendian.test.ref | 518 - libmseed/test/read-detection-record.test | 4 - libmseed/test/read-detection-record.test.ref | 31 - .../test/read-invalid-blockette-offset.test | 4 - .../read-invalid-blockette-offset.test.ref | 3 - .../read-mixed-order-mixed-length-trace.test | 4 - ...ad-mixed-order-mixed-length-trace.test.ref | 3 - libmseed/test/read-no-blockette1000.test | 4 - libmseed/test/read-no-blockette1000.test.ref | 26 - libmseed/test/read-text-encoded.test | 4 - libmseed/test/read-text-encoded.test.ref | 131 - .../test/read-unapplied-timecorrection.test | 4 - .../read-unapplied-timecorrection.test.ref | 23 - libmseed/test/tau/compilers.h | 183 + libmseed/test/tau/misc.h | 81 + libmseed/test/tau/tau.h | 1298 +++ libmseed/test/tau/types.h | 155 + libmseed/test/test-crc.c | 160 + libmseed/test/test-extraheaders.c | 234 + libmseed/test/test-read.c | 473 + libmseed/test/test-runner.c | 144 + libmseed/test/test-selection.c | 70 + libmseed/test/test-sid.c | 75 + libmseed/test/test-time.c | 114 + libmseed/test/test-tracelist.c | 184 + libmseed/test/test-write.c | 251 + libmseed/test/testdata.h | 105 + libmseed/tracelist.c | 2194 +++- libmseed/traceutils.c | 1854 ---- libmseed/unpack.c | 1926 ++-- libmseed/unpack.h | 44 + libmseed/unpackdata.c | 445 +- libmseed/unpackdata.h | 64 +- libmseed/yyjson.c | 9201 +++++++++++++++++ libmseed/yyjson.h | 7690 ++++++++++++++ src/Makefile | 48 +- src/msi.c | 1638 +-- 327 files changed, 41454 insertions(+), 21867 deletions(-) create mode 100644 libmseed/.gitignore create mode 100644 libmseed/LICENSE delete mode 100644 libmseed/LICENSE.txt delete mode 100644 libmseed/Makefile.wat create mode 100644 libmseed/crc32c.c create mode 100644 libmseed/doc/Doxyfile create mode 100644 libmseed/doc/DoxygenLayout.xml create mode 100755 libmseed/doc/build-push-docs.sh create mode 100644 libmseed/doc/capabilities.dox create mode 100644 libmseed/doc/customdoxygen.css create mode 100644 libmseed/doc/examples.dox create mode 100644 libmseed/doc/faq.dox create mode 100644 libmseed/doc/footer.html delete mode 100644 libmseed/doc/libmseed-UsersGuide create mode 100644 libmseed/doc/mainpage.dox delete mode 120000 libmseed/doc/ms_addselect.3 delete mode 120000 libmseed/doc/ms_addselect_comp.3 delete mode 100644 libmseed/doc/ms_bigendianhost.3 delete mode 120000 libmseed/doc/ms_blktdesc.3 delete mode 120000 libmseed/doc/ms_blktlen.3 delete mode 120000 libmseed/doc/ms_btime2isotimestr.3 delete mode 120000 libmseed/doc/ms_btime2mdtimestr.3 delete mode 120000 libmseed/doc/ms_btime2seedtimestr.3 delete mode 120000 libmseed/doc/ms_btime3hptime.3 delete mode 120000 libmseed/doc/ms_detect.3 delete mode 100644 libmseed/doc/ms_doy2md.3 delete mode 120000 libmseed/doc/ms_encodingstr.3 delete mode 120000 libmseed/doc/ms_errorstr.3 delete mode 100644 libmseed/doc/ms_find_reclen.3 delete mode 120000 libmseed/doc/ms_freeselections.3 delete mode 100644 libmseed/doc/ms_genfactmult.3 delete mode 100644 libmseed/doc/ms_gswap.3 delete mode 120000 libmseed/doc/ms_gswap2.3 delete mode 120000 libmseed/doc/ms_gswap2a.3 delete mode 120000 libmseed/doc/ms_gswap3.3 delete mode 120000 libmseed/doc/ms_gswap4.3 delete mode 120000 libmseed/doc/ms_gswap4a.3 delete mode 120000 libmseed/doc/ms_gswap8.3 delete mode 120000 libmseed/doc/ms_gswap8a.3 delete mode 120000 libmseed/doc/ms_hptime2btime.3 delete mode 120000 libmseed/doc/ms_hptime2isotimestr.3 delete mode 120000 libmseed/doc/ms_hptime2mdtimestr.3 delete mode 120000 libmseed/doc/ms_hptime2seedtimestr.3 delete mode 100644 libmseed/doc/ms_intro.3 delete mode 100644 libmseed/doc/ms_log.3 delete mode 120000 libmseed/doc/ms_log_l.3 delete mode 120000 libmseed/doc/ms_loginit.3 delete mode 120000 libmseed/doc/ms_loginit_l.3 delete mode 100644 libmseed/doc/ms_lookup.3 delete mode 120000 libmseed/doc/ms_matchselect.3 delete mode 120000 libmseed/doc/ms_md2doy.3 delete mode 100644 libmseed/doc/ms_parse_raw.3 delete mode 120000 libmseed/doc/ms_printselections.3 delete mode 120000 libmseed/doc/ms_ratapprox.3 delete mode 120000 libmseed/doc/ms_readleapsecondfile.3 delete mode 100644 libmseed/doc/ms_readleapseconds.3 delete mode 100644 libmseed/doc/ms_readmsr.3 delete mode 120000 libmseed/doc/ms_readmsr_r.3 delete mode 120000 libmseed/doc/ms_readselectionsfile.3 delete mode 120000 libmseed/doc/ms_readtracelist.3 delete mode 120000 libmseed/doc/ms_readtracelist_selection.3 delete mode 120000 libmseed/doc/ms_readtracelist_timewin.3 delete mode 120000 libmseed/doc/ms_readtraces.3 delete mode 120000 libmseed/doc/ms_readtraces_selection.3 delete mode 120000 libmseed/doc/ms_readtraces_timewin.3 delete mode 120000 libmseed/doc/ms_recsrcname.3 delete mode 120000 libmseed/doc/ms_samplesize.3 delete mode 120000 libmseed/doc/ms_seedtimestr2hptime.3 delete mode 100644 libmseed/doc/ms_selection.3 delete mode 100644 libmseed/doc/ms_splitsrcname.3 delete mode 100644 libmseed/doc/ms_srcname.3 delete mode 100644 libmseed/doc/ms_strncpclean.3 delete mode 120000 libmseed/doc/ms_strncpopen.3 delete mode 100644 libmseed/doc/ms_time.3 delete mode 120000 libmseed/doc/ms_time2hptime.3 delete mode 120000 libmseed/doc/ms_timestr2hptime.3 delete mode 100644 libmseed/doc/ms_writemseed.3 delete mode 100644 libmseed/doc/msr_addblockette.3 delete mode 100644 libmseed/doc/msr_duplicate.3 delete mode 120000 libmseed/doc/msr_endtime.3 delete mode 120000 libmseed/doc/msr_free.3 delete mode 120000 libmseed/doc/msr_free_blktchain.3 delete mode 100644 libmseed/doc/msr_host_latency.3 delete mode 100644 libmseed/doc/msr_init.3 delete mode 120000 libmseed/doc/msr_nomsamprate.3 delete mode 100644 libmseed/doc/msr_normalize_header.3 delete mode 100644 libmseed/doc/msr_pack.3 delete mode 120000 libmseed/doc/msr_pack_header.3 delete mode 100644 libmseed/doc/msr_parse.3 delete mode 120000 libmseed/doc/msr_parse_selection.3 delete mode 100644 libmseed/doc/msr_print.3 delete mode 100644 libmseed/doc/msr_samprate.3 delete mode 120000 libmseed/doc/msr_srcname.3 delete mode 100644 libmseed/doc/msr_starttime.3 delete mode 120000 libmseed/doc/msr_starttime_uc.3 delete mode 100644 libmseed/doc/msr_unpack.3 delete mode 120000 libmseed/doc/msr_writemseed.3 delete mode 100644 libmseed/doc/mst_addmsr.3 delete mode 120000 libmseed/doc/mst_addmsrtogroup.3 delete mode 120000 libmseed/doc/mst_addspan.3 delete mode 120000 libmseed/doc/mst_addtracetogroup.3 delete mode 100644 libmseed/doc/mst_convertsamples.3 delete mode 120000 libmseed/doc/mst_findadjacent.3 delete mode 100644 libmseed/doc/mst_findmatch.3 delete mode 120000 libmseed/doc/mst_free.3 delete mode 120000 libmseed/doc/mst_freegroup.3 delete mode 120000 libmseed/doc/mst_groupheal.3 delete mode 100644 libmseed/doc/mst_groupsort.3 delete mode 100644 libmseed/doc/mst_init.3 delete mode 120000 libmseed/doc/mst_initgroup.3 delete mode 100644 libmseed/doc/mst_pack.3 delete mode 120000 libmseed/doc/mst_packgroup.3 delete mode 120000 libmseed/doc/mst_printgaplist.3 delete mode 120000 libmseed/doc/mst_printsynclist.3 delete mode 100644 libmseed/doc/mst_printtracelist.3 delete mode 120000 libmseed/doc/mst_srcname.3 delete mode 120000 libmseed/doc/mst_writemseed.3 delete mode 120000 libmseed/doc/mst_writemseedgroup.3 delete mode 100644 libmseed/doc/mstl_addmsr.3 delete mode 120000 libmseed/doc/mstl_convertsamples.3 delete mode 120000 libmseed/doc/mstl_free.3 delete mode 100644 libmseed/doc/mstl_init.3 delete mode 120000 libmseed/doc/mstl_printgaplist.3 delete mode 120000 libmseed/doc/mstl_printsynclist.3 delete mode 100644 libmseed/doc/mstl_printtracelist.3 create mode 100644 libmseed/doc/porting.dox create mode 100644 libmseed/doc/tutorial.dox delete mode 100644 libmseed/example/Makefile.wat create mode 100644 libmseed/example/lm_pack.c create mode 100644 libmseed/example/lm_pack_rollingbuffer.c create mode 100644 libmseed/example/lm_pararead.c rename libmseed/{test/lmtestparse.c => example/lm_parse.c} (69%) create mode 100644 libmseed/example/lm_read_buffer.c create mode 100644 libmseed/example/lm_read_recordlist.c create mode 100644 libmseed/example/lm_read_selection.c create mode 100644 libmseed/example/lm_sids.c create mode 100644 libmseed/example/lm_timestr.c rename libmseed/example/{msview.c => mseedview.c} (68%) delete mode 100644 libmseed/example/msrepack.c delete mode 100644 libmseed/example/test.mseed create mode 100644 libmseed/extraheaders.c create mode 100644 libmseed/extraheaders.h create mode 100644 libmseed/gmtime64.c create mode 100644 libmseed/gmtime64.h delete mode 100644 libmseed/gswap.c delete mode 100644 libmseed/lmplatform.c delete mode 100644 libmseed/lmplatform.h delete mode 100644 libmseed/matlab/Makefile delete mode 100644 libmseed/matlab/README delete mode 100644 libmseed/matlab/mexMsReadTraces.c delete mode 100644 libmseed/matlab/mexMsReadTracesNative.c create mode 100644 libmseed/mseedformat.h create mode 100644 libmseed/msio.c create mode 100644 libmseed/msio.h delete mode 100644 libmseed/steimdata.h create mode 100644 libmseed/test/Makefile.win delete mode 100644 libmseed/test/README delete mode 100644 libmseed/test/data/Float32-encoded.mseed delete mode 100644 libmseed/test/data/Float64-encoded.mseed delete mode 100644 libmseed/test/data/Int16-encoded.mseed delete mode 100644 libmseed/test/data/Int32-1024byte.mseed delete mode 100644 libmseed/test/data/Int32-128byte.mseed delete mode 100644 libmseed/test/data/Int32-2048byte.mseed delete mode 100644 libmseed/test/data/Int32-256byte.mseed delete mode 100644 libmseed/test/data/Int32-4096byte.mseed delete mode 100644 libmseed/test/data/Int32-512byte.mseed delete mode 100644 libmseed/test/data/Int32-8192byte.mseed delete mode 100644 libmseed/test/data/Steim1-AllDifferences-BE.mseed delete mode 100644 libmseed/test/data/Steim1-AllDifferences-LE.mseed delete mode 100644 libmseed/test/data/Steim2-AllDifferences-BE.mseed delete mode 100644 libmseed/test/data/Steim2-AllDifferences-LE.mseed delete mode 100644 libmseed/test/data/corrupt-blockettes-wrongnext.mseed delete mode 100644 libmseed/test/data/invalid-blockette-offset.mseed create mode 100644 libmseed/test/data/reference-testdata-float32.mseed2 create mode 100644 libmseed/test/data/reference-testdata-float32.mseed3 create mode 100644 libmseed/test/data/reference-testdata-float64.mseed2 create mode 100644 libmseed/test/data/reference-testdata-float64.mseed3 create mode 100644 libmseed/test/data/reference-testdata-int16.mseed2 create mode 100644 libmseed/test/data/reference-testdata-int16.mseed3 create mode 100644 libmseed/test/data/reference-testdata-int32.mseed2 create mode 100644 libmseed/test/data/reference-testdata-int32.mseed3 create mode 100644 libmseed/test/data/reference-testdata-steim1-LE.mseed2 create mode 100644 libmseed/test/data/reference-testdata-steim1.mseed2 create mode 100644 libmseed/test/data/reference-testdata-steim1.mseed3 create mode 100644 libmseed/test/data/reference-testdata-steim2-LE.mseed2 create mode 100644 libmseed/test/data/reference-testdata-steim2.mseed2 create mode 100644 libmseed/test/data/reference-testdata-steim2.mseed3 create mode 100644 libmseed/test/data/reference-testdata-text.mseed2 create mode 100644 libmseed/test/data/reference-testdata-text.mseed3 create mode 100644 libmseed/test/data/testdata-3channel-signal.mseed2 create mode 100644 libmseed/test/data/testdata-3channel-signal.mseed3 rename libmseed/test/data/{detection.record.mseed => testdata-detection.record.mseed2} (100%) rename libmseed/test/data/{CDSN-encoded.mseed => testdata-encoding-CDSN.mseed2} (100%) rename libmseed/test/data/{DWWSSN-encoded.mseed => testdata-encoding-DWWSSN.mseed2} (100%) rename libmseed/test/data/{GEOSCOPE-16bit-3exp-encoded.mseed => testdata-encoding-GEOSCOPE-16bit-3exp-encoded.mseed2} (100%) rename libmseed/test/data/{SRO-encoded.mseed => testdata-encoding-SRO.mseed2} (100%) create mode 100644 libmseed/test/data/testdata-invalid-blockette-offsets.mseed2 rename libmseed/test/data/{no-blockette1000-steim1.mseed => testdata-no-blockette1000-steim1.mseed2} (100%) rename libmseed/test/data/{Int32-oneseries-mixedlengths-mixedorder.mseed => testdata-oneseries-mixedlengths-mixedorder.mseed2} (100%) create mode 100644 libmseed/test/data/testdata-oneseries-mixedlengths-mixedorder.mseed3 rename libmseed/test/data/{unapplied-timecorrection.mseed => testdata-unapplied-timecorrection.mseed2} (100%) delete mode 100644 libmseed/test/data/text-encoded.mseed create mode 120000 libmseed/test/lm_pack.c create mode 120000 libmseed/test/lm_pack_rollingbuffer.c create mode 120000 libmseed/test/lm_parse.c create mode 120000 libmseed/test/lm_read_buffer.c create mode 120000 libmseed/test/lm_read_recordlist.c create mode 120000 libmseed/test/lm_read_selection.c create mode 120000 libmseed/test/lm_sids.c create mode 120000 libmseed/test/lm_timestr.c delete mode 100644 libmseed/test/lmtestpack.c delete mode 100755 libmseed/test/pack-Float32-encoded.test delete mode 100644 libmseed/test/pack-Float32-encoded.test.ref delete mode 100755 libmseed/test/pack-Float64-encoded.test delete mode 100644 libmseed/test/pack-Float64-encoded.test.ref delete mode 100755 libmseed/test/pack-Int16-encoded.test delete mode 100644 libmseed/test/pack-Int16-encoded.test.ref delete mode 100755 libmseed/test/pack-Int32-encoded.test delete mode 100644 libmseed/test/pack-Int32-encoded.test.ref delete mode 100755 libmseed/test/pack-Steim1-encoded.test delete mode 100644 libmseed/test/pack-Steim1-encoded.test.ref delete mode 100755 libmseed/test/pack-Steim2-encoded.test delete mode 100644 libmseed/test/pack-Steim2-encoded.test.ref delete mode 100755 libmseed/test/pack-text-encoded.test delete mode 100644 libmseed/test/pack-text-encoded.test.ref delete mode 100755 libmseed/test/read-CDSN-encoded.test delete mode 100644 libmseed/test/read-CDSN-encoded.test.ref delete mode 100755 libmseed/test/read-DWWSSN-encoded.test delete mode 100644 libmseed/test/read-DWWSSN-encoded.test.ref delete mode 100755 libmseed/test/read-Float32-encoded.test delete mode 100644 libmseed/test/read-Float32-encoded.test.ref delete mode 100755 libmseed/test/read-Float64-encoded.test delete mode 100644 libmseed/test/read-Float64-encoded.test.ref delete mode 100755 libmseed/test/read-GEOSCOPE163-encoded.test delete mode 100644 libmseed/test/read-GEOSCOPE163-encoded.test.ref delete mode 100755 libmseed/test/read-Int16-encoded.test delete mode 100644 libmseed/test/read-Int16-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-1024byte-encoded.test delete mode 100644 libmseed/test/read-Int32-1024byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-128byte-encoded.test delete mode 100644 libmseed/test/read-Int32-128byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-2048byte-encoded.test delete mode 100644 libmseed/test/read-Int32-2048byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-256byte-encoded.test delete mode 100644 libmseed/test/read-Int32-256byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-4096byte-encoded.test delete mode 100644 libmseed/test/read-Int32-4096byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-512byte-encoded.test delete mode 100644 libmseed/test/read-Int32-512byte-encoded.test.ref delete mode 100755 libmseed/test/read-Int32-8192byte-encoded.test delete mode 100644 libmseed/test/read-Int32-8192byte-encoded.test.ref delete mode 100755 libmseed/test/read-SRO-encoded.test delete mode 100644 libmseed/test/read-SRO-encoded.test.ref delete mode 100755 libmseed/test/read-Steim1-bigendian.test delete mode 100644 libmseed/test/read-Steim1-bigendian.test.ref delete mode 100755 libmseed/test/read-Steim1-littleendian.test delete mode 100644 libmseed/test/read-Steim1-littleendian.test.ref delete mode 100755 libmseed/test/read-Steim2-bigendian.test delete mode 100644 libmseed/test/read-Steim2-bigendian.test.ref delete mode 100755 libmseed/test/read-Steim2-littleendian.test delete mode 100644 libmseed/test/read-Steim2-littleendian.test.ref delete mode 100755 libmseed/test/read-detection-record.test delete mode 100644 libmseed/test/read-detection-record.test.ref delete mode 100755 libmseed/test/read-invalid-blockette-offset.test delete mode 100644 libmseed/test/read-invalid-blockette-offset.test.ref delete mode 100755 libmseed/test/read-mixed-order-mixed-length-trace.test delete mode 100644 libmseed/test/read-mixed-order-mixed-length-trace.test.ref delete mode 100755 libmseed/test/read-no-blockette1000.test delete mode 100644 libmseed/test/read-no-blockette1000.test.ref delete mode 100755 libmseed/test/read-text-encoded.test delete mode 100644 libmseed/test/read-text-encoded.test.ref delete mode 100755 libmseed/test/read-unapplied-timecorrection.test delete mode 100644 libmseed/test/read-unapplied-timecorrection.test.ref create mode 100644 libmseed/test/tau/compilers.h create mode 100644 libmseed/test/tau/misc.h create mode 100644 libmseed/test/tau/tau.h create mode 100644 libmseed/test/tau/types.h create mode 100644 libmseed/test/test-crc.c create mode 100644 libmseed/test/test-extraheaders.c create mode 100644 libmseed/test/test-read.c create mode 100644 libmseed/test/test-runner.c create mode 100644 libmseed/test/test-selection.c create mode 100644 libmseed/test/test-sid.c create mode 100644 libmseed/test/test-time.c create mode 100644 libmseed/test/test-tracelist.c create mode 100644 libmseed/test/test-write.c create mode 100644 libmseed/test/testdata.h delete mode 100644 libmseed/traceutils.c create mode 100644 libmseed/unpack.h create mode 100644 libmseed/yyjson.c create mode 100644 libmseed/yyjson.h diff --git a/ChangeLog b/ChangeLog index b2ce32b..a4ccd9e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2023.XXX: 4.0 + - Update to libmseed 3, with support for miniSEED 3, URLs, etc. + - Filenames can now contain read range with end: file@start-end + - Added -H option to add HTTP headers + - Added -u option to take user:pass + - Remove -e (encoding) and -r (reclen) options + - Changed -Q to -P, -Q still supported but undocumented + 2017.283: 3.8 - Update libmseed to 2.19.5, with fix for leap second calculation. @@ -24,7 +32,7 @@ truncation for SYNC output. 2011.144: 3.4.1 - - Update to libmseed 2.6.1 with fixes for more graceful handling of bad + - Update to libmseed 2.6.1 with fixes for more graceful handling of bad data and corner-case IRIS archive files. 2011.057: 3.4 @@ -39,7 +47,7 @@ 2010.048: 3.3 - Update to libmseed 2.5, fix for sorting MSTraceSeg entries. - + 2010.026: 3.2 - Update libmseed to version 2.4. diff --git a/LICENSE b/LICENSE index 9cecc1d..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,201 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - {project} Copyright (C) {year} {fullname} - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile index 39827b6..169c72d 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,23 @@ +# Automatically configure URL support if libcurl is present +# Test for curl-config command and add build options if so +ifneq (,$(shell command -v curl-config)) + export LM_CURL_VERSION=$(shell curl-config --version) + export CFLAGS:=$(CFLAGS) -DLIBMSEED_URL + export LDFLAGS:=$(LDFLAGS) $(shell curl-config --libs) + $(info Configured with $(LM_CURL_VERSION)) +endif -DIRS = libmseed src +.PHONY: all clean +all clean: libmseed + $(MAKE) -C src $@ -all clean static install gcc gcc32 gcc64 debug gccdebug gcc32debug gcc64debug :: - @for d in $(DIRS) ; do \ - echo "Running $(MAKE) $@ in $$d" ; \ - if [ -f $$d/Makefile -o -f $$d/makefile ] ; \ - then ( cd $$d && $(MAKE) $@ ) ; \ - elif [ -d $$d ] ; \ - then ( echo "ERROR: no Makefile/makefile in $$d for $(CC)" ) ; \ - fi ; \ - done +.PHONY: libmseed +libmseed: + $(MAKE) -C $@ $(MAKECMDGOALS) +.PHONY: install +install: + @echo + @echo "No install method" + @echo "Copy the binary and documentation to desired location" + @echo diff --git a/README.md b/README.md index 00553fa..d9bb2c9 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ For usage infromation see the [msi manual](doc/msi.md) in the ## Downloading and building -The [releases](https://github.com/iris-edu/msi/releases) area +The [releases](https://github.com/earthscope/msi/releases) area contains release versions. In most environments a simple 'make' will build the program. @@ -17,6 +17,18 @@ In most environments a simple 'make' will build the program. The CC and CFLAGS environment variables can be used to configure the build parameters. -## Licensing +## License -GNU GPL version 3. See included LICENSE file for details. +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +Copyright (C) 2023 Chad Trabant, EarthScope Data Service \ No newline at end of file diff --git a/doc/msi.1 b/doc/msi.1 index 1a1e4fc..14b1f77 100644 --- a/doc/msi.1 +++ b/doc/msi.1 @@ -1,6 +1,6 @@ -.TH MSI 1 2015/03/03 +.TH MSI 1 2023/02/17 .SH NAME -Mini-SEED Inspector +miniSEED Inspector .SH SYNOPSIS .nf @@ -8,9 +8,9 @@ msi [options] file1 [file2 file3 ...] .fi .SH DESCRIPTION -\fBmsi\fP is a general purpose Mini-SEED parser. In addition to -parsing and displaying the contents of Mini-SEED records, \fBmsi\fP -will derive continuous trace information for Mini-SEED data. +\fBmsi\fP is a general purpose miniSEED parser. In addition to +parsing and displaying the contents of miniSEED records, \fBmsi\fP +will derive continuous trace information for miniSEED data. By default, \fBmsi\fP will output a single line of information to summarize each record parsed. More verbose or different output can be @@ -39,53 +39,54 @@ Print program usage and exit. Be more verbose. This flag can be used multiple times ("-v -v" or "-vv") for more verbosity. -.IP "-r \fIreclen\fP" -Specify the input record length in bytes. By default the -record length of each input Mini-SEED record is automatically -detected, this option forces the record length. +.IP "-H \fIHeader\fP" +Add custom header to URL-based reads. Only available when compiled +with URL support. -.IP "-e \fIencoding\fP" -Specify the data encoding format. These encoding values are the same -as those specified in the SEED 1000 Blockette. +.IP "-u \fIuser:pass\fP" +Set \fIuser\fP and \fIpass\fP credentials for URL-based reads. Only +available when compiled with URL support. .IP "-ts \fItime\fP" -Limit processing to Mini-SEED records that contain or start after +Limit processing to miniSEED records that contain or start after \fItime\fP. The format of the \fItime\fP arguement -is: 'YYYY[,DDD,HH,MM,SS,FFFFFF]' where valid delimiters are either -commas (,), colons (:) or periods (.). +is: 'YYYY[-MM-DDThh:mm:ss.ffff], or 'YYYY[,DDD,HH,MM,SS,FFFFFF]', +or Unix/POSIX epoch seconds. .IP "-te \fItime\fP" -Limit processing to Mini-SEED records that contain or end before +Limit processing to miniSEED records that contain or end before \fItime\fP. The format of the \fItime\fP arguement -is: 'YYYY[,DDD,HH,MM,SS,FFFFFF]' where valid delimiters are either -commas (,), colons (:) or periods (.). +is: 'YYYY[-MM-DDThh:mm:ss.ffff], or 'YYYY[,DDD,HH,MM,SS,FFFFFF]', +or Unix/POSIX epoch seconds. .IP "-M \fImatch\fP" -Limit processing to Mini-SEED records that match the \fImatch\fP -regular expression. For each input record a source name string -composed of 'NET_STA_LOC_CHAN_QUAL' is created and compared to the -regular expression. If the match expression begins with an '@' -character it is assumed to indicate a file containing a list of -expressions to match, see the \fBMATCH OR REJECT LIST FILE\fR section -below. +Limit processing to miniSEED records that match the \fImatch\fP +regular expression. This pattern is matched against the +Source Identifier for each record, often following this pattern: +'FDSN:_____' + +If the match expression begins with an '@' character it is assumed +to indicate a file containing a list of expressions to match, see +the \fBMATCH OR REJECT LIST FILE\fR section below. .IP "-R \fIreject\fP" -Limit processing to Mini-SEED records that do not match the -\fIreject\fP regular expression. For each input record a source name -string composed of 'NET_STA_LOC_CHAN_QUAL' is created and compared to -the regular expression. If the reject expression begins with an '@' -character it is assumed to indicate a file containing a list of -expressions to reject, see the \fBMATCH OR REJECT LIST FILE\fR section -below. +Limit processing to miniSEED records that do not match the +\fIreject\fP regular expression. This pattern is matched against +the Source Identifier for each record, often following this pattern: +'FDSN:_____' + +If the reject expression begins with an '@' character it is assumed +to indicate a file containing a list of expressions to reject, see +the \fBMATCH OR REJECT LIST FILE\fR section below. .IP "-n \fIcount\fP" Only process \fIcount\fP input records. -.IP "-y " -Do not skip non-SEED data records. By default the program will -quietly skip any data which cannot be identified as a SEED data -record, allowing the program to work with full SEED volumes and skip -bad data. This option is useful to help identify bad data records. +.IP "-snd " +Skip non-miniSEED records. By default the program will stop when +it encounters data that cannot be identified as a miniSEED record. +This option can be useful with full SEED volumes or files with bad +data. .IP "-p " Print details of each record header. This flag can be used multiple @@ -98,7 +99,7 @@ details. .IP "-L " Include data latency when printing header details. The latency is -calcualed as the difference between the time of the last sample and +calculated as the difference between the time of the last sample and the current time from the host computer. .IP "-s " @@ -121,7 +122,8 @@ Print a sorted trace list after processing all input records and suppress record-by-record output, i.e. trace list only. .IP "-tg " -Include gap estimates when approriate in trace listings. +Include gap estimates when approriate in trace listings and +suppress record-by-record output, i.e. trace list only. .IP "-tt \fIsecs\fP" Specify a time tolerance for constructing continous trace @@ -153,18 +155,19 @@ of seconds. Print a sorted SYNC format trace list after processing all input records and suppress record-by-record output. -.IP "-Q " -Additionally group input data based on SEED data qualitiy flags. By -default data are grouped by network, station, location, channel and -adjacent time windows, this option adds data quality to the grouping -parameters. +.IP "-P " +Additionally group input data by publication. Note: for miniSEED +version 2 records, SEED data qualitiy values are translated to +publication versions. By default data are grouped by network, station, +location, channel and adjacent time windows, this option adds +publication version to the grouping parameters. .IP "-tf \fIformat\fP" Specify the time stamp format for trace and gap/overlap lists. The \fIformat\fP can be one of the following (default = 0): .nf - 0 = SEED time, e.g. "2005,068,00:00:01.000000" - 1 = ISO time, e.g. "2005-03-09T00:00:01.000000" + 0 = SEED day-of-year time, e.g. "2005,068,00:00:01.000000" + 1 = ISO year-month-day time, e.g. "2005-03-09T00:00:01.000000" 2 = Epoch seconds, e.g. "1110326401.000000" .fi @@ -173,16 +176,17 @@ Decompress/unpack data in input records and write the binary samples to \fIbinfile\fP. .IP "-o \fIoutfile\fP" -Write all processed Mini-SEED records to \fIoutfile\fP. +Write all processed miniSEED records to \fIoutfile\fP. .SH "INPUT FILES" An input file name may be followed by an \fB@\fP charater followed by -a byte offset. In this case the program will interpret the byte -offset as the starting offset into the file. Useful for diagnosing -specific records. As an example an input file specified as +a byte range in the pattern \fBSTART[-END]\fP, where the END offset is +optional. As an example an input file specified as \fBANMO.mseed@8192\fP would result in the file \fBANMO.mseed\fP being -read starting at byte 8192. +read starting at byte 8192. An optional end offset can be specified, +e.g. \fBANMO.mseed@8192-12288\fP would start reading at offset 8192 +and stop after offset 12288. .SH "INPUT LIST FILE" A list file can be used to specify input files, one file per line. @@ -201,7 +205,7 @@ data/day1.mseed data/day2.mseed data/day3.mseed .fi - + .SH "MATCH OR REJECT LIST FILE" A list file used with either the \fB-M\fP or \fB-R\fP options contains a list of regular expressions (one on each line) that will be combined @@ -216,16 +220,19 @@ example, if the following command line option was used: The 'match.list' file might look like this: .nf -IU_ANMO_.* -IU_ADK_00_BHZ.* -II_BFO_00_BHZ_Q +FDSN:IU_ANMO_.* +FDSN:IU_ADK_00_B_H_Z +FDSN:II_BFO_00_B_H_Z .fi .SH LEAP SECOND LIST FILE +NOTE: A list of leap seconds is included in the program and no external +list should be needed unless a leap second is added after year 2023. + If the environment variable LIBMSEED_LEAPSECOND_FILE is set it is expected to indicate a file containing a list of leap seconds as published by NIST and IETF, usually available here: -http://www.ietf.org/timezones/data/leap-seconds.list +https://www.ietf.org/timezones/data/leap-seconds.list If present, the leap seconds listed in this file will be used to adjust the time coverage for records that contain a leap second. @@ -234,5 +241,5 @@ Also, leap second indicators in the miniSEED headers will be ignored. .SH AUTHOR .nf Chad Trabant -IRIS Data Management Center +EarthScope Data Services .fi diff --git a/doc/msi.md b/doc/msi.md index 5e20055..04d144d 100644 --- a/doc/msi.md +++ b/doc/msi.md @@ -1,4 +1,4 @@ -#

Mini-SEED Inspector

+#

miniSEED Inspector

1. [Name](#) 1. [Synopsis](#synopsis) @@ -18,7 +18,7 @@ msi [options] file1 [file2 file3 ...] ## Description -

msi is a general purpose Mini-SEED parser. In addition to parsing and displaying the contents of Mini-SEED records, msi will derive continuous trace information for Mini-SEED data.

+

msi is a general purpose miniSEED parser. In addition to parsing and displaying the contents of miniSEED records, msi will derive continuous trace information for miniSEED data.

By default, msi will output a single line of information to summarize each record parsed. More verbose or different output can be specified via the numerous options.

@@ -42,37 +42,41 @@ msi [options] file1 [file2 file3 ...]

Be more verbose. This flag can be used multiple times ("-v -v" or "-vv") for more verbosity.

--r reclen +-H Header -

Specify the input record length in bytes. By default the record length of each input Mini-SEED record is automatically detected, this option forces the record length.

+

Add custom header to URL-based reads. Only available when compiled with URL support.

--e encoding +-u user:pass -

Specify the data encoding format. These encoding values are the same as those specified in the SEED 1000 Blockette.

+

Set user and pass credentials for URL-based reads. Only available when compiled with URL support.

-ts time -

Limit processing to Mini-SEED records that contain or start after time. The format of the time arguement is: 'YYYY[,DDD,HH,MM,SS,FFFFFF]' where valid delimiters are either commas (,), colons (:) or periods (.).

+

Limit processing to miniSEED records that contain or start after time. The format of the time arguement is: 'YYYY[-MM-DDThh:mm:ss.ffff], or 'YYYY[,DDD,HH,MM,SS,FFFFFF]', or Unix/POSIX epoch seconds.

-te time -

Limit processing to Mini-SEED records that contain or end before time. The format of the time arguement is: 'YYYY[,DDD,HH,MM,SS,FFFFFF]' where valid delimiters are either commas (,), colons (:) or periods (.).

+

Limit processing to miniSEED records that contain or end before time. The format of the time arguement is: 'YYYY[-MM-DDThh:mm:ss.ffff], or 'YYYY[,DDD,HH,MM,SS,FFFFFF]', or Unix/POSIX epoch seconds.

-M match -

Limit processing to Mini-SEED records that match the match regular expression. For each input record a source name string composed of 'NET_STA_LOC_CHAN_QUAL' is created and compared to the regular expression. If the match expression begins with an '@' character it is assumed to indicate a file containing a list of expressions to match, see the \fBMATCH OR REJECT LIST FILE\fR section below.

+

Limit processing to miniSEED records that match the match regular expression. This pattern is matched against the Source Identifier for each record, often following this pattern: 'FDSN:_____'

+ +

If the match expression begins with an '@' character it is assumed to indicate a file containing a list of expressions to match, see the \fBMATCH OR REJECT LIST FILE\fR section below.

-R reject -

Limit processing to Mini-SEED records that do not match the reject regular expression. For each input record a source name string composed of 'NET_STA_LOC_CHAN_QUAL' is created and compared to the regular expression. If the reject expression begins with an '@' character it is assumed to indicate a file containing a list of expressions to reject, see the \fBMATCH OR REJECT LIST FILE\fR section below.

+

Limit processing to miniSEED records that do not match the reject regular expression. This pattern is matched against the Source Identifier for each record, often following this pattern: 'FDSN:_____'

+ +

If the reject expression begins with an '@' character it is assumed to indicate a file containing a list of expressions to reject, see the \fBMATCH OR REJECT LIST FILE\fR section below.

-n count

Only process count input records.

--y +-snd -

Do not skip non-SEED data records. By default the program will quietly skip any data which cannot be identified as a SEED data record, allowing the program to work with full SEED volumes and skip bad data. This option is useful to help identify bad data records.

+

Skip non-miniSEED records. By default the program will stop when it encounters data that cannot be identified as a miniSEED record. This option can be useful with full SEED volumes or files with bad data.

-p @@ -84,7 +88,7 @@ msi [options] file1 [file2 file3 ...] -L -

Include data latency when printing header details. The latency is calcualed as the difference between the time of the last sample and the current time from the host computer.

+

Include data latency when printing header details. The latency is calculated as the difference between the time of the last sample and the current time from the host computer.

-s @@ -108,7 +112,7 @@ msi [options] file1 [file2 file3 ...] -tg -

Include gap estimates when approriate in trace listings.

+

Include gap estimates when approriate in trace listings and suppress record-by-record output, i.e. trace list only.

-tt secs @@ -138,16 +142,16 @@ msi [options] file1 [file2 file3 ...]

Print a sorted SYNC format trace list after processing all input records and suppress record-by-record output.

--Q +-P -

Additionally group input data based on SEED data qualitiy flags. By default data are grouped by network, station, location, channel and adjacent time windows, this option adds data quality to the grouping parameters.

+

Additionally group input data by publication. Note: for miniSEED version 2 records, SEED data qualitiy values are translated to publication versions. By default data are grouped by network, station, location, channel and adjacent time windows, this option adds publication version to the grouping parameters.

-tf format

Specify the time stamp format for trace and gap/overlap lists. The format can be one of the following (default = 0):

-  0 = SEED time, e.g. "2005,068,00:00:01.000000"
-  1 = ISO time, e.g. "2005-03-09T00:00:01.000000"
+  0 = SEED day-of-year time, e.g. "2005,068,00:00:01.000000"
+  1 = ISO year-month-day time, e.g. "2005-03-09T00:00:01.000000"
   2 = Epoch seconds, e.g. "1110326401.000000"
@@ -157,11 +161,11 @@ msi [options] file1 [file2 file3 ...] -o outfile -

Write all processed Mini-SEED records to outfile.

+

Write all processed miniSEED records to outfile.

## Input Files -

An input file name may be followed by an @ charater followed by a byte offset. In this case the program will interpret the byte offset as the starting offset into the file. Useful for diagnosing specific records. As an example an input file specified as ANMO.mseed@8192 would result in the file ANMO.mseed being read starting at byte 8192.

+

An input file name may be followed by an @ charater followed by a byte range in the pattern START[-END], where the END offset is optional. As an example an input file specified as ANMO.mseed@8192 would result in the file ANMO.mseed being read starting at byte 8192. An optional end offset can be specified, e.g. ANMO.mseed@8192-12288 would start reading at offset 8192 and stop after offset 12288.

## Input List File @@ -190,14 +194,16 @@ data/day3.mseed

The 'match.list' file might look like this:

-IU_ANMO_.*
-IU_ADK_00_BHZ.*
-II_BFO_00_BHZ_Q
+FDSN:IU_ANMO_.*
+FDSN:IU_ADK_00_B_H_Z
+FDSN:II_BFO_00_B_H_Z
## Leap Second List File -

If the environment variable LIBMSEED_LEAPSECOND_FILE is set it is expected to indicate a file containing a list of leap seconds as published by NIST and IETF, usually available here: http://www.ietf.org/timezones/data/leap-seconds.list

+

NOTE: A list of leap seconds is included in the program and no external list should be needed unless a leap second is added after year 2023.

+ +

If the environment variable LIBMSEED_LEAPSECOND_FILE is set it is expected to indicate a file containing a list of leap seconds as published by NIST and IETF, usually available here: https://www.ietf.org/timezones/data/leap-seconds.list

If present, the leap seconds listed in this file will be used to adjust the time coverage for records that contain a leap second. Also, leap second indicators in the miniSEED headers will be ignored.

@@ -205,8 +211,8 @@ II_BFO_00_BHZ_Q 
 Chad Trabant
-IRIS Data Management Center
+EarthScope Data Services
-(man page 2015/03/03) +(man page 2023/02/17) diff --git a/libmseed/.gitignore b/libmseed/.gitignore new file mode 100644 index 0000000..8803df1 --- /dev/null +++ b/libmseed/.gitignore @@ -0,0 +1,2 @@ +doc/working/ +doc/gh-pages/ diff --git a/libmseed/ChangeLog b/libmseed/ChangeLog index 7f8e09d..cda6c30 100644 --- a/libmseed/ChangeLog +++ b/libmseed/ChangeLog @@ -1,3 +1,279 @@ +2023.204: 3.0.16 + - Additional Steim 1 & 2 decoder optimization. + - Add more const qualifiers to pointer values. Thanks @damb. + +2023.185: + - Fix logic in `msr3_duplicate()` for certain cases. + - Add many const qualifiers to pointer values where the library + interface does not modify the data. Thanks @damb + +2023.180: + - Add const qualifier to record pointer declarations where the + library interface does not modify the data. + +2023.177: + - Incorporate ms_gswapX() functions into libmseed.h to promote inlining. + - Optimize Steim 1 & 2 decoders. + - Change test for environment variable DECODE_DEBUG to compile-time define + - Change test for environment variable ENCODE_DEBUG to compile-time define + +2023.162: 3.0.15 + - Print sample rate in Hz consistently in msr3_print() + - Fix writing of SNR values field 9 of Blockette 201 (v2) + - Read and write microsecond offsets to/from Blockette 500 (v2) + - Fix addition of Clock Model field 9 of Blocketee 500 (v2) + +2023.160: 3.0.14 + - Add FAQ to documentation and update example code to match API changes. + - Change sample type for text encoding to 't', value 'a' still supported. + +2023.159: + WARNING: API change as follows: + The `fpos` and `last` arguments of ms3_readmsr(), ms3_readmsr_r(), + and ms3_readmsr_selection() have been removed. The same capabilities + is avaiable and details are included in the porting guide. + + - Add JSON Merge Patch capability to mseh_set_ptr_r(). + - Fix zero-padding of empty bytes following data in miniSEED v2 creation. + - Rename DE_ASCII to DE_TEXT to generalize to UTF-8, legacy mapping provided. + - Add MS3Tolerance_INITIALIZER for MS3Tolerance values. + +2023.155: + WARNING: API change as follows: + The `MS3TraceList.numtraces` was renamed `MS3TraceList.numtraceids`. + + - New test suite based on Tau :https://github.com/jasmcaus/tau. + Many tests were added and the suite now works on MS-Windows. + + - Update example/lm_pack.c: + * Use improved test sinusuoid that contains all differences for + Steim1 and Steim2 encoding. + * Add `-2` option to generate miniSEED v2 instead of default v3. + +2023.105: + - Handle special case of year 0 when parsing version 2 blockettes. These + are now treated as "unset" and not included in the extra headers. + - Add nstime_t special value of NSTUNSET for use as "unset" meaning. + +2023.099: + WARNING: API change as follows: + The `path` argument to mseh_get and mseh_set routines is now in + JSON Pointer (RFC 6901) format. This is a more appropriate, and + standardized, format than the pseudo-JSON Path, dotted string style + previously used. It also allows more flexibility such as specification + of an array element. + + - `mseh_get_path_r()` and `mseh_set_path_r()`, previously named without + the `_r` suffix, now take a additional `parsestate` argument. This + functionality allows the parsed extra headers to be retained between + calls to avoid re-parsing. For advanced usage, this allows more efficient + getting or setting of multiple extraheader values. If used, this state + information must be free'd with `mseh_free_parsestate()`. If used + with `mseh_set_path_r()` the headers must also be serialized with + `mseh_serialize()`. + + - `mseh_get_path_r()` and `mseh_set_path_r()` accept a value type of `i` + that is used with int64_t values. + + - Replace JSON library with yyjson (https://github.com/ibireme/yyjson). + Benefits include performance, shortest accurate real number representation, + JSON Pointer support, and UTF-8 support. + + +2023.082: + WARNING: API changes as follows: + 1. mstl3_printtracelist() now takes an additional `versions` argument. + When non-zero the routine will decorate SIDs with publication versions. + 2. The MS3TraceID structure is no longer a simple linked list. Instead + it is a skip list, slightly changing the syntax for traversing the list + as illustrated in the examples. + + - Significant optimization for the case of constructing trace lists with + large numbers of differnt source IDs, by using a skip list. Implementation + inspired by: https://github.com/tdeck/c-skiplist, thanks @tdeck! + - Add new mstl3_findID() function for searching a trace list for specific + SourceID and, optionally, publication version. + +2023.068: + - Optimize trace construction in mstl3_addmsr_recordptr() for the case + of duplicate records. + - Add 'const' declarations to ms_sid2nslc() and ms_nslc2sid() to guarantee + input will not be modified. + - Add cURL detection and full build support to example/Makefile. + - Fix logic test for LIBMSEED_NO_THREADING declaration. + +2023.029: 3.0.13 + - Embed current leap second list, used by default and replaced by + ms_readleapsecondfile(). + +2023.028: + - Add ISOMONTHDAY_DOY time string variant, with day-of-year. + - Add '_Z' variants of time string formats for trailing Z versions. + - Print record timestamp in new ISOMONTHDAY_DOY_Z format. + - Deprecated the ms_nstime2timestrz() function. + - Re-brand to EarthScope. + +2022.338: 3.0.12 + - Change printing of bit flag sets to print each bit flag in + most-significant-bit first order to match binary number representation. + +2022.156: 3.0.11 + - Generate proper HTTP Range header by always including a start value, + defaulting to 0, when a range end is specified. + - When time correction value is present always set the time correction + applied bit when creating V2 records. Thanks @nicoleroy-ipgp. + - mseedview example: always emit accumulated log messages, and print + basic summary correctly. + +2022.103: 3.0.10 + - Fix uninitialized file position in ms3_readtracelist_selection() (#80) + by @anowacki. + - Fix array index warning in crc32c.c. + - Update emmbedded Parson to 1.4.0. + - Simplify byte swapping routines (#75) by @QuLogic. + - Initialize selection.pubversion to 0 in ms3_readtracelist_timewin() + by @Cuda-Chen. + - Make logging facility thread safe, with per-thread parameters. + - Add lm_pararead.c example to illustrate reading miniSEED in parallel + using re-entrant interfaces and POSIX threading. + - Add Add MS_HPTIME2NSTIME and MS_NSTIME2HPTIME macros to convert + to/from version 2.x time values. + +2021.234: 3.0.9 + - Update Source Identifier handling to the adopted specification of: + FDSN:NET_STA_LOC_BAND_SOURCE_POSITION + +2020.156: 3.0.8 + - Add error/warning log registry for accumulation of messages. + - Log and diagnostic printing callbacks now require 'const char *'. + - Verbose-triggered messages are now sent to stdout instead of stderr. + +2020.137: + - Add capability to read data from URLs. This feature is optional, + enabled at build time with LIBMSEED_URL and requires libcurl to be + available on the system. + +2019.216: + - Copy only UTF-8 characters in ms_strncpclean(), ms_strncpcleantail(), + and ms_strncpopen(). + +2019.172: 3.0.7 + - Add conversion of epoch values via ms_timestr2nstime(). + - Allow trailing 'Z' in date-times in ms_timestr2nstime(). + +2019.170: 3.0.6 + - Generalize ms_timestr2nstime() to detect all supported time formats. + - Rename old ms_timestr2nstime() to ms_mdtimestr2nstime(). + - Change minimum valid year from 1000 to 1678 to avoid wrap-around. + - ms_nstime2timestr(): fix printing of pre-epoch values for UNIXEPOCH. + - Add test for time string parsing and conversion. + +2019.166: 3.0.5 + - Allow trace list packing with multiple data sample types. + +2019.163: + - Portable printing of size_t values. + +2019.162: + - Re-license all libmseed code under the Apache License V2.0. + +2019.161: 3.0.4 + - Add record record list capability, replacing segment-level record metadata. + +2019.142: + - Add ability to pack miniSEED version 2 records. + +2019.137: + - Allow packing records with no payload, i.e. header-only. + +2019.135: + - Add pre-allocation of data buffers, enable on Windows and disable otherwise. + +2019.123: 3.0.3 + - Fix version splitting, clarify behavior + - Fix publication version filtering, thanks @krischer + - Allow selections without time ranges, thanks @krischer + - Normalize encoding string lookups, the SEED manual values are messy no need to perpetuate them + - Add option to build PDF manual and clarifications in documentation + - Remove steps in install target of Makefile that no longer function, thanks @senshu + +2019.103: 3.0.2 + - mstl3_pack() can be called without modifying the Trace List with MSF_MAINTAINMSTL flag. + - Add lm_pack_rollingbuffer.c example of generating records with a rolling buffer. + - Consistently provide extra headers as terminated string from MS3Record.extra. + - Fix segment start time tracking in mstl3_pack(). + +2019.102: 3.0.1 + - Add mstl3_readbuffer_selection() and fix selection-based ms3_readmsr_selection(). + - Use callback functions for time and sample rate tolerance instead of fixed values. + - Fix progression of record start time when packing records. + - Optionally store record-level metadata, header flags and extra headers, in a MS3TraceList. + - More documentation and examples. + +2019.094: 3.0.0 + - A new major version refactored to support the next generation miniSEED + Documentation including porting guide avilable at: + https://iris-edu.github.io/libmseed/ + + Almost all core data structures and functions have been modified, + often mostly in name (due to structure changes), so porting is required. + + Major new features and changes of note: + + - Support for reading/writing of miniSEED 3 and read support of miniSEED 2. + + - Support for nanosecond time resolution: + The HPTMODULUS is renamed NSTMODULUS and changed for nanoseconds. + Related change of HTPERROR to NSTPERROR value. + hptime_t changed to nstime_t and all time functions changed accordingly. + The hptime2XYZtimestr() function is combined into single nstime2timestr() + function with format flag. + + - Added mstl3_readbuffer() to read all records in a data buffer into a Trace List. + + - Add global libmseed_memory that contains user-definable function pointers to + malloc(), realloc() and free(). This allows all memory management from the library + to be performed with user-defined functions. + + - Data structure change and rename: + Rename MSRecord to MS3Record and restructure for miniSEED 3. + Rename MSTrace[ID,Seg,List] to MS3Trace[ID,Seg,List] and restructure for miniSEED 3. + Rename Selections and SelectTime to MS3Selections and MS3SelectTime. + + - Remove MSTrace_s and MSTraceGroup and related functions, use MS3Trace[ID,Seg,List] instead. + + - Remove all platform defines (LWP_*) except LWP_WIN for MS Windows. + + - Rename all library structs by removing the "_s" suffix so they match their typedef names + + - Rename macros and functions specific to miniSEED 2.x by adding "2". + + - Remove packheaderbyteorder and packdatabyteorder handling and related + envrionment variables. Byte order is either detected or fixed. + + - Decrease MINRECLEN from 256 to 40, decrease MAXRECLEN from 1MB to 128 KiB. + + - Increase 'recbuflen' to msr3_parse[_selection]() to uint64_t to work with very large buffers. + + - Remove record length specifier from many parsing routines, always autodetermined. + + - Remove MS_ISVALIDBLANK macro, was only used for notification of archaic structure. + + - Add JSON handling and general wrapper functions to support extra headers + + - Add CRC-32C calculation, new ms_crc32c() function. + + - Set msr->swapflag bit flags to indicate if header and payload need swapping during parsing. + + - Selection file format allows two selection listing variants + If the "quality" field is an integer it is assumed to be a publication version, + otherwise it is ignored. + + - Remove capability to read the deprecated "pack" file format used at IRIS DMC. + + - Remove StreamState tracking, effectively dropping the compression history capability + between records. Not worth the complexity. + 2017.283: 2.19.5 - msr_endtime(): calculate correct end time during a leap second. - Fixed signedness comparison warning. @@ -136,7 +412,7 @@ contributed by Larry Baker and Eric Thomas. - Change casting of values passed to isdigit() to int intead of unsigned character. Apparently this was consufing on ARM archs. - + 2015.061: - Add ms_readleapseconds() and ms_readleapsecondfile() routines to read a leap seconds file into an internal list. @@ -153,7 +429,7 @@ 2014.234: 2.13 - Clean up Makefile and example/Makefile, remove all GCC-specific and - debug targets. Makefiles are compatible with both GNU and BSD make. + debug targets. Makefiles are compatible with both GNU and BSD make. As before, the shared target works only for GCC-compatible compilers. Thanks to Elliott Sales de Andrade for pointing out that shared library targets did not work with parallel builds, prompting this clean up. @@ -186,8 +462,8 @@ - Update docs for transition to 64-bit sample counts done in 2011! 2013.117: 2.11 - - Initialize internal counters in mst_pack() to avoid their use - in error conditions. Thanks to D. Ketchum and M. Potter for help. + - Initialize internal counters in mst_pack() to avoid their use + in error conditions. Thanks to D. Ketchum and M. Potter for help. - Add 'const' qualifier to the msfile argument of the file reading and writing family of routines to stop compiler warnings resulting from generated binding functions. Thanks to M. Bach for reporting. @@ -199,7 +475,7 @@ 2013.053: 2.9 - Extend parsing of day-of-year style time strings to allow parsing of time fields separated by dashes in addition to allowing the day - and time fields to be separated by a 'T' or space. Modifications + and time fields to be separated by a 'T' or space. Modifications were made to ms_seedtimestr2hptime(). - Extend parsing of year-month-day style time strings to allow parsing of time fields separated by commas. Modifications were made to @@ -318,7 +594,7 @@ - Default data byte order to big endian when blockette 1000 contains invalid byte order value, previously defaulted to host byte order. -2011.042: +2011.042: - Update libmseed.def to match current libmseed.h declaractions. - Cleanup to avoid MSVC warnings. @@ -341,7 +617,7 @@ ms_readtracegroup_selection() ms_readtracelist_timewin() ms_readtracelist_selection() - - Add convience routines to write Mini-SEED data to specified file: + - Add convience routines to write miniSEED data to specified file: msr_writemseed() mst_writemseed() mst_writemseedgroup(). @@ -349,7 +625,7 @@ a NULL packedsamples pointer. - Fix bugs when (re)initializing read buffer. - Fix return of file position in ms_readmsr_main().. - + 2010.365: - Add internal ms_gmtime_r() to replace call to system gmtime_r(). The internal version handles dates beyond year 2038 and avoids the system @@ -414,11 +690,11 @@ 2010.012: - Fix unpacking of 16-bit integer encoded data, thanks to - Robert Barsch. - + Robert Barsch. + 2010.008: - Fix special case of "--" location ID in ms_addselect(). - + 2010.007: - Add SelectTime **ppselecttime argument to ms_matchselect() and msr_matchselect() routines so that the matching time range @@ -428,7 +704,7 @@ - Add a check for ATTRIBUTE_PACKED define (lmplatform.h) and if set add an __attribute__((packed)) qualifier to all structs that are mapped to SEED structures (and cannot be padded). - This is useful on platforms such as ARM that pad structures + This is useful on platforms such as ARM that pad structures for alignment by default. To use add "-DATTRIBUTE_PACKED" to CFLAGS or equivalent. - Fixes to gswapX() routines for platforms where structures @@ -439,7 +715,7 @@ 2010.005: - Simplify packed file reading in ms_readmsr_main() and allow data sections to be skipped based on a Selection list, packed - files are used internally at the IRIS DMC. + files are used internally at the IRIS DMC. - Rename ms_readmsr_r() to ms_readmsr_main() and create a simple wrapper function for ms_readmsr_r(). @@ -459,7 +735,7 @@ thanks to Roman Racine for the report and suggested fix. The error only accumulated to significant values when packing a large number of records with a single call to msr_pack(). - + 2009.354: - Change return type of internal ms_readpackinfo() to off_t and fix small error return check. @@ -467,7 +743,7 @@ 2009.353: - Add ms_splitsrcname() routine to split "NET_STA_LOC_CHAN[_QUAL]" into separate components. - - Update MINOR_VER version to 4 anticipating the 2.4 release + - Update MINOR_VER version to 4 anticipating the 2.4 release (seem to have forgotten 3). 2009.201: 2.3 @@ -479,7 +755,7 @@ - Add diagnostic reporting of data problems in ms_readmsr_r() by calling ms_parse_raw(). -2009.174: +2009.174: - Fix corner case trace sorting error in mstl_addmsr(). - Add ms_nomsamprate() to genutils.c to calculate the sample rate specified as a SEED sample rate factor and multiplier. @@ -512,7 +788,7 @@ the existing MSTraceGroup facility but more efficiently populated, especially when data records are in time order or the time series are very gappy. The MSTraceList related functions are prefixed - with "mstl_" and exist in the new source file tracelist.c. + with "mstl_" and exist in the new source file tracelist.c. - Add mst_printsynclist() and mstl_printsynclist() functions to print trace segment lists in SYNC format. @@ -543,7 +819,7 @@ 2008.163: - Allow data record sequence numbers to be NULL values in addition to ASCII numbers. - + 2008.161: 2.1.5 - Fix string parsing error for IRIS DMC packed files, thanks Sandy! - Use a merge sort algorithm insteam of the bubble sort previsouly @@ -570,7 +846,7 @@ 2007.178: 2.1.3 - Fix log message bug for unknown encoding format while unpacking, this could cause certain systems to segfault if encountered. - - Rename MS_UNPACKENCODINGFORMATFALLBACK macro to + - Rename MS_UNPACKENCODINGFORMATFALLBACK macro to MS_UNPACKENCODINGFALLBACK to match the actual variable name. - Fix handling of fallback encoding format in unpack.c, worked earlier but had regressed to a broken state. @@ -581,7 +857,7 @@ in msr_pack_header_raw() when none is available in the passed MSRecord. Previously this could result in a subtle bug for systems where malloc'd memory is not zeroed. This would only have effected - programs that were creating Mini-SEED in a particular way. + programs that were creating miniSEED in a particular way. 2007.138: 2.1.1 - Create LMP_BSD platform definition to cover the BSDs including @@ -612,10 +888,10 @@ order override variables: MS_PACKHEADERBYTEORDER(X), MS_PACKDATABYTEORDER(X), MS_UNPACKHEADERBYTEORDER(X) and MS_UNPACKDATABYTEORDER(X). - - Add macros for setting the unpack encoding format override and + - Add macros for setting the unpack encoding format override and encoding format fallback variables: MS_UNPACKENCODINGFORMAT(X) and MS_UNPACKENCODINGFORMATFALLBACK(X). - + 2007.074: - Fix typos in the docs referring to msr_readtraces() that should be ms_readtraces(), thanks Richard Boaz. @@ -680,7 +956,7 @@ - Add source name to all packing error and diagnostic messages. - Reorganize sanity check code in msr_unpack() to use the MS_ISVALIDHEADER macro. - - Add ms_recsrcname() function to calculate the source name for + - Add ms_recsrcname() function to calculate the source name for an unpacked record. 2006.326: 2.0pre6 @@ -693,7 +969,7 @@ constitutes a new logging facility that is used throughout the library and can be used by libmseed based programs. The facility allows the caller to redirect all the log, diagnostic and error - output from the library to specific functions. The facility + output from the library to specific functions. The facility also allows user specifed prefixes for all output messages. 2006.321: @@ -721,7 +997,7 @@ unsupported encoding error message. 2006.296: 2.0pre3 - - Add 'quality' flag argument to mst_srcname() to control the + - Add 'quality' flag argument to mst_srcname() to control the addition of the quality indicator in the srcname. - Add 'quality' flag argument to mst_groupsort() to control the inclusion of quality indicator in the sorting. @@ -738,13 +1014,13 @@ - Fix dynamic target and update API version in Makefile. - Require GCC for shared and dynamic library building. - Include ctype.h header in lmplatform.h for WIN32 platform. - + 2006.283: - Add function msr_normalize_header() to update the FSDH and blockettes with values at the MSRecord level. - Add 'normalize' flag argument to msr_pack_header() control the calling of msr_normalize_header() when packing. - - Change the MSRecord element 'private' to 'prvtptr' to avoid + - Change the MSRecord element 'private' to 'prvtptr' to avoid collision with the C++ reserved word. - Add a 'quality' flag argument to msr_srcname() to control the addition of the quality indicator to the srcname. @@ -801,7 +1077,7 @@ - Changed return type of msr_unpack() to int. Function now returns status/error codes. - Changes to many internal functions to support the new unpacking - error code bubble. + error code bubble. - Removed the MSRecord.unpackerr element as it is now unneeded. - Found and fixed bug resulting in the assumption that all sample sizes were 8 bytes (which would usually be wrong) during unpacking. @@ -866,7 +1142,7 @@ srcname if it is non-zero. - Remove the data quality code specifics from mst_print* functions as it is now included in the source name. - + 2006.076: version 1.5 - No changes, just stamp 1.5. @@ -886,11 +1162,11 @@ mst_findadjacent() to control matching of data qualities. - Modify mst_printtracelist() and mst_printgaplist() to include data quality flags in their output when they have been set. - + 2005.336: 1.4.5 - Improve the data record verification in ms_find_reclen() to improve the detection of non-data versus data records. In - particular the routine now requires a record to start with + particular the routine now requires a record to start with 6 ASCII digits followed by a valid data record indicator followed by either a space or NULL character (even though a NULL here is not valid SEED). @@ -922,7 +1198,7 @@ pack has been done). - Do not try to pack Traces with numsamples==0 in mst_packgroup(). - + 2005.289: - Add check for sample count mismatch and decrement mst->samplecnt when packing in mst_pack(). @@ -939,16 +1215,16 @@ - Test using Open Watcom 1.3 under Win32 (Windows XP). - Add 'dynamic' target in Makefile to build a dynamic lib on Mac OSX. - + 2005.269: 1.2 - Update many unpacking routines so that the MS_SAMPMISMATCH error code is correctly returned and that none of the errors - are show stoppers, it is left to the application to decide. + are show stoppers, it is left to the application to decide. - Remove error message when read fails during detection, the end of the file is simply that, no error. - Fix definition of MS_EPOCH2HPTIME and MS_HPTIME2EPOCH in ms_time.3 man page. - - Change int64_t types to hptime_t types in documentation. + - Change int64_t types to hptime_t types in documentation. 2005.203: 1.1 - Add 'chainpos' argument to msr_addblockette() to control @@ -1025,7 +1301,7 @@ 2005.091: 0.9.9 - Fix printing of Blockette 500. - Change macro defines to upper case macro names. - + 2005.080: 0.9.8 - Add ms_isratetolerable() macro to perform the default sample rate tolerance check. Update appropriate functions. @@ -1050,7 +1326,7 @@ for a valid data record header indicator (D,R,Q,etc.) - Example program msi now takes -min and -max options to specify min and max gap/overlap to display in gap list. - + 2005.047: 0.9.6 - Add ms_epoch2hptime() macro to convert Unix/POSIX epoch times to hptimes. diff --git a/libmseed/INSTALL.md b/libmseed/INSTALL.md index 5d1af58..32145f4 100644 --- a/libmseed/INSTALL.md +++ b/libmseed/INSTALL.md @@ -5,32 +5,44 @@ and their unsigned counterpart types. ## Unix, Linux, macOS -A simple 'make' on most Unix-like systems should build the library. +A simple `make` on most Unix-like systems should build the library. The included Makefile should work for most Unix-like environments and -most make variants. It is know to work with GNU make, which, if not the -default, is sometimes installed as gmake. +many make variants. It is known to work with GNU make, which, if not the +default, is sometimes installed as `gmake`. -The CC, CFLAGS, LDFLAGS and CPPFLAGS environment variables can be set +The `CC`, `CFLAGS`, `LDFLAGS` and `CPPFLAGS` environment variables can be set to control the build. -By default a statically linked version of the library is built: 'libmseed.a'. +If the **LIBMSEED_URL** variable is defined during the build, the library will +be compiled with support for reading from URLs. Currently, this support requires +that [libcurl](https://curl.haxx.se/) be installed on the target system. + +The simplest way to build the library with URL support is to include `-DLIMSEED_URL` +in the CFLAGS environment variable. Or invoking the build as such: + +``` +CFLAGS+=" -DLIBMSEED_URL" make +``` + +By default a statically linked version of the library is built: **libmseed.a**, +with an accompanying header **libmseed.h**. With GCC, clang or compatible build tools it is possible to build a shared -library with 'make shared'. +library with `make shared`. A simple install method for the shared library can be invoked with -'make install'. By default the installation destination is /usr/local. -The install destination may be specified using the PREFIX variable, for +`make install`. By default the installation destination is /usr/local. +The install destination may be specified using the **PREFIX** variable, for example: +``` make install PREFIX=/path/to/install/ +``` -## Windows (Win32) +## Windows -On a WIN32 platform the library can be compiled by using the -Nmake compatible Makefile.win (e.g. 'nmake -f Makefile.win') or Open -Watcom's Wmake with Makefile.wat (e.g. 'wmake -f Makefile.wat'). The -default target is a static library 'libmseed.lib'. The library has -been tested with Open Watcom 1.8. A libmseed.def file is included -for use building and linking a DLL. +On a Windows platform the library can be compiled by using the +NMake compatible Makefile.win (e.g. 'nmake -f Makefile.win'). +The default target is a static library 'libmseed.lib'. +A libmseed.def file is included for use building and linking a DLL. diff --git a/libmseed/LICENSE b/libmseed/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/libmseed/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/libmseed/LICENSE.txt b/libmseed/LICENSE.txt deleted file mode 100644 index fd42cd2..0000000 --- a/libmseed/LICENSE.txt +++ /dev/null @@ -1,847 +0,0 @@ -libmseed is licensed under the LGPL v3.0, i.e. it is licensed with the GPL v3.0 -and the additional set of permissions granted by the LGPL v3.0 license. This -file contains both licenses. - - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. - - - - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/libmseed/Makefile b/libmseed/Makefile index 2a11fff..ef0fd1e 100644 --- a/libmseed/Makefile +++ b/libmseed/Makefile @@ -21,60 +21,70 @@ DOCDIR ?= $(DATAROOTDIR)/doc/libmseed MANDIR ?= $(DATAROOTDIR)/man MAN3DIR ?= $(MANDIR)/man3 -LIB_SRCS = fileutils.c genutils.c gswap.c lmplatform.c lookup.c \ - msrutils.c pack.c packdata.c traceutils.c tracelist.c \ +LIB_SRCS = fileutils.c genutils.c msio.c lookup.c yyjson.c msrutils.c \ + extraheaders.c pack.c packdata.c tracelist.c gmtime64.c crc32c.c \ parseutils.c unpack.c unpackdata.c selection.c logging.c LIB_OBJS = $(LIB_SRCS:.c=.o) -LIB_DOBJS = $(LIB_SRCS:.c=.lo) +LIB_LOBJS = $(LIB_SRCS:.c=.lo) -LIB_A = libmseed.a -LIB_SO_BASE = libmseed.so -LIB_SO_NAME = $(LIB_SO_BASE).$(MAJOR_VER) -LIB_SO = $(LIB_SO_BASE).$(FULL_VER) -LIB_DYN_NAME = libmseed.dylib -LIB_DYN = libmseed.$(FULL_VER).dylib -LIB_FILES = Blarg +LIB_NAME = libmseed +LIB_A = $(LIB_NAME).a -all: static - -static: $(LIB_A) +OS := $(shell uname -s) # Build dynamic (.dylib) on macOS/Darwin, otherwise shared (.so) -shared dynamic: -ifeq ($(shell uname -s),Darwin) - $(MAKE) $(LIB_DYN) +ifeq ($(OS), Darwin) + LIB_SO_BASE = $(LIB_NAME).dylib + LIB_SO_MAJOR = $(LIB_NAME).$(MAJOR_VER).dylib + LIB_SO = $(LIB_NAME).$(FULL_VER).dylib + LIB_OPTS = -dynamiclib -compatibility_version $(COMPAT_VER) -current_version $(FULL_VER) -install_name $(LIB_SO) else - $(MAKE) $(LIB_SO) + LIB_SO_BASE = $(LIB_NAME).so + LIB_SO_MAJOR = $(LIB_NAME).so.$(MAJOR_VER) + LIB_SO = $(LIB_NAME).so.$(FULL_VER) + LIB_OPTS = -shared -Wl,--version-script=libmseed.map -Wl,-soname,$(LIB_SO_MAJOR) +endif + +# Automatically configure LDFLAGS for URL support if requested and libcurl is available +# Test for LIBMSEED_URL in CFLAGS, then if curl-config is available, implying libcurl is available +ifneq (,$(findstring LIBMSEED_URL,$(CFLAGS))) + ifneq (,$(shell command -v curl-config;)) + export LM_CURL_VERSION=$(shell curl-config --version) + export LDLIBS:=$(LDLIBS) $(shell curl-config --libs) + endif endif +all: static + +static: $(LIB_A) + +shared dynamic: $(LIB_SO) + # Build static library $(LIB_A): $(LIB_OBJS) @echo "Building static library $(LIB_A)" $(RM) -f $(LIB_A) $(AR) -crs $(LIB_A) $(LIB_OBJS) -# Build shared library using GCC-style options -$(LIB_SO): $(LIB_DOBJS) +# Build shared/dynamic library +$(LIB_SO): $(LIB_LOBJS) @echo "Building shared library $(LIB_SO)" - $(RM) -f $(LIB_SO) $(LIB_SONAME) $(LIB_SO_BASE) - $(CC) $(CFLAGS) $(LDFLAGS) -shared -Wl,--version-script=libmseed.map -Wl,-soname,$(LIB_SO_NAME) -o $(LIB_SO) $(LIB_DOBJS) + $(RM) -f $(LIB_SO) $(LIB_SO_MAJOR) $(LIB_SO_BASE) + $(CC) $(CFLAGS) $(LDFLAGS) $(LDLIBS) $(LIB_OPTS) -o $(LIB_SO) $(LIB_LOBJS) ln -s $(LIB_SO) $(LIB_SO_BASE) - ln -s $(LIB_SO) $(LIB_SO_NAME) - -# Build dynamic library (usually for macOS) -$(LIB_DYN): $(LIB_DOBJS) - @echo "Building dynamic library $(LIB_DYN)" - $(RM) -f $(LIB_DYN) $(LIB_DYN_NAME) - $(CC) $(CFLAGS) -dynamiclib -compatibility_version $(COMPAT_VER) -current_version $(FULL_VER) -install_name $(LIB_DYN_NAME) -o $(LIB_DYN) $(LIB_DOBJS) - ln -sf $(LIB_DYN) $(LIB_DYN_NAME) + ln -s $(LIB_SO) $(LIB_SO_MAJOR) test check: static FORCE @$(MAKE) -C test test +example: static FORCE + @$(MAKE) -C example + clean: - @$(RM) -f $(LIB_OBJS) $(LIB_DOBJS) $(LIB_A) $(LIB_SO) $(LIB_SO_NAME) $(LIB_SO_BASE) $(LIB_DYN) $(LIB_DYN_NAME) + @$(RM) $(LIB_OBJS) $(LIB_LOBJS) $(LIB_A) $(LIB_SO) $(LIB_SO_MAJOR) $(LIB_SO_BASE) @$(MAKE) -C test clean + @$(MAKE) -C example clean @echo "All clean." install: shared @@ -82,25 +92,15 @@ install: shared @mkdir -p $(DESTDIR)$(PREFIX)/include @cp libmseed.h $(DESTDIR)$(PREFIX)/include @mkdir -p $(DESTDIR)$(LIBDIR)/pkgconfig -ifneq ("$(wildcard $(LIB_SO))","") - @cp -a $(LIB_SO_BASE) $(LIB_SO_NAME) $(LIB_SO) $(DESTDIR)$(LIBDIR) -endif -ifneq ("$(wildcard $(LIB_DYN))","") - @cp -a $(LIB_DYN_NAME) $(LIB_DYN) $(DESTDIR)$(LIBDIR) -endif - @sed -e 's|@prefix@|$(PREFIX)|g' \ - -e 's|@exec_prefix@|$(EXEC_PREFIX)|g' \ - -e 's|@libdir@|$(LIBDIR)|g' \ - -e 's|@includedir@|$(PREFIX)/include|g' \ - -e 's|@PACKAGE_NAME@|libmseed|g' \ - -e 's|@PACKAGE_URL@|http://ds.iris.edu/ds/nodes/dmc/software/downloads/libmseed/|g' \ + @cp -a $(LIB_SO_BASE) $(LIB_SO_MAJOR) $(LIB_SO_NAME) $(LIB_SO) $(DESTDIR)$(LIBDIR) + @sed -e 's|@PREFIX@|$(PREFIX)|g' \ + -e 's|@EXEC_PREFIX@|$(EXEC_PREFIX)|g' \ + -e 's|@LIBDIR@|$(LIBDIR)|g' \ + -e 's|@INCLUDEDIR@|$(PREFIX)/include|g' \ -e 's|@VERSION@|$(FULL_VER)|g' \ mseed.pc.in > $(DESTDIR)$(LIBDIR)/pkgconfig/mseed.pc @mkdir -p $(DESTDIR)$(DOCDIR)/example @cp -r example $(DESTDIR)$(DOCDIR)/ - @cp doc/libmseed-UsersGuide $(DESTDIR)$(DOCDIR)/ - @mkdir -p $(DESTDIR)$(MAN3DIR) - @cp -a doc/ms*.3 $(DESTDIR)$(MAN3DIR)/ .SUFFIXES: .c .o .lo @@ -108,8 +108,12 @@ endif .c.o: $(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@ -# Standard object building for dynamic library components using -fPIC +# Standard object building for shared library using -fPIC .c.lo: $(CC) $(CPPFLAGS) $(CFLAGS) -fPIC -c $< -o $@ +# Print Makefile expanded variables, e.g. % make print-LIB_SO +print-%: + @echo '$*=$($*)' + FORCE: diff --git a/libmseed/Makefile.wat b/libmseed/Makefile.wat deleted file mode 100644 index 7271dc7..0000000 --- a/libmseed/Makefile.wat +++ /dev/null @@ -1,71 +0,0 @@ -# -# -# Wmake File For libmseed - For Watcom's wmake -# Use 'wmake -f Makefile.wat' - -.BEFORE - @set INCLUDE=.;$(%watcom)\H;$(%watcom)\H\NT - @set LIB=.;$(%watcom)\LIB386 - -cc = wcc386 -cflags = -zq -lflags = OPT quiet OPT map -cvars = $+$(cvars)$- -DWIN32 - -# To build a DLL uncomment the following two lines -#cflags = -zq -bd -#lflags = OPT quiet OPT map SYS nt_dll - -LIB = libmseed.lib -DLL = libmseed.dll - -INCS = -I. - -OBJS= fileutils.obj & - genutils.obj & - gswap.obj & - lmplatform.obj & - lookup.obj & - msrutils.obj & - pack.obj & - packdata.obj & - traceutils.obj & - tracelist.obj & - parseutils.obj & - unpack.obj & - unpackdata.obj & - selection.obj & - logging.obj - -all: lib - -lib: $(OBJS) .SYMBOLIC - wlib -b -n -c -q $(LIB) +$(OBJS) - -dll: $(OBJS) .SYMBOLIC - wlink $(lflags) name libmseed file {$(OBJS)} - -# Source dependencies: -fileutils.obj: fileutils.c libmseed.h -genutils.obj: genutils.c libmseed.h -gswap.obj: gswap.c libmseed.h -lmplatform.obj: lmplatform.c libmseed.h -lookup.obj: lookup.c libmseed.h -msrutils.obj: msrutils.c libmseed.h -pack.obj: pack.c libmseed.h packdata.h -packdata.obj: packdata.c libmseed.h packdata.h -traceutils.obj: traceutils.c libmseed.h -tracelist.obj: tracelist.c libmseed.h -parseutils.obj: parseutils.c libmseed.h -unpack.obj: unpack.c libmseed.h unpackdata.h -unpackdata.obj: unpackdata.c libmseed.h unpackdata.h -logging.obj: logging.c libmseed.h - -# How to compile sources: -.c.obj: - $(cc) $(cflags) $(cvars) $(INCS) $[@ -fo=$@ - -# Clean-up directives: -clean: .SYMBOLIC - del *.obj *.map - del $(LIB) $(DLL) diff --git a/libmseed/Makefile.win b/libmseed/Makefile.win index a7e9409..76cfed3 100644 --- a/libmseed/Makefile.win +++ b/libmseed/Makefile.win @@ -1,41 +1,49 @@ # -# Nmake file For libmseed - MS Visual C/C++ version +# Nmake file for libmseed - MS Visual C/C++ # Use 'nmake -f Makefile.win' NODEBUG=1 -INCS = -I. -OPTS = -D_CRT_SECURE_NO_WARNINGS -LIB = libmseed.lib -DLL = libmseed.dll - -OBJS= fileutils.obj \ - genutils.obj \ - gswap.obj \ - lmplatform.obj \ - lookup.obj \ - msrutils.obj \ - pack.obj \ - packdata.obj \ - traceutils.obj \ - tracelist.obj \ - parseutils.obj \ - unpack.obj \ - unpackdata.obj \ - selection.obj \ - logging.obj +INCS = /I. +OPTS = /O2 /D_CRT_SECURE_NO_WARNINGS +LM_LIB = libmseed.lib +LM_DLL = libmseed.dll +LM_DEF = libmseed.def + +OBJS = fileutils.obj \ + genutils.obj \ + msio.obj \ + lookup.obj \ + yyjson.obj \ + msrutils.obj \ + extraheaders.obj\ + pack.obj \ + packdata.obj \ + tracelist.obj \ + gmtime64.obj \ + crc32c.obj \ + parseutils.obj \ + unpack.obj \ + unpackdata.obj \ + selection.obj \ + logging.obj all: lib lib: $(OBJS) - link.exe /lib /nologo /out:$(LIB) $(OBJS) + link.exe /lib /nologo /OUT:$(LM_LIB) $(OBJS) dll: $(OBJS) - link.exe /dll /nologo /out:$(DLL) $(OBJS) + link.exe /dll /nologo /OUT:$(LM_DLL) $(OBJS) .c.obj: $(CC) /nologo $(CFLAGS) $(INCS) $(OPTS) /c $< +# Run test suite +test: lib + pushd $@ && $(MAKE) /NOLOGO /f Makefile.win /$(MAKEFLAGS) & popd + # Clean-up directives clean: - -del a.out core *.o *.obj *% *~ $(LIB) $(DLL) + -del a.out core *.o *.obj *% *~ libmseed.exp $(LM_LIB) $(LM_DLL) + @pushd test && $(MAKE) /NOLOGO /f Makefile.win $@ /$(MAKEFLAGS) & popd diff --git a/libmseed/README.byteorder b/libmseed/README.byteorder index 5cfdce5..98bd12a 100644 --- a/libmseed/README.byteorder +++ b/libmseed/README.byteorder @@ -1,61 +1,25 @@ -- Byte order handling in libmseed -- -The SEED 2.4 standard allows data only SEED (Mini-SEED) to be either -in big (most significant byte first) or little (least significant byte -first) endian byte order. One exception is that Steim-1 and Steim-2 -data compression are only defined as big-endian, that said libmseed -supports little-endian Steim compression schemes anyway. While -libmseed supports all four combinations of big and little endian header -and data the surest way to avoid compatibility problems is to always -create big endian Mini-SEED records (header and data). - - -Reading MiniSEED - how libmseed determines the byte order of a record: - -The byte order of a record header including blockettes is determined -by checking if the record start year and day is a sane value (e.g. year -between 1900 and 2100 and day between 1 and 366). The byte order of -encoded data samples is determined by the byte order flag in the -Blockette 1000, if a Blockette 1000 is not present the byte order is -assumed to be the same as the header. To force the byte order -determination of either the header or data section of a record the -following environment variables can be set: - -UNPACK_HEADER_BYTEORDER -UNPACK_DATA_BYTEORDER - -These variables should be set to either 0 (little endian) or 1 (big -endian). A programmatic equivalent of setting these environment -variables is provided via the following macros: +The miniSEED 3 format is defined as little-endian headers with the +endianess of the data payload explicitly defined by the encoding +value. -MS_UNPACKHEADERBYTEORDER(X) -MS_UNPACKDATABYTEORDER(X) - - -Writing MiniSEED - in what byte order libmseed creates records: - -Normally the byte order of MiniSEED created by libmseed is controlled -via a flag in the API. This byte order flag determines the ordering -for both the header and data sections of a record. To force the byte -order of either the header or data section of a record the following -environment variables can be set: - -PACK_HEADER_BYTEORDER -PACK_DATA_BYTEORDER +The SEED 2.4 standard allows data only SEED (miniSEED) to be either in +big (most significant byte first) or little (least significant byte +first) endian byte order. One exception is that Steim-1 and Steim-2 +data compression are only defined as big-endian. -These variables should be set to either 0 (little endian) or 1 (big -endian). A programmatic equivalent of setting these environment -variables is provided via the following macros: +How libmseed determines the byte order of a 2.x record: -MS_PACKHEADERBYTEORDER(X) -MS_PACKDATABYTEORDER(X) +The byte order of a miniSEED 2.x record header including blockettes is +determined by checking if the record start year and day is a sane +value (e.g. year between 1900 and 2100 and day between 1 and 366). +The byte order of encoded data samples is determined by the byte order +flag in the Blockette 1000, if a Blockette 1000 is not present the +byte order is assumed to be the same as the header. +In what byte order libmseed creates 2.x records: -Note that some interpretations of the SEED 2.4 format imply that -so-called little endian MiniSEED means that the record header is -little endian but that the data section is big endian (as the only -defined data encodings must be based on the SEED DDL which, in turn, -must be defined in terms of big endian). Libmseed will not create -MiniSEED of this flavor by default but can be configured to do so by -setting the environment variables described above appropriately. +If the library ever creates miniSEED 2.x records, they will be in +big-endian byte order for maximum compatibility. diff --git a/libmseed/README.md b/libmseed/README.md index 7324df4..9d046b9 100644 --- a/libmseed/README.md +++ b/libmseed/README.md @@ -1,60 +1,32 @@ -# libmseed - The Mini-SEED library +# libmseed - The miniSEED library -The Mini-SEED library provides a framework for manipulation of SEED -data records including the unpacking and packing of data records. -Functionality is also included for managing waveform data as -continuous traces. +The miniSEED library provides a framework for manipulation of SEED +data records, a format for commonly used for seismological time series +and related data. The library includes the functionality to read and +write data records, in addition to reconstructing time series from +multiple records. -All structures of SEED 2.4 data records are supported with the -following exceptions: Blockette 2000 opaque data which has an unknown -data structure by definition and Blockette 405 which depends on full -SEED (SEED including full ASCII headers) for a full data description. - -The library should work in Linux, BSD (and derivatives like macOS), -Solaris and Win32 environments. +The library should work in Unix-like, Windows and potentially other +environments. ## Documentation -The [Wiki](https://github.com/iris-edu/libmseed/wiki) provides an -overview of using the library. For function level documentation, -man pages are included in the [doc](doc) directory. - -## Downloading and installing - -The [releases](https://github.com/iris-edu/libmseed/releases) area -contains release versions. - -For installation instructions see the [INSTALL](INSTALL.md) file. -For further information regarding the library interface see the -documentation in the 'doc' directory. For example uses of libmseed -see the source code in the 'examples' directory. +The [Documentation](https://earthscope.github.io/libmseed) provides an +overview of using the library, a tutorial and function level details. ## License -Copyright (C) 2016 Chad Trabant, IRIS Data Management Center - -This library is free software; you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License as -published by the Free Software Foundation; either version 3 of the -License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License (GNU-LGPL) for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this software. -If not, see . - -## Acknowlegements +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at -Numerous improvements have been incorporated based on feedback and -patches submitted by others. Individual acknowlegements are included -in the ChangeLog. +[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) -This library also uses code bits published in the public domain and -acknowledgement is included in the code whenever possible. +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. -With software provided by http://2038bug.com/ (site offline, checked Oct. 2017) +Copyright (C) 2023 Chad Trabant, EarthScope Data Services diff --git a/libmseed/crc32c.c b/libmseed/crc32c.c new file mode 100644 index 0000000..d553409 --- /dev/null +++ b/libmseed/crc32c.c @@ -0,0 +1,410 @@ +/*************************************************************************** + * CRC-32C calculation routines, clean and simple. Orignal file was named + * 'crc_sw.c' and found at: https://github.com/awslabs/aws-checksums + * + * All copyrights and license notifications have been retained. + * Unecessary routines have been removed for use in this code base. + ***************************************************************************/ + +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include "libmseed.h" + +/* The Castagnoli, iSCSI CRC32c polynomial (reverse of 0x1EDC6F41) */ +#define CRC32C_POLYNOMIAL 0x82F63B78 + +/** Castagnoli CRC32c (iSCSI) lookup table for slice-by-4/8/16 */ +/* Table truncated to 8 top-level tables from original, slice-by-16 is not supported in this code */ +const uint32_t CRC32C_TABLE[8][256] = { + { + 0x00000000, 0xF26B8303, 0xE13B70F7, 0x1350F3F4, 0xC79A971F, 0x35F1141C, 0x26A1E7E8, 0xD4CA64EB, // [0][0x08] + 0x8AD958CF, 0x78B2DBCC, 0x6BE22838, 0x9989AB3B, 0x4D43CFD0, 0xBF284CD3, 0xAC78BF27, 0x5E133C24, // [0][0x10] + 0x105EC76F, 0xE235446C, 0xF165B798, 0x030E349B, 0xD7C45070, 0x25AFD373, 0x36FF2087, 0xC494A384, // [0][0x18] + 0x9A879FA0, 0x68EC1CA3, 0x7BBCEF57, 0x89D76C54, 0x5D1D08BF, 0xAF768BBC, 0xBC267848, 0x4E4DFB4B, // [0][0x20] + 0x20BD8EDE, 0xD2D60DDD, 0xC186FE29, 0x33ED7D2A, 0xE72719C1, 0x154C9AC2, 0x061C6936, 0xF477EA35, // [0][0x28] + 0xAA64D611, 0x580F5512, 0x4B5FA6E6, 0xB93425E5, 0x6DFE410E, 0x9F95C20D, 0x8CC531F9, 0x7EAEB2FA, // [0][0x30] + 0x30E349B1, 0xC288CAB2, 0xD1D83946, 0x23B3BA45, 0xF779DEAE, 0x05125DAD, 0x1642AE59, 0xE4292D5A, // [0][0x38] + 0xBA3A117E, 0x4851927D, 0x5B016189, 0xA96AE28A, 0x7DA08661, 0x8FCB0562, 0x9C9BF696, 0x6EF07595, // [0][0x40] + 0x417B1DBC, 0xB3109EBF, 0xA0406D4B, 0x522BEE48, 0x86E18AA3, 0x748A09A0, 0x67DAFA54, 0x95B17957, // [0][0x48] + 0xCBA24573, 0x39C9C670, 0x2A993584, 0xD8F2B687, 0x0C38D26C, 0xFE53516F, 0xED03A29B, 0x1F682198, // [0][0x50] + 0x5125DAD3, 0xA34E59D0, 0xB01EAA24, 0x42752927, 0x96BF4DCC, 0x64D4CECF, 0x77843D3B, 0x85EFBE38, // [0][0x58] + 0xDBFC821C, 0x2997011F, 0x3AC7F2EB, 0xC8AC71E8, 0x1C661503, 0xEE0D9600, 0xFD5D65F4, 0x0F36E6F7, // [0][0x60] + 0x61C69362, 0x93AD1061, 0x80FDE395, 0x72966096, 0xA65C047D, 0x5437877E, 0x4767748A, 0xB50CF789, // [0][0x68] + 0xEB1FCBAD, 0x197448AE, 0x0A24BB5A, 0xF84F3859, 0x2C855CB2, 0xDEEEDFB1, 0xCDBE2C45, 0x3FD5AF46, // [0][0x70] + 0x7198540D, 0x83F3D70E, 0x90A324FA, 0x62C8A7F9, 0xB602C312, 0x44694011, 0x5739B3E5, 0xA55230E6, // [0][0x78] + 0xFB410CC2, 0x092A8FC1, 0x1A7A7C35, 0xE811FF36, 0x3CDB9BDD, 0xCEB018DE, 0xDDE0EB2A, 0x2F8B6829, // [0][0x80] + 0x82F63B78, 0x709DB87B, 0x63CD4B8F, 0x91A6C88C, 0x456CAC67, 0xB7072F64, 0xA457DC90, 0x563C5F93, // [0][0x88] + 0x082F63B7, 0xFA44E0B4, 0xE9141340, 0x1B7F9043, 0xCFB5F4A8, 0x3DDE77AB, 0x2E8E845F, 0xDCE5075C, // [0][0x90] + 0x92A8FC17, 0x60C37F14, 0x73938CE0, 0x81F80FE3, 0x55326B08, 0xA759E80B, 0xB4091BFF, 0x466298FC, // [0][0x98] + 0x1871A4D8, 0xEA1A27DB, 0xF94AD42F, 0x0B21572C, 0xDFEB33C7, 0x2D80B0C4, 0x3ED04330, 0xCCBBC033, // [0][0xa0] + 0xA24BB5A6, 0x502036A5, 0x4370C551, 0xB11B4652, 0x65D122B9, 0x97BAA1BA, 0x84EA524E, 0x7681D14D, // [0][0xa8] + 0x2892ED69, 0xDAF96E6A, 0xC9A99D9E, 0x3BC21E9D, 0xEF087A76, 0x1D63F975, 0x0E330A81, 0xFC588982, // [0][0xb0] + 0xB21572C9, 0x407EF1CA, 0x532E023E, 0xA145813D, 0x758FE5D6, 0x87E466D5, 0x94B49521, 0x66DF1622, // [0][0xb8] + 0x38CC2A06, 0xCAA7A905, 0xD9F75AF1, 0x2B9CD9F2, 0xFF56BD19, 0x0D3D3E1A, 0x1E6DCDEE, 0xEC064EED, // [0][0xc0] + 0xC38D26C4, 0x31E6A5C7, 0x22B65633, 0xD0DDD530, 0x0417B1DB, 0xF67C32D8, 0xE52CC12C, 0x1747422F, // [0][0xc8] + 0x49547E0B, 0xBB3FFD08, 0xA86F0EFC, 0x5A048DFF, 0x8ECEE914, 0x7CA56A17, 0x6FF599E3, 0x9D9E1AE0, // [0][0xd0] + 0xD3D3E1AB, 0x21B862A8, 0x32E8915C, 0xC083125F, 0x144976B4, 0xE622F5B7, 0xF5720643, 0x07198540, // [0][0xd8] + 0x590AB964, 0xAB613A67, 0xB831C993, 0x4A5A4A90, 0x9E902E7B, 0x6CFBAD78, 0x7FAB5E8C, 0x8DC0DD8F, // [0][0xe0] + 0xE330A81A, 0x115B2B19, 0x020BD8ED, 0xF0605BEE, 0x24AA3F05, 0xD6C1BC06, 0xC5914FF2, 0x37FACCF1, // [0][0xe8] + 0x69E9F0D5, 0x9B8273D6, 0x88D28022, 0x7AB90321, 0xAE7367CA, 0x5C18E4C9, 0x4F48173D, 0xBD23943E, // [0][0xf0] + 0xF36E6F75, 0x0105EC76, 0x12551F82, 0xE03E9C81, 0x34F4F86A, 0xC69F7B69, 0xD5CF889D, 0x27A40B9E, // [0][0xf8] + 0x79B737BA, 0x8BDCB4B9, 0x988C474D, 0x6AE7C44E, 0xBE2DA0A5, 0x4C4623A6, 0x5F16D052, 0xAD7D5351 // [0][0x100] + }, + { + 0x00000000, 0x13A29877, 0x274530EE, 0x34E7A899, 0x4E8A61DC, 0x5D28F9AB, 0x69CF5132, 0x7A6DC945, // [1][0x08] + 0x9D14C3B8, 0x8EB65BCF, 0xBA51F356, 0xA9F36B21, 0xD39EA264, 0xC03C3A13, 0xF4DB928A, 0xE7790AFD, // [1][0x10] + 0x3FC5F181, 0x2C6769F6, 0x1880C16F, 0x0B225918, 0x714F905D, 0x62ED082A, 0x560AA0B3, 0x45A838C4, // [1][0x18] + 0xA2D13239, 0xB173AA4E, 0x859402D7, 0x96369AA0, 0xEC5B53E5, 0xFFF9CB92, 0xCB1E630B, 0xD8BCFB7C, // [1][0x20] + 0x7F8BE302, 0x6C297B75, 0x58CED3EC, 0x4B6C4B9B, 0x310182DE, 0x22A31AA9, 0x1644B230, 0x05E62A47, // [1][0x28] + 0xE29F20BA, 0xF13DB8CD, 0xC5DA1054, 0xD6788823, 0xAC154166, 0xBFB7D911, 0x8B507188, 0x98F2E9FF, // [1][0x30] + 0x404E1283, 0x53EC8AF4, 0x670B226D, 0x74A9BA1A, 0x0EC4735F, 0x1D66EB28, 0x298143B1, 0x3A23DBC6, // [1][0x38] + 0xDD5AD13B, 0xCEF8494C, 0xFA1FE1D5, 0xE9BD79A2, 0x93D0B0E7, 0x80722890, 0xB4958009, 0xA737187E, // [1][0x40] + 0xFF17C604, 0xECB55E73, 0xD852F6EA, 0xCBF06E9D, 0xB19DA7D8, 0xA23F3FAF, 0x96D89736, 0x857A0F41, // [1][0x48] + 0x620305BC, 0x71A19DCB, 0x45463552, 0x56E4AD25, 0x2C896460, 0x3F2BFC17, 0x0BCC548E, 0x186ECCF9, // [1][0x50] + 0xC0D23785, 0xD370AFF2, 0xE797076B, 0xF4359F1C, 0x8E585659, 0x9DFACE2E, 0xA91D66B7, 0xBABFFEC0, // [1][0x58] + 0x5DC6F43D, 0x4E646C4A, 0x7A83C4D3, 0x69215CA4, 0x134C95E1, 0x00EE0D96, 0x3409A50F, 0x27AB3D78, // [1][0x60] + 0x809C2506, 0x933EBD71, 0xA7D915E8, 0xB47B8D9F, 0xCE1644DA, 0xDDB4DCAD, 0xE9537434, 0xFAF1EC43, // [1][0x68] + 0x1D88E6BE, 0x0E2A7EC9, 0x3ACDD650, 0x296F4E27, 0x53028762, 0x40A01F15, 0x7447B78C, 0x67E52FFB, // [1][0x70] + 0xBF59D487, 0xACFB4CF0, 0x981CE469, 0x8BBE7C1E, 0xF1D3B55B, 0xE2712D2C, 0xD69685B5, 0xC5341DC2, // [1][0x78] + 0x224D173F, 0x31EF8F48, 0x050827D1, 0x16AABFA6, 0x6CC776E3, 0x7F65EE94, 0x4B82460D, 0x5820DE7A, // [1][0x80] + 0xFBC3FAF9, 0xE861628E, 0xDC86CA17, 0xCF245260, 0xB5499B25, 0xA6EB0352, 0x920CABCB, 0x81AE33BC, // [1][0x88] + 0x66D73941, 0x7575A136, 0x419209AF, 0x523091D8, 0x285D589D, 0x3BFFC0EA, 0x0F186873, 0x1CBAF004, // [1][0x90] + 0xC4060B78, 0xD7A4930F, 0xE3433B96, 0xF0E1A3E1, 0x8A8C6AA4, 0x992EF2D3, 0xADC95A4A, 0xBE6BC23D, // [1][0x98] + 0x5912C8C0, 0x4AB050B7, 0x7E57F82E, 0x6DF56059, 0x1798A91C, 0x043A316B, 0x30DD99F2, 0x237F0185, // [1][0xa0] + 0x844819FB, 0x97EA818C, 0xA30D2915, 0xB0AFB162, 0xCAC27827, 0xD960E050, 0xED8748C9, 0xFE25D0BE, // [1][0xa8] + 0x195CDA43, 0x0AFE4234, 0x3E19EAAD, 0x2DBB72DA, 0x57D6BB9F, 0x447423E8, 0x70938B71, 0x63311306, // [1][0xb0] + 0xBB8DE87A, 0xA82F700D, 0x9CC8D894, 0x8F6A40E3, 0xF50789A6, 0xE6A511D1, 0xD242B948, 0xC1E0213F, // [1][0xb8] + 0x26992BC2, 0x353BB3B5, 0x01DC1B2C, 0x127E835B, 0x68134A1E, 0x7BB1D269, 0x4F567AF0, 0x5CF4E287, // [1][0xc0] + 0x04D43CFD, 0x1776A48A, 0x23910C13, 0x30339464, 0x4A5E5D21, 0x59FCC556, 0x6D1B6DCF, 0x7EB9F5B8, // [1][0xc8] + 0x99C0FF45, 0x8A626732, 0xBE85CFAB, 0xAD2757DC, 0xD74A9E99, 0xC4E806EE, 0xF00FAE77, 0xE3AD3600, // [1][0xd0] + 0x3B11CD7C, 0x28B3550B, 0x1C54FD92, 0x0FF665E5, 0x759BACA0, 0x663934D7, 0x52DE9C4E, 0x417C0439, // [1][0xd8] + 0xA6050EC4, 0xB5A796B3, 0x81403E2A, 0x92E2A65D, 0xE88F6F18, 0xFB2DF76F, 0xCFCA5FF6, 0xDC68C781, // [1][0xe0] + 0x7B5FDFFF, 0x68FD4788, 0x5C1AEF11, 0x4FB87766, 0x35D5BE23, 0x26772654, 0x12908ECD, 0x013216BA, // [1][0xe8] + 0xE64B1C47, 0xF5E98430, 0xC10E2CA9, 0xD2ACB4DE, 0xA8C17D9B, 0xBB63E5EC, 0x8F844D75, 0x9C26D502, // [1][0xf0] + 0x449A2E7E, 0x5738B609, 0x63DF1E90, 0x707D86E7, 0x0A104FA2, 0x19B2D7D5, 0x2D557F4C, 0x3EF7E73B, // [1][0xf8] + 0xD98EEDC6, 0xCA2C75B1, 0xFECBDD28, 0xED69455F, 0x97048C1A, 0x84A6146D, 0xB041BCF4, 0xA3E32483 // [1][0x100] + }, + { + 0x00000000, 0xA541927E, 0x4F6F520D, 0xEA2EC073, 0x9EDEA41A, 0x3B9F3664, 0xD1B1F617, 0x74F06469, // [2][0x08] + 0x38513EC5, 0x9D10ACBB, 0x773E6CC8, 0xD27FFEB6, 0xA68F9ADF, 0x03CE08A1, 0xE9E0C8D2, 0x4CA15AAC, // [2][0x10] + 0x70A27D8A, 0xD5E3EFF4, 0x3FCD2F87, 0x9A8CBDF9, 0xEE7CD990, 0x4B3D4BEE, 0xA1138B9D, 0x045219E3, // [2][0x18] + 0x48F3434F, 0xEDB2D131, 0x079C1142, 0xA2DD833C, 0xD62DE755, 0x736C752B, 0x9942B558, 0x3C032726, // [2][0x20] + 0xE144FB14, 0x4405696A, 0xAE2BA919, 0x0B6A3B67, 0x7F9A5F0E, 0xDADBCD70, 0x30F50D03, 0x95B49F7D, // [2][0x28] + 0xD915C5D1, 0x7C5457AF, 0x967A97DC, 0x333B05A2, 0x47CB61CB, 0xE28AF3B5, 0x08A433C6, 0xADE5A1B8, // [2][0x30] + 0x91E6869E, 0x34A714E0, 0xDE89D493, 0x7BC846ED, 0x0F382284, 0xAA79B0FA, 0x40577089, 0xE516E2F7, // [2][0x38] + 0xA9B7B85B, 0x0CF62A25, 0xE6D8EA56, 0x43997828, 0x37691C41, 0x92288E3F, 0x78064E4C, 0xDD47DC32, // [2][0x40] + 0xC76580D9, 0x622412A7, 0x880AD2D4, 0x2D4B40AA, 0x59BB24C3, 0xFCFAB6BD, 0x16D476CE, 0xB395E4B0, // [2][0x48] + 0xFF34BE1C, 0x5A752C62, 0xB05BEC11, 0x151A7E6F, 0x61EA1A06, 0xC4AB8878, 0x2E85480B, 0x8BC4DA75, // [2][0x50] + 0xB7C7FD53, 0x12866F2D, 0xF8A8AF5E, 0x5DE93D20, 0x29195949, 0x8C58CB37, 0x66760B44, 0xC337993A, // [2][0x58] + 0x8F96C396, 0x2AD751E8, 0xC0F9919B, 0x65B803E5, 0x1148678C, 0xB409F5F2, 0x5E273581, 0xFB66A7FF, // [2][0x60] + 0x26217BCD, 0x8360E9B3, 0x694E29C0, 0xCC0FBBBE, 0xB8FFDFD7, 0x1DBE4DA9, 0xF7908DDA, 0x52D11FA4, // [2][0x68] + 0x1E704508, 0xBB31D776, 0x511F1705, 0xF45E857B, 0x80AEE112, 0x25EF736C, 0xCFC1B31F, 0x6A802161, // [2][0x70] + 0x56830647, 0xF3C29439, 0x19EC544A, 0xBCADC634, 0xC85DA25D, 0x6D1C3023, 0x8732F050, 0x2273622E, // [2][0x78] + 0x6ED23882, 0xCB93AAFC, 0x21BD6A8F, 0x84FCF8F1, 0xF00C9C98, 0x554D0EE6, 0xBF63CE95, 0x1A225CEB, // [2][0x80] + 0x8B277743, 0x2E66E53D, 0xC448254E, 0x6109B730, 0x15F9D359, 0xB0B84127, 0x5A968154, 0xFFD7132A, // [2][0x88] + 0xB3764986, 0x1637DBF8, 0xFC191B8B, 0x595889F5, 0x2DA8ED9C, 0x88E97FE2, 0x62C7BF91, 0xC7862DEF, // [2][0x90] + 0xFB850AC9, 0x5EC498B7, 0xB4EA58C4, 0x11ABCABA, 0x655BAED3, 0xC01A3CAD, 0x2A34FCDE, 0x8F756EA0, // [2][0x98] + 0xC3D4340C, 0x6695A672, 0x8CBB6601, 0x29FAF47F, 0x5D0A9016, 0xF84B0268, 0x1265C21B, 0xB7245065, // [2][0xa0] + 0x6A638C57, 0xCF221E29, 0x250CDE5A, 0x804D4C24, 0xF4BD284D, 0x51FCBA33, 0xBBD27A40, 0x1E93E83E, // [2][0xa8] + 0x5232B292, 0xF77320EC, 0x1D5DE09F, 0xB81C72E1, 0xCCEC1688, 0x69AD84F6, 0x83834485, 0x26C2D6FB, // [2][0xb0] + 0x1AC1F1DD, 0xBF8063A3, 0x55AEA3D0, 0xF0EF31AE, 0x841F55C7, 0x215EC7B9, 0xCB7007CA, 0x6E3195B4, // [2][0xb8] + 0x2290CF18, 0x87D15D66, 0x6DFF9D15, 0xC8BE0F6B, 0xBC4E6B02, 0x190FF97C, 0xF321390F, 0x5660AB71, // [2][0xc0] + 0x4C42F79A, 0xE90365E4, 0x032DA597, 0xA66C37E9, 0xD29C5380, 0x77DDC1FE, 0x9DF3018D, 0x38B293F3, // [2][0xc8] + 0x7413C95F, 0xD1525B21, 0x3B7C9B52, 0x9E3D092C, 0xEACD6D45, 0x4F8CFF3B, 0xA5A23F48, 0x00E3AD36, // [2][0xd0] + 0x3CE08A10, 0x99A1186E, 0x738FD81D, 0xD6CE4A63, 0xA23E2E0A, 0x077FBC74, 0xED517C07, 0x4810EE79, // [2][0xd8] + 0x04B1B4D5, 0xA1F026AB, 0x4BDEE6D8, 0xEE9F74A6, 0x9A6F10CF, 0x3F2E82B1, 0xD50042C2, 0x7041D0BC, // [2][0xe0] + 0xAD060C8E, 0x08479EF0, 0xE2695E83, 0x4728CCFD, 0x33D8A894, 0x96993AEA, 0x7CB7FA99, 0xD9F668E7, // [2][0xe8] + 0x9557324B, 0x3016A035, 0xDA386046, 0x7F79F238, 0x0B899651, 0xAEC8042F, 0x44E6C45C, 0xE1A75622, // [2][0xf0] + 0xDDA47104, 0x78E5E37A, 0x92CB2309, 0x378AB177, 0x437AD51E, 0xE63B4760, 0x0C158713, 0xA954156D, // [2][0xf8] + 0xE5F54FC1, 0x40B4DDBF, 0xAA9A1DCC, 0x0FDB8FB2, 0x7B2BEBDB, 0xDE6A79A5, 0x3444B9D6, 0x91052BA8 // [2][0x100] + }, + { + 0x00000000, 0xDD45AAB8, 0xBF672381, 0x62228939, 0x7B2231F3, 0xA6679B4B, 0xC4451272, 0x1900B8CA, // [3][0x08] + 0xF64463E6, 0x2B01C95E, 0x49234067, 0x9466EADF, 0x8D665215, 0x5023F8AD, 0x32017194, 0xEF44DB2C, // [3][0x10] + 0xE964B13D, 0x34211B85, 0x560392BC, 0x8B463804, 0x924680CE, 0x4F032A76, 0x2D21A34F, 0xF06409F7, // [3][0x18] + 0x1F20D2DB, 0xC2657863, 0xA047F15A, 0x7D025BE2, 0x6402E328, 0xB9474990, 0xDB65C0A9, 0x06206A11, // [3][0x20] + 0xD725148B, 0x0A60BE33, 0x6842370A, 0xB5079DB2, 0xAC072578, 0x71428FC0, 0x136006F9, 0xCE25AC41, // [3][0x28] + 0x2161776D, 0xFC24DDD5, 0x9E0654EC, 0x4343FE54, 0x5A43469E, 0x8706EC26, 0xE524651F, 0x3861CFA7, // [3][0x30] + 0x3E41A5B6, 0xE3040F0E, 0x81268637, 0x5C632C8F, 0x45639445, 0x98263EFD, 0xFA04B7C4, 0x27411D7C, // [3][0x38] + 0xC805C650, 0x15406CE8, 0x7762E5D1, 0xAA274F69, 0xB327F7A3, 0x6E625D1B, 0x0C40D422, 0xD1057E9A, // [3][0x40] + 0xABA65FE7, 0x76E3F55F, 0x14C17C66, 0xC984D6DE, 0xD0846E14, 0x0DC1C4AC, 0x6FE34D95, 0xB2A6E72D, // [3][0x48] + 0x5DE23C01, 0x80A796B9, 0xE2851F80, 0x3FC0B538, 0x26C00DF2, 0xFB85A74A, 0x99A72E73, 0x44E284CB, // [3][0x50] + 0x42C2EEDA, 0x9F874462, 0xFDA5CD5B, 0x20E067E3, 0x39E0DF29, 0xE4A57591, 0x8687FCA8, 0x5BC25610, // [3][0x58] + 0xB4868D3C, 0x69C32784, 0x0BE1AEBD, 0xD6A40405, 0xCFA4BCCF, 0x12E11677, 0x70C39F4E, 0xAD8635F6, // [3][0x60] + 0x7C834B6C, 0xA1C6E1D4, 0xC3E468ED, 0x1EA1C255, 0x07A17A9F, 0xDAE4D027, 0xB8C6591E, 0x6583F3A6, // [3][0x68] + 0x8AC7288A, 0x57828232, 0x35A00B0B, 0xE8E5A1B3, 0xF1E51979, 0x2CA0B3C1, 0x4E823AF8, 0x93C79040, // [3][0x70] + 0x95E7FA51, 0x48A250E9, 0x2A80D9D0, 0xF7C57368, 0xEEC5CBA2, 0x3380611A, 0x51A2E823, 0x8CE7429B, // [3][0x78] + 0x63A399B7, 0xBEE6330F, 0xDCC4BA36, 0x0181108E, 0x1881A844, 0xC5C402FC, 0xA7E68BC5, 0x7AA3217D, // [3][0x80] + 0x52A0C93F, 0x8FE56387, 0xEDC7EABE, 0x30824006, 0x2982F8CC, 0xF4C75274, 0x96E5DB4D, 0x4BA071F5, // [3][0x88] + 0xA4E4AAD9, 0x79A10061, 0x1B838958, 0xC6C623E0, 0xDFC69B2A, 0x02833192, 0x60A1B8AB, 0xBDE41213, // [3][0x90] + 0xBBC47802, 0x6681D2BA, 0x04A35B83, 0xD9E6F13B, 0xC0E649F1, 0x1DA3E349, 0x7F816A70, 0xA2C4C0C8, // [3][0x98] + 0x4D801BE4, 0x90C5B15C, 0xF2E73865, 0x2FA292DD, 0x36A22A17, 0xEBE780AF, 0x89C50996, 0x5480A32E, // [3][0xa0] + 0x8585DDB4, 0x58C0770C, 0x3AE2FE35, 0xE7A7548D, 0xFEA7EC47, 0x23E246FF, 0x41C0CFC6, 0x9C85657E, // [3][0xa8] + 0x73C1BE52, 0xAE8414EA, 0xCCA69DD3, 0x11E3376B, 0x08E38FA1, 0xD5A62519, 0xB784AC20, 0x6AC10698, // [3][0xb0] + 0x6CE16C89, 0xB1A4C631, 0xD3864F08, 0x0EC3E5B0, 0x17C35D7A, 0xCA86F7C2, 0xA8A47EFB, 0x75E1D443, // [3][0xb8] + 0x9AA50F6F, 0x47E0A5D7, 0x25C22CEE, 0xF8878656, 0xE1873E9C, 0x3CC29424, 0x5EE01D1D, 0x83A5B7A5, // [3][0xc0] + 0xF90696D8, 0x24433C60, 0x4661B559, 0x9B241FE1, 0x8224A72B, 0x5F610D93, 0x3D4384AA, 0xE0062E12, // [3][0xc8] + 0x0F42F53E, 0xD2075F86, 0xB025D6BF, 0x6D607C07, 0x7460C4CD, 0xA9256E75, 0xCB07E74C, 0x16424DF4, // [3][0xd0] + 0x106227E5, 0xCD278D5D, 0xAF050464, 0x7240AEDC, 0x6B401616, 0xB605BCAE, 0xD4273597, 0x09629F2F, // [3][0xd8] + 0xE6264403, 0x3B63EEBB, 0x59416782, 0x8404CD3A, 0x9D0475F0, 0x4041DF48, 0x22635671, 0xFF26FCC9, // [3][0xe0] + 0x2E238253, 0xF36628EB, 0x9144A1D2, 0x4C010B6A, 0x5501B3A0, 0x88441918, 0xEA669021, 0x37233A99, // [3][0xe8] + 0xD867E1B5, 0x05224B0D, 0x6700C234, 0xBA45688C, 0xA345D046, 0x7E007AFE, 0x1C22F3C7, 0xC167597F, // [3][0xf0] + 0xC747336E, 0x1A0299D6, 0x782010EF, 0xA565BA57, 0xBC65029D, 0x6120A825, 0x0302211C, 0xDE478BA4, // [3][0xf8] + 0x31035088, 0xEC46FA30, 0x8E647309, 0x5321D9B1, 0x4A21617B, 0x9764CBC3, 0xF54642FA, 0x2803E842 // [3][0x100] + }, + { + 0x00000000, 0x38116FAC, 0x7022DF58, 0x4833B0F4, 0xE045BEB0, 0xD854D11C, 0x906761E8, 0xA8760E44, // [4][0x08] + 0xC5670B91, 0xFD76643D, 0xB545D4C9, 0x8D54BB65, 0x2522B521, 0x1D33DA8D, 0x55006A79, 0x6D1105D5, // [4][0x10] + 0x8F2261D3, 0xB7330E7F, 0xFF00BE8B, 0xC711D127, 0x6F67DF63, 0x5776B0CF, 0x1F45003B, 0x27546F97, // [4][0x18] + 0x4A456A42, 0x725405EE, 0x3A67B51A, 0x0276DAB6, 0xAA00D4F2, 0x9211BB5E, 0xDA220BAA, 0xE2336406, // [4][0x20] + 0x1BA8B557, 0x23B9DAFB, 0x6B8A6A0F, 0x539B05A3, 0xFBED0BE7, 0xC3FC644B, 0x8BCFD4BF, 0xB3DEBB13, // [4][0x28] + 0xDECFBEC6, 0xE6DED16A, 0xAEED619E, 0x96FC0E32, 0x3E8A0076, 0x069B6FDA, 0x4EA8DF2E, 0x76B9B082, // [4][0x30] + 0x948AD484, 0xAC9BBB28, 0xE4A80BDC, 0xDCB96470, 0x74CF6A34, 0x4CDE0598, 0x04EDB56C, 0x3CFCDAC0, // [4][0x38] + 0x51EDDF15, 0x69FCB0B9, 0x21CF004D, 0x19DE6FE1, 0xB1A861A5, 0x89B90E09, 0xC18ABEFD, 0xF99BD151, // [4][0x40] + 0x37516AAE, 0x0F400502, 0x4773B5F6, 0x7F62DA5A, 0xD714D41E, 0xEF05BBB2, 0xA7360B46, 0x9F2764EA, // [4][0x48] + 0xF236613F, 0xCA270E93, 0x8214BE67, 0xBA05D1CB, 0x1273DF8F, 0x2A62B023, 0x625100D7, 0x5A406F7B, // [4][0x50] + 0xB8730B7D, 0x806264D1, 0xC851D425, 0xF040BB89, 0x5836B5CD, 0x6027DA61, 0x28146A95, 0x10050539, // [4][0x58] + 0x7D1400EC, 0x45056F40, 0x0D36DFB4, 0x3527B018, 0x9D51BE5C, 0xA540D1F0, 0xED736104, 0xD5620EA8, // [4][0x60] + 0x2CF9DFF9, 0x14E8B055, 0x5CDB00A1, 0x64CA6F0D, 0xCCBC6149, 0xF4AD0EE5, 0xBC9EBE11, 0x848FD1BD, // [4][0x68] + 0xE99ED468, 0xD18FBBC4, 0x99BC0B30, 0xA1AD649C, 0x09DB6AD8, 0x31CA0574, 0x79F9B580, 0x41E8DA2C, // [4][0x70] + 0xA3DBBE2A, 0x9BCAD186, 0xD3F96172, 0xEBE80EDE, 0x439E009A, 0x7B8F6F36, 0x33BCDFC2, 0x0BADB06E, // [4][0x78] + 0x66BCB5BB, 0x5EADDA17, 0x169E6AE3, 0x2E8F054F, 0x86F90B0B, 0xBEE864A7, 0xF6DBD453, 0xCECABBFF, // [4][0x80] + 0x6EA2D55C, 0x56B3BAF0, 0x1E800A04, 0x269165A8, 0x8EE76BEC, 0xB6F60440, 0xFEC5B4B4, 0xC6D4DB18, // [4][0x88] + 0xABC5DECD, 0x93D4B161, 0xDBE70195, 0xE3F66E39, 0x4B80607D, 0x73910FD1, 0x3BA2BF25, 0x03B3D089, // [4][0x90] + 0xE180B48F, 0xD991DB23, 0x91A26BD7, 0xA9B3047B, 0x01C50A3F, 0x39D46593, 0x71E7D567, 0x49F6BACB, // [4][0x98] + 0x24E7BF1E, 0x1CF6D0B2, 0x54C56046, 0x6CD40FEA, 0xC4A201AE, 0xFCB36E02, 0xB480DEF6, 0x8C91B15A, // [4][0xa0] + 0x750A600B, 0x4D1B0FA7, 0x0528BF53, 0x3D39D0FF, 0x954FDEBB, 0xAD5EB117, 0xE56D01E3, 0xDD7C6E4F, // [4][0xa8] + 0xB06D6B9A, 0x887C0436, 0xC04FB4C2, 0xF85EDB6E, 0x5028D52A, 0x6839BA86, 0x200A0A72, 0x181B65DE, // [4][0xb0] + 0xFA2801D8, 0xC2396E74, 0x8A0ADE80, 0xB21BB12C, 0x1A6DBF68, 0x227CD0C4, 0x6A4F6030, 0x525E0F9C, // [4][0xb8] + 0x3F4F0A49, 0x075E65E5, 0x4F6DD511, 0x777CBABD, 0xDF0AB4F9, 0xE71BDB55, 0xAF286BA1, 0x9739040D, // [4][0xc0] + 0x59F3BFF2, 0x61E2D05E, 0x29D160AA, 0x11C00F06, 0xB9B60142, 0x81A76EEE, 0xC994DE1A, 0xF185B1B6, // [4][0xc8] + 0x9C94B463, 0xA485DBCF, 0xECB66B3B, 0xD4A70497, 0x7CD10AD3, 0x44C0657F, 0x0CF3D58B, 0x34E2BA27, // [4][0xd0] + 0xD6D1DE21, 0xEEC0B18D, 0xA6F30179, 0x9EE26ED5, 0x36946091, 0x0E850F3D, 0x46B6BFC9, 0x7EA7D065, // [4][0xd8] + 0x13B6D5B0, 0x2BA7BA1C, 0x63940AE8, 0x5B856544, 0xF3F36B00, 0xCBE204AC, 0x83D1B458, 0xBBC0DBF4, // [4][0xe0] + 0x425B0AA5, 0x7A4A6509, 0x3279D5FD, 0x0A68BA51, 0xA21EB415, 0x9A0FDBB9, 0xD23C6B4D, 0xEA2D04E1, // [4][0xe8] + 0x873C0134, 0xBF2D6E98, 0xF71EDE6C, 0xCF0FB1C0, 0x6779BF84, 0x5F68D028, 0x175B60DC, 0x2F4A0F70, // [4][0xf0] + 0xCD796B76, 0xF56804DA, 0xBD5BB42E, 0x854ADB82, 0x2D3CD5C6, 0x152DBA6A, 0x5D1E0A9E, 0x650F6532, // [4][0xf8] + 0x081E60E7, 0x300F0F4B, 0x783CBFBF, 0x402DD013, 0xE85BDE57, 0xD04AB1FB, 0x9879010F, 0xA0686EA3 // [4][0x100] + }, + { + 0x00000000, 0xEF306B19, 0xDB8CA0C3, 0x34BCCBDA, 0xB2F53777, 0x5DC55C6E, 0x697997B4, 0x8649FCAD, // [5][0x08] + 0x6006181F, 0x8F367306, 0xBB8AB8DC, 0x54BAD3C5, 0xD2F32F68, 0x3DC34471, 0x097F8FAB, 0xE64FE4B2, // [5][0x10] + 0xC00C303E, 0x2F3C5B27, 0x1B8090FD, 0xF4B0FBE4, 0x72F90749, 0x9DC96C50, 0xA975A78A, 0x4645CC93, // [5][0x18] + 0xA00A2821, 0x4F3A4338, 0x7B8688E2, 0x94B6E3FB, 0x12FF1F56, 0xFDCF744F, 0xC973BF95, 0x2643D48C, // [5][0x20] + 0x85F4168D, 0x6AC47D94, 0x5E78B64E, 0xB148DD57, 0x370121FA, 0xD8314AE3, 0xEC8D8139, 0x03BDEA20, // [5][0x28] + 0xE5F20E92, 0x0AC2658B, 0x3E7EAE51, 0xD14EC548, 0x570739E5, 0xB83752FC, 0x8C8B9926, 0x63BBF23F, // [5][0x30] + 0x45F826B3, 0xAAC84DAA, 0x9E748670, 0x7144ED69, 0xF70D11C4, 0x183D7ADD, 0x2C81B107, 0xC3B1DA1E, // [5][0x38] + 0x25FE3EAC, 0xCACE55B5, 0xFE729E6F, 0x1142F576, 0x970B09DB, 0x783B62C2, 0x4C87A918, 0xA3B7C201, // [5][0x40] + 0x0E045BEB, 0xE13430F2, 0xD588FB28, 0x3AB89031, 0xBCF16C9C, 0x53C10785, 0x677DCC5F, 0x884DA746, // [5][0x48] + 0x6E0243F4, 0x813228ED, 0xB58EE337, 0x5ABE882E, 0xDCF77483, 0x33C71F9A, 0x077BD440, 0xE84BBF59, // [5][0x50] + 0xCE086BD5, 0x213800CC, 0x1584CB16, 0xFAB4A00F, 0x7CFD5CA2, 0x93CD37BB, 0xA771FC61, 0x48419778, // [5][0x58] + 0xAE0E73CA, 0x413E18D3, 0x7582D309, 0x9AB2B810, 0x1CFB44BD, 0xF3CB2FA4, 0xC777E47E, 0x28478F67, // [5][0x60] + 0x8BF04D66, 0x64C0267F, 0x507CEDA5, 0xBF4C86BC, 0x39057A11, 0xD6351108, 0xE289DAD2, 0x0DB9B1CB, // [5][0x68] + 0xEBF65579, 0x04C63E60, 0x307AF5BA, 0xDF4A9EA3, 0x5903620E, 0xB6330917, 0x828FC2CD, 0x6DBFA9D4, // [5][0x70] + 0x4BFC7D58, 0xA4CC1641, 0x9070DD9B, 0x7F40B682, 0xF9094A2F, 0x16392136, 0x2285EAEC, 0xCDB581F5, // [5][0x78] + 0x2BFA6547, 0xC4CA0E5E, 0xF076C584, 0x1F46AE9D, 0x990F5230, 0x763F3929, 0x4283F2F3, 0xADB399EA, // [5][0x80] + 0x1C08B7D6, 0xF338DCCF, 0xC7841715, 0x28B47C0C, 0xAEFD80A1, 0x41CDEBB8, 0x75712062, 0x9A414B7B, // [5][0x88] + 0x7C0EAFC9, 0x933EC4D0, 0xA7820F0A, 0x48B26413, 0xCEFB98BE, 0x21CBF3A7, 0x1577387D, 0xFA475364, // [5][0x90] + 0xDC0487E8, 0x3334ECF1, 0x0788272B, 0xE8B84C32, 0x6EF1B09F, 0x81C1DB86, 0xB57D105C, 0x5A4D7B45, // [5][0x98] + 0xBC029FF7, 0x5332F4EE, 0x678E3F34, 0x88BE542D, 0x0EF7A880, 0xE1C7C399, 0xD57B0843, 0x3A4B635A, // [5][0xa0] + 0x99FCA15B, 0x76CCCA42, 0x42700198, 0xAD406A81, 0x2B09962C, 0xC439FD35, 0xF08536EF, 0x1FB55DF6, // [5][0xa8] + 0xF9FAB944, 0x16CAD25D, 0x22761987, 0xCD46729E, 0x4B0F8E33, 0xA43FE52A, 0x90832EF0, 0x7FB345E9, // [5][0xb0] + 0x59F09165, 0xB6C0FA7C, 0x827C31A6, 0x6D4C5ABF, 0xEB05A612, 0x0435CD0B, 0x308906D1, 0xDFB96DC8, // [5][0xb8] + 0x39F6897A, 0xD6C6E263, 0xE27A29B9, 0x0D4A42A0, 0x8B03BE0D, 0x6433D514, 0x508F1ECE, 0xBFBF75D7, // [5][0xc0] + 0x120CEC3D, 0xFD3C8724, 0xC9804CFE, 0x26B027E7, 0xA0F9DB4A, 0x4FC9B053, 0x7B757B89, 0x94451090, // [5][0xc8] + 0x720AF422, 0x9D3A9F3B, 0xA98654E1, 0x46B63FF8, 0xC0FFC355, 0x2FCFA84C, 0x1B736396, 0xF443088F, // [5][0xd0] + 0xD200DC03, 0x3D30B71A, 0x098C7CC0, 0xE6BC17D9, 0x60F5EB74, 0x8FC5806D, 0xBB794BB7, 0x544920AE, // [5][0xd8] + 0xB206C41C, 0x5D36AF05, 0x698A64DF, 0x86BA0FC6, 0x00F3F36B, 0xEFC39872, 0xDB7F53A8, 0x344F38B1, // [5][0xe0] + 0x97F8FAB0, 0x78C891A9, 0x4C745A73, 0xA344316A, 0x250DCDC7, 0xCA3DA6DE, 0xFE816D04, 0x11B1061D, // [5][0xe8] + 0xF7FEE2AF, 0x18CE89B6, 0x2C72426C, 0xC3422975, 0x450BD5D8, 0xAA3BBEC1, 0x9E87751B, 0x71B71E02, // [5][0xf0] + 0x57F4CA8E, 0xB8C4A197, 0x8C786A4D, 0x63480154, 0xE501FDF9, 0x0A3196E0, 0x3E8D5D3A, 0xD1BD3623, // [5][0xf8] + 0x37F2D291, 0xD8C2B988, 0xEC7E7252, 0x034E194B, 0x8507E5E6, 0x6A378EFF, 0x5E8B4525, 0xB1BB2E3C // [5][0x100] + }, + { + 0x00000000, 0x68032CC8, 0xD0065990, 0xB8057558, 0xA5E0C5D1, 0xCDE3E919, 0x75E69C41, 0x1DE5B089, // [6][0x08] + 0x4E2DFD53, 0x262ED19B, 0x9E2BA4C3, 0xF628880B, 0xEBCD3882, 0x83CE144A, 0x3BCB6112, 0x53C84DDA, // [6][0x10] + 0x9C5BFAA6, 0xF458D66E, 0x4C5DA336, 0x245E8FFE, 0x39BB3F77, 0x51B813BF, 0xE9BD66E7, 0x81BE4A2F, // [6][0x18] + 0xD27607F5, 0xBA752B3D, 0x02705E65, 0x6A7372AD, 0x7796C224, 0x1F95EEEC, 0xA7909BB4, 0xCF93B77C, // [6][0x20] + 0x3D5B83BD, 0x5558AF75, 0xED5DDA2D, 0x855EF6E5, 0x98BB466C, 0xF0B86AA4, 0x48BD1FFC, 0x20BE3334, // [6][0x28] + 0x73767EEE, 0x1B755226, 0xA370277E, 0xCB730BB6, 0xD696BB3F, 0xBE9597F7, 0x0690E2AF, 0x6E93CE67, // [6][0x30] + 0xA100791B, 0xC90355D3, 0x7106208B, 0x19050C43, 0x04E0BCCA, 0x6CE39002, 0xD4E6E55A, 0xBCE5C992, // [6][0x38] + 0xEF2D8448, 0x872EA880, 0x3F2BDDD8, 0x5728F110, 0x4ACD4199, 0x22CE6D51, 0x9ACB1809, 0xF2C834C1, // [6][0x40] + 0x7AB7077A, 0x12B42BB2, 0xAAB15EEA, 0xC2B27222, 0xDF57C2AB, 0xB754EE63, 0x0F519B3B, 0x6752B7F3, // [6][0x48] + 0x349AFA29, 0x5C99D6E1, 0xE49CA3B9, 0x8C9F8F71, 0x917A3FF8, 0xF9791330, 0x417C6668, 0x297F4AA0, // [6][0x50] + 0xE6ECFDDC, 0x8EEFD114, 0x36EAA44C, 0x5EE98884, 0x430C380D, 0x2B0F14C5, 0x930A619D, 0xFB094D55, // [6][0x58] + 0xA8C1008F, 0xC0C22C47, 0x78C7591F, 0x10C475D7, 0x0D21C55E, 0x6522E996, 0xDD279CCE, 0xB524B006, // [6][0x60] + 0x47EC84C7, 0x2FEFA80F, 0x97EADD57, 0xFFE9F19F, 0xE20C4116, 0x8A0F6DDE, 0x320A1886, 0x5A09344E, // [6][0x68] + 0x09C17994, 0x61C2555C, 0xD9C72004, 0xB1C40CCC, 0xAC21BC45, 0xC422908D, 0x7C27E5D5, 0x1424C91D, // [6][0x70] + 0xDBB77E61, 0xB3B452A9, 0x0BB127F1, 0x63B20B39, 0x7E57BBB0, 0x16549778, 0xAE51E220, 0xC652CEE8, // [6][0x78] + 0x959A8332, 0xFD99AFFA, 0x459CDAA2, 0x2D9FF66A, 0x307A46E3, 0x58796A2B, 0xE07C1F73, 0x887F33BB, // [6][0x80] + 0xF56E0EF4, 0x9D6D223C, 0x25685764, 0x4D6B7BAC, 0x508ECB25, 0x388DE7ED, 0x808892B5, 0xE88BBE7D, // [6][0x88] + 0xBB43F3A7, 0xD340DF6F, 0x6B45AA37, 0x034686FF, 0x1EA33676, 0x76A01ABE, 0xCEA56FE6, 0xA6A6432E, // [6][0x90] + 0x6935F452, 0x0136D89A, 0xB933ADC2, 0xD130810A, 0xCCD53183, 0xA4D61D4B, 0x1CD36813, 0x74D044DB, // [6][0x98] + 0x27180901, 0x4F1B25C9, 0xF71E5091, 0x9F1D7C59, 0x82F8CCD0, 0xEAFBE018, 0x52FE9540, 0x3AFDB988, // [6][0xa0] + 0xC8358D49, 0xA036A181, 0x1833D4D9, 0x7030F811, 0x6DD54898, 0x05D66450, 0xBDD31108, 0xD5D03DC0, // [6][0xa8] + 0x8618701A, 0xEE1B5CD2, 0x561E298A, 0x3E1D0542, 0x23F8B5CB, 0x4BFB9903, 0xF3FEEC5B, 0x9BFDC093, // [6][0xb0] + 0x546E77EF, 0x3C6D5B27, 0x84682E7F, 0xEC6B02B7, 0xF18EB23E, 0x998D9EF6, 0x2188EBAE, 0x498BC766, // [6][0xb8] + 0x1A438ABC, 0x7240A674, 0xCA45D32C, 0xA246FFE4, 0xBFA34F6D, 0xD7A063A5, 0x6FA516FD, 0x07A63A35, // [6][0xc0] + 0x8FD9098E, 0xE7DA2546, 0x5FDF501E, 0x37DC7CD6, 0x2A39CC5F, 0x423AE097, 0xFA3F95CF, 0x923CB907, // [6][0xc8] + 0xC1F4F4DD, 0xA9F7D815, 0x11F2AD4D, 0x79F18185, 0x6414310C, 0x0C171DC4, 0xB412689C, 0xDC114454, // [6][0xd0] + 0x1382F328, 0x7B81DFE0, 0xC384AAB8, 0xAB878670, 0xB66236F9, 0xDE611A31, 0x66646F69, 0x0E6743A1, // [6][0xd8] + 0x5DAF0E7B, 0x35AC22B3, 0x8DA957EB, 0xE5AA7B23, 0xF84FCBAA, 0x904CE762, 0x2849923A, 0x404ABEF2, // [6][0xe0] + 0xB2828A33, 0xDA81A6FB, 0x6284D3A3, 0x0A87FF6B, 0x17624FE2, 0x7F61632A, 0xC7641672, 0xAF673ABA, // [6][0xe8] + 0xFCAF7760, 0x94AC5BA8, 0x2CA92EF0, 0x44AA0238, 0x594FB2B1, 0x314C9E79, 0x8949EB21, 0xE14AC7E9, // [6][0xf0] + 0x2ED97095, 0x46DA5C5D, 0xFEDF2905, 0x96DC05CD, 0x8B39B544, 0xE33A998C, 0x5B3FECD4, 0x333CC01C, // [6][0xf8] + 0x60F48DC6, 0x08F7A10E, 0xB0F2D456, 0xD8F1F89E, 0xC5144817, 0xAD1764DF, 0x15121187, 0x7D113D4F // [6][0x100] + }, + { + 0x00000000, 0x493C7D27, 0x9278FA4E, 0xDB448769, 0x211D826D, 0x6821FF4A, 0xB3657823, 0xFA590504, // [7][0x08] + 0x423B04DA, 0x0B0779FD, 0xD043FE94, 0x997F83B3, 0x632686B7, 0x2A1AFB90, 0xF15E7CF9, 0xB86201DE, // [7][0x10] + 0x847609B4, 0xCD4A7493, 0x160EF3FA, 0x5F328EDD, 0xA56B8BD9, 0xEC57F6FE, 0x37137197, 0x7E2F0CB0, // [7][0x18] + 0xC64D0D6E, 0x8F717049, 0x5435F720, 0x1D098A07, 0xE7508F03, 0xAE6CF224, 0x7528754D, 0x3C14086A, // [7][0x20] + 0x0D006599, 0x443C18BE, 0x9F789FD7, 0xD644E2F0, 0x2C1DE7F4, 0x65219AD3, 0xBE651DBA, 0xF759609D, // [7][0x28] + 0x4F3B6143, 0x06071C64, 0xDD439B0D, 0x947FE62A, 0x6E26E32E, 0x271A9E09, 0xFC5E1960, 0xB5626447, // [7][0x30] + 0x89766C2D, 0xC04A110A, 0x1B0E9663, 0x5232EB44, 0xA86BEE40, 0xE1579367, 0x3A13140E, 0x732F6929, // [7][0x38] + 0xCB4D68F7, 0x827115D0, 0x593592B9, 0x1009EF9E, 0xEA50EA9A, 0xA36C97BD, 0x782810D4, 0x31146DF3, // [7][0x40] + 0x1A00CB32, 0x533CB615, 0x8878317C, 0xC1444C5B, 0x3B1D495F, 0x72213478, 0xA965B311, 0xE059CE36, // [7][0x48] + 0x583BCFE8, 0x1107B2CF, 0xCA4335A6, 0x837F4881, 0x79264D85, 0x301A30A2, 0xEB5EB7CB, 0xA262CAEC, // [7][0x50] + 0x9E76C286, 0xD74ABFA1, 0x0C0E38C8, 0x453245EF, 0xBF6B40EB, 0xF6573DCC, 0x2D13BAA5, 0x642FC782, // [7][0x58] + 0xDC4DC65C, 0x9571BB7B, 0x4E353C12, 0x07094135, 0xFD504431, 0xB46C3916, 0x6F28BE7F, 0x2614C358, // [7][0x60] + 0x1700AEAB, 0x5E3CD38C, 0x857854E5, 0xCC4429C2, 0x361D2CC6, 0x7F2151E1, 0xA465D688, 0xED59ABAF, // [7][0x68] + 0x553BAA71, 0x1C07D756, 0xC743503F, 0x8E7F2D18, 0x7426281C, 0x3D1A553B, 0xE65ED252, 0xAF62AF75, // [7][0x70] + 0x9376A71F, 0xDA4ADA38, 0x010E5D51, 0x48322076, 0xB26B2572, 0xFB575855, 0x2013DF3C, 0x692FA21B, // [7][0x78] + 0xD14DA3C5, 0x9871DEE2, 0x4335598B, 0x0A0924AC, 0xF05021A8, 0xB96C5C8F, 0x6228DBE6, 0x2B14A6C1, // [7][0x80] + 0x34019664, 0x7D3DEB43, 0xA6796C2A, 0xEF45110D, 0x151C1409, 0x5C20692E, 0x8764EE47, 0xCE589360, // [7][0x88] + 0x763A92BE, 0x3F06EF99, 0xE44268F0, 0xAD7E15D7, 0x572710D3, 0x1E1B6DF4, 0xC55FEA9D, 0x8C6397BA, // [7][0x90] + 0xB0779FD0, 0xF94BE2F7, 0x220F659E, 0x6B3318B9, 0x916A1DBD, 0xD856609A, 0x0312E7F3, 0x4A2E9AD4, // [7][0x98] + 0xF24C9B0A, 0xBB70E62D, 0x60346144, 0x29081C63, 0xD3511967, 0x9A6D6440, 0x4129E329, 0x08159E0E, // [7][0xa0] + 0x3901F3FD, 0x703D8EDA, 0xAB7909B3, 0xE2457494, 0x181C7190, 0x51200CB7, 0x8A648BDE, 0xC358F6F9, // [7][0xa8] + 0x7B3AF727, 0x32068A00, 0xE9420D69, 0xA07E704E, 0x5A27754A, 0x131B086D, 0xC85F8F04, 0x8163F223, // [7][0xb0] + 0xBD77FA49, 0xF44B876E, 0x2F0F0007, 0x66337D20, 0x9C6A7824, 0xD5560503, 0x0E12826A, 0x472EFF4D, // [7][0xb8] + 0xFF4CFE93, 0xB67083B4, 0x6D3404DD, 0x240879FA, 0xDE517CFE, 0x976D01D9, 0x4C2986B0, 0x0515FB97, // [7][0xc0] + 0x2E015D56, 0x673D2071, 0xBC79A718, 0xF545DA3F, 0x0F1CDF3B, 0x4620A21C, 0x9D642575, 0xD4585852, // [7][0xc8] + 0x6C3A598C, 0x250624AB, 0xFE42A3C2, 0xB77EDEE5, 0x4D27DBE1, 0x041BA6C6, 0xDF5F21AF, 0x96635C88, // [7][0xd0] + 0xAA7754E2, 0xE34B29C5, 0x380FAEAC, 0x7133D38B, 0x8B6AD68F, 0xC256ABA8, 0x19122CC1, 0x502E51E6, // [7][0xd8] + 0xE84C5038, 0xA1702D1F, 0x7A34AA76, 0x3308D751, 0xC951D255, 0x806DAF72, 0x5B29281B, 0x1215553C, // [7][0xe0] + 0x230138CF, 0x6A3D45E8, 0xB179C281, 0xF845BFA6, 0x021CBAA2, 0x4B20C785, 0x906440EC, 0xD9583DCB, // [7][0xe8] + 0x613A3C15, 0x28064132, 0xF342C65B, 0xBA7EBB7C, 0x4027BE78, 0x091BC35F, 0xD25F4436, 0x9B633911, // [7][0xf0] + 0xA777317B, 0xEE4B4C5C, 0x350FCB35, 0x7C33B612, 0x866AB316, 0xCF56CE31, 0x14124958, 0x5D2E347F, // [7][0xf8] + 0xE54C35A1, 0xAC704886, 0x7734CFEF, 0x3E08B2C8, 0xC451B7CC, 0x8D6DCAEB, 0x56294D82, 0x1F1530A5 // [7][0x100] + } +}; + +/* private (static) function factoring out byte-by-byte CRC computation using just one slice of the lookup table*/ +static uint32_t s_crc_generic_sb1(const uint8_t *input, int length, uint32_t crc, const uint32_t *table_ptr) { + uint32_t(*table)[8][256] = (uint32_t(*)[8][256])table_ptr; + while (length-- > 0) { + crc = (crc >> 8) ^ (*table)[0][(crc & 0xff) ^ *input++]; + } + return crc; +} + +/* The inner loops of the CRC functions that process large blocks of data work best when input is aligned*/ +/* This function begins processing input data one byte at a time until the input pointer is 4-byte aligned*/ +/* Advances the input pointer and reduces the length (both passed by reference)*/ +static inline uint32_t s_crc_generic_align( + const uint8_t **input, + int *length, + uint32_t crc, + const uint32_t *table_ptr) { + + /* Get the 4-byte memory alignment of our input buffer by looking at the least significant 2 bits*/ + size_t input_alignment = ((size_t)*input) & 0x3; + + /* Compute the number of input bytes that precede the first 4-byte aligned block (will be in range 0-3)*/ + size_t leading = (4 - input_alignment) & 0x3; + + /* Determine what's left without the leading input bytes (might be negative)*/ + size_t remaining = *length - leading; + + /* Process unaligned leading input bytes one at a time*/ + if (leading && remaining > 0) { + crc = s_crc_generic_sb1(*input, (uint32_t)leading, crc, table_ptr); + *input += leading; + *length -= (int)leading; + } + + return crc; +} + +/* private (static) function to compute a generic slice-by-4 CRC using the specified lookup table (4 table slices)*/ +static uint32_t s_crc_generic_sb4(const uint8_t *input, int length, uint32_t crc, const uint32_t *table_ptr) { + const uint32_t *current = (const uint32_t *)input; + int remaining = length; + uint32_t(*table)[8][256] = (uint32_t(*)[8][256])table_ptr; + + while (remaining >= 4) { + crc ^= *current++; + crc = (*table)[3][crc & 0xff] ^ (*table)[2][(crc >> 8) & 0xff] ^ (*table)[1][(crc >> 16) & 0xff] ^ + (*table)[0][crc >> 24]; + remaining -= 4; + } + + return s_crc_generic_sb1(&input[length - remaining], remaining, crc, table_ptr); +} + +/* private (static) function to compute a generic slice-by-8 CRC using the specified lookup table (8 table slices)*/ +static uint32_t s_crc_generic_sb8(const uint8_t *input, int length, uint32_t crc, const uint32_t *table_ptr) { + const uint32_t *current = (const uint32_t *)input; + int remaining = length; + uint32_t(*table)[8][256] = (uint32_t(*)[8][256])table_ptr; + + while (remaining >= 8) { + uint32_t c1 = *current++ ^ crc; + uint32_t c2 = *current++; + uint32_t t1 = (*table)[7][c1 & 0xff] ^ (*table)[6][(c1 >> 8) & 0xff] ^ (*table)[5][(c1 >> 16) & 0xff] ^ + (*table)[4][(c1 >> 24) & 0xff]; + uint32_t t2 = (*table)[3][c2 & 0xff] ^ (*table)[2][(c2 >> 8) & 0xff] ^ (*table)[1][(c2 >> 16) & 0xff] ^ + (*table)[0][(c2 >> 24) & 0xff]; + crc = t1 ^ t2; + remaining -= 8; + } + return s_crc_generic_sb4(&input[length - remaining], remaining, crc, table_ptr); +} + +/* Computes the Castagnoli CRC32c (iSCSI) using one byte at a time, i.e. no slicing. */ +static uint32_t s_crc32c_no_slice(const uint8_t *input, int length, uint32_t previousCrc32c) { + return ~s_crc_generic_sb1(input, length, ~previousCrc32c, &CRC32C_TABLE[0][0]); +} + +/* Computes the Castagnoli CRC32c (iSCSI) using slice-by-8. */ +static uint32_t s_crc32c_sb8(const uint8_t *input, int length, uint32_t previousCrc32) { + uint32_t crc = s_crc_generic_align(&input, &length, ~previousCrc32, &CRC32C_TABLE[0][0]); + return ~s_crc_generic_sb8(input, length, crc, &CRC32C_TABLE[0][0]); +} + + +/************************************************************************ + * + * Calculate CRC-32C (Castagnoli) for the specified input data. + * + * If the host is big endian the calculation is the byte-by-byte, aka, + * slice-by-1, version. Otherwise the calculation utilizes the + * slice-by-8 optimized calculation. + * + * Return the CRC value on success or 0 on error. + ************************************************************************/ +uint32_t +ms_crc32c (const uint8_t* input, int length, uint32_t previousCRC32C) +{ + if (!input || length <= 0) + return 0; + + if (ms_bigendianhost()) + return s_crc32c_no_slice(input, length, previousCRC32C); + else + return s_crc32c_sb8(input, length, previousCRC32C); +} /* End of ms_crc32c() */ diff --git a/libmseed/doc/Doxyfile b/libmseed/doc/Doxyfile new file mode 100644 index 0000000..3abcdb9 --- /dev/null +++ b/libmseed/doc/Doxyfile @@ -0,0 +1,2739 @@ +# Doxyfile 1.9.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = libmseed + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "The miniSEED data format library" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0. and GITHUB Use the lower case version of title +# with any whitespace replaced by '-' and punctations characters removed.. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = YES + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = YES + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = . \ + ../libmseed.h \ + ../extraheaders.c \ + ../fileutils.c \ + ../genutils.c \ + ../logging.c \ + ../lookup.c \ + ../msrutils.c \ + ../pack.c \ + ../parseutils.c \ + ../selection.c \ + ../tracelist.c \ + ../unpack.c + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.dox \ + *.md + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = ../example + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +#USE_MDFILE_AS_MAINPAGE = index.md + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = gh-pages + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = customdoxygen.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 230 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 120 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /