summaryrefslogtreecommitdiff
path: root/gst-libs
diff options
context:
space:
mode:
Diffstat (limited to 'gst-libs')
-rw-r--r--gst-libs/gst/codecparsers/gstmpegvideoparser.c9
-rw-r--r--gst-libs/gst/codecparsers/gstmpegvideoparser.h10
2 files changed, 12 insertions, 7 deletions
diff --git a/gst-libs/gst/codecparsers/gstmpegvideoparser.c b/gst-libs/gst/codecparsers/gstmpegvideoparser.c
index af3191154..42654eed4 100644
--- a/gst-libs/gst/codecparsers/gstmpegvideoparser.c
+++ b/gst-libs/gst/codecparsers/gstmpegvideoparser.c
@@ -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,
diff --git a/gst-libs/gst/codecparsers/gstmpegvideoparser.h b/gst-libs/gst/codecparsers/gstmpegvideoparser.h
index 63267ce7a..c816b2ed3 100644
--- a/gst-libs/gst/codecparsers/gstmpegvideoparser.h
+++ b/gst-libs/gst/codecparsers/gstmpegvideoparser.h
@@ -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
*/