mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-22 09:41:07 +00:00
Code Issues 1 Projects Releases Wiki Activity

codecparsers: Fix gtk-doc

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7455>
This commit is contained in:
Edward Hervey 2024-09-04 17:57:08 +02:00 committed by GStreamer Marge Bot
parent fb2077061f
commit 8bc8aedc62
4 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gstav1parser.c
View file

@ -41,21 +41,21 @@
* Then, depending on the #GstAV1OBUType of the newly parsed #GstAV1OBU, * Then, depending on the #GstAV1OBUType of the newly parsed #GstAV1OBU,
* you should call the differents functions to parse the structure details: * you should call the differents functions to parse the structure details:
* *
* * #GST_AV1_OBU_SEQUENCE_HEADER: gst_av1_parser_parse_sequence_header_obu() * * %GST_AV1_OBU_SEQUENCE_HEADER: gst_av1_parser_parse_sequence_header_obu()
* *
* * #GST_AV1_OBU_TEMPORAL_DELIMITER: gst_av1_parser_parse_temporal_delimiter_obu() * * %GST_AV1_OBU_TEMPORAL_DELIMITER: gst_av1_parser_parse_temporal_delimiter_obu()
* *
* * #GST_AV1_OBU_FRAME: gst_av1_parser_parse_frame_obu() * * %GST_AV1_OBU_FRAME: gst_av1_parser_parse_frame_obu()
* *
* * #GST_AV1_OBU_FRAME_HEADER: gst_av1_parser_parse_frame_header_obu() * * %GST_AV1_OBU_FRAME_HEADER: gst_av1_parser_parse_frame_header_obu()
* *
* * #GST_AV1_OBU_TILE_GROUP: gst_av1_parser_parse_tile_group_obu() * * %GST_AV1_OBU_TILE_GROUP: gst_av1_parser_parse_tile_group_obu()
* *
* * #GST_AV1_OBU_METADATA: gst_av1_parser_parse_metadata_obu() * * %GST_AV1_OBU_METADATA: gst_av1_parser_parse_metadata_obu()
* *
* * #GST_AV1_OBU_REDUNDANT_FRAME_HEADER: gst_av1_parser_parse_frame_header_obu() * * %GST_AV1_OBU_REDUNDANT_FRAME_HEADER: gst_av1_parser_parse_frame_header_obu()
* *
* * #GST_AV1_OBU_TILE_LIST: gst_av1_parser_parse_tile_list_obu() * * %GST_AV1_OBU_TILE_LIST: gst_av1_parser_parse_tile_list_obu()
* *
* Note: Some parser functions are dependent on information provided in the sequence * Note: Some parser functions are dependent on information provided in the sequence
* header and reference frame's information. It maintains a state inside itself, which * header and reference frame's information. It maintains a state inside itself, which

6
subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gstav1parser.h
View file

