Differences

This shows you the differences between two versions of the page.

--- variables:inbuilt_variables [2021/02/10 11:13] – [5.FFAStrans Variables] emcodem
+++ variables:inbuilt_variables [2024/03/20 21:20] (current) – emcodem
@@ Line 40: / Line 40: @@
 Media properties are derived from the original input file. Different types of media can contain different kind of properties
-=== Video | Audio Variables ===
+=== Video And Audio Variables ===
 {{:variables:oeil.jpg?nolink&50 |}}{{ :variables:oreille.jpg?nolink&50 |}}
-Video Variables<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>Audio Variables
 |< 100% 17% 33%>|
@@ Line 51: / Line 51: @@
 |**%s_pixel_format%**|Pixel format of first video stream (yuv422p).|**%i_a_channels%**|Total number of audio channels (2).|
 |**%f_frame_rate%**|Frames per second (29.97).|**%i_a_sample_rate%**|Audio sample rate of first audio stream(48000).|
+|**%s_frame_rate%**|Frames per second represented as num/den (30000/1001).|**%s_dbe_layout%**|Json formatted audio layout including Dolby E after full decode.|
 |**%s_v_codec%**|Codec of first video stream (mpeg2video).|**%s_a_codec%**|Codec of first audio stream (pcm_s16le).|
-|**%s_v_profile%**|The profile of the first video stream.|**%s_a_profile%**|The profile of the first audio stream.|
+|**%s_v_profile%**|The profile of the first video stream.|**%s_a_codec_long%**|Long codec name of first audio stream (Advanced Audio Codec).|
 |**%i_v_first%**|Stream number of the first video stream.|**%i_a_first%**|Stream number of the first audio stream.|
-|**%s_pix_aspect%**|Pixel aspect of the first video stream (16:9).|**%i_tot_channels%**|The total number of audio channels.|
+|**%s_pix_aspect%**|Pixel aspect of the first video stream (1:1).|**%i_tot_channels%**|The total number of audio channels.|
 |**%f_duration%**|Media length in seconds (137.48).|**%f_duration%**|Media length in seconds (137.48).|
 |**%i_interlace%**|Field domination(0=Progressive, 1=Upper, 2=Lower (1)).|**%s_a_layout%**|Return audio layout as array. First instance is number of channels in first audio stream, etc.|
 |**%s_date_created%**|Creation date of media (2015-15-11 21:16:33).|**%s_date_created%**|Creation date of media (2015-15-11 21:16:33).|
+|**%i_v_bit_depth%**|Bit depth of first video stream (10).|**%s_a_profile%**|The profile of the first audio stream.|
+|**%i_dheight**|Display height of the codec video.|**%i_has_cover**|Return 1 if audio file has cover image.|
+|**%i_dwidth**|Display width of the codec video.|**%i_has_dolbye**|Checks if source media has Dolby E content.|
 {{:variables:oeil.jpg?nolink&50 |}}\\
-Video Variables\\
+Video Variables Only\\
 |< 100% 50% 50%>|
@@ Line 67: / Line 71: @@
 |**%i_width%**|Media video width of first video stream (1920).|
 |**%s_v_codec_long%**|Long codec name of first video stream (Windows Media Video 2).|
-|**%s_disp_aspect%**|Display aspect of the first video stream (1:1).|
+|**%s_disp_aspect%**|Display aspect of the first video stream (16:9).|
+|**%s_chroma_loc%**|Location of the first chroma sample (Upper left).|
 |**%s_color_space%**|Color space of the first video.|
 |**%s_color_trans%**|Color transfer of the first video.|
@@ Line 73: / Line 78: @@
 |**%s_color_range%**|Color range of the first video.|
 |**%i_intra%**|Checks if media is intra frame based. Return 1 if true, 0 otherwise.|
+|**%i_gamma%**|Gamma curve applied during encoding (Slog3).|
 |**%i_rotation%**|Find the rotation/orientation of the source media.|
 |**%s_duration_tc%**|Media duration as time code (00:05:10:12).|
@@ Line 82: / Line 88: @@
 |**%i_stc_ff%**|Start frame from TC.|
 |**%s_start_tc%**|Start TC of Media (01:13:48:20).|
