NOOP, remove trailing tabs/whitespace.
[ardour.git] / libs / timecode / src / time.cc
index 2d41d9b622fd9275dbfd9816610d1f5ce10591b7..494e6e114558d3e04083d54fac56f2bbdb53189c 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 Lesser General Public
   License for more details.
-  
+
   You should have received a copy of the GNU Lesser General Public License
   along with this program; if not, write to the Free Software Foundation,
   Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
@@ -21,6 +21,7 @@
 
 #include <math.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 #include "timecode/time.h"
 
@@ -45,7 +46,7 @@ increment (Time& timecode, uint32_t subframes_per_frame)
                        timecode.negative = false;
                        return SECONDS;
                }
-    
+
                timecode.negative = false;
                wrap = decrement (timecode, subframes_per_frame);
                if (!Timecode_IS_ZERO (timecode)) {
@@ -93,7 +94,7 @@ increment (Time& timecode, uint32_t subframes_per_frame)
                }
                break;
        }
-  
+
        if (wrap == SECONDS) {
                if (timecode.seconds == 59) {
                        timecode.seconds = 0;
@@ -111,7 +112,7 @@ increment (Time& timecode, uint32_t subframes_per_frame)
        } else {
                timecode.frames++;
        }
-  
+
        return wrap;
 }
 
