mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-24 17:20:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

codecparsers: mpegvideoparser: minor doc fixes

Browse source
This commit is contained in:
Tim-Philipp Müller 2013-08-13 17:45:51 +01:00
parent 1b1332cb6d
commit 4200946cf1
2 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
gst-libs/gst/codecparsers/gstmpegvideoparser.c
View file

@ -238,14 +238,17 @@ scan_for_start_codes (const GstByteReader * reader, guint offset, guint size)
/**
* gst_mpeg_video_parse:
* @packet: a #GstMpegVideoPacket to fill with the data and offset of the
* next packet found
* @data: The data to parse
* @size: The size of @data
* @offset: The offset from which to start parsing
*
* Parses the MPEG 1/2 video bitstream contained in @data , and returns the
* detect packets as a list of #GstMpegVideoTypeOffsetSize.
* Parses the MPEG 1/2 video bitstream contained in @data, and returns the
* offset, and if known also the size, in @packet. This function will scan
* the data to find the next packet if needed.
*
* Returns: TRUE if a packet start code was found
* Returns: TRUE if a packet start code was found, otherwise FALSE.
*/
gboolean
gst_mpeg_video_parse (GstMpegVideoPacket * packet,

10
gst-libs/gst/codecparsers/gstmpegvideoparser.h
View file

@ -466,11 +466,13 @@ struct _GstMpegVideoSliceHdr
};
/**
* GstMpegVideoTypeOffsetSize:
* @type: the type of the packet that start at @offset
* GstMpegVideoPacket:
* @type: the type of the packet that start at @offset, as a #GstMpegVideoPacketTypeCode
* @data: the data containing the packet starting at @offset
* @offset: the offset of the packet start in bytes, it is the exact, start of the packet, no sync code included
* @size: The size in bytes of the packet or -1 if the end wasn't found. It is the exact size of the packet, no sync code included
* @offset: the offset of the packet start in bytes from @data. This is the
* start of the packet itself without the sync code
* @size: The size in bytes of the packet or -1 if the end wasn't found. This
* is the size of the packet itself without the sync code
*
* A structure that contains the type of a packet, its offset and its size
*/