AudioFlinger.cpp revision fb872cc6f77f6d74011fab703b3edd7023c736cb 
1/*
2**
3** Copyright 2007, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9**     http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18
19#define LOG_TAG "AudioFlinger"
20//#define LOG_NDEBUG 0
21
22#include "Configuration.h"
23#include <dirent.h>
24#include <math.h>
25#include <signal.h>
26#include <sys/time.h>
27#include <sys/resource.h>
28
29#include <binder/IPCThreadState.h>
30#include <binder/IServiceManager.h>
31#include <utils/Log.h>
32#include <utils/Trace.h>
33#include <binder/Parcel.h>
34#include <utils/String16.h>
35#include <utils/threads.h>
36#include <utils/Atomic.h>
37
38#include <cutils/bitops.h>
39#include <cutils/properties.h>
40
41#include <system/audio.h>
42#include <hardware/audio.h>
43
44#include "AudioMixer.h"
45#include "AudioFlinger.h"
46#include "ServiceUtilities.h"
47
48#include <media/EffectsFactoryApi.h>
49#include <audio_effects/effect_visualizer.h>
50#include <audio_effects/effect_ns.h>
51#include <audio_effects/effect_aec.h>
52
53#include <audio_utils/primitives.h>
54
55#include <powermanager/PowerManager.h>
56
57#include <common_time/cc_helper.h>
58
59#include <media/IMediaLogService.h>
60
61#include <media/nbaio/Pipe.h>
62#include <media/nbaio/PipeReader.h>
63#include <media/AudioParameter.h>
64#include <private/android_filesystem_config.h>
65
66// ----------------------------------------------------------------------------
67
68// Note: the following macro is used for extremely verbose logging message.  In
69// order to run with ALOG_ASSERT turned on, we need to have LOG_NDEBUG set to
70// 0; but one side effect of this is to turn all LOGV's as well.  Some messages
71// are so verbose that we want to suppress them even when we have ALOG_ASSERT
72// turned on.  Do not uncomment the #def below unless you really know what you
73// are doing and want to see all of the extremely verbose messages.
74//#define VERY_VERY_VERBOSE_LOGGING
75#ifdef VERY_VERY_VERBOSE_LOGGING
76#define ALOGVV ALOGV
77#else
78#define ALOGVV(a...) do { } while(0)
79#endif
80
81namespace android {
82
83static const char kDeadlockedString[] = "AudioFlinger may be deadlocked\n";
84static const char kHardwareLockedString[] = "Hardware lock is taken\n";
85
86
87nsecs_t AudioFlinger::mStandbyTimeInNsecs = kDefaultStandbyTimeInNsecs;
88
89uint32_t AudioFlinger::mScreenState;
90
91#ifdef TEE_SINK
92bool AudioFlinger::mTeeSinkInputEnabled = false;
93bool AudioFlinger::mTeeSinkOutputEnabled = false;
94bool AudioFlinger::mTeeSinkTrackEnabled = false;
95
96size_t AudioFlinger::mTeeSinkInputFrames = kTeeSinkInputFramesDefault;
97size_t AudioFlinger::mTeeSinkOutputFrames = kTeeSinkOutputFramesDefault;
98size_t AudioFlinger::mTeeSinkTrackFrames = kTeeSinkTrackFramesDefault;
99#endif
100
101// ----------------------------------------------------------------------------
102
103static int load_audio_interface(const char *if_name, audio_hw_device_t **dev)
104{
105    const hw_module_t *mod;
106    int rc;
107
108    rc = hw_get_module_by_class(AUDIO_HARDWARE_MODULE_ID, if_name, &mod);
109    ALOGE_IF(rc, "%s couldn't load audio hw module %s.%s (%s)", __func__,
110                 AUDIO_HARDWARE_MODULE_ID, if_name, strerror(-rc));
111    if (rc) {
112        goto out;
113    }
114    rc = audio_hw_device_open(mod, dev);
115    ALOGE_IF(rc, "%s couldn't open audio hw device in %s.%s (%s)", __func__,
116                 AUDIO_HARDWARE_MODULE_ID, if_name, strerror(-rc));
117    if (rc) {
118        goto out;
119    }
120    if ((*dev)->common.version != AUDIO_DEVICE_API_VERSION_CURRENT) {
121        ALOGE("%s wrong audio hw device version %04x", __func__, (*dev)->common.version);
122        rc = BAD_VALUE;
123        goto out;
124    }
125    return 0;
126
127out:
128    *dev = NULL;
129    return rc;
130}
131
132// ----------------------------------------------------------------------------
133
134AudioFlinger::AudioFlinger()
135    : BnAudioFlinger(),
136      mPrimaryHardwareDev(NULL),
137      mHardwareStatus(AUDIO_HW_IDLE),
138      mMasterVolume(1.0f),
139      mMasterMute(false),
140      mNextUniqueId(1),
141      mMode(AUDIO_MODE_INVALID),
142      mBtNrecIsOff(false),
143      mIsLowRamDevice(true),
144      mIsDeviceTypeKnown(false)
145{
146    getpid_cached = getpid();
147    char value[PROPERTY_VALUE_MAX];
148    bool doLog = (property_get("ro.test_harness", value, "0") > 0) && (atoi(value) == 1);
149    if (doLog) {
150        mLogMemoryDealer = new MemoryDealer(kLogMemorySize, "LogWriters");
151    }
152#ifdef TEE_SINK
153    (void) property_get("ro.debuggable", value, "0");
154    int debuggable = atoi(value);
155    int teeEnabled = 0;
156    if (debuggable) {
157        (void) property_get("af.tee", value, "0");
158        teeEnabled = atoi(value);
159    }
160    if (teeEnabled & 1)
161        mTeeSinkInputEnabled = true;
162    if (teeEnabled & 2)
163        mTeeSinkOutputEnabled = true;
164    if (teeEnabled & 4)
165        mTeeSinkTrackEnabled = true;
166#endif
167}
168
169void AudioFlinger::onFirstRef()
170{
171    int rc = 0;
172
173    Mutex::Autolock _l(mLock);
174
175    /* TODO: move all this work into an Init() function */
176    char val_str[PROPERTY_VALUE_MAX] = { 0 };
177    if (property_get("ro.audio.flinger_standbytime_ms", val_str, NULL) >= 0) {
178        uint32_t int_val;
179        if (1 == sscanf(val_str, "%u", &int_val)) {
180            mStandbyTimeInNsecs = milliseconds(int_val);
181            ALOGI("Using %u mSec as standby time.", int_val);
182        } else {
183            mStandbyTimeInNsecs = kDefaultStandbyTimeInNsecs;
184            ALOGI("Using default %u mSec as standby time.",
185                    (uint32_t)(mStandbyTimeInNsecs / 1000000));
186        }
187    }
188
189    mMode = AUDIO_MODE_NORMAL;
190}
191
192AudioFlinger::~AudioFlinger()
193{
194    while (!mRecordThreads.isEmpty()) {
195        // closeInput_nonvirtual() will remove specified entry from mRecordThreads
196        closeInput_nonvirtual(mRecordThreads.keyAt(0));
197    }
198    while (!mPlaybackThreads.isEmpty()) {
199        // closeOutput_nonvirtual() will remove specified entry from mPlaybackThreads
200        closeOutput_nonvirtual(mPlaybackThreads.keyAt(0));
201    }
202
203    for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
204        // no mHardwareLock needed, as there are no other references to this
205        audio_hw_device_close(mAudioHwDevs.valueAt(i)->hwDevice());
206        delete mAudioHwDevs.valueAt(i);
207    }
208}
209
210static const char * const audio_interfaces[] = {
211    AUDIO_HARDWARE_MODULE_ID_PRIMARY,
212    AUDIO_HARDWARE_MODULE_ID_A2DP,
213    AUDIO_HARDWARE_MODULE_ID_USB,
214};
215#define ARRAY_SIZE(x) (sizeof((x))/sizeof(((x)[0])))
216
217AudioFlinger::AudioHwDevice* AudioFlinger::findSuitableHwDev_l(
218        audio_module_handle_t module,
219        audio_devices_t devices)
220{
221    // if module is 0, the request comes from an old policy manager and we should load
222    // well known modules
223    if (module == 0) {
224        ALOGW("findSuitableHwDev_l() loading well know audio hw modules");
225        for (size_t i = 0; i < ARRAY_SIZE(audio_interfaces); i++) {
226            loadHwModule_l(audio_interfaces[i]);
227        }
228        // then try to find a module supporting the requested device.
229        for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
230            AudioHwDevice *audioHwDevice = mAudioHwDevs.valueAt(i);
231            audio_hw_device_t *dev = audioHwDevice->hwDevice();
232            if ((dev->get_supported_devices != NULL) &&
233                    (dev->get_supported_devices(dev) & devices) == devices)
234                return audioHwDevice;
235        }
236    } else {
237        // check a match for the requested module handle
238        AudioHwDevice *audioHwDevice = mAudioHwDevs.valueFor(module);
239        if (audioHwDevice != NULL) {
240            return audioHwDevice;
241        }
242    }
243
244    return NULL;
245}
246
247void AudioFlinger::dumpClients(int fd, const Vector<String16>& args)
248{
249    const size_t SIZE = 256;
250    char buffer[SIZE];
251    String8 result;
252
253    result.append("Clients:\n");
254    for (size_t i = 0; i < mClients.size(); ++i) {
255        sp<Client> client = mClients.valueAt(i).promote();
256        if (client != 0) {
257            snprintf(buffer, SIZE, "  pid: %d\n", client->pid());
258            result.append(buffer);
259        }
260    }
261
262    result.append("Global session refs:\n");
263    result.append(" session pid count\n");
264    for (size_t i = 0; i < mAudioSessionRefs.size(); i++) {
265        AudioSessionRef *r = mAudioSessionRefs[i];
266        snprintf(buffer, SIZE, " %7d %3d %3d\n", r->mSessionid, r->mPid, r->mCnt);
267        result.append(buffer);
268    }
269    write(fd, result.string(), result.size());
270}
271
272
273void AudioFlinger::dumpInternals(int fd, const Vector<String16>& args)
274{
275    const size_t SIZE = 256;
276    char buffer[SIZE];
277    String8 result;
278    hardware_call_state hardwareStatus = mHardwareStatus;
279
280    snprintf(buffer, SIZE, "Hardware status: %d\n"
281                           "Standby Time mSec: %u\n",
282                            hardwareStatus,
283                            (uint32_t)(mStandbyTimeInNsecs / 1000000));
284    result.append(buffer);
285    write(fd, result.string(), result.size());
286}
287
288void AudioFlinger::dumpPermissionDenial(int fd, const Vector<String16>& args)
289{
290    const size_t SIZE = 256;
291    char buffer[SIZE];
292    String8 result;
293    snprintf(buffer, SIZE, "Permission Denial: "
294            "can't dump AudioFlinger from pid=%d, uid=%d\n",
295            IPCThreadState::self()->getCallingPid(),
296            IPCThreadState::self()->getCallingUid());
297    result.append(buffer);
298    write(fd, result.string(), result.size());
299}
300
301bool AudioFlinger::dumpTryLock(Mutex& mutex)
302{
303    bool locked = false;
304    for (int i = 0; i < kDumpLockRetries; ++i) {
305        if (mutex.tryLock() == NO_ERROR) {
306            locked = true;
307            break;
308        }
309        usleep(kDumpLockSleepUs);
310    }
311    return locked;
312}
313
314status_t AudioFlinger::dump(int fd, const Vector<String16>& args)
315{
316    if (!dumpAllowed()) {
317        dumpPermissionDenial(fd, args);
318    } else {
319        // get state of hardware lock
320        bool hardwareLocked = dumpTryLock(mHardwareLock);
321        if (!hardwareLocked) {
322            String8 result(kHardwareLockedString);
323            write(fd, result.string(), result.size());
324        } else {
325            mHardwareLock.unlock();
326        }
327
328        bool locked = dumpTryLock(mLock);
329
330        // failed to lock - AudioFlinger is probably deadlocked
331        if (!locked) {
332            String8 result(kDeadlockedString);
333            write(fd, result.string(), result.size());
334        }
335
336        dumpClients(fd, args);
337        dumpInternals(fd, args);
338
339        // dump playback threads
340        for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
341            mPlaybackThreads.valueAt(i)->dump(fd, args);
342        }
343
344        // dump record threads
345        for (size_t i = 0; i < mRecordThreads.size(); i++) {
346            mRecordThreads.valueAt(i)->dump(fd, args);
347        }
348
349        // dump all hardware devs
350        for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
351            audio_hw_device_t *dev = mAudioHwDevs.valueAt(i)->hwDevice();
352            dev->dump(dev, fd);
353        }
354
355#ifdef TEE_SINK
356        // dump the serially shared record tee sink
357        if (mRecordTeeSource != 0) {
358            dumpTee(fd, mRecordTeeSource);
359        }
360#endif
361
362        if (locked) {
363            mLock.unlock();
364        }
365
366        // append a copy of media.log here by forwarding fd to it, but don't attempt
367        // to lookup the service if it's not running, as it will block for a second
368        if (mLogMemoryDealer != 0) {
369            sp<IBinder> binder = defaultServiceManager()->getService(String16("media.log"));
370            if (binder != 0) {
371                fdprintf(fd, "\nmedia.log:\n");
372                Vector<String16> args;
373                binder->dump(fd, args);
374            }
375        }
376    }
377    return NO_ERROR;
378}
379
380sp<AudioFlinger::Client> AudioFlinger::registerPid_l(pid_t pid)
381{
382    // If pid is already in the mClients wp<> map, then use that entry
383    // (for which promote() is always != 0), otherwise create a new entry and Client.
384    sp<Client> client = mClients.valueFor(pid).promote();
385    if (client == 0) {
386        client = new Client(this, pid);
387        mClients.add(pid, client);
388    }
389
390    return client;
391}
392
393sp<NBLog::Writer> AudioFlinger::newWriter_l(size_t size, const char *name)
394{
395    if (mLogMemoryDealer == 0) {
396        return new NBLog::Writer();
397    }
398    sp<IMemory> shared = mLogMemoryDealer->allocate(NBLog::Timeline::sharedSize(size));
399    sp<NBLog::Writer> writer = new NBLog::Writer(size, shared);
400    sp<IBinder> binder = defaultServiceManager()->getService(String16("media.log"));
401    if (binder != 0) {
402        interface_cast<IMediaLogService>(binder)->registerWriter(shared, size, name);
403    }
404    return writer;
405}
406
407void AudioFlinger::unregisterWriter(const sp<NBLog::Writer>& writer)
408{
409    if (writer == 0) {
410        return;
411    }
412    sp<IMemory> iMemory(writer->getIMemory());
413    if (iMemory == 0) {
414        return;
415    }
416    sp<IBinder> binder = defaultServiceManager()->getService(String16("media.log"));
417    if (binder != 0) {
418        interface_cast<IMediaLogService>(binder)->unregisterWriter(iMemory);
419        // Now the media.log remote reference to IMemory is gone.
420        // When our last local reference to IMemory also drops to zero,
421        // the IMemory destructor will deallocate the region from mMemoryDealer.
422    }
423}
424
425// IAudioFlinger interface
426
427
428sp<IAudioTrack> AudioFlinger::createTrack(
429        audio_stream_type_t streamType,
430        uint32_t sampleRate,
431        audio_format_t format,
432        audio_channel_mask_t channelMask,
433        size_t frameCount,
434        IAudioFlinger::track_flags_t *flags,
435        const sp<IMemory>& sharedBuffer,
436        audio_io_handle_t output,
437        pid_t tid,
438        int *sessionId,
439        String8& name,
440        status_t *status)
441{
442    sp<PlaybackThread::Track> track;
443    sp<TrackHandle> trackHandle;
444    sp<Client> client;
445    status_t lStatus;
446    int lSessionId;
447
448    // client AudioTrack::set already implements AUDIO_STREAM_DEFAULT => AUDIO_STREAM_MUSIC,
449    // but if someone uses binder directly they could bypass that and cause us to crash
450    if (uint32_t(streamType) >= AUDIO_STREAM_CNT) {
451        ALOGE("createTrack() invalid stream type %d", streamType);
452        lStatus = BAD_VALUE;
453        goto Exit;
454    }
455
456    // client is responsible for conversion of 8-bit PCM to 16-bit PCM,
457    // and we don't yet support 8.24 or 32-bit PCM
458    if (audio_is_linear_pcm(format) && format != AUDIO_FORMAT_PCM_16_BIT) {
459        ALOGE("createTrack() invalid format %d", format);
460        lStatus = BAD_VALUE;
461        goto Exit;
462    }
463
464    {
465        Mutex::Autolock _l(mLock);
466        PlaybackThread *thread = checkPlaybackThread_l(output);
467        PlaybackThread *effectThread = NULL;
468        if (thread == NULL) {
469            ALOGE("no playback thread found for output handle %d", output);
470            lStatus = BAD_VALUE;
471            goto Exit;
472        }
473
474        pid_t pid = IPCThreadState::self()->getCallingPid();
475        client = registerPid_l(pid);
476
477        ALOGV("createTrack() sessionId: %d", (sessionId == NULL) ? -2 : *sessionId);
478        if (sessionId != NULL && *sessionId != AUDIO_SESSION_OUTPUT_MIX) {
479            // check if an effect chain with the same session ID is present on another
480            // output thread and move it here.
481            for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
482                sp<PlaybackThread> t = mPlaybackThreads.valueAt(i);
483                if (mPlaybackThreads.keyAt(i) != output) {
484                    uint32_t sessions = t->hasAudioSession(*sessionId);
485                    if (sessions & PlaybackThread::EFFECT_SESSION) {
486                        effectThread = t.get();
487                        break;
488                    }
489                }
490            }
491            lSessionId = *sessionId;
492        } else {
493            // if no audio session id is provided, create one here
494            lSessionId = nextUniqueId();
495            if (sessionId != NULL) {
496                *sessionId = lSessionId;
497            }
498        }
499        ALOGV("createTrack() lSessionId: %d", lSessionId);
500
501        track = thread->createTrack_l(client, streamType, sampleRate, format,
502                channelMask, frameCount, sharedBuffer, lSessionId, flags, tid, &lStatus);
503
504        // move effect chain to this output thread if an effect on same session was waiting
505        // for a track to be created
506        if (lStatus == NO_ERROR && effectThread != NULL) {
507            Mutex::Autolock _dl(thread->mLock);
508            Mutex::Autolock _sl(effectThread->mLock);
509            moveEffectChain_l(lSessionId, effectThread, thread, true);
510        }
511
512        // Look for sync events awaiting for a session to be used.
513        for (int i = 0; i < (int)mPendingSyncEvents.size(); i++) {
514            if (mPendingSyncEvents[i]->triggerSession() == lSessionId) {
515                if (thread->isValidSyncEvent(mPendingSyncEvents[i])) {
516                    if (lStatus == NO_ERROR) {
517                        (void) track->setSyncEvent(mPendingSyncEvents[i]);
518                    } else {
519                        mPendingSyncEvents[i]->cancel();
520                    }
521                    mPendingSyncEvents.removeAt(i);
522                    i--;
523                }
524            }
525        }
526    }
527    if (lStatus == NO_ERROR) {
528        // s for server's pid, n for normal mixer name, f for fast index
529        name = String8::format("s:%d;n:%d;f:%d", getpid_cached, track->name() - AudioMixer::TRACK0,
530                track->fastIndex());
531        trackHandle = new TrackHandle(track);
532    } else {
533        // remove local strong reference to Client before deleting the Track so that the Client
534        // destructor is called by the TrackBase destructor with mLock held
535        client.clear();
536        track.clear();
537    }
538
539Exit:
540    if (status != NULL) {
541        *status = lStatus;
542    }
543    return trackHandle;
544}
545
546uint32_t AudioFlinger::sampleRate(audio_io_handle_t output) const
547{
548    Mutex::Autolock _l(mLock);
549    PlaybackThread *thread = checkPlaybackThread_l(output);
550    if (thread == NULL) {
551        ALOGW("sampleRate() unknown thread %d", output);
552        return 0;
553    }
554    return thread->sampleRate();
555}
556
557int AudioFlinger::channelCount(audio_io_handle_t output) const
558{
559    Mutex::Autolock _l(mLock);
560    PlaybackThread *thread = checkPlaybackThread_l(output);
561    if (thread == NULL) {
562        ALOGW("channelCount() unknown thread %d", output);
563        return 0;
564    }
565    return thread->channelCount();
566}
567
568audio_format_t AudioFlinger::format(audio_io_handle_t output) const
569{
570    Mutex::Autolock _l(mLock);
571    PlaybackThread *thread = checkPlaybackThread_l(output);
572    if (thread == NULL) {
573        ALOGW("format() unknown thread %d", output);
574        return AUDIO_FORMAT_INVALID;
575    }
576    return thread->format();
577}
578
579size_t AudioFlinger::frameCount(audio_io_handle_t output) const
580{
581    Mutex::Autolock _l(mLock);
582    PlaybackThread *thread = checkPlaybackThread_l(output);
583    if (thread == NULL) {
584        ALOGW("frameCount() unknown thread %d", output);
585        return 0;
586    }
587    // FIXME currently returns the normal mixer's frame count to avoid confusing legacy callers;
588    //       should examine all callers and fix them to handle smaller counts
589    return thread->frameCount();
590}
591
592uint32_t AudioFlinger::latency(audio_io_handle_t output) const
593{
594    Mutex::Autolock _l(mLock);
595    PlaybackThread *thread = checkPlaybackThread_l(output);
596    if (thread == NULL) {
597        ALOGW("latency(): no playback thread found for output handle %d", output);
598        return 0;
599    }
600    return thread->latency();
601}
602
603status_t AudioFlinger::setMasterVolume(float value)
604{
605    status_t ret = initCheck();
606    if (ret != NO_ERROR) {
607        return ret;
608    }
609
610    // check calling permissions
611    if (!settingsAllowed()) {
612        return PERMISSION_DENIED;
613    }
614
615    Mutex::Autolock _l(mLock);
616    mMasterVolume = value;
617
618    // Set master volume in the HALs which support it.
619    for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
620        AutoMutex lock(mHardwareLock);
621        AudioHwDevice *dev = mAudioHwDevs.valueAt(i);
622
623        mHardwareStatus = AUDIO_HW_SET_MASTER_VOLUME;
624        if (dev->canSetMasterVolume()) {
625            dev->hwDevice()->set_master_volume(dev->hwDevice(), value);
626        }
627        mHardwareStatus = AUDIO_HW_IDLE;
628    }
629
630    // Now set the master volume in each playback thread.  Playback threads
631    // assigned to HALs which do not have master volume support will apply
632    // master volume during the mix operation.  Threads with HALs which do
633    // support master volume will simply ignore the setting.
634    for (size_t i = 0; i < mPlaybackThreads.size(); i++)
635        mPlaybackThreads.valueAt(i)->setMasterVolume(value);
636
637    return NO_ERROR;
638}
639
640status_t AudioFlinger::setMode(audio_mode_t mode)
641{
642    status_t ret = initCheck();
643    if (ret != NO_ERROR) {
644        return ret;
645    }
646
647    // check calling permissions
648    if (!settingsAllowed()) {
649        return PERMISSION_DENIED;
650    }
651    if (uint32_t(mode) >= AUDIO_MODE_CNT) {
652        ALOGW("Illegal value: setMode(%d)", mode);
653        return BAD_VALUE;
654    }
655
656    { // scope for the lock
657        AutoMutex lock(mHardwareLock);
658        audio_hw_device_t *dev = mPrimaryHardwareDev->hwDevice();
659        mHardwareStatus = AUDIO_HW_SET_MODE;
660        ret = dev->set_mode(dev, mode);
661        mHardwareStatus = AUDIO_HW_IDLE;
662    }
663
664    if (NO_ERROR == ret) {
665        Mutex::Autolock _l(mLock);
666        mMode = mode;
667        for (size_t i = 0; i < mPlaybackThreads.size(); i++)
668            mPlaybackThreads.valueAt(i)->setMode(mode);
669    }
670
671    return ret;
672}
673
674status_t AudioFlinger::setMicMute(bool state)
675{
676    status_t ret = initCheck();
677    if (ret != NO_ERROR) {
678        return ret;
679    }
680
681    // check calling permissions
682    if (!settingsAllowed()) {
683        return PERMISSION_DENIED;
684    }
685
686    AutoMutex lock(mHardwareLock);
687    audio_hw_device_t *dev = mPrimaryHardwareDev->hwDevice();
688    mHardwareStatus = AUDIO_HW_SET_MIC_MUTE;
689    ret = dev->set_mic_mute(dev, state);
690    mHardwareStatus = AUDIO_HW_IDLE;
691    return ret;
692}
693
694bool AudioFlinger::getMicMute() const
695{
696    status_t ret = initCheck();
697    if (ret != NO_ERROR) {
698        return false;
699    }
700
701    bool state = AUDIO_MODE_INVALID;
702    AutoMutex lock(mHardwareLock);
703    audio_hw_device_t *dev = mPrimaryHardwareDev->hwDevice();
704    mHardwareStatus = AUDIO_HW_GET_MIC_MUTE;
705    dev->get_mic_mute(dev, &state);
706    mHardwareStatus = AUDIO_HW_IDLE;
707    return state;
708}
709
710status_t AudioFlinger::setMasterMute(bool muted)
711{
712    status_t ret = initCheck();
713    if (ret != NO_ERROR) {
714        return ret;
715    }
716
717    // check calling permissions
718    if (!settingsAllowed()) {
719        return PERMISSION_DENIED;
720    }
721
722    Mutex::Autolock _l(mLock);
723    mMasterMute = muted;
724
725    // Set master mute in the HALs which support it.
726    for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
727        AutoMutex lock(mHardwareLock);
728        AudioHwDevice *dev = mAudioHwDevs.valueAt(i);
729
730        mHardwareStatus = AUDIO_HW_SET_MASTER_MUTE;
731        if (dev->canSetMasterMute()) {
732            dev->hwDevice()->set_master_mute(dev->hwDevice(), muted);
733        }
734        mHardwareStatus = AUDIO_HW_IDLE;
735    }
736
737    // Now set the master mute in each playback thread.  Playback threads
738    // assigned to HALs which do not have master mute support will apply master
739    // mute during the mix operation.  Threads with HALs which do support master
740    // mute will simply ignore the setting.
741    for (size_t i = 0; i < mPlaybackThreads.size(); i++)
742        mPlaybackThreads.valueAt(i)->setMasterMute(muted);
743
744    return NO_ERROR;
745}
746
747float AudioFlinger::masterVolume() const
748{
749    Mutex::Autolock _l(mLock);
750    return masterVolume_l();
751}
752
753bool AudioFlinger::masterMute() const
754{
755    Mutex::Autolock _l(mLock);
756    return masterMute_l();
757}
758
759float AudioFlinger::masterVolume_l() const
760{
761    return mMasterVolume;
762}
763
764bool AudioFlinger::masterMute_l() const
765{
766    return mMasterMute;
767}
768
769status_t AudioFlinger::setStreamVolume(audio_stream_type_t stream, float value,
770        audio_io_handle_t output)
771{
772    // check calling permissions
773    if (!settingsAllowed()) {
774        return PERMISSION_DENIED;
775    }
776
777    if (uint32_t(stream) >= AUDIO_STREAM_CNT) {
778        ALOGE("setStreamVolume() invalid stream %d", stream);
779        return BAD_VALUE;
780    }
781
782    AutoMutex lock(mLock);
783    PlaybackThread *thread = NULL;
784    if (output) {
785        thread = checkPlaybackThread_l(output);
786        if (thread == NULL) {
787            return BAD_VALUE;
788        }
789    }
790
791    mStreamTypes[stream].volume = value;
792
793    if (thread == NULL) {
794        for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
795            mPlaybackThreads.valueAt(i)->setStreamVolume(stream, value);
796        }
797    } else {
798        thread->setStreamVolume(stream, value);
799    }
800
801    return NO_ERROR;
802}
803
804status_t AudioFlinger::setStreamMute(audio_stream_type_t stream, bool muted)
805{
806    // check calling permissions
807    if (!settingsAllowed()) {
808        return PERMISSION_DENIED;
809    }
810
811    if (uint32_t(stream) >= AUDIO_STREAM_CNT ||
812        uint32_t(stream) == AUDIO_STREAM_ENFORCED_AUDIBLE) {
813        ALOGE("setStreamMute() invalid stream %d", stream);
814        return BAD_VALUE;
815    }
816
817    AutoMutex lock(mLock);
818    mStreamTypes[stream].mute = muted;
819    for (uint32_t i = 0; i < mPlaybackThreads.size(); i++)
820        mPlaybackThreads.valueAt(i)->setStreamMute(stream, muted);
821
822    return NO_ERROR;
823}
824
825float AudioFlinger::streamVolume(audio_stream_type_t stream, audio_io_handle_t output) const
826{
827    if (uint32_t(stream) >= AUDIO_STREAM_CNT) {
828        return 0.0f;
829    }
830
831    AutoMutex lock(mLock);
832    float volume;
833    if (output) {
834        PlaybackThread *thread = checkPlaybackThread_l(output);
835        if (thread == NULL) {
836            return 0.0f;
837        }
838        volume = thread->streamVolume(stream);
839    } else {
840        volume = streamVolume_l(stream);
841    }
842
843    return volume;
844}
845
846bool AudioFlinger::streamMute(audio_stream_type_t stream) const
847{
848    if (uint32_t(stream) >= AUDIO_STREAM_CNT) {
849        return true;
850    }
851
852    AutoMutex lock(mLock);
853    return streamMute_l(stream);
854}
855
856status_t AudioFlinger::setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs)
857{
858    ALOGV("setParameters(): io %d, keyvalue %s, calling pid %d",
859            ioHandle, keyValuePairs.string(), IPCThreadState::self()->getCallingPid());
860
861    // check calling permissions
862    if (!settingsAllowed()) {
863        return PERMISSION_DENIED;
864    }
865
866    // ioHandle == 0 means the parameters are global to the audio hardware interface
867    if (ioHandle == 0) {
868        Mutex::Autolock _l(mLock);
869        status_t final_result = NO_ERROR;
870        {
871            AutoMutex lock(mHardwareLock);
872            mHardwareStatus = AUDIO_HW_SET_PARAMETER;
873            for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
874                audio_hw_device_t *dev = mAudioHwDevs.valueAt(i)->hwDevice();
875                status_t result = dev->set_parameters(dev, keyValuePairs.string());
876                final_result = result ?: final_result;
877            }
878            mHardwareStatus = AUDIO_HW_IDLE;
879        }
880        // disable AEC and NS if the device is a BT SCO headset supporting those pre processings
881        AudioParameter param = AudioParameter(keyValuePairs);
882        String8 value;
883        if (param.get(String8(AUDIO_PARAMETER_KEY_BT_NREC), value) == NO_ERROR) {
884            bool btNrecIsOff = (value == AUDIO_PARAMETER_VALUE_OFF);
885            if (mBtNrecIsOff != btNrecIsOff) {
886                for (size_t i = 0; i < mRecordThreads.size(); i++) {
887                    sp<RecordThread> thread = mRecordThreads.valueAt(i);
888                    audio_devices_t device = thread->inDevice();
889                    bool suspend = audio_is_bluetooth_sco_device(device) && btNrecIsOff;
890                    // collect all of the thread's session IDs
891                    KeyedVector<int, bool> ids = thread->sessionIds();
892                    // suspend effects associated with those session IDs
893                    for (size_t j = 0; j < ids.size(); ++j) {
894                        int sessionId = ids.keyAt(j);
895                        thread->setEffectSuspended(FX_IID_AEC,
896                                                   suspend,
897                                                   sessionId);
898                        thread->setEffectSuspended(FX_IID_NS,
899                                                   suspend,
900                                                   sessionId);
901                    }
902                }
903                mBtNrecIsOff = btNrecIsOff;
904            }
905        }
906        String8 screenState;
907        if (param.get(String8(AudioParameter::keyScreenState), screenState) == NO_ERROR) {
908            bool isOff = screenState == "off";
909            if (isOff != (AudioFlinger::mScreenState & 1)) {
910                AudioFlinger::mScreenState = ((AudioFlinger::mScreenState & ~1) + 2) | isOff;
911            }
912        }
913        return final_result;
914    }
915
916    // hold a strong ref on thread in case closeOutput() or closeInput() is called
917    // and the thread is exited once the lock is released
918    sp<ThreadBase> thread;
919    {
920        Mutex::Autolock _l(mLock);
921        thread = checkPlaybackThread_l(ioHandle);
922        if (thread == 0) {
923            thread = checkRecordThread_l(ioHandle);
924        } else if (thread == primaryPlaybackThread_l()) {
925            // indicate output device change to all input threads for pre processing
926            AudioParameter param = AudioParameter(keyValuePairs);
927            int value;
928            if ((param.getInt(String8(AudioParameter::keyRouting), value) == NO_ERROR) &&
929                    (value != 0)) {
930                for (size_t i = 0; i < mRecordThreads.size(); i++) {
931                    mRecordThreads.valueAt(i)->setParameters(keyValuePairs);
932                }
933            }
934        }
935    }
936    if (thread != 0) {
937        return thread->setParameters(keyValuePairs);
938    }
939    return BAD_VALUE;
940}
941
942String8 AudioFlinger::getParameters(audio_io_handle_t ioHandle, const String8& keys) const
943{
944    ALOGVV("getParameters() io %d, keys %s, calling pid %d",
945            ioHandle, keys.string(), IPCThreadState::self()->getCallingPid());
946
947    Mutex::Autolock _l(mLock);
948
949    if (ioHandle == 0) {
950        String8 out_s8;
951
952        for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
953            char *s;
954            {
955            AutoMutex lock(mHardwareLock);
956            mHardwareStatus = AUDIO_HW_GET_PARAMETER;
957            audio_hw_device_t *dev = mAudioHwDevs.valueAt(i)->hwDevice();
958            s = dev->get_parameters(dev, keys.string());
959            mHardwareStatus = AUDIO_HW_IDLE;
960            }
961            out_s8 += String8(s ? s : "");
962            free(s);
963        }
964        return out_s8;
965    }
966
967    PlaybackThread *playbackThread = checkPlaybackThread_l(ioHandle);
968    if (playbackThread != NULL) {
969        return playbackThread->getParameters(keys);
970    }
971    RecordThread *recordThread = checkRecordThread_l(ioHandle);
972    if (recordThread != NULL) {
973        return recordThread->getParameters(keys);
974    }
975    return String8("");
976}
977
978size_t AudioFlinger::getInputBufferSize(uint32_t sampleRate, audio_format_t format,
979        audio_channel_mask_t channelMask) const
980{
981    status_t ret = initCheck();
982    if (ret != NO_ERROR) {
983        return 0;
984    }
985
986    AutoMutex lock(mHardwareLock);
987    mHardwareStatus = AUDIO_HW_GET_INPUT_BUFFER_SIZE;
988    struct audio_config config;
989    memset(&config, 0, sizeof(config));
990    config.sample_rate = sampleRate;
991    config.channel_mask = channelMask;
992    config.format = format;
993
994    audio_hw_device_t *dev = mPrimaryHardwareDev->hwDevice();
995    size_t size = dev->get_input_buffer_size(dev, &config);
996    mHardwareStatus = AUDIO_HW_IDLE;
997    return size;
998}
999
1000unsigned int AudioFlinger::getInputFramesLost(audio_io_handle_t ioHandle) const
1001{
1002    Mutex::Autolock _l(mLock);
1003
1004    RecordThread *recordThread = checkRecordThread_l(ioHandle);
1005    if (recordThread != NULL) {
1006        return recordThread->getInputFramesLost();
1007    }
1008    return 0;
1009}
1010
1011status_t AudioFlinger::setVoiceVolume(float value)
1012{
1013    status_t ret = initCheck();
1014    if (ret != NO_ERROR) {
1015        return ret;
1016    }
1017
1018    // check calling permissions
1019    if (!settingsAllowed()) {
1020        return PERMISSION_DENIED;
1021    }
1022
1023    AutoMutex lock(mHardwareLock);
1024    audio_hw_device_t *dev = mPrimaryHardwareDev->hwDevice();
1025    mHardwareStatus = AUDIO_HW_SET_VOICE_VOLUME;
1026    ret = dev->set_voice_volume(dev, value);
1027    mHardwareStatus = AUDIO_HW_IDLE;
1028
1029    return ret;
1030}
1031
1032status_t AudioFlinger::getRenderPosition(size_t *halFrames, size_t *dspFrames,
1033        audio_io_handle_t output) const
1034{
1035    status_t status;
1036
1037    Mutex::Autolock _l(mLock);
1038
1039    PlaybackThread *playbackThread = checkPlaybackThread_l(output);
1040    if (playbackThread != NULL) {
1041        return playbackThread->getRenderPosition(halFrames, dspFrames);
1042    }
1043
1044    return BAD_VALUE;
1045}
1046
1047void AudioFlinger::registerClient(const sp<IAudioFlingerClient>& client)
1048{
1049
1050    Mutex::Autolock _l(mLock);
1051
1052    pid_t pid = IPCThreadState::self()->getCallingPid();
1053    if (mNotificationClients.indexOfKey(pid) < 0) {
1054        sp<NotificationClient> notificationClient = new NotificationClient(this,
1055                                                                            client,
1056                                                                            pid);
1057        ALOGV("registerClient() client %p, pid %d", notificationClient.get(), pid);
1058
1059        mNotificationClients.add(pid, notificationClient);
1060
1061        sp<IBinder> binder = client->asBinder();
1062        binder->linkToDeath(notificationClient);
1063
1064        // the config change is always sent from playback or record threads to avoid deadlock
1065        // with AudioSystem::gLock
1066        for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1067            mPlaybackThreads.valueAt(i)->sendIoConfigEvent(AudioSystem::OUTPUT_OPENED);
1068        }
1069
1070        for (size_t i = 0; i < mRecordThreads.size(); i++) {
1071            mRecordThreads.valueAt(i)->sendIoConfigEvent(AudioSystem::INPUT_OPENED);
1072        }
1073    }
1074}
1075
1076void AudioFlinger::removeNotificationClient(pid_t pid)
1077{
1078    Mutex::Autolock _l(mLock);
1079
1080    mNotificationClients.removeItem(pid);
1081
1082    ALOGV("%d died, releasing its sessions", pid);
1083    size_t num = mAudioSessionRefs.size();
1084    bool removed = false;
1085    for (size_t i = 0; i< num; ) {
1086        AudioSessionRef *ref = mAudioSessionRefs.itemAt(i);
1087        ALOGV(" pid %d @ %d", ref->mPid, i);
1088        if (ref->mPid == pid) {
1089            ALOGV(" removing entry for pid %d session %d", pid, ref->mSessionid);
1090            mAudioSessionRefs.removeAt(i);
1091            delete ref;
1092            removed = true;
1093            num--;
1094        } else {
1095            i++;
1096        }
1097    }
1098    if (removed) {
1099        purgeStaleEffects_l();
1100    }
1101}
1102
1103// audioConfigChanged_l() must be called with AudioFlinger::mLock held
1104void AudioFlinger::audioConfigChanged_l(int event, audio_io_handle_t ioHandle, const void *param2)
1105{
1106    size_t size = mNotificationClients.size();
1107    for (size_t i = 0; i < size; i++) {
1108        mNotificationClients.valueAt(i)->audioFlingerClient()->ioConfigChanged(event, ioHandle,
1109                                                                               param2);
1110    }
1111}
1112
1113// removeClient_l() must be called with AudioFlinger::mLock held
1114void AudioFlinger::removeClient_l(pid_t pid)
1115{
1116    ALOGV("removeClient_l() pid %d, calling pid %d", pid,
1117            IPCThreadState::self()->getCallingPid());
1118    mClients.removeItem(pid);
1119}
1120
1121// getEffectThread_l() must be called with AudioFlinger::mLock held
1122sp<AudioFlinger::PlaybackThread> AudioFlinger::getEffectThread_l(int sessionId, int EffectId)
1123{
1124    sp<PlaybackThread> thread;
1125
1126    for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1127        if (mPlaybackThreads.valueAt(i)->getEffect(sessionId, EffectId) != 0) {
1128            ALOG_ASSERT(thread == 0);
1129            thread = mPlaybackThreads.valueAt(i);
1130        }
1131    }
1132
1133    return thread;
1134}
1135
1136
1137
1138// ----------------------------------------------------------------------------
1139
1140AudioFlinger::Client::Client(const sp<AudioFlinger>& audioFlinger, pid_t pid)
1141    :   RefBase(),
1142        mAudioFlinger(audioFlinger),
1143        // FIXME should be a "k" constant not hard-coded, in .h or ro. property, see 4 lines below
1144        mMemoryDealer(new MemoryDealer(1024*1024, "AudioFlinger::Client")),
1145        mPid(pid),
1146        mTimedTrackCount(0)
1147{
1148    // 1 MB of address space is good for 32 tracks, 8 buffers each, 4 KB/buffer
1149}
1150
1151// Client destructor must be called with AudioFlinger::mLock held
1152AudioFlinger::Client::~Client()
1153{
1154    mAudioFlinger->removeClient_l(mPid);
1155}
1156
1157sp<MemoryDealer> AudioFlinger::Client::heap() const
1158{
1159    return mMemoryDealer;
1160}
1161
1162// Reserve one of the limited slots for a timed audio track associated
1163// with this client
1164bool AudioFlinger::Client::reserveTimedTrack()
1165{
1166    const int kMaxTimedTracksPerClient = 4;
1167
1168    Mutex::Autolock _l(mTimedTrackLock);
1169
1170    if (mTimedTrackCount >= kMaxTimedTracksPerClient) {
1171        ALOGW("can not create timed track - pid %d has exceeded the limit",
1172             mPid);
1173        return false;
1174    }
1175
1176    mTimedTrackCount++;
1177    return true;
1178}
1179
1180// Release a slot for a timed audio track
1181void AudioFlinger::Client::releaseTimedTrack()
1182{
1183    Mutex::Autolock _l(mTimedTrackLock);
1184    mTimedTrackCount--;
1185}
1186
1187// ----------------------------------------------------------------------------
1188
1189AudioFlinger::NotificationClient::NotificationClient(const sp<AudioFlinger>& audioFlinger,
1190                                                     const sp<IAudioFlingerClient>& client,
1191                                                     pid_t pid)
1192    : mAudioFlinger(audioFlinger), mPid(pid), mAudioFlingerClient(client)
1193{
1194}
1195
1196AudioFlinger::NotificationClient::~NotificationClient()
1197{
1198}
1199
1200void AudioFlinger::NotificationClient::binderDied(const wp<IBinder>& who)
1201{
1202    sp<NotificationClient> keep(this);
1203    mAudioFlinger->removeNotificationClient(mPid);
1204}
1205
1206
1207// ----------------------------------------------------------------------------
1208
1209sp<IAudioRecord> AudioFlinger::openRecord(
1210        audio_io_handle_t input,
1211        uint32_t sampleRate,
1212        audio_format_t format,
1213        audio_channel_mask_t channelMask,
1214        size_t frameCount,
1215        IAudioFlinger::track_flags_t *flags,
1216        pid_t tid,
1217        int *sessionId,
1218        status_t *status)
1219{
1220    sp<RecordThread::RecordTrack> recordTrack;
1221    sp<RecordHandle> recordHandle;
1222    sp<Client> client;
1223    status_t lStatus;
1224    RecordThread *thread;
1225    size_t inFrameCount;
1226    int lSessionId;
1227
1228    // check calling permissions
1229    if (!recordingAllowed()) {
1230        lStatus = PERMISSION_DENIED;
1231        goto Exit;
1232    }
1233
1234    if (format != AUDIO_FORMAT_PCM_16_BIT) {
1235        ALOGE("openRecord() invalid format %d", format);
1236        lStatus = BAD_VALUE;
1237        goto Exit;
1238    }
1239
1240    // add client to list
1241    { // scope for mLock
1242        Mutex::Autolock _l(mLock);
1243        thread = checkRecordThread_l(input);
1244        if (thread == NULL) {
1245            lStatus = BAD_VALUE;
1246            goto Exit;
1247        }
1248
1249        pid_t pid = IPCThreadState::self()->getCallingPid();
1250        client = registerPid_l(pid);
1251
1252        // If no audio session id is provided, create one here
1253        if (sessionId != NULL && *sessionId != AUDIO_SESSION_OUTPUT_MIX) {
1254            lSessionId = *sessionId;
1255        } else {
1256            lSessionId = nextUniqueId();
1257            if (sessionId != NULL) {
1258                *sessionId = lSessionId;
1259            }
1260        }
1261        // create new record track.
1262        // The record track uses one track in mHardwareMixerThread by convention.
1263        recordTrack = thread->createRecordTrack_l(client, sampleRate, format, channelMask,
1264                                                  frameCount, lSessionId, flags, tid, &lStatus);
1265    }
1266    if (lStatus != NO_ERROR) {
1267        // remove local strong reference to Client before deleting the RecordTrack so that the
1268        // Client destructor is called by the TrackBase destructor with mLock held
1269        client.clear();
1270        recordTrack.clear();
1271        goto Exit;
1272    }
1273
1274    // return to handle to client
1275    recordHandle = new RecordHandle(recordTrack);
1276    lStatus = NO_ERROR;
1277
1278Exit:
1279    if (status) {
1280        *status = lStatus;
1281    }
1282    return recordHandle;
1283}
1284
1285
1286
1287// ----------------------------------------------------------------------------
1288
1289audio_module_handle_t AudioFlinger::loadHwModule(const char *name)
1290{
1291    if (!settingsAllowed()) {
1292        return 0;
1293    }
1294    Mutex::Autolock _l(mLock);
1295    return loadHwModule_l(name);
1296}
1297
1298// loadHwModule_l() must be called with AudioFlinger::mLock held
1299audio_module_handle_t AudioFlinger::loadHwModule_l(const char *name)
1300{
1301    for (size_t i = 0; i < mAudioHwDevs.size(); i++) {
1302        if (strncmp(mAudioHwDevs.valueAt(i)->moduleName(), name, strlen(name)) == 0) {
1303            ALOGW("loadHwModule() module %s already loaded", name);
1304            return mAudioHwDevs.keyAt(i);
1305        }
1306    }
1307
1308    audio_hw_device_t *dev;
1309
1310    int rc = load_audio_interface(name, &dev);
1311    if (rc) {
1312        ALOGI("loadHwModule() error %d loading module %s ", rc, name);
1313        return 0;
1314    }
1315
1316    mHardwareStatus = AUDIO_HW_INIT;
1317    rc = dev->init_check(dev);
1318    mHardwareStatus = AUDIO_HW_IDLE;
1319    if (rc) {
1320        ALOGI("loadHwModule() init check error %d for module %s ", rc, name);
1321        return 0;
1322    }
1323
1324    // Check and cache this HAL's level of support for master mute and master
1325    // volume.  If this is the first HAL opened, and it supports the get
1326    // methods, use the initial values provided by the HAL as the current
1327    // master mute and volume settings.
1328
1329    AudioHwDevice::Flags flags = static_cast<AudioHwDevice::Flags>(0);
1330    {  // scope for auto-lock pattern
1331        AutoMutex lock(mHardwareLock);
1332
1333        if (0 == mAudioHwDevs.size()) {
1334            mHardwareStatus = AUDIO_HW_GET_MASTER_VOLUME;
1335            if (NULL != dev->get_master_volume) {
1336                float mv;
1337                if (OK == dev->get_master_volume(dev, &mv)) {
1338                    mMasterVolume = mv;
1339                }
1340            }
1341
1342            mHardwareStatus = AUDIO_HW_GET_MASTER_MUTE;
1343            if (NULL != dev->get_master_mute) {
1344                bool mm;
1345                if (OK == dev->get_master_mute(dev, &mm)) {
1346                    mMasterMute = mm;
1347                }
1348            }
1349        }
1350
1351        mHardwareStatus = AUDIO_HW_SET_MASTER_VOLUME;
1352        if ((NULL != dev->set_master_volume) &&
1353            (OK == dev->set_master_volume(dev, mMasterVolume))) {
1354            flags = static_cast<AudioHwDevice::Flags>(flags |
1355                    AudioHwDevice::AHWD_CAN_SET_MASTER_VOLUME);
1356        }
1357
1358        mHardwareStatus = AUDIO_HW_SET_MASTER_MUTE;
1359        if ((NULL != dev->set_master_mute) &&
1360            (OK == dev->set_master_mute(dev, mMasterMute))) {
1361            flags = static_cast<AudioHwDevice::Flags>(flags |
1362                    AudioHwDevice::AHWD_CAN_SET_MASTER_MUTE);
1363        }
1364
1365        mHardwareStatus = AUDIO_HW_IDLE;
1366    }
1367
1368    audio_module_handle_t handle = nextUniqueId();
1369    mAudioHwDevs.add(handle, new AudioHwDevice(name, dev, flags));
1370
1371    ALOGI("loadHwModule() Loaded %s audio interface from %s (%s) handle %d",
1372          name, dev->common.module->name, dev->common.module->id, handle);
1373
1374    return handle;
1375
1376}
1377
1378// ----------------------------------------------------------------------------
1379
1380uint32_t AudioFlinger::getPrimaryOutputSamplingRate()
1381{
1382    Mutex::Autolock _l(mLock);
1383    PlaybackThread *thread = primaryPlaybackThread_l();
1384    return thread != NULL ? thread->sampleRate() : 0;
1385}
1386
1387size_t AudioFlinger::getPrimaryOutputFrameCount()
1388{
1389    Mutex::Autolock _l(mLock);
1390    PlaybackThread *thread = primaryPlaybackThread_l();
1391    return thread != NULL ? thread->frameCountHAL() : 0;
1392}
1393
1394// ----------------------------------------------------------------------------
1395
1396status_t AudioFlinger::setLowRamDevice(bool isLowRamDevice)
1397{
1398    uid_t uid = IPCThreadState::self()->getCallingUid();
1399    if (uid != AID_SYSTEM) {
1400        return PERMISSION_DENIED;
1401    }
1402    Mutex::Autolock _l(mLock);
1403    if (mIsDeviceTypeKnown) {
1404        return INVALID_OPERATION;
1405    }
1406    mIsLowRamDevice = isLowRamDevice;
1407    mIsDeviceTypeKnown = true;
1408    return NO_ERROR;
1409}
1410
1411// ----------------------------------------------------------------------------
1412
1413audio_io_handle_t AudioFlinger::openOutput(audio_module_handle_t module,
1414                                           audio_devices_t *pDevices,
1415                                           uint32_t *pSamplingRate,
1416                                           audio_format_t *pFormat,
1417                                           audio_channel_mask_t *pChannelMask,
1418                                           uint32_t *pLatencyMs,
1419                                           audio_output_flags_t flags,
1420                                           const audio_offload_info_t *offloadInfo)
1421{
1422    PlaybackThread *thread = NULL;
1423    struct audio_config config;
1424    memset(&config, 0, sizeof(config));
1425    config.sample_rate = (pSamplingRate != NULL) ? *pSamplingRate : 0;
1426    config.channel_mask = (pChannelMask != NULL) ? *pChannelMask : 0;
1427    config.format = (pFormat != NULL) ? *pFormat : AUDIO_FORMAT_DEFAULT;
1428    if (offloadInfo) {
1429        config.offload_info = *offloadInfo;
1430    }
1431
1432    audio_stream_out_t *outStream = NULL;
1433    AudioHwDevice *outHwDev;
1434
1435    ALOGV("openOutput(), module %d Device %x, SamplingRate %d, Format %#08x, Channels %x, flags %x",
1436              module,
1437              (pDevices != NULL) ? *pDevices : 0,
1438              config.sample_rate,
1439              config.format,
1440              config.channel_mask,
1441              flags);
1442    ALOGV("openOutput(), offloadInfo %p version 0x%04x",
1443          offloadInfo, offloadInfo == NULL ? -1 : offloadInfo->version );
1444
1445    if (pDevices == NULL || *pDevices == 0) {
1446        return 0;
1447    }
1448
1449    Mutex::Autolock _l(mLock);
1450
1451    outHwDev = findSuitableHwDev_l(module, *pDevices);
1452    if (outHwDev == NULL)
1453        return 0;
1454
1455    audio_hw_device_t *hwDevHal = outHwDev->hwDevice();
1456    audio_io_handle_t id = nextUniqueId();
1457
1458    mHardwareStatus = AUDIO_HW_OUTPUT_OPEN;
1459
1460    status_t status = hwDevHal->open_output_stream(hwDevHal,
1461                                          id,
1462                                          *pDevices,
1463                                          (audio_output_flags_t)flags,
1464                                          &config,
1465                                          &outStream);
1466
1467    mHardwareStatus = AUDIO_HW_IDLE;
1468    ALOGV("openOutput() openOutputStream returned output %p, SamplingRate %d, Format %#08x, "
1469            "Channels %x, status %d",
1470            outStream,
1471            config.sample_rate,
1472            config.format,
1473            config.channel_mask,
1474            status);
1475
1476    if (status == NO_ERROR && outStream != NULL) {
1477        AudioStreamOut *output = new AudioStreamOut(outHwDev, outStream, flags);
1478
1479        if (flags & AUDIO_OUTPUT_FLAG_COMPRESS_OFFLOAD) {
1480            thread = new OffloadThread(this, output, id, *pDevices);
1481            ALOGV("openOutput() created offload output: ID %d thread %p", id, thread);
1482        } else if ((flags & AUDIO_OUTPUT_FLAG_DIRECT) ||
1483            (config.format != AUDIO_FORMAT_PCM_16_BIT) ||
1484            (config.channel_mask != AUDIO_CHANNEL_OUT_STEREO)) {
1485            thread = new DirectOutputThread(this, output, id, *pDevices);
1486            ALOGV("openOutput() created direct output: ID %d thread %p", id, thread);
1487        } else {
1488            thread = new MixerThread(this, output, id, *pDevices);
1489            ALOGV("openOutput() created mixer output: ID %d thread %p", id, thread);
1490        }
1491        mPlaybackThreads.add(id, thread);
1492
1493        if (pSamplingRate != NULL) {
1494            *pSamplingRate = config.sample_rate;
1495        }
1496        if (pFormat != NULL) {
1497            *pFormat = config.format;
1498        }
1499        if (pChannelMask != NULL) {
1500            *pChannelMask = config.channel_mask;
1501        }
1502        if (pLatencyMs != NULL) {
1503            *pLatencyMs = thread->latency();
1504        }
1505
1506        // notify client processes of the new output creation
1507        thread->audioConfigChanged_l(AudioSystem::OUTPUT_OPENED);
1508
1509        // the first primary output opened designates the primary hw device
1510        if ((mPrimaryHardwareDev == NULL) && (flags & AUDIO_OUTPUT_FLAG_PRIMARY)) {
1511            ALOGI("Using module %d has the primary audio interface", module);
1512            mPrimaryHardwareDev = outHwDev;
1513
1514            AutoMutex lock(mHardwareLock);
1515            mHardwareStatus = AUDIO_HW_SET_MODE;
1516            hwDevHal->set_mode(hwDevHal, mMode);
1517            mHardwareStatus = AUDIO_HW_IDLE;
1518        }
1519        return id;
1520    }
1521
1522    return 0;
1523}
1524
1525audio_io_handle_t AudioFlinger::openDuplicateOutput(audio_io_handle_t output1,
1526        audio_io_handle_t output2)
1527{
1528    Mutex::Autolock _l(mLock);
1529    MixerThread *thread1 = checkMixerThread_l(output1);
1530    MixerThread *thread2 = checkMixerThread_l(output2);
1531
1532    if (thread1 == NULL || thread2 == NULL) {
1533        ALOGW("openDuplicateOutput() wrong output mixer type for output %d or %d", output1,
1534                output2);
1535        return 0;
1536    }
1537
1538    audio_io_handle_t id = nextUniqueId();
1539    DuplicatingThread *thread = new DuplicatingThread(this, thread1, id);
1540    thread->addOutputTrack(thread2);
1541    mPlaybackThreads.add(id, thread);
1542    // notify client processes of the new output creation
1543    thread->audioConfigChanged_l(AudioSystem::OUTPUT_OPENED);
1544    return id;
1545}
1546
1547status_t AudioFlinger::closeOutput(audio_io_handle_t output)
1548{
1549    return closeOutput_nonvirtual(output);
1550}
1551
1552status_t AudioFlinger::closeOutput_nonvirtual(audio_io_handle_t output)
1553{
1554    // keep strong reference on the playback thread so that
1555    // it is not destroyed while exit() is executed
1556    sp<PlaybackThread> thread;
1557    {
1558        Mutex::Autolock _l(mLock);
1559        thread = checkPlaybackThread_l(output);
1560        if (thread == NULL) {
1561            return BAD_VALUE;
1562        }
1563
1564        ALOGV("closeOutput() %d", output);
1565
1566        if (thread->type() == ThreadBase::MIXER) {
1567            for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1568                if (mPlaybackThreads.valueAt(i)->type() == ThreadBase::DUPLICATING) {
1569                    DuplicatingThread *dupThread =
1570                            (DuplicatingThread *)mPlaybackThreads.valueAt(i).get();
1571                    dupThread->removeOutputTrack((MixerThread *)thread.get());
1572
1573                }
1574            }
1575        }
1576
1577
1578        mPlaybackThreads.removeItem(output);
1579        // save all effects to the default thread
1580        if (mPlaybackThreads.size()) {
1581            PlaybackThread *dstThread = checkPlaybackThread_l(mPlaybackThreads.keyAt(0));
1582            if (dstThread != NULL) {
1583                // audioflinger lock is held here so the acquisition order of thread locks does not
1584                // matter
1585                Mutex::Autolock _dl(dstThread->mLock);
1586                Mutex::Autolock _sl(thread->mLock);
1587                Vector< sp<EffectChain> > effectChains = thread->getEffectChains_l();
1588                for (size_t i = 0; i < effectChains.size(); i ++) {
1589                    moveEffectChain_l(effectChains[i]->sessionId(), thread.get(), dstThread, true);
1590                }
1591            }
1592        }
1593        audioConfigChanged_l(AudioSystem::OUTPUT_CLOSED, output, NULL);
1594    }
1595    thread->exit();
1596    // The thread entity (active unit of execution) is no longer running here,
1597    // but the ThreadBase container still exists.
1598
1599    if (thread->type() != ThreadBase::DUPLICATING) {
1600        AudioStreamOut *out = thread->clearOutput();
1601        ALOG_ASSERT(out != NULL, "out shouldn't be NULL");
1602        // from now on thread->mOutput is NULL
1603        out->hwDev()->close_output_stream(out->hwDev(), out->stream);
1604        delete out;
1605    }
1606    return NO_ERROR;
1607}
1608
1609status_t AudioFlinger::suspendOutput(audio_io_handle_t output)
1610{
1611    Mutex::Autolock _l(mLock);
1612    PlaybackThread *thread = checkPlaybackThread_l(output);
1613
1614    if (thread == NULL) {
1615        return BAD_VALUE;
1616    }
1617
1618    ALOGV("suspendOutput() %d", output);
1619    thread->suspend();
1620
1621    return NO_ERROR;
1622}
1623
1624status_t AudioFlinger::restoreOutput(audio_io_handle_t output)
1625{
1626    Mutex::Autolock _l(mLock);
1627    PlaybackThread *thread = checkPlaybackThread_l(output);
1628
1629    if (thread == NULL) {
1630        return BAD_VALUE;
1631    }
1632
1633    ALOGV("restoreOutput() %d", output);
1634
1635    thread->restore();
1636
1637    return NO_ERROR;
1638}
1639
1640audio_io_handle_t AudioFlinger::openInput(audio_module_handle_t module,
1641                                          audio_devices_t *pDevices,
1642                                          uint32_t *pSamplingRate,
1643                                          audio_format_t *pFormat,
1644                                          audio_channel_mask_t *pChannelMask)
1645{
1646    status_t status;
1647    RecordThread *thread = NULL;
1648    struct audio_config config;
1649    memset(&config, 0, sizeof(config));
1650    config.sample_rate = (pSamplingRate != NULL) ? *pSamplingRate : 0;
1651    config.channel_mask = (pChannelMask != NULL) ? *pChannelMask : 0;
1652    config.format = (pFormat != NULL) ? *pFormat : AUDIO_FORMAT_DEFAULT;
1653
1654    uint32_t reqSamplingRate = config.sample_rate;
1655    audio_format_t reqFormat = config.format;
1656    audio_channel_mask_t reqChannels = config.channel_mask;
1657    audio_stream_in_t *inStream = NULL;
1658    AudioHwDevice *inHwDev;
1659
1660    if (pDevices == NULL || *pDevices == 0) {
1661        return 0;
1662    }
1663
1664    Mutex::Autolock _l(mLock);
1665
1666    inHwDev = findSuitableHwDev_l(module, *pDevices);
1667    if (inHwDev == NULL)
1668        return 0;
1669
1670    audio_hw_device_t *inHwHal = inHwDev->hwDevice();
1671    audio_io_handle_t id = nextUniqueId();
1672
1673    status = inHwHal->open_input_stream(inHwHal, id, *pDevices, &config,
1674                                        &inStream);
1675    ALOGV("openInput() openInputStream returned input %p, SamplingRate %d, Format %d, Channels %x, "
1676            "status %d",
1677            inStream,
1678            config.sample_rate,
1679            config.format,
1680            config.channel_mask,
1681            status);
1682
1683    // If the input could not be opened with the requested parameters and we can handle the
1684    // conversion internally, try to open again with the proposed parameters. The AudioFlinger can
1685    // resample the input and do mono to stereo or stereo to mono conversions on 16 bit PCM inputs.
1686    if (status == BAD_VALUE &&
1687        reqFormat == config.format && config.format == AUDIO_FORMAT_PCM_16_BIT &&
1688        (config.sample_rate <= 2 * reqSamplingRate) &&
1689        (popcount(config.channel_mask) <= FCC_2) && (popcount(reqChannels) <= FCC_2)) {
1690        ALOGV("openInput() reopening with proposed sampling rate and channel mask");
1691        inStream = NULL;
1692        status = inHwHal->open_input_stream(inHwHal, id, *pDevices, &config, &inStream);
1693    }
1694
1695    if (status == NO_ERROR && inStream != NULL) {
1696
1697#ifdef TEE_SINK
1698        // Try to re-use most recently used Pipe to archive a copy of input for dumpsys,
1699        // or (re-)create if current Pipe is idle and does not match the new format
1700        sp<NBAIO_Sink> teeSink;
1701        enum {
1702            TEE_SINK_NO,    // don't copy input
1703            TEE_SINK_NEW,   // copy input using a new pipe
1704            TEE_SINK_OLD,   // copy input using an existing pipe
1705        } kind;
1706        NBAIO_Format format = Format_from_SR_C(inStream->common.get_sample_rate(&inStream->common),
1707                                        popcount(inStream->common.get_channels(&inStream->common)));
1708        if (!mTeeSinkInputEnabled) {
1709            kind = TEE_SINK_NO;
1710        } else if (format == Format_Invalid) {
1711            kind = TEE_SINK_NO;
1712        } else if (mRecordTeeSink == 0) {
1713            kind = TEE_SINK_NEW;
1714        } else if (mRecordTeeSink->getStrongCount() != 1) {
1715            kind = TEE_SINK_NO;
1716        } else if (format == mRecordTeeSink->format()) {
1717            kind = TEE_SINK_OLD;
1718        } else {
1719            kind = TEE_SINK_NEW;
1720        }
1721        switch (kind) {
1722        case TEE_SINK_NEW: {
1723            Pipe *pipe = new Pipe(mTeeSinkInputFrames, format);
1724            size_t numCounterOffers = 0;
1725            const NBAIO_Format offers[1] = {format};
1726            ssize_t index = pipe->negotiate(offers, 1, NULL, numCounterOffers);
1727            ALOG_ASSERT(index == 0);
1728            PipeReader *pipeReader = new PipeReader(*pipe);
1729            numCounterOffers = 0;
1730            index = pipeReader->negotiate(offers, 1, NULL, numCounterOffers);
1731            ALOG_ASSERT(index == 0);
1732            mRecordTeeSink = pipe;
1733            mRecordTeeSource = pipeReader;
1734            teeSink = pipe;
1735            }
1736            break;
1737        case TEE_SINK_OLD:
1738            teeSink = mRecordTeeSink;
1739            break;
1740        case TEE_SINK_NO:
1741        default:
1742            break;
1743        }
1744#endif
1745
1746        AudioStreamIn *input = new AudioStreamIn(inHwDev, inStream);
1747
1748        // Start record thread
1749        // RecordThread requires both input and output device indication to forward to audio
1750        // pre processing modules
1751        thread = new RecordThread(this,
1752                                  input,
1753                                  reqSamplingRate,
1754                                  reqChannels,
1755                                  id,
1756                                  primaryOutputDevice_l(),
1757                                  *pDevices
1758#ifdef TEE_SINK
1759                                  , teeSink
1760#endif
1761                                  );
1762        mRecordThreads.add(id, thread);
1763        ALOGV("openInput() created record thread: ID %d thread %p", id, thread);
1764        if (pSamplingRate != NULL) {
1765            *pSamplingRate = reqSamplingRate;
1766        }
1767        if (pFormat != NULL) {
1768            *pFormat = config.format;
1769        }
1770        if (pChannelMask != NULL) {
1771            *pChannelMask = reqChannels;
1772        }
1773
1774        // notify client processes of the new input creation
1775        thread->audioConfigChanged_l(AudioSystem::INPUT_OPENED);
1776        return id;
1777    }
1778
1779    return 0;
1780}
1781
1782status_t AudioFlinger::closeInput(audio_io_handle_t input)
1783{
1784    return closeInput_nonvirtual(input);
1785}
1786
1787status_t AudioFlinger::closeInput_nonvirtual(audio_io_handle_t input)
1788{
1789    // keep strong reference on the record thread so that
1790    // it is not destroyed while exit() is executed
1791    sp<RecordThread> thread;
1792    {
1793        Mutex::Autolock _l(mLock);
1794        thread = checkRecordThread_l(input);
1795        if (thread == 0) {
1796            return BAD_VALUE;
1797        }
1798
1799        ALOGV("closeInput() %d", input);
1800        audioConfigChanged_l(AudioSystem::INPUT_CLOSED, input, NULL);
1801        mRecordThreads.removeItem(input);
1802    }
1803    thread->exit();
1804    // The thread entity (active unit of execution) is no longer running here,
1805    // but the ThreadBase container still exists.
1806
1807    AudioStreamIn *in = thread->clearInput();
1808    ALOG_ASSERT(in != NULL, "in shouldn't be NULL");
1809    // from now on thread->mInput is NULL
1810    in->hwDev()->close_input_stream(in->hwDev(), in->stream);
1811    delete in;
1812
1813    return NO_ERROR;
1814}
1815
1816status_t AudioFlinger::setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output)
1817{
1818    Mutex::Autolock _l(mLock);
1819    ALOGV("setStreamOutput() stream %d to output %d", stream, output);
1820
1821    for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1822        PlaybackThread *thread = mPlaybackThreads.valueAt(i).get();
1823        thread->invalidateTracks(stream);
1824    }
1825
1826    return NO_ERROR;
1827}
1828
1829
1830int AudioFlinger::newAudioSessionId()
1831{
1832    return nextUniqueId();
1833}
1834
1835void AudioFlinger::acquireAudioSessionId(int audioSession)
1836{
1837    Mutex::Autolock _l(mLock);
1838    pid_t caller = IPCThreadState::self()->getCallingPid();
1839    ALOGV("acquiring %d from %d", audioSession, caller);
1840    size_t num = mAudioSessionRefs.size();
1841    for (size_t i = 0; i< num; i++) {
1842        AudioSessionRef *ref = mAudioSessionRefs.editItemAt(i);
1843        if (ref->mSessionid == audioSession && ref->mPid == caller) {
1844            ref->mCnt++;
1845            ALOGV(" incremented refcount to %d", ref->mCnt);
1846            return;
1847        }
1848    }
1849    mAudioSessionRefs.push(new AudioSessionRef(audioSession, caller));
1850    ALOGV(" added new entry for %d", audioSession);
1851}
1852
1853void AudioFlinger::releaseAudioSessionId(int audioSession)
1854{
1855    Mutex::Autolock _l(mLock);
1856    pid_t caller = IPCThreadState::self()->getCallingPid();
1857    ALOGV("releasing %d from %d", audioSession, caller);
1858    size_t num = mAudioSessionRefs.size();
1859    for (size_t i = 0; i< num; i++) {
1860        AudioSessionRef *ref = mAudioSessionRefs.itemAt(i);
1861        if (ref->mSessionid == audioSession && ref->mPid == caller) {
1862            ref->mCnt--;
1863            ALOGV(" decremented refcount to %d", ref->mCnt);
1864            if (ref->mCnt == 0) {
1865                mAudioSessionRefs.removeAt(i);
1866                delete ref;
1867                purgeStaleEffects_l();
1868            }
1869            return;
1870        }
1871    }
1872    ALOGW("session id %d not found for pid %d", audioSession, caller);
1873}
1874
1875void AudioFlinger::purgeStaleEffects_l() {
1876
1877    ALOGV("purging stale effects");
1878
1879    Vector< sp<EffectChain> > chains;
1880
1881    for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1882        sp<PlaybackThread> t = mPlaybackThreads.valueAt(i);
1883        for (size_t j = 0; j < t->mEffectChains.size(); j++) {
1884            sp<EffectChain> ec = t->mEffectChains[j];
1885            if (ec->sessionId() > AUDIO_SESSION_OUTPUT_MIX) {
1886                chains.push(ec);
1887            }
1888        }
1889    }
1890    for (size_t i = 0; i < mRecordThreads.size(); i++) {
1891        sp<RecordThread> t = mRecordThreads.valueAt(i);
1892        for (size_t j = 0; j < t->mEffectChains.size(); j++) {
1893            sp<EffectChain> ec = t->mEffectChains[j];
1894            chains.push(ec);
1895        }
1896    }
1897
1898    for (size_t i = 0; i < chains.size(); i++) {
1899        sp<EffectChain> ec = chains[i];
1900        int sessionid = ec->sessionId();
1901        sp<ThreadBase> t = ec->mThread.promote();
1902        if (t == 0) {
1903            continue;
1904        }
1905        size_t numsessionrefs = mAudioSessionRefs.size();
1906        bool found = false;
1907        for (size_t k = 0; k < numsessionrefs; k++) {
1908            AudioSessionRef *ref = mAudioSessionRefs.itemAt(k);
1909            if (ref->mSessionid == sessionid) {
1910                ALOGV(" session %d still exists for %d with %d refs",
1911                    sessionid, ref->mPid, ref->mCnt);
1912                found = true;
1913                break;
1914            }
1915        }
1916        if (!found) {
1917            Mutex::Autolock _l (t->mLock);
1918            // remove all effects from the chain
1919            while (ec->mEffects.size()) {
1920                sp<EffectModule> effect = ec->mEffects[0];
1921                effect->unPin();
1922                t->removeEffect_l(effect);
1923                if (effect->purgeHandles()) {
1924                    t->checkSuspendOnEffectEnabled_l(effect, false, effect->sessionId());
1925                }
1926                AudioSystem::unregisterEffect(effect->id());
1927            }
1928        }
1929    }
1930    return;
1931}
1932
1933// checkPlaybackThread_l() must be called with AudioFlinger::mLock held
1934AudioFlinger::PlaybackThread *AudioFlinger::checkPlaybackThread_l(audio_io_handle_t output) const
1935{
1936    return mPlaybackThreads.valueFor(output).get();
1937}
1938
1939// checkMixerThread_l() must be called with AudioFlinger::mLock held
1940AudioFlinger::MixerThread *AudioFlinger::checkMixerThread_l(audio_io_handle_t output) const
1941{
1942    PlaybackThread *thread = checkPlaybackThread_l(output);
1943    return thread != NULL && thread->type() != ThreadBase::DIRECT ? (MixerThread *) thread : NULL;
1944}
1945
1946// checkRecordThread_l() must be called with AudioFlinger::mLock held
1947AudioFlinger::RecordThread *AudioFlinger::checkRecordThread_l(audio_io_handle_t input) const
1948{
1949    return mRecordThreads.valueFor(input).get();
1950}
1951
1952uint32_t AudioFlinger::nextUniqueId()
1953{
1954    return android_atomic_inc(&mNextUniqueId);
1955}
1956
1957AudioFlinger::PlaybackThread *AudioFlinger::primaryPlaybackThread_l() const
1958{
1959    for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1960        PlaybackThread *thread = mPlaybackThreads.valueAt(i).get();
1961        AudioStreamOut *output = thread->getOutput();
1962        if (output != NULL && output->audioHwDev == mPrimaryHardwareDev) {
1963            return thread;
1964        }
1965    }
1966    return NULL;
1967}
1968
1969audio_devices_t AudioFlinger::primaryOutputDevice_l() const
1970{
1971    PlaybackThread *thread = primaryPlaybackThread_l();
1972
1973    if (thread == NULL) {
1974        return 0;
1975    }
1976
1977    return thread->outDevice();
1978}
1979
1980sp<AudioFlinger::SyncEvent> AudioFlinger::createSyncEvent(AudioSystem::sync_event_t type,
1981                                    int triggerSession,
1982                                    int listenerSession,
1983                                    sync_event_callback_t callBack,
1984                                    void *cookie)
1985{
1986    Mutex::Autolock _l(mLock);
1987
1988    sp<SyncEvent> event = new SyncEvent(type, triggerSession, listenerSession, callBack, cookie);
1989    status_t playStatus = NAME_NOT_FOUND;
1990    status_t recStatus = NAME_NOT_FOUND;
1991    for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
1992        playStatus = mPlaybackThreads.valueAt(i)->setSyncEvent(event);
1993        if (playStatus == NO_ERROR) {
1994            return event;
1995        }
1996    }
1997    for (size_t i = 0; i < mRecordThreads.size(); i++) {
1998        recStatus = mRecordThreads.valueAt(i)->setSyncEvent(event);
1999        if (recStatus == NO_ERROR) {
2000            return event;
2001        }
2002    }
2003    if (playStatus == NAME_NOT_FOUND || recStatus == NAME_NOT_FOUND) {
2004        mPendingSyncEvents.add(event);
2005    } else {
2006        ALOGV("createSyncEvent() invalid event %d", event->type());
2007        event.clear();
2008    }
2009    return event;
2010}
2011
2012// ----------------------------------------------------------------------------
2013//  Effect management
2014// ----------------------------------------------------------------------------
2015
2016
2017status_t AudioFlinger::queryNumberEffects(uint32_t *numEffects) const
2018{
2019    Mutex::Autolock _l(mLock);
2020    return EffectQueryNumberEffects(numEffects);
2021}
2022
2023status_t AudioFlinger::queryEffect(uint32_t index, effect_descriptor_t *descriptor) const
2024{
2025    Mutex::Autolock _l(mLock);
2026    return EffectQueryEffect(index, descriptor);
2027}
2028
2029status_t AudioFlinger::getEffectDescriptor(const effect_uuid_t *pUuid,
2030        effect_descriptor_t *descriptor) const
2031{
2032    Mutex::Autolock _l(mLock);
2033    return EffectGetDescriptor(pUuid, descriptor);
2034}
2035
2036
2037sp<IEffect> AudioFlinger::createEffect(
2038        effect_descriptor_t *pDesc,
2039        const sp<IEffectClient>& effectClient,
2040        int32_t priority,
2041        audio_io_handle_t io,
2042        int sessionId,
2043        status_t *status,
2044        int *id,
2045        int *enabled)
2046{
2047    status_t lStatus = NO_ERROR;
2048    sp<EffectHandle> handle;
2049    effect_descriptor_t desc;
2050
2051    pid_t pid = IPCThreadState::self()->getCallingPid();
2052    ALOGV("createEffect pid %d, effectClient %p, priority %d, sessionId %d, io %d",
2053            pid, effectClient.get(), priority, sessionId, io);
2054
2055    if (pDesc == NULL) {
2056        lStatus = BAD_VALUE;
2057        goto Exit;
2058    }
2059
2060    // check audio settings permission for global effects
2061    if (sessionId == AUDIO_SESSION_OUTPUT_MIX && !settingsAllowed()) {
2062        lStatus = PERMISSION_DENIED;
2063        goto Exit;
2064    }
2065
2066    // Session AUDIO_SESSION_OUTPUT_STAGE is reserved for output stage effects
2067    // that can only be created by audio policy manager (running in same process)
2068    if (sessionId == AUDIO_SESSION_OUTPUT_STAGE && getpid_cached != pid) {
2069        lStatus = PERMISSION_DENIED;
2070        goto Exit;
2071    }
2072
2073    if (io == 0) {
2074        if (sessionId == AUDIO_SESSION_OUTPUT_STAGE) {
2075            // output must be specified by AudioPolicyManager when using session
2076            // AUDIO_SESSION_OUTPUT_STAGE
2077            lStatus = BAD_VALUE;
2078            goto Exit;
2079        } else if (sessionId == AUDIO_SESSION_OUTPUT_MIX) {
2080            // if the output returned by getOutputForEffect() is removed before we lock the
2081            // mutex below, the call to checkPlaybackThread_l(io) below will detect it
2082            // and we will exit safely
2083            io = AudioSystem::getOutputForEffect(&desc);
2084        }
2085    }
2086
2087    {
2088        Mutex::Autolock _l(mLock);
2089
2090
2091        if (!EffectIsNullUuid(&pDesc->uuid)) {
2092            // if uuid is specified, request effect descriptor
2093            lStatus = EffectGetDescriptor(&pDesc->uuid, &desc);
2094            if (lStatus < 0) {
2095                ALOGW("createEffect() error %d from EffectGetDescriptor", lStatus);
2096                goto Exit;
2097            }
2098        } else {
2099            // if uuid is not specified, look for an available implementation
2100            // of the required type in effect factory
2101            if (EffectIsNullUuid(&pDesc->type)) {
2102                ALOGW("createEffect() no effect type");
2103                lStatus = BAD_VALUE;
2104                goto Exit;
2105            }
2106            uint32_t numEffects = 0;
2107            effect_descriptor_t d;
2108            d.flags = 0; // prevent compiler warning
2109            bool found = false;
2110
2111            lStatus = EffectQueryNumberEffects(&numEffects);
2112            if (lStatus < 0) {
2113                ALOGW("createEffect() error %d from EffectQueryNumberEffects", lStatus);
2114                goto Exit;
2115            }
2116            for (uint32_t i = 0; i < numEffects; i++) {
2117                lStatus = EffectQueryEffect(i, &desc);
2118                if (lStatus < 0) {
2119                    ALOGW("createEffect() error %d from EffectQueryEffect", lStatus);
2120                    continue;
2121                }
2122                if (memcmp(&desc.type, &pDesc->type, sizeof(effect_uuid_t)) == 0) {
2123                    // If matching type found save effect descriptor. If the session is
2124                    // 0 and the effect is not auxiliary, continue enumeration in case
2125                    // an auxiliary version of this effect type is available
2126                    found = true;
2127                    d = desc;
2128                    if (sessionId != AUDIO_SESSION_OUTPUT_MIX ||
2129                            (desc.flags & EFFECT_FLAG_TYPE_MASK) == EFFECT_FLAG_TYPE_AUXILIARY) {
2130                        break;
2131                    }
2132                }
2133            }
2134            if (!found) {
2135                lStatus = BAD_VALUE;
2136                ALOGW("createEffect() effect not found");
2137                goto Exit;
2138            }
2139            // For same effect type, chose auxiliary version over insert version if
2140            // connect to output mix (Compliance to OpenSL ES)
2141            if (sessionId == AUDIO_SESSION_OUTPUT_MIX &&
2142                    (d.flags & EFFECT_FLAG_TYPE_MASK) != EFFECT_FLAG_TYPE_AUXILIARY) {
2143                desc = d;
2144            }
2145        }
2146
2147        // Do not allow auxiliary effects on a session different from 0 (output mix)
2148        if (sessionId != AUDIO_SESSION_OUTPUT_MIX &&
2149             (desc.flags & EFFECT_FLAG_TYPE_MASK) == EFFECT_FLAG_TYPE_AUXILIARY) {
2150            lStatus = INVALID_OPERATION;
2151            goto Exit;
2152        }
2153
2154        // check recording permission for visualizer
2155        if ((memcmp(&desc.type, SL_IID_VISUALIZATION, sizeof(effect_uuid_t)) == 0) &&
2156            !recordingAllowed()) {
2157            lStatus = PERMISSION_DENIED;
2158            goto Exit;
2159        }
2160
2161        // return effect descriptor
2162        *pDesc = desc;
2163
2164        // If output is not specified try to find a matching audio session ID in one of the
2165        // output threads.
2166        // If output is 0 here, sessionId is neither SESSION_OUTPUT_STAGE nor SESSION_OUTPUT_MIX
2167        // because of code checking output when entering the function.
2168        // Note: io is never 0 when creating an effect on an input
2169        if (io == 0) {
2170            // look for the thread where the specified audio session is present
2171            for (size_t i = 0; i < mPlaybackThreads.size(); i++) {
2172                if (mPlaybackThreads.valueAt(i)->hasAudioSession(sessionId) != 0) {
2173                    io = mPlaybackThreads.keyAt(i);
2174                    break;
2175                }
2176            }
2177            if (io == 0) {
2178                for (size_t i = 0; i < mRecordThreads.size(); i++) {
2179                    if (mRecordThreads.valueAt(i)->hasAudioSession(sessionId) != 0) {
2180                        io = mRecordThreads.keyAt(i);
2181                        break;
2182                    }
2183                }
2184            }
2185            // If no output thread contains the requested session ID, default to
2186            // first output. The effect chain will be moved to the correct output
2187            // thread when a track with the same session ID is created
2188            if (io == 0 && mPlaybackThreads.size()) {
2189                io = mPlaybackThreads.keyAt(0);
2190            }
2191            ALOGV("createEffect() got io %d for effect %s", io, desc.name);
2192        }
2193        ThreadBase *thread = checkRecordThread_l(io);
2194        if (thread == NULL) {
2195            thread = checkPlaybackThread_l(io);
2196            if (thread == NULL) {
2197                ALOGE("createEffect() unknown output thread");
2198                lStatus = BAD_VALUE;
2199                goto Exit;
2200            }
2201        }
2202
2203        sp<Client> client = registerPid_l(pid);
2204
2205        // create effect on selected output thread
2206        handle = thread->createEffect_l(client, effectClient, priority, sessionId,
2207                &desc, enabled, &lStatus);
2208        if (handle != 0 && id != NULL) {
2209            *id = handle->id();
2210        }
2211    }
2212
2213Exit:
2214    if (status != NULL) {
2215        *status = lStatus;
2216    }
2217    return handle;
2218}
2219
2220status_t AudioFlinger::moveEffects(int sessionId, audio_io_handle_t srcOutput,
2221        audio_io_handle_t dstOutput)
2222{
2223    ALOGV("moveEffects() session %d, srcOutput %d, dstOutput %d",
2224            sessionId, srcOutput, dstOutput);
2225    Mutex::Autolock _l(mLock);
2226    if (srcOutput == dstOutput) {
2227        ALOGW("moveEffects() same dst and src outputs %d", dstOutput);
2228        return NO_ERROR;
2229    }
2230    PlaybackThread *srcThread = checkPlaybackThread_l(srcOutput);
2231    if (srcThread == NULL) {
2232        ALOGW("moveEffects() bad srcOutput %d", srcOutput);
2233        return BAD_VALUE;
2234    }
2235    PlaybackThread *dstThread = checkPlaybackThread_l(dstOutput);
2236    if (dstThread == NULL) {
2237        ALOGW("moveEffects() bad dstOutput %d", dstOutput);
2238        return BAD_VALUE;
2239    }
2240
2241    Mutex::Autolock _dl(dstThread->mLock);
2242    Mutex::Autolock _sl(srcThread->mLock);
2243    moveEffectChain_l(sessionId, srcThread, dstThread, false);
2244
2245    return NO_ERROR;
2246}
2247
2248// moveEffectChain_l must be called with both srcThread and dstThread mLocks held
2249status_t AudioFlinger::moveEffectChain_l(int sessionId,
2250                                   AudioFlinger::PlaybackThread *srcThread,
2251                                   AudioFlinger::PlaybackThread *dstThread,
2252                                   bool reRegister)
2253{
2254    ALOGV("moveEffectChain_l() session %d from thread %p to thread %p",
2255            sessionId, srcThread, dstThread);
2256
2257    sp<EffectChain> chain = srcThread->getEffectChain_l(sessionId);
2258    if (chain == 0) {
2259        ALOGW("moveEffectChain_l() effect chain for session %d not on source thread %p",
2260                sessionId, srcThread);
2261        return INVALID_OPERATION;
2262    }
2263
2264    // remove chain first. This is useful only if reconfiguring effect chain on same output thread,
2265    // so that a new chain is created with correct parameters when first effect is added. This is
2266    // otherwise unnecessary as removeEffect_l() will remove the chain when last effect is
2267    // removed.
2268    srcThread->removeEffectChain_l(chain);
2269
2270    // transfer all effects one by one so that new effect chain is created on new thread with
2271    // correct buffer sizes and audio parameters and effect engines reconfigured accordingly
2272    audio_io_handle_t dstOutput = dstThread->id();
2273    sp<EffectChain> dstChain;
2274    uint32_t strategy = 0; // prevent compiler warning
2275    sp<EffectModule> effect = chain->getEffectFromId_l(0);
2276    while (effect != 0) {
2277        srcThread->removeEffect_l(effect);
2278        dstThread->addEffect_l(effect);
2279        // removeEffect_l() has stopped the effect if it was active so it must be restarted
2280        if (effect->state() == EffectModule::ACTIVE ||
2281                effect->state() == EffectModule::STOPPING) {
2282            effect->start();
2283        }
2284        // if the move request is not received from audio policy manager, the effect must be
2285        // re-registered with the new strategy and output
2286        if (dstChain == 0) {
2287            dstChain = effect->chain().promote();
2288            if (dstChain == 0) {
2289                ALOGW("moveEffectChain_l() cannot get chain from effect %p", effect.get());
2290                srcThread->addEffect_l(effect);
2291                return NO_INIT;
2292            }
2293            strategy = dstChain->strategy();
2294        }
2295        if (reRegister) {
2296            AudioSystem::unregisterEffect(effect->id());
2297            AudioSystem::registerEffect(&effect->desc(),
2298                                        dstOutput,
2299                                        strategy,
2300                                        sessionId,
2301                                        effect->id());
2302        }
2303        effect = chain->getEffectFromId_l(0);
2304    }
2305
2306    return NO_ERROR;
2307}
2308
2309struct Entry {
2310#define MAX_NAME 32     // %Y%m%d%H%M%S_%d.wav
2311    char mName[MAX_NAME];
2312};
2313
2314int comparEntry(const void *p1, const void *p2)
2315{
2316    return strcmp(((const Entry *) p1)->mName, ((const Entry *) p2)->mName);
2317}
2318
2319#ifdef TEE_SINK
2320void AudioFlinger::dumpTee(int fd, const sp<NBAIO_Source>& source, audio_io_handle_t id)
2321{
2322    NBAIO_Source *teeSource = source.get();
2323    if (teeSource != NULL) {
2324        // .wav rotation
2325        // There is a benign race condition if 2 threads call this simultaneously.
2326        // They would both traverse the directory, but the result would simply be
2327        // failures at unlink() which are ignored.  It's also unlikely since
2328        // normally dumpsys is only done by bugreport or from the command line.
2329        char teePath[32+256];
2330        strcpy(teePath, "/data/misc/media");
2331        size_t teePathLen = strlen(teePath);
2332        DIR *dir = opendir(teePath);
2333        teePath[teePathLen++] = '/';
2334        if (dir != NULL) {
2335#define MAX_SORT 20 // number of entries to sort
2336#define MAX_KEEP 10 // number of entries to keep
2337            struct Entry entries[MAX_SORT];
2338            size_t entryCount = 0;
2339            while (entryCount < MAX_SORT) {
2340                struct dirent de;
2341                struct dirent *result = NULL;
2342                int rc = readdir_r(dir, &de, &result);
2343                if (rc != 0) {
2344                    ALOGW("readdir_r failed %d", rc);
2345                    break;
2346                }
2347                if (result == NULL) {
2348                    break;
2349                }
2350                if (result != &de) {
2351                    ALOGW("readdir_r returned unexpected result %p != %p", result, &de);
2352                    break;
2353                }
2354                // ignore non .wav file entries
2355                size_t nameLen = strlen(de.d_name);
2356                if (nameLen <= 4 || nameLen >= MAX_NAME ||
2357                        strcmp(&de.d_name[nameLen - 4], ".wav")) {
2358                    continue;
2359                }
2360                strcpy(entries[entryCount++].mName, de.d_name);
2361            }
2362            (void) closedir(dir);
2363            if (entryCount > MAX_KEEP) {
2364                qsort(entries, entryCount, sizeof(Entry), comparEntry);
2365                for (size_t i = 0; i < entryCount - MAX_KEEP; ++i) {
2366                    strcpy(&teePath[teePathLen], entries[i].mName);
2367                    (void) unlink(teePath);
2368                }
2369            }
2370        } else {
2371            if (fd >= 0) {
2372                fdprintf(fd, "unable to rotate tees in %s: %s\n", teePath, strerror(errno));
2373            }
2374        }
2375        char teeTime[16];
2376        struct timeval tv;
2377        gettimeofday(&tv, NULL);
2378        struct tm tm;
2379        localtime_r(&tv.tv_sec, &tm);
2380        strftime(teeTime, sizeof(teeTime), "%Y%m%d%H%M%S", &tm);
2381        snprintf(&teePath[teePathLen], sizeof(teePath) - teePathLen, "%s_%d.wav", teeTime, id);
2382        // if 2 dumpsys are done within 1 second, and rotation didn't work, then discard 2nd
2383        int teeFd = open(teePath, O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, S_IRUSR | S_IWUSR);
2384        if (teeFd >= 0) {
2385            char wavHeader[44];
2386            memcpy(wavHeader,
2387                "RIFF\0\0\0\0WAVEfmt \20\0\0\0\1\0\2\0\104\254\0\0\0\0\0\0\4\0\20\0data\0\0\0\0",
2388                sizeof(wavHeader));
2389            NBAIO_Format format = teeSource->format();
2390            unsigned channelCount = Format_channelCount(format);
2391            ALOG_ASSERT(channelCount <= FCC_2);
2392            uint32_t sampleRate = Format_sampleRate(format);
2393            wavHeader[22] = channelCount;       // number of channels
2394            wavHeader[24] = sampleRate;         // sample rate
2395            wavHeader[25] = sampleRate >> 8;
2396            wavHeader[32] = channelCount * 2;   // block alignment
2397            write(teeFd, wavHeader, sizeof(wavHeader));
2398            size_t total = 0;
2399            bool firstRead = true;
2400            for (;;) {
2401#define TEE_SINK_READ 1024
2402                short buffer[TEE_SINK_READ * FCC_2];
2403                size_t count = TEE_SINK_READ;
2404                ssize_t actual = teeSource->read(buffer, count,
2405                        AudioBufferProvider::kInvalidPTS);
2406                bool wasFirstRead = firstRead;
2407                firstRead = false;
2408                if (actual <= 0) {
2409                    if (actual == (ssize_t) OVERRUN && wasFirstRead) {
2410                        continue;
2411                    }
2412                    break;
2413                }
2414                ALOG_ASSERT(actual <= (ssize_t)count);
2415                write(teeFd, buffer, actual * channelCount * sizeof(short));
2416                total += actual;
2417            }
2418            lseek(teeFd, (off_t) 4, SEEK_SET);
2419            uint32_t temp = 44 + total * channelCount * sizeof(short) - 8;
2420            write(teeFd, &temp, sizeof(temp));
2421            lseek(teeFd, (off_t) 40, SEEK_SET);
2422            temp =  total * channelCount * sizeof(short);
2423            write(teeFd, &temp, sizeof(temp));
2424            close(teeFd);
2425            if (fd >= 0) {
2426                fdprintf(fd, "tee copied to %s\n", teePath);
2427            }
2428        } else {
2429            if (fd >= 0) {
2430                fdprintf(fd, "unable to create tee %s: %s\n", teePath, strerror(errno));
2431            }
2432        }
2433    }
2434}
2435#endif
2436
2437// ----------------------------------------------------------------------------
2438
2439status_t AudioFlinger::onTransact(
2440        uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags)
2441{
2442    return BnAudioFlinger::onTransact(code, data, reply, flags);
2443}
2444
2445}; // namespace android
2446