]> git.sesse.net Git - kdenlive/blobdiff - src/timecode.cpp
Fix indent
[kdenlive] / src / timecode.cpp
index 182f6d9009d17431c3589f4f2881b76645e0c8a6..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 "timecode.h"
 
-#include <kdebug.h>
-#include <klocale.h>
+/*
+
+ 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, int framesPerSecond,
-                   bool dropFrame): m_format(format), m_dropFrame(dropFrame),
-        m_displayedFramesPerSecond(framesPerSecond)
+Timecode::Timecode(Formats format, double framesPerSecond)
 {
+    setFormat(framesPerSecond, format);
 }
 
 Timecode::~Timecode()
 {
 }
 
-int Timecode::fps()
+void Timecode::setFormat(double framesPerSecond, Formats format)
+{
+    m_displayedFramesPerSecond = (int)(framesPerSecond + 0.5);
+    m_dropFrameTimecode = (framesPerSecond / 1.00 != (int)framesPerSecond) ;
+    m_format = format;
+    m_realFps = framesPerSecond;
+    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;
+}
+
+bool Timecode::df() const
+{
+    return m_dropFrameTimecode;
+}
+
+const QString Timecode::mask(const GenTime& t) const
+{
+    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
 {
-    return m_displayedFramesPerSecond;
+    if (m_dropFrameTimecode)
+        return duration.replace(8, 1, ',');
+    return duration.replace(8, 1, ':');
 }
 
+int Timecode::getDisplayFrameCount(const QString &duration, bool frameDisplay) const
+{
+    if (frameDisplay) return duration.toInt();
+    return getFrameCount(duration);
+}
 
-int Timecode::getFrameCount(const QString duration, double fps) const
+int Timecode::getFrameCount(const QString &duration) const
 {
-    if (m_dropFrame) {
-        // calculate how many frames need to be dropped every minute.
-        int frames;
-        int toDrop = (int) floor(600.0 * (m_displayedFramesPerSecond - fps)  + 0.5);
-
-        int perMinute = toDrop / 9;
-        int tenthMinute = toDrop % 9;
-
-        // calculate how many frames are in a normal minute, and how many are in a tenth minute.
-        int normalMinuteFrames = (m_displayedFramesPerSecond * 60) - perMinute;
-        int tenthMinuteFrames = (m_displayedFramesPerSecond * 60) - tenthMinute;;
-
-        // Number of actual frames in a 10 minute interval :
-        int tenMinutes = (normalMinuteFrames * 9) + tenthMinuteFrames;
-        frames = 6 * duration.section(':', 0, 0).toInt() * tenMinutes;
-        int minutes = duration.section(':', 1, 1).toInt();
-        frames += ((int) minutes / 10) * tenMinutes;
-        int mins = minutes % 10;
-        if (mins > 0) {
-            frames += tenthMinuteFrames;
-            mins--;
-            if (mins > 0) frames += mins * normalMinuteFrames;
-        }
-        if (minutes % 10 > 0) frames -= perMinute;
-        frames += duration.section(':', 2, 2).toInt() * m_displayedFramesPerSecond + duration.section(':', 3, 3).toInt();
-        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()) * fps + duration.section(':', 3, 3).toInt());
+    return (int)((hours * 3600.0 + minutes * 60.0 + seconds) * m_realFps + frames);
 }
 
-QString Timecode::getTimecode(const GenTime & time, double fps) const
+QString Timecode::getDisplayTimecode(const GenTime & time, bool frameDisplay) const
+{
+    if (frameDisplay) return QString::number((int) time.frames(m_realFps));
+    return getTimecode(time);
+}
+
+QString Timecode::getTimecode(const GenTime & time) const
 {
     switch (m_format) {
     case HH_MM_SS_FF:
-        return getTimecodeHH_MM_SS_FF(time, fps);
+        return getTimecodeHH_MM_SS_FF(time);
         break;
     case HH_MM_SS_HH:
         return getTimecodeHH_MM_SS_HH(time);
         break;
     case Frames:
-        return getTimecodeFrames(time, fps);
+        return getTimecodeFrames(time);
         break;
     case Seconds:
         return getTimecodeSeconds(time);
@@ -86,22 +193,69 @@ QString Timecode::getTimecode(const GenTime & time, double fps) const
         kWarning() <<
         "Unknown timecode format specified, defaulting to HH_MM_SS_FF"
         << endl;
-        return getTimecodeHH_MM_SS_FF(time, fps);
+        return getTimecodeHH_MM_SS_FF(time);
     }
 }
 
-QString Timecode::getTimecodeFromFrames(int frames)
+const QString Timecode::getDisplayTimecodeFromFrames(int frames, bool frameDisplay) const
+{
+    if (frameDisplay) return QString::number(frames);
+    return getTimecodeHH_MM_SS_FF(frames);
+}
+
+const QString Timecode::getTimecodeFromFrames(int frames) const
 {
     return getTimecodeHH_MM_SS_FF(frames);
 }
 
+
+//static
+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;
+}
+
+
 //static
 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);
-    int seconds = frames / (int) floor(fps + 0.5);
-    frames = frames % ((int) fps);
+    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));
 
     int minutes = seconds / 60;
     seconds = seconds % 60;
@@ -111,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") + ' ');
@@ -141,16 +297,26 @@ QString Timecode::getEasyTimecode(const GenTime & time, const double &fps)
 }
 
 
-QString Timecode::getTimecodeHH_MM_SS_FF(const GenTime & time, double fps) const
+const QString Timecode::getTimecodeHH_MM_SS_FF(const GenTime & time) const
 {
-    if (m_dropFrame)
-        return getTimecodeDropFrame(time, fps);
-
-    return getTimecodeHH_MM_SS_FF((int)time.frames(fps));
+    if (m_dropFrameTimecode) {
+        return getTimecodeDropFrame(time);
+    }
+    return getTimecodeHH_MM_SS_FF((int) time.frames(m_realFps));
 }
 
-QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
+const QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
 {
+    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;
 
@@ -160,7 +326,8 @@ 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));
@@ -172,9 +339,16 @@ 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;
@@ -183,83 +357,74 @@ 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));
-    text.append(':');
+    if (m_dropFrameTimecode)
+        text.append(',');
+    else
+        text.append(':');
     text.append(QString::number(hundredths).rightJustified(2, '0', false));
 
     return text;
 }
 
-QString Timecode::getTimecodeFrames(const GenTime & time, double fps) const
+const QString Timecode::getTimecodeFrames(const GenTime & time) const
 {
-    return QString::number(time.frames(fps));
+    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, double fps) const
+const QString Timecode::getTimecodeDropFrame(const GenTime & time) 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.
-    int frames = (int)time.frames(fps);
-
-    // calculate how many frames need to be dropped every minute.
-    int toDrop = (int) floor(600.0 * (m_displayedFramesPerSecond - fps)  + 0.5);
-
-    int perMinute = toDrop / 9;
-    int tenthMinute = toDrop % 9;
-
-    // calculate how many frames are in a normal minute, and how many are in a tenth minute.
-    int normalMinuteFrames = (m_displayedFramesPerSecond * 60) - perMinute;
-    int tenthMinuteFrames = (m_displayedFramesPerSecond * 60) - tenthMinute;;
-
-    // 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;
+    return getTimecodeDropFrame((int)time.frames(m_realFps));
+}
 
-    // At the point, we have figured out HH:M?:??:??
+const QString Timecode::getTimecodeDropFrame(int framenumber) const
+{
+    //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);
+    }
 
-    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 +=  tenthMinute + perMinute;
+        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));
-    text.append(':');
+    text.append(',');
     text.append(QString::number(frames).rightJustified(2, '0', false));
 
     return text;