summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-06-21 06:40:19 +0200
committerAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-06-22 12:20:12 +0200
commit45ddf06f54915bfcfb6bdfa8b983f4fdbf7bf4dc (patch)
tree394713604f3282a6422d6cb595fb961c5ed867fb
parentb054a3a2168fa404e4e59b190a70682b9508d983 (diff)
avcodec/packet: Improve documentation of av_packet_get_side_data
Document that it also sets the size in case the desired side data is absent (if the pointer has been supplied). Reviewed-by: Anton Khirnov <anton@khirnov.net> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
-rw-r--r--libavcodec/packet.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libavcodec/packet.h b/libavcodec/packet.h
index 41485f4527..96f237f091 100644
--- a/libavcodec/packet.h
+++ b/libavcodec/packet.h
@@ -580,7 +580,8 @@ int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
*
* @param pkt packet
* @param type desired side information type
- * @param size pointer for side information size to store (optional)
+ * @param size If supplied, *size will be set to the size of the side data
+ * or to zero if the desired side data is not present.
* @return pointer to data if present or NULL otherwise
*/
uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,