Move inband event streams to Representation

This is more consistent with our handling of DRM init data,
and is more correct. It'll be up to whoever's using the
manifest to look one layer deeper and figure out what event
streams are defined on all representations, if they wish to
do so.

Issue #2176

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=144968183

library/src/androidTest/java/com/google/android/exoplayer2/drm/OfflineLicenseHelperTest.java

@@ -27,14 +27,12 @@ import com.google.android.exoplayer2.Format;
 import com.google.android.exoplayer2.drm.DrmInitData.SchemeData;
 import com.google.android.exoplayer2.drm.DrmInitData.SchemeData;
 import com.google.android.exoplayer2.source.dash.manifest.AdaptationSet;
 import com.google.android.exoplayer2.source.dash.manifest.AdaptationSet;
 import com.google.android.exoplayer2.source.dash.manifest.DashManifest;
 import com.google.android.exoplayer2.source.dash.manifest.DashManifest;
-import com.google.android.exoplayer2.source.dash.manifest.InbandEventStream;
 import com.google.android.exoplayer2.source.dash.manifest.Period;
 import com.google.android.exoplayer2.source.dash.manifest.Period;
 import com.google.android.exoplayer2.source.dash.manifest.Representation;
 import com.google.android.exoplayer2.source.dash.manifest.Representation;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.SingleSegmentBase;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.SingleSegmentBase;
 import com.google.android.exoplayer2.testutil.TestUtil;
 import com.google.android.exoplayer2.testutil.TestUtil;
 import com.google.android.exoplayer2.upstream.HttpDataSource;
 import com.google.android.exoplayer2.upstream.HttpDataSource;
 import java.util.Arrays;
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashMap;
 import org.mockito.Mock;
 import org.mockito.Mock;
 
 
