NewPipe-app-android/app/src/main/java/org/schabi/newpipe/player/resolver/VideoPlaybackResolver.java

package org.schabi.newpipe.player.resolver;

import android.content.Context;
import android.net.Uri;
import android.util.Log;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.google.android.exoplayer2.C;
import com.google.android.exoplayer2.MediaItem;
import com.google.android.exoplayer2.source.MediaSource;
import com.google.android.exoplayer2.source.MergingMediaSource;

import org.schabi.newpipe.extractor.MediaFormat;
import org.schabi.newpipe.extractor.stream.AudioStream;
import org.schabi.newpipe.extractor.stream.StreamInfo;
import org.schabi.newpipe.extractor.stream.SubtitlesStream;
import org.schabi.newpipe.extractor.stream.VideoStream;
import org.schabi.newpipe.player.helper.PlayerDataSource;
import org.schabi.newpipe.player.helper.PlayerHelper;
import org.schabi.newpipe.player.mediaitem.MediaItemTag;
import org.schabi.newpipe.player.mediaitem.StreamInfoTag;
import org.schabi.newpipe.util.ListHelper;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

import static com.google.android.exoplayer2.C.TIME_UNSET;
import static org.schabi.newpipe.util.ListHelper.getFilteredAudioStreams;
import static org.schabi.newpipe.util.ListHelper.getUrlAndNonTorrentStreams;
import static org.schabi.newpipe.util.ListHelper.getPlayableStreams;

public class VideoPlaybackResolver implements PlaybackResolver {
    private static final String TAG = VideoPlaybackResolver.class.getSimpleName();

    @NonNull
    private final Context context;
    @NonNull
    private final PlayerDataSource dataSource;
    private SourceType streamSourceType;

    @Nullable
    private String playbackQuality;
    @Nullable
    private String audioTrack;

    public enum SourceType {
        LIVE_STREAM,
        VIDEO_WITH_SEPARATED_AUDIO,
        VIDEO_WITH_AUDIO_OR_AUDIO_ONLY
    }

    /**
     * Depending on the player we select different video streams.
     */
    public enum SelectedPlayer {
        MAIN,
        POPUP
    }

    public VideoPlaybackResolver(@NonNull final Context context,
                                 @NonNull final PlayerDataSource dataSource) {
        this.context = context;
        this.dataSource = dataSource;
    }

