Jump to content

PAL timecode calculator UDF


imitto
 Share

Recommended Posts

Hello all!

I use Autoit for a while, already made some automation for a TV station's master control room with it. I made a UDF to easily work with PAL timecode and time with milliseconds, convert, add or subtract them. Feel free to use it if you want something like this :)

#Region ;**** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Res_Description=PAL Timecode Calculator UDF
#AutoIt3Wrapper_Res_LegalCopyright=horvath.imre@gmail.com
#EndRegion ;**** Directives created by AutoIt3Wrapper_GUI ****
;
; #FUNCTION#
; Name...........:  _tcAdd
; Description....:  Returns addition of two timecodes
; Syntax.........:  _tcAdd($fTc1, fTc2 [, $fFormat = "P"])
;
; Parameters.....:  $fTc1               - First timecode in hh:mm:ss.ff format
;                   $fTc2               - Second timecode in hh:mm:ss.ff format
;                   $fFormat            - Time base -   "P" (default): PAL (25 fps)
;                                                       "M" : millisecond
;
; Return value...:  Sum of the two timecode in the selected format

Func _tcAdd($fTc1, $fTc2, $fFormat = "P", $fHourFormat = 1)
    Local $fMs1 = _tcToMs($fTc1)
    Local $fMs2 = _tcToMs($fTc2)
    Local $fSumMs = $fMs1 + $fMs2
    Return _msToTc($fSumMs, $fFormat, $fHourFormat)
EndFunc

; #FUNCTION#
; Name...........:  _tcsSub
; Description....:  Returns addition of two timecodes
; Syntax.........:  _tcSub($fTc1, fTc2 [, $fFormat = "P"])
;
; Parameters.....:  $fTc1               - First timecode in hh:mm:ss.ff format
;                   $fTc2               - Second timecode in hh:mm:ss.ff format
;                   $fFormat            - Time base -   "P" (default): PAL (25 fps)
;                                                       "M" : millisecond
;
; Return value...:  Subtract $fTc2 from $fTc1 in the source format

Func _tcSub($fTc1, $fTc2, $fFormat = "P")
    Local $fMs1 = _tcToMs($fTc1)
    Local $fMs2 = _tcToMs($fTc2)
    Local $fSumMs = $fMs1 - $fMs2
    If $fSumMs < 0 Then
        $fSumMs = _tcToMs("24:00:00.00") - ($fSumMs * -1)
    EndIf
    Return _msToTc($fSumMs, $fFormat)
EndFunc

; #FUNCTION#
; Name...........:  _tcToMs
; Description....:  Returns timecode converted to total milliseconds
; Syntax.........:  _tcToMs($fTc)
;
; Parameters.....:  $fTc                - Timecode in hh:mm:ss.ff or hh:mm:ss:xxx format, where xxx are milliseconds
;
; Return value...:  Milliseconds as an integer value

Func _tcToMs($fTc)
    Local $fTemp = StringSplit($fTc, ":.")
    Local $fChr = StringLen($fTemp[4])
    Switch $fChr
        Case 2
            Return ($fTemp[4] * 40) + ($fTemp[3] * 1000) + ($fTemp[2] * 60000) + ($fTemp[1] * 3600000)
        Case 3
            Return ($fTemp[4]) + ($fTemp[3] * 1000) + ($fTemp[2] * 60000) + ($fTemp[1] * 3600000)
    EndSwitch
EndFunc

; #FUNCTION#
; Name...........:  _msToTc
; Description....:  Converts total milliseconds to timecode
; Syntax.........:  _msToTc($fIn, $fFormat = "P", $fHourFormat = 1)
;
; Parameters.....:  $fIn                - Time in milliseconds
;                   $fFormat            - Output format     "P": PAL TC (default)
;                                                           "M": hh:mm:ss.xxx where xxx are milliseconds
;                   $fHourFormat        - Hour format       "1": max. value is 23, then starts from 0 (default)
;                                                           "0": hours can be more then 23
;
; Return value...:  Timecode as string in the selected format

Func _msToTc($fIn, $fFormat = "P", $fHourFormat = 1)
    Switch $fFormat
        Case "P"
            Local $fFr = StringFormat("%02i",  (StringRight($fIn, 3) - Mod(StringRight($fIn, 3), 40)) / 40)
        Case "M"
            Local $fFr = StringFormat("%03i",  StringRight($fIn, 3))
    EndSwitch
    $fIn = StringTrimRight($fIn, 3)
    Local $fSec = StringFormat("%02i", Mod($fIn, 60))
    $fIn -= $fSec
    Local $fMinTot = $fIn / 60
    Local $fMin = StringFormat("%02i", Mod($fMinTot, 60))
    $fIn -= $fMin*60
    Local $fHourTot = $fIn / 60 / 60
    Switch $fHourFormat
        Case 1
            $fHour = StringFormat("%02i", Mod($fHourTot, 24))
        Case 0
            $fHour = StringFormat("%02i", $fHourTot)
    EndSwitch
    Return($fHour & ":" & $fMin & ":" & $fSec & "." & $fFr)
