2 * Copyright (c) 2006 Smartjog S.A.S, Baptiste Coudurier <baptiste.coudurier@gmail.com>
3 * Copyright (c) 2011-2012 Smartjog S.A.S, Clément Bœsch <clement.boesch@smartjog.com>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Timecode helpers header
27 #ifndef AVUTIL_TIMECODE_H
28 #define AVUTIL_TIMECODE_H
33 #define AV_TIMECODE_STR_SIZE 23
36 AV_TIMECODE_FLAG_DROPFRAME = 1<<0, ///< timecode is drop frame
37 AV_TIMECODE_FLAG_24HOURSMAX = 1<<1, ///< timecode wraps after 24 hours
38 AV_TIMECODE_FLAG_ALLOWNEGATIVE = 1<<2, ///< negative time values are allowed
42 int start; ///< timecode frame start (first base frame number)
43 uint32_t flags; ///< flags such as drop frame, +24 hours support, ...
44 AVRational rate; ///< frame rate in rational form
45 unsigned fps; ///< frame per second; must be consistent with the rate field
49 * Adjust frame number for NTSC drop frame time code.
51 * @param framenum frame number to adjust
52 * @param fps frame per second, 30 or 60
53 * @return adjusted frame number
54 * @warning adjustment is only valid in NTSC 29.97 and 59.94
56 int av_timecode_adjust_ntsc_framenum2(int framenum, int fps);
59 * Convert frame number to SMPTE 12M binary representation.
61 * @param tc timecode data correctly initialized
62 * @param framenum frame number
63 * @return the SMPTE binary representation
65 * See SMPTE ST 314M-2005 Sec 4.4.2.2.1 "Time code pack (TC)"
66 * the format description as follows:
67 * bits 0-5: hours, in BCD(6bits)
69 * bits 7: BGF2 (NTSC) or FIELD (PAL)
70 * bits 8-14: minutes, in BCD(7bits)
71 * bits 15: BGF0 (NTSC) or BGF2 (PAL)
72 * bits 16-22: seconds, in BCD(7bits)
73 * bits 23: FIELD (NTSC) or BGF0 (PAL)
74 * bits 24-29: frames, in BCD(6bits)
75 * bits 30: drop frame flag (0: non drop, 1: drop)
76 * bits 31: color frame flag (0: unsync mode, 1: sync mode)
77 * @note BCD numbers (6 or 7 bits): 4 or 5 lower bits for units, 2 higher bits for tens.
78 * @note Frame number adjustment is automatically done in case of drop timecode,
79 * you do NOT have to call av_timecode_adjust_ntsc_framenum2().
80 * @note The frame number is relative to tc->start.
81 * @note Color frame (CF) and binary group flags (BGF) bits are set to zero.
83 uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum);
86 * Convert sei info to SMPTE 12M binary representation.
88 * @param rate frame rate in rational form
89 * @param drop drop flag
93 * @param ff frame number
94 * @return the SMPTE binary representation
96 uint32_t av_timecode_get_smpte(AVRational rate, int drop, int hh, int mm, int ss, int ff);
99 * Load timecode string in buf.
101 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
102 * @param tc timecode data correctly initialized
103 * @param framenum frame number
104 * @return the buf parameter
106 * @note Timecode representation can be a negative timecode and have more than
107 * 24 hours, but will only be honored if the flags are correctly set.
108 * @note The frame number is relative to tc->start.
110 char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum);
113 * Get the timecode string from the SMPTE timecode format.
115 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
116 * @param tcsmpte the 32-bit SMPTE timecode
117 * @param prevent_df prevent the use of a drop flag when it is known the DF bit
119 * @return the buf parameter
121 char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df);
124 * Get the timecode string from the 25-bit timecode format (MPEG GOP format).
126 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
127 * @param tc25bit the 25-bits timecode
128 * @return the buf parameter
130 char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit);
133 * Init a timecode struct with the passed parameters.
135 * @param log_ctx a pointer to an arbitrary struct of which the first field
136 * is a pointer to an AVClass struct (used for av_log)
137 * @param tc pointer to an allocated AVTimecode
138 * @param rate frame rate in rational form
139 * @param flags miscellaneous flags such as drop frame, +24 hours, ...
140 * (see AVTimecodeFlag)
141 * @param frame_start the first frame number
142 * @return 0 on success, AVERROR otherwise
144 int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx);
147 * Parse timecode representation (hh:mm:ss[:;.]ff).
149 * @param log_ctx a pointer to an arbitrary struct of which the first field is a
150 * pointer to an AVClass struct (used for av_log).
151 * @param tc pointer to an allocated AVTimecode
152 * @param rate frame rate in rational form
153 * @param str timecode string which will determine the frame start
154 * @return 0 on success, AVERROR otherwise
156 int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx);
159 * Check if the timecode feature is available for the given frame rate
161 * @return 0 if supported, <0 otherwise
163 int av_timecode_check_frame_rate(AVRational rate);
165 #endif /* AVUTIL_TIMECODE_H */