+|**%s_start_tc_alt%**|Alternative start TC based on creation time. NOT frame accurate.|
+|**%f_pix_aspect%**|The calculated aspect from denum/num (1.4222).|
+|**%f_v_tbase%**|The time base of the source video returned as float.|
+|**%i_xoffset%**|Start position of display width.|
+|**%i_yoffset%**|Start position of display height.|
+|**%i_v_precharge%**|Return number of pre-charge frames if available.|
+**%s_last_enc_cmd%**
+The latest calculated
 Metadata Variables
@@ Line 114: / Line 128: @@
 |**%s_original_name%**|Original filename without extension and path.|
 |**%s_original_path%**|Path of original file.|
-|**%s_original_folder%**|Path of original without drive or UNC.|
 |**%s_original_path~n%**|Folder name n-steps backwards.|
+|**%s_original_folder%**|Path of original without drive or UNC.|
 |**%i_original_size%**|File size of original in bytes.|
 |**%s_original_date%**|Creation date of original file (YYYY-MM-DD_hh-mm-ss).|
@@ Line 124: / Line 138: @@
 |**%i_original_min%**|Creation minute of original file.|
 |**%i_original_sec%**|Creation second of original file.|
+|**%s_original_root%**|Valid drive or UNC server path of the original file.|
 |**%s_original_drive%**|Drive or UNC server of the original file.|
 |**%s_recursed_path%**|Path of original without drive/UNC, monitored path and filename.|
@@ Line 131: / Line 146: @@
-***Note** : %%The %s_pickup_file% is ALWAYS the file that's being picked up by monitors, hence its name. But, this might be just a link to another file. Consider the case of for example a "c:\shortcut.lnk" file. This file just point to another file, say "\\server\share\cool.mp4"%%
+<note> : %%The %s_pickup_file% is ALWAYS the file that's being picked up by monitors, hence its name. But, this might be just a link to another file. Consider the case of for example a "c:\shortcut.lnk" file. This file just point to another file, say "\\server\share\cool.mp4"%%</note>
 This gives us the following different contents of the two variables:\\
@@ Line 161: / Line 176: @@
 |< 100% 15% 75% >|
+|**%i_gmt_bias%**|Returns the local GMT bias (-1).|
 |**%i_year%**|Full year (2020).|
 |**%i_yr%**|Short year (20).|
@@ Line 188: / Line 204: @@
 |**%s_job_id%**|GUID identifier for the current job (20160219-202314-181-4693BFCC0A72).|
 |**%s_job_work%**|Work folder for the current job (D:\_ffas_workroot\2015052120481\20160219-202314-181-4693BFCC0A72).|
+|**%i_job_priority%**|Priority of the current running job.|
 |**%s_wf_id%**|Identifier for the current workflow (20150521204819).|
 |**%s_wf_name%**|Name of the current workflow (Untitled).|
