mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-10 11:29:55 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/reference/libs/libs-sections.txt

364 lines
8.5 KiB
Text
Raw Normal View History

Add new video format API. Leverage GstVideoFormat utilities from core GStreamer to provide an adaptation layer to VA image formats.
2013-07-09 13:29:59 +00:00
<SECTION>
<FILE>videoformat</FILE>
<TITLE>GstVideoFormat</TITLE>
libs: add and expose gst_vaapi_video_format_to_string() helper. This is just a wrapper over gst_video_format_to_string() for older GStreamer 0.10 builds.
2013-07-22 13:15:48 +00:00
gst_vaapi_video_format_to_string
Fix new video format API. Fix new internal video format API, based on GstVideoFormat, to not clobber with system symbols. So replace the gst_video_format_* prefix with gst_vaapi_video_format_ prefix, even if the format type remains GstVideoFormat.
2013-07-15 12:42:33 +00:00
gst_vaapi_video_format_from_caps
gst_vaapi_video_format_from_structure
gst_vaapi_video_format_from_va_format
gst_vaapi_video_format_get_chroma_type
gst_vaapi_video_format_get_score
gst_vaapi_video_format_is_rgb
gst_vaapi_video_format_is_yuv
gst_vaapi_video_format_to_caps
gst_vaapi_video_format_to_va_format
Add new video format API. Leverage GstVideoFormat utilities from core GStreamer to provide an adaptation layer to VA image formats.
2013-07-09 13:29:59 +00:00
</SECTION>
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SECTION>
<FILE>gstvaapisurfacepool</FILE>
<TITLE>GstVaapiSurfacePool</TITLE>
GstVaapiSurfacePool
gst_vaapi_surface_pool_new
<SUBSECTION Standard>
GST_VAAPI_SURFACE_POOL
</SECTION>
<SECTION>
<FILE>gstvaapivideopool</FILE>
<TITLE>GstVaapiVideoPool</TITLE>
GstVaapiVideoPool
Expose video pool display.
2010-05-11 12:06:59 +00:00
gst_vaapi_video_pool_get_display
libs: add query for GstVaapiVideoPool object types. Add API to identify the underlying GstVaapiVideoPool object type.
2013-05-23 16:45:23 +00:00
gst_vaapi_video_pool_get_object_type
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_video_pool_get_object
gst_vaapi_video_pool_put_object
Add missing docs.
2010-05-03 22:36:34 +00:00
gst_vaapi_video_pool_add_object
gst_vaapi_video_pool_add_objects
gst_vaapi_video_pool_get_capacity
gst_vaapi_video_pool_set_capacity
gst_vaapi_video_pool_get_size
gst_vaapi_video_pool_reserve
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SUBSECTION Standard>
GST_VAAPI_VIDEO_POOL
</SECTION>
<SECTION>
<FILE>gstvaapidisplay_x11</FILE>
<TITLE>GstVaapiDisplayX11</TITLE>
GstVaapiDisplayX11
gst_vaapi_display_x11_new
gst_vaapi_display_x11_new_with_display
gst_vaapi_display_x11_get_display
Make more helpers internal, thus reducing .text size further. Add gst_vaapi_display_x11_get_screen() helper along the way.
2010-04-01 13:41:24 +00:00
gst_vaapi_display_x11_get_screen
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SUBSECTION Standard>
GST_VAAPI_DISPLAY_X11
</SECTION>
<SECTION>
<FILE>gstvaapiwindow_x11</FILE>
<TITLE>GstVaapiWindowX11</TITLE>
GstVaapiWindowX11
Add GST_VAAPI_WINDOW_XWINDOW() helper macro.
2010-03-23 06:40:27 +00:00
GST_VAAPI_WINDOW_XWINDOW
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_window_x11_new
gst_vaapi_window_x11_new_with_xid
gst_vaapi_window_x11_get_xid
Add missing API documentation.
2010-03-25 17:39:06 +00:00
gst_vaapi_window_x11_is_foreign_xid
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SUBSECTION Standard>
GST_VAAPI_WINDOW_X11
</SECTION>
Add missing API documentation.
2010-03-25 17:39:06 +00:00
<SECTION>
<FILE>gstvaapidisplay_glx</FILE>
<TITLE>GstVaapiDisplayGLX</TITLE>
GstVaapiDisplayGLX
gst_vaapi_display_glx_new
gst_vaapi_display_glx_new_with_display
<SUBSECTION Standard>
GST_VAAPI_DISPLAY_GLX
</SECTION>
<SECTION>
<FILE>gstvaapiwindow_glx</FILE>
<TITLE>GstVaapiWindowGLX</TITLE>
GstVaapiWindowGLX
gst_vaapi_window_glx_new
gst_vaapi_window_glx_new_with_xid
gst_vaapi_window_glx_get_context
gst_vaapi_window_glx_set_context
Fix documentation.
2010-03-29 11:25:20 +00:00
gst_vaapi_window_glx_make_current
Add missing API documentation.
2010-03-25 17:39:06 +00:00
gst_vaapi_window_glx_swap_buffers
Fix documentation.
2010-03-29 11:25:20 +00:00
gst_vaapi_window_glx_put_texture
Add missing API documentation.
2010-03-25 17:39:06 +00:00
<SUBSECTION Standard>
GST_VAAPI_WINDOW_GLX
</SECTION>
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SECTION>
<FILE>gstvaapidisplay</FILE>
<TITLE>GstVaapiDisplay</TITLE>
GstVaapiDisplay
gst_vaapi_display_new_with_display
gst_vaapi_display_lock
gst_vaapi_display_unlock
Add gst_vaapi_display_{sync,flush}() helpers.
2010-03-26 11:35:20 +00:00
gst_vaapi_display_sync
gst_vaapi_display_flush
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_display_get_display
Updates.
2010-03-22 08:45:03 +00:00
gst_vaapi_display_get_width
gst_vaapi_display_get_height
gst_vaapi_display_get_size
Add gst_vaapi_display_get_pixel_aspect_ratio().
2010-03-22 09:32:01 +00:00
gst_vaapi_display_get_pixel_aspect_ratio
Add VA profile abstraction.
2010-04-20 13:36:04 +00:00
gst_vaapi_display_get_decode_caps
gst_vaapi_display_has_decoder
gst_vaapi_display_get_encode_caps
gst_vaapi_display_has_encoder
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_display_get_image_caps
gst_vaapi_display_has_image_format
gst_vaapi_display_get_subpicture_caps
gst_vaapi_display_has_subpicture_format
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_display_has_property
gst_vaapi_display_get_rotation
gst_vaapi_display_set_rotation
gst_vaapi_display_get_render_mode
gst_vaapi_display_set_render_mode
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SUBSECTION Standard>
GST_VAAPI_DISPLAY
</SECTION>
<SECTION>
<FILE>gstvaapiimagepool</FILE>
<TITLE>GstVaapiImagePool</TITLE>
GstVaapiImagePool
gst_vaapi_image_pool_new
<SUBSECTION Standard>
GST_VAAPI_IMAGE_POOL
</SECTION>
Add GstVaapiPoint & GstVaapiRectangle data structures.
2010-03-22 12:16:47 +00:00
<SECTION>
<FILE>gstvaapitypes</FILE>
<TITLE>Basic data structures</TITLE>
Add GstVaapiID abstraction.
2010-03-24 09:52:43 +00:00
GstVaapiID
Add GST_VAAPI_ID_FORMAT() and GST_VAAPI_ID_ARGS() helpers.
2010-03-24 12:38:40 +00:00
GST_VAAPI_ID_FORMAT
GST_VAAPI_ID_ARGS
Add GstVaapiPoint & GstVaapiRectangle data structures.
2010-03-22 12:16:47 +00:00
GstVaapiPoint
GstVaapiRectangle
</SECTION>
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SECTION>
<FILE>gstvaapiwindow</FILE>
<TITLE>GstVaapiWindow</TITLE>
GstVaapiWindow
Add gst_vaapi_window_get_fullscreen() helper and "fullscreen" property.
2010-03-22 12:47:13 +00:00
gst_vaapi_window_get_display
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_window_show
gst_vaapi_window_hide
Add gst_vaapi_window_get_fullscreen() helper and "fullscreen" property.
2010-03-22 12:47:13 +00:00
gst_vaapi_window_get_fullscreen
Add gst_vaapi_window_set_fullscreen() API.
2010-03-22 10:51:49 +00:00
gst_vaapi_window_set_fullscreen
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_window_get_width
gst_vaapi_window_get_height
gst_vaapi_window_get_size
gst_vaapi_window_set_width
gst_vaapi_window_set_height
gst_vaapi_window_set_size
gst_vaapi_window_put_surface
<SUBSECTION Standard>
GST_VAAPI_WINDOW
</SECTION>
Make GstVaapi{Surface,Image,Subpicture} derive from a GstVaapiObject.
2010-03-23 16:21:28 +00:00
<SECTION>
<FILE>gstvaapiobject</FILE>
<TITLE>GstVaapiObject</TITLE>
GstVaapiObject
gst_vaapi_object_get_display
Add gst_vaapi_object_{,un}lock_display() helpers.
2010-03-26 15:22:00 +00:00
gst_vaapi_object_lock_display
gst_vaapi_object_unlock_display
Move "id" down to the GstVaapiObject base.
2010-03-24 13:19:58 +00:00
gst_vaapi_object_get_id
Make GstVaapi{Surface,Image,Subpicture} derive from a GstVaapiObject.
2010-03-23 16:21:28 +00:00
<SUBSECTION Standard>
GST_VAAPI_OBJECT
</SECTION>
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SECTION>
<FILE>gstvaapiimage</FILE>
GST_VAAPI_IMAGE_FORMAT
GST_VAAPI_IMAGE_WIDTH
GST_VAAPI_IMAGE_HEIGHT
<TITLE>GstVaapiImage</TITLE>
GstVaapiImage
gst_vaapi_image_new
gst_vaapi_image_new_with_image
Restore the gst_vaapi_{surface,image,subpicture}_get_id() interfaces.
2010-03-25 09:49:17 +00:00
gst_vaapi_image_get_id
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_image_get_image
gst_vaapi_image_get_format
gst_vaapi_image_get_width
gst_vaapi_image_get_height
gst_vaapi_image_get_size
gst_vaapi_image_is_linear
gst_vaapi_image_is_mapped
gst_vaapi_image_map
gst_vaapi_image_unmap
gst_vaapi_image_get_plane_count
gst_vaapi_image_get_plane
gst_vaapi_image_get_pitch
gst_vaapi_image_get_data_size
image: add helpers to extract pixels to user buffers.
2012-01-05 09:29:48 +00:00
gst_vaapi_image_get_buffer
gst_vaapi_image_get_raw
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_image_update_from_buffer
<SUBSECTION Standard>
GST_VAAPI_IMAGE
</SECTION>
<SECTION>
<FILE>gstvaapisurface</FILE>
GstVaapiChromaType
Add gst_vaapi_surface_query_status() wrapper.
2010-03-30 08:11:50 +00:00
GstVaapiSurfaceStatus
Move GstVaapiSurfaceRenderFlags to gstvaapisurface.h since this will also be useful for e.g. a gstvaapitexture.h.
2010-03-21 08:22:46 +00:00
GstVaapiSurfaceRenderFlags
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<TITLE>GstVaapiSurface</TITLE>
GstVaapiSurface
gst_vaapi_surface_new
surface: allow creation with explicit pixel format. Make it possible to create VA surfaces with a specific pixel format. This is a new capability brought in by VA-API >= 0.34.0. If that capability is not built-in (e.g. using VA-API < 0.34.0), then gst_vaapi_surface_new_with_format() will return NULL.
2013-07-09 17:08:37 +00:00
gst_vaapi_surface_new_with_format
Restore the gst_vaapi_{surface,image,subpicture}_get_id() interfaces.
2010-03-25 09:49:17 +00:00
gst_vaapi_surface_get_id
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_surface_get_chroma_type
surface: allow creation with explicit pixel format. Make it possible to create VA surfaces with a specific pixel format. This is a new capability brought in by VA-API >= 0.34.0. If that capability is not built-in (e.g. using VA-API < 0.34.0), then gst_vaapi_surface_new_with_format() will return NULL.
2013-07-09 17:08:37 +00:00
gst_vaapi_surface_get_format
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_surface_get_width
gst_vaapi_surface_get_height
gst_vaapi_surface_get_size
gst_vaapi_surface_derive_image
gst_vaapi_surface_get_image
gst_vaapi_surface_put_image
Add gst_vaapi_surface_{,de}associate_subpicture() API.
2010-03-23 10:36:20 +00:00
gst_vaapi_surface_associate_subpicture
gst_vaapi_surface_deassociate_subpicture
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_surface_sync
Add gst_vaapi_surface_query_status() wrapper.
2010-03-30 08:11:50 +00:00
gst_vaapi_surface_query_status
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
<SUBSECTION Standard>
GST_VAAPI_SURFACE
</SECTION>
<SECTION>
<FILE>gstvaapisubpicture</FILE>
<TITLE>GstVaapiSubpicture</TITLE>
GstVaapiSubpicture
gst_vaapi_subpicture_new
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_subpicture_new_from_overlay_rectangle
Restore the gst_vaapi_{surface,image,subpicture}_get_id() interfaces.
2010-03-25 09:49:17 +00:00
gst_vaapi_subpicture_get_id
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_subpicture_get_flags
gst_vaapi_subpicture_get_global_alpha
gst_vaapi_subpicture_set_global_alpha
Document public API for libgstvaapi-*.so.*.
2010-03-19 17:04:51 +00:00
gst_vaapi_subpicture_get_image
gst_vaapi_subpicture_set_image
<SUBSECTION Standard>
GST_VAAPI_SUBPICTURE
</SECTION>
Add VA profile abstraction.
2010-04-20 13:36:04 +00:00
<SECTION>
<FILE>gstvaapiprofile</FILE>
<TITLE>GstVaapiProfile</TITLE>
GstVaapiCodec
GstVaapiProfile
Add missing docs.
2010-05-03 22:36:34 +00:00
GstVaapiEntrypoint
Add VA profile abstraction.
2010-04-20 13:36:04 +00:00
gst_vaapi_profile
gst_vaapi_profile_from_caps
gst_vaapi_profile_get_va_profile
gst_vaapi_profile_get_caps
gst_vaapi_profile_get_codec
Add missing docs.
2010-05-03 22:36:34 +00:00
gst_vaapi_entrypoint
gst_vaapi_entrypoint_get_va_entrypoint
Add VA profile abstraction.
2010-04-20 13:36:04 +00:00
</SECTION>
Fix documentation.
2010-03-29 11:25:20 +00:00
<SECTION>
<FILE>gstvaapitexture</FILE>
<TITLE>GstVaapiTexture</TITLE>
GstVaapiTexture
gst_vaapi_texture_new
gst_vaapi_texture_new_with_texture
gst_vaapi_texture_get_id
gst_vaapi_texture_get_target
gst_vaapi_texture_get_format
gst_vaapi_texture_get_width
gst_vaapi_texture_get_height
gst_vaapi_texture_get_size
gst_vaapi_texture_put_surface
</SECTION>
Add missing docs.
2010-05-03 22:36:34 +00:00
<SECTION>
<FILE>gstvaapicontext</FILE>
<TITLE>GstVaapiContext</TITLE>
GstVaapiContext
gst_vaapi_context_new
gst_vaapi_context_reset
gst_vaapi_context_get_id
gst_vaapi_context_get_profile
gst_vaapi_context_set_profile
gst_vaapi_context_get_entrypoint
gst_vaapi_context_get_size
decoder: simplify acquisition/release of spare surface. Introduce gst_vaapi_surface_proxy_new_from_pool() to allocate a new surface proxy from the context surface pool. This change also makes sure to retain the parent surface pool in the proxy. Besides, it was also totally useless to attach/detach parent context to VA surface each time we acquire/release it. Since the whole context owns all associated VA surfaces, we can mark this as such only once and for all.
2013-04-03 09:37:44 +00:00
gst_vaapi_context_get_surface_proxy
Check for out-of-free-surfaces condition.
2010-05-15 05:36:15 +00:00
gst_vaapi_context_get_surface_count
context: make it possible to apply composition globally.
2011-12-14 13:35:13 +00:00
gst_vaapi_context_apply_composition
Add missing docs.
2010-05-03 22:36:34 +00:00
<SUBSECTION Standard>
GST_VAAPI_CONTEXT
</SECTION>
<SECTION>
<FILE>gstvaapidecoder</FILE>
GstVaapiDecoderStatus
<TITLE>GstVaapiDecoder</TITLE>
GstVaapiDecoder
Regularly update and expose decoder caps.
2010-05-15 15:33:20 +00:00
gst_vaapi_decoder_get_caps
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_decoder_get_codec
gst_vaapi_decoder_get_codec_state
Add missing docs.
2010-05-03 22:36:34 +00:00
gst_vaapi_decoder_put_buffer
gst_vaapi_decoder_get_surface
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_decoder_get_frame
decoder: add gst_vaapi_decoder_get_frame_with_timeout(). Add gst_vaapi_decoder_get_frame_with_timeout() helper function that will wait for a frame to be decoded, until the specified timeout in microseconds, prior to returning to the caller. This is a fix to performance regression from 851cc0, whereby the vaapidecode loop executed on the srcpad task was called to often, thus starving all CPU resources.
2013-04-25 11:56:18 +00:00
gst_vaapi_decoder_get_frame_with_timeout
docs: expose new interfaces.
2013-01-14 10:48:58 +00:00
gst_vaapi_decoder_parse
gst_vaapi_decoder_decode
Add missing docs.
2010-05-03 22:36:34 +00:00
<SUBSECTION Standard>
GST_VAAPI_DECODER
</SECTION>
docs: add missing entries for the JPEG decoder.
2012-07-19 15:27:06 +00:00
<SECTION>
<FILE>gstvaapidecoder_jpeg</FILE>
<TITLE>GstVaapiDecoderJpeg</TITLE>
GstVaapiDecoderJpeg
gst_vaapi_decoder_jpeg_new
</SECTION>
Fix a few documentation issues.
2012-04-02 10:52:54 +00:00
<SECTION>
<FILE>gstvaapidecoder_mpeg2</FILE>
<TITLE>GstVaapiDecoderMpeg2</TITLE>
GstVaapiDecoderMpeg2
gst_vaapi_decoder_mpeg2_new
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_mpeg4</FILE>
<TITLE>GstVaapiDecoderMpeg4</TITLE>
GstVaapiDecoderMpeg4
gst_vaapi_decoder_mpeg4_new
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_h264</FILE>
<TITLE>GstVaapiDecoderH264</TITLE>
GstVaapiDecoderH264
gst_vaapi_decoder_h264_new
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_vc1</FILE>
<TITLE>GstVaapiDecoderVC1</TITLE>
GstVaapiDecoderVC1
gst_vaapi_decoder_vc1_new
</SECTION>
Add missing docs.
2010-05-03 22:36:34 +00:00
<SECTION>
<FILE>gstvaapisurfaceproxy</FILE>
<TITLE>GstVaapiSurfaceProxy</TITLE>
surfaceproxy: add more attributes for raw decoding modes. Add more attributes for raw decoding modes, i.e. directly through the libgstvaapi helper library. In particular, add presentation timestamp, duration and a couple of flags (interlaced, TFF, RFF, one-field).
2013-04-16 16:35:48 +00:00
gst_vaapi_surface_proxy_get_duration
gst_vaapi_surface_proxy_get_flags
Add missing docs.
2010-05-03 22:36:34 +00:00
gst_vaapi_surface_proxy_get_surface
surfaceproxy: add helper to retrieve the VA surface ID.
2012-01-05 15:59:57 +00:00
gst_vaapi_surface_proxy_get_surface_id
surfaceproxy: add more attributes for raw decoding modes. Add more attributes for raw decoding modes, i.e. directly through the libgstvaapi helper library. In particular, add presentation timestamp, duration and a couple of flags (interlaced, TFF, RFF, one-field).
2013-04-16 16:35:48 +00:00
gst_vaapi_surface_proxy_get_timestamp
decoder: simplify acquisition/release of spare surface. Introduce gst_vaapi_surface_proxy_new_from_pool() to allocate a new surface proxy from the context surface pool. This change also makes sure to retain the parent surface pool in the proxy. Besides, it was also totally useless to attach/detach parent context to VA surface each time we acquire/release it. Since the whole context owns all associated VA surfaces, we can mark this as such only once and for all.
2013-04-03 09:37:44 +00:00
gst_vaapi_surface_proxy_new_from_pool
docs: fix entries for GstVaapiSurfaceProxy.
2012-12-18 15:17:22 +00:00
gst_vaapi_surface_proxy_ref
gst_vaapi_surface_proxy_replace
surfaceproxy: drop user-data support from GstVaapiSurfaceProxy. Drop user-data support from GstVaapiSurfaceProxy. Rather make it explicit to call some user-provided function when the surface proxy is released.
2013-04-16 11:48:00 +00:00
gst_vaapi_surface_proxy_set_destroy_notify
docs: fix entries for GstVaapiSurfaceProxy.
2012-12-18 15:17:22 +00:00
gst_vaapi_surface_proxy_unref
Add missing docs.
2010-05-03 22:36:34 +00:00
<SUBSECTION Standard>
docs: fix entries for GstVaapiSurfaceProxy.
2012-12-18 15:17:22 +00:00
GST_VAAPI_SURFACE_PROXY_SURFACE
Add missing docs.
2010-05-03 22:36:34 +00:00
</SECTION>
Reference in a new issue Copy permalink