/*
* Copyright (C) 2018 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 androidx.media3.exoplayer.offline;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import androidx.annotation.IntDef;
import androidx.media3.common.C;
import androidx.media3.common.util.Assertions;
import androidx.media3.common.util.UnstableApi;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/** Represents state of a download. */
@UnstableApi
public final class Download {
/**
* Download states. One of {@link #STATE_QUEUED}, {@link #STATE_STOPPED}, {@link
* #STATE_DOWNLOADING}, {@link #STATE_COMPLETED}, {@link #STATE_FAILED}, {@link #STATE_REMOVING}
* or {@link #STATE_RESTARTING}.
*/
// @Target list includes both 'default' targets and TYPE_USE, to ensure backwards compatibility
// with Kotlin usages from before TYPE_USE was added.
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE, TYPE_USE})
@IntDef({
STATE_QUEUED,
STATE_STOPPED,
STATE_DOWNLOADING,
STATE_COMPLETED,
STATE_FAILED,
STATE_REMOVING,
STATE_RESTARTING
})
public @interface State {}
// Important: These constants are persisted into DownloadIndex. Do not change them.
/**
* The download is waiting to be started. A download may be queued because the {@code
* DownloadManager}
*
* <ul>
* <li>Is {@code DownloadManager#getDownloadsPaused() paused}
* <li>Has {@code DownloadManager#getRequirements() Requirements} that are not met
* <li>Has already started {@code DownloadManager#getMaxParallelDownloads()
* maxParallelDownloads}
* </ul>
*/
public static final int STATE_QUEUED = 0;
/** The download is stopped for a specified {@link #stopReason}. */
public static final int STATE_STOPPED = 1;
/** The download is currently started. */
public static final int STATE_DOWNLOADING = 2;
/** The download completed. */
public static final int STATE_COMPLETED = 3;
/** The download failed. */
public static final int STATE_FAILED = 4;
/** The download is being removed. */
public static final int STATE_REMOVING = 5;
/** The download will restart after all downloaded data is removed. */
public static final int STATE_RESTARTING = 7;
/** Failure reasons. Either {@link #FAILURE_REASON_NONE} or {@link #FAILURE_REASON_UNKNOWN}. */
// @Target list includes both 'default' targets and TYPE_USE, to ensure backwards compatibility
// with Kotlin usages from before TYPE_USE was added.
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE, TYPE_USE})
@IntDef({FAILURE_REASON_NONE, FAILURE_REASON_UNKNOWN})
public @interface FailureReason {}
/** The download isn't failed. */
public static final int FAILURE_REASON_NONE = 0;
/** The download is failed because of unknown reason. */
public static final int FAILURE_REASON_UNKNOWN = 1;
/** The download isn't stopped. */
public static final int STOP_REASON_NONE = 0;
/** The download request. */
public final DownloadRequest request;
/** The state of the download. */
public final @State int state;
/** The first time when download entry is created. */
public final long startTimeMs;
/** The last update time. */
public final long updateTimeMs;
/** The total size of the content in bytes, or {@link C#LENGTH_UNSET} if unknown. */
public final long contentLength;
/** The reason the download is stopped, or {@link #STOP_REASON_NONE}. */
public final int stopReason;
/**
* If {@link #state} is {@link #STATE_FAILED} then this is the cause, otherwise {@link
* #FAILURE_REASON_NONE}.
*/
public final @FailureReason int failureReason;
/* package */ final DownloadProgress progress;
public Download(
DownloadRequest request,
@State int state,
long startTimeMs,
long updateTimeMs,
long contentLength,
int stopReason,
@FailureReason int failureReason) {
this(
request,
state,
startTimeMs,
updateTimeMs,
contentLength,
stopReason,
failureReason,
new DownloadProgress());
}
public Download(
DownloadRequest request,
@State int state,
long startTimeMs,
long updateTimeMs,
long contentLength,
int stopReason,
@FailureReason int failureReason,
DownloadProgress progress) {
Assertions.checkNotNull(progress);
Assertions.checkArgument((failureReason == FAILURE_REASON_NONE) == (state != STATE_FAILED));
if (stopReason != 0) {
Assertions.checkArgument(state != STATE_DOWNLOADING && state != STATE_QUEUED);
}
this.request = request;
this.state = state;
this.startTimeMs = startTimeMs;
this.updateTimeMs = updateTimeMs;
this.contentLength = contentLength;
this.stopReason = stopReason;
this.failureReason = failureReason;
this.progress = progress;
}
/** Returns whether the download is completed or failed. These are terminal states. */
public boolean isTerminalState() {
return state == STATE_COMPLETED || state == STATE_FAILED;
}
/** Returns the total number of downloaded bytes. */
public long getBytesDownloaded() {
return progress.bytesDownloaded;
}
/**
* Returns the estimated download percentage, or {@link C#PERCENTAGE_UNSET} if no estimate is
* available.
*/
public float getPercentDownloaded() {
return progress.percentDownloaded;
}
}