AudioResampler.h revision 86eae0e5931103e040ac2cdd023ef5db252e09f6 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_AUDIO_RESAMPLER_H
18#define ANDROID_AUDIO_RESAMPLER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22#include <cutils/compiler.h>
23
24#include <media/AudioBufferProvider.h>
25
26namespace android {
27// ----------------------------------------------------------------------------
28
29class ANDROID_API AudioResampler {
30public:
31    // Determines quality of SRC.
32    //  LOW_QUALITY: linear interpolator (1st order)
33    //  MED_QUALITY: cubic interpolator (3rd order)
34    //  HIGH_QUALITY: fixed multi-tap FIR (e.g. 48KHz->44.1KHz)
35    // NOTE: high quality SRC will only be supported for
36    // certain fixed rate conversions. Sample rate cannot be
37    // changed dynamically.
38    enum src_quality {
39        DEFAULT_QUALITY=0,
40        LOW_QUALITY=1,
41        MED_QUALITY=2,
42        HIGH_QUALITY=3,
43        VERY_HIGH_QUALITY=4,
44        DYN_LOW_QUALITY=5,
45        DYN_MED_QUALITY=6,
46        DYN_HIGH_QUALITY=7,
47    };
48
49    static AudioResampler* create(int bitDepth, int inChannelCount,
50            int32_t sampleRate, src_quality quality=DEFAULT_QUALITY);
51
52    virtual ~AudioResampler();
53
54    virtual void init() = 0;
55    virtual void setSampleRate(int32_t inSampleRate);
56    virtual void setVolume(int16_t left, int16_t right);
57    virtual void setLocalTimeFreq(uint64_t freq);
58
59    // set the PTS of the next buffer output by the resampler
60    virtual void setPTS(int64_t pts);
61
62    // Resample int16_t samples from provider and accumulate into 'out'.
63    // A mono provider delivers a sequence of samples.
64    // A stereo provider delivers a sequence of interleaved pairs of samples.
65    // Multi-channel providers are not supported.
66    // In either case, 'out' holds interleaved pairs of fixed-point signed Q19.12.
67    // That is, for a mono provider, there is an implicit up-channeling.
68    // Since this method accumulates, the caller is responsible for clearing 'out' initially.
69    // FIXME assumes provider is always successful; it should return the actual frame count.
70    virtual void resample(int32_t* out, size_t outFrameCount,
71            AudioBufferProvider* provider) = 0;
72
73    virtual void reset();
74    virtual size_t getUnreleasedFrames() const { return mInputIndex; }
75
76    // called from destructor, so must not be virtual
77    src_quality getQuality() const { return mQuality; }
78
79protected:
80    // number of bits for phase fraction - 30 bits allows nearly 2x downsampling
81    static const int kNumPhaseBits = 30;
82
83    // phase mask for fraction
84    static const uint32_t kPhaseMask = (1LU<<kNumPhaseBits)-1;
85
86    // multiplier to calculate fixed point phase increment
87    static const double kPhaseMultiplier = 1L << kNumPhaseBits;
88
89    AudioResampler(int bitDepth, int inChannelCount, int32_t sampleRate, src_quality quality);
90
91    // prevent copying
92    AudioResampler(const AudioResampler&);
93    AudioResampler& operator=(const AudioResampler&);
94
95    int64_t calculateOutputPTS(int outputFrameIndex);
96
97    const int32_t mBitDepth;
98    const int32_t mChannelCount;
99    const int32_t mSampleRate;
100    int32_t mInSampleRate;
101    AudioBufferProvider::Buffer mBuffer;
102    union {
103        int16_t mVolume[2];
104        uint32_t mVolumeRL;
105    };
106    int16_t mTargetVolume[2];
107    size_t mInputIndex;
108    int32_t mPhaseIncrement;
109    uint32_t mPhaseFraction;
110    uint64_t mLocalTimeFreq;
111    int64_t mPTS;
112
113private:
114    const src_quality mQuality;
115
116    // Return 'true' if the quality level is supported without explicit request
117    static bool qualityIsSupported(src_quality quality);
118
119    // For pthread_once()
120    static void init_routine();
121
122    // Return the estimated CPU load for specific resampler in MHz.
123    // The absolute number is irrelevant, it's the relative values that matter.
124    static uint32_t qualityMHz(src_quality quality);
125};
126
127// ----------------------------------------------------------------------------
128}
129; // namespace android
130
131#endif // ANDROID_AUDIO_RESAMPLER_H
132