Home | History | Annotate | Download | only in audioflinger
      1 /*
      2  * Copyright (C) 2012 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_FAST_MIXER_STATE_H
     18 #define ANDROID_AUDIO_FAST_MIXER_STATE_H
     19 
     20 #include <audio_utils/minifloat.h>
     21 #include <system/audio.h>
     22 #include <media/AudioMixer.h>
     23 #include <media/ExtendedAudioBufferProvider.h>
     24 #include <media/nbaio/NBAIO.h>
     25 #include <media/nblog/NBLog.h>
     26 #include "FastThreadState.h"
     27 
     28 namespace android {
     29 
     30 struct FastMixerDumpState;
     31 
     32 class VolumeProvider {
     33 public:
     34     // The provider implementation is responsible for validating that the return value is in range.
     35     virtual gain_minifloat_packed_t getVolumeLR() = 0;
     36 protected:
     37     VolumeProvider() { }
     38     virtual ~VolumeProvider() { }
     39 };
     40 
     41 // Represents the state of a fast track
     42 struct FastTrack {
     43     FastTrack();
     44     /*virtual*/ ~FastTrack();
     45 
     46     ExtendedAudioBufferProvider* mBufferProvider; // must be NULL if inactive, or non-NULL if active
     47     VolumeProvider*         mVolumeProvider; // optional; if NULL then full-scale
     48     audio_channel_mask_t    mChannelMask;    // AUDIO_CHANNEL_OUT_MONO or AUDIO_CHANNEL_OUT_STEREO
     49     audio_format_t          mFormat;         // track format
     50     int                     mGeneration;     // increment when any field is assigned
     51     bool                    mHapticPlaybackEnabled = false; // haptic playback is enabled or not
     52     AudioMixer::haptic_intensity_t mHapticIntensity = AudioMixer::HAPTIC_SCALE_MUTE; // intensity of
     53                                                                                      // haptic data
     54 };
     55 
     56 // Represents a single state of the fast mixer
     57 struct FastMixerState : FastThreadState {
     58                 FastMixerState();
     59     /*virtual*/ ~FastMixerState();
     60 
     61     // These are the minimum, maximum, and default values for maximum number of fast tracks
     62     static const unsigned kMinFastTracks = 2;
     63     static const unsigned kMaxFastTracks = 32;
     64     static const unsigned kDefaultFastTracks = 8;
     65 
     66     static unsigned sMaxFastTracks;             // Configured maximum number of fast tracks
     67     static pthread_once_t sMaxFastTracksOnce;   // Protects initializer for sMaxFastTracks
     68 
     69     // all pointer fields use raw pointers; objects are owned and ref-counted by the normal mixer
     70     FastTrack   mFastTracks[kMaxFastTracks];
     71     int         mFastTracksGen; // increment when any mFastTracks[i].mGeneration is incremented
     72     unsigned    mTrackMask;     // bit i is set if and only if mFastTracks[i] is active
     73     NBAIO_Sink* mOutputSink;    // HAL output device, must already be negotiated
     74     int         mOutputSinkGen; // increment when mOutputSink is assigned
     75     size_t      mFrameCount;    // number of frames per fast mix buffer
     76     audio_channel_mask_t mSinkChannelMask; // If not AUDIO_CHANNEL_NONE, specifies sink channel
     77                                            // mask when it cannot be directly calculated from
     78                                            // channel count
     79 
     80     // Extends FastThreadState::Command
     81     static const Command
     82         // The following commands also process configuration changes, and can be "or"ed:
     83         MIX = 0x8,              // mix tracks
     84         WRITE = 0x10,           // write to output sink
     85         MIX_WRITE = 0x18;       // mix tracks and write to output sink
     86 
     87     // never returns NULL; asserts if command is invalid
     88     static const char *commandToString(Command command);
     89 
     90     // initialize sMaxFastTracks
     91     static void sMaxFastTracksInit();
     92 
     93 };  // struct FastMixerState
     94 
     95 }   // namespace android
     96 
     97 #endif  // ANDROID_AUDIO_FAST_MIXER_STATE_H
     98