|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
<html>
|
|
Packit |
1f69a5 |
<head>
|
|
Packit |
1f69a5 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
1f69a5 |
<title>videobox: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
|
|
Packit |
1f69a5 |
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
Packit |
1f69a5 |
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
|
|
Packit |
1f69a5 |
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
|
|
Packit |
1f69a5 |
<link rel="prev" href="gst-plugins-good-plugins-videobalance.html" title="videobalance">
|
|
Packit |
1f69a5 |
<link rel="next" href="gst-plugins-good-plugins-videocrop.html" title="videocrop">
|
|
Packit |
1f69a5 |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
1f69a5 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
1f69a5 |
</head>
|
|
Packit |
1f69a5 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Top |
|
|
Packit |
1f69a5 |
Description |
|
|
Packit |
1f69a5 |
Object Hierarchy |
|
|
Packit |
1f69a5 |
Properties
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
videobox
|
|
Packit |
1f69a5 |
videobox
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Properties
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gdouble
|
|
Packit |
1f69a5 |
alpha
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gdouble
|
|
Packit |
1f69a5 |
border-alpha
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gint
|
|
Packit |
1f69a5 |
bottom
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
GstVideoBoxFill
|
|
Packit |
1f69a5 |
fill
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gint
|
|
Packit |
1f69a5 |
left
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gint
|
|
Packit |
1f69a5 |
right
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gint
|
|
Packit |
1f69a5 |
top
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
gboolean
|
|
Packit |
1f69a5 |
autocrop
|
|
Packit |
1f69a5 |
Read / Write
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Types and Values
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
struct
|
|
Packit |
1f69a5 |
GstVideoBox
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
enum
|
|
Packit |
1f69a5 |
GstVideoBoxFill
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Object Hierarchy
|
|
Packit |
1f69a5 |
GObject
|
|
Packit |
1f69a5 |
╰── GInitiallyUnowned
|
|
Packit |
1f69a5 |
╰── GstObject
|
|
Packit |
1f69a5 |
╰── GstElement
|
|
Packit |
1f69a5 |
╰── GstBaseTransform
|
|
Packit |
1f69a5 |
╰── GstVideoFilter
|
|
Packit |
1f69a5 |
╰── GstVideoBox
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Description
|
|
Packit |
1f69a5 |
This plugin crops or enlarges the image. It takes 4 values as input, a
|
|
Packit |
1f69a5 |
top, bottom, left and right offset. Positive values will crop that much
|
|
Packit |
1f69a5 |
pixels from the respective border of the image, negative values will add
|
|
Packit |
1f69a5 |
that much pixels. When pixels are added, you can specify their color.
|
|
Packit |
1f69a5 |
Some predefined colors are usable with an enum property.
|
|
Packit |
1f69a5 |
The plugin is alpha channel aware and will try to negotiate with a format
|
|
Packit |
1f69a5 |
that supports alpha channels first. When alpha channel is active two
|
|
Packit |
1f69a5 |
other properties, alpha and border_alpha can be used to set the alpha
|
|
Packit |
1f69a5 |
values of the inner picture and the border respectively. an alpha value of
|
|
Packit |
1f69a5 |
0.0 means total transparency, 1.0 is opaque.
|
|
Packit |
1f69a5 |
The videobox plugin has many uses such as doing a mosaic of pictures,
|
|
Packit |
1f69a5 |
letterboxing video, cutting out pieces of video, picture in picture, etc..
|
|
Packit |
1f69a5 |
Setting autocrop to true changes the behavior of the plugin so that
|
|
Packit |
1f69a5 |
caps determine crop properties rather than the other way around: given
|
|
Packit |
1f69a5 |
input and output dimensions, the crop values are selected so that the
|
|
Packit |
1f69a5 |
smaller frame is effectively centered in the larger frame. This
|
|
Packit |
1f69a5 |
involves either cropping or padding.
|
|
Packit |
1f69a5 |
If you use autocrop there is little point in setting the other
|
|
Packit |
1f69a5 |
properties manually because they will be overriden if the caps change,
|
|
Packit |
1f69a5 |
but nothing stops you from doing so.
|
|
Packit |
1f69a5 |
Sample pipeline:
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
1
|
|
Packit |
1f69a5 |
2
|
|
Packit |
1f69a5 |
gst-launch-1.0 videotestsrc ! videobox autocrop=true ! \
|
|
Packit |
1f69a5 |
"video/x-raw, width=600, height=400" ! videoconvert ! ximagesink
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Synopsis
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Element Information
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
plugin
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
videobox
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
author
|
|
Packit |
1f69a5 |
Wim Taymans <wim@fluendo.com>
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
class
|
|
Packit |
1f69a5 |
Filter/Effect/Video
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Element Pads
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
name
|
|
Packit |
1f69a5 |
sink
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
direction
|
|
Packit |
1f69a5 |
sink
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
presence
|
|
Packit |
1f69a5 |
always
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
details
|
|
Packit |
1f69a5 |
video/x-raw, format=(string){ AYUV, ARGB, BGRA, ABGR, RGBA, xRGB, BGRx, xBGR, RGBx, RGB, BGR, Y444, Y42B, YUY2, YVYU, UYVY, I420, YV12, Y41B, GRAY8, GRAY16_BE, GRAY16_LE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
name
|
|
Packit |
1f69a5 |
src
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
direction
|
|
Packit |
1f69a5 |
source
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
presence
|
|
Packit |
1f69a5 |
always
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
details
|
|
Packit |
1f69a5 |
video/x-raw, format=(string){ AYUV, ARGB, BGRA, ABGR, RGBA, xRGB, BGRx, xBGR, RGBx, RGB, BGR, Y444, Y42B, YUY2, YVYU, UYVY, I420, YV12, Y41B, GRAY8, GRAY16_BE, GRAY16_LE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Functions
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Types and Values
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
struct GstVideoBox
|
|
Packit |
1f69a5 |
struct GstVideoBox;
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
enum GstVideoBoxFill
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Members
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_BLACK
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_GREEN
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_BLUE
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_RED
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_YELLOW
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_WHITE
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
VIDEO_BOX_FILL_LAST
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Property Details
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “alpha” property
|
|
Packit |
1f69a5 |
“alpha” gdouble
|
|
Packit |
1f69a5 |
Alpha value picture.
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Allowed values: [0,1]
|
|
Packit |
1f69a5 |
Default value: 1
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “border-alpha” property
|
|
Packit |
1f69a5 |
“border-alpha” gdouble
|
|
Packit |
1f69a5 |
Alpha value of the border.
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Allowed values: [0,1]
|
|
Packit |
1f69a5 |
Default value: 1
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “bottom” property
|
|
Packit |
1f69a5 |
“bottom” gint
|
|
Packit |
1f69a5 |
Pixels to box at bottom (<0 = add a border).
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: 0
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “fill” property
|
|
Packit |
1f69a5 |
“fill” GstVideoBoxFill
|
|
Packit |
1f69a5 |
How to fill the borders.
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: Black
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “left” property
|
|
Packit |
1f69a5 |
“left” gint
|
|
Packit |
1f69a5 |
Pixels to box at left (<0 = add a border).
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: 0
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “right” property
|
|
Packit |
1f69a5 |
“right” gint
|
|
Packit |
1f69a5 |
Pixels to box at right (<0 = add a border).
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: 0
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “top” property
|
|
Packit |
1f69a5 |
“top” gint
|
|
Packit |
1f69a5 |
Pixels to box at top (<0 = add a border).
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: 0
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
The “autocrop” property
|
|
Packit |
1f69a5 |
“autocrop” gboolean
|
|
Packit |
1f69a5 |
If set to TRUE videobox will automatically crop/pad the input
|
|
Packit |
1f69a5 |
video to be centered in the output.
|
|
Packit |
1f69a5 |
Flags: Read / Write
|
|
Packit |
1f69a5 |
Default value: FALSE
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
See Also
|
|
Packit |
1f69a5 |
GstVideoCrop
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
|
|
Packit |
1f69a5 |
Generated by GTK-Doc V1.27
|
|
Packit |
1f69a5 |
</body>
|
|
Packit |
1f69a5 |
</html>
|