2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 VikTrack *vik_track_new()
36 VikTrack *tr = g_malloc0 ( sizeof ( VikTrack ) );
41 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment)
44 g_free ( tr->comment );
45 tr->comment = comment;
49 void vik_track_set_comment(VikTrack *tr, const gchar *comment)
52 g_free ( tr->comment );
54 if ( comment && comment[0] != '\0' )
55 tr->comment = g_strdup(comment);
60 void vik_track_ref(VikTrack *tr)
65 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog)
67 /* Warning: does not check for existing dialog */
68 tr->property_dialog = dialog;
71 void vik_track_clear_property_dialog(VikTrack *tr)
73 tr->property_dialog = NULL;
76 void vik_track_free(VikTrack *tr)
78 if ( tr->ref_count-- > 1 )
82 g_free ( tr->comment );
83 g_list_foreach ( tr->trackpoints, (GFunc) g_free, NULL );
84 g_list_free( tr->trackpoints );
85 if (tr->property_dialog)
86 gtk_widget_destroy ( GTK_WIDGET(tr->property_dialog) );
90 VikTrack *vik_track_copy ( const VikTrack *tr )
92 VikTrack *new_tr = vik_track_new();
93 VikTrackpoint *new_tp;
94 GList *tp_iter = tr->trackpoints;
95 new_tr->visible = tr->visible;
96 new_tr->trackpoints = NULL;
99 new_tp = g_malloc ( sizeof ( VikTrackpoint ) );
100 *new_tp = *((VikTrackpoint *)(tp_iter->data));
101 new_tr->trackpoints = g_list_append ( new_tr->trackpoints, new_tp );
102 tp_iter = tp_iter->next;
104 vik_track_set_comment(new_tr,tr->comment);
108 VikTrackpoint *vik_trackpoint_new()
110 VikTrackpoint *tp = g_malloc0(sizeof(VikTrackpoint));
111 tp->extended = FALSE;
117 void vik_trackpoint_free(VikTrackpoint *tp)
122 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp)
124 VikTrackpoint *rv = vik_trackpoint_new();
129 gdouble vik_track_get_length(const VikTrack *tr)
132 if ( tr->trackpoints )
134 GList *iter = tr->trackpoints->next;
137 if ( ! VIK_TRACKPOINT(iter->data)->newsegment )
138 len += vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
139 &(VIK_TRACKPOINT(iter->prev->data)->coord) );
146 gdouble vik_track_get_length_including_gaps(const VikTrack *tr)
149 if ( tr->trackpoints )
151 GList *iter = tr->trackpoints->next;
154 len += vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
155 &(VIK_TRACKPOINT(iter->prev->data)->coord) );
162 gulong vik_track_get_tp_count(const VikTrack *tr)
165 GList *iter = tr->trackpoints;
174 gulong vik_track_get_dup_point_count ( const VikTrack *tr )
177 GList *iter = tr->trackpoints;
180 if ( iter->next && vik_coord_equals ( &(VIK_TRACKPOINT(iter->data)->coord),
181 &(VIK_TRACKPOINT(iter->next->data)->coord) ) )
188 void vik_track_remove_dup_points ( VikTrack *tr )
190 GList *iter = tr->trackpoints;
193 if ( iter->next && vik_coord_equals ( &(VIK_TRACKPOINT(iter->data)->coord),
194 &(VIK_TRACKPOINT(iter->next->data)->coord) ) )
196 g_free ( iter->next->data );
197 tr->trackpoints = g_list_delete_link ( tr->trackpoints, iter->next );
204 guint vik_track_get_segment_count(const VikTrack *tr)
207 GList *iter = tr->trackpoints;
210 while ( (iter = iter->next) )
212 if ( VIK_TRACKPOINT(iter->data)->newsegment )
218 VikTrack **vik_track_split_into_segments(VikTrack *t, guint *ret_len)
223 guint segs = vik_track_get_segment_count(t);
232 rv = g_malloc ( segs * sizeof(VikTrack *) );
233 tr = vik_track_copy ( t );
235 iter = tr->trackpoints;
238 while ( (iter = iter->next) )
240 if ( VIK_TRACKPOINT(iter->data)->newsegment )
242 iter->prev->next = NULL;
244 rv[i] = vik_track_new();
246 vik_track_set_comment ( rv[i], tr->comment );
247 rv[i]->visible = tr->visible;
248 rv[i]->trackpoints = iter;
256 void vik_track_reverse ( VikTrack *tr )
259 tr->trackpoints = g_list_reverse(tr->trackpoints);
261 /* fix 'newsegment' */
262 iter = g_list_last ( tr->trackpoints );
265 if ( ! iter->next ) /* last segment, was first, cancel newsegment. */
266 VIK_TRACKPOINT(iter->data)->newsegment = FALSE;
267 if ( ! iter->prev ) /* first segment by convention has newsegment flag. */
268 VIK_TRACKPOINT(iter->data)->newsegment = TRUE;
269 else if ( VIK_TRACKPOINT(iter->data)->newsegment && iter->next )
271 VIK_TRACKPOINT(iter->next->data)->newsegment = TRUE;
272 VIK_TRACKPOINT(iter->data)->newsegment = FALSE;
278 gdouble vik_track_get_average_speed(const VikTrack *tr)
282 if ( tr->trackpoints )
284 GList *iter = tr->trackpoints->next;
287 if ( VIK_TRACKPOINT(iter->data)->has_timestamp &&
288 VIK_TRACKPOINT(iter->prev->data)->has_timestamp &&
289 (! VIK_TRACKPOINT(iter->data)->newsegment) )
291 len += vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
292 &(VIK_TRACKPOINT(iter->prev->data)->coord) );
293 time += ABS(VIK_TRACKPOINT(iter->data)->timestamp - VIK_TRACKPOINT(iter->prev->data)->timestamp);
298 return (time == 0) ? 0 : ABS(len/time);
301 gdouble vik_track_get_max_speed(const VikTrack *tr)
303 gdouble maxspeed = 0.0, speed = 0.0;
304 if ( tr->trackpoints )
306 GList *iter = tr->trackpoints->next;
309 if ( VIK_TRACKPOINT(iter->data)->has_timestamp &&
310 VIK_TRACKPOINT(iter->prev->data)->has_timestamp &&
311 (! VIK_TRACKPOINT(iter->data)->newsegment) )
313 speed = vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord), &(VIK_TRACKPOINT(iter->prev->data)->coord) )
314 / ABS(VIK_TRACKPOINT(iter->data)->timestamp - VIK_TRACKPOINT(iter->prev->data)->timestamp);
315 if ( speed > maxspeed )
324 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode )
326 GList *iter = tr->trackpoints;
329 vik_coord_convert ( &(VIK_TRACKPOINT(iter->data)->coord), dest_mode );
334 /* I understood this when I wrote it ... maybe ... Basically it eats up the
335 * proper amounts of length on the track and averages elevation over that. */
336 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks )
339 gdouble total_length, chunk_length, current_dist, current_area_under_curve, current_seg_length, dist_along_seg = 0.0;
340 gdouble altitude1, altitude2;
341 guint16 current_chunk;
342 gboolean ignore_it = FALSE;
344 GList *iter = tr->trackpoints;
346 if (!iter || !iter->next) /* zero- or one-point track */
349 { /* test if there's anything worth calculating */
350 gboolean okay = FALSE;
353 if ( VIK_TRACKPOINT(iter->data)->altitude != VIK_DEFAULT_ALTITUDE ) {
362 iter = tr->trackpoints;
364 g_assert ( num_chunks < 16000 );
366 pts = g_malloc ( sizeof(gdouble) * num_chunks );
368 total_length = vik_track_get_length_including_gaps ( tr );
369 chunk_length = total_length / num_chunks;
371 /* Zero chunk_length (eg, track of 2 tp with the same loc) will cause crash */
372 if (chunk_length <= 0)
376 current_area_under_curve = 0;
378 current_seg_length = 0;
380 current_seg_length = vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
381 &(VIK_TRACKPOINT(iter->next->data)->coord) );
382 altitude1 = VIK_TRACKPOINT(iter->data)->altitude;
383 altitude2 = VIK_TRACKPOINT(iter->next->data)->altitude;
386 while ( current_chunk < num_chunks ) {
388 /* go along current seg */
389 if ( current_seg_length && (current_seg_length - dist_along_seg) > chunk_length ) {
390 dist_along_seg += chunk_length;
394 * /x altitude = alt_at_pt_1 + alt_at_pt_2 / 2 = altitude1 + slope * dist_value_of_pt_inbetween_pt1_and_pt2
395 * /xx avg altitude = area under curve / chunk len
396 *pt1 *xxx avg altitude = altitude1 + (altitude2-altitude1)/(current_seg_length)*(dist_along_seg + (chunk_len/2))
402 pts[current_chunk] = VIK_DEFAULT_ALTITUDE;
404 pts[current_chunk] = altitude1 + (altitude2-altitude1)*((dist_along_seg - (chunk_length/2))/current_seg_length);
408 /* finish current seg */
409 if ( current_seg_length ) {
410 gdouble altitude_at_dist_along_seg = altitude1 + (altitude2-altitude1)/(current_seg_length)*dist_along_seg;
411 current_dist = current_seg_length - dist_along_seg;
412 current_area_under_curve = current_dist*(altitude_at_dist_along_seg + altitude2)*0.5;
413 } else { current_dist = current_area_under_curve = 0; } /* should only happen if first current_seg_length == 0 */
415 /* get intervening segs */
417 while ( iter && iter->next ) {
418 current_seg_length = vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
419 &(VIK_TRACKPOINT(iter->next->data)->coord) );
420 altitude1 = VIK_TRACKPOINT(iter->data)->altitude;
421 altitude2 = VIK_TRACKPOINT(iter->next->data)->altitude;
422 ignore_it = VIK_TRACKPOINT(iter->next->data)->newsegment;
424 if ( chunk_length - current_dist >= current_seg_length ) {
425 current_dist += current_seg_length;
426 current_area_under_curve += current_seg_length * (altitude1+altitude2) * 0.5;
434 dist_along_seg = chunk_length - current_dist;
435 if ( ignore_it || !iter->next ) {
436 pts[current_chunk] = current_area_under_curve / current_dist;
439 for (i = current_chunk + 1; i < num_chunks; i++)
440 pts[i] = pts[current_chunk];
445 current_area_under_curve += dist_along_seg * (altitude1 + (altitude2 - altitude1)*dist_along_seg/current_seg_length);
446 pts[current_chunk] = current_area_under_curve / chunk_length;
458 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down)
462 if ( tr->trackpoints && VIK_TRACKPOINT(tr->trackpoints->data)->altitude != VIK_DEFAULT_ALTITUDE )
464 GList *iter = tr->trackpoints->next;
467 diff = VIK_TRACKPOINT(iter->data)->altitude - VIK_TRACKPOINT(iter->prev->data)->altitude;
475 *up = *down = VIK_DEFAULT_ALTITUDE;
479 /* by Alex Foobarian */
480 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks )
483 gdouble duration, chunk_dur, T, s_prev, s_now;
485 int i, pt_count, numpts, index;
488 if ( ! tr->trackpoints )
491 g_assert ( num_chunks < 16000 );
493 t1 = VIK_TRACKPOINT(tr->trackpoints->data)->timestamp;
494 t2 = VIK_TRACKPOINT(g_list_last(tr->trackpoints)->data)->timestamp;
497 if ( !t1 || !t2 || !duration )
501 g_warning("negative duration: unsorted trackpoint timestamps?");
504 pt_count = vik_track_get_tp_count(tr);
506 v = g_malloc ( sizeof(gdouble) * num_chunks );
507 chunk_dur = duration / num_chunks;
509 s = g_malloc(sizeof(double) * pt_count);
510 t = g_malloc(sizeof(double) * pt_count);
512 iter = tr->trackpoints->next;
515 t[0] = VIK_TRACKPOINT(iter->prev->data)->timestamp;
518 s[numpts] = s[numpts-1] + vik_coord_diff ( &(VIK_TRACKPOINT(iter->prev->data)->coord), &(VIK_TRACKPOINT(iter->data)->coord) );
519 t[numpts] = VIK_TRACKPOINT(iter->data)->timestamp;
524 /* In the following computation, we iterate through periods of time of duration chunk_dur.
525 * The first period begins at the beginning of the track. The last period ends at the end of the track.
527 index = 0; /* index of the current trackpoint. */
528 for (i = 0; i < num_chunks; i++) {
529 /* we are now covering the interval from t[0] + i*chunk_dur to t[0] + (i+1)*chunk_dur.
530 * find the first trackpoint outside the current interval, averaging the speeds between intermediate trackpoints.
532 if (t[0] + i*chunk_dur >= t[index]) {
533 gdouble acc_t = 0, acc_s = 0;
535 while (t[0] + i*chunk_dur >= t[index]) {
536 acc_s += (s[index+1]-s[index]);
537 acc_t += (t[index+1]-t[index]);
555 /* by Alex Foobarian */
556 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start )
558 gdouble dist = vik_track_get_length_including_gaps(tr) * reldist;
559 gdouble current_dist = 0.0;
560 gdouble current_inc = 0.0;
561 if ( tr->trackpoints )
563 GList *iter = tr->trackpoints->next;
564 GList *last_iter = NULL;
565 gdouble last_dist = 0.0;
568 current_inc = vik_coord_diff ( &(VIK_TRACKPOINT(iter->data)->coord),
569 &(VIK_TRACKPOINT(iter->prev->data)->coord) );
570 last_dist = current_dist;
571 current_dist += current_inc;
572 if ( current_dist >= dist )
577 if (!iter) { /* passing the end the track */
579 if (meters_from_start)
580 *meters_from_start = last_dist;
581 return(VIK_TRACKPOINT(last_iter->data));
586 /* we've gone past the dist already, was prev trackpoint closer? */
587 /* should do a vik_coord_average_weighted() thingy. */
588 if ( iter->prev && abs(current_dist-current_inc-dist) < abs(current_dist-dist) ) {
589 if (meters_from_start)
590 *meters_from_start = last_dist;
594 if (meters_from_start)
595 *meters_from_start = current_dist;
597 return VIK_TRACKPOINT(iter->data);
603 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reltime, time_t *seconds_from_start )
605 time_t t_pos, t_start, t_end, t_total;
606 t_start = VIK_TRACKPOINT(tr->trackpoints->data)->timestamp;
607 t_end = VIK_TRACKPOINT(g_list_last(tr->trackpoints)->data)->timestamp;
608 t_total = t_end - t_start;
610 t_pos = t_start + t_total * reltime;
612 if ( !tr->trackpoints )
615 GList *iter = tr->trackpoints;
618 if (VIK_TRACKPOINT(iter->data)->timestamp == t_pos)
620 if (VIK_TRACKPOINT(iter->data)->timestamp > t_pos) {
621 if (iter->prev == NULL) /* first trackpoint */
623 time_t t_before = t_pos - VIK_TRACKPOINT(iter->prev)->timestamp;
624 time_t t_after = VIK_TRACKPOINT(iter->data)->timestamp - t_pos;
625 if (t_before <= t_after)
629 else if ((iter->next == NULL) && (t_pos < (VIK_TRACKPOINT(iter->data)->timestamp + 3))) /* last trackpoint: accommodate for round-off */
636 if (seconds_from_start)
637 *seconds_from_start = VIK_TRACKPOINT(iter->data)->timestamp - VIK_TRACKPOINT(tr->trackpoints->data)->timestamp;
638 return VIK_TRACKPOINT(iter->data);
641 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt )
645 if ( tr && tr->trackpoints && tr->trackpoints->data && (VIK_TRACKPOINT(tr->trackpoints->data)->altitude != VIK_DEFAULT_ALTITUDE) ) {
646 GList *iter = tr->trackpoints->next;
650 tmp_alt = VIK_TRACKPOINT(iter->data)->altitude;
651 if ( tmp_alt > *max_alt )
653 if ( tmp_alt < *min_alt )
662 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *datalen)
665 GByteArray *b = g_byte_array_new();
669 g_byte_array_append(b, (guint8 *)tr, sizeof(*tr));
671 /* we'll fill out number of trackpoints later */
673 g_byte_array_append(b, (guint8 *)&len, sizeof(len));
675 tps = tr->trackpoints;
678 g_byte_array_append(b, (guint8 *)tps->data, sizeof(VikTrackpoint));
682 *(guint *)(b->data + intp) = ntp;
684 len = (tr->comment) ? strlen(tr->comment)+1 : 0;
685 g_byte_array_append(b, (guint8 *)&len, sizeof(len));
686 if (tr->comment) g_byte_array_append(b, (guint8 *)tr->comment, len);
690 g_byte_array_free(b, FALSE);
693 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen)
696 VikTrack *new_tr = vik_track_new();
697 VikTrackpoint *new_tp;
701 /* only the visibility is needed */
702 new_tr->visible = ((VikTrack *)data)->visible;
703 data += sizeof(*new_tr);
705 ntp = *(guint *)data;
708 for (i=0; i<ntp; i++) {
709 new_tp = vik_trackpoint_new();
710 memcpy(new_tp, data, sizeof(*new_tp));
711 data += sizeof(*new_tp);
712 new_tr->trackpoints = g_list_append(new_tr->trackpoints, new_tp);
715 len = *(guint *)data;
718 new_tr->comment = g_strdup((gchar *)data);
723 void vik_track_apply_dem_data ( VikTrack *tr )
727 tp_iter = tr->trackpoints;
729 /* TODO: of the 4 possible choices we have for choosing an elevation
730 * (trackpoint in between samples), choose the one with the least elevation change
732 elev = a_dems_get_elev_by_coord ( &(VIK_TRACKPOINT(tp_iter->data)->coord), VIK_DEM_INTERPOL_BEST );
733 if ( elev != VIK_DEM_INVALID_ELEVATION )
734 VIK_TRACKPOINT(tp_iter->data)->altitude = elev;
735 tp_iter = tp_iter->next;
739 /* appends t2 to t1, leaving t2 with no trackpoints */
740 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 )
742 if ( t1->trackpoints ) {
743 GList *tpiter = t1->trackpoints;
744 while ( tpiter->next )
745 tpiter = tpiter->next;
746 tpiter->next = t2->trackpoints;
747 t2->trackpoints->prev = tpiter;
749 t1->trackpoints = t2->trackpoints;
750 t2->trackpoints = NULL;
753 /* starting at the end, looks backwards for the last "double point", a duplicate trackpoint.
754 * this is indicative of magic scissors continued use. If there is no double point,
755 * deletes all the trackpoints. Returns the new end of the track (or the start if
756 * there are no double points
758 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr )
760 GList *iter = tr->trackpoints;
769 while ( iter->prev ) {
770 if ( vik_coord_equals((VikCoord *)iter->data, (VikCoord *)iter->prev->data) ) {
771 GList *prev = iter->prev;
773 rv = g_malloc(sizeof(VikCoord));
774 *rv = *((VikCoord *) iter->data);
776 /* truncate trackpoint list */
777 iter->prev = NULL; /* pretend it's the end */
778 g_list_foreach ( iter, (GFunc) g_free, NULL );
788 /* no double point found! */
789 rv = g_malloc(sizeof(VikCoord));
790 *rv = *((VikCoord *) tr->trackpoints->data);
791 g_list_foreach ( tr->trackpoints, (GFunc) g_free, NULL );
792 g_list_free( tr->trackpoints );
793 tr->trackpoints = NULL;