Check for out-of-free-surfaces condition.
[platform/upstream/gstreamer-vaapi.git] / docs / reference / libs / libs-sections.txt
1 <SECTION>
2 <FILE>gstvaapisurfacepool</FILE>
3 <TITLE>GstVaapiSurfacePool</TITLE>
4 GstVaapiSurfacePool
5 GstVaapiSurfacePoolClass
6 gst_vaapi_surface_pool_new
7 <SUBSECTION Standard>
8 GST_VAAPI_SURFACE_POOL
9 GST_VAAPI_IS_SURFACE_POOL
10 GST_VAAPI_TYPE_SURFACE_POOL
11 gst_vaapi_surface_pool_get_type
12 GST_VAAPI_SURFACE_POOL_CLASS
13 GST_VAAPI_IS_SURFACE_POOL_CLASS
14 GST_VAAPI_SURFACE_POOL_GET_CLASS
15 </SECTION>
16
17 <SECTION>
18 <FILE>gstvaapivideopool</FILE>
19 <TITLE>GstVaapiVideoPool</TITLE>
20 GstVaapiVideoPool
21 GstVaapiVideoPoolClass
22 gst_vaapi_video_pool_get_display
23 gst_vaapi_video_pool_get_caps
24 gst_vaapi_video_pool_get_object
25 gst_vaapi_video_pool_put_object
26 gst_vaapi_video_pool_add_object
27 gst_vaapi_video_pool_add_objects
28 gst_vaapi_video_pool_get_capacity
29 gst_vaapi_video_pool_set_capacity
30 gst_vaapi_video_pool_get_size
31 gst_vaapi_video_pool_reserve
32 <SUBSECTION Standard>
33 GST_VAAPI_VIDEO_POOL
34 GST_VAAPI_IS_VIDEO_POOL
35 GST_VAAPI_TYPE_VIDEO_POOL
36 gst_vaapi_video_pool_get_type
37 GST_VAAPI_VIDEO_POOL_CLASS
38 GST_VAAPI_IS_VIDEO_POOL_CLASS
39 GST_VAAPI_VIDEO_POOL_GET_CLASS
40 </SECTION>
41
42 <SECTION>
43 <FILE>gstvaapivideosink</FILE>
44 <TITLE>GstVaapiVideoSink</TITLE>
45 GST_VAAPI_VIDEO_SINK_GET_INTERFACE
46 GstVaapiVideoSinkInterface
47 gst_vaapi_video_sink_get_display
48 gst_vaapi_video_sink_lookup
49 <SUBSECTION Standard>
50 GST_VAAPI_VIDEO_SINK
51 GST_VAAPI_IS_VIDEO_SINK
52 GST_VAAPI_TYPE_VIDEO_SINK
53 gst_vaapi_video_sink_get_type
54 </SECTION>
55
56 <SECTION>
57 <FILE>gstvaapidisplay_x11</FILE>
58 <TITLE>GstVaapiDisplayX11</TITLE>
59 GstVaapiDisplayX11
60 GstVaapiDisplayX11Class
61 gst_vaapi_display_x11_new
62 gst_vaapi_display_x11_new_with_display
63 gst_vaapi_display_x11_get_display
64 gst_vaapi_display_x11_get_screen
65 <SUBSECTION Standard>
66 GST_VAAPI_DISPLAY_X11
67 GST_VAAPI_IS_DISPLAY_X11
68 GST_VAAPI_TYPE_DISPLAY_X11
69 gst_vaapi_display_x11_get_type
70 GST_VAAPI_DISPLAY_X11_CLASS
71 GST_VAAPI_IS_DISPLAY_X11_CLASS
72 GST_VAAPI_DISPLAY_X11_GET_CLASS
73 </SECTION>
74
75 <SECTION>
76 <FILE>gstvaapiwindow_x11</FILE>
77 <TITLE>GstVaapiWindowX11</TITLE>
78 GstVaapiWindowX11
79 GstVaapiWindowX11Class
80 GST_VAAPI_WINDOW_XWINDOW
81 gst_vaapi_window_x11_new
82 gst_vaapi_window_x11_new_with_xid
83 gst_vaapi_window_x11_get_xid
84 gst_vaapi_window_x11_is_foreign_xid
85 <SUBSECTION Standard>
86 GST_VAAPI_WINDOW_X11
87 GST_VAAPI_IS_WINDOW_X11
88 GST_VAAPI_TYPE_WINDOW_X11
89 gst_vaapi_window_x11_get_type
90 GST_VAAPI_WINDOW_X11_CLASS
91 GST_VAAPI_IS_WINDOW_X11_CLASS
92 GST_VAAPI_WINDOW_X11_GET_CLASS
93 </SECTION>
94
95 <SECTION>
96 <FILE>gstvaapidisplay_glx</FILE>
97 <TITLE>GstVaapiDisplayGLX</TITLE>
98 GstVaapiDisplayGLX
99 GstVaapiDisplayGLXClass
100 gst_vaapi_display_glx_new
101 gst_vaapi_display_glx_new_with_display
102 <SUBSECTION Standard>
103 GST_VAAPI_DISPLAY_GLX
104 GST_VAAPI_IS_DISPLAY_GLX
105 GST_VAAPI_TYPE_DISPLAY_GLX
106 gst_vaapi_display_glx_get_type
107 GST_VAAPI_DISPLAY_GLX_CLASS
108 GST_VAAPI_IS_DISPLAY_GLX_CLASS
109 GST_VAAPI_DISPLAY_GLX_GET_CLASS
110 </SECTION>
111
112 <SECTION>
113 <FILE>gstvaapiwindow_glx</FILE>
114 <TITLE>GstVaapiWindowGLX</TITLE>
115 GstVaapiWindowGLX
116 GstVaapiWindowGLXClass
117 gst_vaapi_window_glx_new
118 gst_vaapi_window_glx_new_with_xid
119 gst_vaapi_window_glx_get_context
120 gst_vaapi_window_glx_set_context
121 gst_vaapi_window_glx_make_current
122 gst_vaapi_window_glx_swap_buffers
123 gst_vaapi_window_glx_put_texture
124 <SUBSECTION Standard>
125 GST_VAAPI_WINDOW_GLX
126 GST_VAAPI_IS_WINDOW_GLX
127 GST_VAAPI_TYPE_WINDOW_GLX
128 gst_vaapi_window_glx_get_type
129 GST_VAAPI_WINDOW_GLX_CLASS
130 GST_VAAPI_IS_WINDOW_GLX_CLASS
131 GST_VAAPI_WINDOW_GLX_GET_CLASS
132 </SECTION>
133
134 <SECTION>
135 <FILE>gstvaapidisplay</FILE>
136 <TITLE>GstVaapiDisplay</TITLE>
137 GstVaapiDisplay
138 GstVaapiDisplayClass
139 gst_vaapi_display_new_with_display
140 gst_vaapi_display_lock
141 gst_vaapi_display_unlock
142 gst_vaapi_display_sync
143 gst_vaapi_display_flush
144 gst_vaapi_display_get_display
145 gst_vaapi_display_get_width
146 gst_vaapi_display_get_height
147 gst_vaapi_display_get_size
148 gst_vaapi_display_get_pixel_aspect_ratio
149 gst_vaapi_display_get_decode_caps
150 gst_vaapi_display_has_decoder
151 gst_vaapi_display_get_encode_caps
152 gst_vaapi_display_has_encoder
153 gst_vaapi_display_get_image_caps
154 gst_vaapi_display_has_image_format
155 gst_vaapi_display_get_subpicture_caps
156 gst_vaapi_display_has_subpicture_format
157 <SUBSECTION Standard>
158 GST_VAAPI_DISPLAY
159 GST_VAAPI_IS_DISPLAY
160 GST_VAAPI_TYPE_DISPLAY
161 gst_vaapi_display_get_type
162 GST_VAAPI_DISPLAY_CLASS
163 GST_VAAPI_IS_DISPLAY_CLASS
164 GST_VAAPI_DISPLAY_GET_CLASS
165 </SECTION>
166
167 <SECTION>
168 <FILE>gstvaapiimagepool</FILE>
169 <TITLE>GstVaapiImagePool</TITLE>
170 GstVaapiImagePool
171 GstVaapiImagePoolClass
172 gst_vaapi_image_pool_new
173 <SUBSECTION Standard>
174 GST_VAAPI_IMAGE_POOL
175 GST_VAAPI_IS_IMAGE_POOL
176 GST_VAAPI_TYPE_IMAGE_POOL
177 gst_vaapi_image_pool_get_type
178 GST_VAAPI_IMAGE_POOL_CLASS
179 GST_VAAPI_IS_IMAGE_POOL_CLASS
180 GST_VAAPI_IMAGE_POOL_GET_CLASS
181 </SECTION>
182
183 <SECTION>
184 <FILE>gstvaapivideobuffer</FILE>
185 <TITLE>GstVaapiVideoBuffer</TITLE>
186 GstVaapiVideoBuffer
187 GstVaapiVideoBufferClass
188 gst_vaapi_video_buffer_new
189 gst_vaapi_video_buffer_new_from_pool
190 gst_vaapi_video_buffer_new_with_image
191 gst_vaapi_video_buffer_new_with_surface
192 gst_vaapi_video_buffer_new_with_surface_proxy
193 gst_vaapi_video_buffer_get_display
194 gst_vaapi_video_buffer_get_image
195 gst_vaapi_video_buffer_set_image
196 gst_vaapi_video_buffer_set_image_from_pool
197 gst_vaapi_video_buffer_get_surface
198 gst_vaapi_video_buffer_get_surface_proxy
199 gst_vaapi_video_buffer_set_surface
200 gst_vaapi_video_buffer_set_surface_proxy
201 gst_vaapi_video_buffer_set_surface_from_pool
202 <SUBSECTION Standard>
203 GST_VAAPI_VIDEO_BUFFER
204 GST_VAAPI_IS_VIDEO_BUFFER
205 GST_VAAPI_TYPE_VIDEO_BUFFER
206 gst_vaapi_video_buffer_get_type
207 GST_VAAPI_VIDEO_BUFFER_CLASS
208 GST_VAAPI_IS_VIDEO_BUFFER_CLASS
209 GST_VAAPI_VIDEO_BUFFER_GET_CLASS
210 </SECTION>
211
212 <SECTION>
213 <FILE>gstvaapitypes</FILE>
214 <TITLE>Basic data structures</TITLE>
215 GstVaapiID
216 GST_VAAPI_ID_FORMAT
217 GST_VAAPI_ID_ARGS
218 GST_VAAPI_ID
219 GST_VAAPI_ID_NONE
220 GstVaapiPoint
221 GstVaapiRectangle
222 </SECTION>
223
224 <SECTION>
225 <FILE>gstvaapivalue</FILE>
226 <TITLE></TITLE>
227 GST_VAAPI_TYPE_ID
228 gst_vaapi_value_get_id
229 gst_vaapi_value_set_id
230 </SECTION>
231
232 <SECTION>
233 <FILE>gstvaapiparamspecs</FILE>
234 <TITLE></TITLE>
235 GstVaapiParamSpecID
236 gst_vaapi_param_spec_id
237 </SECTION>
238
239 <SECTION>
240 <FILE>gstvaapiwindow</FILE>
241 <TITLE>GstVaapiWindow</TITLE>
242 GstVaapiWindow
243 GstVaapiWindowClass
244 gst_vaapi_window_get_display
245 gst_vaapi_window_show
246 gst_vaapi_window_hide
247 gst_vaapi_window_get_fullscreen
248 gst_vaapi_window_set_fullscreen
249 gst_vaapi_window_get_width
250 gst_vaapi_window_get_height
251 gst_vaapi_window_get_size
252 gst_vaapi_window_set_width
253 gst_vaapi_window_set_height
254 gst_vaapi_window_set_size
255 gst_vaapi_window_put_surface
256 <SUBSECTION Standard>
257 GST_VAAPI_WINDOW
258 GST_VAAPI_IS_WINDOW
259 GST_VAAPI_TYPE_WINDOW
260 gst_vaapi_window_get_type
261 GST_VAAPI_WINDOW_CLASS
262 GST_VAAPI_IS_WINDOW_CLASS
263 GST_VAAPI_WINDOW_GET_CLASS
264 </SECTION>
265
266 <SECTION>
267 <FILE>gstvaapiobject</FILE>
268 <TITLE>GstVaapiObject</TITLE>
269 GstVaapiObject
270 GstVaapiObjectClass
271 gst_vaapi_object_get_display
272 gst_vaapi_object_lock_display
273 gst_vaapi_object_unlock_display
274 gst_vaapi_object_get_id
275 <SUBSECTION Standard>
276 GST_VAAPI_OBJECT
277 GST_VAAPI_IS_OBJECT
278 GST_VAAPI_TYPE_OBJECT
279 gst_vaapi_object_get_type
280 GST_VAAPI_OBJECT_CLASS
281 GST_VAAPI_IS_OBJECT_CLASS
282 GST_VAAPI_OBJECT_GET_CLASS
283 </SECTION>
284
285 <SECTION>
286 <FILE>gstvaapiimage</FILE>
287 GST_VAAPI_IMAGE_FORMAT
288 GST_VAAPI_IMAGE_WIDTH
289 GST_VAAPI_IMAGE_HEIGHT
290 <TITLE>GstVaapiImage</TITLE>
291 GstVaapiImage
292 GstVaapiImageClass
293 gst_vaapi_image_new
294 gst_vaapi_image_new_with_image
295 gst_vaapi_image_get_id
296 gst_vaapi_image_get_image
297 gst_vaapi_image_get_format
298 gst_vaapi_image_get_width
299 gst_vaapi_image_get_height
300 gst_vaapi_image_get_size
301 gst_vaapi_image_is_linear
302 gst_vaapi_image_is_mapped
303 gst_vaapi_image_map
304 gst_vaapi_image_unmap
305 gst_vaapi_image_get_plane_count
306 gst_vaapi_image_get_plane
307 gst_vaapi_image_get_pitch
308 gst_vaapi_image_get_data_size
309 gst_vaapi_image_update_from_buffer
310 <SUBSECTION Standard>
311 GST_VAAPI_IMAGE
312 GST_VAAPI_IS_IMAGE
313 GST_VAAPI_TYPE_IMAGE
314 gst_vaapi_image_get_type
315 GST_VAAPI_IMAGE_CLASS
316 GST_VAAPI_IS_IMAGE_CLASS
317 GST_VAAPI_IMAGE_GET_CLASS
318 </SECTION>
319
320 <SECTION>
321 <FILE>gstvaapisurface</FILE>
322 GstVaapiChromaType
323 GstVaapiSurfaceStatus
324 GstVaapiSurfaceRenderFlags
325 <TITLE>GstVaapiSurface</TITLE>
326 GstVaapiSurface
327 GstVaapiSurfaceClass
328 gst_vaapi_surface_new
329 gst_vaapi_surface_get_id
330 gst_vaapi_surface_get_chroma_type
331 gst_vaapi_surface_get_width
332 gst_vaapi_surface_get_height
333 gst_vaapi_surface_get_size
334 gst_vaapi_surface_derive_image
335 gst_vaapi_surface_get_image
336 gst_vaapi_surface_put_image
337 gst_vaapi_surface_associate_subpicture
338 gst_vaapi_surface_deassociate_subpicture
339 gst_vaapi_surface_sync
340 gst_vaapi_surface_query_status
341 <SUBSECTION Standard>
342 GST_VAAPI_SURFACE
343 GST_VAAPI_IS_SURFACE
344 GST_VAAPI_TYPE_SURFACE
345 gst_vaapi_surface_get_type
346 GST_VAAPI_SURFACE_CLASS
347 GST_VAAPI_IS_SURFACE_CLASS
348 GST_VAAPI_SURFACE_GET_CLASS
349 </SECTION>
350
351 <SECTION>
352 <FILE>gstvaapisubpicture</FILE>
353 <TITLE>GstVaapiSubpicture</TITLE>
354 GstVaapiSubpicture
355 GstVaapiSubpictureClass
356 gst_vaapi_subpicture_new
357 gst_vaapi_subpicture_get_id
358 gst_vaapi_subpicture_get_image
359 gst_vaapi_subpicture_set_image
360 <SUBSECTION Standard>
361 GST_VAAPI_SUBPICTURE
362 GST_VAAPI_IS_SUBPICTURE
363 GST_VAAPI_TYPE_SUBPICTURE
364 gst_vaapi_subpicture_get_type
365 GST_VAAPI_SUBPICTURE_CLASS
366 GST_VAAPI_IS_SUBPICTURE_CLASS
367 GST_VAAPI_SUBPICTURE_GET_CLASS
368 </SECTION>
369
370 <SECTION>
371 <FILE>gstvaapiimageformat</FILE>
372 <TITLE>GstVaapiImageFormat</TITLE>
373 GstVaapiImageFormat
374 gst_vaapi_image_format_is_rgb
375 gst_vaapi_image_format_is_yuv
376 gst_vaapi_image_format
377 gst_vaapi_image_format_from_caps
378 gst_vaapi_image_format_from_fourcc
379 gst_vaapi_image_format_get_va_format
380 gst_vaapi_image_format_get_caps
381 gst_vaapi_image_format_get_score
382 </SECTION>
383
384 <SECTION>
385 <FILE>gstvaapiprofile</FILE>
386 <TITLE>GstVaapiProfile</TITLE>
387 GstVaapiCodec
388 GstVaapiProfile
389 GstVaapiEntrypoint
390 gst_vaapi_profile
391 gst_vaapi_profile_from_caps
392 gst_vaapi_profile_get_va_profile
393 gst_vaapi_profile_get_caps
394 gst_vaapi_profile_get_codec
395 gst_vaapi_entrypoint
396 gst_vaapi_entrypoint_get_va_entrypoint
397 </SECTION>
398
399 <SECTION>
400 <FILE>gstvaapitexture</FILE>
401 <TITLE>GstVaapiTexture</TITLE>
402 GstVaapiTexture
403 GstVaapiTextureClass
404 gst_vaapi_texture_new
405 gst_vaapi_texture_new_with_texture
406 gst_vaapi_texture_get_id
407 gst_vaapi_texture_get_target
408 gst_vaapi_texture_get_format
409 gst_vaapi_texture_get_width
410 gst_vaapi_texture_get_height
411 gst_vaapi_texture_get_size
412 gst_vaapi_texture_put_surface
413 <SUBSECTION Standard>
414 GST_VAAPI_TEXTURE
415 GST_VAAPI_IS_TEXTURE
416 GST_VAAPI_TYPE_TEXTURE
417 gst_vaapi_texture_get_type
418 GST_VAAPI_TEXTURE_CLASS
419 GST_VAAPI_IS_TEXTURE_CLASS
420 GST_VAAPI_TEXTURE_GET_CLASS
421 </SECTION>
422
423 <SECTION>
424 <FILE>gstvaapicontext</FILE>
425 <TITLE>GstVaapiContext</TITLE>
426 GstVaapiContext
427 GstVaapiContextClass
428 gst_vaapi_context_new
429 gst_vaapi_context_reset
430 gst_vaapi_context_get_id
431 gst_vaapi_context_get_profile
432 gst_vaapi_context_set_profile
433 gst_vaapi_context_get_entrypoint
434 gst_vaapi_context_get_size
435 gst_vaapi_context_get_surface
436 gst_vaapi_context_get_surface_count
437 gst_vaapi_context_put_surface
438 gst_vaapi_context_find_surface_by_id
439 <SUBSECTION Standard>
440 GST_VAAPI_CONTEXT
441 GST_VAAPI_IS_CONTEXT
442 GST_VAAPI_TYPE_CONTEXT
443 gst_vaapi_context_get_type
444 GST_VAAPI_CONTEXT_CLASS
445 GST_VAAPI_IS_CONTEXT_CLASS
446 GST_VAAPI_CONTEXT_GET_CLASS
447 </SECTION>
448
449 <SECTION>
450 <FILE>gstvaapidecoder</FILE>
451 GstVaapiDecoderStatus
452 <TITLE>GstVaapiDecoder</TITLE>
453 GstVaapiDecoder
454 GstVaapiDecoderClass
455 gst_vaapi_decoder_put_buffer
456 gst_vaapi_decoder_get_surface
457 <SUBSECTION Standard>
458 GST_VAAPI_DECODER
459 GST_VAAPI_IS_DECODER
460 GST_VAAPI_TYPE_DECODER
461 gst_vaapi_decoder_get_type
462 GST_VAAPI_DECODER_CLASS
463 GST_VAAPI_IS_DECODER_CLASS
464 GST_VAAPI_DECODER_GET_CLASS
465 </SECTION>
466
467 <SECTION>
468 <FILE>gstvaapidecoder_ffmpeg</FILE>
469 <TITLE>GstVaapiDecoderFfmpeg</TITLE>
470 GstVaapiDecoderFfmpeg
471 GstVaapiDecoderFfmpegClass
472 gst_vaapi_decoder_ffmpeg_new
473 <SUBSECTION Standard>
474 GST_VAAPI_DECODER_FFMPEG
475 GST_VAAPI_IS_DECODER_FFMPEG
476 GST_VAAPI_TYPE_DECODER_FFMPEG
477 gst_vaapi_decoder_ffmpeg_get_type
478 GST_VAAPI_DECODER_FFMPEG_CLASS
479 GST_VAAPI_IS_DECODER_FFMPEG_CLASS
480 GST_VAAPI_DECODER_FFMPEG_GET_CLASS
481 </SECTION>
482
483 <SECTION>
484 <FILE>gstvaapisurfaceproxy</FILE>
485 <TITLE>GstVaapiSurfaceProxy</TITLE>
486 GstVaapiSurfaceProxy
487 GstVaapiSurfaceProxyClass
488 gst_vaapi_surface_proxy_new
489 gst_vaapi_surface_proxy_get_context
490 gst_vaapi_surface_proxy_set_context
491 gst_vaapi_surface_proxy_get_surface
492 gst_vaapi_surface_proxy_set_surface
493 gst_vaapi_surface_proxy_get_timestamp
494 gst_vaapi_surface_proxy_set_timestamp
495 <SUBSECTION Standard>
496 GST_VAAPI_SURFACE_PROXY
497 GST_VAAPI_IS_SURFACE_PROXY
498 GST_VAAPI_TYPE_SURFACE_PROXY
499 gst_vaapi_surface_proxy_get_type
500 GST_VAAPI_SURFACE_PROXY_CLASS
501 GST_VAAPI_IS_SURFACE_PROXY_CLASS
502 GST_VAAPI_SURFACE_PROXY_GET_CLASS
503 </SECTION>