]> git.sesse.net Git - kdenlive/blob - src/timecode.h
Clean up timecode handling, improves:
[kdenlive] / src / timecode.h
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 ***************************************************************************/
8
9 /***************************************************************************
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  ***************************************************************************/
17 #ifndef TIMECODE_H
18 #define TIMECODE_H
19
20 #include <qstring.h>
21
22 #include "gentime.h"
23
24 /**
25 Handles the conversion of a GenTime into a nicely formatted string, taking into account things such as drop frame if necessary. Handles multiple formats, such as HH:MM:SS:FF, HH:MM:SS:F, All Frames, All Seconds, etc.
26
27 @author Jason Wood
28 */
29 class Timecode
30 {
31 public:
32     enum Formats { HH_MM_SS_FF, HH_MM_SS_HH, Frames, Seconds };
33
34     explicit Timecode(Formats format = HH_MM_SS_FF, double framesPerSecond =
35                           25, bool dropFrame = false);
36
37     /** Set the current timecode format; this is the output format for this timecode. */
38     void setFormat(double framesPerSecond, bool dropFrame = false, Formats format = HH_MM_SS_FF) {
39         m_displayedFramesPerSecond = (int) (framesPerSecond + 0.5);
40         m_dropFrame = dropFrame;
41         m_format = format;
42         m_realFps = framesPerSecond;
43     }
44
45     Formats format() const {
46         return m_format;
47     }
48
49     ~Timecode();
50
51     /** Returns the timecode for a given time */
52     QString getTimecode(const GenTime & time) const;
53     int getFrameCount(const QString duration) const;
54     static QString getEasyTimecode(const GenTime & time, const double &fps);
55     static QString getStringTimecode(int frames, const double &fps);
56     QString getTimecodeFromFrames(int frames) const;
57     int fps() const;
58
59 private:
60     Formats m_format;
61     bool m_dropFrame;
62     int m_displayedFramesPerSecond;
63     double m_realFps;
64
65     QString getTimecodeHH_MM_SS_FF(const GenTime & time) const;
66     QString getTimecodeHH_MM_SS_FF(int frames) const;
67     
68     QString getTimecodeHH_MM_SS_HH(const GenTime & time) const;
69     QString getTimecodeFrames(const GenTime & time) const;
70     QString getTimecodeSeconds(const GenTime & time) const;
71     QString getTimecodeDropFrame(const GenTime & time) const;
72     QString getTimecodeDropFrame(int frames) const;
73 };
74
75 #endif