comparison audiointerleave.h @ 4422:dd42a94023eb libavformat

cosmetics: typo/grammar fixes in doxygen and other comments
author diego
date Sun, 08 Feb 2009 23:34:58 +0000
parents de5ccc7a4461
children 7854590fb1fd
comparison
equal deleted inserted replaced
4421:a6849222fccc 4422:dd42a94023eb
1 /* 1 /*
2 * Audio Interleaving prototypes and declarations 2 * audio interleaving prototypes and declarations
3 * 3 *
4 * Copyright (c) 2009 Baptiste Coudurier <baptiste dot coudurier at gmail dot com> 4 * Copyright (c) 2009 Baptiste Coudurier <baptiste dot coudurier at gmail dot com>
5 * 5 *
6 * This file is part of FFmpeg. 6 * This file is part of FFmpeg.
7 * 7 *
26 #include "libavutil/fifo.h" 26 #include "libavutil/fifo.h"
27 #include "avformat.h" 27 #include "avformat.h"
28 28
29 typedef struct { 29 typedef struct {
30 AVFifoBuffer fifo; 30 AVFifoBuffer fifo;
31 unsigned fifo_size; ///< current fifo size allocated 31 unsigned fifo_size; ///< size of currently allocated FIFO
32 uint64_t dts; ///< current dts 32 uint64_t dts; ///< current dts
33 int sample_size; ///< size of one sample all channels included 33 int sample_size; ///< size of one sample all channels included
34 const int *samples_per_frame; ///< must be 0 terminated 34 const int *samples_per_frame; ///< must be 0-terminated
35 const int *samples; ///< current samples per frame, pointer to samples_per_frame 35 const int *samples; ///< current samples per frame, pointer to samples_per_frame
36 AVRational time_base; ///< time base of output audio packets 36 AVRational time_base; ///< time base of output audio packets
37 } AudioInterleaveContext; 37 } AudioInterleaveContext;
38 38
39 int ff_audio_interleave_init(AVFormatContext *s, const int *samples_per_frame, AVRational time_base); 39 int ff_audio_interleave_init(AVFormatContext *s, const int *samples_per_frame, AVRational time_base);
40 void ff_audio_interleave_close(AVFormatContext *s); 40 void ff_audio_interleave_close(AVFormatContext *s);
41 41
42 int ff_interleave_compare_dts(AVFormatContext *s, AVPacket *next, AVPacket *pkt); 42 int ff_interleave_compare_dts(AVFormatContext *s, AVPacket *next, AVPacket *pkt);
43 /** 43 /**
44 * Rechunk audio pcm packets per AudioInterleaveContext->samples_per_frame 44 * Rechunk audio PCM packets per AudioInterleaveContext->samples_per_frame
45 * and interleave them correctly. 45 * and interleave them correctly.
46 * AVStream->priv_data first element must be AudioInterleaveContext 46 * The first element of AVStream->priv_data must be AudioInterleaveContext
47 * when using this function. 47 * when using this function.
48 * 48 *
49 * @param get_packet function will output a packet when streams are correctly interleaved. 49 * @param get_packet function will output a packet when streams are correctly interleaved.
50 * @param compare_ts function will compare AVPackets and decide interleaving order. 50 * @param compare_ts function will compare AVPackets and decide interleaving order.
51 */ 51 */
52 int ff_audio_interleave(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush, 52 int ff_audio_interleave(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush,
53 int (*get_packet)(AVFormatContext *, AVPacket *, AVPacket *, int), 53 int (*get_packet)(AVFormatContext *, AVPacket *, AVPacket *, int),
54 int (*compare_ts)(AVFormatContext *, AVPacket *, AVPacket *)); 54 int (*compare_ts)(AVFormatContext *, AVPacket *, AVPacket *));
55 55
56 #endif // AVFORMAT_AUDIOINTERLEAVE_H 56 #endif /* AVFORMAT_AUDIOINTERLEAVE_H */