[YouTube] Don't generate manifests for post live streams when loading the stream info

AudricV · AudricV · commit 7f19059f442d · 2021-08-16T21:17:27.000+02:00
Like for OTF streams, to prevent errors, unused requests, and improve the content loading.

Add getters and setter for ItagInfo objects. Fields of this class are now private.

Add some unknown constants and some JavaDocs
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/ItagInfo.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/ItagInfo.java
@@ -3,15 +3,29 @@
 import java.io.Serializable;
 
 public class ItagInfo implements Serializable {
-    public String content;
-    public ItagItem itagItem;
-    public boolean isUrl;
+    private final String content;
+    private final ItagItem itagItem;
+    private boolean isUrl;
 
     public ItagInfo(final String content,
-                    final ItagItem itagItem,
-                    final boolean isUrl) {
+                    final ItagItem itagItem) {
         this.content = content;
         this.itagItem = itagItem;
+    }
+
+    public void setIsUrl(final boolean isUrl) {
         this.isUrl = isUrl;
     }
+
+    public String getContent() {
+        return content;
+    }
+
+    public ItagItem getItagItem() {
+        return itagItem;
+    }
+
+    public boolean getIsUrl() {
+        return isUrl;
+    }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/ItagItem.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/ItagItem.java
@@ -17,8 +17,8 @@ public class ItagItem implements Serializable {
      */
     private static final ItagItem[] ITAG_LIST = {
             /////////////////////////////////////////////////////
-            // VIDEO     ID  Type   Format  Resolution  FPS  ///
-            ///////////////////////////////////////////////////
+            // VIDEO     ID  Type   Format  Resolution  FPS  ////
+            /////////////////////////////////////////////////////
             new ItagItem(17, VIDEO, v3GPP, "144p"),
             new ItagItem(36, VIDEO, v3GPP, "240p"),
 
@@ -36,8 +36,8 @@ public class ItagItem implements Serializable {
             new ItagItem(45, VIDEO, WEBM, "720p"),
             new ItagItem(46, VIDEO, WEBM, "1080p"),
 
-            ////////////////////////////////////////////////////////////////////
-            // AUDIO     ID      ItagType          Format        Bitrate    ///
+            //////////////////////////////////////////////////////////////////
+            // AUDIO     ID      ItagType          Format        Bitrate    //
             //////////////////////////////////////////////////////////////////
             new ItagItem(171, AUDIO, WEBMA, 128),
             new ItagItem(172, AUDIO, WEBMA, 256),
@@ -49,8 +49,8 @@ public class ItagItem implements Serializable {
             new ItagItem(251, AUDIO, WEBMA_OPUS, 160),
 
             /// VIDEO ONLY ////////////////////////////////////////////
-            //           ID      Type     Format  Resolution  FPS  ///
-            /////////////////////////////////////////////////////////
+            //           ID      Type     Format  Resolution  FPS  ////
+            ///////////////////////////////////////////////////////////
             new ItagItem(160, VIDEO_ONLY, MPEG_4, "144p"),
             new ItagItem(133, VIDEO_ONLY, MPEG_4, "240p"),
             new ItagItem(134, VIDEO_ONLY, MPEG_4, "360p"),
@@ -100,11 +100,20 @@ public static ItagItem getItag(final int itagId) throws ParsingException {
                 return item;
             }
         }
-        throw new ParsingException("itag=" + itagId + " not supported");
+        throw new ParsingException("itag " + itagId + " is not supported");
     }
 
     /*//////////////////////////////////////////////////////////////////////////
-    // Contructors and misc
+    // Static constants
+    //////////////////////////////////////////////////////////////////////////*/
+
+    public static final int AVERAGE_BITRATE_UNKNOWN = -1;
+    public static final int SAMPLE_RATE_UNKNOWN = -1;
+    public static final int FPS_UNKNOWN = -1;
+    public static final int TARGET_DURATION_SEC_UNKNOWN = -1;
+
+    /*//////////////////////////////////////////////////////////////////////////
+    // Constructors and misc
     //////////////////////////////////////////////////////////////////////////*/
 
     public enum ItagType {
@@ -163,12 +172,12 @@ public MediaFormat getMediaFormat() {
     public final ItagType itagType;
 
     // Audio fields
-    public int avgBitrate = -1;
-    public int sampleRate = -1;
+    public int avgBitrate = AVERAGE_BITRATE_UNKNOWN;
+    private int sampleRate = SAMPLE_RATE_UNKNOWN;
 
     // Video fields
     public String resolutionString;
-    public int fps = -1;
+    public int fps = FPS_UNKNOWN;
 
     // Fields for Dash
     private int bitrate;
@@ -180,76 +189,133 @@ public MediaFormat getMediaFormat() {
     private int indexEnd;
     private String quality;
     private String codec;
+    private int targetDurationSec = TARGET_DURATION_SEC_UNKNOWN;
 
     public int getBitrate() {
         return bitrate;
     }
 
-    public void setBitrate(int bitrate) {
+    public void setBitrate(final int bitrate) {
         this.bitrate = bitrate;
     }
 
     public int getWidth() {
         return width;
     }
 
-    public void setWidth(int width) {
+    public void setWidth(final int width) {
         this.width = width;
     }
 
     public int getHeight() {
         return height;
     }
 
-    public void setHeight(int height) {
+    public void setHeight(final int height) {
         this.height = height;
     }
 
     public int getInitStart() {
         return initStart;
     }
 
-    public void setInitStart(int initStart) {
+    public void setInitStart(final int initStart) {
         this.initStart = initStart;
     }
 
     public int getInitEnd() {
         return initEnd;
     }
 
-    public void setInitEnd(int initEnd) {
+    public void setInitEnd(final int initEnd) {
         this.initEnd = initEnd;
     }
 
     public int getIndexStart() {
         return indexStart;
     }
 
-    public void setIndexStart(int indexStart) {
+    public void setIndexStart(final int indexStart) {
         this.indexStart = indexStart;
     }
 
     public int getIndexEnd() {
         return indexEnd;
     }
 
-    public void setIndexEnd(int indexEnd) {
+    public void setIndexEnd(final int indexEnd) {
         this.indexEnd = indexEnd;
     }
 
     public String getQuality() {
         return quality;
     }
 
-    public void setQuality(String quality) {
+    public void setQuality(final String quality) {
         this.quality = quality;
     }
 
     public String getCodec() {
         return codec;
     }
 
-    public void setCodec(String codec) {
+    public void setCodec(final String codec) {
         this.codec = codec;
     }
+
+    /**
+     * Get the {@code targetDurationSec} value.
+     * <p>
+     * This value is an average time in seconds of sequences duration of livestreams and ended
+     * livestreams. It is only returned for these stream types by YouTube and makes no sense for
+     * videos, so {@link #TARGET_DURATION_SEC_UNKNOWN} is returned for video streams.
+     * </p>
+     *
+     * @return the targetDurationSec value or {@link #TARGET_DURATION_SEC_UNKNOWN}
+     */
+    public int getTargetDurationSec() {
+        return targetDurationSec;
+    }
+
+    /**
+     * Set the {@code targetDurationSec} value.
+     * <p>
+     * This value is an average time in seconds of sequences duration of livestreams and ended
+     * livestreams. It is only returned for these stream types by YouTube and makes no sense for
+     * videos, so {@link #TARGET_DURATION_SEC_UNKNOWN} will be set for video streams or if this
+     * value is less than or equal to 0.
+     * </p>
+     *
+     */
+    public void setTargetDurationSec(final int targetDurationSec) {
+        if (targetDurationSec > 0) {
+            this.targetDurationSec = targetDurationSec;
+        }
+    }
+
+    /**
+     * Get the sample rate.
+     * <p>
+     * It is only known for audio streams, so {@link #SAMPLE_RATE_UNKNOWN} is returned for video
+     * streams or if the sample rate is unknown.
+     * </p>
+     *
+     * @return the sample rate or {@link #SAMPLE_RATE_UNKNOWN}
+     */
+    public int getSampleRate() {
+        return sampleRate;
+    }
+
+    /**
+     * Set the sample rate.
+     * <p>
+     * It is only known for audio streams, so {@link #SAMPLE_RATE_UNKNOWN} is set for video
+     * streams or if the sample rate value is less than or equal to 0.
+     * </p>
+     */
+    public void setSampleRate(final int sampleRate) {
+        if (sampleRate > 0) {
+            this.sampleRate = sampleRate;
+        }
+    }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/YoutubeDashManifestCreator.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/YoutubeDashManifestCreator.java
@@ -478,10 +478,10 @@ private static void generateRepresentationElement(@Nonnull final Document docume
                 representationElement.setAttributeNode(frameRateAttribute);
             }
 
-            if (itagType == ItagItem.ItagType.AUDIO && itagItem.sampleRate > 0) {
+            if (itagType == ItagItem.ItagType.AUDIO && itagItem.getSampleRate() > 0) {
                 final Attr audioSamplingRateAttribute = document.createAttribute(
                         "audioSamplingRate");
-                audioSamplingRateAttribute.setValue(String.valueOf(itagItem.sampleRate));
+                audioSamplingRateAttribute.setValue(String.valueOf(itagItem.getSampleRate()));
             }
 
             adaptationSetElement.appendChild(representationElement);
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
@@ -515,9 +515,9 @@ public List<AudioStream> getAudioStreams() throws ExtractionException {
             try {
                 for (final ItagInfo itagInfo : getItags(ADAPTIVE_FORMATS,
                         ItagItem.ItagType.AUDIO)) {
-                    final ItagItem itag = itagInfo.itagItem;
-                    final String content = itagInfo.content;
-                    final boolean isUrl = itagInfo.isUrl;
+                    final ItagItem itag = itagInfo.getItagItem();
+                    final String content = itagInfo.getContent();
+                    final boolean isUrl = itagInfo.getIsUrl();
                     final AudioStream audioStream;
 
                     if (streamType == StreamType.VIDEO_STREAM) {
@@ -560,9 +560,9 @@ public List<VideoStream> getVideoStreams() throws ExtractionException {
 
             try {
                 for (final ItagInfo itagInfo : getItags(FORMATS, ItagItem.ItagType.VIDEO)) {
-                    final ItagItem itag = itagInfo.itagItem;
-                    final String content = itagInfo.content;
-                    final boolean isUrl = itagInfo.isUrl;
+                    final ItagItem itag = itagInfo.getItagItem();
+                    final String content = itagInfo.getContent();
+                    final boolean isUrl = itagInfo.getIsUrl();
                     final VideoStream videoStream;
 
                     if (streamType == StreamType.VIDEO_STREAM) {
@@ -605,9 +605,9 @@ public List<VideoStream> getVideoOnlyStreams() throws ExtractionException {
             try {
                 for (final ItagInfo itagInfo : getItags(ADAPTIVE_FORMATS,
                         ItagItem.ItagType.VIDEO_ONLY)) {
-                    final ItagItem itag = itagInfo.itagItem;
-                    final String content = itagInfo.content;
-                    final boolean isUrl = itagInfo.isUrl;
+                    final ItagItem itag = itagInfo.getItagItem();
+                    final String content = itagInfo.getContent();
+                    final boolean isUrl = itagInfo.getIsUrl();
                     final VideoStream videoOnlyStream;
 
                     if (streamType == StreamType.VIDEO_STREAM) {
@@ -1243,45 +1243,31 @@ private List<ItagInfo> getStreamsFromStreamingDataKey(
                                     "-1")));
                             itagItem.setQuality(formatData.getString("quality"));
                             itagItem.setCodec(codec);
+                            itagItem.setTargetDurationSec(formatData.getInt("targetDurationSec"));
 
                             if (itagType == ItagItem.ItagType.VIDEO
                                     || itagType == ItagItem.ItagType.VIDEO_ONLY) {
                                 itagItem.fps = formatData.getInt("fps");
                             }
                             if (itagType == ItagItem.ItagType.AUDIO) {
-                                itagItem.sampleRate = Integer.parseInt(formatData.getString(
-                                        "audioSampleRate"));
+                                itagItem.setSampleRate(Integer.parseInt(formatData.getString(
+                                        "audioSampleRate")));
                             }
+                            final ItagInfo itagInfo = new ItagInfo(streamUrl, itagItem);
 
                             if (streamType == StreamType.VIDEO_STREAM) {
-                                if (formatData.getString("type", EMPTY_STRING)
-                                        .equalsIgnoreCase("FORMAT_STREAM_TYPE_OTF")) {
-                                    itagInfos.add(new ItagInfo(streamUrl, itagItem, false));
-                                } else {
-                                    itagInfos.add(new ItagInfo(streamUrl, itagItem, true));
-                                }
-                            } else if (streamType == StreamType.POST_LIVE_STREAM) {
-                                // Even if it increases the content loading, we need to generate
-                                // manifests of post live streams now because the
-                                // targetDurationSec value is required to create these manifests
-                                try {
-                                    final String content =
-                                            createDashManifestFromPostLiveStreamDvrStreamingUrl(
-                                                    streamUrl, itagItem, formatData
-                                                            .getInt("targetDurationSec"));
-                                    itagInfos.add(new ItagInfo(content, itagItem, false));
-                                } catch (final YoutubeDashManifestCreator
-                                        .YoutubeDashManifestCreationException ignored) {
-                                    // Something went wrong when generating the DASH manifest
-                                    // of the stream, don't add this stream to the stream list
-                                }
+                                itagInfo.setIsUrl(!formatData.getString("type", EMPTY_STRING)
+                                        .equalsIgnoreCase("FORMAT_STREAM_TYPE_OTF"));
                             } else {
                                 // We are currently not able to generate DASH manifests for running
                                 // livestreams, so because of the requirements of StreamInfo
-                                // objects, return these streams as DASH streams
-                                // (even if they are not playable).
-                                itagInfos.add(new ItagInfo(streamUrl, itagItem, true));
+                                // objects, return these streams as DASH URL streams (even if they
+                                // are not playable).
+                                // Ended livestreams are returned as non URL streams
+                                itagInfo.setIsUrl(streamType != StreamType.POST_LIVE_STREAM);
                             }
+
+                            itagInfos.add(itagInfo);
                         }
                     } catch (final UnsupportedEncodingException | ParsingException ignored) {
                     }

Original file line number	Diff line number	Diff line change
`@@ -478,10 +478,10 @@ private static void generateRepresentationElement(@Nonnull final Document docume`
`478`	`478`	`representationElement.setAttributeNode(frameRateAttribute);`
`479`	`479`	`}`
`480`	`480`
`481`		`- if (itagType == ItagItem.ItagType.AUDIO && itagItem.sampleRate > 0) {`
	`481`	`+ if (itagType == ItagItem.ItagType.AUDIO && itagItem.getSampleRate() > 0) {`
`482`	`482`	`final Attr audioSamplingRateAttribute = document.createAttribute(`
`483`	`483`	`"audioSamplingRate");`
`484`		`- audioSamplingRateAttribute.setValue(String.valueOf(itagItem.sampleRate));`
	`484`	`+ audioSamplingRateAttribute.setValue(String.valueOf(itagItem.getSampleRate()));`
`485`	`485`	`}`
`486`	`486`
`487`	`487`	`adaptationSetElement.appendChild(representationElement);`