![]() |
![]() |
![]() |
GStreamer VA-API Plugins 0.10 Library Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define GST_VAAPI_IMAGE_FORMAT (image) #define GST_VAAPI_IMAGE_WIDTH (image) #define GST_VAAPI_IMAGE_HEIGHT (image) struct GstVaapiImage; struct GstVaapiImageClass; GstVaapiImage * gst_vaapi_image_new (GstVaapiDisplay *display
,GstVaapiImageFormat format
,guint width
,guint height
); GstVaapiImage * gst_vaapi_image_new_with_image (GstVaapiDisplay *display
,VAImage *va_image
); GstVaapiID gst_vaapi_image_get_id (GstVaapiImage *image
); gboolean gst_vaapi_image_get_image (GstVaapiImage *image
,VAImage *va_image
); GstVaapiImageFormat gst_vaapi_image_get_format (GstVaapiImage *image
); guint gst_vaapi_image_get_width (GstVaapiImage *image
); guint gst_vaapi_image_get_height (GstVaapiImage *image
); void gst_vaapi_image_get_size (GstVaapiImage *image
,guint *pwidth
,guint *pheight
); gboolean gst_vaapi_image_is_linear (GstVaapiImage *image
); gboolean gst_vaapi_image_is_mapped (GstVaapiImage *image
); gboolean gst_vaapi_image_map (GstVaapiImage *image
); gboolean gst_vaapi_image_unmap (GstVaapiImage *image
); guint gst_vaapi_image_get_plane_count (GstVaapiImage *image
); guchar * gst_vaapi_image_get_plane (GstVaapiImage *image
,guint plane
); guint gst_vaapi_image_get_pitch (GstVaapiImage *image
,guint plane
); guint gst_vaapi_image_get_data_size (GstVaapiImage *image
); gboolean gst_vaapi_image_get_buffer (GstVaapiImage *image
,GstBuffer *buffer
,GstVaapiRectangle *rect
); gboolean gst_vaapi_image_get_raw (GstVaapiImage *image
,GstVaapiImageRaw *dst_image
,GstVaapiRectangle *rect
); gboolean gst_vaapi_image_update_from_buffer (GstVaapiImage *image
,GstBuffer *buffer
,GstVaapiRectangle *rect
);
"format" guint : Read / Write / Construct Only "height" guint : Read / Write / Construct Only "image" VAImage* : Read / Write / Construct Only "width" guint : Read / Write / Construct Only
#define GST_VAAPI_IMAGE_FORMAT(image) gst_vaapi_image_get_format(image)
Macro that evaluates to the GstVaapiImageFormat of image
.
|
a GstVaapiImage |
#define GST_VAAPI_IMAGE_WIDTH(image) gst_vaapi_image_get_width(image)
Macro that evaluates to the width of image
.
|
a GstVaapiImage |
#define GST_VAAPI_IMAGE_HEIGHT(image) gst_vaapi_image_get_height(image)
Macro that evaluates to the height of image
.
|
a GstVaapiImage |
GstVaapiImage * gst_vaapi_image_new (GstVaapiDisplay *display
,GstVaapiImageFormat format
,guint width
,guint height
);
Creates a new GstVaapiImage with the specified format and dimensions.
|
a GstVaapiDisplay |
|
a GstVaapiImageFormat |
|
the requested image width |
|
the requested image height |
Returns : |
the newly allocated GstVaapiImage object |
GstVaapiImage * gst_vaapi_image_new_with_image (GstVaapiDisplay *display
,VAImage *va_image
);
Creates a new GstVaapiImage from a foreign VA image. The image
format and dimensions will be extracted from va_image
. This
function is mainly used by gst_vaapi_surface_derive_image()
to bind
a VA image to a GstVaapiImage object.
|
a GstVaapiDisplay |
|
a VA image |
Returns : |
the newly allocated GstVaapiImage object |
GstVaapiID gst_vaapi_image_get_id (GstVaapiImage *image
);
Returns the underlying VAImageID of the image
.
|
a GstVaapiImage |
Returns : |
the underlying VA image id |
gboolean gst_vaapi_image_get_image (GstVaapiImage *image
,VAImage *va_image
);
Fills va_image
with the VA image used internally.
|
a GstVaapiImage |
|
a VA image |
Returns : |
TRUE on success |
GstVaapiImageFormat gst_vaapi_image_get_format (GstVaapiImage *image
);
Returns the GstVaapiImageFormat the image
was created with.
|
a GstVaapiImage |
Returns : |
the GstVaapiImageFormat |
guint gst_vaapi_image_get_width (GstVaapiImage *image
);
Returns the image
width.
|
a GstVaapiImage |
Returns : |
the image width, in pixels |
guint gst_vaapi_image_get_height (GstVaapiImage *image
);
Returns the image
height.
|
a GstVaapiImage |
Returns : |
the image height, in pixels. |
void gst_vaapi_image_get_size (GstVaapiImage *image
,guint *pwidth
,guint *pheight
);
Retrieves the dimensions of a GstVaapiImage.
|
a GstVaapiImage |
|
return location for the width, or NULL
|
|
return location for the height, or NULL
|
gboolean gst_vaapi_image_is_linear (GstVaapiImage *image
);
Checks whether the image
has data planes allocated from a single
buffer and offsets into that buffer are in increasing order with
the number of planes.
|
a GstVaapiImage |
Returns : |
TRUE if image data planes are allocated from a single buffer |
gboolean gst_vaapi_image_is_mapped (GstVaapiImage *image
);
Checks whether the image
is currently mapped or not.
|
a GstVaapiImage |
Returns : |
TRUE if the image is mapped |
gboolean gst_vaapi_image_map (GstVaapiImage *image
);
Maps the image data buffer. The actual pixels are returned by the
gst_vaapi_image_get_plane()
function.
|
a GstVaapiImage |
Returns : |
TRUE on success |
gboolean gst_vaapi_image_unmap (GstVaapiImage *image
);
Unmaps the image data buffer. Pointers to pixels returned by
gst_vaapi_image_get_plane()
are then no longer valid.
|
a GstVaapiImage |
Returns : |
TRUE on success |
guint gst_vaapi_image_get_plane_count (GstVaapiImage *image
);
Retrieves the number of planes available in the image
. The image
must be mapped for this function to work properly.
|
a GstVaapiImage |
Returns : |
the number of planes available in the image
|
guchar * gst_vaapi_image_get_plane (GstVaapiImage *image
,guint plane
);
Retrieves the pixels data to the specified plane
. The image
must
be mapped for this function to work properly.
|
a GstVaapiImage |
|
the requested plane number |
Returns : |
the pixels data of the specified plane
|
guint gst_vaapi_image_get_pitch (GstVaapiImage *image
,guint plane
);
Retrieves the line size (stride) of the specified plane
. The
image
must be mapped for this function to work properly.
|
a GstVaapiImage |
|
the requested plane number |
Returns : |
the line size (stride) of the specified plane |
guint gst_vaapi_image_get_data_size (GstVaapiImage *image
);
Retrieves the underlying image data size. This function could be used to determine whether the image has a compatible layout with another image structure.
|
a GstVaapiImage |
Returns : |
the whole image data size of the image
|
gboolean gst_vaapi_image_get_buffer (GstVaapiImage *image
,GstBuffer *buffer
,GstVaapiRectangle *rect
);
Transfers pixels data contained in the image
into the GstBuffer.
Both image structures shall have the same format.
|
a GstVaapiImage |
|
a GstBuffer |
|
a GstVaapiRectangle expressing a region, or NULL for the
whole image |
Returns : |
TRUE on success |
gboolean gst_vaapi_image_get_raw (GstVaapiImage *image
,GstVaapiImageRaw *dst_image
,GstVaapiRectangle *rect
);
Transfers pixels data contained in the image
into the GstVaapiImageRaw.
Both image structures shall have the same format.
|
a GstVaapiImage |
|
a GstVaapiImageRaw |
|
a GstVaapiRectangle expressing a region, or NULL for the
whole image |
Returns : |
TRUE on success |
gboolean gst_vaapi_image_update_from_buffer (GstVaapiImage *image
,GstBuffer *buffer
,GstVaapiRectangle *rect
);
Transfers pixels data contained in the GstBuffer into the
image
. Both image structures shall have the same format.
|
a GstVaapiImage |
|
a GstBuffer |
|
a GstVaapiRectangle expressing a region, or NULL for the
whole image |
Returns : |
TRUE on success |
"format"
property "format" guint : Read / Write / Construct Only
The GstVaapiImageFormat of the image
Default value: 0
"height"
property "height" guint : Read / Write / Construct Only
The image height.
Default value: 0