settings/sound/VolumeLineItem.java

/*
 * Copyright (C) 2017 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.annotation.DrawableRes;
import android.annotation.StringRes;
import android.car.CarNotConnectedException;
import android.car.media.CarAudioManager;
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 android.widget.SeekBar;

import androidx.car.widget.SeekbarListItem;

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

/**
 * Contains logic about volume controller UI.
 */
public class VolumeLineItem extends SeekbarListItem implements SeekBar.OnSeekBarChangeListener {
    private static final Logger LOG = new Logger(VolumeLineItem.class);
    private static final int AUDIO_FEEDBACK_DURATION_MS = 1000;

    private final Handler mUiHandler;
    private final Ringtone mRingtone;
    private final int mVolumeGroupId;
    private final CarAudioManager mCarAudioManager;

    public VolumeLineItem(
            Context context,
            CarAudioManager carAudioManager,
            int volumeGroupId,
            @AudioAttributes.AttributeUsage int usage,
            @DrawableRes int iconResId,
            @StringRes int titleId) throws CarNotConnectedException {
        super(context);
        mCarAudioManager = carAudioManager;
        mUiHandler = new Handler(Looper.getMainLooper());
        mRingtone = RingtoneManager.getRingtone(context, getRingtoneUri(usage));
        mRingtone.setAudioAttributes(new AudioAttributes.Builder().setUsage(usage).build());
        mVolumeGroupId = volumeGroupId;
        setMax(getMaxSeekbarValue());
        updateProgress();
        setOnSeekBarChangeListener(this);
        setText(context.getString(titleId));
        setPrimaryActionIcon(iconResId);
    }

    @Override
    public void onStartTrackingTouch(SeekBar seekBar) {
        // no-op
    }

    @Override
    public void onStopTrackingTouch(SeekBar seekBar) {
        // no-op
    }

    @Override
    public void onProgressChanged(SeekBar seekBar, int progress, boolean fromUser) {
        if (!fromUser) {
            // For instance, if this event is originated from AudioService,
            // we can ignore it as it has already been handled and doesn't need to be
            // sent back down again.
            return;
        }
        try {
            if (mCarAudioManager == null) {
                LOG.w("Ignoring volume change event because the car isn't connected");
                return;
            }
            // AudioManager.FLAG_PLAY_SOUND does not guarantee play sound, use our own
            // playback here instead.
            mCarAudioManager.setGroupVolume(mVolumeGroupId, progress, 0);
            playAudioFeedback();
        } catch (CarNotConnectedException e) {
            LOG.e("Car is not connected!", e);
        }
    }

    /**
     * Clean ups
     */
    public void stop() {
        mUiHandler.removeCallbacksAndMessages(null);
        mRingtone.stop();
    }

    public int getVolumeGroupId() {
        return mVolumeGroupId;
    }

    /**
     * Gets the latest progress.
     */
    public void updateProgress() {
        setProgress(getSeekbarValue());
    }

    private void playAudioFeedback() {
        mUiHandler.removeCallbacksAndMessages(null);
        mRingtone.play();
        mUiHandler.postDelayed(() -> {
            if (mRingtone.isPlaying()) {
                mRingtone.stop();
            }
        }, AUDIO_FEEDBACK_DURATION_MS);
    }

    // TODO: bundle car-specific audio sample assets in res/raw by usage
    private Uri getRingtoneUri(@AudioAttributes.AttributeUsage int usage) {
        switch (usage) {
            case AudioAttributes.USAGE_NOTIFICATION:
                return Settings.System.DEFAULT_NOTIFICATION_URI;
            case AudioAttributes.USAGE_ALARM:
                return Settings.System.DEFAULT_ALARM_ALERT_URI;
            default:
                return Settings.System.DEFAULT_RINGTONE_URI;
        }
    }

    private int getSeekbarValue() {
        try {
            return mCarAudioManager.getGroupVolume(mVolumeGroupId);
        } catch (CarNotConnectedException e) {
            LOG.e("Car is not connected!", e);
        }
        return 0;
    }

    private int getMaxSeekbarValue() {
        try {
            return mCarAudioManager.getGroupMaxVolume(mVolumeGroupId);
        } catch (CarNotConnectedException e) {
            LOG.e("Car is not connected!", e);
        }
        return 0;
    }
}