@@ -205,18 +203,17 @@ public class OfflineLicenseHelperTest extends InstrumentationTestCase {
   private static DashManifest newDashManifestWithAllElements() {
   private static DashManifest newDashManifestWithAllElements() {
     return newDashManifest(newPeriods(newAdaptationSets(newRepresentations(newDrmInitData()))));
     return newDashManifest(newPeriods(newAdaptationSets(newRepresentations(newDrmInitData()))));
   }
   }
-  
+
   private static DashManifest newDashManifest(Period... periods) {
   private static DashManifest newDashManifest(Period... periods) {
     return new DashManifest(0, 0, 0, false, 0, 0, 0, null, null, Arrays.asList(periods));
     return new DashManifest(0, 0, 0, false, 0, 0, 0, null, null, Arrays.asList(periods));
   }
   }
-  
+
   private static Period newPeriods(AdaptationSet... adaptationSets) {
   private static Period newPeriods(AdaptationSet... adaptationSets) {
     return new Period("", 0, Arrays.asList(adaptationSets));
     return new Period("", 0, Arrays.asList(adaptationSets));
   }
   }
 
 
   private static AdaptationSet newAdaptationSets(Representation... representations) {
   private static AdaptationSet newAdaptationSets(Representation... representations) {
-    return new AdaptationSet(0, C.TRACK_TYPE_VIDEO, Arrays.asList(representations),
-        Collections.<InbandEventStream>emptyList());
+    return new AdaptationSet(0, C.TRACK_TYPE_VIDEO, Arrays.asList(representations));
   }
   }
 
 
   private static Representation newRepresentations(DrmInitData drmInitData) {
   private static Representation newRepresentations(DrmInitData drmInitData) {
@@ -225,7 +222,7 @@ public class OfflineLicenseHelperTest extends InstrumentationTestCase {
   }
   }
 
 
   private static DrmInitData newDrmInitData() {
   private static DrmInitData newDrmInitData() {
-    return new DrmInitData(new SchemeData(C.WIDEVINE_UUID, "mimeType", 
+    return new DrmInitData(new SchemeData(C.WIDEVINE_UUID, "mimeType",
         new byte[]{1, 4, 7, 0, 3, 6}));
         new byte[]{1, 4, 7, 0, 3, 6}));
   }
   }
 
 

library/src/main/java/com/google/android/exoplayer2/source/dash/manifest/AdaptationSet.java

@@ -46,25 +46,16 @@ public class AdaptationSet {
   public final List<Representation> representations;
   public final List<Representation> representations;
 
 
   /**
   /**
-   * The {@link InbandEventStream}s contained by all {@link Representation}s in the adaptation set.
-   */
-  public final List<InbandEventStream> inbandEventStreams;
-
-  /**
    * @param id A non-negative identifier for the adaptation set that's unique in the scope of its
    * @param id A non-negative identifier for the adaptation set that's unique in the scope of its
    *     containing period, or {@link #ID_UNSET} if not specified.
    *     containing period, or {@link #ID_UNSET} if not specified.
    * @param type The type of the adaptation set. One of the {@link com.google.android.exoplayer2.C}
    * @param type The type of the adaptation set. One of the {@link com.google.android.exoplayer2.C}
    *     {@code TRACK_TYPE_*} constants.
    *     {@code TRACK_TYPE_*} constants.
    * @param representations The {@link Representation}s in the adaptation set.
    * @param representations The {@link Representation}s in the adaptation set.
-   * @param inbandEventStreams The {@link InbandEventStream}s contained by all
-   *     {@link Representation}s in the adaptation set.
    */
    */
-  public AdaptationSet(int id, int type, List<Representation> representations,
-      List<InbandEventStream> inbandEventStreams) {
+  public AdaptationSet(int id, int type, List<Representation> representations) {
     this.id = id;
     this.id = id;
     this.type = type;
     this.type = type;
     this.representations = Collections.unmodifiableList(representations);
     this.representations = Collections.unmodifiableList(representations);
-    this.inbandEventStreams = Collections.unmodifiableList(inbandEventStreams);
   }
   }
 
 
 }
 }

library/src/main/java/com/google/android/exoplayer2/source/dash/manifest/DashManifestParser.java

@@ -240,9 +240,8 @@ public class DashManifestParser extends DefaultHandler
     String language = xpp.getAttributeValue(null, "lang");
     String language = xpp.getAttributeValue(null, "lang");
     int accessibilityChannel = Format.NO_VALUE;
     int accessibilityChannel = Format.NO_VALUE;
     ArrayList<SchemeData> drmSchemeDatas = new ArrayList<>();
     ArrayList<SchemeData> drmSchemeDatas = new ArrayList<>();
+    ArrayList<InbandEventStream> inbandEventStreams = new ArrayList<>();
     List<RepresentationInfo> representationInfos = new ArrayList<>();
     List<RepresentationInfo> representationInfos = new ArrayList<>();
-    List<InbandEventStream> adaptationSetInbandEventStreams = new ArrayList<>();
-    List<InbandEventStream> commonRepresentationInbandEventStreams = null;
     @C.SelectionFlags int selectionFlags = 0;
     @C.SelectionFlags int selectionFlags = 0;
 
 
     boolean seenFirstBaseUrl = false;
     boolean seenFirstBaseUrl = false;
@@ -274,22 +273,6 @@ public class DashManifestParser extends DefaultHandler
         contentType = checkContentTypeConsistency(contentType,
         contentType = checkContentTypeConsistency(contentType,
             getContentType(representationInfo.format));
             getContentType(representationInfo.format));
         representationInfos.add(representationInfo);
         representationInfos.add(representationInfo);
-        // Initialize or update InbandEventStream elements defined in all child Representations.
-        List<InbandEventStream> inbandEventStreams = representationInfo.inbandEventStreams;
-        if (commonRepresentationInbandEventStreams == null) {
-          // Initialize with the elements defined in this representation.
-          commonRepresentationInbandEventStreams = new ArrayList<>(inbandEventStreams);
-        } else {
-          // Remove elements that are not also defined in this representation.
-          for (int i = commonRepresentationInbandEventStreams.size() - 1; i >= 0; i--) {
-            InbandEventStream inbandEventStream = commonRepresentationInbandEventStreams.get(i);
-            if (!inbandEventStreams.contains(inbandEventStream)) {
-              Log.w(TAG, "Ignoring InbandEventStream element not defined on all Representations: "
-                  + inbandEventStream);
-              commonRepresentationInbandEventStreams.remove(i);
-            }
-          }
-        }
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentBase")) {
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentBase")) {
         segmentBase = parseSegmentBase(xpp, (SingleSegmentBase) segmentBase);
         segmentBase = parseSegmentBase(xpp, (SingleSegmentBase) segmentBase);
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentList")) {
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentList")) {
@@ -297,33 +280,25 @@ public class DashManifestParser extends DefaultHandler
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentTemplate")) {
       } else if (XmlPullParserUtil.isStartTag(xpp, "SegmentTemplate")) {
         segmentBase = parseSegmentTemplate(xpp, (SegmentTemplate) segmentBase);
         segmentBase = parseSegmentTemplate(xpp, (SegmentTemplate) segmentBase);
       } else if (XmlPullParserUtil.isStartTag(xpp, "InbandEventStream")) {
       } else if (XmlPullParserUtil.isStartTag(xpp, "InbandEventStream")) {
-        adaptationSetInbandEventStreams.add(parseInbandEventStream(xpp));
+        inbandEventStreams.add(parseInbandEventStream(xpp));
       } else if (XmlPullParserUtil.isStartTag(xpp)) {
       } else if (XmlPullParserUtil.isStartTag(xpp)) {
         parseAdaptationSetChild(xpp);
         parseAdaptationSetChild(xpp);
       }
       }
     } while (!XmlPullParserUtil.isEndTag(xpp, "AdaptationSet"));
     } while (!XmlPullParserUtil.isEndTag(xpp, "AdaptationSet"));
 
 
