]> git.sesse.net Git - kdenlive/blobdiff - src/timecode.cpp
Const'ref
[kdenlive] / src / timecode.cpp
index 6973e81eeaa4e08eaa4003f9be37cf5fd577235f..789b286103d2bf0659513ec0c6fc04da94b64cf9 100644 (file)
@@ -4,6 +4,7 @@
     begin                : Wed Dec 17 2003
     copyright            : (C) 2003 by Jason Wood
     email                : jasonwood@blueyonder.co.uk
+ *   Copyright (C) 2010 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
  ***************************************************************************/
 
 /***************************************************************************
  *   (at your option) any later version.                                   *
  *                                                                         *
  ***************************************************************************/
-#include <QValidator>
+
+/*
+
+ Timecode calculation code for reference
+ If we ever use Quicktime timecode with 50.94 Drop frame, keep in mind that there is a bug inthe Quicktime code
+
+//CONVERT A FRAME NUMBER TO DROP FRAME TIMECODE
+//Code by David Heidelberger, adapted from Andrew Duncan
+//Given an int called framenumber and a double called framerate
+//Framerate should be 29.97, 59.94, or 23.976, otherwise the calculations will be off.
+
+int d;
+int m;
+
+int dropFrames = round(framerate * .066666); //Number of frames to drop on the minute marks is the nearest integer to 6% of the framerate
+int framesPerHour = round(framerate*60*60); //Number of frames in an hour
+int framesPer24Hours = framesPerHour*24; //Number of frames in a day - timecode rolls over after 24 hours
+int framesPer10Minutes = round(framerate * 60 * 10); //Number of frames per ten minutes
+int framesPerMinute = round(framerate)*60)-  dropFrames; //Number of frames per minute is the round of the framerate * 60 minus the number of dropped frames
+
+if (framenumber<0) //Negative time. Add 24 hours.
+{
+    framenumber=framesPer24Hours+framenumber;
+}
+
+//If framenumber is greater than 24 hrs, next operation will rollover clock
+framenumber = framenumber % framesPer24Hours; //% is the modulus operator, which returns a remainder. a % b = the remainder of a/b
+
+d = framenumber\framesPer10Minutes; // \ means integer division, which is a/b without a remainder. Some languages you could use floor(a/b)
+m = framenumber % framesPer10Minutes;
+
+if (m>1)
+{
+    framenumber=framenumber + (dropFrames*9*d) + dropFrames*((m-dropFrames)\framesPerMinute);
+}
+else
+{
+    framenumber = framenumber + dropFrames*9*d;
+}
+
+int frRound = round(framerate);
+int frames = framenumber % frRound;
+int seconds = (framenumber \ frRound) % 60;
+int minutes = ((framenumber \ frRound) \ 60) % 60;
+int hours = (((framenumber \ frRound) \ 60) \ 60);
+
+
+------------------------------------------------------------------------------------
+
+//CONVERT DROP FRAME TIMECODE TO A FRAME NUMBER
+//Code by David Heidelberger, adapted from Andrew Duncan
+//Given ints called hours, minutes, seconds, frames, and a double called framerate
+
+int dropFrames = round(framerate*.066666); //Number of drop frames is 6% of framerate rounded to nearest integer
+int timeBase = round(framerate); //We don’t need the exact framerate anymore, we just need it rounded to nearest integer
+
+int hourFrames = timeBase*60*60; //Number of frames per hour (non-drop)
+int minuteFrames = timeBase*60; //Number of frames per minute (non-drop)
+int totalMinutes = (60*hours) + minutes; //Total number of minuts
+int frameNumber = ((hourFrames * hours) + (minuteFrames * minutes) + (timeBase * seconds) + frames) - (dropFrames * (totalMinutes - (totalMinutes \ 10)));
+return frameNumber;
+
+*/
+
+
 
 #include <KDebug>
 #include <KLocale>
 
 #include "timecode.h"
 
-Timecode::Timecode(Formats format, double framesPerSecond, bool dropFrame)
+Timecode::Timecode(Formats format, double framesPerSecond)
 {
-    m_validator = new QRegExpValidator(0);
-    setFormat(framesPerSecond, dropFrame, format);
+    setFormat(framesPerSecond, format);
 }
 
 Timecode::~Timecode()
 {
 }
 
