Update Source Identifier handling to the adopted specification

Author: chad-iris

ChangeLog

@@ -1,3 +1,7 @@
+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 *'.

example/lm_sids.c

@@ -62,7 +62,7 @@ main (int argc, char **argv)
   char *sid;
   int idx;
 
-  sid = "XFDSN:NET_STA_LOC_C_H_N";
+  sid = "FDSN:NET_STA_LOC_C_H_N";
 
   if (map_sid (sid))
   {

genutils.c

@@ -3,7 +3,7 @@
  *
  * This file is part of the miniSEED Library.
  *
- * Copyright (c) 2020 Chad Trabant, IRIS Data Management Center
+ * Copyright (c) 2021 Chad Trabant, IRIS Data Management Center
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -113,18 +113,25 @@ static const int monthdays_leap[] = {31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30,
 
 
 /**********************************************************************/ /**
- * @brief Parse network, station, location and channel from a source ID URI
+ * @brief Parse network, station, location and channel from an FDSN Source ID
+ *
+ * FDSN Source Identifiers are defined at:
+ *   https://docs.fdsn.org/projects/source-identifiers/
  *
  * Parse a source identifier into separate components, expecting:
- *  \c "XFDSN:NET_STA_LOC_CHAN", where \c CHAN="BAND_SOURCE_POSITION"
+ *  \c "FDSN:NET_STA_LOC_CHAN", where \c CHAN="BAND_SOURCE_POSITION"
  *
  * The CHAN value will be converted to a SEED channel code if
  * possible.  Meaning, if the BAND, SOURCE, and POSITION are single
  * characters, the underscore delimiters will not be included in the
  * returned channel.
  *
  * Identifiers may contain additional namespace identifiers, e.g.:
- *  \c "XFDSN:AGENCY:NET_STA_LOC_CHAN"
+ *  \c "FDSN:AGENCY:NET_STA_LOC_CHAN"
+ *
+ * Such additional namespaces are not part of the Source ID standard
+ * as of this writing and support is included for specialized usage or
+ * future identifier changes.
  *
  * Memory for each component must already be allocated.  If a specific
  * component is not desired set the appropriate argument to NULL.
@@ -154,21 +161,20 @@ ms_sid2nslc (char *sid, char *net, char *sta, char *loc, char *chan)
     return -1;
   }
 
-  /* Handle the XFDSN: and FDSN: namespace identifiers */
-  if (!strncmp (sid, "XFDSN:", 6) ||
-      !strncmp (sid, "FDSN:", 5))
+  /* Handle the FDSN: namespace identifier */
+  if (!strncmp (sid, "FDSN:", 5))
   {
     /* Advance sid pointer to last ':', skipping all namespace identifiers */
     sid = strrchr (sid, ':') + 1;
 
-    /* Verify 3 or 5 delimiters */
+    /* Verify 5 delimiters */
     id = sid;
     while ((id = strchr (id, '_')))
     {
       id++;
       sepcnt++;
     }
-    if (sepcnt != 3 && sepcnt != 5)
+    if (sepcnt != 5)
     {
       ms_log (2, "Incorrect number of identifier delimiters (%d): %s\n", sepcnt, sid);
       return -1;
@@ -205,7 +211,7 @@ ms_sid2nslc (char *sid, char *net, char *sta, char *loc, char *chan)
 
       top = next;
     }
-    /* Location (potentially empty) */
+    /* Location, potentially empty */
     if ((ptr = strchr (top, '_')))
     {
       next = ptr + 1;
@@ -240,11 +246,14 @@ ms_sid2nslc (char *sid, char *net, char *sta, char *loc, char *chan)
 } /* End of ms_sid2nslc() */
 
 /**********************************************************************/ /**
- * @brief Convert network, station, location and channel to a source ID URI
+ * @brief Convert network, station, location and channel to an FDSN Source ID
+ *
+ * FDSN Source Identifiers are defined at:
+ *   https://docs.fdsn.org/projects/source-identifiers/
  *
  * Create a source identifier from individual network,
  * station, location and channel codes with the form:
- *  \c XFDSN:NET_STA_LOC_CHAN, where \c CHAN="BAND_SOURCE_POSITION"
+ *  \c FDSN:NET_STA_LOC_CHAN, where \c CHAN="BAND_SOURCE_POSITION"
  *
  * Memory for the source identifier must already be allocated.  If a
  * specific component is NULL it will be empty in the resulting
@@ -288,13 +297,12 @@ ms_nslc2sid (char *sid, int sidlen, uint16_t flags,
     return -1;
   }
 
-  *sptr++ = 'X';
   *sptr++ = 'F';
   *sptr++ = 'D';
   *sptr++ = 'S';
   *sptr++ = 'N';
   *sptr++ = ':';
-  needed  = 6;
+  needed  = 5;
 
   if (net)
   {

libmseed.h

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * Copyright (C) 2020:
+ * Copyright (C) 2021:
  * @author Chad Trabant, IRIS Data Management Center
  ***************************************************************************/
 
@@ -28,8 +28,8 @@
 extern "C" {
 #endif
 
-#define LIBMSEED_VERSION "3.0.8"    //!< Library version
-#define LIBMSEED_RELEASE "2020.156" //!< Library release date
+#define LIBMSEED_VERSION "3.0.1"    //!< Library version
+#define LIBMSEED_RELEASE "2021.234" //!< Library release date
 
 /** @defgroup io-functions File and URL I/O */
 /** @defgroup miniseed-record Record Handling */

test/parse-sids.test

@@ -1,4 +1,4 @@
 #!/bin/sh
 LD_LIBRARY_PATH=.. \
 DYLD_LIBRARY_PATH=.. \
-./lm_sids XFDSN:XX_TEST__L_H_Z XFDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION
+./lm_sids FDSN:XX_TEST__L_H_Z FDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION

test/parse-sids.test.ref

@@ -1,9 +1,9 @@
-Original SID: 'XFDSN:NET_STA_LOC_C_H_N'
+Original SID: 'FDSN:NET_STA_LOC_C_H_N'
   network: 'NET', station: 'STA', location: 'LOC', channel: 'CHN'
-  SID: 'XFDSN:NET_STA_LOC_C_H_N'
-Original SID: 'XFDSN:XX_TEST__L_H_Z'
+  SID: 'FDSN:NET_STA_LOC_C_H_N'
+Original SID: 'FDSN:XX_TEST__L_H_Z'
   network: 'XX', station: 'TEST', location: '', channel: 'LHZ'
-  SID: 'XFDSN:XX_TEST__L_H_Z'
-Original SID: 'XFDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION'
+  SID: 'FDSN:XX_TEST__L_H_Z'
+Original SID: 'FDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION'
   network: 'NETWORK', station: 'STATION', location: 'LOCATION', channel: 'BAND_SOURCE_POSITION'
-  SID: 'XFDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION'
+  SID: 'FDSN:NETWORK_STATION_LOCATION_BAND_SOURCE_POSITION'

test/read-CDSN-encoded.test.ref

@@ -1,4 +1,4 @@
-XFDSN:XX_TEST__B_H_E, 3, 4096, 2016 samples, 20 Hz, 1986,360,01:11:45.430000
+FDSN:XX_TEST__B_H_E, 3, 4096, 2016 samples, 20 Hz, 1986,360,01:11:45.430000
        -96         -87        -100        -128        -123         -83  
        -52         -54         -77        -108        -130        -120  
        -92         -93        -106        -108         -96         -57  

test/read-DWWSSN-encoded.test.ref

@@ -1,4 +1,4 @@
-XFDSN:XX_TEST__L_H_E, 4, 4096, 2016 samples, 1 Hz, 1980,360,00:00:00.320000
+FDSN:XX_TEST__L_H_E, 4, 4096, 2016 samples, 1 Hz, 1980,360,00:00:00.320000
          6           5           1          -9         -18         -19  
         -7          10          27          34          34          35  
         40          45          49          44          35          31  

test/read-Float32-encoded.test.ref

@@ -1,4 +1,4 @@
-XFDSN:XX_TEST__V_H_E, 2, 4096, 1008 samples, 0.1 Hz, 1986,360,02:12:05.864800
+FDSN:XX_TEST__V_H_E, 2, 4096, 1008 samples, 0.1 Hz, 1986,360,02:12:05.864800
    -1.0625   -1.078125   -1.078125   -1.078125   -1.078125   -1.078125  
 -1.0859375  -1.0859375  -1.0859375  -1.0859375    -1.09375    -1.09375  
   -1.09375    -1.09375  -1.0859375  -1.0859375  -1.0703125     -1.0625  

test/read-Float64-encoded.test.ref

@@ -1,4 +1,4 @@
-XFDSN:XX_TEST__V_H_E, 2, 4096, 504 samples, 0.1 Hz, 1986,360,02:12:05.864800
+FDSN:XX_TEST__V_H_E, 2, 4096, 504 samples, 0.1 Hz, 1986,360,02:12:05.864800
    -1.0625   -1.078125   -1.078125   -1.078125   -1.078125   -1.078125  
 -1.0859375  -1.0859375  -1.0859375  -1.0859375    -1.09375    -1.09375  
   -1.09375    -1.09375  -1.0859375  -1.0859375  -1.0703125     -1.0625