# HG changeset patch
# User bcoudurier
# Date 1234127314 0
# Node ID e059726dfb1be05b6962c6b9de4d035f7d1bf5a3
# Parent  e0da6eba9942a6659972c67fc4d616842795fdea
document ff_audio_interleave

diff -r e0da6eba9942 -r e059726dfb1b audiointerleave.h
--- 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 *));