dive.c

   1 /* dive.c */
   2 /* maintains the internal dive list structure */
   3 #include <string.h>
   4 #include <stdio.h>
   5
   6 #include "dive.h"
   7
   8 void add_event(struct dive *dive, int time, int type, int flags, int value, const char *name)
   9 {
  10         struct event *ev, **p;
  11         unsigned int size, len = strlen(name);
  12
  13         size = sizeof(*ev) + len + 1;
  14         ev = malloc(size);
  15         if (!ev)
  16                 return;
  17         memset(ev, 0, size);
  18         memcpy(ev->name, name, len);
  19         ev->time.seconds = time;
  20         ev->type = type;
  21         ev->flags = flags;
  22         ev->value = value;
  23         ev->next = NULL;
  24
  25         p = &dive->events;
  26         while (*p)
  27                 p = &(*p)->next;
  28         *p = ev;
  29 }
  30
  31 double get_depth_units(unsigned int mm, int *frac, const char **units)
  32 {
  33         int decimals;
  34         double d;
  35         const char *unit;
  36
  37         switch (output_units.length) {
  38         case METERS:
  39                 d = mm / 1000.0;
  40                 unit = "m";
  41                 decimals = d < 20;
  42                 break;
  43         case FEET:
  44                 d = mm_to_feet(mm);
  45                 unit = "ft";
  46                 decimals = 0;
  47                 break;
  48         }
  49         if (frac)
  50                 *frac = decimals;
  51         if (units)
  52                 *units = unit;
  53         return d;
  54 }
  55
  56 struct dive *alloc_dive(void)
  57 {
  58         const int initial_samples = 5;
  59         unsigned int size;
  60         struct dive *dive;
  61
  62         size = dive_size(initial_samples);
  63         dive = malloc(size);
  64         if (!dive)
  65                 exit(1);
  66         memset(dive, 0, size);
  67         dive->alloc_samples = initial_samples;
  68         return dive;
  69 }
  70
  71 struct sample *prepare_sample(struct dive **divep)
  72 {
  73         struct dive *dive = *divep;
  74         if (dive) {
  75                 int nr = dive->samples;
  76                 int alloc_samples = dive->alloc_samples;
  77                 struct sample *sample;
  78                 if (nr >= alloc_samples) {
  79                         unsigned int size;
  80
  81                         alloc_samples = (alloc_samples * 3)/2 + 10;
  82                         size = dive_size(alloc_samples);
  83                         dive = realloc(dive, size);
  84                         if (!dive)
  85                                 return NULL;
  86                         dive->alloc_samples = alloc_samples;
  87                         *divep = dive;
  88                 }
  89                 sample = dive->sample + nr;
  90                 memset(sample, 0, sizeof(*sample));
  91                 return sample;
  92         }
  93         return NULL;
  94 }
  95
  96 void finish_sample(struct dive *dive, struct sample *sample)
  97 {
  98         dive->samples++;
  99 }
 100
 101 /*
 102  * So when we re-calculate maxdepth and meandepth, we will
 103  * not override the old numbers if they are close to the
 104  * new ones.
 105  *
 106  * Why? Because a dive computer may well actually track the
 107  * max depth and mean depth at finer granularity than the
 108  * samples it stores. So it's possible that the max and mean
 109  * have been reported more correctly originally.
 110  *
 111  * Only if the values calculated from the samples are clearly
 112  * different do we override the normal depth values.
 113  *
 114  * This considers 1m to be "clearly different". That's
 115  * a totally random number.
 116  */
 117 static void update_depth(depth_t *depth, int new)
 118 {
 119         if (new) {
 120                 int old = depth->mm;
 121
 122                 if (abs(old - new) > 1000)
 123                         depth->mm = new;
 124         }
 125 }
 126
 127 static void update_duration(duration_t *duration, int new)
 128 {
 129         if (new)
 130                 duration->seconds = new;
 131 }
 132
 133 static void update_temperature(temperature_t *temperature, int new)
 134 {
 135         if (new) {
 136                 int old = temperature->mkelvin;
 137
 138                 if (abs(old - new) > 1000)
 139                         temperature->mkelvin = new;
 140         }
 141 }
 142
 143 static void fixup_pressure(struct dive *dive, struct sample *sample)
 144 {
 145         unsigned int pressure, index;
 146         cylinder_t *cyl;
 147
 148         pressure = sample->cylinderpressure.mbar;
 149         if (!pressure)
 150                 return;
 151         index = sample->cylinderindex;
 152         if (index >= MAX_CYLINDERS)
 153                 return;
 154         cyl = dive->cylinder + index;
 155         if (!cyl->start.mbar)
 156                 cyl->start.mbar = pressure;
 157         if (!cyl->end.mbar || pressure < cyl->end.mbar)
 158                 cyl->end.mbar = pressure;
 159 }
 160
 161 struct dive *fixup_dive(struct dive *dive)
 162 {
 163         int i;
 164         double depthtime = 0;
 165         int lasttime = 0;
 166         int start = -1, end = -1;
 167         int maxdepth = 0, mintemp = 0;
 168         int lastdepth = 0;
 169         int lasttemp = 0;
 170
 171         for (i = 0; i < dive->samples; i++) {
 172                 struct sample *sample = dive->sample + i;
 173                 int time = sample->time.seconds;
 174                 int depth = sample->depth.mm;
 175                 int temp = sample->temperature.mkelvin;
 176
 177                 if (lastdepth)
 178                         end = time;
 179
 180                 if (depth) {
 181                         if (start < 0)
 182                                 start = lasttime;
 183                         if (depth > maxdepth)
 184                                 maxdepth = depth;
 185                 }
 186
 187                 fixup_pressure(dive, sample);
 188
 189                 if (temp) {
 190                         /*
 191                          * If we have consecutive identical
 192                          * temperature readings, throw away
 193                          * the redundant ones.
 194                          */
 195                         if (lasttemp == temp)
 196                                 sample->temperature.mkelvin = 0;
 197                         else
 198                                 lasttemp = temp;
 199
 200                         if (!mintemp || temp < mintemp)
 201                                 mintemp = temp;
 202                 }
 203                 depthtime += (time - lasttime) * (lastdepth + depth) / 2;
 204                 lastdepth = depth;
 205                 lasttime = time;
 206         }
 207         if (end < 0)
 208                 return dive;
 209
 210         update_duration(&dive->duration, end - start);
 211         if (start != end)
 212                 depthtime /= (end - start);
 213
 214         update_depth(&dive->meandepth, depthtime);
 215         update_temperature(&dive->watertemp, mintemp);
 216         update_depth(&dive->maxdepth, maxdepth);
 217
 218         return dive;
 219 }
 220
 221 /* Don't pick a zero for MERGE_MIN() */
 222 #define MERGE_MAX(res, a, b, n) res->n = MAX(a->n, b->n)
 223 #define MERGE_MIN(res, a, b, n) res->n = (a->n)?(b->n)?MIN(a->n, b->n):(a->n):(b->n)
 224 #define MERGE_TXT(res, a, b, n) res->n = merge_text(a->n, b->n)
 225 #define MERGE_NONZERO(res, a, b, n) res->n = a->n ? a->n : b->n
 226
 227 static struct dive *add_sample(struct sample *sample, int time, struct dive *dive)
 228 {
 229         struct sample *p = prepare_sample(&dive);
 230
 231         if (!p)
 232                 return NULL;
 233         *p = *sample;
 234         p->time.seconds = time;
 235         finish_sample(dive, p);
 236         return dive;
 237 }
 238
 239 /*
 240  * Merge samples. Dive 'a' is "offset" seconds before Dive 'b'
 241  */
 242 static struct dive *merge_samples(struct dive *res, struct dive *a, struct dive *b, int offset)
 243 {
 244         int asamples = a->samples;
 245         int bsamples = b->samples;
 246         struct sample *as = a->sample;
 247         struct sample *bs = b->sample;
 248
 249         for (;;) {
 250                 int at, bt;
 251                 struct sample sample;
 252
 253                 if (!res)
 254                         return NULL;
 255
 256                 at = asamples ? as->time.seconds : -1;
 257                 bt = bsamples ? bs->time.seconds + offset : -1;
 258
 259                 /* No samples? All done! */
 260                 if (at < 0 && bt < 0)
 261                         return fixup_dive(res);
 262
 263                 /* Only samples from a? */
 264                 if (bt < 0) {
 265 add_sample_a:
 266                         res = add_sample(as, at, res);
 267                         as++;
 268                         asamples--;
 269                         continue;
 270                 }
 271
 272                 /* Only samples from b? */
 273                 if (at < 0) {
 274 add_sample_b:
 275                         res = add_sample(bs, bt, res);
 276                         bs++;
 277                         bsamples--;
 278                         continue;
 279                 }
 280
 281                 if (at < bt)
 282                         goto add_sample_a;
 283                 if (at > bt)
 284                         goto add_sample_b;
 285
 286                 /* same-time sample: add a merged sample. Take the non-zero ones */
 287                 sample = *bs;
 288                 if (as->depth.mm)
 289                         sample.depth = as->depth;
 290                 if (as->temperature.mkelvin)
 291                         sample.temperature = as->temperature;
 292                 if (as->cylinderpressure.mbar)
 293                         sample.cylinderpressure = as->cylinderpressure;
 294                 if (as->cylinderindex)
 295                         sample.cylinderindex = as->cylinderindex;
 296
 297                 res = add_sample(&sample, at, res);
 298
 299                 as++;
 300                 bs++;
 301                 asamples--;
 302                 bsamples--;
 303         }
 304 }
 305
 306 static char *merge_text(const char *a, const char *b)
 307 {
 308         char *res;
 309
 310         if (!a || !*a)
 311                 return (char *)b;
 312         if (!b || !*b)
 313                 return (char *)a;
 314         if (!strcmp(a,b))
 315                 return (char *)a;
 316         res = malloc(strlen(a) + strlen(b) + 9);
 317         if (!res)
 318                 return (char *)a;
 319         sprintf(res, "(%s) or (%s)", a, b);
 320         return res;
 321 }
 322
 323 #define SORT(a,b,field) \
 324         if (a->field != b->field) return a->field < b->field ? -1 : 1
 325
 326 static int sort_event(struct event *a, struct event *b)
 327 {
 328         SORT(a,b,time.seconds);
 329         SORT(a,b,type);
 330         SORT(a,b,flags);
 331         SORT(a,b,value);
 332         return strcmp(a->name, b->name);
 333 }
 334
 335 static void merge_events(struct dive *res, struct dive *src1, struct dive *src2, int offset)
 336 {
 337         struct event *a, *b;
 338         struct event **p = &res->events;
 339
 340         a = src1->events;
 341         b = src2->events;
 342         while (b) {
 343                 b->time.seconds += offset;
 344                 b = b->next;
 345         }
 346         b = src2->events;
 347
 348         while (a || b) {
 349                 int s;
 350                 if (!b) {
 351                         *p = a;
 352                         break;
 353                 }
 354                 if (!a) {
 355                         *p = b;
 356                         break;
 357                 }
 358                 s = sort_event(a, b);
 359                 /* Pick b */
 360                 if (s > 0) {
 361                         *p = b;
 362                         p = &b->next;
 363                         b = b->next;
 364                         continue;
 365                 }
 366                 /* Pick 'a' or neither */
 367                 if (s < 0) {
 368                         *p = a;
 369                         p = &a->next;
 370                 }
 371                 a = a->next;
 372                 continue;
 373         }
 374 }
 375
 376 /* Pick whichever has any info (if either). Prefer 'a' */
 377 static void merge_cylinder_type(cylinder_type_t *res, cylinder_type_t *a, cylinder_type_t *b)
 378 {
 379         if (a->size.mliter)
 380                 b = a;
 381         *res = *b;
 382 }
 383
 384 static void merge_cylinder_mix(struct gasmix *res, struct gasmix *a, struct gasmix *b)
 385 {
 386         if (a->o2.permille)
 387                 b = a;
 388         *res = *b;
 389 }
 390
 391 static void merge_cylinder_info(cylinder_t *res, cylinder_t *a, cylinder_t *b)
 392 {
 393         merge_cylinder_type(&res->type, &a->type, &b->type);
 394         merge_cylinder_mix(&res->gasmix, &a->gasmix, &b->gasmix);
 395         MERGE_MAX(res, a, b, start.mbar);
 396         MERGE_MIN(res, a, b, end.mbar);
 397 }
 398
 399 /*
 400  * This could do a lot more merging. Right now it really only
 401  * merges almost exact duplicates - something that happens easily
 402  * with overlapping dive downloads.
 403  */
 404 struct dive *try_to_merge(struct dive *a, struct dive *b)
 405 {
 406         int i;
 407         struct dive *res;
 408
 409         if (a->when != b->when)
 410                 return NULL;
 411
 412         res = alloc_dive();
 413
 414         res->when = a->when;
 415         MERGE_NONZERO(res, a, b, latitude);
 416         MERGE_NONZERO(res, a, b, longitude);
 417         MERGE_TXT(res, a, b, location);
 418         MERGE_TXT(res, a, b, notes);
 419         MERGE_TXT(res, a, b, buddy);
 420         MERGE_TXT(res, a, b, divemaster);
 421         MERGE_MAX(res, a, b, number);
 422         MERGE_MAX(res, a, b, maxdepth.mm);
 423         res->meandepth.mm = 0;
 424         MERGE_MAX(res, a, b, duration.seconds);
 425         MERGE_MAX(res, a, b, surfacetime.seconds);
 426         MERGE_MAX(res, a, b, airtemp.mkelvin);
 427         MERGE_MIN(res, a, b, watertemp.mkelvin);
 428         for (i = 0; i < MAX_CYLINDERS; i++)
 429                 merge_cylinder_info(res->cylinder+i, a->cylinder + i, b->cylinder + i);
 430         merge_events(res, a, b, 0);
 431         return merge_samples(res, a, b, 0);
 432 }