EndFunc

; #FUNCTION#
; Name...........:  _tcFormatChange
; Description....:  Toggle TC format
; Syntax.........:  _tcFormatChange($fTc)
;
; Parameters.....:  $fTc                - Timecode in hh:mm:ss.ff or hh:mm:ss:xxx format, where xxx are milliseconds
;
; Return value...:  PAL timecode or time with milliseconds as string, depends on input

Func _tcFormatChange($fTc)
    Local $fTemp = StringSplit($fTc, ":.")
    Local $fChr = StringLen($fTemp[4])
    Switch $fChr
        Case 2
            Return $fTemp[1]&":"&$fTemp[2]&":"&$fTemp[3]&"."&StringFormat("%03i", $fTemp[4]*40)
        Case 3
            Return $fTemp[1]&":"&$fTemp[2]&":"&$fTemp[3]&"."&StringFormat("%02i", ($fTemp[4]-Mod($fTemp[4], 40))/40)
    EndSwitch
EndFunc

And the example script:

#include<_PAL_TC_Calc.au3>

$palTC1 = "00:01:12.20"
$palTC2 = "23:59:50.02"
$msTC1 = "00:01:12.800"
$msTC2 = "23:59:50.120"

MsgBox(0, "1", _tcAdd($palTC1, $palTC2));           Adds $palTC1 to $palTC2, turns hour back to 0 after 23, returns PAL TC format
MsgBox(0, "2", _tcAdd($palTC1, $palTC2, "M"));      Adds $palTC1 to $palTC2, turns hour back to 0 after 23, returns time with milliseconds format
MsgBox(0, "3", _tcAdd($palTC1, $palTC2, "M", 0));   Adds $palTC1 to $palTC2, hours can be infinite, returns time with milliseconds format
MsgBox(0, "4", _tcAdd($msTC1, $msTC2));             Adds $palTC1 to $palTC2, turns hour back to 0 after 23, returns PAL TC format
MsgBox(0, "5", _tcAdd($msTC1, $msTC2, "M"));        Adds $palTC1 to $palTC2, turns hour back to 0 after 23, returns time with milliseconds format
MsgBox(0, "6", _tcAdd($msTC1, $msTC2, "M", 0));     Adds $palTC1 to $palTC2, hours can be infinite, returns time with milliseconds format

MsgBox(0, "7", _tcSub($palTC2, $palTC1));           Subtract $palTC1 from $palTC2, returns PAL TC format
MsgBox(0, "8", _tcSub($palTC2, $palTC1, "M"));      Subtract $palTC1 from $palTC2, time with milliseconds format
MsgBox(0, "9", _tcSub($msTC1, $msTC2));             Subtract $palTC1 from $palTC2, returns PAL TC format - when hits zero, counts back from 24:00:00.00
MsgBox(0, "10", _tcSub($msTC1, $msTC2, "M"));       Subtract $palTC1 from $palTC2, time with milliseconds format - when hits zero, counts back from 24:00:00.000

MsgBox(0, "11", _tcFormatChange($palTC2));          Convert PAL TC to time with milliseconds and back
MsgBox(0, "12", _tcFormatChange($msTC2));           Convert PAL TC to time with milliseconds and back

 

TC_CALC_example.au3

_PAL_TC_Calc.au3

Link to comment
Share on other sites

Thanks for posting your UDF.
If you want to make them better start with using this:
 

#Tidy_Parameters=/sort_funcs /reel
#AutoIt3Wrapper_Au3Check_Parameters=-d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w 7

And read about #include directive, as in non standalone Include file it should be used like this:

#include "_PAL_TC_Calc.au3"

 

Signature beginning:
Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Codefor other useful stuff click the following button:

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST APIErrorLog.au3 UDF - A logging Library * Include Dependency Tree (Tool for analyzing script relations) * Show_Macro_Values.au3 *

 

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 UDF * ADO.au3 UDF SMTP Mailer UDF * Dual Monitor resolution detection * * 2GUI on Dual Monitor System * _SciLexer.au3 UDF * SciTE - Lexer for console pane

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Good coding practices in AutoIt * 

OpenOffice/LibreOffice/XLS Related: WriterDemo.au3 * XLS/MDB from scratch with ADOX

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * IE in TaskSchedulerIE Embedded Control Versioning (use IE9+ and HTML5 in a GUI) * PDF Related:How to get reference to PDF object embeded in IE * IE on Windows 11

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

I also encourage you to check awesome @trancexx code:  * Create COM objects from modules without any demand on user to register anything. * Another COM object registering stuffOnHungApp handlerAvoid "AutoIt Error" message box in unknown errors  * HTML editor

winhttp.au3 related : * https://www.autoitscript.com/forum/topic/206771-winhttpau3-download-problem-youre-speaking-plain-http-to-an-ssl-enabled-server-port/

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2023-04-24

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...