path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-06-23docs: Mark parent classes as plugin APIThibault Saunier1-0/+102
2020-06-23meson: mark plugins cache target as always staleMathieu Duponchelle1-0/+1
2020-06-22doc: Stop documenting properties from parentsThibault Saunier1-317/+4
2020-06-19Update plugin docs and add more pluginsTim-Philipp Müller1-3/+496
Part-of: <>
2020-06-03doc: Require hotdoc >= 0.11.0Thibault Saunier1-0/+11
2020-06-03docs: Update plugin cache with the new formatThibault Saunier1-1749/+663
And fix the default URL which should not be inside quotes.
2019-05-16docs: Update plugin cacheThibault Saunier1-36/+110
2019-05-13meson: Fix call to wrong functionThibault Saunier1-1/+1
2019-05-13docs: Port to hotdocThibault Saunier12-641/+2840
2019-04-19Back to developmentTim-Philipp Müller1-1/+1
2019-04-19Update docsTim-Philipp Müller1-1/+1
2019-04-11Update docsTim-Philipp Müller1-7/+7
2019-03-04Back to developmentTim-Philipp Müller1-1/+1
2019-02-26Update docsTim-Philipp Müller1-1/+1
2019-01-17Update docsTim-Philipp Müller1-15/+15
2018-10-12gst: Advertise elements interacting with hardware devicesPhilippe Normand1-7/+7
2018-03-20Back to developmentTim-Philipp Müller1-0/+196
2016-10-27docs: document environment variablesVíctor Manuel Jáquez Leal3-1/+74
2016-10-27docs: replace vaapidecode with each codecVíctor Manuel Jáquez Leal2-7/+88
In the spirit of the codec split, this patch removes the documentation of vaapidecode and adds a page per each possible decoder. Nonetheless, only those available in the compilation system are going to be instrospected, because the rest are not registered.
2016-07-15build: doc: do not redefine MAINTAINERCLEANFILESVíctor Manuel Jáquez Leal1-1/+1
MAINTAINERCLEANFILES is defined in gtk-doc-plugins.mak, thus instead of overload it, the files should be added.
2016-03-30docs: generate vaapijpegdec documentationVíctor Manuel Jáquez Leal2-7/+9
2016-03-09build: git ignore gtkdoc generated filesVíctor Manuel Jáquez Leal1-0/+2
2016-02-03rename encoders to vaapi{codec}encVíctor Manuel Jáquez Leal2-15/+15
Trying to comply with GStreamer's element names, this patch renames the encoders using the name format vaapi{codec}enc. In this way, the plugin documentation is linked correctly. Signed-off-by: Víctor Manuel Jáquez Leal <>
2016-02-03docs: update plugin documentationVíctor Manuel Jáquez Leal2-3/+149
Update all the documentation of elements of the vaapi plugin. Signed-off-by: Víctor Manuel Jáquez Leal <>
2016-02-03resurrect gtk-doc machineryVíctor Manuel Jáquez Leal9-174/+107
Our auto-generated documentation has been a bit neglected. This patch replaces the 'normal' gtk-doc with the one used in GStreamer, which is adapted for plugins, elements and libraries. This patch also re-enables documentation generation. Signed-off-by: Víctor Manuel Jáquez Leal <>
2016-01-25docs: remove library documentation which is non-public nowTim-Philipp Müller5-776/+1
2016-01-20libs: remove versioningVíctor Manuel Jáquez Leal2-5/+5
Since we don't install libraries anymore, it makes no sense to keep versioning them according to the gstreamer's version. Signed-off-by: Víctor Manuel Jáquez Leal <>
2015-06-04doc: add VA-API reference in freedesktopVíctor Manuel Jáquez Leal1-0/+5
2015-05-20doc: conditional linking for scannerVíctor Manuel Jáquez Leal1-1/+10
Add x11 library only if it is enabled.
2015-05-20doc: fix scanner compilation warningVíctor Manuel Jáquez Leal1-0/+6
2015-05-20doc: update sections and symbolsVíctor Manuel Jáquez Leal2-11/+200
2015-05-18build: use git.mkVíctor Manuel Jáquez Leal4-8/+4
This patch handles dinamically the gitignore files with[1]. Removed the automake variable MAINTAINERCLANFILES in most of the files since now it is handled by the top one. 1.
2013-11-28surfaceproxy: add copy function.Gwenole Beauchesne1-0/+1
Add gst_vaapi_surface_proxy_copy() function that creates a new surface proxy with the same information from the parent proxy, except that the user-defined destroy notify function is not copied over. The underlying VA surface is pushed back to the video pool only when the last reference to the parent surface proxy is released.
2013-11-21filter: add helper to specify references for deinterlacing.Halley Zhao1-0/+1
Add gst_vaapi_fitler_set_deinterlacing_references() API to submit the list of surfaces used for forward or backward reference in advanced deinterlacing mode, e.g. Motion-Adaptive, Motion-Compensated. The list of surfaces used as deinterlacing references shall be live until the next call to gst_vaapi_filter_process(). Signed-off-by: Gwenole Beauchesne <>
2013-11-21filter: add helpers to check for supported/active operation.Gwenole Beauchesne1-0/+2
Add a couple of helper functions: - gst_vaapi_filter_has_operation(): checks whether the VA driver advertises support for the supplied operation ; - gst_vaapi_filter_use_operation(): checks whether the supplied operation was already enabled to its non-default value.
2013-08-27filter: allow specification of render target regions.Gwenole Beauchesne1-0/+1
Add support for rendering the source surface to a particular region within the supplied target surface. The default background color is black.
2013-08-23filter: add initial support for deinterlacing.Zhao Halley1-0/+1
Add basic deinterlacing support, i.e. bob-deinterlacing whereby only the selected field from the input surface is kept for the target surface. Setting gst_vaapi_filter_set_deinterlacing() method argument to GST_VAAPI_DEINTERLACE_METHOD_NONE means to disable deinterlacing. Also move GstVaapiDeinterlaceMethod definition from vaapipostproc plug-in to libgstvaapi core library. Signed-off-by: Gwenole Beauchesne <>
2013-08-23filter: add support for color balance adjustment.Zhao Halley1-0/+4
Add ProcAmp (color balance) adjustments for hue, saturation, brightness and contrast. The respective range for each filter shall be the same as for the VA display attributes. Signed-off-by: Gwenole Beauchesne <>
2013-08-23filter: add support for sharpening.Zhao Halley1-0/+1
Sharpening is configured with a float value. The supported range is -1.0 .. 1.0 with 0.0 being the default, and that means no sharpening operation at all. Signed-off-by: Gwenole Beauchesne <>
2013-08-23filter: add support for denoising.Zhao Halley1-0/+1
Noise reduction is configured with a float value. The supported range is 0.0 .. 1.0 with 0.0 being the default, and that means no denoise operation at all. Signed-off-by: Gwenole Beauchesne <>
2013-08-23filter: add support for frame cropping.Gwenole Beauchesne1-0/+1
Frame cropping is defined with a GstVaapiRectangle value. The default behaviour is to treat the source surface as a whole
2013-08-23Add initial infrastructure for video processing.Gwenole Beauchesne2-0/+17
Add initial API for video processing: only scaling and color format conversion operations are supported.
2013-08-23libs: drop some public APIs.Gwenole Beauchesne2-21/+0
Don't expose GstVaapiContext APIs and make them totally private to libgstvaapi core library. That API would also tend to disappear in a future revision. Likewise, don't expose GstVaapiDisplayCache API but keep symbols visible so that the various render backends could share a common display cache implementation in libgstvaapi. Try to clean-up the documentation from any stale entry too.
2013-07-26image: clean image API up.Gwenole Beauchesne1-1/+0
Don't expose functions that reference a GstVaapiImageRaw, those are meant to be internal only for implementing subpictures sync. Also add a few private definitions to avoid functions calls for retrieving image size and format information.
2013-07-26image: add gst_vaapi_image_copy() helper.Gwenole Beauchesne1-0/+1
Add gst_vaapi_image_copy() helper function to copy images of same format and size.
2013-07-22x11: implement pixmap API.Gwenole Beauchesne2-0/+14
Implement the new render-to-pixmap API. The only supported pixmap format that will work is xRGB, with native byte ordering. Others might work but they were not tested.
2013-07-22Add initial Pixmap API.Gwenole Beauchesne2-0/+18
Add API to transfer VA urfaces to native pixmaps. Also add an API to render a native pixmap, for completeness. In general, rendering to pixmap would only be useful to certain VA drivers and use cases on X11 display servers. e.g. GLX_EXT_texture_from_pixmap (TFP) handled in an upper layer.
2013-07-22libs: add and expose gst_vaapi_video_format_to_string() helper.Gwenole Beauchesne1-0/+1
This is just a wrapper over gst_video_format_to_string() for older GStreamer 0.10 builds.
2013-07-15Fix new video format API.Gwenole Beauchesne1-9/+9
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-10surface: allow creation with explicit pixel format.Gwenole Beauchesne1-0/+2
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.