@@ -123,7 +124,7 @@ Wrap
 decrement (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        if (timecode.negative || Timecode_IS_ZERO (timecode)) {
                timecode.negative = false;
                wrap = increment (timecode, subframes_per_frame);
@@ -135,7 +136,7 @@ decrement (Time& timecode, uint32_t subframes_per_frame)
                timecode.negative = true;
                return SECONDS;
        }
-  
+
        switch ((int)ceil (timecode.rate)) {
        case 24:
                if (timecode.frames == 0) {
@@ -160,7 +161,7 @@ decrement (Time& timecode, uint32_t subframes_per_frame)
                                timecode.frames = 29;
                                wrap = SECONDS;
                        }
-                       
+
                } else {
                        if (timecode.frames == 0) {
                                timecode.frames = 29;
@@ -175,7 +176,7 @@ decrement (Time& timecode, uint32_t subframes_per_frame)
                }
                break;
        }
-  
+
        if (wrap == SECONDS) {
                if (timecode.seconds == 0) {
                        timecode.seconds = 59;
@@ -194,11 +195,11 @@ decrement (Time& timecode, uint32_t subframes_per_frame)
        } else {
                timecode.frames--;
        }
-  
+
        if (Timecode_IS_ZERO (timecode)) {
                timecode.negative = false;
        }
-  
+
        return wrap;
 }
 
@@ -219,7 +220,7 @@ Wrap
 increment_subframes (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        if (timecode.negative) {
                timecode.negative = false;
                wrap = decrement_subframes (timecode, subframes_per_frame);
@@ -228,7 +229,7 @@ increment_subframes (Time& timecode, uint32_t subframes_per_frame)
                }
                return wrap;
        }
-  
+
        timecode.subframes++;
        if (timecode.subframes >= subframes_per_frame) {
                timecode.subframes = 0;
@@ -244,14 +245,14 @@ Wrap
 decrement_subframes (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        if (timecode.negative) {
                timecode.negative = false;
                wrap = increment_subframes (timecode, subframes_per_frame);
                timecode.negative = true;
                return wrap;
        }
-  
+
        if (timecode.subframes <= 0) {
                timecode.subframes = 0;
                if (Timecode_IS_ZERO (timecode)) {
@@ -278,10 +279,10 @@ Wrap
 increment_seconds (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        // Clear subframes
        frames_floor (timecode);
-  
+
        if (timecode.negative) {
                // Wrap second if on second boundary
                wrap = increment (timecode, subframes_per_frame);
@@ -306,11 +307,11 @@ increment_seconds (Time& timecode, uint32_t subframes_per_frame)
                        timecode.frames = 59;
                        break;
                }
-    
+
                // Increment by one frame
                wrap = increment (timecode, subframes_per_frame);
        }
-  
+
        return wrap;
 }
 
@@ -322,7 +323,7 @@ seconds_floor (Time& timecode)
 {
        // Clear subframes
        frames_floor (timecode);
-  
+
        // Go to lowest possible frame in this second
        switch ((int)ceil (timecode.rate)) {
        case 24:
@@ -340,7 +341,7 @@ seconds_floor (Time& timecode)
                }
                break;
        }
-  
+
        if (Timecode_IS_ZERO (timecode)) {
                timecode.negative = false;
        }
@@ -352,10 +353,10 @@ Wrap
 increment_minutes (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        // Clear subframes
        frames_floor (timecode);
-  
+
        if (timecode.negative) {
                // Wrap if on minute boundary
                wrap = increment_seconds (timecode, subframes_per_frame);
@@ -367,7 +368,7 @@ increment_minutes (Time& timecode, uint32_t subframes_per_frame)
                // Wrap minute by incrementing second
                wrap = increment_seconds (timecode, subframes_per_frame);
        }
-  
+
        return wrap;
 }
 
@@ -392,10 +393,10 @@ Wrap
 increment_hours (Time& timecode, uint32_t subframes_per_frame)
 {
        Wrap wrap = NONE;
-  
+
        // Clear subframes
        frames_floor (timecode);
-  
+
        if (timecode.negative) {
                // Wrap if on hour boundary
                wrap = increment_minutes (timecode, subframes_per_frame);
@@ -405,7 +406,7 @@ increment_hours (Time& timecode, uint32_t subframes_per_frame)
                timecode.minutes = 59;
                wrap = increment_minutes (timecode, subframes_per_frame);
        }
-  
+
        return wrap;
 }
 
@@ -418,7 +419,7 @@ hours_floor(Time& timecode)
        timecode.seconds   = 0;
        timecode.frames    = 0;
        timecode.subframes = 0;
-  
+
        if (Timecode_IS_ZERO (timecode)) {
                timecode.negative = false;
        }
@@ -563,21 +564,15 @@ timecode_format_name (TimecodeFormat const t)
                        return "25";
 
                        break;
+               case timecode_2997000:
                case timecode_2997:
                        return "29.97";
 
                        break;
+               case timecode_2997000drop:
                case timecode_2997drop:
                        return "29.97 drop";
 
-                       break;
-               case timecode_2997000:
-                       return "29.97000";
-
-                       break;
-               case timecode_2997000drop:
-                       return "29.97000 drop";
-
                        break;
                case timecode_30:
                        return "30";
@@ -629,6 +624,24 @@ std::string timecode_format_sampletime (
        return timecode_format_time(t);
 }
 
+bool parse_timecode_format(std::string tc, Timecode::Time &TC) {
+       char negative[2];
+       char ignored[2];
+       TC.subframes = 0;
+       if (sscanf (tc.c_str(), "%[- ]%" PRId32 ":%" PRId32 ":%" PRId32 "%[:;]%" PRId32,
+                               negative, &TC.hours, &TC.minutes, &TC.seconds, ignored, &TC.frames) != 6) {
+               TC.hours = TC.minutes = TC.seconds = TC.frames = 0;
+               TC.negative = false;
+               return false;
+       }
+       if (negative[0]=='-') {
+               TC.negative = true;
+       } else {
+               TC.negative = false;
+       }
+       return true;
+}
+
 void
 timecode_to_sample(
                Timecode::Time& timecode, int64_t& sample,
@@ -681,16 +694,20 @@ timecode_to_sample(
                //  0:10:00:00        0.0             0                   600.000         26460000 (accurate)
                //
                //  Per Sigmond <per@sigmond.no>
-
-               // Samples inside time dividable by 10 minutes (real time accurate)
-               int64_t base_samples = (int64_t) (((timecode.hours * 107892) + ((timecode.minutes / 10) * 17982)) * frames_per_timecode_frame);
-
-               // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
-               int32_t exceeding_df_minutes = timecode.minutes % 10;
-               int32_t exceeding_df_seconds = (exceeding_df_minutes * 60) + timecode.seconds;
-               int32_t exceeding_df_frames = (30 * exceeding_df_seconds) + timecode.frames - (2 * exceeding_df_minutes);
-               int64_t exceeding_samples = (int64_t) rint(exceeding_df_frames * frames_per_timecode_frame);
-               sample = base_samples + exceeding_samples;
+               //
+               //  This schma would compensate exactly for a frame-rate of 30 * 0.999. but the
+               //  actual rate is 30000/1001 - which results in an offset of -3.6ms per hour or
+               //  about -86ms over a 24-hour period. (SMPTE 12M-1999)
+               //
+               //  Robin Gareus <robin@gareus.org>
+
+               const int64_t fps_i = ceil(timecode.rate);
+               int64_t totalMinutes = 60 * timecode.hours + timecode.minutes;
+               int64_t frameNumber  = fps_i * 3600 * timecode.hours
+                       + fps_i * 60 * timecode.minutes
+                       + fps_i * timecode.seconds + timecode.frames
+                       - 2 * (totalMinutes - totalMinutes / 10);
+               sample = frameNumber * sample_frame_rate / (double) timecode.rate;
        } else {
                /*
                   Non drop is easy.. just note the use of
@@ -699,11 +716,18 @@ timecode_to_sample(
                   frame_rate() in the non-integer Timecode rate case.
                */
 
-               sample = (int64_t)rint((((timecode.hours * 60 * 60) + (timecode.minutes * 60) + timecode.seconds) * (rint(timecode.rate) * frames_per_timecode_frame)) + (timecode.frames * frames_per_timecode_frame));
+               sample = (int64_t) rint(
+                               (
+                                ((timecode.hours * 60 * 60) + (timecode.minutes * 60) + timecode.seconds)
+                                *
+                                (rint(timecode.rate) * frames_per_timecode_frame)
+                               )
+                               + (timecode.frames * frames_per_timecode_frame)
+                       );
        }
 
        if (use_subframes) {
-               sample += (int64_t) (((double)timecode.subframes * frames_per_timecode_frame) / subframes_per_frame);
+               sample += (int64_t) rint(((double)timecode.subframes * frames_per_timecode_frame) / (double)subframes_per_frame);
        }
 
        if (use_offset) {
@@ -742,21 +766,11 @@ sample_to_timecode (
                bool offset_is_negative, int64_t offset_samples
                )
 {
-       const double frames_per_timecode_frame = (double) sample_frame_rate / (double) timecode_frames_per_second;
-       int32_t frames_per_hour;
-
-       if (timecode_drop_frames) {
-         frames_per_hour = (int32_t)(107892 * frames_per_timecode_frame);
-       } else {
-         frames_per_hour = (int32_t)(3600 * rint(timecode_frames_per_second) * frames_per_timecode_frame);
-       }
-
-  /* do the work */
        int64_t offset_sample;
 
        if (!use_offset) {
-               offset_sample = sample;
-               timecode.negative = false;
+               timecode.negative = (sample < 0);
+               offset_sample = ::llabs(sample);
        } else {
                if (offset_is_negative) {
                        offset_sample = sample + offset_samples;
@@ -772,70 +786,54 @@ sample_to_timecode (
                }
        }
 
-       double timecode_frames_left_exact;
-       double timecode_frames_fraction;
-       uint64_t timecode_frames_left;
+       if (timecode_drop_frames) {
+               int64_t frameNumber = floor( (double)offset_sample * timecode_frames_per_second / sample_frame_rate);
 
-       // Extract whole hours. Do this to prevent rounding errors with
-       // high sample numbers in the calculations that follow.
-       timecode.hours = offset_sample / frames_per_hour;
-       offset_sample = offset_sample % frames_per_hour;
+               /* there are 17982 frames in 10 min @ 29.97df */
+               const int64_t D = frameNumber / 17982;
+               const int64_t M = frameNumber % 17982;
 
-       // Calculate exact number of (exceeding) timecode frames and fractional frames
-       timecode_frames_left_exact = (double) offset_sample / frames_per_timecode_frame;
-       timecode_frames_fraction = timecode_frames_left_exact - floor( timecode_frames_left_exact );
-       timecode.subframes = (int32_t) floor(timecode_frames_fraction * subframes_per_frame);
+               timecode.subframes = rint(subframes_per_frame
+                               * ((double)offset_sample * timecode_frames_per_second / sample_frame_rate - (double)frameNumber));
 
-       // XXX Not sure if this is necessary anymore...
-       if (timecode.subframes == subframes_per_frame) {
-               // This can happen with 24 fps (and 29.97 fps ?)
-               timecode_frames_left_exact = ceil( timecode_frames_left_exact );
-               timecode.subframes = 0;
-       }
+               if (timecode.subframes == subframes_per_frame) {
+                       timecode.subframes = 0;
+                       frameNumber++;
+               }
 
-       // Extract hour-exceeding frames for minute, second and frame calculations
-       timecode_frames_left = (uint64_t) floor (timecode_frames_left_exact);
+               frameNumber +=  18*D + 2*((M - 2) / 1798);
 
-       if (timecode_drop_frames) {
-               // See int32_t explanation in timecode_to_sample()...
-
-               // Number of 10 minute chunks
-               timecode.minutes = (timecode_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
-               // frames exceeding the nearest 10 minute barrier
-               int32_t exceeding_df_frames = timecode_frames_left % 17982;
-
-               // Find minutes exceeding the nearest 10 minute barrier
-               if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
-                       exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
-                       int32_t extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
-                       exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
-                       timecode.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
-               }
+               timecode.frames  =    frameNumber % 30;
+               timecode.seconds =   (frameNumber / 30) % 60;
+               timecode.minutes =  ((frameNumber / 30) / 60) % 60;
+               timecode.hours   = (((frameNumber / 30) / 60) / 60);
 
-               // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
-               if (timecode.minutes % 10) {
-                       // Every minute except every 10th
-                       if (exceeding_df_frames < 28) {
-                               // First second, frames 0 and 1 are skipped
-                               timecode.seconds = 0;
-                               timecode.frames = exceeding_df_frames + 2;
-                       } else {
-                               // All other seconds, all 30 frames are counted
-                               exceeding_df_frames -= 28;
-                               timecode.seconds = (exceeding_df_frames / 30) + 1;
-                               timecode.frames = exceeding_df_frames % 30;
-                       }
-               } else {
-                       // Every 10th minute, all 30 frames counted in all seconds
-                       timecode.seconds = exceeding_df_frames / 30;
-                       timecode.frames = exceeding_df_frames % 30;
-               }
        } else {
-               // Non drop is easy
-               timecode.minutes = timecode_frames_left / ((int32_t) rint (timecode_frames_per_second) * 60);
-               timecode_frames_left = timecode_frames_left % ((int32_t) rint (timecode_frames_per_second) * 60);
-               timecode.seconds = timecode_frames_left / (int32_t) rint(timecode_frames_per_second);
-               timecode.frames = timecode_frames_left % (int32_t) rint(timecode_frames_per_second);
+               double timecode_frames_left_exact;
+               double timecode_frames_fraction;
+               int64_t timecode_frames_left;
+               const double frames_per_timecode_frame = sample_frame_rate / timecode_frames_per_second;
+               const int64_t frames_per_hour = (int64_t)(3600. * rint(timecode_frames_per_second) * frames_per_timecode_frame);
+
+               timecode.hours = offset_sample / frames_per_hour;
+
+               // Extract whole hours. Do this to prevent rounding errors with
+               // high sample numbers in the calculations that follow.
+               timecode_frames_left_exact = (double)(offset_sample % frames_per_hour) / frames_per_timecode_frame;
+               timecode_frames_fraction = timecode_frames_left_exact - floor( timecode_frames_left_exact );
+
+               timecode.subframes = (int32_t) rint(timecode_frames_fraction * subframes_per_frame);
+               timecode_frames_left = (int64_t) floor (timecode_frames_left_exact);
+
+               if (use_subframes && timecode.subframes == subframes_per_frame) {
+                       timecode_frames_left++;
+                       timecode.subframes = 0;
+               }
+
+               timecode.minutes = timecode_frames_left / ((int32_t) lrint (timecode_frames_per_second) * 60);
+               timecode_frames_left = timecode_frames_left % ((int32_t) lrint (timecode_frames_per_second) * 60);
+               timecode.seconds = timecode_frames_left / (int32_t) lrint(timecode_frames_per_second);
+               timecode.frames = timecode_frames_left % (int32_t) lrint(timecode_frames_per_second);
        }
 
        if (!use_subframes) {
@@ -848,8 +846,8 @@ sample_to_timecode (
 
 } // namespace Timecode
 
-std::ostream& 
-operator<<(std::ostream& ostr, const Timecode::Time& t) 
+std::ostream&
+operator<<(std::ostream& ostr, const Timecode::Time& t)
 {
        return t.print (ostr);
 }