xref: /frameworks/base/packages/SystemUI/src/com/android/systemui/media/dialog/MediaItem.java

/*
 * Copyright (C) 2022 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.systemui.media.dialog;

import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;

import com.android.settingslib.media.MediaDevice;
import com.android.systemui.res.R;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Optional;

/**
 * MediaItem represents an item in OutputSwitcher list (could be a MediaDevice, group divider or
 * connect new device item).
 */
public class MediaItem {
    private final Optional<MediaDevice> mMediaDeviceOptional;
    private final String mTitle;
    @MediaItemType
    private final int mMediaItemType;
    private final boolean mIsFirstDeviceInGroup;
    private final boolean mIsExpandableDivider;
    private final boolean mHasTopSeparator;

    @Retention(RetentionPolicy.SOURCE)
    @IntDef({
            MediaItemType.TYPE_DEVICE,
            MediaItemType.TYPE_GROUP_DIVIDER,
            MediaItemType.TYPE_PAIR_NEW_DEVICE,
            MediaItemType.TYPE_DEVICE_GROUP
    })
    public @interface MediaItemType {
        int TYPE_DEVICE = 0;
        int TYPE_GROUP_DIVIDER = 1;
        int TYPE_PAIR_NEW_DEVICE = 2;
        int TYPE_DEVICE_GROUP = 3;
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_DEVICE} {@link MediaItem} with its {@link
     * #getMediaDevice() media device} set to {@code device} and its title set to {@code device}'s
     * name.
     */
    public static MediaItem createDeviceMediaItem(@NonNull MediaDevice device) {
        return new MediaItem(device, device.getName(), MediaItemType.TYPE_DEVICE, false);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_DEVICE} {@link MediaItem} with its {@link
     * #getMediaDevice() media device} set to {@code device} and its title set to {@code device}'s
     * name.
     */
    public static MediaItem createDeviceMediaItem(
            @NonNull MediaDevice device, boolean isFirstDeviceInGroup) {
        return new MediaItem(
            device, device.getName(), MediaItemType.TYPE_DEVICE, isFirstDeviceInGroup);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_DEVICE_GROUP} {@link MediaItem}. This items controls
     * the volume of the group session.
     */
    public static MediaItem createDeviceGroupMediaItem() {
        return new MediaItem(
                /* device */ null,
                /* title */ null,
                /* type */ MediaItemType.TYPE_DEVICE_GROUP,
                /* misFirstDeviceInGroup */ false);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_PAIR_NEW_DEVICE} {@link MediaItem} with both {@link
     * #getMediaDevice() media device} and title set to {@code null}.
     */
    public static MediaItem createPairNewDeviceMediaItem() {
        return new MediaItem(
                /* device */ null,
                /* title */ null,
                MediaItemType.TYPE_PAIR_NEW_DEVICE,
                /* mIsFirstDeviceInGroup */ false);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_GROUP_DIVIDER} {@link MediaItem} with the specified
     * title and a {@code null} {@link #getMediaDevice() media device}.
     */
    public static MediaItem createGroupDividerMediaItem(@Nullable String title) {
        return new MediaItem(
            /* device */ null,
            title,
            MediaItemType.TYPE_GROUP_DIVIDER,
            /* misFirstDeviceInGroup */ false);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_GROUP_DIVIDER} {@link MediaItem} with the specified
     * title and a {@code null} {@link #getMediaDevice() media device}. This item needs to be
     * rendered with a separator above it.
     */
    public static MediaItem createGroupDividerWithSeparatorMediaItem(@Nullable String title) {
        return new MediaItem(
                /* device */ null,
                title,
                MediaItemType.TYPE_GROUP_DIVIDER,
                /* isFirstDeviceInGroup */ false,
                /* isExpandableDivider */ false,
                /* hasTopSeparator */ true);
    }

    /**
     * Returns a new {@link MediaItemType#TYPE_GROUP_DIVIDER} {@link MediaItem} with the specified
     * title and a {@code null} {@link #getMediaDevice() media device}. The item serves as a toggle
     * for expanding/collapsing the group of devices.
     */
    public static MediaItem createExpandableGroupDividerMediaItem(@Nullable String title) {
        return new MediaItem(
                /* device */ null,
                title,
                MediaItemType.TYPE_GROUP_DIVIDER,
                /* isFirstDeviceInGroup */ false,
                /* isExpandableDivider */ true,
                /* hasTopSeparator */ false);
    }

    private MediaItem(
            @Nullable MediaDevice device,
            @Nullable String title,
            @MediaItemType int type,
            boolean isFirstDeviceInGroup) {
        this(device, title, type, isFirstDeviceInGroup, /* isExpandableDivider */
                false, /* hasTopSeparator */ false);
    }

    private MediaItem(
            @Nullable MediaDevice device,
            @Nullable String title,
            @MediaItemType int type,
            boolean isFirstDeviceInGroup,
            boolean isExpandableDivider,
            boolean hasTopSeparator) {
        this.mMediaDeviceOptional = Optional.ofNullable(device);
        this.mTitle = title;
        this.mMediaItemType = type;
        this.mIsFirstDeviceInGroup = isFirstDeviceInGroup;
        this.mIsExpandableDivider = isExpandableDivider;
        this.mHasTopSeparator = hasTopSeparator;
    }

    public Optional<MediaDevice> getMediaDevice() {
        return mMediaDeviceOptional;
    }

    /** Get layout id based on media item Type. */
    public static int getMediaLayoutId(@MediaItemType int mediaItemType) {
        return switch (mediaItemType) {
            case MediaItemType.TYPE_DEVICE, MediaItemType.TYPE_PAIR_NEW_DEVICE ->
                    R.layout.media_output_list_item_advanced;
            default -> R.layout.media_output_list_group_divider;
        };
    }

    public String getTitle() {
        return mTitle;
    }

    public boolean isMutingExpectedDevice() {
        return mMediaDeviceOptional.isPresent()
                && mMediaDeviceOptional.get().isMutingExpectedDevice();
    }

    public int getMediaItemType() {
        return mMediaItemType;
    }

    public boolean isFirstDeviceInGroup() {
        return mIsFirstDeviceInGroup;
    }

    /** Returns whether a group divider has a button that expands group device list */
    public boolean isExpandableDivider() {
        return mIsExpandableDivider;
    }

    /** Returns whether a group divider has a border at the top */
    public boolean hasTopSeparator() {
        return mHasTopSeparator;
    }
}