lavr: do not pass consumed samples as a parameter to ff_audio_resample()
[libav.git] / libavresample / resample.h
CommitLineData
c8af852b
JR
1/*
2 * Copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of Libav.
5 *
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef AVRESAMPLE_RESAMPLE_H
22#define AVRESAMPLE_RESAMPLE_H
23
24#include "avresample.h"
25#include "audio_data.h"
26
27typedef struct ResampleContext ResampleContext;
28
29/**
30 * Allocate and initialize a ResampleContext.
31 *
32 * The parameters in the AVAudioResampleContext are used to initialize the
33 * ResampleContext.
34 *
35 * @param avr AVAudioResampleContext
36 * @return newly-allocated ResampleContext
37 */
38ResampleContext *ff_audio_resample_init(AVAudioResampleContext *avr);
39
40/**
41 * Free a ResampleContext.
42 *
43 * @param c ResampleContext
44 */
45void ff_audio_resample_free(ResampleContext **c);
46
47/**
48 * Resample audio data.
49 *
50 * Changes the sample rate.
51 *
52 * @par
53 * All samples in the source data may not be consumed depending on the
54 * resampling parameters and the size of the output buffer. The unconsumed
55 * samples are automatically added to the start of the source in the next call.
56 * If the destination data can be reallocated, that may be done in this function
57 * in order to fit all available output. If it cannot be reallocated, fewer
58 * input samples will be consumed in order to have the output fit in the
59 * destination data buffers.
60 *
61 * @param c ResampleContext
62 * @param dst destination audio data
63 * @param src source audio data
d2f9f8e0 64 * @return 0 on success, negative AVERROR code on failure
c8af852b 65 */
1d86aa8b 66int ff_audio_resample(ResampleContext *c, AudioData *dst, AudioData *src);
c8af852b
JR
67
68#endif /* AVRESAMPLE_RESAMPLE_H */