<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>gavl: Timecodes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">gavl
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Timecodes</div> </div>
</div><!--header-->
<div class="contents">
<p>Timecode definitions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Timecode format. <a href="structgavl__timecode__format__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga725785acdd94b530c6bdc0017d92d32a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga725785acdd94b530c6bdc0017d92d32a">GAVL_TIMECODE_SIGN_MASK</a>   (0x1LL<<62)</td></tr>
<tr class="memdesc:ga725785acdd94b530c6bdc0017d92d32a"><td class="mdescLeft"> </td><td class="mdescRight">If 1, timecode is negative. <a href="#ga725785acdd94b530c6bdc0017d92d32a">More...</a><br /></td></tr>
<tr class="separator:ga725785acdd94b530c6bdc0017d92d32a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7d327b1069bfafdb6f64e3f2eded1e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gaf7d327b1069bfafdb6f64e3f2eded1e5">GAVL_TIMECODE_INVALID_MASK</a>   (0x1LL<<63)</td></tr>
<tr class="memdesc:gaf7d327b1069bfafdb6f64e3f2eded1e5"><td class="mdescLeft"> </td><td class="mdescRight">If 1, timecode is invalid. <a href="#gaf7d327b1069bfafdb6f64e3f2eded1e5">More...</a><br /></td></tr>
<tr class="separator:gaf7d327b1069bfafdb6f64e3f2eded1e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb132f471c755cdf8d479f549ff9b446"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gadb132f471c755cdf8d479f549ff9b446">GAVL_TIMECODE_DROP_FRAME</a>   (1<<0)</td></tr>
<tr class="memdesc:gadb132f471c755cdf8d479f549ff9b446"><td class="mdescLeft"> </td><td class="mdescRight">NTSC drop frame is used. <a href="#gadb132f471c755cdf8d479f549ff9b446">More...</a><br /></td></tr>
<tr class="separator:gadb132f471c755cdf8d479f549ff9b446"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1102fb210b8180cdc82c66204845cff2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga1102fb210b8180cdc82c66204845cff2">GAVL_TIMECODE_UNDEFINED</a>   <a class="el" href="group__timecode.html#gaf7d327b1069bfafdb6f64e3f2eded1e5">GAVL_TIMECODE_INVALID_MASK</a></td></tr>
<tr class="memdesc:ga1102fb210b8180cdc82c66204845cff2"><td class="mdescLeft"> </td><td class="mdescRight">Convenience macro. <a href="#ga1102fb210b8180cdc82c66204845cff2">More...</a><br /></td></tr>
<tr class="separator:ga1102fb210b8180cdc82c66204845cff2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf71e35da45bfb1b008fa4394c533b34c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gaf71e35da45bfb1b008fa4394c533b34c">GAVL_TIMECODE_STRING_LEN</a>   26</td></tr>
<tr class="separator:gaf71e35da45bfb1b008fa4394c533b34c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabff9793d5841d2ec4f93ee09fc0fe0e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gabff9793d5841d2ec4f93ee09fc0fe0e4">GAVL_TIMECODE_STRING_LEN_SHORT</a>   13</td></tr>
<tr class="separator:gabff9793d5841d2ec4f93ee09fc0fe0e4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga534f23baf96ee5cdabd99f1619672452"><td class="memItemLeft" align="right" valign="top">typedef uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a></td></tr>
<tr class="memdesc:ga534f23baf96ee5cdabd99f1619672452"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for timecodes. <a href="#ga534f23baf96ee5cdabd99f1619672452">More...</a><br /></td></tr>
<tr class="separator:ga534f23baf96ee5cdabd99f1619672452"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga46ed47cec1464129b475c2f088721ea0"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga46ed47cec1464129b475c2f088721ea0">gavl_timecode_format_copy</a> (<a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *dst, const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *src)</td></tr>
<tr class="memdesc:ga46ed47cec1464129b475c2f088721ea0"><td class="mdescLeft"> </td><td class="mdescRight">Copy one timecode format to another. <a href="#ga46ed47cec1464129b475c2f088721ea0">More...</a><br /></td></tr>
<tr class="separator:ga46ed47cec1464129b475c2f088721ea0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ff8de60cb7d70e78da25274e4213994"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga5ff8de60cb7d70e78da25274e4213994">gavl_timecode_to_hmsf</a> (<a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc, int *hours, int *minutes, int *seconds, int *frames)</td></tr>
<tr class="memdesc:ga5ff8de60cb7d70e78da25274e4213994"><td class="mdescLeft"> </td><td class="mdescRight">Extract the time part of the timecode. <a href="#ga5ff8de60cb7d70e78da25274e4213994">More...</a><br /></td></tr>
<tr class="separator:ga5ff8de60cb7d70e78da25274e4213994"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf35480216a11bdc61c9451c9ccbd5b32"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gaf35480216a11bdc61c9451c9ccbd5b32">gavl_timecode_to_ymd</a> (<a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc, int *year, int *month, int *day)</td></tr>
<tr class="memdesc:gaf35480216a11bdc61c9451c9ccbd5b32"><td class="mdescLeft"> </td><td class="mdescRight">Extract the date part of the timecode. <a href="#gaf35480216a11bdc61c9451c9ccbd5b32">More...</a><br /></td></tr>
<tr class="separator:gaf35480216a11bdc61c9451c9ccbd5b32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61174a979942cd0abb81a8bc8616e434"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga61174a979942cd0abb81a8bc8616e434">gavl_timecode_from_hmsf</a> (<a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> *tc, int hours, int minutes, int seconds, int frames)</td></tr>
<tr class="memdesc:ga61174a979942cd0abb81a8bc8616e434"><td class="mdescLeft"> </td><td class="mdescRight">Set the time part of the timecode. <a href="#ga61174a979942cd0abb81a8bc8616e434">More...</a><br /></td></tr>
<tr class="separator:ga61174a979942cd0abb81a8bc8616e434"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69fb314b0066db8309028209c2f824e1"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga69fb314b0066db8309028209c2f824e1">gavl_timecode_from_ymd</a> (<a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> *tc, int year, int month, int day)</td></tr>
<tr class="memdesc:ga69fb314b0066db8309028209c2f824e1"><td class="mdescLeft"> </td><td class="mdescRight">Set the date part of the timecode. <a href="#ga69fb314b0066db8309028209c2f824e1">More...</a><br /></td></tr>
<tr class="separator:ga69fb314b0066db8309028209c2f824e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77d037723b25d83edec5440050303da6"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga77d037723b25d83edec5440050303da6">gavl_timecode_to_framecount</a> (const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *tf, <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc)</td></tr>
<tr class="memdesc:ga77d037723b25d83edec5440050303da6"><td class="mdescLeft"> </td><td class="mdescRight">Get the frame count from the timecode. <a href="#ga77d037723b25d83edec5440050303da6">More...</a><br /></td></tr>
<tr class="separator:ga77d037723b25d83edec5440050303da6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4273b9445f199fb2a060dcfcd80a9ba4"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga4273b9445f199fb2a060dcfcd80a9ba4">gavl_timecode_from_framecount</a> (const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *tf, int64_t fc)</td></tr>
<tr class="memdesc:ga4273b9445f199fb2a060dcfcd80a9ba4"><td class="mdescLeft"> </td><td class="mdescRight">Get a timecode from the frame count. <a href="#ga4273b9445f199fb2a060dcfcd80a9ba4">More...</a><br /></td></tr>
<tr class="separator:ga4273b9445f199fb2a060dcfcd80a9ba4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a647e905b904f3998deea6eb4532c25"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga9a647e905b904f3998deea6eb4532c25">gavl_timecode_dump</a> (const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *tf, <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc)</td></tr>
<tr class="memdesc:ga9a647e905b904f3998deea6eb4532c25"><td class="mdescLeft"> </td><td class="mdescRight">Dump a timecode to stderr. <a href="#ga9a647e905b904f3998deea6eb4532c25">More...</a><br /></td></tr>
<tr class="separator:ga9a647e905b904f3998deea6eb4532c25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc6960288725d242c166623f491de9fa"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#gabc6960288725d242c166623f491de9fa">gavl_timecode_prettyprint</a> (const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> *tf, <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc, char str[<a class="el" href="group__timecode.html#gaf71e35da45bfb1b008fa4394c533b34c">GAVL_TIMECODE_STRING_LEN</a>])</td></tr>
<tr class="memdesc:gabc6960288725d242c166623f491de9fa"><td class="mdescLeft"> </td><td class="mdescRight">Print a full timecode into a string. <a href="#gabc6960288725d242c166623f491de9fa">More...</a><br /></td></tr>
<tr class="separator:gabc6960288725d242c166623f491de9fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0bfd79167ca0f9849b82d020f1d3cc75"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timecode.html#ga0bfd79167ca0f9849b82d020f1d3cc75">gavl_timecode_prettyprint_short</a> (<a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> tc, char str[<a class="el" href="group__timecode.html#gabff9793d5841d2ec4f93ee09fc0fe0e4">GAVL_TIMECODE_STRING_LEN_SHORT</a>])</td></tr>
<tr class="memdesc:ga0bfd79167ca0f9849b82d020f1d3cc75"><td class="mdescLeft"> </td><td class="mdescRight">Print a short timecode into a string. <a href="#ga0bfd79167ca0f9849b82d020f1d3cc75">More...</a><br /></td></tr>
<tr class="separator:ga0bfd79167ca0f9849b82d020f1d3cc75"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Timecode definitions. </p>
<p>Timecodes are usually associated with video frames and represent a unique time (e.g. Wall clock time) within the whole footage.</p>
<p>Since 1.1.0 </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga725785acdd94b530c6bdc0017d92d32a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga725785acdd94b530c6bdc0017d92d32a">§ </a></span>GAVL_TIMECODE_SIGN_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_SIGN_MASK   (0x1LL<<62)</td>
</tr>
</table>
</div><div class="memdoc">
<p>If 1, timecode is negative. </p>
</div>
</div>
<a id="gaf7d327b1069bfafdb6f64e3f2eded1e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf7d327b1069bfafdb6f64e3f2eded1e5">§ </a></span>GAVL_TIMECODE_INVALID_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_INVALID_MASK   (0x1LL<<63)</td>
</tr>
</table>
</div><div class="memdoc">
<p>If 1, timecode is invalid. </p>
</div>
</div>
<a id="gadb132f471c755cdf8d479f549ff9b446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb132f471c755cdf8d479f549ff9b446">§ </a></span>GAVL_TIMECODE_DROP_FRAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_DROP_FRAME   (1<<0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>NTSC drop frame is used. </p>
</div>
</div>
<a id="ga1102fb210b8180cdc82c66204845cff2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1102fb210b8180cdc82c66204845cff2">§ </a></span>GAVL_TIMECODE_UNDEFINED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_UNDEFINED   <a class="el" href="group__timecode.html#gaf7d327b1069bfafdb6f64e3f2eded1e5">GAVL_TIMECODE_INVALID_MASK</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience macro. </p>
</div>
</div>
<a id="gaf71e35da45bfb1b008fa4394c533b34c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf71e35da45bfb1b008fa4394c533b34c">§ </a></span>GAVL_TIMECODE_STRING_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_STRING_LEN   26</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length for a string into which a timecode will be printed </p>
</div>
</div>
<a id="gabff9793d5841d2ec4f93ee09fc0fe0e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabff9793d5841d2ec4f93ee09fc0fe0e4">§ </a></span>GAVL_TIMECODE_STRING_LEN_SHORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_TIMECODE_STRING_LEN_SHORT   13</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length for a string into which a short timecode will be printed </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga534f23baf96ee5cdabd99f1619672452"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga534f23baf96ee5cdabd99f1619672452">§ </a></span>gavl_timecode_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint64_t <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for timecodes. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga46ed47cec1464129b475c2f088721ea0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46ed47cec1464129b475c2f088721ea0">§ </a></span>gavl_timecode_format_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_format_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy one timecode format to another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination format </td></tr>
<tr><td class="paramname">src</td><td>Source format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5ff8de60cb7d70e78da25274e4213994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5ff8de60cb7d70e78da25274e4213994">§ </a></span>gavl_timecode_to_hmsf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_to_hmsf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>hours</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>minutes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>seconds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>frames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extract the time part of the timecode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">hours</td><td>If non NULL, returns the hours </td></tr>
<tr><td class="paramname">minutes</td><td>If non NULL, returns the minutes </td></tr>
<tr><td class="paramname">seconds</td><td>If non NULL, returns the seconds </td></tr>
<tr><td class="paramname">frames</td><td>If non NULL, returns the frames </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf35480216a11bdc61c9451c9ccbd5b32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf35480216a11bdc61c9451c9ccbd5b32">§ </a></span>gavl_timecode_to_ymd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_to_ymd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>year</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>month</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>day</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extract the date part of the timecode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">year</td><td>If non NULL, returns the year </td></tr>
<tr><td class="paramname">month</td><td>If non NULL, returns the month </td></tr>
<tr><td class="paramname">day</td><td>If non NULL, returns the day </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga61174a979942cd0abb81a8bc8616e434"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61174a979942cd0abb81a8bc8616e434">§ </a></span>gavl_timecode_from_hmsf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_from_hmsf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> * </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hours</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minutes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>seconds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>frames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the time part of the timecode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">hours</td><td>The hours </td></tr>
<tr><td class="paramname">minutes</td><td>The minutes </td></tr>
<tr><td class="paramname">seconds</td><td>The seconds </td></tr>
<tr><td class="paramname">frames</td><td>The frames </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga69fb314b0066db8309028209c2f824e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga69fb314b0066db8309028209c2f824e1">§ </a></span>gavl_timecode_from_ymd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_from_ymd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> * </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>year</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>month</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>day</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the date part of the timecode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">year</td><td>The year </td></tr>
<tr><td class="paramname">month</td><td>The month </td></tr>
<tr><td class="paramname">day</td><td>The day </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga77d037723b25d83edec5440050303da6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga77d037723b25d83edec5440050303da6">§ </a></span>gavl_timecode_to_framecount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int64_t gavl_timecode_to_framecount </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>tf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the frame count from the timecode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tf</td><td>The timecode format </td></tr>
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The frame count</dd></dl>
<p>If the time is larger than 24 hours, the framecount is calculated from 00:00:00, January 1, 1970 </p>
</div>
</div>
<a id="ga4273b9445f199fb2a060dcfcd80a9ba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4273b9445f199fb2a060dcfcd80a9ba4">§ </a></span>gavl_timecode_from_framecount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> gavl_timecode_from_framecount </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>tf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>fc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a timecode from the frame count. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tf</td><td>The timecode format </td></tr>
<tr><td class="paramname">fc</td><td>The frame count </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The timecode corresponding to the framecount</dd></dl>
<p>If the date fields are non-zero, the framecount is calculated from 00:00:00, January 1, 1970 </p>
</div>
</div>
<a id="ga9a647e905b904f3998deea6eb4532c25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a647e905b904f3998deea6eb4532c25">§ </a></span>gavl_timecode_dump()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_dump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>tf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump a timecode to stderr. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tf</td><td>The timecode format </td></tr>
<tr><td class="paramname">tc</td><td>A timecode</td></tr>
</table>
</dd>
</dl>
<p>This is used mainly for debugging </p>
</div>
</div>
<a id="gabc6960288725d242c166623f491de9fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc6960288725d242c166623f491de9fa">§ </a></span>gavl_timecode_prettyprint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_prettyprint </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__timecode__format__t.html">gavl_timecode_format_t</a> * </td>
<td class="paramname"><em>tf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>str</em>[GAVL_TIMECODE_STRING_LEN] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print a full timecode into a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tf</td><td>The timecode format </td></tr>
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">str</td><td>String where the timecode will be printed</td></tr>
</table>
</dd>
</dl>
<p>This prints the full timecode (including calendar date if available). For real-life applications, you might want to try <a class="el" href="group__timecode.html#ga0bfd79167ca0f9849b82d020f1d3cc75">gavl_timecode_prettyprint_short</a> instead. </p>
</div>
</div>
<a id="ga0bfd79167ca0f9849b82d020f1d3cc75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0bfd79167ca0f9849b82d020f1d3cc75">§ </a></span>gavl_timecode_prettyprint_short()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_timecode_prettyprint_short </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__timecode.html#ga534f23baf96ee5cdabd99f1619672452">gavl_timecode_t</a> </td>
<td class="paramname"><em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>str</em>[GAVL_TIMECODE_STRING_LEN_SHORT] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print a short timecode into a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tc</td><td>A timecode </td></tr>
<tr><td class="paramname">str</td><td>String where the timecode will be printed</td></tr>
</table>
</dd>
</dl>
<p>Since 1.1.1 </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
