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