Allow checking for ContentAvailability

Adds a new field to `StreamInfoItem` to denote the availability of the
stream. A stream may be restricted to only certain user groups or times.

This allows users to ignore the stream based on their availability, e.g.
a app may choose to hide all streams that require payment.

Author: FineFindus

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamInfoItemExtractor.java

@@ -35,6 +35,7 @@
 import org.schabi.newpipe.extractor.services.youtube.linkHandler.YoutubeStreamLinkHandlerFactory;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemExtractor;
 import org.schabi.newpipe.extractor.stream.StreamType;
+import org.schabi.newpipe.extractor.stream.StreamInfoItem.ContentAvailability;
 import org.schabi.newpipe.extractor.utils.JsonUtils;
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Utils;
@@ -471,9 +472,7 @@ public boolean isShortFormContent() throws ParsingException {
         }
     }
 
-    @Nonnull
-    @Override
-    public boolean requiresMembership() throws ParsingException {
+    private boolean isMembersOnly() throws ParsingException {
         final JsonArray badges = videoInfo.getArray("badges");
         for (final Object badge : badges) {
             if (((JsonObject) badge).getObject("metadataBadgeRenderer")
@@ -484,4 +483,23 @@ public boolean requiresMembership() throws ParsingException {
         return false;
     }
 
+
+    @Nonnull
+    @Override
+    public ContentAvailability getContentAvailability() throws ParsingException {
+        if (isPremiere()) {
+            return ContentAvailability.UPCOMING;
+        }
+
+        if (isMembersOnly()) {
+            return ContentAvailability.MEMBERSHIP;
+        }
+
+        if (isPremium()) {
+            return ContentAvailability.PAID;
+        }
+
+        return ContentAvailability.AVAILABLE;
+    }
+
 }

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java

@@ -33,6 +33,7 @@
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.LinkHandler;
 import org.schabi.newpipe.extractor.localization.DateWrapper;
+import org.schabi.newpipe.extractor.stream.StreamInfoItem.ContentAvailability;
 import org.schabi.newpipe.extractor.utils.Parser;
 
 import javax.annotation.Nonnull;
@@ -582,13 +583,13 @@ public boolean isShortFormContent() throws ParsingException {
     }
 
     /**
-     * Whether the stream is only available to channel members.
+     * Get the availability of the stream.
      *
-     * @return whether the stream is only available to channel members.
+     * @return The stream's availability
      * @throws ParsingException if there is an error in the extraction
      */
-    public boolean requiresMembership() throws ParsingException {
-        return false;
+    public ContentAvailability getContentAvailability() throws ParsingException {
+        return ContentAvailability.AVAILABLE;
     }
 
     public enum Privacy {

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java

@@ -26,6 +26,7 @@
 import org.schabi.newpipe.extractor.MetaInfo;
 import org.schabi.newpipe.extractor.NewPipe;
 import org.schabi.newpipe.extractor.StreamingService;
+import org.schabi.newpipe.extractor.stream.StreamInfoItem.ContentAvailability;
 import org.schabi.newpipe.extractor.exceptions.ContentNotAvailableException;
 import org.schabi.newpipe.extractor.exceptions.ContentNotSupportedException;
 import org.schabi.newpipe.extractor.exceptions.ExtractionException;
@@ -331,7 +332,7 @@ private static void extractOptionalData(final StreamInfo streamInfo,
             streamInfo.addError(e);
         }
         try {
-            streamInfo.setRequiresMembership(extractor.requiresMembership());
+            streamInfo.setContentAvailability(extractor.getContentAvailability());
         } catch (final Exception e) {
             streamInfo.addError(e);
         }
@@ -386,7 +387,7 @@ private static void extractOptionalData(final StreamInfo streamInfo,
     private List<StreamSegment> streamSegments = List.of();
     private List<MetaInfo> metaInfo = List.of();
     private boolean shortFormContent = false;
-    private boolean membersOnly = false;
+    private ContentAvailability contentAvailability = ContentAvailability.AVAILABLE;
 
     /**
      * Preview frames, e.g. for the storyboard / seekbar thumbnail preview
@@ -734,11 +735,11 @@ public void setShortFormContent(final boolean isShortFormContent) {
         this.shortFormContent = isShortFormContent;
     }
 
-    public boolean requiresMembership() {
-        return membersOnly;
+    public ContentAvailability getContentAvailability() {
+        return contentAvailability;
     }
 
-    public void setRequiresMembership(final boolean requiresMembership) {
-        this.membersOnly = requiresMembership;
+    public void setContentAvailability(final ContentAvailability availablility) {
+        this.contentAvailability = availablility;
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfoItem.java

@@ -47,7 +47,7 @@ public class StreamInfoItem extends InfoItem {
     private List<Image> uploaderAvatars = List.of();
     private boolean uploaderVerified = false;
     private boolean shortFormContent = false;
-    private boolean requiresMembership = false;
+    private ContentAvailability contentAvailability = ContentAvailability.AVAILABLE;
 
     public StreamInfoItem(final int serviceId,
                           final String url,
@@ -145,19 +145,19 @@ public void setShortFormContent(final boolean shortFormContent) {
     }
 
     /**
-     * Whether the stream is only available to channel members.
+     * Gets the availablility of the content.
      *
-     * @return whether the stream is only available to channel members.
+     * @return The availablility of the stream.
      */
-    public boolean requiresMembership() {
-        return requiresMembership;
+    public ContentAvailability getContentAvailability() {
+        return contentAvailability;
     }
 
     /**
-     * Sets whether the stream is only available to channel members.
+     * Sets the availablility of the Stream.
      */
-    public void setRequiresMembership(final boolean requiresMembership) {
-        this.requiresMembership = requiresMembership;
+    public void setContentAvailability(final ContentAvailability availablility) {
+        this.contentAvailability = availablility;
     }
 
     @Override
@@ -177,4 +177,29 @@ public String toString() {
                 + ", uploaderVerified='" + isUploaderVerified() + '\''
                 + '}';
     }
+
+    /**
+     *  Availablility of the stream.
+     *
+     *  A stream may be available to all, restricted to a certain user group
+     *  or time.
+     */
+    public enum ContentAvailability {
+        /**
+         *  The stream is available to all users.
+         */
+        AVAILABLE,
+        /**
+         *  The stream is available to users whith a membership.
+         */
+        MEMBERSHIP,
+        /**
+         *  The stream is behind a paywall.
+         */
+        PAID,
+        /**
+         *  The stream is only available in the future.
+         */
+        UPCOMING,
+    }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfoItemExtractor.java

@@ -24,6 +24,7 @@
 import org.schabi.newpipe.extractor.InfoItemExtractor;
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.localization.DateWrapper;
+import org.schabi.newpipe.extractor.stream.StreamInfoItem.ContentAvailability;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -149,12 +150,12 @@ default boolean isShortFormContent() throws ParsingException {
     }
 
     /**
-     * Whether the stream is only available to channel members.
+     * Get the availability of the stream.
      *
-     * @return whether the stream is only available to channel members.
+     * @return The stream's availability
      * @throws ParsingException if there is an error in the extraction
      */
-    default boolean requiresMembership() throws ParsingException {
-        return false;
+    default ContentAvailability getContentAvailability() throws ParsingException {
+        return ContentAvailability.AVAILABLE;
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfoItemsCollector.java

@@ -104,7 +104,7 @@ public StreamInfoItem extract(final StreamInfoItemExtractor extractor) throws Pa
             addError(e);
         }
         try {
-            resultItem.setRequiresMembership(extractor.requiresMembership());
+            resultItem.setContentAvailability(extractor.getContentAvailability());
         } catch (final Exception e) {
             addError(e);
         }

extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/YoutubePlaylistExtractorTest.java

@@ -25,6 +25,7 @@
 import org.schabi.newpipe.extractor.services.youtube.extractors.YoutubePlaylistExtractor;
 import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
+import org.schabi.newpipe.extractor.stream.StreamInfoItem.ContentAvailability;
 import org.schabi.newpipe.extractor.utils.Utils;
 
 import java.io.IOException;
@@ -522,7 +523,7 @@ void testOnlyMembersOnlyVideos() throws Exception {
                     .map(StreamInfoItem.class::cast)
                     .collect(Collectors.toUnmodifiableList());
             final List<StreamInfoItem> membershipVideos = allItems.stream()
-                    .filter(item -> !item.requiresMembership())
+                    .filter(item -> item.getContentAvailability() != ContentAvailability.MEMBERSHIP)
                     .collect(Collectors.toUnmodifiableList());
 
             assertFalse(allItems.isEmpty());