cannam@85: /*
cannam@85:  * libmad - MPEG audio decoder library
cannam@85:  * Copyright (C) 2000-2004 Underbit Technologies, Inc.
cannam@85:  *
cannam@85:  * This program is free software; you can redistribute it and/or modify
cannam@85:  * it under the terms of the GNU General Public License as published by
cannam@85:  * the Free Software Foundation; either version 2 of the License, or
cannam@85:  * (at your option) any later version.
cannam@85:  *
cannam@85:  * This program is distributed in the hope that it will be useful,
cannam@85:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@85:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@85:  * GNU General Public License for more details.
cannam@85:  *
cannam@85:  * You should have received a copy of the GNU General Public License
cannam@85:  * along with this program; if not, write to the Free Software
cannam@85:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
cannam@85:  *
cannam@85:  * $Id: timer.c,v 1.18 2004/01/23 09:41:33 rob Exp $
cannam@85:  */
cannam@85: 
cannam@85: # ifdef HAVE_CONFIG_H
cannam@85: #  include "config.h"
cannam@85: # endif
cannam@85: 
cannam@85: # include "global.h"
cannam@85: 
cannam@85: # include <stdio.h>
cannam@85: 
cannam@85: # ifdef HAVE_ASSERT_H
cannam@85: #  include <assert.h>
cannam@85: # endif
cannam@85: 
cannam@85: # include "timer.h"
cannam@85: 
cannam@85: mad_timer_t const mad_timer_zero = { 0, 0 };
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->compare()
cannam@85:  * DESCRIPTION:	indicate relative order of two timers
cannam@85:  */
cannam@85: int mad_timer_compare(mad_timer_t timer1, mad_timer_t timer2)
cannam@85: {
cannam@85:   signed long diff;
cannam@85: 
cannam@85:   diff = timer1.seconds - timer2.seconds;
cannam@85:   if (diff < 0)
cannam@85:     return -1;
cannam@85:   else if (diff > 0)
cannam@85:     return +1;
cannam@85: 
cannam@85:   diff = timer1.fraction - timer2.fraction;
cannam@85:   if (diff < 0)
cannam@85:     return -1;
cannam@85:   else if (diff > 0)
cannam@85:     return +1;
cannam@85: 
cannam@85:   return 0;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->negate()
cannam@85:  * DESCRIPTION:	invert the sign of a timer
cannam@85:  */
cannam@85: void mad_timer_negate(mad_timer_t *timer)
cannam@85: {
cannam@85:   timer->seconds = -timer->seconds;
cannam@85: 
cannam@85:   if (timer->fraction) {
cannam@85:     timer->seconds -= 1;
cannam@85:     timer->fraction = MAD_TIMER_RESOLUTION - timer->fraction;
cannam@85:   }
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->abs()
cannam@85:  * DESCRIPTION:	return the absolute value of a timer
cannam@85:  */
cannam@85: mad_timer_t mad_timer_abs(mad_timer_t timer)
cannam@85: {
cannam@85:   if (timer.seconds < 0)
cannam@85:     mad_timer_negate(&timer);
cannam@85: 
cannam@85:   return timer;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	reduce_timer()
cannam@85:  * DESCRIPTION:	carry timer fraction into seconds
cannam@85:  */
cannam@85: static
cannam@85: void reduce_timer(mad_timer_t *timer)
cannam@85: {
cannam@85:   timer->seconds  += timer->fraction / MAD_TIMER_RESOLUTION;
cannam@85:   timer->fraction %= MAD_TIMER_RESOLUTION;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	gcd()
cannam@85:  * DESCRIPTION:	compute greatest common denominator
cannam@85:  */
cannam@85: static
cannam@85: unsigned long gcd(unsigned long num1, unsigned long num2)
cannam@85: {
cannam@85:   unsigned long tmp;
cannam@85: 
cannam@85:   while (num2) {
cannam@85:     tmp  = num2;
cannam@85:     num2 = num1 % num2;
cannam@85:     num1 = tmp;
cannam@85:   }
cannam@85: 
cannam@85:   return num1;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	reduce_rational()
cannam@85:  * DESCRIPTION:	convert rational expression to lowest terms
cannam@85:  */
cannam@85: static
cannam@85: void reduce_rational(unsigned long *numer, unsigned long *denom)
cannam@85: {
cannam@85:   unsigned long factor;
cannam@85: 
cannam@85:   factor = gcd(*numer, *denom);
cannam@85: 
cannam@85:   assert(factor != 0);
cannam@85: 
cannam@85:   *numer /= factor;
cannam@85:   *denom /= factor;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	scale_rational()
cannam@85:  * DESCRIPTION:	solve numer/denom == ?/scale avoiding overflowing
cannam@85:  */
cannam@85: static
cannam@85: unsigned long scale_rational(unsigned long numer, unsigned long denom,
cannam@85: 			     unsigned long scale)
cannam@85: {
cannam@85:   reduce_rational(&numer, &denom);
cannam@85:   reduce_rational(&scale, &denom);
cannam@85: 
cannam@85:   assert(denom != 0);
cannam@85: 
cannam@85:   if (denom < scale)
cannam@85:     return numer * (scale / denom) + numer * (scale % denom) / denom;
cannam@85:   if (denom < numer)
cannam@85:     return scale * (numer / denom) + scale * (numer % denom) / denom;
cannam@85: 
cannam@85:   return numer * scale / denom;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->set()
cannam@85:  * DESCRIPTION:	set timer to specific (positive) value
cannam@85:  */
cannam@85: void mad_timer_set(mad_timer_t *timer, unsigned long seconds,
cannam@85: 		   unsigned long numer, unsigned long denom)
cannam@85: {
cannam@85:   timer->seconds = seconds;
cannam@85:   if (numer >= denom && denom > 0) {
cannam@85:     timer->seconds += numer / denom;
cannam@85:     numer %= denom;
cannam@85:   }
cannam@85: 
cannam@85:   switch (denom) {
cannam@85:   case 0:
cannam@85:   case 1:
cannam@85:     timer->fraction = 0;
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_TIMER_RESOLUTION:
cannam@85:     timer->fraction = numer;
cannam@85:     break;
cannam@85: 
cannam@85:   case 1000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION /  1000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 8000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION /  8000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 11025:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 11025);
cannam@85:     break;
cannam@85: 
cannam@85:   case 12000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 12000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 16000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 16000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 22050:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 22050);
cannam@85:     break;
cannam@85: 
cannam@85:   case 24000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 24000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 32000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 32000);
cannam@85:     break;
cannam@85: 
cannam@85:   case 44100:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 44100);
cannam@85:     break;
cannam@85: 
cannam@85:   case 48000:
cannam@85:     timer->fraction = numer * (MAD_TIMER_RESOLUTION / 48000);
cannam@85:     break;
cannam@85: 
cannam@85:   default:
cannam@85:     timer->fraction = scale_rational(numer, denom, MAD_TIMER_RESOLUTION);
cannam@85:     break;
cannam@85:   }
cannam@85: 
cannam@85:   if (timer->fraction >= MAD_TIMER_RESOLUTION)
cannam@85:     reduce_timer(timer);
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->add()
cannam@85:  * DESCRIPTION:	add one timer to another
cannam@85:  */
cannam@85: void mad_timer_add(mad_timer_t *timer, mad_timer_t incr)
cannam@85: {
cannam@85:   timer->seconds  += incr.seconds;
cannam@85:   timer->fraction += incr.fraction;
cannam@85: 
cannam@85:   if (timer->fraction >= MAD_TIMER_RESOLUTION)
cannam@85:     reduce_timer(timer);
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->multiply()
cannam@85:  * DESCRIPTION:	multiply a timer by a scalar value
cannam@85:  */
cannam@85: void mad_timer_multiply(mad_timer_t *timer, signed long scalar)
cannam@85: {
cannam@85:   mad_timer_t addend;
cannam@85:   unsigned long factor;
cannam@85: 
cannam@85:   factor = scalar;
cannam@85:   if (scalar < 0) {
cannam@85:     factor = -scalar;
cannam@85:     mad_timer_negate(timer);
cannam@85:   }
cannam@85: 
cannam@85:   addend = *timer;
cannam@85:   *timer = mad_timer_zero;
cannam@85: 
cannam@85:   while (factor) {
cannam@85:     if (factor & 1)
cannam@85:       mad_timer_add(timer, addend);
cannam@85: 
cannam@85:     mad_timer_add(&addend, addend);
cannam@85:     factor >>= 1;
cannam@85:   }
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->count()
cannam@85:  * DESCRIPTION:	return timer value in selected units
cannam@85:  */
cannam@85: signed long mad_timer_count(mad_timer_t timer, enum mad_units units)
cannam@85: {
cannam@85:   switch (units) {
cannam@85:   case MAD_UNITS_HOURS:
cannam@85:     return timer.seconds / 60 / 60;
cannam@85: 
cannam@85:   case MAD_UNITS_MINUTES:
cannam@85:     return timer.seconds / 60;
cannam@85: 
cannam@85:   case MAD_UNITS_SECONDS:
cannam@85:     return timer.seconds;
cannam@85: 
cannam@85:   case MAD_UNITS_DECISECONDS:
cannam@85:   case MAD_UNITS_CENTISECONDS:
cannam@85:   case MAD_UNITS_MILLISECONDS:
cannam@85: 
cannam@85:   case MAD_UNITS_8000_HZ:
cannam@85:   case MAD_UNITS_11025_HZ:
cannam@85:   case MAD_UNITS_12000_HZ:
cannam@85:   case MAD_UNITS_16000_HZ:
cannam@85:   case MAD_UNITS_22050_HZ:
cannam@85:   case MAD_UNITS_24000_HZ:
cannam@85:   case MAD_UNITS_32000_HZ:
cannam@85:   case MAD_UNITS_44100_HZ:
cannam@85:   case MAD_UNITS_48000_HZ:
cannam@85: 
cannam@85:   case MAD_UNITS_24_FPS:
cannam@85:   case MAD_UNITS_25_FPS:
cannam@85:   case MAD_UNITS_30_FPS:
cannam@85:   case MAD_UNITS_48_FPS:
cannam@85:   case MAD_UNITS_50_FPS:
cannam@85:   case MAD_UNITS_60_FPS:
cannam@85:   case MAD_UNITS_75_FPS:
cannam@85:     return timer.seconds * (signed long) units +
cannam@85:       (signed long) scale_rational(timer.fraction, MAD_TIMER_RESOLUTION,
cannam@85: 				   units);
cannam@85: 
cannam@85:   case MAD_UNITS_23_976_FPS:
cannam@85:   case MAD_UNITS_24_975_FPS:
cannam@85:   case MAD_UNITS_29_97_FPS:
cannam@85:   case MAD_UNITS_47_952_FPS:
cannam@85:   case MAD_UNITS_49_95_FPS:
cannam@85:   case MAD_UNITS_59_94_FPS:
cannam@85:     return (mad_timer_count(timer, -units) + 1) * 1000 / 1001;
cannam@85:   }
cannam@85: 
cannam@85:   /* unsupported units */
cannam@85:   return 0;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->fraction()
cannam@85:  * DESCRIPTION:	return fractional part of timer in arbitrary terms
cannam@85:  */
cannam@85: unsigned long mad_timer_fraction(mad_timer_t timer, unsigned long denom)
cannam@85: {
cannam@85:   timer = mad_timer_abs(timer);
cannam@85: 
cannam@85:   switch (denom) {
cannam@85:   case 0:
cannam@85:     return timer.fraction ?
cannam@85:       MAD_TIMER_RESOLUTION / timer.fraction : MAD_TIMER_RESOLUTION + 1;
cannam@85: 
cannam@85:   case MAD_TIMER_RESOLUTION:
cannam@85:     return timer.fraction;
cannam@85: 
cannam@85:   default:
cannam@85:     return scale_rational(timer.fraction, MAD_TIMER_RESOLUTION, denom);
cannam@85:   }
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	timer->string()
cannam@85:  * DESCRIPTION:	write a string representation of a timer using a template
cannam@85:  */
cannam@85: void mad_timer_string(mad_timer_t timer,
cannam@85: 		      char *dest, char const *format, enum mad_units units,
cannam@85: 		      enum mad_units fracunits, unsigned long subparts)
cannam@85: {
cannam@85:   unsigned long hours, minutes, seconds, sub;
cannam@85:   unsigned int frac;
cannam@85: 
cannam@85:   timer = mad_timer_abs(timer);
cannam@85: 
cannam@85:   seconds = timer.seconds;
cannam@85:   frac = sub = 0;
cannam@85: 
cannam@85:   switch (fracunits) {
cannam@85:   case MAD_UNITS_HOURS:
cannam@85:   case MAD_UNITS_MINUTES:
cannam@85:   case MAD_UNITS_SECONDS:
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_UNITS_DECISECONDS:
cannam@85:   case MAD_UNITS_CENTISECONDS:
cannam@85:   case MAD_UNITS_MILLISECONDS:
cannam@85: 
cannam@85:   case MAD_UNITS_8000_HZ:
cannam@85:   case MAD_UNITS_11025_HZ:
cannam@85:   case MAD_UNITS_12000_HZ:
cannam@85:   case MAD_UNITS_16000_HZ:
cannam@85:   case MAD_UNITS_22050_HZ:
cannam@85:   case MAD_UNITS_24000_HZ:
cannam@85:   case MAD_UNITS_32000_HZ:
cannam@85:   case MAD_UNITS_44100_HZ:
cannam@85:   case MAD_UNITS_48000_HZ:
cannam@85: 
cannam@85:   case MAD_UNITS_24_FPS:
cannam@85:   case MAD_UNITS_25_FPS:
cannam@85:   case MAD_UNITS_30_FPS:
cannam@85:   case MAD_UNITS_48_FPS:
cannam@85:   case MAD_UNITS_50_FPS:
cannam@85:   case MAD_UNITS_60_FPS:
cannam@85:   case MAD_UNITS_75_FPS:
cannam@85:     {
cannam@85:       unsigned long denom;
cannam@85: 
cannam@85:       denom = MAD_TIMER_RESOLUTION / fracunits;
cannam@85: 
cannam@85:       frac = timer.fraction / denom;
cannam@85:       sub  = scale_rational(timer.fraction % denom, denom, subparts);
cannam@85:     }
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_UNITS_23_976_FPS:
cannam@85:   case MAD_UNITS_24_975_FPS:
cannam@85:   case MAD_UNITS_29_97_FPS:
cannam@85:   case MAD_UNITS_47_952_FPS:
cannam@85:   case MAD_UNITS_49_95_FPS:
cannam@85:   case MAD_UNITS_59_94_FPS:
cannam@85:     /* drop-frame encoding */
cannam@85:     /* N.B. this is only well-defined for MAD_UNITS_29_97_FPS */
cannam@85:     {
cannam@85:       unsigned long frame, cycle, d, m;
cannam@85: 
cannam@85:       frame = mad_timer_count(timer, fracunits);
cannam@85: 
cannam@85:       cycle = -fracunits * 60 * 10 - (10 - 1) * 2;
cannam@85: 
cannam@85:       d = frame / cycle;
cannam@85:       m = frame % cycle;
cannam@85:       frame += (10 - 1) * 2 * d;
cannam@85:       if (m > 2)
cannam@85: 	frame += 2 * ((m - 2) / (cycle / 10));
cannam@85: 
cannam@85:       frac    = frame % -fracunits;
cannam@85:       seconds = frame / -fracunits;
cannam@85:     }
cannam@85:     break;
cannam@85:   }
cannam@85: 
cannam@85:   switch (units) {
cannam@85:   case MAD_UNITS_HOURS:
cannam@85:     minutes = seconds / 60;
cannam@85:     hours   = minutes / 60;
cannam@85: 
cannam@85:     sprintf(dest, format,
cannam@85: 	    hours,
cannam@85: 	    (unsigned int) (minutes % 60),
cannam@85: 	    (unsigned int) (seconds % 60),
cannam@85: 	    frac, sub);
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_UNITS_MINUTES:
cannam@85:     minutes = seconds / 60;
cannam@85: 
cannam@85:     sprintf(dest, format,
cannam@85: 	    minutes,
cannam@85: 	    (unsigned int) (seconds % 60),
cannam@85: 	    frac, sub);
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_UNITS_SECONDS:
cannam@85:     sprintf(dest, format,
cannam@85: 	    seconds,
cannam@85: 	    frac, sub);
cannam@85:     break;
cannam@85: 
cannam@85:   case MAD_UNITS_23_976_FPS:
cannam@85:   case MAD_UNITS_24_975_FPS:
cannam@85:   case MAD_UNITS_29_97_FPS:
cannam@85:   case MAD_UNITS_47_952_FPS:
cannam@85:   case MAD_UNITS_49_95_FPS:
cannam@85:   case MAD_UNITS_59_94_FPS:
cannam@85:     if (fracunits < 0) {
cannam@85:       /* not yet implemented */
cannam@85:       sub = 0;
cannam@85:     }
cannam@85: 
cannam@85:     /* fall through */
cannam@85: 
cannam@85:   case MAD_UNITS_DECISECONDS:
cannam@85:   case MAD_UNITS_CENTISECONDS:
cannam@85:   case MAD_UNITS_MILLISECONDS:
cannam@85: 
cannam@85:   case MAD_UNITS_8000_HZ:
cannam@85:   case MAD_UNITS_11025_HZ:
cannam@85:   case MAD_UNITS_12000_HZ:
cannam@85:   case MAD_UNITS_16000_HZ:
cannam@85:   case MAD_UNITS_22050_HZ:
cannam@85:   case MAD_UNITS_24000_HZ:
cannam@85:   case MAD_UNITS_32000_HZ:
cannam@85:   case MAD_UNITS_44100_HZ:
cannam@85:   case MAD_UNITS_48000_HZ:
cannam@85: 
cannam@85:   case MAD_UNITS_24_FPS:
cannam@85:   case MAD_UNITS_25_FPS:
cannam@85:   case MAD_UNITS_30_FPS:
cannam@85:   case MAD_UNITS_48_FPS:
cannam@85:   case MAD_UNITS_50_FPS:
cannam@85:   case MAD_UNITS_60_FPS:
cannam@85:   case MAD_UNITS_75_FPS:
cannam@85:     sprintf(dest, format, mad_timer_count(timer, units), sub);
cannam@85:     break;
cannam@85:   }
cannam@85: }