• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_HARDWARE_BASE_H
18 #define ANDROID_AUDIO_HARDWARE_BASE_H
19 
20 #include "hardware_legacy/AudioHardwareInterface.h"
21 
22 
23 namespace android {
24 
25 // ----------------------------------------------------------------------------
26 
27 /**
28  * AudioHardwareBase is a convenient base class used for implementing the
29  * AudioHardwareInterface interface.
30  */
31 class AudioHardwareBase : public AudioHardwareInterface
32 {
33 public:
34                         AudioHardwareBase();
~AudioHardwareBase()35     virtual             ~AudioHardwareBase() { }
36 
37     /**
38      * setMode is called when the audio mode changes. NORMAL mode is for
39      * standard audio playback, RINGTONE when a ringtone is playing, IN_CALL
40      * when a telephony call is in progress, IN_COMMUNICATION when a VoIP call is in progress.
41      */
42     virtual status_t    setMode(int mode);
43 
44     virtual status_t    setParameters(const String8& keyValuePairs);
45     virtual String8     getParameters(const String8& keys);
46 
47     virtual  size_t     getInputBufferSize(uint32_t sampleRate, int format, int channelCount);
48 
49     /**This method dumps the state of the audio hardware */
50     virtual status_t dumpState(int fd, const Vector<String16>& args);
51 
52 protected:
53     /** returns true if the given mode maps to a telephony or VoIP call is in progress */
isModeInCall(int mode)54     virtual bool     isModeInCall(int mode)
55                         { return ((mode == AudioSystem::MODE_IN_CALL)
56                                 || (mode == AudioSystem::MODE_IN_COMMUNICATION)); };
57     /** returns true if a telephony or VoIP call is in progress */
isInCall()58     virtual bool     isInCall() { return isModeInCall(mMode); };
59     int              mMode;
60 };
61 
62 }; // namespace android
63 
64 #endif // ANDROID_AUDIO_HARDWARE_BASE_H
65