diff options
author | Michael Niedermayer <michaelni@gmx.at> | 2009-02-09 15:31:08 +0000 |
---|---|---|
committer | Michael Niedermayer <michaelni@gmx.at> | 2009-02-09 15:31:08 +0000 |
commit | 3136fcf45ec7c8fc45171f628ecf5001f4d486a7 (patch) | |
tree | 9f45d87e8135bd68d9eb4ea8329c06ee4e37637e /libavcodec/avcodec.h | |
parent | e2a004ad4ef502d43f0628b0618decc679d905ca (diff) | |
download | ffmpeg-streaming-3136fcf45ec7c8fc45171f628ecf5001f4d486a7.zip ffmpeg-streaming-3136fcf45ec7c8fc45171f628ecf5001f4d486a7.tar.gz |
Move doxy for public resample2 functions to the public header.
Originally committed as revision 17099 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec/avcodec.h')
-rw-r--r-- | libavcodec/avcodec.h | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 39dabeb..36a4086 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -2448,8 +2448,37 @@ ReSampleContext *audio_resample_init(int output_channels, int input_channels, int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples); void audio_resample_close(ReSampleContext *s); + +/** + * Initializes an audio resampler. + * Note, if either rate is not an integer then simply scale both rates up so they are. + */ struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff); + +/** + * resamples. + * @param src an array of unconsumed samples + * @param consumed the number of samples of src which have been consumed are returned here + * @param src_size the number of unconsumed samples available + * @param dst_size the amount of space in samples available in dst + * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context. + * @return the number of samples written in dst or -1 if an error occurred + */ int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx); + + +/** + * Compensates samplerate/timestamp drift. The compensation is done by changing + * the resampler parameters, so no audible clicks or similar distortions occur + * @param compensation_distance distance in output samples over which the compensation should be performed + * @param sample_delta number of output samples which should be output less + * + * example: av_resample_compensate(c, 10, 500) + * here instead of 510 samples only 500 samples would be output + * + * note, due to rounding the actual compensation might be slightly different, + * especially if the compensation_distance is large and the in_rate used during init is small + */ void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance); void av_resample_close(struct AVResampleContext *c); |