Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Add feature to flip the video horizontally (#7478)

Jeffrey Cheung4474bf1a5e30
diff --git a/client/src/standalone/player/src/peertube-player.ts b/client/src/standalone/player/src/peertube-player.ts
index 7aad5fa566..f882235900 100644
--- a/client/src/standalone/player/src/peertube-player.ts
+++ b/client/src/standalone/player/src/peertube-player.ts
@@ -30,12 +30,14 @@ import './shared/nsfw/peertube-nsfw-plugin'
import './shared/p2p-media-loader/hls-plugin'
import './shared/p2p-media-loader/p2p-media-loader-plugin'
import './shared/peertube/peertube-plugin'
+import './shared/video-filter/video-flip-horizontally-plugin'
import { ControlBarOptionsBuilder, HLSOptionsBuilder, WebVideoOptionsBuilder } from './shared/player-options-builder'
import './shared/playlist/playlist-plugin'
import './shared/resolutions/peertube-resolutions-plugin'
import './shared/settings/menu-focus-fixed'
import './shared/settings/resolution-menu-button'
import './shared/settings/resolution-menu-item'
+import './shared/video-filter/video-filter-menu-button'
import './shared/settings/settings-dialog'
import './shared/settings/settings-menu-button'
import './shared/settings/settings-menu-item'
@@ -271,6 +273,7 @@ export class PeerTubePlayer {
if (!this.player) return
if (this.player.usingPlugin('peertubeMobile')) this.player.peertubeMobile().dispose()
+ if (this.player.usingPlugin('videoFlipHorizontallyPlugin')) this.player.videoFlipHorizontallyPlugin().dispose()
if (this.player.usingPlugin('peerTubeHotkeysPlugin')) this.player.peerTubeHotkeysPlugin().dispose()
if (this.player.usingPlugin('playlist')) this.player.playlist().dispose()
if (this.player.usingPlugin('bezels')) this.player.bezels().dispose()
@@ -300,6 +303,8 @@ export class PeerTubePlayer {
p2pEnabled: this.currentLoadOptions.p2pEnabled
})
+ this.player.videoFlipHorizontallyPlugin()
+
if (this.options.enableHotkeys === true) {
this.player.peerTubeHotkeysPlugin({
isLive: this.currentLoadOptions.isLive,
diff --git a/client/src/standalone/player/src/sass/shared/index.scss b/client/src/standalone/player/src/sass/shared/index.scss
index 27a3ee6d44..ca1d63d762 100644
--- a/client/src/standalone/player/src/sass/shared/index.scss
+++ b/client/src/standalone/player/src/sass/shared/index.scss
@@ -12,3 +12,4 @@
@use './stats';
@use './offline-notification';
@use './storyboard.scss';
+@use './video-filter.scss';
diff --git a/client/src/standalone/player/src/sass/shared/settings-menu.scss b/client/src/standalone/player/src/sass/shared/settings-menu.scss
index d990b7e80d..05129e5371 100644
--- a/client/src/standalone/player/src/sass/shared/settings-menu.scss
+++ b/client/src/standalone/player/src/sass/shared/settings-menu.scss
@@ -64,7 +64,7 @@ $setting-transition-easing: ease-out;
.vjs-settings-panel-child {
display: flex;
- align-items: flex-end;
+ align-items: flex-start;
white-space: nowrap;
&:focus,
@@ -171,7 +171,8 @@ $setting-transition-easing: ease-out;
}
}
- &.vjs-resolution-button {
+ &.vjs-resolution-button,
+ &.vjs-video-filter-button {
.vjs-menu-item-text {
@include margin-left(25px);
}
diff --git a/client/src/standalone/player/src/sass/shared/video-filter.scss b/client/src/standalone/player/src/sass/shared/video-filter.scss
new file mode 100644
index 0000000000..f4a9100ea5
--- /dev/null
+++ b/client/src/standalone/player/src/sass/shared/video-filter.scss
@@ -0,0 +1,6 @@
+.vjs-video-flip-horizontally {
+ video,
+ .vjs-poster img {
+ transform: scaleX(-1);
+ }
+}
diff --git a/client/src/standalone/player/src/shared/hotkeys/peertube-hotkeys-plugin.ts b/client/src/standalone/player/src/shared/hotkeys/peertube-hotkeys-plugin.ts
index d15249edf4..01ddea8fb7 100644
--- a/client/src/standalone/player/src/shared/hotkeys/peertube-hotkeys-plugin.ts
+++ b/client/src/standalone/player/src/shared/hotkeys/peertube-hotkeys-plugin.ts
@@ -154,6 +154,16 @@ class PeerTubeHotkeysPlugin extends Plugin {
const dist = 1 / 30
this.player.currentTime(this.player.currentTime() + dist)
}
+ },
+
+ // Flip horizontally
+ {
+ accept: e => this.isNaked(e, 'h'),
+ cb: () => {
+ if (this.player.usingPlugin('videoFlipHorizontallyPlugin')) {
+ this.player.videoFlipHorizontallyPlugin().toggleFlip()
+ }
+ }
}
]
diff --git a/client/src/standalone/player/src/shared/player-options-builder/control-bar-options-builder.ts b/client/src/standalone/player/src/shared/player-options-builder/control-bar-options-builder.ts
index 0c7216d1f1..6fa8cccee4 100644
--- a/client/src/standalone/player/src/shared/player-options-builder/control-bar-options-builder.ts
+++ b/client/src/standalone/player/src/shared/player-options-builder/control-bar-options-builder.ts
@@ -58,6 +58,7 @@ export class ControlBarOptionsBuilder {
settingEntries.push('playbackRateMenuButton')
settingEntries.push('captionsButton')
settingEntries.push('resolutionMenuButton')
+ settingEntries.push('videoFilterMenuButton')
return {
settingsButton: {
diff --git a/client/src/standalone/player/src/shared/settings/settings-menu-item.ts b/client/src/standalone/player/src/shared/settings/settings-menu-item.ts
index c1ee4cf75a..2a9f13ad7e 100644
--- a/client/src/standalone/player/src/shared/settings/settings-menu-item.ts
+++ b/client/src/standalone/player/src/shared/settings/settings-menu-item.ts
@@ -277,6 +277,8 @@ class SettingsMenuItem extends MenuItem {
if (this.subMenu.name() === 'PlaybackRateMenuButton') {
this.settingsSubMenuValueEl_.innerHTML = (this.subMenu as any).labelEl_.textContent
} else {
+ let innerHTML = ''
+
// Loop through the submenu items to find the selected child
for (const subMenuItem of this.subMenu.menu.children_) {
if (!(subMenuItem instanceof MenuItem)) {
@@ -287,13 +289,14 @@ class SettingsMenuItem extends MenuItem {
if (subMenuItemExtended.isSelected_) {
// Prefer to use the function
if (typeof subMenuItemExtended.getLabel === 'function') {
- this.settingsSubMenuValueEl_.innerHTML = subMenuItemExtended.getLabel()
- break
+ innerHTML += subMenuItemExtended.getLabel()
+ } else {
+ innerHTML += this.player().localize(subMenuItemExtended.options_.label)
}
-
- this.settingsSubMenuValueEl_.innerHTML = this.player().localize(subMenuItemExtended.options_.label)
}
}
+
+ this.settingsSubMenuValueEl_.innerHTML = innerHTML
}
let target: HTMLElement = null
diff --git a/client/src/standalone/player/src/shared/video-filter/video-filter-menu-button.ts b/client/src/standalone/player/src/shared/video-filter/video-filter-menu-button.ts
new file mode 100644
index 0000000000..c385232dc0
--- /dev/null
+++ b/client/src/standalone/player/src/shared/video-filter/video-filter-menu-button.ts
@@ -0,0 +1,46 @@
+import videojs from 'video.js'
+import { VideojsButtonOptions, VideojsMenu, VideojsMenuButton, VideojsPlayer } from '../../types'
+import { VideoFilterMenuItem } from './video-filter-menu-item'
+
+const Menu = videojs.getComponent('Menu') as typeof VideojsMenu
+const MenuButton = videojs.getComponent('MenuButton') as typeof VideojsMenuButton
+
+class VideoFilterMenuButton extends MenuButton {
+ declare labelEl_: HTMLElement
+
+ constructor (player: VideojsPlayer, options: VideojsButtonOptions) {
+ super(player, options)
+
+ this.controlText(this.player().localize('Video Filter'))
+ }
+
+ createMenu () {
+ const menu = new Menu(this.player_, { menuButton: this })
+
+ const item = new VideoFilterMenuItem(this.player_, {
+ label: this.player().localize('Mirror Video'),
+ menuLabel: this.player().localize('Mirror'),
+ videoFilter: 'video-flip-horizontally'
+ })
+
+ item.on('selected-updated', () => {
+ this.trigger('label-updated')
+ })
+
+ menu.addItem(item)
+
+ return menu
+ }
+
+ buildCSSClass () {
+ return 'vjs-video-filter-button ' + super.buildCSSClass()
+ }
+
+ buildWrapperCSSClass () {
+ return 'vjs-video-filter-control ' + super.buildWrapperCSSClass()
+ }
+}
+
+videojs.registerComponent('VideoFilterMenuButton', VideoFilterMenuButton)
+
+export { VideoFilterMenuButton }
diff --git a/client/src/standalone/player/src/shared/video-filter/video-filter-menu-item.ts b/client/src/standalone/player/src/shared/video-filter/video-filter-menu-item.ts
new file mode 100644
index 0000000000..2f2799e369
--- /dev/null
+++ b/client/src/standalone/player/src/shared/video-filter/video-filter-menu-item.ts
@@ -0,0 +1,48 @@
+import videojs from 'video.js'
+import type { VideojsMenuItem, VideojsPlayer, VideojsMenuItemOptions } from '../../types'
+
+const MenuItem = videojs.getComponent('MenuItem') as typeof VideojsMenuItem
+
+export interface VideoFilterMenuItemMenuItemOptions extends VideojsMenuItemOptions {
+ videoFilter?: string
+}
+
+class VideoFilterMenuItem extends MenuItem {
+ menuLabel: string
+ videoFilter: string
+
+ constructor (player: VideojsPlayer, options?: VideoFilterMenuItemMenuItemOptions) {
+ super(player, { ...options, selectable: true })
+
+ this.videoFilter = options.videoFilter || ''
+ this.menuLabel = options.menuLabel || ''
+
+ this.player().on(`${this.videoFilter}-on`, () => {
+ this.selected(true)
+
+ this.trigger('selected-updated')
+ })
+
+ this.player().on(`${this.videoFilter}-off`, () => {
+ this.selected(false)
+
+ this.trigger('selected-updated')
+ })
+ }
+
+ handleClick (): void {
+ if (this.isSelected_) {
+ this.player_.trigger(`${this.videoFilter}-off`)
+ } else {
+ this.player_.trigger(`${this.videoFilter}-on`)
+ }
+ }
+
+ getLabel () {
+ return this.menuLabel
+ }
+}
+
+videojs.registerComponent('VideoFilterMenuItem', VideoFilterMenuItem)
+
+export { VideoFilterMenuItem }
diff --git a/client/src/standalone/player/src/shared/video-filter/video-flip-horizontally-plugin.ts b/client/src/standalone/player/src/shared/video-filter/video-flip-horizontally-plugin.ts
new file mode 100644
index 0000000000..9365b4f720
--- /dev/null
+++ b/client/src/standalone/player/src/shared/video-filter/video-flip-horizontally-plugin.ts
@@ -0,0 +1,44 @@
+import videojs from 'video.js'
+import { VideojsPlayer, type VideojsPlugin } from '../../types'
+
+const Plugin = videojs.getPlugin('plugin') as typeof VideojsPlugin
+
+class VideoFlipHorizontallyPlugin extends Plugin {
+ constructor (player: VideojsPlayer) {
+ super(player)
+
+ player.on('video-flip-horizontally-on', () => {
+ this.player.addClass('vjs-video-flip-horizontally')
+ })
+
+ player.on('video-flip-horizontally-off', () => {
+ this.player.removeClass('vjs-video-flip-horizontally')
+ })
+ }
+
+ enableFlip () {
+ this.player.trigger('video-flip-horizontally-on')
+ }
+
+ disableFlip () {
+ this.player.trigger('video-flip-horizontally-off')
+ }
+
+ toggleFlip () {
+ if (this.player.hasClass('vjs-video-flip-horizontally')) {
+ this.disableFlip()
+ } else {
+ this.enableFlip()
+ }
+ }
+
+ dispose (): void {
+ this.player.removeClass('vjs-video-flip-horizontally')
+
+ super.dispose()
+ }
+}
+
+videojs.registerPlugin('videoFlipHorizontallyPlugin', VideoFlipHorizontallyPlugin)
+
+export { VideoFlipHorizontallyPlugin }
diff --git a/client/src/standalone/player/src/types/peertube-videojs-typings.ts b/client/src/standalone/player/src/types/peertube-videojs-typings.ts
index 71942d9201..1a51028e13 100644
--- a/client/src/standalone/player/src/types/peertube-videojs-typings.ts
+++ b/client/src/standalone/player/src/types/peertube-videojs-typings.ts
@@ -39,6 +39,7 @@ import { StatsCardOptions } from '../shared/stats/stats-card'
import { StatsForNerdsPlugin } from '../shared/stats/stats-plugin'
import { UpNextPlugin } from '../shared/upnext/upnext-plugin'
import { WebVideoPlugin } from '../shared/web-video/web-video-plugin'
+import { VideoFlipHorizontallyPlugin } from '../shared/video-filter/video-flip-horizontally-plugin'
declare module 'video.js' {
export interface VideoJsPlayer {
@@ -357,6 +358,8 @@ export type VideojsPlayer = ReturnType<typeof videojs.getPlayer> & {
playlist(options?: PlaylistPluginOptions): PlaylistPlugin
+ videoFlipHorizontallyPlugin(): VideoFlipHorizontallyPlugin
+
// ---------------------------------------------------------------------------
theaterEnabled: boolean
diff --git a/scripts/i18n/create-custom-files.ts b/scripts/i18n/create-custom-files.ts
index 9e8d106ca8..7bcbde3def 100755
--- a/scripts/i18n/create-custom-files.ts
+++ b/scripts/i18n/create-custom-files.ts
@@ -99,7 +99,10 @@ const playerKeys = {
'Download speed:': 'Download speed:',
'Uploader note:': 'Uploader note:',
'Close': 'Close',
- '(skipped {1} buffers) ': '(skipped {1} buffers) '
+ '(skipped {1} buffers) ': '(skipped {1} buffers) ',
+ 'Video Filter': 'Video Filter',
+ 'Mirror Video': 'Mirror Video',
+ 'Mirror': 'Mirror'
}
Object.assign(playerKeys, videojs)