Feature/live chat comments

extractor/src/main/java/org/schabi/newpipe/extractor/InfoItem.java

@@ -76,6 +76,7 @@ public enum InfoType {
         STREAM,
         PLAYLIST,
         CHANNEL,
-        COMMENT
+        COMMENT,
+        BULLET_COMMENT
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/StreamingService.java

@@ -2,6 +2,7 @@
 
 import org.schabi.newpipe.extractor.channel.ChannelExtractor;
 import org.schabi.newpipe.extractor.channel.tabs.ChannelTabExtractor;
+import org.schabi.newpipe.extractor.bulletComments.BulletCommentsExtractor;
 import org.schabi.newpipe.extractor.comments.CommentsExtractor;
 import org.schabi.newpipe.extractor.exceptions.ExtractionException;
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
@@ -76,7 +77,7 @@
         }
 
         public enum MediaCapability {
-            AUDIO, VIDEO, LIVE, COMMENTS
+            AUDIO, VIDEO, LIVE, COMMENTS, BULLET_COMMENTS
         }
     }
 
@@ -163,6 +164,9 @@
      */
     public abstract SearchQueryHandlerFactory getSearchQHFactory();
     public abstract ListLinkHandlerFactory getCommentsLHFactory();
+    public ListLinkHandlerFactory getBulletCommentsLHFactory() {
+        return null;
+    }
 
     /*//////////////////////////////////////////////////////////////////////////
     // Extractors
@@ -241,6 +245,10 @@
 
     public abstract CommentsExtractor getCommentsExtractor(ListLinkHandler linkHandler)
             throws ExtractionException;
+    public BulletCommentsExtractor getBulletCommentsExtractor(
+            final ListLinkHandler linkHandler) throws ExtractionException {
+        return null;
+    }
 
     /*//////////////////////////////////////////////////////////////////////////
     // Extractors without link handler
@@ -303,6 +311,15 @@
         return getStreamExtractor(getStreamLHFactory().fromUrl(url));
     }
 
