timecode.h

/*****************************************************************
 * gavl - a general purpose audio/video processing library
 *
 * Copyright (c) 2001 - 2024 Members of the Gmerlin project
 * http://github.com/bplaum
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * *****************************************************************/
 
 
 
#ifndef GAVL_TIMECODE_H_INCLUDED
#define GAVL_TIMECODE_H_INCLUDED
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <gavl/gavldefs.h>

 
typedef uint64_t gavl_timecode_t; 
 
#define GAVL_TIMECODE_SIGN_MASK     (0x1LL<<62) 
#define GAVL_TIMECODE_INVALID_MASK  (0x1LL<<63) 
 
#define GAVL_TIMECODE_DROP_FRAME (1<<0) 
 
#define GAVL_TIMECODE_UNDEFINED GAVL_TIMECODE_INVALID_MASK 
  
  
typedef struct
  {
  uint32_t int_framerate; 
  uint32_t flags;         
  } gavl_timecode_format_t;

  
GAVL_PUBLIC
void gavl_timecode_format_copy(gavl_timecode_format_t * dst,
                               const gavl_timecode_format_t * src);
 
  
  
GAVL_PUBLIC
void gavl_timecode_to_hmsf(gavl_timecode_t tc,
                           int * hours,
                           int * minutes,
                           int * seconds,
                           int * frames);

  
GAVL_PUBLIC
void gavl_timecode_to_ymd(gavl_timecode_t tc,
                          int * year,
                          int * month,
                          int * day);

  
GAVL_PUBLIC
void gavl_timecode_from_hmsf(gavl_timecode_t * tc,
                            int hours,
                            int minutes,
                            int seconds,
                            int frames);

  
GAVL_PUBLIC
void gavl_timecode_from_ymd(gavl_timecode_t * tc,
                            int year,
                            int month,
                            int day);

  
GAVL_PUBLIC
int64_t gavl_timecode_to_framecount(const gavl_timecode_format_t * tf,
                                    gavl_timecode_t tc);

 
GAVL_PUBLIC
gavl_timecode_t gavl_timecode_from_framecount(const gavl_timecode_format_t * tf,
                                              int64_t fc);

  
GAVL_PUBLIC
void gavl_timecode_dump(const gavl_timecode_format_t * tf,
                        gavl_timecode_t tc);
  
 
/* -YYYY-MM-DD-HH:MM:SS.FFFF */
 
#define GAVL_TIMECODE_STRING_LEN 26 

  
GAVL_PUBLIC
void gavl_timecode_prettyprint(const gavl_timecode_format_t * tf,
                               gavl_timecode_t tc,
                               char str[GAVL_TIMECODE_STRING_LEN]);
 
/* -HH:MM:SS:FF */
 
#define GAVL_TIMECODE_STRING_LEN_SHORT 13 

  
GAVL_PUBLIC
void gavl_timecode_prettyprint_short(gavl_timecode_t tc,
                                     char str[GAVL_TIMECODE_STRING_LEN_SHORT]);
 
  
 
#ifdef __cplusplus
}
#endif
 
#endif /* GAVL_TIMECODE_H_INCLUDED */