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 16
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 * @return adjusted frame number
53 * @warning adjustment is only valid in NTSC 29.97
54 * @deprecated use av_timecode_adjust_ntsc_framenum2 instead
56 attribute_deprecated int av_timecode_adjust_ntsc_framenum(int framenum);
59 * Adjust frame number for NTSC drop frame time code.
61 * @param framenum frame number to adjust
62 * @param fps frame per second, 30 or 60
63 * @return adjusted frame number
64 * @warning adjustment is only valid in NTSC 29.97 and 59.94
66 int av_timecode_adjust_ntsc_framenum2(int framenum, int fps);
69 * Convert frame number to SMPTE 12M binary representation.
71 * @param tc timecode data correctly initialized
72 * @param framenum frame number
73 * @return the SMPTE binary representation
75 * @note Frame number adjustment is automatically done in case of drop timecode,
76 * you do NOT have to call av_timecode_adjust_ntsc_framenum().
77 * @note The frame number is relative to tc->start.
78 * @note Color frame (CF), binary group flags (BGF) and biphase mark polarity
79 * correction (PC) bits are set to zero.
81 uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum);
84 * Load timecode string in buf.
86 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
87 * @param tc timecode data correctly initialized
88 * @param framenum frame number
89 * @return the buf parameter
91 * @note Timecode representation can be a negative timecode and have more than
92 * 24 hours, but will only be honored if the flags are correctly set.
93 * @note The frame number is relative to tc->start.
95 char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum);
98 * Get the timecode string from the SMPTE timecode format.
100 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
101 * @param tcsmpte the 32-bit SMPTE timecode
102 * @param prevent_df prevent the use of a drop flag when it is known the DF bit
104 * @return the buf parameter
106 char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df);
109 * Get the timecode string from the 25-bit timecode format (MPEG GOP format).
111 * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long
112 * @param tc25bit the 25-bits timecode
113 * @return the buf parameter
115 char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit);
118 * Init a timecode struct with the passed parameters.
120 * @param log_ctx a pointer to an arbitrary struct of which the first field
121 * is a pointer to an AVClass struct (used for av_log)
122 * @param tc pointer to an allocated AVTimecode
123 * @param rate frame rate in rational form
124 * @param flags miscellaneous flags such as drop frame, +24 hours, ...
125 * (see AVTimecodeFlag)
126 * @param frame_start the first frame number
127 * @return 0 on success, AVERROR otherwise
129 int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx);
132 * Parse timecode representation (hh:mm:ss[:;.]ff).
134 * @param log_ctx a pointer to an arbitrary struct of which the first field is a
135 * pointer to an AVClass struct (used for av_log).
136 * @param tc pointer to an allocated AVTimecode
137 * @param rate frame rate in rational form
138 * @param str timecode string which will determine the frame start
139 * @return 0 on success, AVERROR otherwise
141 int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx);
144 * Check if the timecode feature is available for the given frame rate
146 * @return 0 if supported, <0 otherwise
148 int av_timecode_check_frame_rate(AVRational rate);
150 #endif /* AVUTIL_TIMECODE_H */