document ff_audio_interleave
[ffmpeg.git] / libavformat / audiointerleave.h
1 /*
2  * Audio Interleaving prototypes and declarations
3  *
4  * Copyright (c) 2009 Baptiste Coudurier <baptiste dot coudurier at gmail dot com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef AVFORMAT_AUDIOINTERLEAVE_H
24 #define AVFORMAT_AUDIOINTERLEAVE_H
25
26 #include "libavutil/fifo.h"
27 #include "avformat.h"
28
29 typedef struct {
30     AVFifoBuffer fifo;
31     unsigned fifo_size;           ///< current fifo size allocated
32     uint64_t dts;                 ///< current dts
33     int sample_size;              ///< size of one sample all channels included
34     const int *samples_per_frame; ///< must be 0 terminated
35     const int *samples;           ///< current samples per frame, pointer to samples_per_frame
36     AVRational time_base;         ///< time base of output audio packets
37 } AudioInterleaveContext;
38
39 int ff_audio_interleave_init(AVFormatContext *s, const int *samples_per_frame, AVRational time_base);
40 void ff_audio_interleave_close(AVFormatContext *s);
41
42 int ff_interleave_compare_dts(AVFormatContext *s, AVPacket *next, AVPacket *pkt);
43 int ff_interleave_new_audio_packet(AVFormatContext *s, AVPacket *pkt,
44                                    int stream_index, int flush);
45 /**
46  * Rechunk audio pcm packets per AudioInterleaveContext->samples_per_frame
47  * and interleave them correctly.
48  * AVStream->priv_data first element must be AudioInterleaveContext
49  * when using this function.
50  *
51  * @param get_packet function will output a packet when streams are correctly interleaved.
52  * @param compare_ts function will compare AVPackets and decide interleaving order.
53  */
54 int ff_audio_interleave(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush,
55                         int (*get_packet)(AVFormatContext *, AVPacket *, AVPacket *, int),
56                         int (*compare_ts)(AVFormatContext *, AVPacket *, AVPacket *));
57
58 #endif // AVFORMAT_AUDIOINTERLEAVE_H