timecode.h

Go to the documentation of this file.

#ifndef TIMECODE_H
#define TIMECODE_H 1

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h> /* size_t */

#ifndef DOXYGEN_IGNORE
/* libtimecode version */
#define LIBTIMECODE_VERSION "0.5.0"
#define LIBTIMECODE_VERSION_MAJOR  0
#define LIBTIMECODE_VERSION_MINOR  0
#define LIBTIMECODE_VERSION_MICRO  0

/* interface revision number
 * http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
 */
#define LIBTIMECODE_CUR  0
#define LIBTIMECODE_REV  0
#define LIBTIMECODE_AGE  0
#endif

#ifndef int32_t
typedef int int32_t;
#endif

#ifndef int64_t
typedef long long int int64_t;
#endif

typedef struct TimecodeTime {
        int32_t hour; 
        int32_t minute; 
        int32_t second; 
        int32_t frame; 
        int32_t subframe; 
} TimecodeTime;

typedef struct TimecodeDate {
        int32_t year; 
        int32_t month; 
        int32_t day;  
        int32_t timezone; 
} TimecodeDate;


typedef struct TimecodeRate {
        int32_t num; 
        int32_t den; 
        int drop; 
        int32_t subframes; 
} TimecodeRate;

typedef struct Timecode {
        TimecodeTime t; 
        TimecodeDate d; 
        TimecodeRate r; 
} Timecode;


/* TODO: subframe default, use 80, 100 or 384 or 600 or 5760,.. or 500000
 * 84672000 = LCM(192k, 88.2k, 24, 25, 30)
 */

const TimecodeRate tcfps23976   = { 24000, 1001, 0, 80};
const TimecodeRate tcfps24      = {    24,    1, 0, 80};
const TimecodeRate tcfps24976   = { 25000, 1001, 0, 80};
const TimecodeRate tcfps25      = {    25,    1, 0, 80};
const TimecodeRate tcfps2997ndf = { 30000, 1001, 0, 80};
const TimecodeRate tcfps2997df  = { 30000, 1001, 1, 80};
const TimecodeRate tcfps30      = {    30,    1, 0, 80};
const TimecodeRate tcfps30df    = {    30,    1, 1, 80};
const TimecodeRate tcfps5994    = { 60000, 1001, 0, 80};
const TimecodeRate tcfps60      = {    30,    1, 0, 80};

const TimecodeRate tcfpsDS      = {        10,   1, 0, 1000};
const TimecodeRate tcfpsCS      = {       100,   1, 0, 1000};
const TimecodeRate tcfpsMS      = {      1000,   1, 0, 1000};
const TimecodeRate tcfpsUS      = {   1000000,   1, 0, 1};
const TimecodeRate tcfpsNS      = {1000000000,   1, 0, 1};

#define TCFPS23976 (&tcfps23976)
#define TCFPS24 (&tcfps24)
#define TCFPS24976 (&tcfps24976)
#define TCFPS25 (&tcfps25)
#define TCFPS2997DF (&tcfps2997df)
#define TCFPS30 (&tcfps30)
#define TCFPSMS (&tcfpsMS)


/*  --- misc functions  --- */

double timecode_rate_to_double(TimecodeRate const * const r);

double timecode_frames_per_timecode_frame(TimecodeRate const * const r, const double samplerate);


/*  --- timecode <> sample,frame-number  --- */

int64_t timecode_to_sample (TimecodeTime const * const t, TimecodeRate const * const r, const double samplerate);

void timecode_sample_to_time (TimecodeTime * const t, TimecodeRate const * const r, const double samplerate, const int64_t sample);


int64_t timecode_to_framenumber (TimecodeTime const * const t, TimecodeRate const * const r);

void timecode_framenumber_to_time (TimecodeTime * const t, TimecodeRate const * const r, const int64_t frameno);

void timecode_convert_rate (TimecodeTime * const t_out, TimecodeRate const * const r_out, TimecodeTime * const t_in, TimecodeRate const * const r_in);


/* --- float seconds --- */

double timecode_sample_to_seconds (const int64_t sample, double samplerate);

int64_t timecode_seconds_to_sample (const double sec, double samplerate);

double timecode_framenumber_to_seconds (const int64_t frameno, TimecodeRate const * const r);

int64_t timecode_seconds_to_framenumber (const double sec, TimecodeRate const * const r);

void timecode_seconds_to_time (TimecodeTime * const t, TimecodeRate const * const r, const double sec);

double timecode_to_sec (TimecodeTime const * const t, TimecodeRate const * const r);


/*  --- add/subtract timecodes at same frame rate  --- */

void timecode_time_add (TimecodeTime * const res, TimecodeRate const * const r, TimecodeTime const * const t1, TimecodeTime const * const t2);

void timecode_time_subtract (TimecodeTime * const res, TimecodeRate const * const r, TimecodeTime const * const t1, TimecodeTime const * const t2);


/*  --- comparison operators at same frame rate  --- */

int timecode_time_compare (TimecodeRate const * const r, TimecodeTime const * const a, TimecodeTime const * const b);

int timecode_date_compare (TimecodeDate const * const a, TimecodeDate const * const b);

int timecode_datetime_compare (TimecodeRate const * const r, Timecode const * const a, Timecode const * const b);


/*  --- increment, decrement  --- */

void timecode_date_increment(TimecodeDate * const d);

void timecode_date_decrement (TimecodeDate * const d);

int timecode_time_increment(TimecodeTime * const t, TimecodeRate const * const r);

int timecode_time_decrement(TimecodeTime * const t, TimecodeRate const * const r);

int timecode_datetime_increment (Timecode * const dt);

int timecode_datetime_decrement (Timecode * const dt);


/*  --- parse from string, export to string  --- */

void timecode_time_to_string (char *smptestring, TimecodeTime const * const t);

size_t timecode_strftimecode (char *str, const size_t maxsize, const char *format, const Timecode const * const t);

size_t timecode_strftime (char *str, const size_t maxsize, const char *format, const TimecodeTime const * const t, const TimecodeRate const * const r);

void timecode_parse_time (TimecodeTime * const t, TimecodeRate const * const r, const char *val);

/* TODO, ideas */
// parse date, timezone, parse packed format "HHMMSSFF"
// Bar, Beat, Tick Time (Tempo-Based Time)

#ifdef __cplusplus
}
#endif


#endif