client/src/standalone/videos/embed.ts

   1 import './embed.scss'
   2
   3 import 'core-js/es6/symbol'
   4 import 'core-js/es6/object'
   5 import 'core-js/es6/function'
   6 import 'core-js/es6/parse-int'
   7 import 'core-js/es6/parse-float'
   8 import 'core-js/es6/number'
   9 import 'core-js/es6/math'
  10 import 'core-js/es6/string'
  11 import 'core-js/es6/date'
  12 import 'core-js/es6/array'
  13 import 'core-js/es6/regexp'
  14 import 'core-js/es6/map'
  15 import 'core-js/es6/weak-map'
  16 import 'core-js/es6/set'
  17 // For google bot that uses Chrome 41 and does not understand fetch
  18 import 'whatwg-fetch'
  19
  20 // FIXME: something weird with our path definition in tsconfig and typings
  21 // @ts-ignore
  22 import * as vjs from 'video.js'
  23
  24 import * as Channel from 'jschannel'
  25
  26 import { peertubeTranslate, ResultList, VideoDetails } from '../../../../shared'
  27 import { addContextMenu, getServerTranslations, getVideojsOptions, loadLocaleInVideoJS } from '../../assets/player/peertube-player'
  28 import { PeerTubeResolution } from '../player/definitions'
  29 import { VideoJSCaption } from '../../assets/player/peertube-videojs-typings'
  30 import { VideoCaption } from '../../../../shared/models/videos/caption/video-caption.model'
  31
  32 /**
  33  * Embed API exposes control of the embed player to the outside world via
  34  * JSChannels and window.postMessage
  35  */
  36 class PeerTubeEmbedApi {
  37   private channel: Channel.MessagingChannel
  38   private isReady = false
  39   private resolutions: PeerTubeResolution[] = null
  40
  41   constructor (private embed: PeerTubeEmbed) {
  42   }
  43
  44   initialize () {
  45     this.constructChannel()
  46     this.setupStateTracking()
  47
  48     // We're ready!
  49
  50     this.notifyReady()
  51   }
  52
  53   private get element () {
  54     return this.embed.videoElement
  55   }
  56
  57   private constructChannel () {
  58     let channel = Channel.build({ window: window.parent, origin: '*', scope: this.embed.scope })
  59
  60     channel.bind('play', (txn, params) => this.embed.player.play())
  61     channel.bind('pause', (txn, params) => this.embed.player.pause())
  62     channel.bind('seek', (txn, time) => this.embed.player.currentTime(time))
  63     channel.bind('setVolume', (txn, value) => this.embed.player.volume(value))
  64     channel.bind('getVolume', (txn, value) => this.embed.player.volume())
  65     channel.bind('isReady', (txn, params) => this.isReady)
  66     channel.bind('setResolution', (txn, resolutionId) => this.setResolution(resolutionId))
  67     channel.bind('getResolutions', (txn, params) => this.resolutions)
  68     channel.bind('setPlaybackRate', (txn, playbackRate) => this.embed.player.playbackRate(playbackRate))
  69     channel.bind('getPlaybackRate', (txn, params) => this.embed.player.playbackRate())
  70     channel.bind('getPlaybackRates', (txn, params) => this.embed.playerOptions.playbackRates)
  71
  72     this.channel = channel
  73   }
  74
  75   private setResolution (resolutionId: number) {
  76     if (resolutionId === -1 && this.embed.player.peertube().isAutoResolutionForbidden()) return
  77
  78     // Auto resolution
  79     if (resolutionId === -1) {
  80       this.embed.player.peertube().enableAutoResolution()
  81       return
  82     }
  83
  84     this.embed.player.peertube().disableAutoResolution()
  85     this.embed.player.peertube().updateResolution(resolutionId)
  86   }
  87
  88   /**
  89    * Let the host know that we're ready to go!
  90    */
  91   private notifyReady () {
  92     this.isReady = true
  93     this.channel.notify({ method: 'ready', params: true })
  94   }
  95
  96   private setupStateTracking () {
  97     let currentState: 'playing' | 'paused' | 'unstarted' = 'unstarted'
  98
  99     setInterval(() => {
 100       let position = this.element.currentTime
 101       let volume = this.element.volume
 102
 103       this.channel.notify({
 104         method: 'playbackStatusUpdate',
 105         params: {
 106           position,
 107           volume,
 108           playbackState: currentState
 109         }
 110       })
 111     }, 500)
 112
 113     this.element.addEventListener('play', ev => {
 114       currentState = 'playing'
 115       this.channel.notify({ method: 'playbackStatusChange', params: 'playing' })
 116     })
 117
 118     this.element.addEventListener('pause', ev => {
 119       currentState = 'paused'
 120       this.channel.notify({ method: 'playbackStatusChange', params: 'paused' })
 121     })
 122
 123     // PeerTube specific capabilities
 124
 125     this.embed.player.peertube().on('autoResolutionUpdate', () => this.loadResolutions())
 126     this.embed.player.peertube().on('videoFileUpdate', () => this.loadResolutions())
 127   }
 128
 129   private loadResolutions () {
 130     let resolutions = []
 131     let currentResolutionId = this.embed.player.peertube().getCurrentResolutionId()
 132
 133     for (const videoFile of this.embed.player.peertube().videoFiles) {
 134       let label = videoFile.resolution.label
 135       if (videoFile.fps && videoFile.fps >= 50) {
 136         label += videoFile.fps
 137       }
 138
 139       resolutions.push({
 140         id: videoFile.resolution.id,
 141         label,
 142         src: videoFile.magnetUri,
 143         active: videoFile.resolution.id === currentResolutionId
 144       })
 145     }
 146
 147     this.resolutions = resolutions
 148     this.channel.notify({
 149       method: 'resolutionUpdate',
 150       params: this.resolutions
 151     })
 152   }
 153 }
 154
 155 class PeerTubeEmbed {
 156   videoElement: HTMLVideoElement
 157   player: any
 158   playerOptions: any
 159   api: PeerTubeEmbedApi = null
 160   autoplay = false
 161   controls = true
 162   muted = false
 163   loop = false
 164   enableApi = false
 165   startTime: number | string = 0
 166   scope = 'peertube'
 167
 168   static async main () {
 169     const videoContainerId = 'video-container'
 170     const embed = new PeerTubeEmbed(videoContainerId)
 171     await embed.init()
 172   }
 173
 174   constructor (private videoContainerId: string) {
 175     this.videoElement = document.getElementById(videoContainerId) as HTMLVideoElement
 176   }
 177
 178   getVideoUrl (id: string) {
 179     return window.location.origin + '/api/v1/videos/' + id
 180   }
 181
 182   loadVideoInfo (videoId: string): Promise<Response> {
 183     return fetch(this.getVideoUrl(videoId))
 184   }
 185
 186   loadVideoCaptions (videoId: string): Promise<Response> {
 187     return fetch(this.getVideoUrl(videoId) + '/captions')
 188   }
 189
 190   removeElement (element: HTMLElement) {
 191     element.parentElement.removeChild(element)
 192   }
 193
 194   displayError (text: string) {
 195     // Remove video element
 196     if (this.videoElement) this.removeElement(this.videoElement)
 197
 198     document.title = 'Sorry - ' + text
 199
 200     const errorBlock = document.getElementById('error-block')
 201     errorBlock.style.display = 'flex'
 202
 203     const errorText = document.getElementById('error-content')
 204     errorText.innerHTML = text
 205   }
 206
 207   videoNotFound () {
 208     const text = 'This video does not exist.'
 209     this.displayError(text)
 210   }
 211
 212   videoFetchError () {
 213     const text = 'We cannot fetch the video. Please try again later.'
 214     this.displayError(text)
 215   }
 216
 217   getParamToggle (params: URLSearchParams, name: string, defaultValue: boolean) {
 218     return params.has(name) ? (params.get(name) === '1' || params.get(name) === 'true') : defaultValue
 219   }
 220
 221   getParamString (params: URLSearchParams, name: string, defaultValue: string) {
 222     return params.has(name) ? params.get(name) : defaultValue
 223   }
 224
 225   async init () {
 226     try {
 227       await this.initCore()
 228     } catch (e) {
 229       console.error(e)
 230     }
 231   }
 232
 233   private initializeApi () {
 234     if (!this.enableApi) return
 235
 236     this.api = new PeerTubeEmbedApi(this)
 237     this.api.initialize()
 238   }
 239
 240   private loadParams () {
 241     try {
 242       let params = new URL(window.location.toString()).searchParams
 243
 244       this.autoplay = this.getParamToggle(params, 'autoplay', this.autoplay)
 245       this.controls = this.getParamToggle(params, 'controls', this.controls)
 246       this.muted = this.getParamToggle(params, 'muted', this.muted)
 247       this.loop = this.getParamToggle(params, 'loop', this.loop)
 248       this.enableApi = this.getParamToggle(params, 'api', this.enableApi)
 249       this.scope = this.getParamString(params, 'scope', this.scope)
 250
 251       const startTimeParamString = params.get('start')
 252       if (startTimeParamString) this.startTime = startTimeParamString
 253     } catch (err) {
 254       console.error('Cannot get params from URL.', err)
 255     }
 256   }
 257
 258   private async initCore () {
 259     const urlParts = window.location.pathname.split('/')
 260     const videoId = urlParts[ urlParts.length - 1 ]
 261
 262     const [ , serverTranslations, videoResponse, captionsResponse ] = await Promise.all([
 263       loadLocaleInVideoJS(window.location.origin, vjs, navigator.language),
 264       getServerTranslations(window.location.origin, navigator.language),
 265       this.loadVideoInfo(videoId),
 266       this.loadVideoCaptions(videoId)
 267     ])
 268
 269     if (!videoResponse.ok) {
 270       if (videoResponse.status === 404) return this.videoNotFound()
 271
 272       return this.videoFetchError()
 273     }
 274
 275     const videoInfo: VideoDetails = await videoResponse.json()
 276     let videoCaptions: VideoJSCaption[] = []
 277     if (captionsResponse.ok) {
 278       const { data } = (await captionsResponse.json()) as ResultList<VideoCaption>
 279       videoCaptions = data.map(c => ({
 280         label: peertubeTranslate(c.language.label, serverTranslations),
 281         language: c.language.id,
 282         src: window.location.origin + c.captionPath
 283       }))
 284     }
 285
 286     this.loadParams()
 287
 288     const videojsOptions = getVideojsOptions({
 289       autoplay: this.autoplay,
 290       controls: this.controls,
 291       muted: this.muted,
 292       loop: this.loop,
 293       startTime: this.startTime,
 294
 295       videoCaptions,
 296       inactivityTimeout: 1500,
 297       videoViewUrl: this.getVideoUrl(videoId) + '/views',
 298       playerElement: this.videoElement,
 299       videoFiles: videoInfo.files,
 300       videoDuration: videoInfo.duration,
 301       enableHotkeys: true,
 302       peertubeLink: true,
 303       poster: window.location.origin + videoInfo.previewPath,
 304       theaterMode: false
 305     })
 306
 307     this.playerOptions = videojsOptions
 308     this.player = vjs(this.videoContainerId, videojsOptions, () => {
 309       this.player.on('customError', (event: any, data: any) => this.handleError(data.err))
 310
 311       window[ 'videojsPlayer' ] = this.player
 312
 313       if (this.controls) {
 314         this.player.dock({
 315           title: videoInfo.name,
 316           description: this.player.localize('Uses P2P, others may know your IP is downloading this video.')
 317         })
 318       }
 319
 320       addContextMenu(this.player, window.location.origin + videoInfo.embedPath)
 321
 322       this.initializeApi()
 323     })
 324   }
 325
 326   private handleError (err: Error) {
 327     if (err.message.indexOf('from xs param') !== -1) {
 328       this.player.dispose()
 329       this.videoElement = null
 330       this.displayError('This video is not available because the remote instance is not responding.')
 331       return
 332     }
 333   }
 334 }
 335
 336 PeerTubeEmbed.main()
 337   .catch(err => console.error('Cannot init embed.', err))