subsurface/uemis.c

/*
 * uemis.c
 *
 * UEMIS SDA file importer
 * AUTHOR:  Dirk Hohndel - Copyright 2011
 *
 * Licensed under the MIT license.
 */

#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <stdint.h>
#include <stdlib.h>
#define __USE_XOPEN
#include <time.h>
#include <regex.h>

#include "dive.h"
#include "uemis.h"

/*
 * following code is based on code found in at base64.sourceforge.net/b64.c
 * AUTHOR:         Bob Trower 08/04/01
 * COPYRIGHT:      Copyright (c) Trantor Standard Systems Inc., 2001
 * NOTE:           This source code may be used as you wish, subject to
 *                 the MIT license.
 */
/*
 * Translation Table to decode (created by Bob Trower)
 */
static const char cd64[]="|$$$}rstuvwxyz{$$$$$$$>?@ABCDEFGHIJKLMNOPQRSTUVW$$$$$$XYZ[\\]^_`abcdefghijklmnopq";

/*
 * decodeblock -- decode 4 '6-bit' characters into 3 8-bit binary bytes
 */
static void decodeblock( unsigned char in[4], unsigned char out[3] ) {
	out[ 0 ] = (unsigned char ) (in[0] << 2 | in[1] >> 4);
	out[ 1 ] = (unsigned char ) (in[1] << 4 | in[2] >> 2);
	out[ 2 ] = (unsigned char ) (((in[2] << 6) & 0xc0) | in[3]);
}

/*
 * decode a base64 encoded stream discarding padding, line breaks and noise
 */
static void decode( uint8_t *inbuf, uint8_t *outbuf, int inbuf_len ) {
	uint8_t in[4], out[3], v;
	int i,len,indx_in=0,indx_out=0;

	while (indx_in < inbuf_len) {
		for (len = 0, i = 0; i < 4 && (indx_in < inbuf_len); i++ ) {
			v = 0;
			while ((indx_in < inbuf_len) && v == 0) {
				v = inbuf[indx_in++];
				v = ((v < 43 || v > 122) ? 0 : cd64[ v - 43 ]);
				if (v)
					v = ((v == '$') ? 0 : v - 61);
			}
			if (indx_in < inbuf_len) {
				len++;
				if (v)
					in[i] = (v - 1);
			}
			else
				in[i] = 0;
		}
		if( len ) {
			decodeblock( in, out );
			for( i = 0; i < len - 1; i++ )
				outbuf[indx_out++] = out[i];
		}
	}
}
/* end code from Bob Trower */

/* small helper functions */
/* simpleregex allocates (and reallocates) the found buffer
 * don't forget to free it when you are done
 */
static int simpleregex(char *buffer, char *regex, char **found) {
	int status;
	regex_t re;
	regmatch_t match[5];

	if (regcomp(&re, regex, 0) !=0) {
		fprintf(stderr,"internal error, regex failed!\n");
		exit(1);
	}
	status = regexec(&re,buffer,5,match,0);
	if(status == 0) {
		*found = realloc(*found,match[1].rm_eo-match[1].rm_so + 1);
		strncpy(*found,buffer+match[1].rm_so,match[1].rm_eo-match[1].rm_so);
		(*found)[match[1].rm_eo-match[1].rm_so] = '\0';
	}
	return(status == 0);
}

/* read in line of arbitrary length (important for SDA files that can
 * have lines that are tens of kB long
 * don't forget to free it when you are done
 */
#define MYGETL_INCR 1024
static char * mygetline(FILE * f) {
	size_t size = 0;
	size_t len  = 0;
	char * buf  = NULL;

	do {
		size += MYGETL_INCR;
		if ((buf = realloc(buf,size)) == NULL)
			break;
		fgets(buf+len,MYGETL_INCR,f);
		len = strlen(buf);
	} while (!feof(f) && buf[len-1]!='\n');
	return buf;
}

/* text matching, used to build very poor man's XML parser */
int matchit(FILE *infd, char *regex, char *typeregex, char **found) {
	char *buffer;

	while (!feof(infd)) {
		buffer = mygetline(infd);
		if (buffer && simpleregex(buffer,regex,found)) {
			buffer = mygetline(infd);
			if (buffer && simpleregex(buffer,typeregex,found)) {
				return 1;
			}
		}
	}
	return 0;
}

/*
 * pressure_to_depth: In centibar. And when converting to
 * depth, I'm just going to always use saltwater, because I
 * think "true depth" is just stupid. From a diving standpoint,
 * "true depth" is pretty much completely pointless, unless
 * you're doing some kind of underwater surveying work.
 *
 * So I give water depths in "pressure depth", always assuming
 * salt water. So one atmosphere per 10m.
 */
static int pressure_to_depth(uint16_t value)
{
	double atm, cm;

	atm = (value / 100.0) / 1.01325;
	cm = 100 * atm + 0.5;
	return( (cm > 0) ? 10 * (long)cm : 0);
}

