AddBorders

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
(added template, category and some links)
 
(add link to avs+ documentation)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:FuncDef|AddBorders(clip ''clip'', int ''left'', int ''top'', int ''right'', int ''bottom'' [, int ''color''])}}
+
<div {{BlueBox2|40|0|3px solid purple}} >
 +
{{AvsPlusFullname}}<br>
 +
Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/addborders.html https://avisynthplus.readthedocs.io]
 +
</div>
  
AddBorders adds black (or specified color) borders around the image, with the specified widths (in pixels). [[YV12]]/[[YUY2]] format only stores color information for every two pixels horizontally, so if you're processing in YV12/YUY2 mode, left and right must be even.
 
  
The color parameter is optional (added in v2.07), default=0 <black>, and is specified as an [[RGB]] value regardless of whether the clip format is RGB or [[YUV]] based. Color presets can be found here: [[color presets]]. See [[Colors]] for more information on specifying colors.
+
Add black or colored borders, increasing frame size. This has several common uses:
 +
* Adjust the [[Aspect_ratios|aspect ratio]] (make a 4:3 clip into 16:9 without stretching)
 +
* [[Splice]] a smaller resolution clip to a larger one without resizing
 +
* Together with [[Crop]], shift a clip horizontally or vertically &ndash; see below.
 +
See also: [[Letterbox]], which adds borders without changing frame size.
  
Be aware that many lossy compression algorithms don't deal well with solid-color borders, unless the border width happens to be a multiple of the block size (16 pixels for MPEG).
 
  
You can use this filter in combination with [[Crop]] to shift an image around without changing the frame size. For example:
+
== Syntax and Parameters ==
 +
{{FuncDef
 +
|AddBorders( clip ''clip'', int ''left'', int ''top'', int ''right'', int ''bottom'' [, int ''color'' ] [, int ''color_yuv'' {{AvsPluscon}}])
 +
}}
  
  # Shift a 352x240 image 2 pixels to the right
+
:{{Par2|left, top, right, bottom|int|(required)}}
  Crop(0, 0, 350, 240)
+
::Border width in pixels.
 +
::*For [[YUY2]] and [[YV16]] sources, {{FuncArg|left}} and {{FuncArg|right}} must be [[Modulo|mod2]] (divisible by 2).
 +
::*For [[YV411]] sources, {{FuncArg|left}} and {{FuncArg|right}} must be [[Modulo|mod4]] (divisible by 4).
 +
::*For [[YV12]] sources, all four border widths must be mod2.
 +
 
 +
:{{Par2|color|int|(black)}}
 +
::Border color; specified as an RGB value. See [[Colors|this page]] for more information on specifying colors.
 +
::*For YUV clips, colors are converted from full-range (0&ndash;255) to tv-range (16&ndash;235).
 +
 
 +
:{{Par2|color_yuv|int|}} {{AvsPluscon}}
 +
::Specifies the color of the border using YUV values. It requires setting pixel_type to one of the YUV formats; otherwise it doesn't do anything.
 +
::Similar to {{FuncArg|color_yuv}} in BlankClip
 +
 
 +
== Examples and Notes ==
 +
<div style="max-width:54em" >
 +
* Add ''letterbox'' (top and bottom) borders:
 +
<div {{BoxWidthIndent|42|2}} >
 +
  ## add dark blue borders, using [[Colors|hex color notation]]
 +
AddBorders(0, 86, 0, 86, $00008B)
 +
 +
## same as above, using [[Preset_colors|named preset color]]
 +
AddBorders(0, 86, 0, 86, color_darkblue)
 +
 +
## full scale black border using color_yuv [[Colors|hex color notation]]
 +
AddBorders(0, 86, 0, 86, color_yuv = $008080)
 +
 
 +
</div>
 +
 
 +
* Be aware that many older lossy compression algorithms don't deal well with solid-color borders, unless the border happens to fall on a [[Wikipedia:Macroblock|macroblock]] boundary (16 pixels for MPEG).
 +
 
 +
* Use '''AddBorders''' in combination with [[Crop]] to ''shift'' an image without changing the frame size:
 +
<div {{BoxWidthIndent|36|2}} >
 +
# Shift an image 2 pixels to the right
 +
  Crop(0, 0, Width-2, Height)
 
  AddBorders(2, 0, 0, 0)
 
  AddBorders(2, 0, 0, 0)
 +
</div>
 +
: Note, shifting this way must be done in 1- or 2-pixel increments, depending on color format.
 +
: You can shift in ''sub''-pixel increments with [[Resize#General_information|Resize]].
 +
</div>
  
# Add letterbox borders that are Black making a 720x308 image 720x480
 
# For YUV colorspace it will be correct (for CCIR-601) color (luma=16)
 
AddBorders(0, 86, 0, 86, $000000)
 
  
 
[[Category:Internal filters]]
 
[[Category:Internal filters]]
 +
[[Category:Borders_and_Cropping]]

Latest revision as of 04:33, 18 September 2022

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


Add black or colored borders, increasing frame size. This has several common uses:

  • Adjust the aspect ratio (make a 4:3 clip into 16:9 without stretching)
  • Splice a smaller resolution clip to a larger one without resizing
  • Together with Crop, shift a clip horizontally or vertically – see below.

See also: Letterbox, which adds borders without changing frame size.


[edit] Syntax and Parameters

AddBorders( clip clip, int left, int top, int right, int bottom [, int color ] [, int color_yuv AVS+])

int  left, top, right, bottom = (required)
Border width in pixels.
  • For YUY2 and YV16 sources, left and right must be mod2 (divisible by 2).
  • For YV411 sources, left and right must be mod4 (divisible by 4).
  • For YV12 sources, all four border widths must be mod2.
int  color = (black)
Border color; specified as an RGB value. See this page for more information on specifying colors.
  • For YUV clips, colors are converted from full-range (0–255) to tv-range (16–235).
int  color_yuv =
AVS+
Specifies the color of the border using YUV values. It requires setting pixel_type to one of the YUV formats; otherwise it doesn't do anything.
Similar to color_yuv in BlankClip

[edit] Examples and Notes

  • Add letterbox (top and bottom) borders:
## add dark blue borders, using hex color notation
AddBorders(0, 86, 0, 86, $00008B) 

## same as above, using named preset color
AddBorders(0, 86, 0, 86, color_darkblue) 

## full scale black border using color_yuv hex color notation
AddBorders(0, 86, 0, 86, color_yuv = $008080) 
  • Be aware that many older lossy compression algorithms don't deal well with solid-color borders, unless the border happens to fall on a macroblock boundary (16 pixels for MPEG).
  • Use AddBorders in combination with Crop to shift an image without changing the frame size:
# Shift an image 2 pixels to the right
Crop(0, 0, Width-2, Height)
AddBorders(2, 0, 0, 0)
Note, shifting this way must be done in 1- or 2-pixel increments, depending on color format.
You can shift in sub-pixel increments with Resize.
Personal tools