globally change all use of "frame" to refer to audio into "sample".
[ardour.git] / libs / timecode / timecode / time.h
index 65cd3d7a13b6ea9e83145190cdc68c5de2d9142c..556b73b62507583fc4199010a3e4279d2925510f 100644 (file)
@@ -1,16 +1,16 @@
 /*
        Copyright (C) 2006-2010 Paul Davis
-       
+
        This program is free software; you can redistribute it and/or modify it
        under the terms of the GNU Lesser General Public License as published
        by the Free Software Foundation; either version 2 of the License, or
        (at your option) any later version.
-       
+
        This program 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 this program; if not, write to the Free Software Foundation, Inc.,
        675 Mass Ave, Cambridge, MA 02139, USA.
@@ -19,6 +19,7 @@
 #ifndef __timecode_time_h__
 #define __timecode_time_h__
 
+#include <cmath>
 #include <ostream>
 #include <inttypes.h>
 
@@ -54,7 +55,7 @@ struct LIBTIMECODE_API Time {
        uint32_t      hours;
        uint32_t      minutes;
        uint32_t      seconds;
-       uint32_t      frames;        ///< Timecode frames (not audio samples)
+       uint32_t      frames;        ///< Timecode frames (not audio frames)
        uint32_t      subframes;     ///< Typically unused
        double        rate;          ///< Frame rate of this Time
        static double default_rate;  ///< Rate to use for default constructor
@@ -68,8 +69,9 @@ struct LIBTIMECODE_API Time {
                frames = 0;
                subframes = 0;
                rate = a_rate;
+               drop = (lrintf(100.f * (float)a_rate) == (long)2997);
        }
-       
+
        bool operator== (const Time& other) const {
                return negative == other.negative && hours == other.hours &&
                       minutes == other.minutes && seconds == other.seconds &&
@@ -96,7 +98,7 @@ Wrap LIBTIMECODE_API decrement_subframes (Time& timecode, uint32_t);
 Wrap LIBTIMECODE_API increment_seconds (Time& timecode, uint32_t);
 Wrap LIBTIMECODE_API increment_minutes (Time& timecode, uint32_t);
 Wrap LIBTIMECODE_API increment_hours (Time& timecode, uint32_t);
-void LIBTIMECODE_API frames_floor (Time& timecode);
+void LIBTIMECODE_API frames_floot (Time& timecode);
 void LIBTIMECODE_API seconds_floor (Time& timecode);
 void LIBTIMECODE_API minutes_floor (Time& timecode);
 void LIBTIMECODE_API hours_floor (Time& timecode);
@@ -110,7 +112,7 @@ std::string LIBTIMECODE_API timecode_format_time (Timecode::Time const timecode)
 
 std::string LIBTIMECODE_API timecode_format_sampletime (
                int64_t sample,
-               double sample_frame_rate,
+               double sample_sample_rate,
                double timecode_frames_per_second, bool timecode_drop_frames
                );
 
@@ -120,7 +122,7 @@ void LIBTIMECODE_API timecode_to_sample(
                Timecode::Time& timecode, int64_t& sample,
                bool use_offset, bool use_subframes,
     /* Note - framerate info is taken from Timecode::Time& */
-               double sample_frame_rate /**< may include pull up/down */,
+               double sample_sample_rate /**< may include pull up/down */,
                uint32_t subframes_per_frame /**< must not be 0 if use_subframes==true */,
     /* optional offset  - can be improved: function pointer to lazily query this*/
                bool offset_is_negative, int64_t offset_samples
@@ -132,7 +134,7 @@ void LIBTIMECODE_API sample_to_timecode (
     /* framerate info */
                double timecode_frames_per_second,
                bool   timecode_drop_frames,
-               double sample_frame_rate/**< can include pull up/down */,
+               double sample_sample_rate/**< can include pull up/down */,
                uint32_t subframes_per_frame,
     /* optional offset  - can be improved: function pointer to lazily query this*/
                bool offset_is_negative, int64_t offset_samples