gstreamer/gst-libs/gst/vaapi/gstvaapidisplay.h

301 lines
9.5 KiB
C

/*
* gstvaapidisplay.h - VA display abstraction
*
* Copyright (C) 2010-2011 Splitted-Desktop Systems
* Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
* Copyright (C) 2011-2013 Intel Corporation
* Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
#ifndef GST_VAAPI_DISPLAY_H
#define GST_VAAPI_DISPLAY_H
#include <va/va.h>
#include <gst/gst.h>
#include <gst/vaapi/gstvaapitypes.h>
#include <gst/vaapi/gstvaapiprofile.h>
#include <gst/vaapi/video-format.h>
G_BEGIN_DECLS
#define GST_TYPE_VAAPI_DISPLAY (gst_vaapi_display_get_type ())
#define GST_VAAPI_DISPLAY(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VAAPI_DISPLAY, GstVaapiDisplay))
#define GST_VAAPI_IS_DISPLAY(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VAAPI_DISPLAY))
/**
* GST_VAAPI_DISPLAY_GET_CLASS_TYPE:
* @display: a #GstVaapiDisplay
*
* Returns the #display class type
*/
#define GST_VAAPI_DISPLAY_GET_CLASS_TYPE(display) \
gst_vaapi_display_get_class_type (GST_VAAPI_DISPLAY (display))
/**
* GST_VAAPI_DISPLAY_VADISPLAY_TYPE:
* @display: a #GstVaapiDisplay
*
* Returns the underlying VADisplay @display type.
*/
#define GST_VAAPI_DISPLAY_VADISPLAY_TYPE(display) \
gst_vaapi_display_get_display_type (GST_VAAPI_DISPLAY (display))
/**
* GST_VAAPI_DISPLAY_VADISPLAY:
* @display_: a #GstVaapiDisplay
*
* Macro that evaluates to the #VADisplay of @display.
*/
#define GST_VAAPI_DISPLAY_VADISPLAY(display) \
gst_vaapi_display_get_display (GST_VAAPI_DISPLAY (display))
/**
* GST_VAAPI_DISPLAY_LOCK:
* @display: a #GstVaapiDisplay
*
* Locks @display
*/
#define GST_VAAPI_DISPLAY_LOCK(display) \
gst_vaapi_display_lock (GST_VAAPI_DISPLAY (display))
/**
* GST_VAAPI_DISPLAY_UNLOCK:
* @display: a #GstVaapiDisplay
*
* Unlocks @display
*/
#define GST_VAAPI_DISPLAY_UNLOCK(display) \
gst_vaapi_display_unlock (GST_VAAPI_DISPLAY (display))
typedef struct _GstVaapiDisplayInfo GstVaapiDisplayInfo;
typedef struct _GstVaapiDisplay GstVaapiDisplay;
/**
* GstVaapiDriverQuirks:
* @GST_VAAPI_DRIVER_QUIRK_NO_CHECK_SURFACE_PUT_IMAGE: if driver
* crashes when try to put an image in a reused surface.
* https://gitlab.freedesktop.org/mesa/mesa/merge_requests/2016
* @GST_VAAPI_DRIVER_QUIRK_NO_CHECK_VPP_COLOR_STD: if driver does not
* properly report supported vpp color standards.
* @GST_VAAPI_DRIVER_QUIRK_NO_RGBYUV_VPP_COLOR_PRIMARY: if driver can
* only do CSC from YUV to RGB, and vice-versa without changing the
* color standard primaries. This quirk is initially introduced to
* work around a problem in the intel-media-driver (iHD) reported here:
* https://github.com/intel/media-driver/issues/860. Once the driver
* issue is fixed, we should remove this quirk. Also see this issue:
* https://gitlab.freedesktop.org/gstreamer/gstreamer-vaapi/issues/238
* @GST_VAAPI_DRIVER_QUIRK_MISSING_RGBA_IMAGE_FORMAT: i965 driver doesn't
* report to support ARGB format, but if it's forced to create a RGBA
* surface, it works. Driver issue:
* https://github.com/intel/intel-vaapi-driver/issues/500
* @GST_VAAPI_DRIVER_QUIRK_JPEG_ENC_SHIFT_VALUE_BY_50: if the driver shifts
* the value by 50 when calculating quantization from quality level
* @GST_VAAPI_DRIVER_QUIRK_HEVC_ENC_SLICE_NOT_SPAN_TILE: The requirement
* that one slice should not span tiles when tile is enabled.
* @GST_VAAPI_DRIVER_QUIRK_JPEG_DEC_BROKEN_FORMATS: i965 driver does not
* report all the handled formats for JPEG decoding.
*/
typedef enum
{
GST_VAAPI_DRIVER_QUIRK_NO_CHECK_SURFACE_PUT_IMAGE = (1U << 0),
GST_VAAPI_DRIVER_QUIRK_NO_CHECK_VPP_COLOR_STD = (1U << 1),
GST_VAAPI_DRIVER_QUIRK_NO_RGBYUV_VPP_COLOR_PRIMARY = (1U << 2),
GST_VAAPI_DRIVER_QUIRK_MISSING_RGBA_IMAGE_FORMAT = (1U << 3),
GST_VAAPI_DRIVER_QUIRK_JPEG_ENC_SHIFT_VALUE_BY_50 = (1U << 4),
GST_VAAPI_DRIVER_QUIRK_HEVC_ENC_SLICE_NOT_SPAN_TILE = (1U << 5),
GST_VAAPI_DRIVER_QUIRK_JPEG_DEC_BROKEN_FORMATS = (1U << 6),
} GstVaapiDriverQuirks;
/**
* GstVaapiDisplayType:
* @GST_VAAPI_DISPLAY_TYPE_ANY: Automatic detection of the display type.
* @GST_VAAPI_DISPLAY_TYPE_X11: VA/X11 display.
* @GST_VAAPI_DISPLAY_TYPE_GLX: VA/GLX display.
* @GST_VAAPI_DISPLAY_TYPE_WAYLAND: VA/Wayland display.
* @GST_VAAPI_DISPLAY_TYPE_DRM: VA/DRM display.
* @GST_VAAPI_DISPLAY_TYPE_EGL: VA/EGL display.
*/
typedef enum
{
GST_VAAPI_DISPLAY_TYPE_ANY = 0,
GST_VAAPI_DISPLAY_TYPE_X11,
GST_VAAPI_DISPLAY_TYPE_GLX,
GST_VAAPI_DISPLAY_TYPE_WAYLAND,
GST_VAAPI_DISPLAY_TYPE_DRM,
GST_VAAPI_DISPLAY_TYPE_EGL,
} GstVaapiDisplayType;
#define GST_VAAPI_TYPE_DISPLAY_TYPE \
(gst_vaapi_display_type_get_type())
GType
gst_vaapi_display_type_get_type (void) G_GNUC_CONST;
GType
gst_vaapi_display_get_type (void) G_GNUC_CONST;
gboolean
gst_vaapi_display_type_is_compatible (GstVaapiDisplayType type1,
GstVaapiDisplayType type2);
/**
* GstVaapiDisplayInfo:
*
* Generic class to retrieve VA display info
*/
struct _GstVaapiDisplayInfo
{
GstVaapiDisplay *display;
gchar *display_name;
VADisplay va_display;
gpointer native_display;
};
/**
* GstVaapiDisplayProperties:
* @GST_VAAPI_DISPLAY_PROP_RENDER_MODE: rendering mode (#GstVaapiRenderMode).
* @GST_VAAPI_DISPLAY_PROP_ROTATION: rotation angle (#GstVaapiRotation).
* @GST_VAAPI_DISPLAY_PROP_HUE: hue (float: [-180 ; 180], default: 0).
* @GST_VAAPI_DISPLAY_PROP_SATURATION: saturation (float: [0 ; 2], default: 1).
* @GST_VAAPI_DISPLAY_PROP_BRIGHTNESS: brightness (float: [-1 ; 1], default: 0).
* @GST_VAAPI_DISPLAY_PROP_CONTRAST: contrast (float: [0 ; 2], default: 1).
*/
#define GST_VAAPI_DISPLAY_PROP_RENDER_MODE "render-mode"
#define GST_VAAPI_DISPLAY_PROP_ROTATION "rotation"
#define GST_VAAPI_DISPLAY_PROP_HUE "hue"
#define GST_VAAPI_DISPLAY_PROP_SATURATION "saturation"
#define GST_VAAPI_DISPLAY_PROP_BRIGHTNESS "brightness"
#define GST_VAAPI_DISPLAY_PROP_CONTRAST "contrast"
GstVaapiDisplay *
gst_vaapi_display_new_with_display (VADisplay va_display);
void
gst_vaapi_display_replace (GstVaapiDisplay ** old_display_ptr,
GstVaapiDisplay * new_display);
void
gst_vaapi_display_lock (GstVaapiDisplay * display);
void
gst_vaapi_display_unlock (GstVaapiDisplay * display);
void
gst_vaapi_display_sync (GstVaapiDisplay * display);
void
gst_vaapi_display_flush (GstVaapiDisplay * display);
GstVaapiDisplayType
gst_vaapi_display_get_class_type (GstVaapiDisplay * display);
GstVaapiDisplayType
gst_vaapi_display_get_display_type (GstVaapiDisplay * display);
const gchar *
gst_vaapi_display_get_display_name (GstVaapiDisplay * display);
VADisplay
gst_vaapi_display_get_display (GstVaapiDisplay * display);
guint
gst_vaapi_display_get_width (GstVaapiDisplay * display);
guint
gst_vaapi_display_get_height (GstVaapiDisplay * display);
void
gst_vaapi_display_get_size (GstVaapiDisplay * display, guint * pwidth,
guint * pheight);
void
gst_vaapi_display_get_pixel_aspect_ratio (GstVaapiDisplay * display,
guint * par_n, guint * par_d);
gboolean
gst_vaapi_display_has_video_processing (GstVaapiDisplay * display);
GArray *
gst_vaapi_display_get_decode_profiles (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_has_decoder (GstVaapiDisplay * display,
GstVaapiProfile profile, GstVaapiEntrypoint entrypoint);
GArray *
gst_vaapi_display_get_encode_profiles (GstVaapiDisplay * display);
GArray *
gst_vaapi_display_get_encode_profiles_by_codec (GstVaapiDisplay * display,
GstVaapiCodec codec);
gboolean
gst_vaapi_display_has_encoder (GstVaapiDisplay * display,
GstVaapiProfile profile, GstVaapiEntrypoint entrypoint);
GArray *
gst_vaapi_display_get_image_formats (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_has_image_format (GstVaapiDisplay * display,
GstVideoFormat format);
GArray *
gst_vaapi_display_get_subpicture_formats (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_has_subpicture_format (GstVaapiDisplay * display,
GstVideoFormat format, guint * flags_ptr);
gboolean
gst_vaapi_display_has_property (GstVaapiDisplay * display, const gchar * name);
gboolean
gst_vaapi_display_get_render_mode (GstVaapiDisplay * display,
GstVaapiRenderMode * pmode);
gboolean
gst_vaapi_display_set_render_mode (GstVaapiDisplay * display,
GstVaapiRenderMode mode);
GstVaapiRotation
gst_vaapi_display_get_rotation (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_set_rotation (GstVaapiDisplay * display,
GstVaapiRotation rotation);
const gchar *
gst_vaapi_display_get_vendor_string (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_has_opengl (GstVaapiDisplay * display);
void
gst_vaapi_display_reset_texture_map (GstVaapiDisplay * display);
gboolean
gst_vaapi_display_has_driver_quirks (GstVaapiDisplay * display, guint quirks);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVaapiDisplay, gst_object_unref)
G_END_DECLS
#endif /* GST_VAAPI_DISPLAY_H */