changeset 4416:e059726dfb1b libavformat

document ff_audio_interleave
author bcoudurier
date Sun, 08 Feb 2009 21:08:34 +0000
parents e0da6eba9942
children de5ccc7a4461
files audiointerleave.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/audiointerleave.h	Sun Feb 08 18:50:32 2009 +0000
+++ b/audiointerleave.h	Sun Feb 08 21:08:34 2009 +0000
@@ -42,6 +42,15 @@
 int ff_interleave_compare_dts(AVFormatContext *s, AVPacket *next, AVPacket *pkt);
 int ff_interleave_new_audio_packet(AVFormatContext *s, AVPacket *pkt,
                                    int stream_index, int flush);
+/**
+ * Rechunk audio pcm packets per AudioInterleaveContext->samples_per_frame
+ * and interleave them correctly.
+ * AVStream->priv_data first element must be AudioInterleaveContext
+ * when using this function.
+ *
+ * @param get_packet function will output a packet when streams are correctly interleaved.
+ * @param compare_ts function will compare AVPackets and decide interleaving order.
+ */
 int ff_audio_interleave(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush,
                         int (*get_packet)(AVFormatContext *, AVPacket *, AVPacket *, int),
                         int (*compare_ts)(AVFormatContext *, AVPacket *, AVPacket *));