]> git.sesse.net Git - kdenlive/blob - src/timecode.cpp
Required changes to make Kdenlive work with some locales that have a comma (,) as...
[kdenlive] / src / timecode.cpp
1 /***************************************************************************
2                           timecode  -  description
3                              -------------------
4     begin                : Wed Dec 17 2003
5     copyright            : (C) 2003 by Jason Wood
6     email                : jasonwood@blueyonder.co.uk
7  *   Copyright (C) 2010 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
8  ***************************************************************************/
9
10 /***************************************************************************
11  *                                                                         *
12  *   This program is free software; you can redistribute it and/or modify  *
13  *   it under the terms of the GNU General Public License as published by  *
14  *   the Free Software Foundation; either version 2 of the License, or     *
15  *   (at your option) any later version.                                   *
16  *                                                                         *
17  ***************************************************************************/
18
19 /*
20
21  Timecode calculation code for reference
22  If we ever use Quicktime timecode with 50.94 Drop frame, keep in mind that there is a bug inthe Quicktime code
23
24 //CONVERT A FRAME NUMBER TO DROP FRAME TIMECODE
25 //Code by David Heidelberger, adapted from Andrew Duncan
26 //Given an int called framenumber and a double called framerate
27 //Framerate should be 29.97, 59.94, or 23.976, otherwise the calculations will be off.
28
29 int d;
30 int m;
31
32 int dropFrames = round(framerate * .066666); //Number of frames to drop on the minute marks is the nearest integer to 6% of the framerate
33 int framesPerHour = round(framerate*60*60); //Number of frames in an hour
34 int framesPer24Hours = framesPerHour*24; //Number of frames in a day - timecode rolls over after 24 hours
35 int framesPer10Minutes = round(framerate * 60 * 10); //Number of frames per ten minutes
36 int framesPerMinute = round(framerate)*60)-  dropFrames; //Number of frames per minute is the round of the framerate * 60 minus the number of dropped frames
37
38 if (framenumber<0) //Negative time. Add 24 hours.
39 {
40     framenumber=framesPer24Hours+framenumber;
41 }
42
43 //If framenumber is greater than 24 hrs, next operation will rollover clock
44 framenumber = framenumber % framesPer24Hours; //% is the modulus operator, which returns a remainder. a % b = the remainder of a/b
45
46 d = framenumber\framesPer10Minutes; // \ means integer division, which is a/b without a remainder. Some languages you could use floor(a/b)
47 m = framenumber % framesPer10Minutes;
48
49 if (m>1)
50 {
51     framenumber=framenumber + (dropFrames*9*d) + dropFrames*((m-dropFrames)\framesPerMinute);
52 }
53 else
54 {
55     framenumber = framenumber + dropFrames*9*d;
56 }
57
58 int frRound = round(framerate);
59 int frames = framenumber % frRound;
60 int seconds = (framenumber \ frRound) % 60;
61 int minutes = ((framenumber \ frRound) \ 60) % 60;
62 int hours = (((framenumber \ frRound) \ 60) \ 60);
63
64
65 ------------------------------------------------------------------------------------
66
67 //CONVERT DROP FRAME TIMECODE TO A FRAME NUMBER
68 //Code by David Heidelberger, adapted from Andrew Duncan
69 //Given ints called hours, minutes, seconds, frames, and a double called framerate
70
71 int dropFrames = round(framerate*.066666); //Number of drop frames is 6% of framerate rounded to nearest integer
72 int timeBase = round(framerate); //We don’t need the exact framerate anymore, we just need it rounded to nearest integer
73
74 int hourFrames = timeBase*60*60; //Number of frames per hour (non-drop)
75 int minuteFrames = timeBase*60; //Number of frames per minute (non-drop)
76 int totalMinutes = (60*hours) + minutes; //Total number of minuts
77 int frameNumber = ((hourFrames * hours) + (minuteFrames * minutes) + (timeBase * seconds) + frames) - (dropFrames * (totalMinutes - (totalMinutes \ 10)));
78 return frameNumber;
79
80 */
81
82
83 #include <QValidator>
84
85 #include <KDebug>
86 #include <KLocale>
87
88 #include "timecode.h"
89
90 Timecode::Timecode(Formats format, double framesPerSecond)
91 {
92     m_validator = new QRegExpValidator(0);
93     setFormat(framesPerSecond, format);
94 }
95
96 Timecode::~Timecode()
97 {
98 }
99
100 void Timecode::setFormat(double framesPerSecond, Formats format)
101 {
102     m_displayedFramesPerSecond = (int)(framesPerSecond + 0.5);
103     m_dropFrameTimecode = (framesPerSecond / 1.00 != (int)framesPerSecond) ;
104     m_format = format;
105     m_realFps = framesPerSecond;
106     if (m_dropFrameTimecode) {
107         m_dropFrames = round(m_realFps * .066666); //Number of frames to drop on the minute marks is the nearest integer to 6% of the framerate
108         m_framesPer10Minutes = round(m_realFps * 600); //Number of frames per ten minutes
109     }
110     QRegExp regExp;
111     if (m_dropFrameTimecode)
112         regExp.setPattern("^\\d{2}:\\d{2}:\\d{2};\\d{2}$");
113     else
114         regExp.setPattern("^\\d{2}:\\d{2}:\\d{2}:\\d{2}$");
115     m_validator->setRegExp(regExp);
116 }
117
118 double Timecode::fps() const
119 {
120     return m_realFps;
121 }
122
123 bool Timecode::df() const
124 {
125     return m_dropFrameTimecode;
126 }
127
128 const QValidator *Timecode::validator() const
129 {
130     return m_validator;
131 }
132
133 QString Timecode::reformatSeparators(QString duration) const
134 {
135     if (m_dropFrameTimecode)
136         return duration.replace(8, 1, ';');
137     return duration.replace(8, 1, ':');
138 }
139
140 int Timecode::getDisplayFrameCount(const QString duration, bool frameDisplay) const
141 {
142     if (frameDisplay) return duration.toInt();
143     return getFrameCount(duration);
144 }
145
146 int Timecode::getFrameCount(const QString duration) const
147 {
148     if (m_dropFrameTimecode) {
149
150         //CONVERT DROP FRAME TIMECODE TO A FRAME NUMBER
151         //Code by David Heidelberger, adapted from Andrew Duncan
152         //Given ints called hours, minutes, seconds, frames, and a double called framerate
153
154         //Get Hours, Minutes, Seconds, Frames from timecode
155         int hours, minutes, seconds, frames;
156
157         hours = duration.section(':', 0, 0).toInt();
158         minutes = duration.section(':', 1, 1).toInt();
159         if (duration.contains(';')) {
160             seconds = duration.section(';', 0, 0).section(':', 2, 2).toInt();
161             frames = duration.section(';', 1, 1).toInt();
162         } else {
163             //Handle Drop Frame timecode frame calculations, even if the timecode supplied uses incorrect "99:99:99:99" format instead of "99:99:99;99"
164             seconds = duration.section(':', 2, 2).toInt();
165             frames = duration.section(':', 3, 3).toInt();
166         }
167
168         int totalMinutes = (60 * hours) + minutes; //Total number of minutes
169         int frameNumber = ((m_displayedFramesPerSecond * 3600 * hours) + (m_displayedFramesPerSecond * 60 * minutes) + (m_displayedFramesPerSecond * seconds) + frames) - (m_dropFrames * (totalMinutes - floor(totalMinutes / 10)));
170         return frameNumber;
171     }
172     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());
173 }
174
175 QString Timecode::getDisplayTimecode(const GenTime & time, bool frameDisplay) const
176 {
177     if (frameDisplay) return QString::number((int) time.frames(m_realFps));
178     return getTimecode(time);
179 }
180
181 QString Timecode::getTimecode(const GenTime & time) const
182 {
183     switch (m_format) {
184     case HH_MM_SS_FF:
185         return getTimecodeHH_MM_SS_FF(time);
186         break;
187     case HH_MM_SS_HH:
188         return getTimecodeHH_MM_SS_HH(time);
189         break;
190     case Frames:
191         return getTimecodeFrames(time);
192         break;
193     case Seconds:
194         return getTimecodeSeconds(time);
195         break;
196     default:
197         kWarning() <<
198         "Unknown timecode format specified, defaulting to HH_MM_SS_FF"
199         << endl;
200         return getTimecodeHH_MM_SS_FF(time);
201     }
202 }
203
204 const QString Timecode::getDisplayTimecodeFromFrames(int frames, bool frameDisplay) const
205 {
206     if (frameDisplay) return QString::number(frames);
207     return getTimecodeHH_MM_SS_FF(frames);
208 }
209
210 const QString Timecode::getTimecodeFromFrames(int frames) const
211 {
212     return getTimecodeHH_MM_SS_FF(frames);
213 }
214
215
216 //static
217 QString Timecode::getStringTimecode(int frames, const double &fps)
218 {
219     // Returns the timecode in an hh:mm:ss format
220
221     bool negative = false;
222     if (frames < 0) {
223         negative = true;
224         frames = qAbs(frames);
225     }
226
227     int seconds = (int)(frames / fps);
228     int minutes = seconds / 60;
229     seconds = seconds % 60;
230     int hours = minutes / 60;
231     minutes = minutes % 60;
232     QString text;
233     if (negative)
234         text.append('-');
235     text.append(QString::number(hours).rightJustified(2, '0', false));
236     text.append(':');
237     text.append(QString::number(minutes).rightJustified(2, '0', false));
238     text.append(':');
239     text.append(QString::number(seconds).rightJustified(2, '0', false));
240     return text;
241 }
242
243
244 //static
245 QString Timecode::getEasyTimecode(const GenTime & time, const double &fps)
246 {
247     // Returns the timecode in an easily read display, like 3 min. 5 sec.
248     int frames = (int) time.frames(fps);
249
250     bool negative = false;
251     if (frames < 0) {
252         negative = true;
253         frames = qAbs(frames);
254     }
255
256     int seconds = (int)(frames / fps);
257     frames = frames - ((int)(fps * seconds));
258
259     int minutes = seconds / 60;
260     seconds = seconds % 60;
261     int hours = minutes / 60;
262     minutes = minutes % 60;
263
264     QString text;
265     bool trim = false;
266
267     if (negative)
268         text.append('-');
269     if (hours != 0) {
270         text.append(QString::number(hours).rightJustified(2, '0', false));
271         text.append(' ' + i18n("hour") + ' ');
272         trim = true;
273     }
274     if (minutes != 0 || trim) {
275         if (!trim) {
276             text.append(QString::number(minutes));
277         } else
278             text.append(QString::number(minutes).rightJustified(2, '0', false));
279         text.append(' ' + i18n("min.") + ' ');
280         trim = true;
281     }
282     if (seconds != 0 || trim) {
283         if (!trim) {
284             text.append(QString::number(seconds));
285         } else
286             text.append(QString::number(seconds).rightJustified(2, '0', false));
287         text.append(' ' + i18n("sec."));
288         trim = true;
289     }
290     if (!trim) {
291         text.append(QString::number(frames));
292         text.append(' ' + i18n("frames"));
293     }
294
295     return text;
296 }
297
298
299 const QString Timecode::getTimecodeHH_MM_SS_FF(const GenTime & time) const
300 {
301     if (m_dropFrameTimecode) {
302         return getTimecodeDropFrame(time);
303     }
304     return getTimecodeHH_MM_SS_FF((int) time.frames(m_realFps));
305 }
306
307 const QString Timecode::getTimecodeHH_MM_SS_FF(int frames) const
308 {
309     if (m_dropFrameTimecode) {
310         return getTimecodeDropFrame(frames);
311     }
312
313     bool negative = false;
314     if (frames < 0) {
315         negative = true;
316         frames = qAbs(frames);
317     }
318
319     int seconds = frames / m_displayedFramesPerSecond;
320     frames = frames % m_displayedFramesPerSecond;
321
322     int minutes = seconds / 60;
323     seconds = seconds % 60;
324     int hours = minutes / 60;
325     minutes = minutes % 60;
326
327     QString text;
328     if (negative)
329         text.append('-');
330     text.append(QString::number(hours).rightJustified(2, '0', false));
331     text.append(':');
332     text.append(QString::number(minutes).rightJustified(2, '0', false));
333     text.append(':');
334     text.append(QString::number(seconds).rightJustified(2, '0', false));
335     text.append(':');
336     text.append(QString::number(frames).rightJustified(2, '0', false));
337
338     return text;
339 }
340
341 const QString Timecode::getTimecodeHH_MM_SS_HH(const GenTime & time) const
342 {
343     int hundredths = (int)(time.seconds() * 100);
344
345     bool negative = false;
346     if (hundredths < 0) {
347         negative = true;
348         hundredths = qAbs(hundredths);
349     }
350
351     int seconds = hundredths / 100;
352     hundredths = hundredths % 100;
353     int minutes = seconds / 60;
354     seconds = seconds % 60;
355     int hours = minutes / 60;
356     minutes = minutes % 60;
357
358     QString text;
359     if (negative)
360         text.append('-');
361     text.append(QString::number(hours).rightJustified(2, '0', false));
362     text.append(':');
363     text.append(QString::number(minutes).rightJustified(2, '0', false));
364     text.append(':');
365     text.append(QString::number(seconds).rightJustified(2, '0', false));
366     if (m_dropFrameTimecode)
367         text.append(';');
368     else
369         text.append(':');
370     text.append(QString::number(hundredths).rightJustified(2, '0', false));
371
372     return text;
373 }
374
375 const QString Timecode::getTimecodeFrames(const GenTime & time) const
376 {
377     return QString::number((int) time.frames(m_realFps));
378 }
379
380 const QString Timecode::getTimecodeSeconds(const GenTime & time) const
381 {
382     QLocale locale;
383     return locale.toString(time.seconds());
384 }
385
386 const QString Timecode::getTimecodeDropFrame(const GenTime & time) const
387 {
388     return getTimecodeDropFrame((int)time.frames(m_realFps));
389 }
390
391 const QString Timecode::getTimecodeDropFrame(int framenumber) const
392 {
393     //CONVERT A FRAME NUMBER TO DROP FRAME TIMECODE
394     //Based on code by David Heidelberger, adapted from Andrew Duncan
395     //Given an int called framenumber and a double called framerate
396     //Framerate should be 29.97, 59.94, or 23.976, otherwise the calculations will be off.
397
398     bool negative = false;
399     if (framenumber < 0) {
400         negative = true;
401         framenumber = qAbs(framenumber);
402     }
403
404     int d = floor(framenumber / m_framesPer10Minutes);
405     int m = framenumber % m_framesPer10Minutes;
406
407     if (m > m_dropFrames) {
408         framenumber += (m_dropFrames * 9 * d) + m_dropFrames * (floor((m - m_dropFrames) / (round(m_realFps * 60) - m_dropFrames)));
409     } else {
410         framenumber += m_dropFrames * 9 * d;
411     }
412
413     int frames = framenumber % m_displayedFramesPerSecond;
414     int seconds = (int) floor(framenumber / m_displayedFramesPerSecond) % 60;
415     int minutes = (int) floor(floor(framenumber / m_displayedFramesPerSecond) / 60) % 60;
416     int hours = floor(floor(floor(framenumber / m_displayedFramesPerSecond) / 60) / 60);
417
418     QString text;
419     if (negative)
420         text.append('-');
421     text.append(QString::number(hours).rightJustified(2, '0', false));
422     text.append(':');
423     text.append(QString::number(minutes).rightJustified(2, '0', false));
424     text.append(':');
425     text.append(QString::number(seconds).rightJustified(2, '0', false));
426     text.append(';');
427     text.append(QString::number(frames).rightJustified(2, '0', false));
428
429     return text;
430 }