-    // Pull up InbandEventStream elements defined in all child Representations.
-    for (int i = 0; i < commonRepresentationInbandEventStreams.size(); i++) {
-      InbandEventStream inbandEventStream = commonRepresentationInbandEventStreams.get(i);
-      if (!adaptationSetInbandEventStreams.contains(inbandEventStream)) {
-        adaptationSetInbandEventStreams.add(inbandEventStream);
-      }
-    }
-
     // Build the representations.
     // Build the representations.
     List<Representation> representations = new ArrayList<>(representationInfos.size());
     List<Representation> representations = new ArrayList<>(representationInfos.size());
     for (int i = 0; i < representationInfos.size(); i++) {
     for (int i = 0; i < representationInfos.size(); i++) {
       representations.add(buildRepresentation(representationInfos.get(i), contentId,
       representations.add(buildRepresentation(representationInfos.get(i), contentId,
-          drmSchemeDatas));
+          drmSchemeDatas, inbandEventStreams));
     }
     }
 
 
-    return buildAdaptationSet(id, contentType, representations, adaptationSetInbandEventStreams);
+    return buildAdaptationSet(id, contentType, representations);
   }
   }
 
 
   protected AdaptationSet buildAdaptationSet(int id, int contentType,
   protected AdaptationSet buildAdaptationSet(int id, int contentType,
-      List<Representation> representations, List<InbandEventStream> inbandEventStreams) {
-    return new AdaptationSet(id, contentType, representations, inbandEventStreams);
+      List<Representation> representations) {
+    return new AdaptationSet(id, contentType, representations);
   }
   }
 
 
   protected int parseContentType(XmlPullParser xpp) {
   protected int parseContentType(XmlPullParser xpp) {
@@ -510,15 +485,18 @@ public class DashManifestParser extends DefaultHandler
   }
   }
 
 
   protected Representation buildRepresentation(RepresentationInfo representationInfo,
   protected Representation buildRepresentation(RepresentationInfo representationInfo,
-      String contentId, ArrayList<SchemeData> extraDrmSchemeDatas) {
+      String contentId, ArrayList<SchemeData> extraDrmSchemeDatas,
+      ArrayList<InbandEventStream> extraInbandEventStreams) {
     Format format = representationInfo.format;
     Format format = representationInfo.format;
     ArrayList<SchemeData> drmSchemeDatas = representationInfo.drmSchemeDatas;
     ArrayList<SchemeData> drmSchemeDatas = representationInfo.drmSchemeDatas;
     drmSchemeDatas.addAll(extraDrmSchemeDatas);
     drmSchemeDatas.addAll(extraDrmSchemeDatas);
     if (!drmSchemeDatas.isEmpty()) {
     if (!drmSchemeDatas.isEmpty()) {
       format = format.copyWithDrmInitData(new DrmInitData(drmSchemeDatas));
       format = format.copyWithDrmInitData(new DrmInitData(drmSchemeDatas));
     }
     }
+    ArrayList<InbandEventStream> inbandEventStremas = representationInfo.inbandEventStreams;
+    inbandEventStremas.addAll(extraInbandEventStreams);
     return Representation.newInstance(contentId, Representation.REVISION_ID_DEFAULT, format,
     return Representation.newInstance(contentId, Representation.REVISION_ID_DEFAULT, format,
-        representationInfo.baseUrl, representationInfo.segmentBase);
+        representationInfo.baseUrl, representationInfo.segmentBase, inbandEventStremas);
   }
   }
 
 
   // SegmentBase, SegmentList and SegmentTemplate parsing.
   // SegmentBase, SegmentList and SegmentTemplate parsing.