-void Timecode::setFormat(double framesPerSecond, bool dropFrame, Formats format)
+void Timecode::setFormat(double framesPerSecond, Formats format)
 {
     m_displayedFramesPerSecond = (int)(framesPerSecond + 0.5);
-    m_dropFrame = dropFrame;
+    m_dropFrameTimecode = (framesPerSecond / 1.00 != (int)framesPerSecond) ;
     m_format = format;
     m_realFps = framesPerSecond;
-    QRegExp regExp;
-    if (m_dropFrame)
-        regExp.setPattern("^\\d{2}:\\d{2}:\\d{2};\\d{2}$");
-    else
-        regExp.setPattern("^\\d{2}:\\d{2}:\\d{2}:\\d{2}$");
-    m_validator->setRegExp(regExp);
+    if (m_dropFrameTimecode) {
+        m_dropFrames = round(m_realFps * .066666); //Number of frames to drop on the minute marks is the nearest integer to 6% of the framerate
+        m_framesPer10Minutes = round(m_realFps * 600); //Number of frames per ten minutes
+    }
 }
 
 double Timecode::fps() const
 {
-    return m_realFps; //m_displayedFramesPerSecond;
+    return m_realFps;
 }
 
 bool Timecode::df() const
 {
-    return m_dropFrame;
+    return m_dropFrameTimecode;
 }
 
-const QValidator *Timecode::validator() const
+const QString Timecode::mask(const GenTime& t) const
 {
-    return m_validator;
+    if (t < GenTime()) {
+        if (m_dropFrameTimecode) return "#99:99:99,99";
+        else return "#99:99:99:99";
+    }
+    if (m_dropFrameTimecode) return "99:99:99,99";
+    else return "99:99:99:99";
 }
 
 QString Timecode::reformatSeparators(QString duration) const
 {
-    if (m_dropFrame)
-        return duration.replace(8, 1, ';');
+    if (m_dropFrameTimecode)
+        return duration.replace(8, 1, ',');
     return duration.replace(8, 1, ':');
 }
 
-int Timecode::getDisplayFrameCount(const QString duration, bool frameDisplay) const
+int Timecode::getDisplayFrameCount(const QString &duration, bool frameDisplay) const
 {
     if (frameDisplay) return duration.toInt();
     return getFrameCount(duration);
 }
 