+|**%s_wf_folder%**|Folder name of the current workflow.|
+|**%s_split_id%**|Split/branch id of the current running job.|
 |**%s_node_name%**|Name of the current working processor node (XDCAM-HD).|
 |[[variables:Inbuilt_variables#special_variables|%s_source%]] |Full path to the file work file passed by FFAStrans processors. 4'th level source. Any file set as current input/output source for processors'|
@@ Line 200: / Line 219: @@
 |**%s_cache_record%**|Full path to the cache history record file created by the monitors.|
 |**%s_source_dir%**|Path to the files passed by some FFAStrans processors.|
+|**%s_version%**|Version of the current running FFAStrans.|
+|**%s_last_error%**|Retrieve last viable error message.|
 ----
 ===== Special Variables  =====
-**%s_source%** is the most important variable in FFAStrans. It does represent the current "input file" for any processor.
+There is currently one variable that behave a bit different than others:
-{{gallery>:variables:source_tutorial.png?500x500&1200X1200&lightbox}}
+**%s_original_path~n%** = Folder name n-steps backwards. (This variable supports minus notation for retrieving path names from the right side.)
-__Operations with %s_source%:__
+{{variables:ffastrans_original_path_v2.png?nolink&800|}}
-  * You can use a Populate Variables Processor to change %s_source% to another file if you need to
-    * Typical example: the workflow starts with a .txt file instead of a media file, it calculates the path to the media file and then sets %s_source% to the calculated value
-  * Whenever the value of s_source is changed, FFAStrans will execute the analysis (mediainfo/ffprobe/exiftool) internally and update all Media related variables
-  * If you change %s_source% to a non-media file (or any other value), all the Media Variables will be empty/invalid
-  * Setting %s_source% to "" (nothing) will cause the current branch/job to end and dissapear from the status monitor - the job is not just dispelled but deleted from history
+**%s_source%** represent the input file for any processor. It can be altered using the "Populate variables"-node.
-**%s_success%** represents the "success message" in the Job Status Monitor upon Job completion. It can be altered using the "Populate variables"-node. Workflow developers often use this method to investigate the current value of a variable.
+{{:variables:source_tutorial_m1.png?nolink&1200|}}
-__Operations with %s_success%:__
+**%s_success%** represent the success message upon job completion. It can be altered using the "Populate variables"-node.\\
 In this example, the objective is to ensure that the input file has a video stream to perform the H264 encoding. Otherwise a message in the status monitor and in Webinterface's jobs list will appear. In this particular workflow, each branch leads to a success(but "no video" node isn't one for the user). The trick is to turn that success into "error" for user. Don't forget to use "//execute on success//"(conditional "TRUE") to continue to H264 node OR "//execute on error//"(conditional "FALSE") to continue to another node.\\
 You just have to finish your branch by populated the %s_success% variable to a message of your choice e.g: "error" or "failed" or for the example "No video in input file".
-{{gallery>:variables:success_variable.png?500x500&1200X1200&lightbox}}
+{{:variables:success_variable.png?nolink&800|}}
+**%s_options%** (since FFAStrans 1.4) advanced users can force special behaviour.
-**%s_original_path~n%** = Folder name n-steps backwards.
+Mostly used by advanced users to change the encoding commands of internal encode processors to specific needs.
+You can enable/disable options by setting %s_options% to some value using a populate vars processor. Setting one a single option will not change possible existing options.
-{{:variables:original_path.jpg?nolink&600|}}
+Note that **skip_encoding=True|save_enc_cmd=True** can be used to "not encode" but just calculate some encoding command string which you can change to your needs.
+^ Heading 1      ^ Heading 2      ^
+|skip_encoding	|Option to skip encoding in encoding nodes - used to retrieve the calculated encoding cmd in combination with save_enc_cmd|
+|proc_execute	|Don't execute procs when false|
+|save_enc_cmd	|Option to save ffmpeg processing and filter chains to variables|
+|allow_text_source	|Option to turn the string in s_source into a text file|
+|end_branch	|Option to end the current branch even if there are subsequent nodes|
+|dispel_branch	|Option to end the current branch even if there are subsequent nodes and hide from history|
+|emulate_crash	|none,mem,bounds,var,obj,halt,recurse,stress, null, Option to emulate node crash. For testing purpose only!|
+|allow_afuncs	|Allow using native AutoIT functions in the populate and conditional node.|
+|encode_errors	|Stop and error on known encoding andomalies resulting in a complete but incompatible file.|
+|afilters	|Add extra ffmpeg audio filters at the end of filter chain per stream.|
+|apre_filters	|Add extra ffmpeg audio filters at the start of filter chain per stream.|
+|apost_filters	|Add extra ffmpeg audio filters at the end of filter chain per stream.|
+|vfilters	|Add extra ffmpeg video filters at the end of filter chain.|
+|vpre_filters	 |Add extra ffmpeg video filters at the start of filter chain.|
+|vpost_filters	|Add extra ffmpeg video filters at the end of filter chain.|
+|enc_pre_input	|Add extra ffmpeg arguments before input specifier.|
+|enc_pre_output	|Add extra ffmpeg arguments before output specifier.|
+**%s_last_enc_cmd%**
+Read only variable for retrieving the latest internally ffmpeg encoding command (after some encode processor)
 -----
@@ Line 272: / Line 317: @@
+ <note> : Each time you create or modify a user variable, an archive file is created. You can retrieve the history of your variables from the folder : \\
+ %FFAStrans install directory%\Processors\db\configs\archive\user_variables</note>
 __**Static User Variable**__ : This is another kind of variable. Unlike other variables, static variables are always written with upper case.Creating statics are very handy for example representing a very long path in a short static.\\