ShowFrameNumber

AviSynth+
Up-to-date documentation: https://avisynthplus.readthedocs.io

Show frame number or time on the screen.

ShowFrameNumber

ShowFrameNumber(clip clip [, bool scroll, int offset, float x, float y,
string font, int size, int text_color, int halo_color, float font_width, float font_angle ] )

Draws text on every frame indicating what frame number AviSynth sees at that point in the script. This is sometimes useful when writing scripts. If you apply additional filters to the clip, they will treat the text on the frame just as they would treat an image, so the numbers may be distorted by the time you see them. Sometimes this is what you want, as it shows frame blending etc.

The frame numbers will be drawn on the left side of the clip for frame-based, top field first material; on the right side for frame-based, bottom field first material and alternating on the left side and right for field-based material, depending whether the field is top or bottom. Much more on the topic of interlaced video on this page: Interlaced Fieldbased.

Due to antialiased text rendering, this filter can be a little slow.

Parameters

clip clip =

Source clip.

bool scroll = false

If true, the frame number will be drawn only once on the video and scroll from top to bottom;

If false, it will be drawn on one side, stacked vertically as often as it fits. Default is false.

int offset = 0

Sets the starting frame number.

float x,y = 0.0

Text position. Their interpretation corresponds to Subtitle's align=4 and the special meaning of -1 is not available.

Note that x and y must be used together or not at all; if they are present, the scroll option is ignored.

string font = "Arial"

Font name. All installed fonts on the current machine are available. Default "Arial"

int size = 24

Height of the text in pixels. Default 24.

int text_color = color_yellow

int halo_color = color_black

Colors for font fill and outline respectively. Default yellow, black.

int font_width = 0

Set character width in logical units, to the nearest 0.125 unit. See Subtitle for an example. Default=0, use Windows' default width.

float font_angle = 0.0

Adjust the baseline angle of text in degrees anti-clockwise to the nearest 0.1 degree. Default 0, no rotation.

Examples

Default appearance if source is frame-based:

generated by the following script:

FFmpegSource2("sintel.mp4")
ShowFrameNumber

Draw the frame numbers in red, scrolling from top to bottom, starting with "00009":

# this is always top field first, therefore numbers will be on the left
Mpeg2Source("clip.d2v") 
ShowFrameNumber(scroll=true, offset=9, text_color=$ff0000)

ShowSMPTE

ShowSMPTE(clip clip [, float fps, string offset, int offset_f, float x, float y,
string font, int size, int text_color, int halo_color, float font_width, float font_angle ] )

Displays SMPTE-style timecode labels for the current frame. Format is HH:MM:SS:FF (for example "03:52:39:24" = 3 hours, 52 minutes, 39 seconds and 24 frames).

Frame 0 is marked "00:00:00:00", frame 1 is marked "00:00:00:01" and so on – unless an offset is applied.

Due to antialiased text rendering, this filter can be a little slow.

Note:
With certain exceptions, SMPTE timecode has no concept of fractional frame rates (like 24.5 fps for example).

ShowSMPTE source clips must have an integer framerate (18, 24, 25, 30, 31,...) or a drop-frame rate ('29.97' being the most common). Supported drop-frame rates are listed in the table below. If that's not the case an error will be thrown.