    @Nullable
    public MediaSource resolve(@NonNull final StreamInfo info,
                               @NonNull final SelectedPlayer selectedPlayer) {
        final MediaSource liveSource = PlaybackResolver.maybeBuildLiveMediaSource(dataSource, info);
        if (liveSource != null) {
            streamSourceType = SourceType.LIVE_STREAM;
            return liveSource;
        }

        // Create video stream source
        final List<VideoStream> videoStreamsList = ListHelper.getSortedStreamVideosList(context,
                getPlayableStreams(info.getVideoStreams(), info.getServiceId()),
                getPlayableStreams(info.getVideoOnlyStreams(), info.getServiceId()), false, true);
        final List<AudioStream> audioStreamsList =
                getFilteredAudioStreams(
                        context,
                        // TODO: getAudioStreams should be @NonNull
                        Objects.requireNonNullElse(info.getAudioStreams(), Collections.emptyList())
                );

        int videoIndex = -999;
        if (playbackQuality == null) {
            switch (selectedPlayer) {
                case MAIN -> {
                    videoIndex = ListHelper.getDefaultResolutionIndex(
                            context,
                            videoStreamsList
                    );
                }
                case POPUP -> {
                    videoIndex = ListHelper.getPopupDefaultResolutionIndex(
                            context,
                            videoStreamsList
                    );
                }
            }
        } else {
            videoIndex = ListHelper.getDefaultResolutionWithDefaultFormat(
                    context,
                    getPlaybackQuality(),
                    videoStreamsList
            );
        }

        final int audioIndex =
                ListHelper.getAudioFormatIndex(context, audioStreamsList, audioTrack);

        @Nullable MediaItemTag.Quality video = null;
        @Nullable MediaItemTag.AudioTrack audio = null;

        if (videoIndex != -1) {
            video = new MediaItemTag.Quality(videoStreamsList, videoIndex);
        }
        if (audioIndex != -1) {
            audio = new MediaItemTag.AudioTrack(audioStreamsList, audioIndex);
        }
        final MediaItemTag tag = new StreamInfoTag(info, video, audio, null);

        final List<MediaSource> mediaSources = new ArrayList<>();
        if (video != null) {
            try {
                final VideoStream stream = video.getSelectedVideoStream();
                final MediaSource streamSource = PlaybackResolver.buildMediaSource(
                        dataSource, stream, info, PlaybackResolver.cacheKeyOf(info, stream), tag);
                mediaSources.add(streamSource);
            } catch (final ResolverException e) {
                Log.e(TAG, "Unable to create video source", e);
                return null;
            }
        }

        // Use the audio stream if there is no video stream, or
        // merge with audio stream in case if video does not contain audio
        if (audio != null
                && (video == null
                    || video.getSelectedVideoStream().isVideoOnly()
                    || audioTrack != null)) {
            try {
                final AudioStream stream = audio.getSelectedAudioStream();
                final MediaSource audioSource = PlaybackResolver.buildMediaSource(
                        dataSource, stream, info, PlaybackResolver.cacheKeyOf(info, stream), tag);
                mediaSources.add(audioSource);
                streamSourceType = SourceType.VIDEO_WITH_SEPARATED_AUDIO;
            } catch (final ResolverException e) {
                Log.e(TAG, "Unable to create audio source", e);
                return null;
            }
        } else {
            streamSourceType = SourceType.VIDEO_WITH_AUDIO_OR_AUDIO_ONLY;
        }

        // If there is no audio or video sources, then this media source cannot be played back
        if (mediaSources.isEmpty()) {
            return null;
        }

        // Below are auxiliary media sources

        // Create subtitle sources
        final List<SubtitlesStream> subtitlesStreams = info.getSubtitles();
        if (subtitlesStreams != null) {
            // Torrent and non URL subtitles are not supported by ExoPlayer
            final List<SubtitlesStream> nonTorrentAndUrlStreams = getUrlAndNonTorrentStreams(
                    subtitlesStreams);
            for (final SubtitlesStream subtitle : nonTorrentAndUrlStreams) {
                final MediaFormat mediaFormat = subtitle.getFormat();
                if (mediaFormat != null) {
                    @C.RoleFlags final int textRoleFlag = subtitle.isAutoGenerated()
                            ? C.ROLE_FLAG_DESCRIBES_MUSIC_AND_SOUND
                            : C.ROLE_FLAG_CAPTION;
                    final MediaItem.SubtitleConfiguration textMediaItem =
                            new MediaItem.SubtitleConfiguration.Builder(
                                    Uri.parse(subtitle.getContent()))
                                    .setMimeType(mediaFormat.getMimeType())
                                    .setRoleFlags(textRoleFlag)
                                    .setLanguage(PlayerHelper.captionLanguageOf(context, subtitle))
                                    .build();
                    final MediaSource textSource = dataSource.getSingleSampleMediaSourceFactory()
                            .createMediaSource(textMediaItem, TIME_UNSET);
                    mediaSources.add(textSource);
                }
            }
        }

        if (mediaSources.size() == 1) {
            return mediaSources.get(0);
        } else {
            return new MergingMediaSource(true, mediaSources.toArray(new MediaSource[0]));
        }
    }

    /**
     * Returns the last resolved {@link StreamInfo}'s {@link SourceType source type}.
     *
     * @return {@link Optional#empty()} if nothing was resolved, otherwise the {@link SourceType}
     * of the last resolved {@link StreamInfo} inside an {@link Optional}
     */
    public Optional<SourceType> getStreamSourceType() {
        return Optional.ofNullable(streamSourceType);
    }

    @Nullable
    public String getPlaybackQuality() {
        return playbackQuality;
    }

    public void setPlaybackQuality(@Nullable final String playbackQuality) {
        this.playbackQuality = playbackQuality;
    }

    /** Set audio track to be used the next time {@link #resolve(StreamInfo, SelectedPlayer)}
     * is called.
     *
     * @param audioTrack the {@link AudioStream} audioTrackId that should be selected on resolve
     */
    public void setAudioTrack(@Nullable final String audioTrack) {
        this.audioTrack = audioTrack;
    }
}