-// FIXME: something weird with our path definition in tsconfig and typings
-// @ts-ignore
-import * as videojs from 'video.js'
-
+import videojs from 'video.js'
import * as WebTorrent from 'webtorrent'
-import { VideoFile } from '../../../../../shared/models/videos/video.model'
-import { renderVideo } from './video-renderer'
-import { LoadedQualityData, PlayerNetworkInfo, VideoJSComponentInterface, WebtorrentPluginOptions } from '../peertube-videojs-typings'
-import { getRtcConfig, videoFileMaxByResolution, videoFileMinByResolution } from '../utils'
+import { timeToInt } from '@shared/core-utils'
+import { VideoFile } from '@shared/models'
+import { getAverageBandwidthInStore, getStoredMute, getStoredVolume, saveAverageBandwidth } from '../peertube-player-local-storage'
+import { PeerTubeResolution, PlayerNetworkInfo, WebtorrentPluginOptions } from '../peertube-videojs-typings'
+import { getRtcConfig, isIOS, videoFileMaxByResolution, videoFileMinByResolution } from '../utils'
import { PeertubeChunkStore } from './peertube-chunk-store'
-import {
- getAverageBandwidthInStore,
- getStoredMute,
- getStoredVolume,
- getStoredWebTorrentEnabled,
- saveAverageBandwidth
-} from '../peertube-player-local-storage'
+import { renderVideo } from './video-renderer'
const CacheChunkStore = require('cache-chunk-store')
type PlayOptions = {
- forcePlay?: boolean,
- seek?: number,
+ forcePlay?: boolean
+ seek?: number
delay?: number
}
-const Plugin: VideoJSComponentInterface = videojs.getPlugin('plugin')
+const Plugin = videojs.getPlugin('plugin')
+
class WebTorrentPlugin extends Plugin {
+ readonly videoFiles: VideoFile[]
+
private readonly playerElement: HTMLVideoElement
private readonly autoplay: boolean = false
private readonly startTime: number = 0
- private readonly savePlayerSrcFunction: Function
- private readonly videoFiles: VideoFile[]
+ private readonly savePlayerSrcFunction: videojs.Player['src']
private readonly videoDuration: number
private readonly CONSTANTS = {
INFO_SCHEDULER: 1000, // Don't change this
dht: false
})
- private player: any
private currentVideoFile: VideoFile
private torrent: WebTorrent.Torrent
private downloadSpeeds: number[] = []
- constructor (player: videojs.Player, options: WebtorrentPluginOptions) {
- super(player, options)
+ constructor (player: videojs.Player, options?: WebtorrentPluginOptions) {
+ super(player)
+
+ this.startTime = timeToInt(options.startTime)
- // Disable auto play on iOS
- this.autoplay = options.autoplay && this.isIOS() === false
- this.playerRefusedP2P = !getStoredWebTorrentEnabled()
+ // Custom autoplay handled by webtorrent because we lazy play the video
+ this.autoplay = options.autoplay
+
+ this.playerRefusedP2P = options.playerRefusedP2P
this.videoFiles = options.videoFiles
this.videoDuration = options.videoDuration
updateVideoFile (
videoFile?: VideoFile,
options: {
- forcePlay?: boolean,
- seek?: number,
+ forcePlay?: boolean
+ seek?: number
delay?: number
} = {},
done: () => void = () => { /* empty */ }
) {
// Automatically choose the adapted video file
- if (videoFile === undefined) {
+ if (!videoFile) {
const savedAverageBandwidth = getAverageBandwidthInStore()
videoFile = savedAverageBandwidth
? this.getAppropriateFile(savedAverageBandwidth)
: this.pickAverageVideoFile()
}
+ if (!videoFile) {
+ throw Error(`Can't update video file since videoFile is undefined.`)
+ }
+
// Don't add the same video file once again
if (this.currentVideoFile !== undefined && this.currentVideoFile.magnetUri === videoFile.magnetUri) {
return
}
// Do not display error to user because we will have multiple fallback
- this.disableErrorDisplay()
+ this.player.peertube().hideFatalError();
// Hack to "simulate" src link in video.js >= 6
// Without this, we can't play the video after pausing it
// https://github.com/videojs/video.js/blob/master/src/js/player.js#L1633
- this.player.src = () => true
+ (this.player as any).src = () => true
const oldPlaybackRate = this.player.playbackRate()
const previousVideoFile = this.currentVideoFile
// Don't try on iOS that does not support MediaSource
// Or don't use P2P if webtorrent is disabled
- if (this.isIOS() || this.playerRefusedP2P) {
+ if (isIOS() || this.playerRefusedP2P) {
return this.fallbackToHttp(options, () => {
this.player.playbackRate(oldPlaybackRate)
return done()
return done()
})
- this.changeQuality()
- this.trigger('resolutionChange', { auto: this.autoResolution, resolutionId: this.currentVideoFile.resolution.id })
+ this.selectAppropriateResolution(true)
}
- updateResolution (resolutionId: number, delay = 0) {
+ updateEngineResolution (resolutionId: number, delay = 0) {
// Remember player state
const currentTime = this.player.currentTime()
const isPaused = this.player.paused()
- // Remove poster to have black background
- this.playerElement.poster = ''
-
// Hide bigPlayButton
if (!isPaused) {
this.player.bigPlayButton.hide()
}
+ // Audio-only (resolutionId === 0) gets special treatment
+ if (resolutionId === 0) {
+ // Audio-only: show poster, do not auto-hide controls
+ this.player.addClass('vjs-playing-audio-only-content')
+ this.player.posterImage.show()
+ } else {
+ // Hide poster to have black background
+ this.player.removeClass('vjs-playing-audio-only-content')
+ this.player.posterImage.hide()
+ }
+
const newVideoFile = this.videoFiles.find(f => f.resolution.id === resolutionId)
const options = {
forcePlay: false,
delay,
seek: currentTime + (delay / 1000)
}
+
this.updateVideoFile(newVideoFile, options)
}
}
}
- enableAutoResolution () {
- this.autoResolution = true
- this.trigger('resolutionChange', { auto: this.autoResolution, resolutionId: this.getCurrentResolutionId() })
+ disableAutoResolution () {
+ this.autoResolution = false
+ this.autoResolutionPossible = false
+ this.player.peertubeResolutions().disableAutoResolution()
}
- disableAutoResolution (forbid = false) {
- if (forbid === true) this.autoResolutionPossible = false
-
- this.autoResolution = false
- this.trigger('autoResolutionChange', { possible: this.autoResolutionPossible })
- this.trigger('resolutionChange', { auto: this.autoResolution, resolutionId: this.getCurrentResolutionId() })
+ isAutoResolutionPossible () {
+ return this.autoResolutionPossible
}
getTorrent () {
return this.torrent
}
+ getCurrentVideoFile () {
+ return this.currentVideoFile
+ }
+
+ changeQuality (id: number) {
+ if (id === -1) {
+ if (this.autoResolutionPossible === true) {
+ this.autoResolution = true
+
+ this.selectAppropriateResolution(false)
+ }
+
+ return
+ }
+
+ this.autoResolution = false
+ this.updateEngineResolution(id)
+ this.selectAppropriateResolution(false)
+ }
+
private addTorrent (
magnetOrTorrentUrl: string,
previousVideoFile: VideoFile,
options: PlayOptions,
- done: Function
+ done: (err?: Error) => void
) {
+ if (!magnetOrTorrentUrl) return this.fallbackToHttp(options, done)
+
console.log('Adding ' + magnetOrTorrentUrl + '.')
const oldTorrent = this.torrent
const torrentOptions = {
- store: (chunkLength: number, storeOpts: any) => new CacheChunkStore(new PeertubeChunkStore(chunkLength, storeOpts), {
- max: 100
- })
+ // Don't use arrow function: it breaks webtorrent (that uses `new` keyword)
+ store: function (chunkLength: number, storeOpts: any) {
+ return new CacheChunkStore(new PeertubeChunkStore(chunkLength, storeOpts), {
+ max: 100
+ })
+ }
}
this.torrent = this.webtorrent.add(magnetOrTorrentUrl, torrentOptions, torrent => {
this.stopTorrent(oldTorrent)
// We use a fake renderer so we download correct pieces of the next file
- if (options.delay) this.renderFileInFakeElement(torrent.files[ 0 ], options.delay)
+ if (options.delay) this.renderFileInFakeElement(torrent.files[0], options.delay)
}
// Render the video in a few seconds? (on resolution change for example, we wait some seconds of the new video resolution)
if (options.seek) this.player.currentTime(options.seek)
const renderVideoOptions = { autoplay: false, controls: true }
- renderVideo(torrent.files[ 0 ], this.playerElement, renderVideoOptions, (err, renderer) => {
+ renderVideo(torrent.files[0], this.playerElement, renderVideoOptions, (err, renderer) => {
this.renderer = renderer
if (err) return this.fallbackToHttp(options, done)
if (err.message.indexOf('incorrect info hash') !== -1) {
console.error('Incorrect info hash detected, falling back to torrent file.')
const newOptions = { forcePlay: true, seek: options.seek }
- return this.addTorrent(this.torrent[ 'xs' ], previousVideoFile, newOptions, done)
+ return this.addTorrent(this.torrent['xs'], previousVideoFile, newOptions, done)
}
// Remote instance is down
const playPromise = this.player.play()
if (playPromise !== undefined) {
- return playPromise.then(done)
+ return playPromise.then(() => done())
.catch((err: Error) => {
- if (err.message.indexOf('The play() request was interrupted by a call to pause()') !== -1) {
+ if (err.message.includes('The play() request was interrupted by a call to pause()')) {
return
}
this.player.posterImage.show()
this.player.removeClass('vjs-has-autoplay')
this.player.removeClass('vjs-has-big-play-button-clicked')
+ this.player.removeClass('vjs-playing-audio-only-content')
return done()
})
}
private getAppropriateFile (averageDownloadSpeed?: number): VideoFile {
- if (this.videoFiles === undefined || this.videoFiles.length === 0) return undefined
+ if (this.videoFiles === undefined) return undefined
if (this.videoFiles.length === 1) return this.videoFiles[0]
- // Don't change the torrent is the play was ended
+ const files = this.videoFiles.filter(f => f.resolution.id !== 0)
+ if (files.length === 0) return undefined
+
+ // Don't change the torrent if the player 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
+ const playerHeight = this.playerElement.offsetHeight
// 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) {
+ let maxResolution = files[0].resolution.id
+ for (let i = files.length - 1; i >= 0; i--) {
+ const resolutionId = files[i].resolution.id
+ if (resolutionId !== 0 && 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
+ const filteredFiles = files.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)
- }
+ // 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
- })
+ return averageDownloadSpeed > threshold
+ })
// If the download speed is too bad, return the lowest resolution we have
- if (filteredFiles.length === 0) return videoFileMinByResolution(this.videoFiles)
+ if (filteredFiles.length === 0) return videoFileMinByResolution(files)
return videoFileMaxByResolution(filteredFiles)
}
private initializePlayer () {
this.buildQualities()
- if (this.autoplay === true) {
+ if (this.autoplay) {
this.player.posterImage.hide()
return this.updateVideoFile(undefined, { forcePlay: true, seek: this.startTime })
}
// Proxy first play
- const oldPlay = this.player.play.bind(this.player)
- this.player.play = () => {
+ const oldPlay = this.player.play.bind(this.player);
+ (this.player as any).play = () => {
this.player.addClass('vjs-has-big-play-button-clicked')
this.player.play = oldPlay
}
if (changeResolution === true) {
- this.updateResolution(file.resolution.id, changeResolutionDelay)
+ this.updateEngineResolution(file.resolution.id, changeResolutionDelay)
// Wait some seconds in observation of our new resolution
this.isAutoResolutionObservation = true
}
private isPlayerWaiting () {
- return this.player && this.player.hasClass('vjs-waiting')
+ return this.player?.hasClass('vjs-waiting')
}
private runTorrentInfoScheduler () {
if (this.webtorrent.downloadSpeed !== 0) this.downloadSpeeds.push(this.webtorrent.downloadSpeed)
return this.player.trigger('p2pInfo', {
+ source: 'webtorrent',
http: {
downloadSpeed: 0,
uploadSpeed: 0,
uploadSpeed: this.torrent.uploadSpeed,
downloaded: this.torrent.downloaded,
uploaded: this.torrent.uploaded
- }
+ },
+ bandwidthEstimate: this.webtorrent.downloadSpeed
} as PlayerNetworkInfo)
}, this.CONSTANTS.INFO_SCHEDULER)
}
- private fallbackToHttp (options: PlayOptions, done?: Function) {
+ private fallbackToHttp (options: PlayOptions, done?: (err?: Error) => void) {
const paused = this.player.paused()
- this.disableAutoResolution(true)
+ this.disableAutoResolution()
this.flushVideoFile(this.currentVideoFile, true)
this.torrent = null
// Enable error display now this is our last fallback
- this.player.one('error', () => this.enableErrorDisplay())
+ this.player.one('error', () => this.player.peertube().displayFatalError())
const httpUrl = this.currentVideoFile.fileUrl
this.player.src = this.savePlayerSrcFunction
this.player.src(httpUrl)
- this.changeQuality()
+ this.selectAppropriateResolution(true)
// We changed the source, so reinit captions
this.player.trigger('sourcechange')
return this.player.trigger('customError', { err })
}
- private enableErrorDisplay () {
- this.player.addClass('vjs-error-display-enabled')
- }
-
- private disableErrorDisplay () {
- this.player.removeClass('vjs-error-display-enabled')
- }
-
- private isIOS () {
- return !!navigator.platform && /iPad|iPhone|iPod/.test(navigator.platform)
- }
-
private pickAverageVideoFile () {
if (this.videoFiles.length === 1) return this.videoFiles[0]
- return this.videoFiles[Math.floor(this.videoFiles.length / 2)]
+ const files = this.videoFiles.filter(f => f.resolution.id !== 0)
+ return files[Math.floor(files.length / 2)]
}
private stopTorrent (torrent: WebTorrent.Torrent) {
torrent.pause()
// Pause does not remove actual peers (in particular the webseed peer)
- torrent.removePeer(torrent[ 'ws' ])
+ torrent.removePeer(torrent['ws'])
}
private renderFileInFakeElement (file: WebTorrent.TorrentFile, delay: number) {
}
private buildQualities () {
- const qualityLevelsPayload = []
-
- for (const file of this.videoFiles) {
- const representation = {
- id: file.resolution.id,
- label: this.buildQualityLabel(file),
- height: file.resolution.id,
- _enabled: true
- }
-
- this.player.qualityLevels().addQualityLevel(representation)
-
- qualityLevelsPayload.push({
- id: representation.id,
- label: representation.label,
- selected: false
- })
- }
+ const resolutions: PeerTubeResolution[] = this.videoFiles.map(file => ({
+ id: file.resolution.id,
+ label: this.buildQualityLabel(file),
+ height: file.resolution.id,
+ selected: false,
+ selectCallback: () => this.changeQuality(file.resolution.id)
+ }))
+
+ resolutions.push({
+ id: -1,
+ label: this.player.localize('Auto'),
+ selected: true,
+ selectCallback: () => this.changeQuality(-1)
+ })
- const payload: LoadedQualityData = {
- qualitySwitchCallback: (d: any) => this.qualitySwitchCallback(d),
- qualityData: {
- video: qualityLevelsPayload
- }
- }
- this.player.tech_.trigger('loadedqualitydata', payload)
+ this.player.peertubeResolutions().add(resolutions)
}
private buildQualityLabel (file: VideoFile) {
return label
}
- private qualitySwitchCallback (id: number) {
- if (id === -1) {
- if (this.autoResolutionPossible === true) this.enableAutoResolution()
- return
- }
+ private selectAppropriateResolution (byEngine: boolean) {
+ const resolution = this.autoResolution
+ ? -1
+ : this.getCurrentResolutionId()
- this.disableAutoResolution()
- this.updateResolution(id)
- }
+ const autoResolutionChosen = this.autoResolution
+ ? this.getCurrentResolutionId()
+ : undefined
- private changeQuality () {
- const resolutionId = this.currentVideoFile.resolution.id
- const qualityLevels = this.player.qualityLevels()
-
- if (resolutionId === -1) {
- qualityLevels.selectedIndex = -1
- return
- }
-
- for (let i = 0; i < qualityLevels; i++) {
- const q = this.player.qualityLevels[i]
- if (q.height === resolutionId) qualityLevels.selectedIndex = i
- }
+ this.player.peertubeResolutions().select({ id: resolution, autoResolutionChosenId: autoResolutionChosen, byEngine })
}
}
projects / github / Chocobozzz / PeerTube.git / blobdiff