libmad: timer.h Source File

00001 /*
00002  * libmad - MPEG audio decoder library
00003  * Copyright (C) 2000-2008 Underbit Technologies, Inc.
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this program; if not, write to the Free Software
00017  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018  *
00019  * $Id: timer.h 88 2008-06-09 11:59:11Z mich $
00020  */
00024 # ifndef LIBMAD_TIMER_H
00025 # define LIBMAD_TIMER_H
00026 
00027 typedef struct {
00028   signed long seconds;          
00029   unsigned long fraction;       
00030 } mad_timer_t;
00031 
00032 extern mad_timer_t const mad_timer_zero;
00033 
00034 # define MAD_TIMER_RESOLUTION   352800000UL
00035 
00036 enum mad_units {
00037   MAD_UNITS_HOURS        =    -2,
00038   MAD_UNITS_MINUTES      =    -1,
00039   MAD_UNITS_SECONDS      =     0,
00040 
00041   /* metric units */
00042 
00043   MAD_UNITS_DECISECONDS  =    10,
00044   MAD_UNITS_CENTISECONDS =   100,
00045   MAD_UNITS_MILLISECONDS =  1000,
00046 
00047   /* audio sample units */
00048 
00049   MAD_UNITS_8000_HZ      =  8000,
00050   MAD_UNITS_11025_HZ     = 11025,
00051   MAD_UNITS_12000_HZ     = 12000,
00052 
00053   MAD_UNITS_16000_HZ     = 16000,
00054   MAD_UNITS_22050_HZ     = 22050,
00055   MAD_UNITS_24000_HZ     = 24000,
00056 
00057   MAD_UNITS_32000_HZ     = 32000,
00058   MAD_UNITS_44100_HZ     = 44100,
00059   MAD_UNITS_48000_HZ     = 48000,
00060 
00061   /* video frame/field units */
00062 
00063   MAD_UNITS_24_FPS       =    24,
00064   MAD_UNITS_25_FPS       =    25,
00065   MAD_UNITS_30_FPS       =    30,
00066   MAD_UNITS_48_FPS       =    48,
00067   MAD_UNITS_50_FPS       =    50,
00068   MAD_UNITS_60_FPS       =    60,
00069 
00070   /* CD audio frames */
00071 
00072   MAD_UNITS_75_FPS       =    75,
00073 
00074   /* video drop-frame units */
00075 
00076   MAD_UNITS_23_976_FPS   =   -24,
00077   MAD_UNITS_24_975_FPS   =   -25,
00078   MAD_UNITS_29_97_FPS    =   -30,
00079   MAD_UNITS_47_952_FPS   =   -48,
00080   MAD_UNITS_49_95_FPS    =   -50,
00081   MAD_UNITS_59_94_FPS    =   -60
00082 };
00083 
00084 # define mad_timer_reset(timer) ((void) (*(timer) = mad_timer_zero))
00085 
00086 int mad_timer_compare(mad_timer_t, mad_timer_t);
00087 
00088 # define mad_timer_sign(timer)  mad_timer_compare((timer), mad_timer_zero)
00089 
00090 void mad_timer_negate(mad_timer_t *);
00091 mad_timer_t mad_timer_abs(mad_timer_t);
00092 
00093 void mad_timer_set(mad_timer_t *, unsigned long, unsigned long, unsigned long);
00094 void mad_timer_add(mad_timer_t *, mad_timer_t);
00095 void mad_timer_multiply(mad_timer_t *, signed long);
00096 
00097 signed long mad_timer_count(mad_timer_t, enum mad_units);
00098 unsigned long mad_timer_fraction(mad_timer_t, unsigned long);
00099 void mad_timer_string(mad_timer_t, char *, char const *,
00100                       enum mad_units, enum mad_units, unsigned long);
00101 
00102 # endif