import { VideoFile } from '../../../../shared/models/videos/video.model'
import { renderVideo } from './video-renderer'
import './settings-menu-button'
-import { PeertubePluginOptions, VideoJSComponentInterface, videojsUntyped } from './peertube-videojs-typings'
-import { getStoredMute, getStoredVolume, saveMuteInStore, saveVolumeInStore } from './utils'
-
-const webtorrent = new WebTorrent({
- tracker: {
- rtcConfig: {
- iceServers: [
- {
- urls: 'stun:stun.stunprotocol.org'
- },
- {
- urls: 'stun:stun.framasoft.org'
- }
- ]
- }
- },
- dht: false
-})
-
-const Plugin: VideoJSComponentInterface = videojsUntyped.getPlugin('plugin')
+import { PeertubePluginOptions, VideoJSCaption, VideoJSComponentInterface, videojsUntyped } from './peertube-videojs-typings'
+import { isMobile, videoFileMaxByResolution, videoFileMinByResolution, timeToInt } from './utils'
+import * as CacheChunkStore from 'cache-chunk-store'
+import { PeertubeChunkStore } from './peertube-chunk-store'
+import {
+ getAverageBandwidthInStore,
+ getStoredMute,
+ getStoredVolume,
+ saveAverageBandwidth,
+ saveMuteInStore,
+ saveVolumeInStore
+} from './peertube-player-local-storage'
+
+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
+ private readonly videoDuration: number
+ private readonly CONSTANTS = {
+ 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 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 videoFiles: VideoFile[]
private torrent: WebTorrent.Torrent
- private videoViewUrl: string
- private videoDuration: number
+ private videoCaptions: VideoJSCaption[]
+ private renderer
+ private fakeRenderer
+ private autoResolution = true
+ private forbidAutoResolution = false
+ private isAutoResolutionObservation = false
+
private videoViewInterval
private torrentInfoInterval
+ private autoQualityInterval
+ 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 = timeToInt(options.startTime)
this.videoFiles = options.videoFiles
this.videoViewUrl = options.videoViewUrl
this.videoDuration = options.videoDuration
+ this.videoCaptions = options.videoCaptions
this.savePlayerSrcFunction = this.player.src
// Hack to "simulate" src link in video.js >= 6
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)
this.initializePlayer()
this.runTorrentInfoScheduler()
this.runViewAdd()
+
+ this.player.one('play', () => {
+ // Don't run immediately scheduler, wait some seconds the TCP connections are made
+ this.runAutoQualitySchedulerTimer = setTimeout(() => {
+ this.runAutoQualityScheduler()
+ }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER)
+ })
})
this.player.on('volumechange', () => {
}
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 () {
}
getCurrentResolutionLabel () {
- return this.currentVideoFile ? this.currentVideoFile.resolution.label : ''
- }
+ if (!this.currentVideoFile) return ''
- updateVideoFile (videoFile?: VideoFile, done?: () => void) {
- if (done === undefined) {
- done = () => { /* empty */ }
- }
+ const fps = this.currentVideoFile.fps >= 50 ? this.currentVideoFile.fps : ''
+ return this.currentVideoFile.resolution.label + fps
+ }
- // Pick the first one
+ updateVideoFile (
+ videoFile?: VideoFile,
+ options: {
+ forcePlay?: boolean,
+ seek?: number,
+ delay?: number
+ } = {},
+ done: () => void = () => { /* empty */ }
+ ) {
+ // Automatically choose the adapted video file
if (videoFile === undefined) {
- videoFile = this.videoFiles[0]
+ const savedAverageBandwidth = getAverageBandwidthInStore()
+ videoFile = savedAverageBandwidth
+ ? this.getAppropriateFile(savedAverageBandwidth)
+ : this.pickAverageVideoFile()
}
// Don't add the same video file once again
const previousVideoFile = this.currentVideoFile
this.currentVideoFile = videoFile
- this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, () => {
+ this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, options, () => {
this.player.playbackRate(oldPlaybackRate)
return done()
})
this.trigger('videoFileUpdate')
}
- addTorrent (magnetOrTorrentUrl: string, previousVideoFile: VideoFile, done: Function) {
+ addTorrent (
+ magnetOrTorrentUrl: string,
+ previousVideoFile: VideoFile,
+ options: {
+ forcePlay?: boolean,
+ seek?: number,
+ delay?: number
+ },
+ done: Function
+ ) {
console.log('Adding ' + magnetOrTorrentUrl + '.')
- this.torrent = webtorrent.add(magnetOrTorrentUrl, torrent => {
- console.log('Added ' + magnetOrTorrentUrl + '.')
+ const oldTorrent = this.torrent
+ const torrentOptions = {
+ store: (chunkLength, storeOpts) => new CacheChunkStore(new PeertubeChunkStore(chunkLength, storeOpts), {
+ max: 100
+ })
+ }
- this.flushVideoFile(previousVideoFile)
+ this.torrent = this.webtorrent.add(magnetOrTorrentUrl, torrentOptions, torrent => {
+ console.log('Added ' + magnetOrTorrentUrl + '.')
- const options = { autoplay: true, controls: true }
- renderVideo(torrent.files[0], this.playerElement, options,(err, renderer) => {
- this.renderer = renderer
+ if (oldTorrent) {
+ // Pause the old torrent
+ oldTorrent.pause()
+ // Pause does not remove actual peers (in particular the webseed peer)
+ oldTorrent.removePeer(oldTorrent['ws'])
- if (err) return this.fallbackToHttp(done)
+ // 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 (!this.player.paused()) {
- const playPromise = this.player.play()
- if (playPromise !== undefined) return playPromise.then(done)
+ if (err) console.error('Cannot render new torrent in fake video element.', err)
- return done()
+ // Load the future file at the correct time
+ fakeVideoElem.currentTime = this.player.currentTime() + (options.delay / 2000)
+ })
}
+ }
- return done()
- })
+ // 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 renderVideoOptions = { autoplay: false, controls: true }
+ renderVideo(torrent.files[0], this.playerElement, renderVideoOptions,(err, renderer) => {
+ this.renderer = renderer
+
+ if (err) return this.fallbackToHttp(done)
+
+ return this.tryToPlay(err => {
+ if (err) return done(err)
+
+ if (options.seek) this.seek(options.seek)
+ if (options.forcePlay === false && paused === true) this.player.pause()
+
+ return done(err)
+ })
+ })
+ }, options.delay || 0)
})
- this.torrent.on('error', err => this.handleError(err))
+ this.torrent.on('error', err => console.error(err))
this.torrent.on('warning', (err: any) => {
// We don't support HTTP tracker but we don't care -> we use the web socket tracker
// Users don't care about issues with WebRTC, but developers do so log it in the console
if (err.message.indexOf('Ice connection failed') !== -1) {
- console.error(err)
+ console.log(err)
return
}
// 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, done)
+ const newOptions = { forcePlay: true, seek: options.seek }
+ return this.addTorrent(this.torrent['xs'], previousVideoFile, newOptions, done)
+ }
+
+ // Remote instance is down
+ if (err.message.indexOf('from xs param') !== -1) {
+ this.handleError(err)
}
- return this.handleError(err)
+ console.warn(err)
})
}
- updateResolution (resolutionId: number) {
+ updateResolution (resolutionId: number, delay = 0) {
// Remember player state
const currentTime = this.player.currentTime()
const isPaused = this.player.paused()
}
const newVideoFile = this.videoFiles.find(f => f.resolution.id === resolutionId)
- this.updateVideoFile(newVideoFile, () => {
- 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)
}
}
- setVideoFiles (files: VideoFile[], videoViewUrl: string, videoDuration: number) {
- this.videoViewUrl = videoViewUrl
- this.videoDuration = videoDuration
- this.videoFiles = files
+ isAutoResolutionOn () {
+ return this.autoResolution
+ }
+
+ enableAutoResolution () {
+ this.autoResolution = true
+ this.trigger('autoResolutionUpdate')
+ }
+
+ disableAutoResolution (forbid = false) {
+ if (forbid === true) this.forbidAutoResolution = true
+
+ this.autoResolution = false
+ this.trigger('autoResolutionUpdate')
+ }
+
+ isAutoResolutionForbidden () {
+ return this.forbidAutoResolution === true
+ }
+
+ 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 => {
+ if (err.message.indexOf('The play() request was interrupted by a call to pause()') !== -1) {
+ return
+ }
+
+ 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()
+ }
- // Re run view add for the new video
- this.runViewAdd()
- this.updateVideoFile(undefined, () => this.player.play())
+ 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]
+
+ // 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()
+
+ // Limit resolution according to player height
+ const playerHeight = this.playerElement.offsetHeight as number
+
+ // We take the first resolution just above the player height
+ // Example: player height is 530px, we want the 720p file instead of 480p
+ let maxResolution = this.videoFiles[0].resolution.id
+ for (let i = this.videoFiles.length - 1; i >= 0; i--) {
+ const resolutionId = this.videoFiles[i].resolution.id
+ if (resolutionId >= playerHeight) {
+ maxResolution = resolutionId
+ break
+ }
+ }
+
+ // Filter videos we can play according to our screen resolution and bandwidth
+ const filteredFiles = this.videoFiles
+ .filter(f => f.resolution.id <= maxResolution)
+ .filter(f => {
+ const fileBitrate = (f.size / this.videoDuration)
+ let threshold = fileBitrate
+
+ // 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)
+ }
+
+ return averageDownloadSpeed > threshold
+ })
+
+ // If the download speed is too bad, return the lowest resolution we have
+ if (filteredFiles.length === 0) return videoFileMinByResolution(this.videoFiles)
+
+ return videoFileMaxByResolution(filteredFiles)
+ }
+
+ 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
+
+ const sum = lastDownloadSpeeds.reduce((a, b) => a + b)
+ const averageBandwidth = Math.round(sum / lastDownloadSpeeds.length)
+
+ // Save the average bandwidth for future use
+ saveAverageBandwidth(averageBandwidth)
+
+ return averageBandwidth
}
private initializePlayer () {
+ if (isMobile()) this.player.addClass('vjs-is-mobile')
+
this.initSmoothProgressBar()
+ this.initCaptions()
+
this.alterInactivity()
if (this.autoplay === true) {
this.player.posterImage.hide()
- this.updateVideoFile(undefined, () => 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, () => 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(() => {
+
+ // Not initialized or in HTTP fallback
+ if (this.torrent === undefined || this.torrent === null) return
+ if (this.isAutoResolutionOn() === false) return
+ if (this.isAutoResolutionObservation === true) return
+
+ const file = this.getAppropriateFile()
+ let changeResolution = false
+ let changeResolutionDelay = 0
+
+ // Lower resolution
+ 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) { // Higher resolution
+ console.log('Upgrading automatically the resolution to: %s', file.resolution.label)
+ changeResolution = true
+ changeResolutionDelay = this.CONSTANTS.AUTO_QUALITY_HIGHER_RESOLUTION_DELAY
+ }
+
+ if (changeResolution === true) {
+ this.updateResolution(file.resolution.id, changeResolutionDelay)
+
+ // Wait some seconds in observation of our new resolution
+ this.isAutoResolutionObservation = true
+
+ this.qualityObservationTimer = setTimeout(() => {
+ this.isAutoResolutionObservation = false
+ }, this.CONSTANTS.AUTO_QUALITY_OBSERVATION_TIME)
+ }
+ }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER)
+ }
+
+ private isPlayerWaiting () {
+ return this.player && this.player.hasClass('vjs-waiting')
+ }
+
private runTorrentInfoScheduler () {
this.torrentInfoInterval = setInterval(() => {
// Not initialized yet
// Http fallback
if (this.torrent === null) return this.trigger('torrentInfo', false)
+ // 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,
numPeers: this.torrent.numPeers,
- uploadSpeed: this.torrent.uploadSpeed
+ uploadSpeed: this.torrent.uploadSpeed,
+ downloaded: this.torrent.downloaded,
+ uploaded: this.torrent.uploaded
})
- }, 1000)
+ }, this.CONSTANTS.INFO_SCHEDULER)
}
private runViewAdd () {
}
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.disableAutoResolution(true)
+
this.flushVideoFile(this.currentVideoFile, true)
this.torrent = null
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) {
this.player.removeClass('vjs-error-display-enabled')
}
+ private isIOS () {
+ return !!navigator.platform && /iPad|iPhone|iPod/.test(navigator.platform)
+ }
+
private alterInactivity () {
let saveInactivityTimeout: number
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
+ }
+ }
+
+ private initCaptions () {
+ for (const caption of this.videoCaptions) {
+ this.player.addRemoteTextTrack({
+ kind: 'captions',
+ label: caption.label,
+ language: caption.language,
+ id: caption.language,
+ src: caption.src
+ }, false)
+ }
+ }
+
// Thanks: https://github.com/videojs/video.js/issues/4460#issuecomment-312861657
private initSmoothProgressBar () {
const SeekBar = videojsUntyped.getComponent('SeekBar')
}
}
-videojsUntyped.registerPlugin('peertube', PeerTubePlugin)
+videojs.registerPlugin('peertube', PeerTubePlugin)
export { PeerTubePlugin }
projects / github / Chocobozzz / PeerTube.git / blobdiff