-int Timecode::getFrameCount(const QString duration) const
+int Timecode::getFrameCount(const QString &duration) const
 {
-    if (m_dropFrame) {
-        //Get Hours, Minutes, Seconds, Frames from timecode
-        int hours, minutes, seconds, frames;
-
-        hours = duration.section(':', 0, 0).toInt();
-        minutes = duration.section(':', 1, 1).toInt();
-        if (duration.contains(';')) {
-            seconds = duration.section(';', 0, 0).section(':', 2, 2).toInt();
-            frames = duration.section(';', 1, 1).toInt();
-        } else {
-            //Handle Drop Frame timecode frame calculations, even if the timecode supplied uses incorrect "99:99:99:99" format instead of "99:99:99;99"
-            seconds = duration.section(':', 2, 2).toInt();
-            frames = duration.section(':', 3, 3).toInt();
-        }
-
-        //Calculate the frame count
-        int dropRate = (int)((ceil(m_displayedFramesPerSecond) / 30) * 2);
-        frames += ((hours * 60 + minutes) * 60 + seconds) * m_displayedFramesPerSecond;
-        frames -= dropRate * ((hours * 60 + minutes) - (floor((hours * 60 + minutes) / 10)));
-        return frames;
+    if (duration.isEmpty()) {
+        return 0;
+    }
+    int hours, minutes, seconds, frames;
+    int offset = 0;
+    if (duration.at(0) == '-') {
+        offset = 1;
+        hours = duration.mid(1, 2).toInt();
+    } else {
+        hours = duration.left(2).toInt();
+    }
+    minutes = duration.mid(3 + offset, 2).toInt();
+    seconds = duration.mid(6 + offset, 2).toInt();
+    frames = duration.right(2).toInt();
+    if (m_dropFrameTimecode) {
+        //CONVERT DROP FRAME TIMECODE TO A FRAME NUMBER
+        //Code by David Heidelberger, adapted from Andrew Duncan
+        //Given ints called hours, minutes, seconds, frames, and a double called framerate
+
+        int totalMinutes = (60 * hours) + minutes; //Total number of minutes
+        int frameNumber = ((m_displayedFramesPerSecond * 3600 * hours) + (m_displayedFramesPerSecond * 60 * minutes) + (m_displayedFramesPerSecond * seconds) + frames) - (m_dropFrames * (totalMinutes - floor(totalMinutes / 10)));
+        return frameNumber;
     }
-    return (int)((duration.section(':', 0, 0).toInt()*3600.0 + duration.section(':', 1, 1).toInt()*60.0 + duration.section(':', 2, 2).toInt()) * m_realFps + duration.section(':', 3, 3).toInt());
+    return (int)((hours * 3600.0 + minutes * 60.0 + seconds) * m_realFps + frames);
 }
 
 QString Timecode::getDisplayTimecode(const GenTime & time, bool frameDisplay) const
@@ -141,20 +210,34 @@ const QString Timecode::getTimecodeFromFrames(int frames) const
 
 
 //static
-QString Timecode::getStringTimecode(int frames, const double &fps)
+QString Timecode::getStringTimecode(int frames, const double &fps, bool showFrames)
 {
     // Returns the timecode in an hh:mm:ss format
+
+    bool negative = false;
+    if (frames < 0) {
+        negative = true;
+        frames = qAbs(frames);
+    }
+
     int seconds = (int)(frames / fps);
+    int frms = frames % (int) (fps + 0.5);
     int minutes = seconds / 60;
     seconds = seconds % 60;
     int hours = minutes / 60;
     minutes = minutes % 60;
     QString text;
+    if (negative)
+        text.append('-');
     text.append(QString::number(hours).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(minutes).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(seconds).rightJustified(2, '0', false));
+    if (showFrames) {
+        text.append('.');
+        text.append(QString::number(frms).rightJustified(2, '0', false));
+    }
     return text;
 }
 
@@ -164,6 +247,13 @@ QString Timecode::getEasyTimecode(const GenTime & time, const double &fps)
 {
     // Returns the timecode in an easily read display, like 3 min. 5 sec.
     int frames = (int) time.frames(fps);
+
+    bool negative = false;
+    if (frames < 0) {
+        negative = true;
+        frames = qAbs(frames);
+    }
+
     int seconds = (int)(frames / fps);
     frames = frames - ((int)(fps * seconds));
 
@@ -175,6 +265,8 @@ QString Timecode::getEasyTimecode(const GenTime & time, const double &fps)
     QString text;
     bool trim = false;
 
+    if (negative)
+        text.append('-');
     if (hours != 0) {
         text.append(QString::number(hours).rightJustified(2, '0', false));
         text.append(' ' + i18n("hour") + ' ');
@@ -207,17 +299,24 @@ QString Timecode::getEasyTimecode(const GenTime & time, const double &fps)
 
 const QString Timecode::getTimecodeHH_MM_SS_FF(const GenTime & time) const
 {
-    if (m_dropFrame)
+    if (m_dropFrameTimecode) {
         return getTimecodeDropFrame(time);
-
+    }
     return getTimecodeHH_MM_SS_FF((int) time.frames(m_realFps));
 }
 
 const QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
 {
-    if (m_dropFrame) {
+    if (m_dropFrameTimecode) {
         return getTimecodeDropFrame(frames);
     }
+
+    bool negative = false;
+    if (frames < 0) {
+        negative = true;
+        frames = qAbs(frames);
+    }
+
     int seconds = frames / m_displayedFramesPerSecond;
     frames = frames % m_displayedFramesPerSecond;
 
@@ -227,6 +326,8 @@ const QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
     minutes = minutes % 60;
 
     QString text;
+    if (negative)
+        text.append('-');
     text.append(QString::number(hours).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(minutes).rightJustified(2, '0', false));
@@ -238,9 +339,16 @@ const QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
     return text;
 }
 
-QString Timecode::getTimecodeHH_MM_SS_HH(const GenTime & time) const
+const QString Timecode::getTimecodeHH_MM_SS_HH(const GenTime & time) const
 {
     int hundredths = (int)(time.seconds() * 100);
+
+    bool negative = false;
+    if (hundredths < 0) {
+        negative = true;
+        hundredths = qAbs(hundredths);
+    }
+
     int seconds = hundredths / 100;
     hundredths = hundredths % 100;
     int minutes = seconds / 60;
@@ -249,14 +357,15 @@ QString Timecode::getTimecodeHH_MM_SS_HH(const GenTime & time) const
     minutes = minutes % 60;
 
     QString text;
-
+    if (negative)
+        text.append('-');
     text.append(QString::number(hours).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(minutes).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(seconds).rightJustified(2, '0', false));
-    if (m_dropFrame)
-        text.append(';');
+    if (m_dropFrameTimecode)
+        text.append(',');
     else
         text.append(':');
     text.append(QString::number(hundredths).rightJustified(2, '0', false));
@@ -264,78 +373,58 @@ QString Timecode::getTimecodeHH_MM_SS_HH(const GenTime & time) const
     return text;
 }
 
-QString Timecode::getTimecodeFrames(const GenTime & time) const
+const QString Timecode::getTimecodeFrames(const GenTime & time) const
 {
-    return QString::number(time.frames(m_realFps));
+    return QString::number((int) time.frames(m_realFps));
 }
 
-QString Timecode::getTimecodeSeconds(const GenTime & time) const
+const QString Timecode::getTimecodeSeconds(const GenTime & time) const
 {
-    return QString::number(time.seconds());
+    QLocale locale;
+    return locale.toString(time.seconds());
 }
 
-QString Timecode::getTimecodeDropFrame(const GenTime & time) const
+const QString Timecode::getTimecodeDropFrame(const GenTime & time) const
 {
     return getTimecodeDropFrame((int)time.frames(m_realFps));
 }
 
-QString Timecode::getTimecodeDropFrame(int frames) const
+const QString Timecode::getTimecodeDropFrame(int framenumber) const
 {
-    // Calculate the timecode using dropframes to remove the difference in fps. Note that this algorithm should work
-    // for NTSC times, but is untested for any others - it is in no way an "official" algorithm, unless it's by fluke.
-
-    // calculate how many frames need to be dropped every minute.
-    int dropRate = 0;
-    if (m_dropFrame) {
-        dropRate = (int)((ceil(m_displayedFramesPerSecond) / 30) * 2);
+    //CONVERT A FRAME NUMBER TO DROP FRAME TIMECODE
+    //Based on code by David Heidelberger, adapted from Andrew Duncan
+    //Given an int called framenumber and a double called framerate
+    //Framerate should be 29.97, 59.94, or 23.976, otherwise the calculations will be off.
+
+    bool negative = false;
+    if (framenumber < 0) {
+        negative = true;
+        framenumber = qAbs(framenumber);
     }
 
-    // calculate how many frames are in a normal minute, and how many are in a tenth minute.
-    int normalMinuteFrames = (m_displayedFramesPerSecond * 60) - dropRate;
-    int tenthMinuteFrames = (m_displayedFramesPerSecond * 60);
-
-    // Number of actual frames in a 10 minute interval :
-    int tenMinutes = (normalMinuteFrames * 9) + tenthMinuteFrames;
-
-    int tenMinuteIntervals = frames / tenMinutes;
-    frames = frames % tenMinutes;
-
-    int hours = tenMinuteIntervals / 6;
-    tenMinuteIntervals = tenMinuteIntervals % 6;
-
-    // At the point, we have figured out HH:M?:??:??
-
-    int numMinutes;
+    int d = floor(framenumber / m_framesPer10Minutes);
+    int m = framenumber % m_framesPer10Minutes;
 
-    if (frames < tenthMinuteFrames) {
-        // tenth minute logic applies.
-        numMinutes = 0;
+    if (m > m_dropFrames) {
+        framenumber += (m_dropFrames * 9 * d) + m_dropFrames * (floor((m - m_dropFrames) / (round(m_realFps * 60) - m_dropFrames)));
     } else {
-        // normal minute logic applies.
-        numMinutes = 1 + (frames - tenthMinuteFrames) / normalMinuteFrames;
-        frames = (frames - tenthMinuteFrames) % normalMinuteFrames;
-        frames +=  dropRate;
+        framenumber += m_dropFrames * 9 * d;
     }
-    // We now have HH:MM:??:??
 
-    int seconds = frames / m_displayedFramesPerSecond;
-    frames = frames % m_displayedFramesPerSecond;
-
-    // We now have HH:MM:SS:FF
-
-    // THANK FUCK FOR THAT.
+    int frames = framenumber % m_displayedFramesPerSecond;
+    int seconds = (int) floor(framenumber / m_displayedFramesPerSecond) % 60;
+    int minutes = (int) floor(floor(framenumber / m_displayedFramesPerSecond) / 60) % 60;
+    int hours = floor(floor(floor(framenumber / m_displayedFramesPerSecond) / 60) / 60);
 
     QString text;
+    if (negative)
+        text.append('-');
     text.append(QString::number(hours).rightJustified(2, '0', false));
     text.append(':');
-    text.append(QString::number(tenMinuteIntervals));
-    text.append(QString::number(numMinutes));
+    text.append(QString::number(minutes).rightJustified(2, '0', false));
     text.append(':');
     text.append(QString::number(seconds).rightJustified(2, '0', false));
-    if (m_dropFrame)
-        text.append(';');
-    else
-        text.append(':');
+    text.append(',');
     text.append(QString::number(frames).rightJustified(2, '0', false));
 
     return text;