Skip to content

SDK / exoplayer

Go to a project
Commit af43c93a by ibaker Committed by Ian Baker
Options

Remove deprecated ActionFile and ActionFileUpgradeUtil 

#minor-release

PiperOrigin-RevId: 426868933
parent e40f138d
Expand all
Inline Side-by-side
Showing with 4 additions and 479 deletions
RELEASENOTES.md
...@@ -160,6 +160,9 @@ ...@@ -160,6 +160,9 @@
a fallback value. a fallback value.
* Remove `(Simple)ExoPlayer.setThrowsWhenUsingWrongThread`. Opting out of * Remove `(Simple)ExoPlayer.setThrowsWhenUsingWrongThread`. Opting out of
the thread enforcement is no longer possible. the thread enforcement is no longer possible.
* Remove `ActionFile` and `ActionFileUpgradeUtil`. Use ExoPlayer 2.16.1 or
before to use `ActionFileUpgradeUtil` to merge legacy action files into
`DefaultDownloadIndex`.
* Change the following `IntDefs` to `@Target(TYPE_USE)` only. This may break * Change the following `IntDefs` to `@Target(TYPE_USE)` only. This may break
the compilation of usages in Kotlin, which can be fixed by moving the the compilation of usages in Kotlin, which can be fixed by moving the
annotation to annotate the type (`Int`). annotation to annotate the type (`Int`).
......
demos/main/src/main/java/com/google/android/exoplayer2/demo/DemoUtil.java
...@@ -22,8 +22,6 @@ import com.google.android.exoplayer2.database.DatabaseProvider; ...@@ -22,8 +22,6 @@ import com.google.android.exoplayer2.database.DatabaseProvider;
import com.google.android.exoplayer2.database.StandaloneDatabaseProvider; import com.google.android.exoplayer2.database.StandaloneDatabaseProvider;
import com.google.android.exoplayer2.ext.cronet.CronetDataSource; import com.google.android.exoplayer2.ext.cronet.CronetDataSource;
import com.google.android.exoplayer2.ext.cronet.CronetUtil; import com.google.android.exoplayer2.ext.cronet.CronetUtil;
import com.google.android.exoplayer2.offline.ActionFileUpgradeUtil;
import com.google.android.exoplayer2.offline.DefaultDownloadIndex;
import com.google.android.exoplayer2.offline.DownloadManager; import com.google.android.exoplayer2.offline.DownloadManager;
import com.google.android.exoplayer2.ui.DownloadNotificationHelper; import com.google.android.exoplayer2.ui.DownloadNotificationHelper;
import com.google.android.exoplayer2.upstream.DataSource; import com.google.android.exoplayer2.upstream.DataSource;
...@@ -34,9 +32,7 @@ import com.google.android.exoplayer2.upstream.cache.Cache; ...@@ -34,9 +32,7 @@ import com.google.android.exoplayer2.upstream.cache.Cache;
import com.google.android.exoplayer2.upstream.cache.CacheDataSource; import com.google.android.exoplayer2.upstream.cache.CacheDataSource;
import com.google.android.exoplayer2.upstream.cache.NoOpCacheEvictor; import com.google.android.exoplayer2.upstream.cache.NoOpCacheEvictor;
import com.google.android.exoplayer2.upstream.cache.SimpleCache; import com.google.android.exoplayer2.upstream.cache.SimpleCache;
import com.google.android.exoplayer2.util.Log;
import java.io.File; import java.io.File;
import java.io.IOException;
import java.net.CookieHandler; import java.net.CookieHandler;
import java.net.CookieManager; import java.net.CookieManager;
import java.net.CookiePolicy; import java.net.CookiePolicy;
...@@ -60,8 +56,6 @@ public final class DemoUtil { ...@@ -60,8 +56,6 @@ public final class DemoUtil {
private static final boolean USE_CRONET_FOR_NETWORKING = true; private static final boolean USE_CRONET_FOR_NETWORKING = true;
private static final String TAG = "DemoUtil"; private static final String TAG = "DemoUtil";
private static final String DOWNLOAD_ACTION_FILE = "actions";
private static final String DOWNLOAD_TRACKER_ACTION_FILE = "tracked_actions";
private static final String DOWNLOAD_CONTENT_DIRECTORY = "downloads"; private static final String DOWNLOAD_CONTENT_DIRECTORY = "downloads";
private static DataSource.@MonotonicNonNull Factory dataSourceFactory; private static DataSource.@MonotonicNonNull Factory dataSourceFactory;
...@@ -155,14 +149,6 @@ public final class DemoUtil { ...@@ -155,14 +149,6 @@ public final class DemoUtil {
private static synchronized void ensureDownloadManagerInitialized(Context context) { private static synchronized void ensureDownloadManagerInitialized(Context context) {
if (downloadManager == null) { if (downloadManager == null) {
DefaultDownloadIndex downloadIndex = new DefaultDownloadIndex(getDatabaseProvider(context));
upgradeActionFile(
context, DOWNLOAD_ACTION_FILE, downloadIndex, /* addNewDownloadsAsCompleted= */ false);
upgradeActionFile(
context,
DOWNLOAD_TRACKER_ACTION_FILE,
downloadIndex,
/* addNewDownloadsAsCompleted= */ true);
downloadManager = downloadManager =
new DownloadManager( new DownloadManager(
context, context,
...@@ -175,23 +161,6 @@ public final class DemoUtil { ...@@ -175,23 +161,6 @@ public final class DemoUtil {
} }
} }
private static synchronized void upgradeActionFile(
Context context,
String fileName,
DefaultDownloadIndex downloadIndex,
boolean addNewDownloadsAsCompleted) {
try {
ActionFileUpgradeUtil.upgradeAndDelete(
new File(getDownloadDirectory(context), fileName),
/* downloadIdProvider= */ null,
downloadIndex,
/* deleteOnFailure= */ true,
addNewDownloadsAsCompleted);
} catch (IOException e) {
Log.e(TAG, "Failed to upgrade action file: " + fileName, e);
}
}
private static synchronized DatabaseProvider getDatabaseProvider(Context context) { private static synchronized DatabaseProvider getDatabaseProvider(Context context) {
if (databaseProvider == null) { if (databaseProvider == null) {
databaseProvider = new StandaloneDatabaseProvider(context); databaseProvider = new StandaloneDatabaseProvider(context);
......
docs/downloading-media.md
...@@ -96,11 +96,6 @@ downloadManager.setMaxParallelDownloads(3); ...@@ -96,11 +96,6 @@ downloadManager.setMaxParallelDownloads(3);
See [`DemoUtil`][] in the demo app for a concrete example. See [`DemoUtil`][] in the demo app for a concrete example.
The example in the demo app also imports download state from legacy `ActionFile`
instances. This is only necessary if your app used `ActionFile` prior to
ExoPlayer 2.10.0.
{:.info}
## Adding a download ## ## Adding a download ##
To add a download you need to create a `DownloadRequest` and send it to your To add a download you need to create a `DownloadRequest` and send it to your
......
library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFile.java deleted 100644 → 0
/*
* Copyright (C) 2017 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.google.android.exoplayer2.offline;
import android.net.Uri;
import androidx.annotation.Nullable;
import com.google.android.exoplayer2.offline.DownloadRequest.UnsupportedRequestException;
import com.google.android.exoplayer2.util.AtomicFile;
import com.google.android.exoplayer2.util.MimeTypes;
import com.google.android.exoplayer2.util.Util;
import java.io.DataInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
/**
* Loads {@link DownloadRequest DownloadRequests} from legacy action files.
*
* @deprecated Legacy action files should be merged into download indices using {@link
* ActionFileUpgradeUtil}.
*/
@Deprecated
/* package */ final class ActionFile {
private static final int VERSION = 0;
private static final String DOWNLOAD_TYPE_PROGRESSIVE = "progressive";
private static final String DOWNLOAD_TYPE_DASH = "dash";
private static final String DOWNLOAD_TYPE_HLS = "hls";
private static final String DOWNLOAD_TYPE_SS = "ss";
private final AtomicFile atomicFile;
/**
* @param actionFile The file from which {@link DownloadRequest DownloadRequests} will be loaded.
*/
public ActionFile(File actionFile) {
atomicFile = new AtomicFile(actionFile);
}
/** Returns whether the file or its backup exists. */
public boolean exists() {
return atomicFile.exists();
}
/** Deletes the action file and its backup. */
public void delete() {
atomicFile.delete();
}
/**
* Loads {@link DownloadRequest DownloadRequests} from the file.
*
* @return The loaded {@link DownloadRequest DownloadRequests}, or an empty array if the file does
* not exist.
* @throws IOException If there is an error reading the file.
*/
public DownloadRequest[] load() throws IOException {
if (!exists()) {
return new DownloadRequest[0];
}
@Nullable InputStream inputStream = null;
try {
inputStream = atomicFile.openRead();
DataInputStream dataInputStream = new DataInputStream(inputStream);
int version = dataInputStream.readInt();
if (version > VERSION) {
throw new IOException("Unsupported action file version: " + version);
}
int actionCount = dataInputStream.readInt();
ArrayList<DownloadRequest> actions = new ArrayList<>();
for (int i = 0; i < actionCount; i++) {
try {
actions.add(readDownloadRequest(dataInputStream));
} catch (UnsupportedRequestException e) {
// remove DownloadRequest is not supported. Ignore and continue loading rest.
}
}
return actions.toArray(new DownloadRequest[0]);
} finally {
Util.closeQuietly(inputStream);
}
}
private static DownloadRequest readDownloadRequest(DataInputStream input) throws IOException {
String downloadType = input.readUTF();
int version = input.readInt();
Uri uri = Uri.parse(input.readUTF());
boolean isRemoveAction = input.readBoolean();
int dataLength = input.readInt();
@Nullable byte[] data;
if (dataLength != 0) {
data = new byte[dataLength];
input.readFully(data);
} else {
data = null;
}
// Serialized version 0 progressive actions did not contain keys.
boolean isLegacyProgressive = version == 0 && DOWNLOAD_TYPE_PROGRESSIVE.equals(downloadType);
List<StreamKey> keys = new ArrayList<>();
if (!isLegacyProgressive) {
int keyCount = input.readInt();
for (int i = 0; i < keyCount; i++) {
keys.add(readKey(downloadType, version, input));
}
}
// Serialized version 0 and 1 DASH/HLS/SS actions did not contain a custom cache key.
boolean isLegacySegmented =
version < 2
&& (DOWNLOAD_TYPE_DASH.equals(downloadType)
|| DOWNLOAD_TYPE_HLS.equals(downloadType)
|| DOWNLOAD_TYPE_SS.equals(downloadType));
@Nullable String customCacheKey = null;
if (!isLegacySegmented) {
customCacheKey = input.readBoolean() ? input.readUTF() : null;
}
// Serialized version 0, 1 and 2 did not contain an id. We need to generate one.
String id = version < 3 ? generateDownloadId(uri, customCacheKey) : input.readUTF();
if (isRemoveAction) {
// Remove actions are not supported anymore.
throw new UnsupportedRequestException();
}
return new DownloadRequest.Builder(id, uri)
.setMimeType(inferMimeType(downloadType))
.setStreamKeys(keys)
.setCustomCacheKey(customCacheKey)
.setData(data)
.build();
}
private static StreamKey readKey(String type, int version, DataInputStream input)
throws IOException {
int periodIndex;
int groupIndex;
int trackIndex;
// Serialized version 0 HLS/SS actions did not contain a period index.
if ((DOWNLOAD_TYPE_HLS.equals(type) || DOWNLOAD_TYPE_SS.equals(type)) && version == 0) {
periodIndex = 0;
groupIndex = input.readInt();
trackIndex = input.readInt();
} else {
periodIndex = input.readInt();
groupIndex = input.readInt();
trackIndex = input.readInt();
}
return new StreamKey(periodIndex, groupIndex, trackIndex);
}
private static String inferMimeType(String downloadType) {
switch (downloadType) {
case DOWNLOAD_TYPE_DASH:
return MimeTypes.APPLICATION_MPD;
case DOWNLOAD_TYPE_HLS:
return MimeTypes.APPLICATION_M3U8;
case DOWNLOAD_TYPE_SS:
return MimeTypes.APPLICATION_SS;
case DOWNLOAD_TYPE_PROGRESSIVE:
default:
return MimeTypes.VIDEO_UNKNOWN;
}
}
private static String generateDownloadId(Uri uri, @Nullable String customCacheKey) {
return customCacheKey != null ? customCacheKey : uri.toString();
}
}
library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFileUpgradeUtil.java deleted 100644 → 0
/*
* Copyright (C) 2019 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.google.android.exoplayer2.offline;
import static com.google.android.exoplayer2.offline.Download.STATE_QUEUED;
import androidx.annotation.Nullable;
import androidx.annotation.WorkerThread;
import com.google.android.exoplayer2.C;
import java.io.File;
import java.io.IOException;
/** Utility class for upgrading legacy action files into {@link DefaultDownloadIndex}. */
public final class ActionFileUpgradeUtil {
/** Provides download IDs during action file upgrade. */
public interface DownloadIdProvider {
/**
* Returns a download id for given request.
*
* @param downloadRequest The request for which an ID is required.
* @return A corresponding download ID.
*/
String getId(DownloadRequest downloadRequest);
}
private ActionFileUpgradeUtil() {}
/**
* Merges {@link DownloadRequest DownloadRequests} contained in a legacy action file into a {@link
* DefaultDownloadIndex}, deleting the action file if the merge is successful or if {@code
* deleteOnFailure} is {@code true}.
*
* <p>This method must not be called while the {@link DefaultDownloadIndex} is being used by a
* {@link DownloadManager}.
*
* <p>This method may be slow and shouldn't normally be called on the main thread.
*
* @param actionFilePath The action file path.
* @param downloadIdProvider A download ID provider, or {@code null}. If {@code null} then ID of
* each download will be its custom cache key if one is specified, or else its URL.
* @param downloadIndex The index into which the requests will be merged.
* @param deleteOnFailure Whether to delete the action file if the merge fails.
* @param addNewDownloadsAsCompleted Whether to add new downloads as completed.
* @throws IOException If an error occurs loading or merging the requests.
*/
@WorkerThread
@SuppressWarnings("deprecation")
public static void upgradeAndDelete(
File actionFilePath,
@Nullable DownloadIdProvider downloadIdProvider,
DefaultDownloadIndex downloadIndex,
boolean deleteOnFailure,
boolean addNewDownloadsAsCompleted)
throws IOException {
ActionFile actionFile = new ActionFile(actionFilePath);
if (actionFile.exists()) {
boolean success = false;
try {
long nowMs = System.currentTimeMillis();
for (DownloadRequest request : actionFile.load()) {
if (downloadIdProvider != null) {
request = request.copyWithId(downloadIdProvider.getId(request));
}
mergeRequest(request, downloadIndex, addNewDownloadsAsCompleted, nowMs);
}
success = true;
} finally {
if (success || deleteOnFailure) {
actionFile.delete();
}
}
}
}
/**
* Merges a {@link DownloadRequest} into a {@link DefaultDownloadIndex}.
*
* @param request The request to be merged.
* @param downloadIndex The index into which the request will be merged.
* @param addNewDownloadAsCompleted Whether to add new downloads as completed.
* @throws IOException If an error occurs merging the request.
*/
/* package */ static void mergeRequest(
DownloadRequest request,
DefaultDownloadIndex downloadIndex,
boolean addNewDownloadAsCompleted,
long nowMs)
throws IOException {
@Nullable Download download = downloadIndex.getDownload(request.id);
if (download != null) {
download = DownloadManager.mergeRequest(download, request, download.stopReason, nowMs);
} else {
download =
new Download(
request,
addNewDownloadAsCompleted ? Download.STATE_COMPLETED : STATE_QUEUED,
/* startTimeMs= */ nowMs,
/* updateTimeMs= */ nowMs,
/* contentLength= */ C.LENGTH_UNSET,
Download.STOP_REASON_NONE,
Download.FAILURE_REASON_NONE);
}
downloadIndex.putDownload(download);
}
}
library/core/src/test/java/com/google/android/exoplayer2/offline/ActionFileTest.java deleted 100644 → 0
/*
* Copyright (C) 2017 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.google.android.exoplayer2.offline;
import static com.google.common.truth.Truth.assertThat;
import android.net.Uri;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.android.exoplayer2.testutil.TestUtil;
import com.google.android.exoplayer2.util.MimeTypes;
import com.google.android.exoplayer2.util.Util;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
/** Unit tests for {@link ActionFile}. */
@SuppressWarnings("deprecation")
@RunWith(AndroidJUnit4.class)
public class ActionFileTest {
private File tempFile;
private DownloadRequest expectedAction1;
private DownloadRequest expectedAction2;
@Before
public void setUp() throws Exception {
tempFile = Util.createTempFile(ApplicationProvider.getApplicationContext(), "ExoPlayerTest");
expectedAction1 =
buildExpectedRequest(Uri.parse("http://test1.uri"), TestUtil.buildTestData(16));
expectedAction2 =
buildExpectedRequest(Uri.parse("http://test2.uri"), TestUtil.buildTestData(32));
}
@After
public void tearDown() throws Exception {
tempFile.delete();
}
@Test
public void loadNoDataThrowsIOException() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_no_data.exi");
try {
actionFile.load();
Assert.fail();
} catch (IOException e) {
// Expected exception.
}
}
@Test
public void loadIncompleteHeaderThrowsIOException() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_incomplete_header.exi");
try {
actionFile.load();
Assert.fail();
} catch (IOException e) {
// Expected exception.
}
}
@Test
public void loadZeroActions() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_zero_actions.exi");
DownloadRequest[] actions = actionFile.load();
assertThat(actions).isNotNull();
assertThat(actions).hasLength(0);
}
@Test
public void loadOneAction() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_one_action.exi");
DownloadRequest[] actions = actionFile.load();
assertThat(actions).hasLength(1);
assertThat(actions[0]).isEqualTo(expectedAction1);
}
@Test
public void loadTwoActions() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_two_actions.exi");
DownloadRequest[] actions = actionFile.load();
assertThat(actions).hasLength(2);
assertThat(actions[0]).isEqualTo(expectedAction1);
assertThat(actions[1]).isEqualTo(expectedAction2);
}
@Test
public void loadUnsupportedVersion() throws Exception {
ActionFile actionFile = getActionFile("media/offline/action_file_unsupported_version.exi");
try {
actionFile.load();
Assert.fail();
} catch (IOException e) {
// Expected exception.
}
}
private ActionFile getActionFile(String fileName) throws IOException {
// Copy the test data from the asset to where the ActionFile expects it to be.
byte[] actionFileBytes =
TestUtil.getByteArray(ApplicationProvider.getApplicationContext(), fileName);
try (FileOutputStream output = new FileOutputStream(tempFile)) {
output.write(actionFileBytes);
}
// Load the action file.
return new ActionFile(tempFile);
}
private static DownloadRequest buildExpectedRequest(Uri uri, byte[] data) {
return new DownloadRequest.Builder(/* id= */ uri.toString(), uri)
.setMimeType(MimeTypes.VIDEO_UNKNOWN)
.setData(data)
.build();
}
}
library/core/src/test/java/com/google/android/exoplayer2/offline/ProgressiveDownloaderTest.java
...@@ -41,8 +41,7 @@ import org.junit.Before; ...@@ -41,8 +41,7 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
/** Unit tests for {@link ActionFile}. */ /** Unit tests for {@link ProgressiveDownloader}. */
@SuppressWarnings("deprecation")
@RunWith(AndroidJUnit4.class) @RunWith(AndroidJUnit4.class)
public class ProgressiveDownloaderTest { public class ProgressiveDownloaderTest {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment