278 lines
11 KiB
Java
278 lines
11 KiB
Java
package org.schabi.newpipe.extractor.stream;
|
|
|
|
import org.schabi.newpipe.extractor.Info;
|
|
import org.schabi.newpipe.extractor.InfoItem;
|
|
import org.schabi.newpipe.extractor.exceptions.ContentNotAvailableException;
|
|
import org.schabi.newpipe.extractor.exceptions.ExtractionException;
|
|
import org.schabi.newpipe.extractor.utils.DashMpdParser;
|
|
|
|
import java.util.List;
|
|
import java.util.Vector;
|
|
|
|
/*
|
|
* Created by Christian Schabesberger on 26.08.15.
|
|
*
|
|
* Copyright (C) Christian Schabesberger 2016 <chris.schabesberger@mailbox.org>
|
|
* StreamInfo.java is part of NewPipe.
|
|
*
|
|
* NewPipe is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* NewPipe is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with NewPipe. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* Info object for opened videos, ie the video ready to play.
|
|
*/
|
|
@SuppressWarnings("WeakerAccess")
|
|
public class StreamInfo extends Info {
|
|
|
|
public static class StreamExtractException extends ExtractionException {
|
|
StreamExtractException(String message) {
|
|
super(message);
|
|
}
|
|
}
|
|
|
|
public StreamInfo() {
|
|
}
|
|
|
|
/**
|
|
* Fills out the video info fields which are common to all services.
|
|
* Probably needs to be overridden by subclasses
|
|
*/
|
|
public static StreamInfo getVideoInfo(StreamExtractor extractor) throws ExtractionException {
|
|
StreamInfo streamInfo = new StreamInfo();
|
|
|
|
try {
|
|
streamInfo = extractImportantData(streamInfo, extractor);
|
|
streamInfo = extractStreams(streamInfo, extractor);
|
|
streamInfo = extractOptionalData(streamInfo, extractor);
|
|
} catch (ExtractionException e) {
|
|
// Currently YouTube does not distinguish between age restricted videos and videos blocked
|
|
// by country. This means that during the initialisation of the extractor, the extractor
|
|
// will assume that a video is age restricted while in reality it it blocked by country.
|
|
//
|
|
// We will now detect whether the video is blocked by country or not.
|
|
String errorMsg = extractor.getErrorMessage();
|
|
|
|
if (errorMsg != null) {
|
|
throw new ContentNotAvailableException(errorMsg);
|
|
} else {
|
|
throw e;
|
|
}
|
|
}
|
|
|
|
return streamInfo;
|
|
}
|
|
|
|
private static StreamInfo extractImportantData(StreamInfo streamInfo, StreamExtractor extractor) throws ExtractionException {
|
|
/* ---- important data, withoug the video can't be displayed goes here: ---- */
|
|
// if one of these is not available an exception is meant to be thrown directly into the frontend.
|
|
|
|
streamInfo.service_id = extractor.getServiceId();
|
|
streamInfo.url = extractor.getUrl();
|
|
streamInfo.stream_type = extractor.getStreamType();
|
|
streamInfo.id = extractor.getId();
|
|
streamInfo.name = extractor.getTitle();
|
|
streamInfo.age_limit = extractor.getAgeLimit();
|
|
|
|
if ((streamInfo.stream_type == StreamType.NONE)
|
|
|| (streamInfo.url == null || streamInfo.url.isEmpty())
|
|
|| (streamInfo.id == null || streamInfo.id.isEmpty())
|
|
|| (streamInfo.name == null /* streamInfo.title can be empty of course */)
|
|
|| (streamInfo.age_limit == -1)) {
|
|
throw new ExtractionException("Some important stream information was not given.");
|
|
}
|
|
|
|
return streamInfo;
|
|
}
|
|
|
|
private static StreamInfo extractStreams(StreamInfo streamInfo, StreamExtractor extractor) throws ExtractionException {
|
|
/* ---- stream extraction goes here ---- */
|
|
// At least one type of stream has to be available,
|
|
// otherwise an exception will be thrown directly into the frontend.
|
|
|
|
try {
|
|
streamInfo.dashMpdUrl = extractor.getDashMpdUrl();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(new ExtractionException("Couldn't get Dash manifest", e));
|
|
}
|
|
|
|
/* Load and extract audio */
|
|
try {
|
|
streamInfo.audio_streams = extractor.getAudioStreams();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(new ExtractionException("Couldn't get audio streams", e));
|
|
}
|
|
/* Extract video stream url*/
|
|
try {
|
|
streamInfo.video_streams = extractor.getVideoStreams();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(new ExtractionException("Couldn't get video streams", e));
|
|
}
|
|
/* Extract video only stream url*/
|
|
try {
|
|
streamInfo.video_only_streams = extractor.getVideoOnlyStreams();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(new ExtractionException("Couldn't get video only streams", e));
|
|
}
|
|
|
|
// Lists can be null if a exception was thrown during extraction
|
|
if (streamInfo.video_streams == null) streamInfo.video_streams = new Vector<>();
|
|
if (streamInfo.video_only_streams == null) streamInfo.video_only_streams = new Vector<>();
|
|
if (streamInfo.audio_streams == null) streamInfo.audio_streams = new Vector<>();
|
|
|
|
if (streamInfo.dashMpdUrl != null && !streamInfo.dashMpdUrl.isEmpty()) {
|
|
try {
|
|
// Will try to find in the dash manifest for any stream that the ItagItem has (by the id),
|
|
// it has video, video only and audio streams and will only add to the list if it don't
|
|
// find a similar stream in the respective lists (calling Stream#equalStats).
|
|
DashMpdParser.getStreams(streamInfo);
|
|
} catch (Exception e) {
|
|
streamInfo.addException(new ExtractionException("Couldn't get streams from dash mpd", e));
|
|
}
|
|
}
|
|
|
|
// either dash_mpd audio_only or video has to be available, otherwise we didn't get a stream,
|
|
// and therefore failed. (Since video_only_streams are just optional they don't caunt).
|
|
if ((streamInfo.video_streams == null || streamInfo.video_streams.isEmpty())
|
|
&& (streamInfo.audio_streams == null || streamInfo.audio_streams.isEmpty())
|
|
&& (streamInfo.dashMpdUrl == null || streamInfo.dashMpdUrl.isEmpty())) {
|
|
throw new StreamExtractException(
|
|
"Could not get any stream. See error variable to get further details.");
|
|
}
|
|
|
|
return streamInfo;
|
|
}
|
|
|
|
private static StreamInfo extractOptionalData(StreamInfo streamInfo, StreamExtractor extractor) {
|
|
/* ---- optional data goes here: ---- */
|
|
// If one of these fails, the frontend needs to handle that they are not available.
|
|
// Exceptions are therefore not thrown into the frontend, but stored into the error List,
|
|
// so the frontend can afterwards check where errors happened.
|
|
|
|
try {
|
|
streamInfo.thumbnail_url = extractor.getThumbnailUrl();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.duration = extractor.getLength();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.uploader = extractor.getUploader();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.channel_url = extractor.getChannelUrl();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.description = extractor.getDescription();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.view_count = extractor.getViewCount();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.upload_date = extractor.getUploadDate();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.uploader_thumbnail_url = extractor.getUploaderThumbnailUrl();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.start_position = extractor.getTimeStamp();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.average_rating = extractor.getAverageRating();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.like_count = extractor.getLikeCount();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
streamInfo.dislike_count = extractor.getDislikeCount();
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
StreamInfoItemCollector c = new StreamInfoItemCollector(extractor.getServiceId());
|
|
StreamInfoItemExtractor nextVideo = extractor.getNextVideo();
|
|
c.commit(nextVideo);
|
|
if (c.getItemList().size() != 0) {
|
|
streamInfo.next_video = (StreamInfoItem) c.getItemList().get(0);
|
|
}
|
|
streamInfo.errors.addAll(c.getErrors());
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
try {
|
|
// get related videos
|
|
StreamInfoItemCollector c = extractor.getRelatedVideos();
|
|
streamInfo.related_streams = c.getItemList();
|
|
streamInfo.errors.addAll(c.getErrors());
|
|
} catch (Exception e) {
|
|
streamInfo.addException(e);
|
|
}
|
|
|
|
return streamInfo;
|
|
}
|
|
|
|
public void addException(Exception e) {
|
|
errors.add(e);
|
|
}
|
|
|
|
public StreamType stream_type;
|
|
public String uploader;
|
|
public String thumbnail_url;
|
|
public String upload_date;
|
|
public long view_count = -1;
|
|
|
|
public String uploader_thumbnail_url;
|
|
public String channel_url;
|
|
public String description;
|
|
|
|
public List<VideoStream> video_streams;
|
|
public List<AudioStream> audio_streams;
|
|
public List<VideoStream> video_only_streams;
|
|
// video streams provided by the dash mpd do not need to be provided as VideoStream.
|
|
// Later on this will also aplly to audio streams. Since dash mpd is standarized,
|
|
// crawling such a file is not service dependent. Therefore getting audio only streams by yust
|
|
// providing the dash mpd fille will be possible in the future.
|
|
public String dashMpdUrl;
|
|
public int duration = -1;
|
|
|
|
public int age_limit = -1;
|
|
public int like_count = -1;
|
|
public int dislike_count = -1;
|
|
public String average_rating;
|
|
public StreamInfoItem next_video;
|
|
public List<InfoItem> related_streams = new Vector<>();
|
|
//in seconds. some metadata is not passed using a StreamInfo object!
|
|
public int start_position = 0;
|
|
}
|