X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fassets%2Fplayer%2Fpeertube-videojs-plugin.ts;h=b62dcb8299ed2364f77072fb01a614d1450693df;hb=f5a2dc48eb80ab7842cec1da7269b5d153208689;hp=91a3993a34cbd1ecf6df1164fd2c354686f008ac;hpb=a8462c8e3a61f4f7314fe18c0c10cc2946c254d1;p=github%2FChocobozzz%2FPeerTube.git diff --git a/client/src/assets/player/peertube-videojs-plugin.ts b/client/src/assets/player/peertube-videojs-plugin.ts index 91a3993a3..b62dcb829 100644 --- a/client/src/assets/player/peertube-videojs-plugin.ts +++ b/client/src/assets/player/peertube-videojs-plugin.ts @@ -7,35 +7,22 @@ import { PeertubePluginOptions, VideoJSComponentInterface, videojsUntyped } from import { getAverageBandwidth, getStoredMute, - getStoredVolume, + getStoredVolume, isMobile, saveAverageBandwidth, saveMuteInStore, - saveVolumeInStore + saveVolumeInStore, + videoFileMaxByResolution, + videoFileMinByResolution } from './utils' -import minBy from 'lodash-es/minBy' -import maxBy from 'lodash-es/maxBy' - -const webtorrent = new WebTorrent({ - tracker: { - rtcConfig: { - iceServers: [ - { - urls: 'stun:stun.stunprotocol.org' - }, - { - urls: 'stun:stun.framasoft.org' - } - ] - } - }, - dht: false -}) +import * as CacheChunkStore from 'cache-chunk-store' +import { PeertubeChunkStore } from './peertube-chunk-store' -const Plugin: VideoJSComponentInterface = videojsUntyped.getPlugin('plugin') +const Plugin: VideoJSComponentInterface = videojs.getPlugin('plugin') class PeerTubePlugin extends Plugin { private readonly playerElement: HTMLVideoElement private readonly autoplay: boolean = false + private readonly startTime: number = 0 private readonly savePlayerSrcFunction: Function private readonly videoFiles: VideoFile[] private readonly videoViewUrl: string @@ -44,29 +31,51 @@ class PeerTubePlugin extends Plugin { INFO_SCHEDULER: 1000, // Don't change this AUTO_QUALITY_SCHEDULER: 3000, // Check quality every 3 seconds AUTO_QUALITY_THRESHOLD_PERCENT: 30, // Bandwidth should be 30% more important than a resolution bitrate to change to it - AUTO_QUALITY_OBSERVATION_TIME: 10000, // Wait 10 seconds before potentially changing the definition - AUTO_QUALITY_UPPER_RESOLUTION_DELAY: 5000, // Buffer upper resolution during 5 seconds + AUTO_QUALITY_OBSERVATION_TIME: 10000, // Wait 10 seconds after having change the resolution before another check + AUTO_QUALITY_HIGHER_RESOLUTION_DELAY: 5000, // Buffering higher resolution during 5 seconds BANDWIDTH_AVERAGE_NUMBER_OF_VALUES: 5 // Last 5 seconds to build average bandwidth } + private readonly webtorrent = new WebTorrent({ + tracker: { + rtcConfig: { + iceServers: [ + { + urls: 'stun:stun.stunprotocol.org' + }, + { + urls: 'stun:stun.framasoft.org' + } + ] + } + }, + dht: false + }) + private player: any private currentVideoFile: VideoFile private torrent: WebTorrent.Torrent + private renderer + private fakeRenderer + private autoResolution = true + private isAutoResolutionObservation = false + private videoViewInterval private torrentInfoInterval private autoQualityInterval - private autoResolution = true - private isAutoResolutionObservation = false + private addTorrentDelay + private qualityObservationTimer + private runAutoQualitySchedulerTimer private downloadSpeeds: number[] = [] constructor (player: videojs.Player, options: PeertubePluginOptions) { super(player, options) - // Fix canplay event on google chrome by disabling default videojs autoplay - this.autoplay = this.player.options_.autoplay - this.player.options_.autoplay = false + // Disable auto play on iOS + this.autoplay = options.autoplay && this.isIOS() === false + this.startTime = options.startTime this.videoFiles = options.videoFiles this.videoViewUrl = options.videoViewUrl this.videoDuration = options.videoDuration @@ -79,6 +88,8 @@ class PeerTubePlugin extends Plugin { this.playerElement = options.playerElement + if (this.autoplay === true) this.player.addClass('vjs-has-autoplay') + this.player.ready(() => { const volume = getStoredVolume() if (volume !== undefined) this.player.volume(volume) @@ -90,8 +101,10 @@ class PeerTubePlugin extends Plugin { this.runViewAdd() this.player.one('play', () => { - // Don't run immediately scheduler, wait some seconds the TCP connections are maid - setTimeout(() => this.runAutoQualityScheduler(), this.CONSTANTS.AUTO_QUALITY_SCHEDULER) + // Don't run immediately scheduler, wait some seconds the TCP connections are made + this.runAutoQualitySchedulerTimer = setTimeout(() => { + this.runAutoQualityScheduler() + }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER) }) }) @@ -102,12 +115,18 @@ class PeerTubePlugin extends Plugin { } dispose () { + clearTimeout(this.addTorrentDelay) + clearTimeout(this.qualityObservationTimer) + clearTimeout(this.runAutoQualitySchedulerTimer) + clearInterval(this.videoViewInterval) clearInterval(this.torrentInfoInterval) clearInterval(this.autoQualityInterval) // Don't need to destroy renderer, video player will be destroyed this.flushVideoFile(this.currentVideoFile, false) + + this.destroyFakeRenderer() } getCurrentResolutionId () { @@ -118,17 +137,21 @@ class PeerTubePlugin extends Plugin { return this.currentVideoFile ? this.currentVideoFile.resolution.label : '' } - updateVideoFile (videoFile?: VideoFile, delay = 0, done?: () => void) { - if (done === undefined) { - done = () => { /* empty */ } - } - + updateVideoFile ( + videoFile?: VideoFile, + options: { + forcePlay?: boolean, + seek?: number, + delay?: number + } = {}, + done: () => void = () => { /* empty */ } + ) { // Automatically choose the adapted video file if (videoFile === undefined) { const savedAverageBandwidth = getAverageBandwidth() videoFile = savedAverageBandwidth ? this.getAppropriateFile(savedAverageBandwidth) - : this.videoFiles[0] + : this.pickAverageVideoFile() } // Don't add the same video file once again @@ -145,7 +168,7 @@ class PeerTubePlugin extends Plugin { const previousVideoFile = this.currentVideoFile this.currentVideoFile = videoFile - this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, delay, () => { + this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, options, () => { this.player.playbackRate(oldPlaybackRate) return done() }) @@ -153,39 +176,70 @@ class PeerTubePlugin extends Plugin { this.trigger('videoFileUpdate') } - addTorrent (magnetOrTorrentUrl: string, previousVideoFile: VideoFile, delay = 0, done: Function) { + addTorrent ( + magnetOrTorrentUrl: string, + previousVideoFile: VideoFile, + options: { + forcePlay?: boolean, + seek?: number, + delay?: number + }, + done: Function + ) { console.log('Adding ' + magnetOrTorrentUrl + '.') const oldTorrent = this.torrent - this.torrent = webtorrent.add(magnetOrTorrentUrl, torrent => { + const torrentOptions = { + store: (chunkLength, storeOpts) => new CacheChunkStore(new PeertubeChunkStore(chunkLength, storeOpts), { + max: 100 + }) + } + + this.torrent = this.webtorrent.add(magnetOrTorrentUrl, torrentOptions, torrent => { console.log('Added ' + magnetOrTorrentUrl + '.') - // Pause the old torrent if (oldTorrent) { + // Pause the old torrent oldTorrent.pause() // Pause does not remove actual peers (in particular the webseed peer) oldTorrent.removePeer(oldTorrent['ws']) + + // We use a fake renderer so we download correct pieces of the next file + if (options.delay) { + const fakeVideoElem = document.createElement('video') + renderVideo(torrent.files[0], fakeVideoElem, { autoplay: false, controls: false }, (err, renderer) => { + this.fakeRenderer = renderer + + if (err) console.error('Cannot render new torrent in fake video element.', err) + + // Load the future file at the correct time + fakeVideoElem.currentTime = this.player.currentTime() + (options.delay / 2000) + }) + } } - setTimeout(() => { + // Render the video in a few seconds? (on resolution change for example, we wait some seconds of the new video resolution) + this.addTorrentDelay = setTimeout(() => { + this.destroyFakeRenderer() + + const paused = this.player.paused() + this.flushVideoFile(previousVideoFile) - const options = { autoplay: true, controls: true } - renderVideo(torrent.files[0], this.playerElement, options,(err, renderer) => { + const renderVideoOptions = { autoplay: false, controls: true } + renderVideo(torrent.files[0], this.playerElement, renderVideoOptions,(err, renderer) => { this.renderer = renderer if (err) return this.fallbackToHttp(done) - if (!this.player.paused()) { - const playPromise = this.player.play() - if (playPromise !== undefined) return playPromise.then(done) + return this.tryToPlay(err => { + if (err) return done(err) - return done() - } - - return done() + if (options.seek) this.seek(options.seek) + if (options.forcePlay === false && paused === true) this.player.pause() + }) }) - }, delay) + }, options.delay || 0) }) this.torrent.on('error', err => this.handleError(err)) @@ -203,7 +257,8 @@ class PeerTubePlugin extends Plugin { // Magnet hash is not up to date with the torrent file, add directly the torrent file if (err.message.indexOf('incorrect info hash') !== -1) { console.error('Incorrect info hash detected, falling back to torrent file.') - return this.addTorrent(this.torrent['xs'], previousVideoFile, 0, done) + const options = { forcePlay: true } + return this.addTorrent(this.torrent['xs'], previousVideoFile, options, done) } return this.handleError(err) @@ -224,17 +279,19 @@ class PeerTubePlugin extends Plugin { } const newVideoFile = this.videoFiles.find(f => f.resolution.id === resolutionId) - this.updateVideoFile(newVideoFile, delay, () => { - this.player.currentTime(currentTime) - this.player.handleTechSeeked_() - }) + const options = { + forcePlay: false, + delay, + seek: currentTime + (delay / 1000) + } + this.updateVideoFile(newVideoFile, options) } flushVideoFile (videoFile: VideoFile, destroyRenderer = true) { - if (videoFile !== undefined && webtorrent.get(videoFile.magnetUri)) { + if (videoFile !== undefined && this.webtorrent.get(videoFile.magnetUri)) { if (destroyRenderer === true && this.renderer && this.renderer.destroy) this.renderer.destroy() - webtorrent.remove(videoFile.magnetUri) + this.webtorrent.remove(videoFile.magnetUri) console.log('Removed ' + videoFile.magnetUri) } } @@ -253,19 +310,54 @@ class PeerTubePlugin extends Plugin { this.trigger('autoResolutionUpdate') } + getCurrentVideoFile () { + return this.currentVideoFile + } + + getTorrent () { + return this.torrent + } + + private tryToPlay (done?: Function) { + if (!done) done = function () { /* empty */ } + + const playPromise = this.player.play() + if (playPromise !== undefined) { + return playPromise.then(done) + .catch(err => { + console.error(err) + this.player.pause() + this.player.posterImage.show() + this.player.removeClass('vjs-has-autoplay') + this.player.removeClass('vjs-has-big-play-button-clicked') + + return done() + }) + } + + return done() + } + + private seek (time: number) { + this.player.currentTime(time) + this.player.handleTechSeeked_() + } + private getAppropriateFile (averageDownloadSpeed?: number): VideoFile { if (this.videoFiles === undefined || this.videoFiles.length === 0) return undefined if (this.videoFiles.length === 1) return this.videoFiles[0] - if (this.torrent && this.torrent.progress === 1) return this.currentVideoFile - if (!averageDownloadSpeed) averageDownloadSpeed = this.getActualDownloadSpeed() + // Don't change the torrent is the play was ended + if (this.torrent && this.torrent.progress === 1 && this.player.ended()) return this.currentVideoFile + + if (!averageDownloadSpeed) averageDownloadSpeed = this.getAndSaveActualDownloadSpeed() // Filter videos we can play according to our bandwidth const filteredFiles = this.videoFiles.filter(f => { const fileBitrate = (f.size / this.videoDuration) let threshold = fileBitrate - // If this is for a higher resolution, or an initial load -> add a upper margin + // If this is for a higher resolution or an initial load: add a margin if (!this.currentVideoFile || f.resolution.id > this.currentVideoFile.resolution.id) { threshold += ((fileBitrate * this.CONSTANTS.AUTO_QUALITY_THRESHOLD_PERCENT) / 100) } @@ -274,12 +366,12 @@ class PeerTubePlugin extends Plugin { }) // If the download speed is too bad, return the lowest resolution we have - if (filteredFiles.length === 0) return minBy(this.videoFiles, 'resolution.id') + if (filteredFiles.length === 0) return videoFileMinByResolution(this.videoFiles) - return maxBy(filteredFiles, 'resolution.id') + return videoFileMaxByResolution(filteredFiles) } - private getActualDownloadSpeed () { + private getAndSaveActualDownloadSpeed () { const start = Math.max(this.downloadSpeeds.length - this.CONSTANTS.BANDWIDTH_AVERAGE_NUMBER_OF_VALUES, 0) const lastDownloadSpeeds = this.downloadSpeeds.slice(start, this.downloadSpeeds.length) if (lastDownloadSpeeds.length === 0) return -1 @@ -294,26 +386,39 @@ class PeerTubePlugin extends Plugin { } private initializePlayer () { + if (isMobile()) this.player.addClass('vjs-is-mobile') + this.initSmoothProgressBar() this.alterInactivity() if (this.autoplay === true) { this.player.posterImage.hide() - this.updateVideoFile(undefined, 0, () => this.player.play()) + + this.updateVideoFile(undefined, { forcePlay: true, seek: this.startTime }) } else { + // Don't try on iOS that does not support MediaSource + if (this.isIOS()) { + this.currentVideoFile = this.pickAverageVideoFile() + return this.fallbackToHttp(undefined, false) + } + // Proxy first play const oldPlay = this.player.play.bind(this.player) this.player.play = () => { - this.updateVideoFile(undefined, 0, () => oldPlay) + this.player.addClass('vjs-has-big-play-button-clicked') this.player.play = oldPlay + + this.updateVideoFile(undefined, { forcePlay: true, seek: this.startTime }) } } } private runAutoQualityScheduler () { this.autoQualityInterval = setInterval(() => { - if (this.torrent === undefined) return + + // Not initialized or in HTTP fallback + if (this.torrent === undefined || this.torrent === null) return if (this.isAutoResolutionOn() === false) return if (this.isAutoResolutionObservation === true) return @@ -325,10 +430,10 @@ class PeerTubePlugin extends Plugin { if (this.isPlayerWaiting() && file.resolution.id < this.currentVideoFile.resolution.id) { console.log('Downgrading automatically the resolution to: %s', file.resolution.label) changeResolution = true - } else if (file.resolution.id > this.currentVideoFile.resolution.id) { // Greater resolution + } else if (file.resolution.id > this.currentVideoFile.resolution.id) { // Higher resolution console.log('Upgrading automatically the resolution to: %s', file.resolution.label) changeResolution = true - changeResolutionDelay = this.CONSTANTS.AUTO_QUALITY_UPPER_RESOLUTION_DELAY + changeResolutionDelay = this.CONSTANTS.AUTO_QUALITY_HIGHER_RESOLUTION_DELAY } if (changeResolution === true) { @@ -336,13 +441,16 @@ class PeerTubePlugin extends Plugin { // Wait some seconds in observation of our new resolution this.isAutoResolutionObservation = true - setTimeout(() => this.isAutoResolutionObservation = false, this.CONSTANTS.AUTO_QUALITY_OBSERVATION_TIME) + + this.qualityObservationTimer = setTimeout(() => { + this.isAutoResolutionObservation = false + }, this.CONSTANTS.AUTO_QUALITY_OBSERVATION_TIME) } }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER) } private isPlayerWaiting () { - return this.player.hasClass('vjs-waiting') + return this.player && this.player.hasClass('vjs-waiting') } private runTorrentInfoScheduler () { @@ -353,8 +461,8 @@ class PeerTubePlugin extends Plugin { // Http fallback if (this.torrent === null) return this.trigger('torrentInfo', false) - // webtorrent.downloadSpeed because we need to take into account the potential old torrent too - if (webtorrent.downloadSpeed !== 0) this.downloadSpeeds.push(webtorrent.downloadSpeed) + // this.webtorrent.downloadSpeed because we need to take into account the potential old torrent too + if (this.webtorrent.downloadSpeed !== 0) this.downloadSpeeds.push(this.webtorrent.downloadSpeed) return this.trigger('torrentInfo', { downloadSpeed: this.torrent.downloadSpeed, @@ -394,10 +502,12 @@ class PeerTubePlugin extends Plugin { } private addViewToVideo () { + if (!this.videoViewUrl) return Promise.resolve(undefined) + return fetch(this.videoViewUrl, { method: 'POST' }) } - private fallbackToHttp (done: Function) { + private fallbackToHttp (done?: Function, play = true) { this.flushVideoFile(this.currentVideoFile, true) this.torrent = null @@ -407,9 +517,9 @@ class PeerTubePlugin extends Plugin { const httpUrl = this.currentVideoFile.fileUrl this.player.src = this.savePlayerSrcFunction this.player.src(httpUrl) - this.player.play() + if (play) this.tryToPlay() - return done() + if (done) return done() } private handleError (err: Error | string) { @@ -424,6 +534,10 @@ class PeerTubePlugin extends Plugin { this.player.removeClass('vjs-error-display-enabled') } + private isIOS () { + return !!navigator.platform && /iPad|iPhone|iPod/.test(navigator.platform) + } + private alterInactivity () { let saveInactivityTimeout: number @@ -443,6 +557,25 @@ class PeerTubePlugin extends Plugin { settingsDialog.on('mouseleave', () => enableInactivity()) } + private pickAverageVideoFile () { + if (this.videoFiles.length === 1) return this.videoFiles[0] + + return this.videoFiles[Math.floor(this.videoFiles.length / 2)] + } + + private destroyFakeRenderer () { + if (this.fakeRenderer) { + if (this.fakeRenderer.destroy) { + try { + this.fakeRenderer.destroy() + } catch (err) { + console.log('Cannot destroy correctly fake renderer.', err) + } + } + this.fakeRenderer = undefined + } + } + // Thanks: https://github.com/videojs/video.js/issues/4460#issuecomment-312861657 private initSmoothProgressBar () { const SeekBar = videojsUntyped.getComponent('SeekBar') @@ -466,5 +599,5 @@ class PeerTubePlugin extends Plugin { } } -videojsUntyped.registerPlugin('peertube', PeerTubePlugin) +videojs.registerPlugin('peertube', PeerTubePlugin) export { PeerTubePlugin }