+    public BulletCommentsExtractor getBulletCommentsExtractor(final String url)
+            throws ExtractionException {
+        final ListLinkHandlerFactory listLinkHandlerFactory = getBulletCommentsLHFactory();
+        if (listLinkHandlerFactory == null) {
+            return null;
+        }
+        return getBulletCommentsExtractor(listLinkHandlerFactory.fromUrl(url));
+    }
+
     public CommentsExtractor getCommentsExtractor(final String url) throws ExtractionException {
         final ListLinkHandlerFactory listLinkHandlerFactory = getCommentsLHFactory();
         if (listLinkHandlerFactory == null) {

extractor/src/main/java/org/schabi/newpipe/extractor/bulletComments/BulletCommentsExtractor.java

@@ -0,0 +1,58 @@
+package org.schabi.newpipe.extractor.bulletComments;
+
+import javax.annotation.Nonnull;
+
+import org.schabi.newpipe.extractor.ListExtractor;
+import org.schabi.newpipe.extractor.Page;
+import org.schabi.newpipe.extractor.StreamingService;
+import org.schabi.newpipe.extractor.exceptions.ExtractionException;
+import org.schabi.newpipe.extractor.exceptions.ParsingException;
+import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
+
+import java.io.IOException;
+import java.util.List;
+
+public abstract class BulletCommentsExtractor extends ListExtractor<BulletCommentsInfoItem> {
+    public BulletCommentsExtractor(final StreamingService service,
+                                   final ListLinkHandler uiHandler) {
+        super(service, uiHandler);
+    }
+
+    @Nonnull
+    @Override
+    public String getName() throws ParsingException {
+        return "BulletComments";
+    }
+
+    @Override
+    public InfoItemsPage<BulletCommentsInfoItem> getPage(final Page page)
+            throws IOException, ExtractionException {
+        return null;
+    }
+
+    public List<BulletCommentsInfoItem> getLiveMessages() throws ParsingException {
+        return null;
+    }
+
+    public boolean isLive() {
+        return false;
+    }
+
+    public boolean isDisabled() {
+        return false;
+    }
+
+    public void disconnect() {
+
+    }
+
+    public void reconnect() {
+
+    }
+
+    public void setCurrentPlayPosition(final long currentPlayPosition) {
+    }
+
+    public void clearMappingState() {
+    }
+}

extractor/src/main/java/org/schabi/newpipe/extractor/bulletComments/BulletCommentsInfo.java

@@ -0,0 +1,91 @@
+package org.schabi.newpipe.extractor.bulletComments;
+
+import java.io.IOException;
+
+import org.schabi.newpipe.extractor.ListInfo;
+import org.schabi.newpipe.extractor.utils.ExtractorLogger;
+import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
+import org.schabi.newpipe.extractor.ListExtractor.InfoItemsPage;
+import org.schabi.newpipe.extractor.NewPipe;
+import org.schabi.newpipe.extractor.Page;
+import org.schabi.newpipe.extractor.StreamingService;
+import org.schabi.newpipe.extractor.exceptions.ExtractionException;
+import org.schabi.newpipe.extractor.utils.ExtractorHelper;
+
+public final class BulletCommentsInfo extends ListInfo<BulletCommentsInfoItem> {
+    private BulletCommentsInfo(
+            final int serviceId,
+            final ListLinkHandler listUrlIdHandler,
+            final String name) {
+        super(serviceId, listUrlIdHandler, name);
+    }
+
+    public static BulletCommentsInfo getInfo(final String url)
+            throws IOException, ExtractionException {
+        return getInfo(NewPipe.getServiceByUrl(url), url);
+    }
+
+    public static BulletCommentsInfo getInfo(final StreamingService service, final String url)
+            throws ExtractionException, IOException {
+        return getInfo(service.getBulletCommentsExtractor(url));
+    }
+
+    public static BulletCommentsInfo getInfo(final BulletCommentsExtractor commentsExtractor)
+            throws IOException, ExtractionException {
+        // for services which do not have a comments extractor
+        if (commentsExtractor == null) {
+            ExtractorLogger.d("BulletCommentsInfo", "getInfo() extractor is null");
+            return null;
+        }
+
+        ExtractorLogger.d("BulletCommentsInfo", "getInfo() fetching page for "
+                + commentsExtractor.getUrl());
+        commentsExtractor.fetchPage();
+
+        final String name = commentsExtractor.getName();
+        final int serviceId = commentsExtractor.getServiceId();
+        final ListLinkHandler listUrlIdHandler = commentsExtractor.getLinkHandler();
+
+        final BulletCommentsInfo commentsInfo = new BulletCommentsInfo(
+                serviceId, listUrlIdHandler, name);
+        commentsInfo.setBulletCommentsExtractor(commentsExtractor);
+        final InfoItemsPage<BulletCommentsInfoItem> initialCommentsPage = ExtractorHelper
+                .getItemsPageOrLogError(commentsInfo, commentsExtractor);
+        commentsInfo.setRelatedItems(initialCommentsPage.getItems());
+        commentsInfo.setNextPage(initialCommentsPage.getNextPage());
+
+        return commentsInfo;
+    }
+
+    public static InfoItemsPage<BulletCommentsInfoItem> getMoreItems(
+            final BulletCommentsInfo commentsInfo,
+            final Page page) throws ExtractionException, IOException {
+        return getMoreItems(NewPipe.getService(commentsInfo.getServiceId()), commentsInfo.getUrl(),
+                page);
+    }
+
+    public static InfoItemsPage<BulletCommentsInfoItem> getMoreItems(
+            final StreamingService service,
+            final BulletCommentsInfo commentsInfo,
+            final Page page) throws IOException, ExtractionException {
+        return getMoreItems(service, commentsInfo.getUrl(), page);
+    }
+
+    public static InfoItemsPage<BulletCommentsInfoItem> getMoreItems(
+            final StreamingService service,
+            final String url,
+            final Page page) throws IOException, ExtractionException {
+        return service.getBulletCommentsExtractor(url).getPage(page);
+    }
+
+    private transient BulletCommentsExtractor commentsExtractor;
+
+    public BulletCommentsExtractor getBulletCommentsExtractor() {
+        return commentsExtractor;
+    }
+
+    public void setBulletCommentsExtractor(
+            final BulletCommentsExtractor bulletCommentsExtractor) {
+        this.commentsExtractor = bulletCommentsExtractor;
+    }
+}

extractor/src/main/java/org/schabi/newpipe/extractor/bulletComments/BulletCommentsInfoItem.java

@@ -0,0 +1,90 @@
+package org.schabi.newpipe.extractor.bulletComments;
+
+import java.time.Duration;
+
+import org.schabi.newpipe.extractor.InfoItem;
+
+import javax.annotation.Nonnull;
+
+public class BulletCommentsInfoItem extends InfoItem implements Comparable<BulletCommentsInfoItem> {
+    @Override
+    public int compareTo(@Nonnull final BulletCommentsInfoItem bulletCommentsInfoItem) {
+        return this.duration.compareTo(bulletCommentsInfoItem.duration);
+    }
+
+    public enum Position {
+        REGULAR,
+        BOTTOM,
+        TOP,
+        SUPERCHAT
+    }
+
+    private String commentText;
+    private int argbColor;
+    private Position position;
+    private double relativeFontSize;
+    /* It really should be named as timePosition or some other thing*/
+    private Duration duration;
+    private int lastingTime;
+    private boolean isLive;
+
+    public BulletCommentsInfoItem(final int serviceId, final String url, final String name) {
+        super(InfoType.COMMENT, serviceId, url, name);
+    }
+
+    public String getCommentText() {
+        return commentText;
+    }
+
+    public void setCommentText(final String commentText) {
+        this.commentText = commentText;
+    }
+
+    public int getArgbColor() {
+        return argbColor;
+    }
+
+    public void setArgbColor(final int argbColor) {
+        this.argbColor = argbColor;
+    }
+
+    public Position getPosition() {
+        return position;
+    }
+
+    public void setPosition(final Position position) {
+        this.position = position;
+    }
+
+    public double getRelativeFontSize() {
+        return relativeFontSize;
+    }
+
+    public void setRelativeFontSize(final double relativeFontSize) {
+        this.relativeFontSize = relativeFontSize;
+    }
+
+    public Duration getDuration() {
+        return duration;
+    }
+
+    public void setDuration(final Duration duration) {
+        this.duration = duration;
+    }
+
+    public int getLastingTime() {
+        return -1;
+    }
+
+    public void setLastingTime(final int lastingTime) {
+        this.lastingTime = lastingTime;
+    }
+
+    public boolean isLive() {
+        return isLive;
+    }
+
+    public void setLive(final boolean live) {
+        isLive = live;
+    }
+}

extractor/src/main/java/org/schabi/newpipe/extractor/bulletComments/BulletCommentsInfoItemExtractor.java

@@ -0,0 +1,57 @@
+package org.schabi.newpipe.extractor.bulletComments;
+
+import org.schabi.newpipe.extractor.InfoItemExtractor;
+import org.schabi.newpipe.extractor.exceptions.ParsingException;
+
+import java.time.Duration;
+import java.util.Collections;
+import java.util.List;
+
+public interface BulletCommentsInfoItemExtractor extends InfoItemExtractor {
+    @Override
+    default String getName() throws ParsingException {
+        return null;
+    }
+
+    @Override
+    default List<org.schabi.newpipe.extractor.Image> getThumbnails() throws ParsingException {
+        return Collections.emptyList();
+    }
+
+    @Override
+    default String getUrl() throws ParsingException {
+        return null;
+    }
+
+    default String getCommentText() throws ParsingException {
+        return "";
+    }
+
+    /**
+     * Returns ARGB32 int. White: 0xFFFFFFFF.
+     * @return ARGB32 int. White: 0xFFFFFFFF.
+     */
+    default int getArgbColor() throws ParsingException {
+        return 0xFFFFFFFF;
+    }
+
+    default BulletCommentsInfoItem.Position getPosition() throws ParsingException {
+        return BulletCommentsInfoItem.Position.REGULAR;
+    }
+
+    default double getRelativeFontSize() throws ParsingException {
+        return 0.7;
+    }
+
+    default int getLastingTime() {
+        return -1;
+    }
+
+    default boolean isLive() throws ParsingException {
+        return false;
+    }
+
+    // Must be implemented. If that is a live stream you should at least
+    // calculate the time from the start of the stream.
+    Duration getDuration() throws ParsingException;
+}