/*
 * convert the base64 data blog
 */
int uemis_convert_base64(char *base64, uint8_t **data) {
	int len,datalen;

	len = strlen(base64);
	datalen = (len/4 + 1)*3;
	if (datalen < 0x123+0x25) {
		/* less than header + 1 sample??? */
		fprintf(stderr,"suspiciously short data block\n");
	}
	*data = malloc(datalen);
	if (! *data) {
		datalen = 0;
		fprintf(stderr,"Out of memory\n");
		goto bail;
	}
	decode(base64, *data, len);

	if (memcmp(*data,"Dive\01\00\00",7))
		fprintf(stderr,"Missing Dive100 header\n");

bail:
	return datalen;
}

/*
 * parse uemis base64 data blob into struct dive
 */
static void parse_divelog_binary(char *base64, struct dive **divep) {
	int datalen;
	int i;
	uint8_t *data;
	struct sample *sample;
	struct dive *dive = *divep;
	int template, gasoffset;

	datalen = uemis_convert_base64(base64, &data);

	/* dive template in use:
	   0 = air
	   1 = nitrox (B)
	   2 = nitrox (B+D)
	   3 = nitrox (B+T+D)
	   uemis cylinder data is insane - it stores seven tank settings in a block
	   and the template tells us which of the four groups of tanks we need to look at
	 */
	gasoffset = template = *(uint8_t *)(data+115);
	if (template == 3)
		gasoffset = 4;
	for (i = 0; i < template; i++) {
		float volume = *(float *)(data+116+25*(gasoffset + i)) * 1000.0;
		/* uemis always assumes a working pressure of 3000psi / 206bar - even though that's wrong */
		/* I also think that the unit that it stores (cuft for me) might change with SDA settings */
		// dive->cylinder[i].type.size.mliter = volume * 206.84 / 28.317;
		dive->cylinder[i].type.size.mliter = volume * 200 / 28.317;
		dive->cylinder[i].gasmix.o2.permille = *(uint8_t *)(data+120+25*(gasoffset + i)) * 10 + 0.5;
		dive->cylinder[i].gasmix.he.permille = 0;
	}
	/* first byte of divelog data is at offset 0x123 */
	i = 0x123;
	while ((i < datalen) && (*(uint16_t *)(data+i))) {
		/* it seems that a dive_time of 0 indicates the end of the valid readings */
		/* the SDA usually records more samples after the end of the dive --
		 * we want to discard those, but not cut the dive short; sadly the dive
		 * duration in the header is a) in minutes and b) up to 3 minutes short */
		if (*(uint16_t *)(data+i) > dive->duration.seconds + 180)
			break;
		sample = prepare_sample(divep);
		dive = *divep; /* prepare_sample might realloc the dive */
		sample->time.seconds = *(uint16_t *)(data+i);
		sample->depth.mm = pressure_to_depth(*(uint16_t *)(data+i+2));
		sample->temperature.mkelvin = (*(uint16_t *)(data+i+4) * 100) + 273150;
		sample->cylinderpressure.mbar= *(uint16_t *)(data+i+23) * 10;
		sample->cylinderindex = *(uint8_t *)(data+i+22);
		finish_sample(dive, sample);
		i += 0x25;
	}
	dive->duration.seconds = sample->time.seconds - 1;
	return;
}

/* parse a single file
 * TODO: we don't report any errors when the parse fails - we simply don't add them to the list
 */
void
parse_uemis_file(char *divelogfilename) {
	char *found=NULL;
	struct tm tm;
	struct dive *dive;

	FILE *divelogfile = fopen(divelogfilename,"r");

	dive = alloc_dive();

	if (! matchit(divelogfile,"val key=\"date\"","<ts>\\([^<]*\\)</ts>",&found)) {
		/* some error handling */
		goto bail;
	}
	strptime(found, "%Y-%m-%dT%H:%M:%S", &tm);
	dive->when = utc_mktime(&tm);
	if (! matchit(divelogfile,"<val key=\"duration\">",
			"<float>\\([0-9.]*\\)</float>",	&found)) {
		/* some error handling */
		goto bail;
	}
	dive->duration.seconds = 60.0 * atof(found);

	if (! matchit(divelogfile,"<val key=\"depth\">",
			"<int>\\([0-9.]*\\)</int>", &found)) {
		/* some error handling */
		goto bail;
	}
	dive->maxdepth.mm = pressure_to_depth(atoi(found));

	if (! matchit(divelogfile,"<val key=\"file_content\">",
			">\\([a-zA-Z0-9+/=]*\\)<", &found)) {
		/* some error handling */
		goto bail;
	}
	parse_divelog_binary(found,&dive);
	record_dive(dive);
bail:
	if (found)
		free(found);
}

/*
 * parse the two files extracted from the SDA
 */
void
uemis_import() {
	if (open_import_file_dialog("*.SDA","uemis Zurich SDA files",
					&parse_uemis_file))
		report_dives();
}