FFmpeg
timecode.h
Go to the documentation of this file.
1 /*
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>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 
27 #ifndef AVUTIL_TIMECODE_H
28 #define AVUTIL_TIMECODE_H
29 
30 #include <stdint.h>
31 #include "rational.h"
32 
33 #define AV_TIMECODE_STR_SIZE 23
34 
39 };
40 
41 typedef struct {
42  int start;
43  uint32_t flags;
45  unsigned fps;
46 } AVTimecode;
47 
56 int av_timecode_adjust_ntsc_framenum2(int framenum, int fps);
57 
71 uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum);
72 
85 char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum);
86 
96 char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df);
97 
105 char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit);
106 
119 int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx);
120 
131 int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx);
132 
139 
140 #endif /* AVUTIL_TIMECODE_H */
timecode is drop frame
Definition: timecode.h:36
char * av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum)
Load timecode string in buf.
Definition: timecode.c:84
int start
timecode frame start (first base frame number)
Definition: timecode.h:42
int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx)
Parse timecode representation (hh:mm:ss[:;.
Definition: timecode.c:194
AVTimecodeFlag
Definition: timecode.h:35
unsigned fps
frame per second; must be consistent with the rate field
Definition: timecode.h:45
timecode wraps after 24 hours
Definition: timecode.h:37
int av_timecode_adjust_ntsc_framenum2(int framenum, int fps)
Adjust frame number for NTSC drop frame time code.
Definition: timecode.c:34
AVRational rate
frame rate in rational form
Definition: timecode.h:44
int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx)
Init a timecode struct with the passed parameters.
Definition: timecode.c:184
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int av_timecode_check_frame_rate(AVRational rate)
Check if the timecode feature is available for the given frame rate.
Definition: timecode.c:179
negative time values are allowed
Definition: timecode.h:38
char * av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df)
Get the timecode string from the SMPTE timecode format.
Definition: timecode.c:118
char * av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit)
Get the timecode string from the 25-bit timecode format (MPEG GOP format).
Definition: timecode.c:130
Utilties for rational number calculation.
uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum)
Convert frame number to SMPTE 12M binary representation.
Definition: timecode.c:55
Definition: timecode.h:41
uint32_t flags
flags such as drop frame, +24 hours support, ...
Definition: timecode.h:43