progress.h

/*
 * progress.h
 * $Id: progress.h,v 1.11 2006/09/01 17:20:50 bobi Exp $
 *
 * Copyright 2004 Bobi B., w1zard0f07@yahoo.com
 *
 * This file is part of hdl_dump.
 *
 * hdl_dump is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * hdl_dump is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with hdl_dump; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#if !defined(_PROGRESS_H)
#define _PROGRESS_H

#include "config.h"
#include <time.h>

C_START

/*
 * the shorter that is, the faster it will respond to the changes,
 * however it will be more inacurate;
 * heavily depends on the distance between and height of measurements;
 * # measures of 1MB each => track last # megabytes
 */
#define PG_HIST_SIZE 10


/* high-resolution timers support */
#define HIGHRES_TO_SEC 1000000 /* microseconds */

#if defined(_BUILD_WIN32) && !defined(_BUILD_WINE)
#include <windows.h>
typedef LARGE_INTEGER highres_time_t;
#endif

#if defined(_BUILD_UNIX) || defined(_BUILD_WINE)
#include <sys/time.h>
typedef struct timeval highres_time_t;
#endif

void highres_time(/*@out@*/ highres_time_t *cl);
u_int64_t highres_time_val(const highres_time_t *cl);


typedef struct progress_type progress_t;

/* returns 0 to continue, other to interrupt */
typedef int (*progress_cb_t)(progress_t *, void *);

/* TODO: check overflow with big files */
struct progress_type
{                               /* "private" */
    u_int64_t start_, elapsed_; /* highres_time_val */
    u_int64_t offset_;          /* of the current block, absolute */
    progress_cb_t progress_cb_;
    /*@dependent@*/ void *progress_data_;
    int last_elapsed_; /* last time when the estimated has been calculated */

    /* history/histogram to track current speed */
    struct hist_t
    {
        u_int32_t how_much;
        u_int64_t when; /* highres_time_val */
    } history_[PG_HIST_SIZE];
    u_int32_t hist_pos_;
    u_int64_t hist_sum_; /* = select sum (how_much) from history_ */

    /* last major values when callback has been called */
    int call_pc_completed_, call_elapsed_, call_estimated_, call_remaining_;

    /* "public" */
    u_int64_t total, curr;             /* in bytes */
    long avg_bps, curr_bps;            /* avg and curr bps (since the begining) */
    int pc_completed;                  /* in % */
    int elapsed, estimated, remaining; /* in seconds or -1 */
    char elapsed_text[20], estimated_text[20], remaining_text[20];
};


progress_t *pgs_alloc(progress_cb_t progress_cb,
                      void *data);

void pgs_free(progress_t *pgs);

void pgs_prepare(progress_t *pgs,
                 u_int64_t total);

void pgs_chunk_complete(progress_t *pgs);

int pgs_update(progress_t *pgs,
               u_int64_t curr);

C_END

#endif /* _PROGRESS_H defined? */