gir: update gir about aggregate params and pool

1) update aggregate params gir
2) update gstbufferpool gir

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7201>
This commit is contained in:
Qian Hu (胡骞) 2024-11-19 10:01:15 +08:00 committed by GStreamer Marge Bot
parent 1d45fbc56b
commit e7f0bc15f3
2 changed files with 111 additions and 3 deletions

View file

@ -101,6 +101,30 @@ See also #GstBufferMapInfo.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstallocator.h"/>
<type name="utf8" c:type="gchar*"/>
</constant>
<callback name="AllocationMetaParamsAggregator" c:type="GstAllocationMetaParamsAggregator" version="1.26">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.h">The aggregator function will combine the parameters from @params0 and @param1
and write the result back into @aggregated_params.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.h">%TRUE if the parameters were successfully aggregated, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="aggregated_params" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.h">This structure will be updated with the
combined parameters from both @params0 and @params1.</doc>
<type name="Structure" c:type="GstStructure**"/>
</parameter>
<parameter name="params0" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.h">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
<parameter name="params1" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.h">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</callback>
<record name="AllocationParams" c:type="GstAllocationParams" glib:type-name="GstAllocationParams" glib:get-type="gst_allocation_params_get_type" c:symbol-prefix="allocation_params">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstallocator.h">Parameters to control the allocation of memory</doc>
<source-position filename="../subprojects/gstreamer/gst/gstallocator.h"/>
@ -27199,6 +27223,37 @@ to remember the size of previous data to preallocate the next.</doc>
</parameter>
</parameters>
</method>
<function name="api_type_aggregate_params" c:identifier="gst_meta_api_type_aggregate_params" version="1.26">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">When a element like `tee` decides the allocation, each downstream element may
fill different parameters and pass them to gst_query_add_allocation_meta().
In order to keep these parameters, a merge operation is needed. This
aggregate function can combine the parameters from @params0 and @param1, and
write the result back into @aggregated_params.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">%TRUE if the parameters were successfully aggregated, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="api" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">the GType of the API for which the parameters are being aggregated.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="aggregated_params" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">This structure will be updated with the
combined parameters from both @params0 and @params1.</doc>
<type name="Structure" c:type="GstStructure**"/>
</parameter>
<parameter name="params0" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
<parameter name="params1" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="api_type_get_tags" c:identifier="gst_meta_api_type_get_tags" version="1.2">
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">
@ -27253,6 +27308,24 @@ to remember the size of previous data to preallocate the next.</doc>
</parameter>
</parameters>
</function>
<function name="api_type_set_params_aggregator" c:identifier="gst_meta_api_type_set_params_aggregator" version="1.26" introspectable="0">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">This function sets the aggregator function for a specific API type.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="api" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">the #GType of the API for which the aggregator function is being set.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="aggregator" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">the aggregator function to be associated with the given API
type.</doc>
<type name="AllocationMetaParamsAggregator" c:type="GstAllocationMetaParamsAggregator"/>
</parameter>
</parameters>
</function>
<function name="deserialize" c:identifier="gst_meta_deserialize" version="1.24">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">Recreate a #GstMeta from serialized data returned by
gst_meta_serialize() and add it to @buffer.
@ -55136,6 +55209,37 @@ of @new_message.</doc>
</parameter>
</parameters>
</function>
<function name="meta_api_type_aggregate_params" c:identifier="gst_meta_api_type_aggregate_params" moved-to="Meta.api_type_aggregate_params" version="1.26">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">When a element like `tee` decides the allocation, each downstream element may
fill different parameters and pass them to gst_query_add_allocation_meta().
In order to keep these parameters, a merge operation is needed. This
aggregate function can combine the parameters from @params0 and @param1, and
write the result back into @aggregated_params.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">%TRUE if the parameters were successfully aggregated, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="api" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">the GType of the API for which the parameters are being aggregated.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="aggregated_params" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">This structure will be updated with the
combined parameters from both @params0 and @params1.</doc>
<type name="Structure" c:type="GstStructure**"/>
</parameter>
<parameter name="params0" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
<parameter name="params1" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstmeta.c">a #GstStructure containing the new parameters to be aggregated.</doc>
<type name="Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="meta_api_type_get_tags" c:identifier="gst_meta_api_type_get_tags" moved-to="Meta.api_type_get_tags" version="1.2">
<source-position filename="../subprojects/gstreamer/gst/gstmeta.h"/>
<return-value transfer-ownership="none">

View file

@ -12344,8 +12344,12 @@ fields:
- padding-bottom (uint): extra pixels on the bottom
- padding-left (uint): extra pixels on the left side
- padding-right (uint): extra pixels on the right side
The padding fields have the same semantic as #GstVideoMeta.alignment
and so represent the paddings requested on produced video buffers.
- stride-align0 (uint): stride align requirements for plane 0
- stride-align1 (uint): stride align requirements for plane 1
- stride-align2 (uint): stride align requirements for plane 2
- stride-align3 (uint): stride align requirements for plane 3
The padding and stride-align fields have the same semantic as #GstVideoMeta.alignment
and so represent the paddings and stride-align requested on produced video buffers.
Since 1.24 it can be serialized using gst_meta_serialize() and
gst_meta_deserialize().</doc>
@ -17021,7 +17025,7 @@ in @align</doc>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/video/gstvideopool.c">a #GstStructure</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
<parameter name="align" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/video/gstvideopool.c">a #GstVideoAlignment</doc>