settings/sound/VolumeSettingsRingtoneManager.java

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.car.settings.sound;

import android.content.Context;
import android.media.AudioAttributes;
import android.media.Ringtone;
import android.media.RingtoneManager;
import android.net.Uri;
import android.os.Handler;
import android.os.Looper;
import android.provider.Settings;

import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;

import com.android.car.settings.R;
import com.android.car.settings.common.Logger;

import java.util.HashMap;
import java.util.Map;

/** Manges the audio played by the {@link VolumeSettingsPreferenceController}. */
public class VolumeSettingsRingtoneManager {

    private static final Logger LOG = new Logger(VolumeSettingsRingtoneManager.class);

    private static final int AUDIO_FEEDBACK_DURATION_MS = 1000;

    private final Context mContext;
    private final Handler mUiHandler;
    private final Map<Integer, Ringtone> mGroupToRingtoneMap = new HashMap<>();
    private final Map<Integer, Uri> mAttributeUsageToRingtoneUriMap = new HashMap<>();

    @Nullable
    private Ringtone mCurrentRingtone;

    public VolumeSettingsRingtoneManager(Context context) {
        mContext = context;
        mUiHandler = new Handler(Looper.getMainLooper());
        populateAttributeUsageToRingtoneUriMap();
    }

    private void populateAttributeUsageToRingtoneUriMap() {
        int[] audioAttributeUsages = mContext
            .getResources()
            .getIntArray(R.array.config_ringtone_audio_attribute_usages_map_key);
        String[] ringtoneStrings = mContext
            .getResources()
            .getStringArray(R.array.config_ringtone_uri_map_value);
        if (audioAttributeUsages.length != ringtoneStrings.length) {
            throw new IllegalArgumentException(
                "config_ringtone_audio_attribute_usages_map_key and config_ringtone_uri_map_value "
                + "must have the same number of items");
        }

        for (int i = 0; i < audioAttributeUsages.length; i++) {
            @AudioAttributes.AttributeUsage int usage = audioAttributeUsages[i];
            if (AudioAttributes.usageToString(usage).contains("unknown usage")) {
                throw new IllegalArgumentException(
                    "Invalid usage in config_ringtone_audio_attribute_usages_map_key");
            }
            Uri ringtoneUri = Uri.parse(ringtoneStrings[i]);
            LOG.d("Usage " + usage + " mapped to ringtone " + ringtoneUri);
            mAttributeUsageToRingtoneUriMap.put(usage, ringtoneUri);
        }
    }

    /**
     * Play the audio defined by the current group and usage. Stop the current ringtone if it is a
     * different ringtone than what is currently playing.
     */
    public void playAudioFeedback(int group, int usage) {
        Ringtone nextRingtone = lazyLoadRingtone(group, usage);
        if (mCurrentRingtone != null && mCurrentRingtone != nextRingtone
                && mCurrentRingtone.isPlaying()) {
            mCurrentRingtone.stop();
        }

        mUiHandler.removeCallbacksAndMessages(null);
        mCurrentRingtone = nextRingtone;
        if (mCurrentRingtone != null) {
            mCurrentRingtone.play();
            mUiHandler.postDelayed(() -> {
                if (mCurrentRingtone.isPlaying()) {
                    mCurrentRingtone.stop();
                    mCurrentRingtone = null;
                }
            }, AUDIO_FEEDBACK_DURATION_MS);
        }
    }

    /** Stop playing the current ringtone. */
    public void stopCurrentRingtone() {
        if (mCurrentRingtone != null) {
            mCurrentRingtone.stop();
        }
    }

    /** If we have already seen this ringtone, use it. Otherwise load when requested. */
    private Ringtone lazyLoadRingtone(int group, int usage) {
        if (!mGroupToRingtoneMap.containsKey(group)) {
            Ringtone ringtone = RingtoneManager.getRingtone(mContext, getRingtoneUri(usage));
            if (ringtone == null) {
                return null;
            }

            AudioAttributes.Builder builder = new AudioAttributes.Builder();
            if (AudioAttributes.isSystemUsage(usage)) {
                builder.setSystemUsage(usage);
            } else {
                builder.setUsage(usage);
            }

            ringtone.setAudioAttributes(builder.build());
            mGroupToRingtoneMap.put(group, ringtone);
        }
        return mGroupToRingtoneMap.get(group);
    }

    // TODO: bundle car-specific audio sample assets in res/raw by usage
    @VisibleForTesting
    Uri getRingtoneUri(@AudioAttributes.AttributeUsage int usage) {
        return mAttributeUsageToRingtoneUriMap.getOrDefault(
            usage, Settings.System.DEFAULT_RINGTONE_URI);
    }
}