aboutsummaryrefslogtreecommitdiff
path: root/src/com/android/tv/TvOptionsManager.java
blob: 493e039c2ef1ba53828cb59c5ca74c49e713b7b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
 * Copyright (C) 2015 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.tv;

import android.content.Context;
import android.media.tv.TvTrackInfo;
import android.support.annotation.IntDef;
import android.util.SparseArray;

import com.android.tv.data.DisplayMode;

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

/**
 * The TvOptionsManager is responsible for keeping track of current TV options such as closed
 * captions and display mode. Can be also used to create MenuAction items to control such options.
 */
public class TvOptionsManager {
    @Retention(RetentionPolicy.SOURCE)
    @IntDef({OPTION_CLOSED_CAPTIONS, OPTION_DISPLAY_MODE, OPTION_SYSTEMWIDE_PIP, OPTION_MULTI_AUDIO,
            OPTION_MORE_CHANNELS, OPTION_DEVELOPER, OPTION_SETTINGS})
    public @interface OptionType {}
    public static final int OPTION_CLOSED_CAPTIONS = 0;
    public static final int OPTION_DISPLAY_MODE = 1;
    public static final int OPTION_SYSTEMWIDE_PIP = 2;
    public static final int OPTION_MULTI_AUDIO = 3;
    public static final int OPTION_MORE_CHANNELS = 4;
    public static final int OPTION_DEVELOPER = 5;
    public static final int OPTION_SETTINGS = 6;

    private final Context mContext;
    private final SparseArray<OptionChangedListener> mOptionChangedListeners = new SparseArray<>();

    private String mClosedCaptionsLanguage;
    private int mDisplayMode;
    private String mMultiAudio;

    public TvOptionsManager(Context context) {
        mContext = context;
    }

    /**
     * Returns a suitable displayed string for the given option type under current settings.
     * @param option the type of option, should be one of {@link OptionType}.
     */
    public String getOptionString(@OptionType int option) {
        switch (option) {
            case OPTION_CLOSED_CAPTIONS:
                if (mClosedCaptionsLanguage == null) {
                    return mContext.getString(R.string.closed_caption_option_item_off);
                }
                return new Locale(mClosedCaptionsLanguage).getDisplayName();
            case OPTION_DISPLAY_MODE:
                return ((MainActivity) mContext).getTvViewUiManager()
                        .isDisplayModeAvailable(mDisplayMode)
                        ? DisplayMode.getLabel(mDisplayMode, mContext)
                        : DisplayMode.getLabel(DisplayMode.MODE_NORMAL, mContext);
            case OPTION_MULTI_AUDIO:
                return mMultiAudio;
        }
        return "";
    }

    /**
     * Handles changing selection of closed caption.
     */
    public void onClosedCaptionsChanged(TvTrackInfo track, int trackIndex) {
        mClosedCaptionsLanguage = (track == null) ?
                null : (track.getLanguage() != null) ? track.getLanguage()
                : mContext.getString(R.string.closed_caption_unknown_language, trackIndex + 1);
        notifyOptionChanged(OPTION_CLOSED_CAPTIONS);
    }

    /**
     * Handles changing selection of display mode.
     */
    public void onDisplayModeChanged(int displayMode) {
        mDisplayMode = displayMode;
        notifyOptionChanged(OPTION_DISPLAY_MODE);
    }

    /**
     * Handles changing selection of multi-audio.
     */
    public void onMultiAudioChanged(String multiAudio) {
        mMultiAudio = multiAudio;
        notifyOptionChanged(OPTION_MULTI_AUDIO);
    }

    private void notifyOptionChanged(@OptionType int option) {
        OptionChangedListener listener = mOptionChangedListeners.get(option);
        if (listener != null) {
            listener.onOptionChanged(option, getOptionString(option));
        }
    }

    /**
     * Sets listeners to changes of the given option type.
     */
    public void setOptionChangedListener(int option, OptionChangedListener listener) {
        mOptionChangedListeners.put(option, listener);
    }

    /**
     * An interface used to monitor option changes.
     */
    public interface OptionChangedListener {
        void onOptionChanged(@OptionType int optionType, String newString);
    }
}