Merge "Revert "Make PlaybackState immutable with a builder"" (b9731a10) · Commits · e / os / android_frameworks_base

api/current.txt

+7 −13

Original line number	Diff line number	Diff line
		@@ -15918,14 +15918,19 @@ package android.media.session {
		}

		public final class PlaybackState implements android.os.Parcelable {
		ctor public PlaybackState();
		ctor public PlaybackState(android.media.session.PlaybackState);
		method public int describeContents();
		method public long getActions();
		method public long getBufferPosition();
		method public java.lang.CharSequence getErrorMessage();
		method public long getLastPositionUpdateTime();
		method public float getPlaybackSpeed();
		method public float getPlaybackRate();
		method public long getPosition();
		method public int getState();
		method public void setActions(long);
		method public void setBufferPosition(long);
		method public void setErrorMessage(java.lang.CharSequence);
		method public void setState(int, long, float);
		method public void writeToParcel(android.os.Parcel, int);
		field public static final long ACTION_FAST_FORWARD = 64L; // 0x40L
		field public static final long ACTION_PAUSE = 2L; // 0x2L
		@@ -15951,17 +15956,6 @@ package android.media.session {
		field public static final int STATE_STOPPED = 1; // 0x1
		}

		public static final class PlaybackState.Builder {
		ctor public PlaybackState.Builder();
		ctor public PlaybackState.Builder(android.media.session.PlaybackState);
		method public android.media.session.PlaybackState build();
		method public android.media.session.PlaybackState.Builder setActions(long);
		method public android.media.session.PlaybackState.Builder setBufferPosition(long);
		method public android.media.session.PlaybackState.Builder setErrorMessage(java.lang.CharSequence);
		method public android.media.session.PlaybackState.Builder setState(int, long, float, long);
		method public android.media.session.PlaybackState.Builder setState(int, long, float);
		}

		}

		package android.media.tv {

media/java/android/media/RemoteControlClient.java

+6 −11

Original line number	Diff line number	Diff line
		@@ -682,13 +682,9 @@ public class RemoteControlClient
		// USE_SESSIONS
		if (mSession != null) {
		int pbState = PlaybackState.getStateFromRccState(state);
		long position = hasPosition ? mPlaybackPositionMs
		: PlaybackState.PLAYBACK_POSITION_UNKNOWN;

		PlaybackState.Builder bob = new PlaybackState.Builder(mSessionPlaybackState);
		bob.setState(pbState, position, playbackSpeed, SystemClock.elapsedRealtime());
		bob.setErrorMessage(null);
		mSessionPlaybackState = bob.build();
		mSessionPlaybackState.setState(pbState, hasPosition ?
		mPlaybackPositionMs : PlaybackState.PLAYBACK_POSITION_UNKNOWN,
		playbackSpeed);
		mSession.setPlaybackState(mSessionPlaybackState);
		}
		}
		@@ -749,9 +745,8 @@ public class RemoteControlClient

		// USE_SESSIONS
		if (mSession != null) {
		PlaybackState.Builder bob = new PlaybackState.Builder(mSessionPlaybackState);
		bob.setActions(PlaybackState.getActionsFromRccControlFlags(transportControlFlags));
		mSessionPlaybackState = bob.build();
		mSessionPlaybackState.setActions(PlaybackState
		.getActionsFromRccControlFlags(transportControlFlags));
		mSession.setPlaybackState(mSessionPlaybackState);
		}
		}
		@@ -951,7 +946,7 @@ public class RemoteControlClient
		/**
		* Cache for the current playback state using Session APIs.
		*/
		private PlaybackState mSessionPlaybackState = null;
		private final PlaybackState mSessionPlaybackState = new PlaybackState();

		/**
		* Cache for metadata using Session APIs. This is re-initialized in apply().

media/java/android/media/RemoteController.java

+1 −1

Original line number	Diff line number	Diff line
		@@ -1020,7 +1020,7 @@ public final class RemoteController
		l.onClientPlaybackStateUpdate(playstate);
		} else {
		l.onClientPlaybackStateUpdate(playstate, state.getLastPositionUpdateTime(),
		state.getPosition(), state.getPlaybackSpeed());
		state.getPosition(), state.getPlaybackRate());
		}
		if (state != null) {
		l.onClientTransportControlUpdate(PlaybackState.getRccControlFlagsFromActions(state

media/java/android/media/session/PlaybackState.java

+108 −195

Original line number	Diff line number	Diff line
		@@ -183,29 +183,41 @@ public final class PlaybackState implements Parcelable {
		*/
		public final static long PLAYBACK_POSITION_UNKNOWN = -1;

		private final int mState;
		private final long mPosition;
		private final long mBufferPosition;
		private final float mSpeed;
		private final long mActions;
		private final CharSequence mErrorMessage;
		private final long mUpdateTime;

		private PlaybackState(int state, long position, long updateTime, float speed,
		long bufferPosition, long actions, CharSequence error) {
		mState = state;
		mPosition = position;
		mSpeed = speed;
		mUpdateTime = updateTime;
		mBufferPosition = bufferPosition;
		mActions = actions;
		mErrorMessage = error;
		private int mState;
		private long mPosition;
		private long mBufferPosition;
		private float mRate;
		private long mActions;
		private CharSequence mErrorMessage;
		private long mUpdateTime;

		/**
		* Create an empty PlaybackState. At minimum a state and actions should be
		* set before publishing a PlaybackState.
		*/
		public PlaybackState() {
		}

		/**
		* Create a new PlaybackState from an existing PlaybackState. All fields
		* will be copied to the new state.
		*
		* @param from The PlaybackState to duplicate
		*/
		public PlaybackState(PlaybackState from) {
		mState = from.mState;
		mPosition = from.mPosition;
		mRate = from.mRate;
		mUpdateTime = from.mUpdateTime;
		mBufferPosition = from.mBufferPosition;
		mActions = from.mActions;
		mErrorMessage = from.mErrorMessage;
		}

		private PlaybackState(Parcel in) {
		mState = in.readInt();
		mPosition = in.readLong();
		mSpeed = in.readFloat();
		mRate = in.readFloat();
		mUpdateTime = in.readLong();
		mBufferPosition = in.readLong();
		mActions = in.readLong();
		@@ -219,7 +231,7 @@ public final class PlaybackState implements Parcelable {
		bob.append("state=").append(mState);
		bob.append(", position=").append(mPosition);
		bob.append(", buffered position=").append(mBufferPosition);
		bob.append(", speed=").append(mSpeed);
		bob.append(", rate=").append(mRate);
		bob.append(", updated=").append(mUpdateTime);
		bob.append(", actions=").append(mActions);
		bob.append(", error=").append(mErrorMessage);
		@@ -236,7 +248,7 @@ public final class PlaybackState implements Parcelable {
		public void writeToParcel(Parcel dest, int flags) {
		dest.writeInt(mState);
		dest.writeLong(mPosition);
		dest.writeFloat(mSpeed);
		dest.writeFloat(mRate);
		dest.writeLong(mUpdateTime);
		dest.writeLong(mBufferPosition);
		dest.writeLong(mActions);
		@@ -258,6 +270,41 @@ public final class PlaybackState implements Parcelable {
		public int getState() {
		return mState;
		}

		/**
		* Set the current state of playback.
		* <p>
		* The position must be in ms and indicates the current playback position
		* within the track. If the position is unknown use
		* {@link #PLAYBACK_POSITION_UNKNOWN}.
		* <p>
		* The rate is a multiple of normal playback and should be 0 when paused and
		* negative when rewinding. Normal playback rate is 1.0.
		* <p>
		* The state must be one of the following:
		* <ul>
		* <li> {@link PlaybackState#STATE_NONE}</li>
		* <li> {@link PlaybackState#STATE_STOPPED}</li>
		* <li> {@link PlaybackState#STATE_PLAYING}</li>
		* <li> {@link PlaybackState#STATE_PAUSED}</li>
		* <li> {@link PlaybackState#STATE_FAST_FORWARDING}</li>
		* <li> {@link PlaybackState#STATE_REWINDING}</li>
		* <li> {@link PlaybackState#STATE_BUFFERING}</li>
		* <li> {@link PlaybackState#STATE_ERROR}</li>
		* </ul>
		*
		* @param state The current state of playback.
		* @param position The position in the current track in ms.
		* @param playbackRate The current rate of playback as a multiple of normal
		* playback.
		*/
		public void setState(int state, long position, float playbackRate) {
		this.mState = state;
		this.mPosition = position;
		this.mRate = playbackRate;
		mUpdateTime = SystemClock.elapsedRealtime();
		}

		/**
		* Get the current playback position in ms.
		*/
		@@ -275,14 +322,23 @@ public final class PlaybackState implements Parcelable {
		}

		/**
		* Get the current playback speed as a multiple of normal playback. This
		* Set the current buffer position in ms. This is the farthest playback
		* point that can be reached from the current position using only buffered
		* content.
		*/
		public void setBufferPosition(long bufferPosition) {
		mBufferPosition = bufferPosition;
		}

		/**
		* Get the current playback rate as a multiple of normal playback. This
		* should be negative when rewinding. A value of 1 means normal playback and
		* 0 means paused.
		*
		* @return The current speed of playback.
		* @return The current rate of playback.
		*/
		public float getPlaybackSpeed() {
		return mSpeed;
		public float getPlaybackRate() {
		return mRate;
		}

		/**
		@@ -304,6 +360,25 @@ public final class PlaybackState implements Parcelable {
		return mActions;
		}

		/**
		* Set the current capabilities available on this session. This should use a
		* bitmask of the available capabilities.
		* <ul>
		* <li> {@link PlaybackState#ACTION_SKIP_TO_PREVIOUS}</li>
		* <li> {@link PlaybackState#ACTION_REWIND}</li>
		* <li> {@link PlaybackState#ACTION_PLAY}</li>
		* <li> {@link PlaybackState#ACTION_PAUSE}</li>
		* <li> {@link PlaybackState#ACTION_STOP}</li>
		* <li> {@link PlaybackState#ACTION_FAST_FORWARD}</li>
		* <li> {@link PlaybackState#ACTION_SKIP_TO_NEXT}</li>
		* <li> {@link PlaybackState#ACTION_SEEK_TO}</li>
		* <li> {@link PlaybackState#ACTION_SET_RATING}</li>
		* </ul>
		*/
		public void setActions(long capabilities) {
		mActions = capabilities;
		}

		/**
		* Get a user readable error message. This should be set when the state is
		* {@link PlaybackState#STATE_ERROR}.
		@@ -317,11 +392,20 @@ public final class PlaybackState implements Parcelable {
		* position has never been set this will return 0;
		*
		* @return The last time the position was updated.
		* @hide
		*/
		public long getLastPositionUpdateTime() {
		return mUpdateTime;
		}

		/**
		* Set a user readable error message. This should be set when the state is
		* {@link PlaybackState#STATE_ERROR}.
		*/
		public void setErrorMessage(CharSequence errorMessage) {
		mErrorMessage = errorMessage;
		}

		/**
		* Get the {@link PlaybackState} state for the given
		* {@link RemoteControlClient} state.
		@@ -489,175 +573,4 @@ public final class PlaybackState implements Parcelable {
		return new PlaybackState[size];
		}
		};

		/**
		* Builder for {@link PlaybackState} objects.
		*/
		public static final class Builder {
		private int mState;
		private long mPosition;
		private long mBufferPosition;
		private float mSpeed;
		private long mActions;
		private CharSequence mErrorMessage;
		private long mUpdateTime;

		/**
		* Creates an initially empty state builder.
		*/
		public Builder() {
		}

		/**
		* Creates a builder with the same initial values as those in the from
		* state.
		*
		* @param from The state to use for initializing the builder.
		*/
		public Builder(PlaybackState from) {
		if (from == null) {
		return;
		}
		mState = from.mState;
		mPosition = from.mPosition;
		mBufferPosition = from.mBufferPosition;
		mSpeed = from.mSpeed;
		mActions = from.mActions;
		mErrorMessage = from.mErrorMessage;
		mUpdateTime = from.mUpdateTime;
		}

		/**
		* Set the current state of playback.
		* <p>
		* The position must be in ms and indicates the current playback
		* position within the track. If the position is unknown use
		* {@link #PLAYBACK_POSITION_UNKNOWN}. When not using an unknown
		* position the time at which the position was updated must be provided.
		* It is okay to use {@link SystemClock#elapsedRealtime()} if the
		* current position was just retrieved.
		* <p>
		* The speed is a multiple of normal playback and should be 0 when
		* paused and negative when rewinding. Normal playback speed is 1.0.
		* <p>
		* The state must be one of the following:
		* <ul>
		* <li> {@link PlaybackState#STATE_NONE}</li>
		* <li> {@link PlaybackState#STATE_STOPPED}</li>
		* <li> {@link PlaybackState#STATE_PLAYING}</li>
		* <li> {@link PlaybackState#STATE_PAUSED}</li>
		* <li> {@link PlaybackState#STATE_FAST_FORWARDING}</li>
		* <li> {@link PlaybackState#STATE_REWINDING}</li>
		* <li> {@link PlaybackState#STATE_BUFFERING}</li>
		* <li> {@link PlaybackState#STATE_ERROR}</li>
		* </ul>
		*
		* @param state The current state of playback.
		* @param position The position in the current track in ms.
		* @param playbackSpeed The current speed of playback as a multiple of
		* normal playback.
		* @param updateTime The time in the {@link SystemClock#elapsedRealtime}
		* timebase that the position was updated at.
		* @return this
		*/
		public Builder setState(int state, long position, float playbackSpeed, long updateTime) {
		mState = state;
		mPosition = position;
		mUpdateTime = updateTime;
		mSpeed = playbackSpeed;
		return this;
		}

		/**
		* Set the current state of playback.
		* <p>
		* The position must be in ms and indicates the current playback
		* position within the track. If the position is unknown use
		* {@link #PLAYBACK_POSITION_UNKNOWN}. The update time will be set to
		* the current {@link SystemClock#elapsedRealtime()}.
		* <p>
		* The speed is a multiple of normal playback and should be 0 when
		* paused and negative when rewinding. Normal playback speed is 1.0.
		* <p>
		* The state must be one of the following:
		* <ul>
		* <li> {@link PlaybackState#STATE_NONE}</li>
		* <li> {@link PlaybackState#STATE_STOPPED}</li>
		* <li> {@link PlaybackState#STATE_PLAYING}</li>
		* <li> {@link PlaybackState#STATE_PAUSED}</li>
		* <li> {@link PlaybackState#STATE_FAST_FORWARDING}</li>
		* <li> {@link PlaybackState#STATE_REWINDING}</li>
		* <li> {@link PlaybackState#STATE_BUFFERING}</li>
		* <li> {@link PlaybackState#STATE_ERROR}</li>
		* </ul>
		*
		* @param state The current state of playback.
		* @param position The position in the current track in ms.
		* @param playbackSpeed The current speed of playback as a multiple of
		* normal playback.
		* @return this
		*/
		public Builder setState(int state, long position, float playbackSpeed) {
		return setState(state, position, playbackSpeed, SystemClock.elapsedRealtime());
		}

		/**
		* Set the current actions available on this session. This should use a
		* bitmask of possible actions.
		* <ul>
		* <li> {@link PlaybackState#ACTION_SKIP_TO_PREVIOUS}</li>
		* <li> {@link PlaybackState#ACTION_REWIND}</li>
		* <li> {@link PlaybackState#ACTION_PLAY}</li>
		* <li> {@link PlaybackState#ACTION_PAUSE}</li>
		* <li> {@link PlaybackState#ACTION_STOP}</li>
		* <li> {@link PlaybackState#ACTION_FAST_FORWARD}</li>
		* <li> {@link PlaybackState#ACTION_SKIP_TO_NEXT}</li>
		* <li> {@link PlaybackState#ACTION_SEEK_TO}</li>
		* <li> {@link PlaybackState#ACTION_SET_RATING}</li>
		* </ul>
		*
		* @param actions The set of actions allowed.
		* @return this
		*/
		public Builder setActions(long actions) {
		mActions = actions;
		return this;
		}

		/**
		* Set the current buffer position in ms. This is the farthest playback
		* point that can be reached from the current position using only
		* buffered content.
		*
		* @param bufferPosition The position in ms that playback is buffered
		* to.
		* @return this
		*/
		public Builder setBufferPosition(long bufferPosition) {
		mBufferPosition = bufferPosition;
		return this;
		}

		/**
		* Set a user readable error message. This should be set when the state
		* is {@link PlaybackState#STATE_ERROR}.
		*
		* @param error The error message for display to the user.
		* @return this
		*/
		public Builder setErrorMessage(CharSequence error) {
		mErrorMessage = error;
		return this;
		}

		/**
		* Build and return the PlaybackState instance with these values.
		*
		* @return A new state instance.
		*/
		public PlaybackState build() {
		return new PlaybackState(mState, mPosition, mUpdateTime, mSpeed, mBufferPosition,
		mActions, mErrorMessage);
		}
		}
		}

services/core/java/com/android/server/media/MediaSessionRecord.java

+4 −7

Original line number	Diff line number	Diff line
		@@ -682,19 +682,16 @@ public class MediaSessionRecord implements IBinder.DeathRecipient {
		\|\| state.getState() == PlaybackState.STATE_FAST_FORWARDING
		\|\| state.getState() == PlaybackState.STATE_REWINDING) {
		long updateTime = state.getLastPositionUpdateTime();
		long currentTime = SystemClock.elapsedRealtime();
		if (updateTime > 0) {
		long position = (long) (state.getPlaybackSpeed()
		* (currentTime - updateTime)) + state.getPosition();
		long position = (long) (state.getPlaybackRate()
		* (SystemClock.elapsedRealtime() - updateTime)) + state.getPosition();
		if (duration >= 0 && position > duration) {
		position = duration;
		} else if (position < 0) {
		position = 0;
		}
		PlaybackState.Builder builder = new PlaybackState.Builder(state);
		builder.setState(state.getState(), position, state.getPlaybackSpeed(),
		currentTime);
		result = builder.build();
		result = new PlaybackState(state);
		result.setState(state.getState(), position, state.getPlaybackRate());
		}
		}
		}