]> git.tdb.fi Git - ext/subsurface.git/blobdiff - profile.c
Correctly plot dives ending below the surface
[ext/subsurface.git] / profile.c
index bdce4261d000322e1a3713f561ce9c22049aad55..60e0f4215e2b69e481dd11501d188f36c8d64a15 100644 (file)
--- a/profile.c
+++ b/profile.c
@@ -96,6 +96,24 @@ void set_source_rgb(struct graphics_context *gc, double r, double g, double b)
 
 #define ROUND_UP(x,y) ((((x)+(y)-1)/(y))*(y))
 
+/* debugging tool - not normally used */
+static void dump_pi (struct plot_info *pi)
+{
+       int i;
+
+       printf("pi:{nr:%d maxtime:%d meandepth:%d maxdepth:%d \n"
+               "    minpressure:%d maxpressure:%d endpressure:%d mintemp:%d maxtemp:%d\n",
+               pi->nr, pi->maxtime, pi->meandepth, pi->maxdepth,
+               pi->minpressure, pi->maxpressure, pi->endpressure, pi->mintemp, pi->maxtemp);
+       for (i = 0; i < pi->nr; i++)
+               printf("    entry[%d]:{same_cylinder:%d cylinderindex:%d sec:%d pressure:{%d,%d}\n"
+                       "                temperature:%d depth:%d smoothed:%d}\n",
+                       i, pi->entry[i].same_cylinder, pi->entry[i].cylinderindex, pi->entry[i].sec,
+                       pi->entry[i].pressure[0], pi->entry[i].pressure[1],
+                       pi->entry[i].temperature, pi->entry[i].depth, pi->entry[i].smoothed);
+       printf("   }\n");
+}
+
 /*
  * When showing dive profiles, we scale things to the
  * current dive. However, we don't scale past less than
@@ -166,11 +184,62 @@ static void plot_text(struct graphics_context *gc, const text_render_options_t *
        cairo_show_text(cr, buffer);
 }
 
+struct ev_select {
+       char *ev_name;
+       gboolean plot_ev;
+};
+static struct ev_select *ev_namelist;
+static int evn_allocated;
+static int evn_used;
+
+void evn_foreach(void (*callback)(const char *, int *, void *), void *data)
+{
+       int i;
+
+       for (i = 0; i < evn_used; i++) {
+               callback(ev_namelist[i].ev_name, &ev_namelist[i].plot_ev, data);
+       }
+}
+
+void remember_event(const char *eventname)
+{
+       int i=0, len;
+
+       if (!eventname || (len = strlen(eventname)) == 0)
+               return;
+       while (i < evn_used) {
+               if (!strncmp(eventname,ev_namelist[i].ev_name,len))
+                       return;
+               i++;
+       }
+       if (evn_used == evn_allocated) {
+               evn_allocated += 10;
+               ev_namelist = realloc(ev_namelist, evn_allocated * sizeof(struct ev_select));
+               if (! ev_namelist)
+                       /* we are screwed, but let's just bail out */
+                       return;
+       }
+       ev_namelist[evn_used].ev_name = strdup(eventname);
+       ev_namelist[evn_used].plot_ev = TRUE;
+       evn_used++;
+}
+
 static void plot_one_event(struct graphics_context *gc, struct plot_info *pi, struct event *event, const text_render_options_t *tro)
 {
        int i, depth = 0;
        int x,y;
 
+       /* is plotting this event disabled? */
+       if (event->name) {
+               for (i = 0; i < evn_used; i++) {
+                       if (! strcmp(event->name, ev_namelist[i].ev_name)) {
+                               if (ev_namelist[i].plot_ev)
+                                       break;
+                               else
+                                       return;
+                       }
+               }
+       }
        for (i = 0; i < pi->nr; i++) {
                struct plot_data *data = pi->entry + i;
                if (event->time.seconds < data->sec)
@@ -225,6 +294,7 @@ static void plot_text_samples(struct graphics_context *gc, struct plot_info *pi)
        static const text_render_options_t deep = {14, 1.0, 0.2, 0.2, CENTER, TOP};
        static const text_render_options_t shallow = {14, 1.0, 0.2, 0.2, CENTER, BOTTOM};
        int i;
+       int last = -1;
 
        for (i = 0; i < pi->nr; i++) {
                struct plot_data *entry = pi->entry + i;
@@ -232,11 +302,18 @@ static void plot_text_samples(struct graphics_context *gc, struct plot_info *pi)
                if (entry->depth < 2000)
                        continue;
 
-               if (entry == entry->max[2])
+               if ((entry == entry->max[2]) && entry->depth != last) {
                        render_depth_sample(gc, entry, &deep);
+                       last = entry->depth;
+               }
 
-               if (entry == entry->min[2])
+               if ((entry == entry->min[2]) && entry->depth != last) {
                        render_depth_sample(gc, entry, &shallow);
+                       last = entry->depth;
+               }
+
+               if (entry->depth != last)
+                       last = -1;
        }
 }
 
@@ -299,23 +376,43 @@ static void plot_minmax_profile(struct graphics_context *gc, struct plot_info *p
 
 static void plot_depth_profile(struct graphics_context *gc, struct plot_info *pi)
 {
-       int i;
+       int i, incr;
        cairo_t *cr = gc->cr;
        int sec, depth;
        struct plot_data *entry;
        int maxtime, maxdepth, marker;
+       int increments[4] = { 5*60, 10*60, 15*60, 30*60 };
 
        /* Get plot scaling limits */
        maxtime = get_maxtime(pi);
        maxdepth = get_maxdepth(pi);
 
-       /* Time markers: every 5 min */
+       /* Time markers: at most every 5 min, but no more than 12 markers
+        * and for convenience we do 5, 10, 15 or 30 min intervals.
+        * This allows for 6h dives - enough (I hope) for even the craziest
+        * divers - but just in case, for those 8h depth-record-breaking dives,
+        * we double the interval if this still doesn't get us to 12 or fewer
+        * time markers */
+       i = 0;
+       while (maxtime / increments[i] > 12 && i < 4)
+               i++;
+       incr = increments[i];
+       while (maxtime / incr > 12)
+               incr *= 2;
+
        gc->leftx = 0; gc->rightx = maxtime;
        gc->topy = 0; gc->bottomy = 1.0;
-       for (i = 5*60; i < maxtime; i += 5*60) {
+       set_source_rgba(gc, 1, 1, 1, 0.5);
+       for (i = incr; i < maxtime; i += incr) {
                move_to(gc, i, 0);
                line_to(gc, i, 1);
        }
+       cairo_stroke(cr);
+
+       /* now the text on every second time marker */
+       text_render_options_t tro = {10, 0.2, 1.0, 0.2, CENTER, TOP};
+       for (i = incr; i < maxtime; i += 2 * incr)
+               plot_text(gc, &tro, i, 1, "%d", i/60);
 
        /* Depth markers: every 30 ft or 10 m*/
        gc->leftx = 0; gc->rightx = 1.0;
@@ -414,19 +511,13 @@ static int setup_temperature_limits(struct graphics_context *gc, struct plot_inf
 
 static void plot_single_temp_text(struct graphics_context *gc, int sec, int mkelvin)
 {
-       int deg;
+       double deg;
        const char *unit;
        static const text_render_options_t tro = {12, 0.2, 0.2, 1.0, LEFT, TOP};
-       temperature_t temperature = { mkelvin };
 
-       if (output_units.temperature == FAHRENHEIT) {
-               deg = to_F(temperature);
-               unit = UTF8_DEGREE "F";
-       } else {
-               deg = to_C(temperature);
-               unit = UTF8_DEGREE "C";
-       }
-       plot_text(gc, &tro, sec, temperature.mkelvin, "%d%s", deg, unit);
+       deg = get_temp_units(mkelvin, &unit);
+
+       plot_text(gc, &tro, sec, mkelvin, "%d%s", (int)(deg + 0.5), unit);
 }
 
 static void plot_temperature_text(struct graphics_context *gc, struct plot_info *pi)
@@ -546,32 +637,13 @@ static void plot_cylinder_pressure(struct graphics_context *gc, struct plot_info
        plot_pressure_helper(gc, pi, INTERPOLATED_PR);
 }
 
-static int mbar_to_PSI(int mbar)
-{
-       pressure_t p = {mbar};
-       return to_PSI(p);
-}
-
 static void plot_pressure_value(struct graphics_context *gc, int mbar, int sec,
                                int xalign, int yalign)
 {
        int pressure;
        const char *unit;
 
-       switch (output_units.pressure) {
-       case PASCAL:
-               pressure = mbar * 100;
-               unit = "pascal";
-               break;
-       case BAR:
-               pressure = (mbar + 500) / 1000;
-               unit = "bar";
-               break;
-       case PSI:
-               pressure = mbar_to_PSI(mbar);
-               unit = "psi";
-               break;
-       }
+       pressure = get_pressure_units(mbar, &unit);
        text_render_options_t tro = {10, 0.2, 1.0, 0.2, xalign, yalign};
        plot_text(gc, &tro, sec, mbar, "%d %s", pressure, unit);
 }
@@ -588,8 +660,10 @@ static void plot_cylinder_pressure_text(struct graphics_context *gc, struct plot
        if (!get_cylinder_pressure_range(gc, pi))
                return;
 
-       /* only loop over the actual events from the dive computer */
-       for (i = 2; i < pi->nr - 2; i++) {
+       /* only loop over the actual events from the dive computer
+        * plus the second synthetic event at the start (to make sure
+        * we get "time=0" right) */
+       for (i = 1; i < pi->nr; i++) {
                entry = pi->entry + i;
 
                if (!entry->same_cylinder) {
@@ -816,8 +890,11 @@ static void fill_missing_tank_pressures(struct dive *dive, struct plot_info *pi,
        for (cyl = 0; cyl < MAX_CYLINDERS; cyl++) {
                cur_pr[cyl] = track_pr[cyl]->start;
        }
-       for (i = 0; i < dive->samples; i++) {
-               entry = pi->entry + i + 2;
+
+       /* The first two are "fillers", but in case we don't have a sample
+        * at time 0 we need to process the second of them here */
+       for (i = 1; i < pi->nr; i++) {
+               entry = pi->entry + i;
                if (SENSOR_PRESSURE(entry)) {
                        cur_pr[entry->cylinderindex] = SENSOR_PRESSURE(entry);
                } else {
@@ -855,9 +932,85 @@ static void fill_missing_tank_pressures(struct dive *dive, struct plot_info *pi,
                                INTERPOLATED_PRESSURE(entry) =
                                        cur_pr[entry->cylinderindex] + cur_pt * magic;
                                cur_pr[entry->cylinderindex] = INTERPOLATED_PRESSURE(entry);
-                       }
+                       } else
+                               INTERPOLATED_PRESSURE(entry) = cur_pr[entry->cylinderindex];
+               }
+       }
+}
+
+static int get_cylinder_index(struct dive *dive, struct event *ev)
+{
+       int i;
+
+       /*
+        * Try to find a cylinder that matches the O2 percentage
+        * in the gas change event 'value' field.
+        *
+        * Crazy suunto gas change events. We really should do
+        * this in libdivecomputer or something.
+        */
+       for (i = 0; i < MAX_CYLINDERS; i++) {
+               cylinder_t *cyl = dive->cylinder+i;
+               int o2 = (cyl->gasmix.o2.permille + 5) / 10;
+               if (o2 == ev->value)
+                       return i;
+       }
+
+       return 0;
+}
+
+static struct event *get_next_gaschange(struct event *event)
+{
+       while (event) {
+               if (!strcmp(event->name, "gaschange"))
+                       return event;
+               event = event->next;
+       }
+       return event;
+}
+
+static int set_cylinder_index(struct plot_info *pi, int i, int cylinderindex, unsigned int end)
+{
+       while (i < pi->nr) {
+               struct plot_data *entry = pi->entry+i;
+               if (entry->sec > end)
+                       break;
+               if (entry->cylinderindex != cylinderindex) {
+                       entry->cylinderindex = cylinderindex;
+                       entry->pressure[0] = 0;
                }
+               i++;
        }
+       return i;
+}
+
+static void check_gas_change_events(struct dive *dive, struct plot_info *pi)
+{
+       int i = 0, cylinderindex = 0;
+       struct event *ev = get_next_gaschange(dive->events);
+
+       if (!ev)
+               return;
+
+       do {
+               i = set_cylinder_index(pi, i, cylinderindex, ev->time.seconds);
+               cylinderindex = get_cylinder_index(dive, ev);
+               ev = get_next_gaschange(ev->next);
+       } while (ev);
+       set_cylinder_index(pi, i, cylinderindex, ~0u);
+}
+
+/* for computers that track gas changes through events */
+static int count_gas_change_events(struct dive *dive)
+{
+       int count = 0;
+       struct event *ev = get_next_gaschange(dive->events);
+
+       while (ev) {
+               count++;
+               ev = get_next_gaschange(ev->next);
+       }
+       return count;
 }
 
 /*
@@ -867,50 +1020,107 @@ static void fill_missing_tank_pressures(struct dive *dive, struct plot_info *pi,
  * sides, so that you can do end-points without having to worry
  * about it.
  */
-static struct plot_info *create_plot_info(struct dive *dive)
+static struct plot_info *create_plot_info(struct dive *dive, int nr_samples, struct sample *dive_sample)
 {
        int cylinderindex = -1;
        int lastdepth, lastindex;
-       int i, nr = dive->samples + 4, sec, cyl;
-       size_t alloc_size = plot_info_size(nr);
+       int i, pi_idx, nr, sec, cyl;
+       size_t alloc_size;
        struct plot_info *pi;
        pr_track_t *track_pr[MAX_CYLINDERS] = {NULL, };
        pr_track_t *pr_track, *current;
        gboolean missing_pr = FALSE;
-       struct plot_data *entry;
+       struct plot_data *entry = NULL;
+       struct event *ev;
 
+       /* we want to potentially add synthetic plot_info elements for the gas changes */
+       nr = nr_samples + 4 + 2 * count_gas_change_events(dive);
+       alloc_size = plot_info_size(nr);
        pi = malloc(alloc_size);
        if (!pi)
                return pi;
        memset(pi, 0, alloc_size);
        pi->nr = nr;
+       pi_idx = 2; /* the two extra events at the start */
+       /* check for gas changes before the samples start */
+       ev = get_next_gaschange(dive->events);
+       while (ev && ev->time.seconds < dive_sample->time.seconds) {
+               entry = pi->entry + pi_idx;
+               entry->sec = ev->time.seconds;
+               entry->depth = 0; /* is that always correct ? */
+               pi_idx++;
+               ev = get_next_gaschange(ev->next);
+       }
+       if (ev && ev->time.seconds == dive_sample->time.seconds) {
+               /* we already have a sample at the time of the event */
+               ev = get_next_gaschange(ev->next);
+       }
        sec = 0;
        lastindex = 0;
        lastdepth = -1;
-       for (i = 0; i < dive->samples; i++) {
+       for (i = 0; i < nr_samples; i++) {
                int depth;
-               struct sample *sample = dive->sample+i;
-
-               entry = pi->entry + i + 2;
-               sec = entry->sec = sample->time.seconds;
+               int delay = 0;
+               struct sample *sample = dive_sample+i;
+
+               entry = pi->entry + i + pi_idx;
+               while (ev && ev->time.seconds < sample->time.seconds) {
+                       /* insert two fake plot info structures for the end of
+                        * the old tank and the start of the new tank */
+                       entry->sec = ev->time.seconds;
+                       (entry+1)->sec = ev->time.seconds + 1;
+                       /* we need a fake depth - let's interpolate */
+                       if (i) {
+                               entry->depth = sample->depth.mm -
+                                       (sample->depth.mm - (sample-1)->depth.mm) / 2;
+                       } else
+                               entry->depth = sample->depth.mm;
+                       (entry+1)->depth = entry->depth;
+                       pi_idx += 2;
+                       entry = pi->entry + i + pi_idx;
+                       ev = get_next_gaschange(ev->next);
+               }
+               if (ev && ev->time.seconds == sample->time.seconds) {
+                       /* we already have a sample at the time of the event
+                        * just add a new one for the old tank and delay the
+                        * real even by one second (to keep time monotonous) */
+                       entry->sec = ev->time.seconds;
+                       entry->depth = sample->depth.mm;
+                       pi_idx++;
+                       entry = pi->entry + i + pi_idx;
+                       ev = get_next_gaschange(ev->next);
+                       delay = 1;
+               }
+               sec = entry->sec = sample->time.seconds + delay;
                depth = entry->depth = sample->depth.mm;
                entry->cylinderindex = sample->cylinderindex;
                SENSOR_PRESSURE(entry) = sample->cylinderpressure.mbar;
                entry->temperature = sample->temperature.mkelvin;
 
                if (depth || lastdepth)
-                       lastindex = i+2;
+                       lastindex = i + pi_idx;
 
                lastdepth = depth;
                if (depth > pi->maxdepth)
                        pi->maxdepth = depth;
        }
+       entry = pi->entry + i + pi_idx;
+       /* are there still unprocessed gas changes? that would be very strange */
+       while (ev) {
+               entry->sec = ev->time.seconds;
+               entry->depth = 0; /* why are there gas changes after the dive is over? */
+               pi_idx++;
+               entry = pi->entry + i + pi_idx;
+               ev = get_next_gaschange(ev->next);
+       }
+       nr = nr_samples + pi_idx - 2;
+       check_gas_change_events(dive, pi);
 
        for (cyl = 0; cyl < MAX_CYLINDERS; cyl++) /* initialize the start pressures */
                track_pr[cyl] = pr_track_alloc(dive->cylinder[cyl].start.mbar, -1);
-       current = track_pr[dive->sample[0].cylinderindex];
-       for (i = 0; i < dive->samples; i++) {
-               entry = pi->entry + i + 2;
+       current = track_pr[pi->entry[2].cylinderindex];
+       for (i = 0; i < nr + 1; i++) {
+               entry = pi->entry + i + 1;
 
                entry->same_cylinder = entry->cylinderindex == cylinderindex;
                cylinderindex = entry->cylinderindex;
@@ -938,7 +1148,9 @@ static struct plot_info *create_plot_info(struct dive *dive)
                missing_pr |= !SENSOR_PRESSURE(entry);
        }
 
-       current->t_end = entry->sec;
+       if (entry)
+               current->t_end = entry->sec;
+
        for (cyl = 0; cyl < MAX_CYLINDERS; cyl++) { /* initialize the end pressures */
                int pr = dive->cylinder[cyl].end.mbar;
                if (pr && track_pr[cyl]) {
@@ -946,13 +1158,16 @@ static struct plot_info *create_plot_info(struct dive *dive)
                        pr_track->end = pr;
                }
        }
-       if (lastdepth)
-               lastindex = i + 2;
        /* Fill in the last two entries with empty values but valid times */
-       i = dive->samples + 2;
+       i = nr + 2;
        pi->entry[i].sec = sec + 20;
        pi->entry[i+1].sec = sec + 40;
+       /* the number of actual entries - some computers have lots of
+        * depth 0 samples at the end of a dive, we want to make sure
+        * we have exactly one of them at the end */
        pi->nr = lastindex+1;
+       while (pi->nr <= i+2 && pi->entry[pi->nr-1].depth > 0)
+               pi->nr++;
        pi->maxtime = pi->entry[lastindex].sec;
 
        pi->endpressure = pi->minpressure = dive->cylinder[0].end.mbar;
@@ -965,12 +1180,31 @@ static struct plot_info *create_plot_info(struct dive *dive)
        }
        for (cyl = 0; cyl < MAX_CYLINDERS; cyl++)
                list_free(track_pr[cyl]);
+       if (0) /* awesome for debugging - not useful otherwise */
+               dump_pi(pi);
        return analyze_plot_info(pi);
 }
 
 void plot(struct graphics_context *gc, cairo_rectangle_int_t *drawing_area, struct dive *dive)
 {
-       struct plot_info *pi = create_plot_info(dive);
+       struct plot_info *pi;
+       static struct sample fake[4];
+       struct sample *sample = dive->sample;
+       int nr = dive->samples;
+
+       if (!nr) {
+               int duration = dive->duration.seconds;
+               int maxdepth = dive->maxdepth.mm;
+               sample = fake;
+               fake[1].time.seconds = duration * 0.05;
+               fake[1].depth.mm = maxdepth;
+               fake[2].time.seconds = duration * 0.95;
+               fake[2].depth.mm = maxdepth;
+               fake[3].time.seconds = duration * 1.00;
+               nr = 4;
+       }
+
+       pi = create_plot_info(dive, nr, sample);
 
        cairo_translate(gc->cr, drawing_area->x, drawing_area->y);
        cairo_set_line_width(gc->cr, 2);