library/src/main/java/com/google/android/exoplayer2/source/dash/manifest/Representation.java

@@ -21,6 +21,8 @@ import com.google.android.exoplayer2.Format;
 import com.google.android.exoplayer2.source.dash.DashSegmentIndex;
 import com.google.android.exoplayer2.source.dash.DashSegmentIndex;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.MultiSegmentBase;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.MultiSegmentBase;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.SingleSegmentBase;
 import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.SingleSegmentBase;
+import java.util.Collections;
+import java.util.List;
 
 
 /**
 /**
  * A DASH representation.
  * A DASH representation.
@@ -60,6 +62,10 @@ public abstract class Representation {
    * The offset of the presentation timestamps in the media stream relative to media time.
    * The offset of the presentation timestamps in the media stream relative to media time.
    */
    */
   public final long presentationTimeOffsetUs;
   public final long presentationTimeOffsetUs;
+  /**
+   * The {@link InbandEventStream}s in the representation. Never null, but may be empty.
+   */
+  public final List<InbandEventStream> inbandEventStreams;
 
 
   private final RangedUri initializationUri;
   private final RangedUri initializationUri;
 
 
@@ -84,20 +90,39 @@ public abstract class Representation {
    * @param contentId Identifies the piece of content to which this representation belongs.
    * @param contentId Identifies the piece of content to which this representation belongs.
    * @param revisionId Identifies the revision of the content.
    * @param revisionId Identifies the revision of the content.
    * @param format The format of the representation.
    * @param format The format of the representation.
+   * @param baseUrl The base URL.
+   * @param segmentBase A segment base element for the representation.
+   * @param inbandEventStreams The {@link InbandEventStream}s in the representation. May be null.
+   * @return The constructed instance.
+   */
+  public static Representation newInstance(String contentId, long revisionId, Format format,
+      String baseUrl, SegmentBase segmentBase, List<InbandEventStream> inbandEventStreams) {
+    return newInstance(contentId, revisionId, format, baseUrl, segmentBase, inbandEventStreams,
+        null);
+  }
+
+  /**
+   * Constructs a new instance.
+   *
+   * @param contentId Identifies the piece of content to which this representation belongs.
+   * @param revisionId Identifies the revision of the content.
+   * @param format The format of the representation.
    * @param baseUrl The base URL of the representation.
    * @param baseUrl The base URL of the representation.
    * @param segmentBase A segment base element for the representation.
    * @param segmentBase A segment base element for the representation.
+   * @param inbandEventStreams The {@link InbandEventStream}s in the representation. May be null.
    * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null. This
    * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null. This
    *     parameter is ignored if {@code segmentBase} consists of multiple segments.
    *     parameter is ignored if {@code segmentBase} consists of multiple segments.
    * @return The constructed instance.
    * @return The constructed instance.
    */
    */
   public static Representation newInstance(String contentId, long revisionId, Format format,
   public static Representation newInstance(String contentId, long revisionId, Format format,
-      String baseUrl, SegmentBase segmentBase, String customCacheKey) {
+      String baseUrl, SegmentBase segmentBase, List<InbandEventStream> inbandEventStreams,
+      String customCacheKey) {
     if (segmentBase instanceof SingleSegmentBase) {
     if (segmentBase instanceof SingleSegmentBase) {
       return new SingleSegmentRepresentation(contentId, revisionId, format, baseUrl,
       return new SingleSegmentRepresentation(contentId, revisionId, format, baseUrl,
-          (SingleSegmentBase) segmentBase, customCacheKey, C.LENGTH_UNSET);
+          (SingleSegmentBase) segmentBase, inbandEventStreams, customCacheKey, C.LENGTH_UNSET);
     } else if (segmentBase instanceof MultiSegmentBase) {
     } else if (segmentBase instanceof MultiSegmentBase) {
       return new MultiSegmentRepresentation(contentId, revisionId, format, baseUrl,
       return new MultiSegmentRepresentation(contentId, revisionId, format, baseUrl,
-          (MultiSegmentBase) segmentBase);
+          (MultiSegmentBase) segmentBase, inbandEventStreams);
     } else {
     } else {
       throw new IllegalArgumentException("segmentBase must be of type SingleSegmentBase or "
       throw new IllegalArgumentException("segmentBase must be of type SingleSegmentBase or "
           + "MultiSegmentBase");
           + "MultiSegmentBase");
@@ -105,11 +130,14 @@ public abstract class Representation {
   }
   }
 
 
   private Representation(String contentId, long revisionId, Format format, String baseUrl,
   private Representation(String contentId, long revisionId, Format format, String baseUrl,
-      SegmentBase segmentBase) {
+      SegmentBase segmentBase, List<InbandEventStream> inbandEventStreams) {
     this.contentId = contentId;
     this.contentId = contentId;
     this.revisionId = revisionId;
     this.revisionId = revisionId;
     this.format = format;
     this.format = format;
     this.baseUrl = baseUrl;
     this.baseUrl = baseUrl;
+    this.inbandEventStreams = inbandEventStreams == null
+        ? Collections.<InbandEventStream>emptyList()
+        : Collections.unmodifiableList(inbandEventStreams);
     initializationUri = segmentBase.getInitialization(this);
     initializationUri = segmentBase.getInitialization(this);
     presentationTimeOffsetUs = segmentBase.getPresentationTimeOffsetUs();
     presentationTimeOffsetUs = segmentBase.getPresentationTimeOffsetUs();
   }
   }
@@ -167,18 +195,20 @@ public abstract class Representation {
      * @param initializationEnd The offset of the last byte of initialization data.
      * @param initializationEnd The offset of the last byte of initialization data.
      * @param indexStart The offset of the first byte of index data.
      * @param indexStart The offset of the first byte of index data.
      * @param indexEnd The offset of the last byte of index data.
      * @param indexEnd The offset of the last byte of index data.
+     * @param inbandEventStreams The {@link InbandEventStream}s in the representation. May be null.
      * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null.
      * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null.
      * @param contentLength The content length, or {@link C#LENGTH_UNSET} if unknown.
      * @param contentLength The content length, or {@link C#LENGTH_UNSET} if unknown.
      */
      */
     public static SingleSegmentRepresentation newInstance(String contentId, long revisionId,
     public static SingleSegmentRepresentation newInstance(String contentId, long revisionId,
         Format format, String uri, long initializationStart, long initializationEnd,
         Format format, String uri, long initializationStart, long initializationEnd,
-        long indexStart, long indexEnd, String customCacheKey, long contentLength) {
+        long indexStart, long indexEnd, List<InbandEventStream> inbandEventStreams,
+        String customCacheKey, long contentLength) {
       RangedUri rangedUri = new RangedUri(null, initializationStart,
       RangedUri rangedUri = new RangedUri(null, initializationStart,
           initializationEnd - initializationStart + 1);
           initializationEnd - initializationStart + 1);
       SingleSegmentBase segmentBase = new SingleSegmentBase(rangedUri, 1, 0, indexStart,
       SingleSegmentBase segmentBase = new SingleSegmentBase(rangedUri, 1, 0, indexStart,
           indexEnd - indexStart + 1);
           indexEnd - indexStart + 1);
       return new SingleSegmentRepresentation(contentId, revisionId,
       return new SingleSegmentRepresentation(contentId, revisionId,
-          format, uri, segmentBase, customCacheKey, contentLength);
+          format, uri, segmentBase, inbandEventStreams, customCacheKey, contentLength);
     }
     }
 
 
     /**
     /**
@@ -187,12 +217,14 @@ public abstract class Representation {
      * @param format The format of the representation.
      * @param format The format of the representation.
      * @param baseUrl The base URL of the representation.
      * @param baseUrl The base URL of the representation.
      * @param segmentBase The segment base underlying the representation.
      * @param segmentBase The segment base underlying the representation.
+     * @param inbandEventStreams The {@link InbandEventStream}s in the representation. May be null.
      * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null.
      * @param customCacheKey A custom value to be returned from {@link #getCacheKey()}, or null.
      * @param contentLength The content length, or {@link C#LENGTH_UNSET} if unknown.
      * @param contentLength The content length, or {@link C#LENGTH_UNSET} if unknown.
      */
      */
     public SingleSegmentRepresentation(String contentId, long revisionId, Format format,
     public SingleSegmentRepresentation(String contentId, long revisionId, Format format,
-        String baseUrl, SingleSegmentBase segmentBase, String customCacheKey, long contentLength) {
-      super(contentId, revisionId, format, baseUrl, segmentBase);
+        String baseUrl, SingleSegmentBase segmentBase, List<InbandEventStream> inbandEventStreams,
+        String customCacheKey, long contentLength) {
+      super(contentId, revisionId, format, baseUrl, segmentBase, inbandEventStreams);
       this.uri = Uri.parse(baseUrl);
       this.uri = Uri.parse(baseUrl);
       this.indexUri = segmentBase.getIndex();
       this.indexUri = segmentBase.getIndex();
       this.cacheKey = customCacheKey != null ? customCacheKey
       this.cacheKey = customCacheKey != null ? customCacheKey
@@ -235,10 +267,11 @@ public abstract class Representation {
      * @param format The format of the representation.
      * @param format The format of the representation.
      * @param baseUrl The base URL of the representation.
      * @param baseUrl The base URL of the representation.
      * @param segmentBase The segment base underlying the representation.
      * @param segmentBase The segment base underlying the representation.
+     * @param inbandEventStreams The {@link InbandEventStream}s in the representation. May be null.
      */
      */
     public MultiSegmentRepresentation(String contentId, long revisionId, Format format,
     public MultiSegmentRepresentation(String contentId, long revisionId, Format format,
-        String baseUrl, MultiSegmentBase segmentBase) {
-      super(contentId, revisionId, format, baseUrl, segmentBase);
+        String baseUrl, MultiSegmentBase segmentBase, List<InbandEventStream> inbandEventStreams) {
+      super(contentId, revisionId, format, baseUrl, segmentBase, inbandEventStreams);
       this.segmentBase = segmentBase;
       this.segmentBase = segmentBase;
     }
     }