yading@11: /* yading@11: * Copyright (c) 2006 Smartjog S.A.S, Baptiste Coudurier yading@11: * Copyright (c) 2011-2012 Smartjog S.A.S, Clément Bœsch yading@11: * yading@11: * This file is part of FFmpeg. yading@11: * yading@11: * FFmpeg is free software; you can redistribute it and/or yading@11: * modify it under the terms of the GNU Lesser General Public yading@11: * License as published by the Free Software Foundation; either yading@11: * version 2.1 of the License, or (at your option) any later version. yading@11: * yading@11: * FFmpeg is distributed in the hope that it will be useful, yading@11: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@11: * Lesser General Public License for more details. yading@11: * yading@11: * You should have received a copy of the GNU Lesser General Public yading@11: * License along with FFmpeg; if not, write to the Free Software yading@11: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@11: */ yading@11: yading@11: /** yading@11: * @file yading@11: * Timecode helpers header yading@11: */ yading@11: yading@11: #ifndef AVUTIL_TIMECODE_H yading@11: #define AVUTIL_TIMECODE_H yading@11: yading@11: #include yading@11: #include "rational.h" yading@11: yading@11: #define AV_TIMECODE_STR_SIZE 16 yading@11: yading@11: enum AVTimecodeFlag { yading@11: AV_TIMECODE_FLAG_DROPFRAME = 1<<0, ///< timecode is drop frame yading@11: AV_TIMECODE_FLAG_24HOURSMAX = 1<<1, ///< timecode wraps after 24 hours yading@11: AV_TIMECODE_FLAG_ALLOWNEGATIVE = 1<<2, ///< negative time values are allowed yading@11: }; yading@11: yading@11: typedef struct { yading@11: int start; ///< timecode frame start (first base frame number) yading@11: uint32_t flags; ///< flags such as drop frame, +24 hours support, ... yading@11: AVRational rate; ///< frame rate in rational form yading@11: unsigned fps; ///< frame per second; must be consistent with the rate field yading@11: } AVTimecode; yading@11: yading@11: /** yading@11: * Adjust frame number for NTSC drop frame time code. yading@11: * yading@11: * @param framenum frame number to adjust yading@11: * @param fps frame per second, 30 or 60 yading@11: * @return adjusted frame number yading@11: * @warning adjustment is only valid in NTSC 29.97 and 59.94 yading@11: */ yading@11: int av_timecode_adjust_ntsc_framenum2(int framenum, int fps); yading@11: yading@11: /** yading@11: * Convert frame number to SMPTE 12M binary representation. yading@11: * yading@11: * @param tc timecode data correctly initialized yading@11: * @param framenum frame number yading@11: * @return the SMPTE binary representation yading@11: * yading@11: * @note Frame number adjustment is automatically done in case of drop timecode, yading@11: * you do NOT have to call av_timecode_adjust_ntsc_framenum2(). yading@11: * @note The frame number is relative to tc->start. yading@11: * @note Color frame (CF), binary group flags (BGF) and biphase mark polarity yading@11: * correction (PC) bits are set to zero. yading@11: */ yading@11: uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum); yading@11: yading@11: /** yading@11: * Load timecode string in buf. yading@11: * yading@11: * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long yading@11: * @param tc timecode data correctly initialized yading@11: * @param framenum frame number yading@11: * @return the buf parameter yading@11: * yading@11: * @note Timecode representation can be a negative timecode and have more than yading@11: * 24 hours, but will only be honored if the flags are correctly set. yading@11: * @note The frame number is relative to tc->start. yading@11: */ yading@11: char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum); yading@11: yading@11: /** yading@11: * Get the timecode string from the SMPTE timecode format. yading@11: * yading@11: * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long yading@11: * @param tcsmpte the 32-bit SMPTE timecode yading@11: * @param prevent_df prevent the use of a drop flag when it is known the DF bit yading@11: * is arbitrary yading@11: * @return the buf parameter yading@11: */ yading@11: char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df); yading@11: yading@11: /** yading@11: * Get the timecode string from the 25-bit timecode format (MPEG GOP format). yading@11: * yading@11: * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long yading@11: * @param tc25bit the 25-bits timecode yading@11: * @return the buf parameter yading@11: */ yading@11: char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit); yading@11: yading@11: /** yading@11: * Init a timecode struct with the passed parameters. yading@11: * yading@11: * @param log_ctx a pointer to an arbitrary struct of which the first field yading@11: * is a pointer to an AVClass struct (used for av_log) yading@11: * @param tc pointer to an allocated AVTimecode yading@11: * @param rate frame rate in rational form yading@11: * @param flags miscellaneous flags such as drop frame, +24 hours, ... yading@11: * (see AVTimecodeFlag) yading@11: * @param frame_start the first frame number yading@11: * @return 0 on success, AVERROR otherwise yading@11: */ yading@11: int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx); yading@11: yading@11: /** yading@11: * Parse timecode representation (hh:mm:ss[:;.]ff). yading@11: * yading@11: * @param log_ctx a pointer to an arbitrary struct of which the first field is a yading@11: * pointer to an AVClass struct (used for av_log). yading@11: * @param tc pointer to an allocated AVTimecode yading@11: * @param rate frame rate in rational form yading@11: * @param str timecode string which will determine the frame start yading@11: * @return 0 on success, AVERROR otherwise yading@11: */ yading@11: int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx); yading@11: yading@11: /** yading@11: * Check if the timecode feature is available for the given frame rate yading@11: * yading@11: * @return 0 if supported, <0 otherwise yading@11: */ yading@11: int av_timecode_check_frame_rate(AVRational rate); yading@11: yading@11: #endif /* AVUTIL_TIMECODE_H */