git.sesse.net Git - ffmpeg/blob - libavutil/timecode.c

   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
  22 /**
  23  * @file
  24  * Timecode helpers
  25  * @see https://en.wikipedia.org/wiki/SMPTE_time_code
  26  * @see http://www.dropframetimecode.org
  27  */
  28
  29 #include <stdio.h>
  30 #include "timecode.h"
  31 #include "log.h"
  32 #include "error.h"
  33
  34 int av_timecode_adjust_ntsc_framenum2(int framenum, int fps)
  35 {
  36     /* only works for NTSC 29.97 and 59.94 */
  37     int drop_frames = 0;
  38     int d, m, frames_per_10mins;
  39
  40     if (fps == 30) {
  41         drop_frames = 2;
  42         frames_per_10mins = 17982;
  43     } else if (fps == 60) {
  44         drop_frames = 4;
  45         frames_per_10mins = 35964;
  46     } else
  47         return framenum;
  48
  49     d = framenum / frames_per_10mins;
  50     m = framenum % frames_per_10mins;
  51
  52     return framenum + 9 * drop_frames * d + drop_frames * ((m - drop_frames) / (frames_per_10mins / 10));
  53 }
  54
  55 uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum)
  56 {
  57     unsigned fps = tc->fps;
  58     int drop = !!(tc->flags & AV_TIMECODE_FLAG_DROPFRAME);
  59     int hh, mm, ss, ff;
  60
  61     framenum += tc->start;
  62     if (drop)
  63         framenum = av_timecode_adjust_ntsc_framenum2(framenum, tc->fps);
  64     ff = framenum % fps;
  65     ss = framenum / fps      % 60;
  66     mm = framenum / (fps*60) % 60;
  67     hh = framenum / (fps*3600) % 24;
  68     return av_timecode_get_smpte(tc->rate, drop, hh, mm, ss, ff);
  69 }
  70
  71 uint32_t av_timecode_get_smpte(AVRational rate, int drop, int hh, int mm, int ss, int ff)
  72 {
  73     uint32_t tc = 0;
  74
  75     /* For SMPTE 12-M timecodes, frame count is a special case if > 30 FPS.
  76        See SMPTE ST 12-1:2014 Sec 12.1 for more info. */
  77     if (av_cmp_q(rate, (AVRational) {30, 1}) == 1) {
  78         if (ff % 2 == 1) {
  79             if (av_cmp_q(rate, (AVRational) {50, 1}) == 0)
  80                 tc |= (1 << 7);
  81             else
  82                 tc |= (1 << 23);
  83         }
  84         ff /= 2;
  85     }
  86
  87     hh = hh % 24;
  88     mm = av_clip(mm, 0, 59);
  89     ss = av_clip(ss, 0, 59);
  90     ff = ff % 40;
  91
  92     tc |= drop << 30;
  93     tc |= (ff / 10) << 28;
  94     tc |= (ff % 10) << 24;
  95     tc |= (ss / 10) << 20;
  96     tc |= (ss % 10) << 16;
  97     tc |= (mm / 10) << 12;
  98     tc |= (mm % 10) << 8;
  99     tc |= (hh / 10) << 4;
 100     tc |= (hh % 10);
 101
 102     return tc;
 103 }
 104
 105 char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum)
 106 {
 107     int fps = tc->fps;
 108     int drop = tc->flags & AV_TIMECODE_FLAG_DROPFRAME;
 109     int hh, mm, ss, ff, neg = 0;
 110
 111     framenum += tc->start;
 112     if (drop)
 113         framenum = av_timecode_adjust_ntsc_framenum2(framenum, fps);
 114     if (framenum < 0) {
 115         framenum = -framenum;
 116         neg = tc->flags & AV_TIMECODE_FLAG_ALLOWNEGATIVE;
 117     }
 118     ff = framenum % fps;
 119     ss = framenum / fps        % 60;
 120     mm = framenum / (fps*60)   % 60;
 121     hh = framenum / (fps*3600);
 122     if (tc->flags & AV_TIMECODE_FLAG_24HOURSMAX)
 123         hh = hh % 24;
 124     snprintf(buf, AV_TIMECODE_STR_SIZE, "%s%02d:%02d:%02d%c%02d",
 125              neg ? "-" : "",
 126              hh, mm, ss, drop ? ';' : ':', ff);
 127     return buf;
 128 }
 129
 130 static unsigned bcd2uint(uint8_t bcd)
 131 {
 132    unsigned low  = bcd & 0xf;
 133    unsigned high = bcd >> 4;
 134    if (low > 9 || high > 9)
 135        return 0;
 136    return low + 10*high;
 137 }
 138
 139 char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df)
 140 {
 141     unsigned hh   = bcd2uint(tcsmpte     & 0x3f);    // 6-bit hours
 142     unsigned mm   = bcd2uint(tcsmpte>>8  & 0x7f);    // 7-bit minutes
 143     unsigned ss   = bcd2uint(tcsmpte>>16 & 0x7f);    // 7-bit seconds
 144     unsigned ff   = bcd2uint(tcsmpte>>24 & 0x3f);    // 6-bit frames
 145     unsigned drop = tcsmpte & 1<<30 && !prevent_df;  // 1-bit drop if not arbitrary bit
 146     snprintf(buf, AV_TIMECODE_STR_SIZE, "%02u:%02u:%02u%c%02u",
 147              hh, mm, ss, drop ? ';' : ':', ff);
 148     return buf;
 149 }
 150
 151 char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit)
 152 {
 153     snprintf(buf, AV_TIMECODE_STR_SIZE,
 154              "%02"PRIu32":%02"PRIu32":%02"PRIu32"%c%02"PRIu32,
 155              tc25bit>>19 & 0x1f,              // 5-bit hours
 156              tc25bit>>13 & 0x3f,              // 6-bit minutes
 157              tc25bit>>6  & 0x3f,              // 6-bit seconds
 158              tc25bit     & 1<<24 ? ';' : ':', // 1-bit drop flag
 159              tc25bit     & 0x3f);             // 6-bit frames
 160     return buf;
 161 }
 162
 163 static int check_fps(int fps)
 164 {
 165     int i;
 166     static const int supported_fps[] = {
 167         24, 25, 30, 48, 50, 60, 100, 120, 150,
 168     };
 169
 170     for (i = 0; i < FF_ARRAY_ELEMS(supported_fps); i++)
 171         if (fps == supported_fps[i])
 172             return 0;
 173     return -1;
 174 }
 175
 176 static int check_timecode(void *log_ctx, AVTimecode *tc)
 177 {
 178     if ((int)tc->fps <= 0) {
 179         av_log(log_ctx, AV_LOG_ERROR, "Valid timecode frame rate must be specified. Minimum value is 1\n");
 180         return AVERROR(EINVAL);
 181     }
 182     if ((tc->flags & AV_TIMECODE_FLAG_DROPFRAME) && tc->fps != 30 && tc->fps != 60) {
 183         av_log(log_ctx, AV_LOG_ERROR, "Drop frame is only allowed with 30000/1001 or 60000/1001 FPS\n");
 184         return AVERROR(EINVAL);
 185     }
 186     if (check_fps(tc->fps) < 0) {
 187         av_log(log_ctx, AV_LOG_WARNING, "Using non-standard frame rate %d/%d\n",
 188                tc->rate.num, tc->rate.den);
 189     }
 190     return 0;
 191 }
 192
 193 static int fps_from_frame_rate(AVRational rate)
 194 {
 195     if (!rate.den || !rate.num)
 196         return -1;
 197     return (rate.num + rate.den/2) / rate.den;
 198 }
 199
 200 int av_timecode_check_frame_rate(AVRational rate)
 201 {
 202     return check_fps(fps_from_frame_rate(rate));
 203 }
 204
 205 int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx)
 206 {
 207     memset(tc, 0, sizeof(*tc));
 208     tc->start = frame_start;
 209     tc->flags = flags;
 210     tc->rate  = rate;
 211     tc->fps   = fps_from_frame_rate(rate);
 212     return check_timecode(log_ctx, tc);
 213 }
 214
 215 int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx)
 216 {
 217     char c;
 218     int hh, mm, ss, ff, ret;
 219
 220     if (sscanf(str, "%d:%d:%d%c%d", &hh, &mm, &ss, &c, &ff) != 5) {
 221         av_log(log_ctx, AV_LOG_ERROR, "Unable to parse timecode, "
 222                                       "syntax: hh:mm:ss[:;.]ff\n");
 223         return AVERROR_INVALIDDATA;
 224     }
 225
 226     memset(tc, 0, sizeof(*tc));
 227     tc->flags = c != ':' ? AV_TIMECODE_FLAG_DROPFRAME : 0; // drop if ';', '.', ...
 228     tc->rate  = rate;
 229     tc->fps   = fps_from_frame_rate(rate);
 230
 231     ret = check_timecode(log_ctx, tc);
 232     if (ret < 0)
 233         return ret;
 234
 235     tc->start = (hh*3600 + mm*60 + ss) * tc->fps + ff;
 236     if (tc->flags & AV_TIMECODE_FLAG_DROPFRAME) { /* adjust frame number */
 237         int tmins = 60*hh + mm;
 238         tc->start -= (tc->fps == 30 ? 2 : 4) * (tmins - tmins/10);
 239     }
 240     return 0;
 241 }