Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f692b95b authored by Kyeongkab.Nam's avatar Kyeongkab.Nam
Browse files

Add spoken subtitle information to TvTrackInfo 

Add TIF API for getting spoken subtitle attribute for audio tracks
in order for TV App to use it.

Test: build
Bug: 112835103
Change-Id: I2ebc27dae020bce14cd1a3464e91416c7a4415ec
parent dd3358b2

api/current.txt

+2 −0
Original line number Diff line number Diff line
@@ -28330,6 +28330,7 @@ package android.media.tv { 
    method public boolean isAudioDescription();

    method public boolean isEncrypted();

    method public boolean isHardOfHearing();

    method public boolean isSpokenSubtitle();

    method public void writeToParcel(android.os.Parcel, int);

    field @NonNull public static final android.os.Parcelable.Creator<android.media.tv.TvTrackInfo> CREATOR;

    field public static final int TYPE_AUDIO = 0; // 0x0
@@ -28348,6 +28349,7 @@ package android.media.tv { 
    method public android.media.tv.TvTrackInfo.Builder setExtra(android.os.Bundle);

    method @NonNull public android.media.tv.TvTrackInfo.Builder setHardOfHearing(boolean);

    method public android.media.tv.TvTrackInfo.Builder setLanguage(String);

    method @NonNull public android.media.tv.TvTrackInfo.Builder setSpokenSubtitle(boolean);

    method public android.media.tv.TvTrackInfo.Builder setVideoActiveFormatDescription(byte);

    method public android.media.tv.TvTrackInfo.Builder setVideoFrameRate(float);

    method public android.media.tv.TvTrackInfo.Builder setVideoHeight(int);

media/java/android/media/tv/TvTrackInfo.java

+48 −5
Original line number Diff line number Diff line
@@ -63,6 +63,7 @@ public final class TvTrackInfo implements Parcelable { 
    private final int mAudioSampleRate;

    private final boolean mAudioDescription;

    private final boolean mHardOfHearing;

    private final boolean mSpokenSubtitle;

    private final int mVideoWidth;

    private final int mVideoHeight;

    private final float mVideoFrameRate;
@@ -73,8 +74,9 @@ public final class TvTrackInfo implements Parcelable { 


    private TvTrackInfo(int type, String id, String language, CharSequence description,

            boolean encrypted, int audioChannelCount, int audioSampleRate, boolean audioDescription,

            boolean hardOfHearing, int videoWidth, int videoHeight, float videoFrameRate,

            float videoPixelAspectRatio, byte videoActiveFormatDescription, Bundle extra) {

            boolean hardOfHearing, boolean spokenSubtitle, int videoWidth, int videoHeight,

            float videoFrameRate, float videoPixelAspectRatio, byte videoActiveFormatDescription,

            Bundle extra) {

        mType = type;

        mId = id;

        mLanguage = language;
@@ -84,6 +86,7 @@ public final class TvTrackInfo implements Parcelable { 
        mAudioSampleRate = audioSampleRate;

        mAudioDescription = audioDescription;

        mHardOfHearing = hardOfHearing;

        mSpokenSubtitle = spokenSubtitle;

        mVideoWidth = videoWidth;

        mVideoHeight = videoHeight;

        mVideoFrameRate = videoFrameRate;
@@ -102,6 +105,7 @@ public final class TvTrackInfo implements Parcelable { 
        mAudioSampleRate = in.readInt();

        mAudioDescription = in.readInt() != 0;

        mHardOfHearing = in.readInt() != 0;

        mSpokenSubtitle = in.readInt() != 0;

        mVideoWidth = in.readInt();

        mVideoHeight = in.readInt();

        mVideoFrameRate = in.readFloat();
@@ -211,6 +215,22 @@ public final class TvTrackInfo implements Parcelable { 
        return mHardOfHearing;

    }



    /**

     * Returns {@code true} if the track is a spoken subtitle for people with visual impairment,

     * {@code false} otherwise. Valid only for {@link #TYPE_AUDIO} tracks.

     *

     * <p>For example of broadcast, spoken subtitle information may be referred to broadcast

     * standard (e.g. Supplementary Audio Language Descriptor of ETSI EN 300 468).

     *

     * @throws IllegalStateException if not called on an audio track

     */

    public boolean isSpokenSubtitle() {

        if (mType != TYPE_AUDIO) {

            throw new IllegalStateException("Not an audio track");

        }

        return mSpokenSubtitle;

    }



    /**

     * Returns the width of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}

     * tracks.
@@ -308,6 +328,7 @@ public final class TvTrackInfo implements Parcelable { 
        dest.writeInt(mAudioSampleRate);

        dest.writeInt(mAudioDescription ? 1 : 0);

        dest.writeInt(mHardOfHearing ? 1 : 0);

        dest.writeInt(mSpokenSubtitle ? 1 : 0);

        dest.writeInt(mVideoWidth);

        dest.writeInt(mVideoHeight);

        dest.writeFloat(mVideoFrameRate);
@@ -331,6 +352,7 @@ public final class TvTrackInfo implements Parcelable { 
        if (!TextUtils.equals(mId, obj.mId) || mType != obj.mType

                || !TextUtils.equals(mLanguage, obj.mLanguage)

                || !TextUtils.equals(mDescription, obj.mDescription)

                || mEncrypted != obj.mEncrypted

                || !Objects.equals(mExtra, obj.mExtra)) {

            return false;

        }
@@ -340,7 +362,8 @@ public final class TvTrackInfo implements Parcelable { 
                return mAudioChannelCount == obj.mAudioChannelCount

                        && mAudioSampleRate == obj.mAudioSampleRate

                        && mAudioDescription == obj.mAudioDescription

                        && mHardOfHearing == obj.mHardOfHearing;

                        && mHardOfHearing == obj.mHardOfHearing

                        && mSpokenSubtitle == obj.mSpokenSubtitle;



            case TYPE_VIDEO:

                return mVideoWidth == obj.mVideoWidth
@@ -387,6 +410,7 @@ public final class TvTrackInfo implements Parcelable { 
        private int mAudioSampleRate;

        private boolean mAudioDescription;

        private boolean mHardOfHearing;

        private boolean mSpokenSubtitle;

        private int mVideoWidth;

        private int mVideoHeight;

        private float mVideoFrameRate;
@@ -520,6 +544,25 @@ public final class TvTrackInfo implements Parcelable { 
            return this;

        }



        /**

         * Sets the spoken subtitle attribute of the audio. Valid only for {@link #TYPE_AUDIO}

         * tracks.

         *

         * <p>For example of broadcast, spoken subtitle information may be referred to broadcast

         * standard (e.g. Supplementary Audio Language Descriptor of ETSI EN 300 468).

         *

         * @param spokenSubtitle The spoken subtitle attribute of the audio.

         * @throws IllegalStateException if not called on an audio track

         */

        @NonNull

        public Builder setSpokenSubtitle(boolean spokenSubtitle) {

            if (mType != TYPE_AUDIO) {

                throw new IllegalStateException("Not an audio track");

            }

            mSpokenSubtitle = spokenSubtitle;

            return this;

        }



        /**

         * Sets the width of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}

         * tracks.
@@ -623,8 +666,8 @@ public final class TvTrackInfo implements Parcelable { 
        public TvTrackInfo build() {

            return new TvTrackInfo(mType, mId, mLanguage, mDescription, mEncrypted,

                    mAudioChannelCount, mAudioSampleRate, mAudioDescription, mHardOfHearing,

                    mVideoWidth, mVideoHeight, mVideoFrameRate, mVideoPixelAspectRatio,

                    mVideoActiveFormatDescription, mExtra);

                    mSpokenSubtitle, mVideoWidth, mVideoHeight, mVideoFrameRate,

                    mVideoPixelAspectRatio, mVideoActiveFormatDescription, mExtra);

        }

    }

}