If the framerate is not integral or drop-frame (let's call it "nonstandard" for short), use ShowFrameNumber or ShowTime instead.

You may encounter media sources that are almost at a standard framerate, but not quite – perhaps due to an error in processing at some point, or perhaps the source was something like a security camera or a video game console. In this case you should force the clip to the nearest standard framerate with AssumeFPS.

Parameters

clip clip =

Source clip. See boxed note above.

float fps = (clip.Framerate)

Not required, unless the current fps can't be used.^{[clarification needed]}

If used, fps must be either an integer or a standard drop-frame rate as listed in the table below.

string offset =

Sets the start time. Format is HH:MM:SS:FF (for example "03:52:39:24" - 3 hours, 52 minutes, 39 seconds and 24 frames).

int offset_f = 0

Sets the starting frame number; ignored if offset is supplied.

float x, y = 0.0

Text position. Their interpretation corresponds to Subtitle's align=2.

string font = "Arial"

Font name. All installed fonts on the current machine are available. Default "Arial"

int size = 24

Height of the text in pixels. Default 24.

int text_color = color_yellow

int halo_color = color_black

Colors for font fill and outline respectively. Default yellow, black.

int font_width = 0

Set character width in logical units, to the nearest 0.125 unit. See Subtitle for an example. Default 0.

float font_angle = 0.0

Adjust the baseline angle of text in degrees anti-clockwise to the nearest 0.1 degree. Default 0, no rotation.

Drop-Frame versus Non-Drop-Frame Time Code

When television began, it was black-and-white only. At that time NTSC ("American" standard) television ran at 30 frames per second (60 fields per second). When the television engineers added color, they slowed the frame rate by the precise ratio 1000/1001, due to technical reasons. NTSC televisions now run at 30×1000/1001 or approximately 29.97002997 frames per second. This is commonly called "29.97 fps." 29.97 is the nominal framerate, a convenient shortcut term for 30×1000/1001.

This slight slowing of the framerate complicates the display of timecode. A second of time no longer consists of a whole number of frames. If the timecode readout simply advanced the seconds counter every 30 frames, the timecode reading would be slower than clock time by about 3.6 seconds per hour. Timecode displays cannot show "fractional" frames (their whole purpose is to uniquely identify every frame) so they drop the display of just enough frame numbers to make the displayed timecode correspond to real or clock time. This is done in a prescribed and repeatable fashion: the first two frame numbers of every minute, except for the tenth minute, are dropped, ie

00:00:00:00, 00:00:00:01, 00:00:00:02, ..., 
00:00:59:29, 00:01:00:02, 00:01:00:03, 
00:01:59:29, 00:02:00:02, 00:02:00:03, ..., 
00:08:59:29, 00:09:00:02, 00:09:00:03, ..., 
00:09:59:29, 00:10:00:00, 00:10:00:01, etc

ShowSMPTE automatically assumes drop-frame timecode given certain input framerate ranges, as listed in the table below. For example, if the input framerate is > 29.969 and < 29.971 fps, the framerate is assumed to be 30×1000/1001 for time calculation, and drop-frame counting is used.

input fps (bounds excluded)	assumed rate	nominal rate
23.975 – 23.977	24×1000/1001	23.98
29.969 – 29.971	30×1000/1001	29.97
47.951 – 47.953	48×1000/1001	47.95
59.939 – 59.941	60×1000/1001	59.94
119.879 - 119.881	120×1000/1001	119.88

You may encounter the term "NDF" - this means "non-drop-frame." As you would expect, this is used for all the integer framerates. Sometimes though, video running at drop-frame rates will have NDF timecode. This is most common for short-form videos of a few minutes' duration at most: some video professionals prefer not to skip frame numbers at all, even though the time display will be off slightly. To get ShowSMPTE to show NDF timecode at drop-frame rates, see the example below.

Examples

Default appearance:

generated by the following script:

FFmpegSource2("sintel.mp4")
ShowSMPTE

Change the position:

fontheight=32

##bottom center
ShowSMPTE(size=fontheight)

##top center
ShowSMPTE(size=fontheight, y=(fontheight))

##top left
ShowSMPTE(size=fontheight, x=(fontheight*3), y=(fontheight))

##top right
ShowSMPTE(size=fontheight, x=(Width-fontheight*3), y=(fontheight))

Showing non-drop-frame timecode at drop-frame rates:

ColorBars                 ## (framerate = 29.97)
ShowSMPTE(size=24, y=24)  ## timecode (top of screen) is DF (drop-frame)
C=Last
AssumeFPS(30)             ## force integer framerate
ShowSMPTE                 ## timecode (bottom of screen) is NDF 
AssumeFPS(C)              ## fps returned to original
return Last           

## DF (top) skips frame numbers at frames 1800, 3598, 106094...
## NDF (bottom) does not skip numbers but runs slower than real time
##  (frame 106094 = DF "00:59:00:02" == NDF "00:58:56:14")

Using offset, x, y, font, size, and text_color arguments:

ShowSMPTE(offset="00:00:59:29", x=360, y=576, font="georgia", size=24, text_color=$ff0000)

ShowTime

ShowTime(clip clip [int offset_f, float x, float y,
string font, int size, int text_color, int halo_color, float font_width, float font_angle ] )

Displays time for the current frame. Format is HH:MM:SS.DDD (for example "03:52:39.800" = 3 hours, 52 minutes, 39 seconds and 800 milliseconds).

Due to antialiased text rendering, this filter can be a little slow.

Parameters

clip clip =

Source clip.

int offset_f = 0

Sets the starting frame number. Displayed time will be increased by offset_f/clip.FrameRate seconds.

int x, y = 0

Text position. Their interpretation corresponds to Subtitle's align=2.

string font = "Arial"

Font name. All installed fonts on the current machine are available. Default "Arial"

int size = 24

Height of the text in pixels. Default 24.

int text_color = color_yellow

int halo_color = color_black

Colors for font fill and outline respectively. Default yellow, black.

int font_width = 0

Set character width in logical units, to the nearest 0.125 unit. See Subtitle for an example. Default 0.

float font_angle = 0.0

Adjust the baseline angle of text in degrees anti-clockwise to the nearest 0.1 degree. Default 0, no rotation.

Examples

Default appearance:

generated by the following script:

FFmpegSource2("sintel.mp4")
ShowTime

Changes

v2.60	All functions: position (x,y) can be float (previously int) (with 0.125 pixel granularity). ShowSMPTE: added drop-frame for other framerates (other than 30).
v2.58	Added ShowTime. Added font_width and font_angle.
v2.56	Added offset and other options.
v2.53	ShowSMPTE: fps argument is made optional (and taken from the clip by default).

ShowFrameNumber

Contents