dmTCFramesBetween(3dm)                                  dmTCFramesBetween(3dm)


NAME
     dmTCFramesBetween - digital media timecode mathematics

SYNOPSIS
     #include <dmedia/dm_timecode.h>

     DMstatus dmTCFramesBetween
         ( int *result,
           const DMtimecode *a,
           const DMtimecode *b )


TYPES
     DMtimecode   A structure containing a representation of SMPTE time code
                  on which certain mathematical and utility functions can be
                  performed.  Can be used with:  dmTCAddTC(3dm),
                  dmTCAddFrames(3dm), dmTCToString(3dm), dmTCFromSeconds(3dm),
                  dmTCToSeconds(3dm), dmTCFromString(3dm),
                  dmTCFramesPerDay(3dm), and dmTCFramesBetween(3dm).  Can also
                  be used with the dmLTC(3dm) and dmVITC(3dm) routines.  See
                  also DMtimecode(3dm).


ARGUMENTS
     result The result of calculating the difference (b-a), measured
              in frames.


     a, b     The two operands of the differencing operation.


DESCRIPTION
     dmFramesBetween is used to determine the number of frames between two
     timecodes. It returns (b - a), as measured in frames.  The result of the
     difference operation may be negative; this is not an error condition.

     Note that the operands a and b must have the same tc_type as each other.


RETURN VALUE
     If a DMtimecode operand (a or b) contains an illegal timecode value
     (e.g., a negative entry, invalid frame number, etc.), these functions
     will return DM_FAILURE, and the contents of result will be undefined.

     If the tc_type's of a and b do not match, dmTCFramesBetween will return
     DM_FAILURE, and the contents of result will be undefined.

     dmTCFramesBetween returns DM_SUCCESS upon successful completion of the
     subtraction operation.


SEE ALSO
     dmTCFromSeconds(3dm), dmTCToSeconds(3dm), dmTCFromString(3dm),
     dmTCFromString(3dm), dmTCFramesPerDay(3dm), dmTCFramesBetween(3dm),
     dmLTC(3dm), dmVITC(3dm)


                                                                        Page 2