@ -1408,7 +1408,7 @@ struct _GstAV1FilmGrainParams {
* GstAV1FrameHeaderOBU: * GstAV1FrameHeaderOBU:
* @show_existing_frame: equal to 1, indicates the frame indexed by @frame_to_show_map_idx is * @show_existing_frame: equal to 1, indicates the frame indexed by @frame_to_show_map_idx is
* to be output; @show_existing_frame equal to 0 indicates that further processing is required. * to be output; @show_existing_frame equal to 0 indicates that further processing is required.
* If @obu_type is equal to #GST_AV1_OBU_FRAME, it is a requirement of bitstream conformance that * If @obu_type is equal to %GST_AV1_OBU_FRAME, it is a requirement of bitstream conformance that
* @show_existing_frame is equal to 0. * @show_existing_frame is equal to 0.
* @frame_to_show_map_idx: specifies the frame to be output. It is only available if * @frame_to_show_map_idx: specifies the frame to be output. It is only available if
* @show_existing_frame is 1. * @show_existing_frame is 1.
@ -1466,7 +1466,7 @@ struct _GstAV1FilmGrainParams {
* is the remainder of a modulo 1 << ( @buffer_removal_time_length_minus_1 + 1 ) counter. * is the remainder of a modulo 1 << ( @buffer_removal_time_length_minus_1 + 1 ) counter.
* @refresh_frame_flags: contains a bitmask that specifies which reference frame slots will be * @refresh_frame_flags: contains a bitmask that specifies which reference frame slots will be
* updated with the current frame after it is decoded. If @frame_type is equal to * updated with the current frame after it is decoded. If @frame_type is equal to
* #GST_AV1_INTRA_ONLY_FRAME, it is a requirement of bitstream conformance that * %GST_AV1_INTRA_ONLY_FRAME, it is a requirement of bitstream conformance that
* @refresh_frame_flags is not equal to 0xff. * @refresh_frame_flags is not equal to 0xff.
* @ref_order_hint: specifies the expected output order hint for each reference buffer. * @ref_order_hint: specifies the expected output order hint for each reference buffer.
* @allow_intrabc: equal to 1 indicates that intra block copy may be used in this frame. * @allow_intrabc: equal to 1 indicates that intra block copy may be used in this frame.
@ -1723,7 +1723,7 @@ struct _GstAV1TileGroupOBUEntry {
* GstAV1TileGroupOBU: * GstAV1TileGroupOBU:
* @tile_start_and_end_present_flag: specifies whether @tg_start and @tg_end are present * @tile_start_and_end_present_flag: specifies whether @tg_start and @tg_end are present
* in the bitstream. If @tg_start and @tg_end are not present in the bitstream, this * in the bitstream. If @tg_start and @tg_end are not present in the bitstream, this
* tile group covers the entire frame. If @obu_type is equal to #GST_AV1_OBU_FRAME, it is a * tile group covers the entire frame. If @obu_type is equal to %GST_AV1_OBU_FRAME, it is a
* requirement of bitstream conformance that the value of @tile_start_and_end_present_flag * requirement of bitstream conformance that the value of @tile_start_and_end_present_flag
* is equal to 0. * is equal to 0.
* @tg_start: specifies the zero-based index of the first tile in the current tile group. * @tg_start: specifies the zero-based index of the first tile in the current tile group.

16
subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gsth264parser.c
View file

@ -44,13 +44,13 @@
* The following functions are then available for parsing the structure of the * The following functions are then available for parsing the structure of the
* #GstH264NalUnit, depending on the #GstH264NalUnitType: * #GstH264NalUnit, depending on the #GstH264NalUnitType:
* *
* * From #GST_H264_NAL_SLICE to #GST_H264_NAL_SLICE_IDR: #gst_h264_parser_parse_slice_hdr * * From %GST_H264_NAL_SLICE to %GST_H264_NAL_SLICE_IDR: #gst_h264_parser_parse_slice_hdr
* *
* * #GST_H264_NAL_SEI: #gst_h264_parser_parse_sei * * %GST_H264_NAL_SEI: #gst_h264_parser_parse_sei
* *
* * #GST_H264_NAL_SPS: #gst_h264_parser_parse_sps * * %GST_H264_NAL_SPS: #gst_h264_parser_parse_sps
* *
* * #GST_H264_NAL_PPS: #gst_h264_parser_parse_pps * * %GST_H264_NAL_PPS: #gst_h264_parser_parse_pps
* *
* * Any other: #gst_h264_parser_parse_nal * * Any other: #gst_h264_parser_parse_nal
* *
@ -2249,7 +2249,7 @@ error:
/** /**
* gst_h264_parse_pps: * gst_h264_parse_pps:
* @nalparser: a #GstH264NalParser * @nalparser: a #GstH264NalParser
* @nalu: The #GST_H264_NAL_PPS #GstH264NalUnit to parse * @nalu: The %GST_H264_NAL_PPS #GstH264NalUnit to parse
* @pps: The #GstH264PPS to fill. * @pps: The #GstH264PPS to fill.
* *
* Parses @data, and fills the @pps structure. * Parses @data, and fills the @pps structure.
@ -2384,7 +2384,7 @@ error:
/** /**
* gst_h264_parser_parse_pps: * gst_h264_parser_parse_pps:
* @nalparser: a #GstH264NalParser * @nalparser: a #GstH264NalParser
* @nalu: The #GST_H264_NAL_PPS #GstH264NalUnit to parse * @nalu: The %GST_H264_NAL_PPS #GstH264NalUnit to parse
* @pps: The #GstH264PPS to fill. * @pps: The #GstH264PPS to fill.
* *
* Parses @nalu containing a Picture Parameter Set, and fills @pps. * Parses @nalu containing a Picture Parameter Set, and fills @pps.
@ -2431,7 +2431,7 @@ gst_h264_pps_clear (GstH264PPS * pps)
/** /**
* gst_h264_parser_parse_slice_hdr: * gst_h264_parser_parse_slice_hdr:
* @nalparser: a #GstH264NalParser * @nalparser: a #GstH264NalParser
* @nalu: The #GST_H264_NAL_SLICE to #GST_H264_NAL_SLICE_IDR #GstH264NalUnit to parse * @nalu: The %GST_H264_NAL_SLICE to %GST_H264_NAL_SLICE_IDR #GstH264NalUnit to parse
* @slice: The #GstH264SliceHdr to fill. * @slice: The #GstH264SliceHdr to fill.
* @parse_pred_weight_table: Whether to parse the pred_weight_table or not * @parse_pred_weight_table: Whether to parse the pred_weight_table or not
* @parse_dec_ref_pic_marking: Whether to parse the dec_ref_pic_marking or not * @parse_dec_ref_pic_marking: Whether to parse the dec_ref_pic_marking or not
@ -2712,7 +2712,7 @@ gst_h264_sei_clear (GstH264SEIMessage * sei)
/** /**
* gst_h264_parser_parse_sei: * gst_h264_parser_parse_sei:
* @nalparser: a #GstH264NalParser * @nalparser: a #GstH264NalParser
* @nalu: The #GST_H264_NAL_SEI #GstH264NalUnit to parse * @nalu: The %GST_H264_NAL_SEI #GstH264NalUnit to parse
* @messages: The GArray of #GstH264SEIMessage to fill. The caller must free it when done. * @messages: The GArray of #GstH264SEIMessage to fill. The caller must free it when done.
* *
* Parses @nalu containing one or more Supplementary Enhancement Information messages, * Parses @nalu containing one or more Supplementary Enhancement Information messages,

20
subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gsth265parser.c
View file

@ -37,15 +37,15 @@
* Then, depending on the #GstH265NalUnitType of the newly parsed #GstH265NalUnit, * Then, depending on the #GstH265NalUnitType of the newly parsed #GstH265NalUnit,
* you should call the differents functions to parse the structure: * you should call the differents functions to parse the structure:
* *
* * From #GST_H265_NAL_SLICE_TRAIL_N to #GST_H265_NAL_SLICE_CRA_NUT: gst_h265_parser_parse_slice_hdr() * * From %GST_H265_NAL_SLICE_TRAIL_N to %GST_H265_NAL_SLICE_CRA_NUT: gst_h265_parser_parse_slice_hdr()
* *
* * `GST_H265_NAL_*_SEI`: gst_h265_parser_parse_sei() * * `GST_H265_NAL_*_SEI`: gst_h265_parser_parse_sei()
* *
* * #GST_H265_NAL_VPS: gst_h265_parser_parse_vps() * * %GST_H265_NAL_VPS: gst_h265_parser_parse_vps()
* *
* * #GST_H265_NAL_SPS: gst_h265_parser_parse_sps() * * %GST_H265_NAL_SPS: gst_h265_parser_parse_sps()
* *
* * #GST_H265_NAL_PPS: #gst_h265_parser_parse_pps() * * %GST_H265_NAL_PPS: #gst_h265_parser_parse_pps()
* *
* * Any other: gst_h265_parser_parse_nal() * * Any other: gst_h265_parser_parse_nal()
* *
@ -1832,7 +1832,7 @@ gst_h265_parser_parse_nal (GstH265Parser * parser, GstH265NalUnit * nalu)
/** /**
* gst_h265_parser_parse_vps: * gst_h265_parser_parse_vps:
* @parser: a #GstH265Parser * @parser: a #GstH265Parser
* @nalu: The #GST_H265_NAL_VPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_VPS #GstH265NalUnit to parse
* @vps: The #GstH265VPS to fill. * @vps: The #GstH265VPS to fill.
* *
* Parses @data, and fills the @vps structure. * Parses @data, and fills the @vps structure.
@ -1857,7 +1857,7 @@ gst_h265_parser_parse_vps (GstH265Parser * parser, GstH265NalUnit * nalu,
/** /**
* gst_h265_parse_vps: * gst_h265_parse_vps:
* @nalu: The #GST_H265_NAL_VPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_VPS #GstH265NalUnit to parse
* @sps: The #GstH265VPS to fill. * @sps: The #GstH265VPS to fill.
* *
* Parses @data, and fills the @vps structure. * Parses @data, and fills the @vps structure.
@ -2002,7 +2002,7 @@ error:
/** /**
* gst_h265_parser_parse_sps: * gst_h265_parser_parse_sps:
* @parser: a #GstH265Parser * @parser: a #GstH265Parser
* @nalu: The #GST_H265_NAL_SPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_SPS #GstH265NalUnit to parse
* @sps: The #GstH265SPS to fill. * @sps: The #GstH265SPS to fill.
* @parse_vui_params: Whether to parse the vui_params or not * @parse_vui_params: Whether to parse the vui_params or not
* *
@ -2030,7 +2030,7 @@ gst_h265_parser_parse_sps (GstH265Parser * parser, GstH265NalUnit * nalu,
/** /**
* gst_h265_parse_sps: * gst_h265_parse_sps:
* parser: The #GstH265Parser * parser: The #GstH265Parser
* @nalu: The #GST_H265_NAL_SPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_SPS #GstH265NalUnit to parse
* @sps: The #GstH265SPS to fill. * @sps: The #GstH265SPS to fill.
* @parse_vui_params: Whether to parse the vui_params or not * @parse_vui_params: Whether to parse the vui_params or not
* *
@ -2293,7 +2293,7 @@ error:
/** /**
* gst_h265_parse_pps: * gst_h265_parse_pps:
* @parser: a #GstH265Parser * @parser: a #GstH265Parser
* @nalu: The #GST_H265_NAL_PPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_PPS #GstH265NalUnit to parse
* @pps: The #GstH265PPS to fill. * @pps: The #GstH265PPS to fill.
* *
* Parses @data, and fills the @pps structure. * Parses @data, and fills the @pps structure.
@ -2612,7 +2612,7 @@ error:
/** /**
* gst_h265_parser_parse_pps: * gst_h265_parser_parse_pps:
* @parser: a #GstH265Parser * @parser: a #GstH265Parser
* @nalu: The #GST_H265_NAL_PPS #GstH265NalUnit to parse * @nalu: The %GST_H265_NAL_PPS #GstH265NalUnit to parse
* @pps: The #GstH265PPS to fill. * @pps: The #GstH265PPS to fill.
* *
* Parses @data, and fills the @pps structure. * Parses @data, and fills the @pps structure.