![]() |
![]() |
![]() |
GStreamer Base Plugins 1.0 Library Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <gst/video/video.h> #define GST_VIDEO_FPS_RANGE #define GST_VIDEO_SIZE_RANGE enum GstVideoFormat; gboolean gst_video_calculate_display_ratio (guint *dar_n
,guint *dar_d
,guint video_width
,guint video_height
,guint video_par_n
,guint video_par_d
,guint display_par_n
,guint display_par_d
); guint32 gst_video_format_to_fourcc (GstVideoFormat format
); GstVideoFormat gst_video_format_from_fourcc (guint32 fourcc
); GstBuffer * gst_video_parse_caps_palette (GstCaps *caps
); void (*GstVideoConvertSampleCallback) (GstSample *sample
,GError *error
,gpointer user_data
); GstSample * gst_video_convert_sample (GstSample *sample
,const GstCaps *to_caps
,GstClockTime timeout
,GError **error
); void gst_video_convert_sample_async (GstSample *sample
,const GstCaps *to_caps
,GstClockTime timeout
,GstVideoConvertSampleCallback callback
,gpointer user_data
,GDestroyNotify destroy_notify
); GstEvent * gst_video_event_new_still_frame (gboolean in_still
); gboolean gst_video_event_parse_still_frame (GstEvent *event
,gboolean *in_still
); GstEvent * gst_video_event_new_upstream_force_key_unit (GstClockTime running_time
,gboolean all_headers
,guint count
); GstEvent * gst_video_event_new_downstream_force_key_unit (GstClockTime timestamp
,GstClockTime stream_time
,GstClockTime running_time
,gboolean all_headers
,guint count
); gboolean gst_video_event_is_force_key_unit (GstEvent *event
); gboolean gst_video_event_parse_upstream_force_key_unit (GstEvent *event
,GstClockTime *running_time
,gboolean *all_headers
,guint *count
); gboolean gst_video_event_parse_downstream_force_key_unit (GstEvent *event
,GstClockTime *timestamp
,GstClockTime *stream_time
,GstClockTime *running_time
,gboolean *all_headers
,guint *count
);
This library contains some helper functions and includes the videosink and videofilter base classes.
typedef enum { GST_VIDEO_FORMAT_UNKNOWN, GST_VIDEO_FORMAT_I420, GST_VIDEO_FORMAT_YV12, GST_VIDEO_FORMAT_YUY2, GST_VIDEO_FORMAT_UYVY, GST_VIDEO_FORMAT_AYUV, GST_VIDEO_FORMAT_RGBx, GST_VIDEO_FORMAT_BGRx, GST_VIDEO_FORMAT_xRGB, GST_VIDEO_FORMAT_xBGR, GST_VIDEO_FORMAT_RGBA, GST_VIDEO_FORMAT_BGRA, GST_VIDEO_FORMAT_ARGB, GST_VIDEO_FORMAT_ABGR, GST_VIDEO_FORMAT_RGB, GST_VIDEO_FORMAT_BGR, GST_VIDEO_FORMAT_Y41B, GST_VIDEO_FORMAT_Y42B, GST_VIDEO_FORMAT_YVYU, GST_VIDEO_FORMAT_Y444, GST_VIDEO_FORMAT_v210, GST_VIDEO_FORMAT_v216, GST_VIDEO_FORMAT_NV12, GST_VIDEO_FORMAT_NV21, GST_VIDEO_FORMAT_GRAY8, GST_VIDEO_FORMAT_GRAY16_BE, GST_VIDEO_FORMAT_GRAY16_LE, GST_VIDEO_FORMAT_v308, GST_VIDEO_FORMAT_Y800, GST_VIDEO_FORMAT_Y16, GST_VIDEO_FORMAT_RGB16, GST_VIDEO_FORMAT_BGR16, GST_VIDEO_FORMAT_RGB15, GST_VIDEO_FORMAT_BGR15, GST_VIDEO_FORMAT_UYVP, GST_VIDEO_FORMAT_A420, GST_VIDEO_FORMAT_RGB8_PALETTED, GST_VIDEO_FORMAT_YUV9, GST_VIDEO_FORMAT_YVU9, GST_VIDEO_FORMAT_IYU1, GST_VIDEO_FORMAT_ARGB64, GST_VIDEO_FORMAT_AYUV64, GST_VIDEO_FORMAT_r210 } GstVideoFormat;
Enum value describing the most common video formats.
Unknown or unset video format id | |
planar 4:2:0 YUV | |
planar 4:2:0 YVU (like I420 but UV planes swapped) | |
packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...) | |
packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) | |
packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...) | |
sparse rgb packed into 32 bit, space last | |
sparse reverse rgb packed into 32 bit, space last | |
sparse rgb packed into 32 bit, space first | |
sparse reverse rgb packed into 32 bit, space first | |
rgb with alpha channel last | |
reverse rgb with alpha channel last | |
rgb with alpha channel first | |
reverse rgb with alpha channel first | |
rgb | |
reverse rgb | |
planar 4:1:1 YUV (Since: 0.10.18) | |
planar 4:2:2 YUV (Since: 0.10.18) | |
packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...) (Since: 0.10.23) | |
planar 4:4:4 YUV (Since: 0.10.24) | |
packed 4:2:2 10-bit YUV, complex format (Since: 0.10.24) | |
packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order (Since: 0.10.24) | |
planar 4:2:0 YUV with interleaved UV plane (Since: 0.10.26) | |
planar 4:2:0 YUV with interleaved VU plane (Since: 0.10.26) | |
8-bit grayscale (Since: 0.10.29) | |
16-bit grayscale, most significant byte first (Since: 0.10.29) | |
16-bit grayscale, least significant byte first (Since: 0.10.29) | |
packed 4:4:4 YUV (Since: 0.10.29) | |
same as GST_VIDEO_FORMAT_GRAY8 (Since: 0.10.30) | |
same as GST_VIDEO_FORMAT_GRAY16_LE (Since: 0.10.30) | |
rgb 5-6-5 bits per component (Since: 0.10.30) | |
reverse rgb 5-6-5 bits per component (Since: 0.10.30) | |
rgb 5-5-5 bits per component (Since: 0.10.30) | |
reverse rgb 5-5-5 bits per component (Since: 0.10.30) | |
packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) (Since: 0.10.31) | |
planar 4:4:2:0 AYUV (Since: 0.10.31) | |
8-bit paletted RGB (Since: 0.10.32) | |
planar 4:1:0 YUV (Since: 0.10.32) | |
planar 4:1:0 YUV (like YUV9 but UV planes swapped) (Since: 0.10.32) | |
packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...) (Since: 0.10.32) | |
rgb with alpha channel first, 16 bits per channel (Since: 0.10.33) | |
packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...) (Since: 0.10.33) | |
packed 4:4:4 RGB, 10 bits per channel (Since: 0.10.33) |
gboolean gst_video_calculate_display_ratio (guint *dar_n
,guint *dar_d
,guint video_width
,guint video_height
,guint video_par_n
,guint video_par_d
,guint display_par_n
,guint display_par_d
);
Given the Pixel Aspect Ratio and size of an input video frame, and the pixel aspect ratio of the intended display device, calculates the actual display ratio the video will be rendered with.
|
Numerator of the calculated display_ratio |
|
Denominator of the calculated display_ratio |
|
Width of the video frame in pixels |
|
Height of the video frame in pixels |
|
Numerator of the pixel aspect ratio of the input video. |
|
Denominator of the pixel aspect ratio of the input video. |
|
Numerator of the pixel aspect ratio of the display device |
|
Denominator of the pixel aspect ratio of the display device |
Returns : |
A boolean indicating success and a calculated Display Ratio in the dar_n and dar_d parameters. The return value is FALSE in the case of integer overflow or other error. |
Since 0.10.7
guint32 gst_video_format_to_fourcc (GstVideoFormat format
);
Converts a GstVideoFormat value into the corresponding FOURCC. Only
a few YUV formats have corresponding FOURCC values. If format
has
no corresponding FOURCC value, 0 is returned.
|
a GstVideoFormat video format |
Returns : |
the FOURCC corresponding to format
|
Since 0.10.16
GstVideoFormat gst_video_format_from_fourcc (guint32 fourcc
);
Converts a FOURCC value into the corresponding GstVideoFormat. If the FOURCC cannot be represented by GstVideoFormat, GST_VIDEO_FORMAT_UNKNOWN is returned.
|
a FOURCC value representing raw YUV video |
Returns : |
the GstVideoFormat describing the FOURCC value |
Since 0.10.16
GstBuffer * gst_video_parse_caps_palette (GstCaps *caps
);
Returns the palette data from the caps as a GstBuffer. For GST_VIDEO_FORMAT_RGB8_PALETTED this is containing 256 guint32 values, each containing ARGB colors in native endianness.
Since 0.10.32
void (*GstVideoConvertSampleCallback) (GstSample *sample
,GError *error
,gpointer user_data
);
GstSample * gst_video_convert_sample (GstSample *sample
,const GstCaps *to_caps
,GstClockTime timeout
,GError **error
);
Converts a raw video buffer into the specified output caps.
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
The width, height and pixel-aspect-ratio can also be specified in the output caps.
|
a GstSample |
|
the GstCaps to convert to |
|
the maximum amount of time allowed for the processing. |
|
pointer to a GError. Can be NULL . |
Returns : |
The converted GstSample, or NULL if an error happened (in which case err
will point to the GError). |
Since 0.10.31
void gst_video_convert_sample_async (GstSample *sample
,const GstCaps *to_caps
,GstClockTime timeout
,GstVideoConvertSampleCallback callback
,gpointer user_data
,GDestroyNotify destroy_notify
);
Converts a raw video buffer into the specified output caps.
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
The width, height and pixel-aspect-ratio can also be specified in the output caps.
callback
will be called after conversion, when an error occured or if conversion didn't
finish after timeout
. callback
will always be called from the thread default
GMainContext
, see g_main_context_get_thread_default()
. If GLib before 2.22 is used,
this will always be the global default main context.
destroy_notify
will be called after the callback was called and user_data
is not needed
anymore.
|
a GstSample |
|
the GstCaps to convert to |
|
the maximum amount of time allowed for the processing. |
|
GstVideoConvertSampleCallback that will be called after conversion. |
|
extra data that will be passed to the callback
|
|
GDestroyNotify to be called after user_data is not needed anymore |
Since 0.10.31
GstEvent * gst_video_event_new_still_frame (gboolean in_still
);
Creates a new Still Frame event. If in_still
is TRUE
, then the event
represents the start of a still frame sequence. If it is FALSE
, then
the event ends a still frame sequence.
To parse an event created by gst_video_event_new_still_frame()
use
gst_video_event_parse_still_frame()
.
|
boolean value for the still-frame state of the event. |
Returns : |
The new GstEvent |
Since 0.10.26
gboolean gst_video_event_parse_still_frame (GstEvent *event
,gboolean *in_still
);
Parse a GstEvent, identify if it is a Still Frame event, and return the still-frame state from the event if it is. If the event represents the start of a still frame, the in_still variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the in_still variable order to just check whether the event is a valid still-frame event.
Create a still frame event using gst_video_event_new_still_frame()
|
A GstEvent to parse |
|
A boolean to receive the still-frame status from the event, or NULL |
Returns : |
TRUE if the event is a valid still-frame event. FALSE if not |
Since 0.10.26
GstEvent * gst_video_event_new_upstream_force_key_unit (GstClockTime running_time
,gboolean all_headers
,guint count
);
Creates a new upstream force key unit event. An upstream force key unit event can be sent to request upstream elements to produce a key unit.
running_time
can be set to request a new key unit at a specific
running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a
new key unit as soon as possible.
To parse an event created by gst_video_event_new_downstream_force_key_unit()
use
gst_video_event_parse_downstream_force_key_unit()
.
|
the running_time at which a new key unit should be produced |
|
TRUE to produce headers when starting a new key unit |
|
integer that can be used to number key units |
Returns : |
The new GstEvent |
Since 0.10.36
GstEvent * gst_video_event_new_downstream_force_key_unit (GstClockTime timestamp
,GstClockTime stream_time
,GstClockTime running_time
,gboolean all_headers
,guint count
);
Creates a new downstream force key unit event. A downstream force key unit event can be sent down the pipeline to request downstream elements to produce a key unit. A downstream force key unit event must also be sent when handling an upstream force key unit event to notify downstream that the latter has been handled.
To parse an event created by gst_video_event_new_downstream_force_key_unit()
use
gst_video_event_parse_downstream_force_key_unit()
.
|
the timestamp of the buffer that starts a new key unit |
|
the stream_time of the buffer that starts a new key unit |
|
the running_time of the buffer that starts a new key unit |
|
TRUE to produce headers when starting a new key unit |
|
integer that can be used to number key units |
Returns : |
The new GstEvent |
Since 0.10.36
gboolean gst_video_event_is_force_key_unit (GstEvent *event
);
Checks if an event is a force key unit event. Returns true for both upstream and downstream force key unit events.
Since 0.10.36
gboolean gst_video_event_parse_upstream_force_key_unit (GstEvent *event
,GstClockTime *running_time
,gboolean *all_headers
,guint *count
);
Get running-time, all-headers and count in the force key unit event. See
gst_video_event_new_upstream_force_key_unit()
for a full description of the
upstream force key unit event.
Create an upstream force key unit event using gst_video_event_new_upstream_force_key_unit()
|
A GstEvent to parse |
|
A pointer to the running_time in the event. [out] |
|
A pointer to the all_headers flag in the event. [out] |
|
A pointer to the count field in the event. [out] |
Returns : |
TRUE if the event is a valid upstream force-key-unit event. FALSE if not |
Since 0.10.36
gboolean gst_video_event_parse_downstream_force_key_unit (GstEvent *event
,GstClockTime *timestamp
,GstClockTime *stream_time
,GstClockTime *running_time
,gboolean *all_headers
,guint *count
);
Get timestamp, stream-time, running-time, all-headers and count in the force
key unit event. See gst_video_event_new_downstream_force_key_unit()
for a
full description of the downstream force key unit event.
|
A GstEvent to parse |
|
A pointer to the timestamp in the event. [out] |
|
A pointer to the stream-time in the event. [out] |
|
A pointer to the running-time in the event. [out] |
|
A pointer to the all_headers flag in the event. [out] |
|
A pointer to the count field of the event. [out] |
Returns : |
TRUE if the event is a valid downstream force key unit event. |
Since 0.10.36