PeerTube/server/helpers/video.ts

140 lines
5.0 KiB
TypeScript
Raw Normal View History

import { Response } from 'express'
import { CONFIG } from '@server/initializers/config'
import { DEFAULT_AUDIO_RESOLUTION } from '@server/initializers/constants'
import { JobQueue } from '@server/lib/job-queue'
2019-08-20 13:52:49 +02:00
import {
2020-04-23 09:32:53 +02:00
isStreamingPlaylist,
MStreamingPlaylistVideo,
MVideo,
2019-08-20 13:52:49 +02:00
MVideoAccountLightBlacklistAllFiles,
2020-04-23 09:32:53 +02:00
MVideoFile,
2019-08-20 13:52:49 +02:00
MVideoFullLight,
MVideoIdThumbnail,
2020-04-23 09:32:53 +02:00
MVideoImmutable,
2019-08-20 13:52:49 +02:00
MVideoThumbnail,
2020-04-23 09:32:53 +02:00
MVideoWithRights
2020-06-18 10:45:25 +02:00
} from '@server/types/models'
2020-11-04 14:16:57 +01:00
import { VideoPrivacy, VideoState, VideoTranscodingPayload } from '@shared/models'
import { VideoModel } from '../models/video/video'
2018-09-19 11:16:23 +02:00
type VideoFetchType = 'all' | 'only-video' | 'only-video-with-rights' | 'id' | 'none' | 'only-immutable-attributes'
2018-09-19 11:16:23 +02:00
2020-12-08 14:30:29 +01:00
function fetchVideo (id: number | string, fetchType: 'all', userId?: number): Promise<MVideoFullLight>
function fetchVideo (id: number | string, fetchType: 'only-immutable-attributes'): Promise<MVideoImmutable>
function fetchVideo (id: number | string, fetchType: 'only-video', userId?: number): Promise<MVideoThumbnail>
function fetchVideo (id: number | string, fetchType: 'only-video-with-rights', userId?: number): Promise<MVideoWithRights>
function fetchVideo (id: number | string, fetchType: 'id' | 'none', userId?: number): Promise<MVideoIdThumbnail>
2019-08-15 11:53:26 +02:00
function fetchVideo (
id: number | string,
fetchType: VideoFetchType,
userId?: number
2020-12-08 14:30:29 +01:00
): Promise<MVideoFullLight | MVideoThumbnail | MVideoWithRights | MVideoIdThumbnail | MVideoImmutable>
2019-08-15 11:53:26 +02:00
function fetchVideo (
id: number | string,
fetchType: VideoFetchType,
userId?: number
2020-12-08 14:30:29 +01:00
): Promise<MVideoFullLight | MVideoThumbnail | MVideoWithRights | MVideoIdThumbnail | MVideoImmutable> {
2018-10-05 11:15:06 +02:00
if (fetchType === 'all') return VideoModel.loadAndPopulateAccountAndServerAndTags(id, undefined, userId)
2018-09-19 11:16:23 +02:00
if (fetchType === 'only-immutable-attributes') return VideoModel.loadImmutableAttributes(id)
2019-01-29 08:37:25 +01:00
if (fetchType === 'only-video-with-rights') return VideoModel.loadWithRights(id)
2018-09-19 11:16:23 +02:00
if (fetchType === 'only-video') return VideoModel.load(id)
if (fetchType === 'id' || fetchType === 'none') return VideoModel.loadOnlyId(id)
}
type VideoFetchByUrlType = 'all' | 'only-video' | 'only-immutable-attributes'
2019-08-15 11:53:26 +02:00
2020-12-08 14:30:29 +01:00
function fetchVideoByUrl (url: string, fetchType: 'all'): Promise<MVideoAccountLightBlacklistAllFiles>
function fetchVideoByUrl (url: string, fetchType: 'only-immutable-attributes'): Promise<MVideoImmutable>
function fetchVideoByUrl (url: string, fetchType: 'only-video'): Promise<MVideoThumbnail>
function fetchVideoByUrl (
url: string,
fetchType: VideoFetchByUrlType
2020-12-08 14:30:29 +01:00
): Promise<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail | MVideoImmutable>
function fetchVideoByUrl (
url: string,
fetchType: VideoFetchByUrlType
2020-12-08 14:30:29 +01:00
): Promise<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail | MVideoImmutable> {
2018-09-19 11:16:23 +02:00
if (fetchType === 'all') return VideoModel.loadByUrlAndPopulateAccount(url)
if (fetchType === 'only-immutable-attributes') return VideoModel.loadByUrlImmutableAttributes(url)
2018-09-19 11:16:23 +02:00
if (fetchType === 'only-video') return VideoModel.loadByUrl(url)
}
2019-08-20 13:52:49 +02:00
function getVideoWithAttributes (res: Response) {
return res.locals.videoAll || res.locals.onlyVideo || res.locals.onlyVideoWithRights
}
2020-04-23 09:32:53 +02:00
function addOptimizeOrMergeAudioJob (video: MVideo, videoFile: MVideoFile) {
let dataInput: VideoTranscodingPayload
if (videoFile.isAudio()) {
dataInput = {
type: 'merge-audio' as 'merge-audio',
resolution: DEFAULT_AUDIO_RESOLUTION,
videoUUID: video.uuid,
isNewVideo: true
}
} else {
dataInput = {
type: 'optimize' as 'optimize',
videoUUID: video.uuid,
isNewVideo: true
}
}
return JobQueue.Instance.createJobWithPromise({ type: 'video-transcoding', payload: dataInput })
}
function extractVideo (videoOrPlaylist: MVideo | MStreamingPlaylistVideo) {
return isStreamingPlaylist(videoOrPlaylist)
? videoOrPlaylist.Video
: videoOrPlaylist
}
function isPrivacyForFederation (privacy: VideoPrivacy) {
const castedPrivacy = parseInt(privacy + '', 10)
return castedPrivacy === VideoPrivacy.PUBLIC ||
(CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true && castedPrivacy === VideoPrivacy.UNLISTED)
}
2020-11-04 14:16:57 +01:00
function isStateForFederation (state: VideoState) {
const castedState = parseInt(state + '', 10)
return castedState === VideoState.PUBLISHED || castedState === VideoState.WAITING_FOR_LIVE || castedState === VideoState.LIVE_ENDED
}
function getPrivaciesForFederation () {
return (CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true)
? [ { privacy: VideoPrivacy.PUBLIC }, { privacy: VideoPrivacy.UNLISTED } ]
: [ { privacy: VideoPrivacy.PUBLIC } ]
}
function getExtFromMimetype (mimeTypes: { [id: string]: string | string[] }, mimeType: string) {
const value = mimeTypes[mimeType]
if (Array.isArray(value)) return value[0]
return value
}
2018-09-19 11:16:23 +02:00
export {
VideoFetchType,
VideoFetchByUrlType,
fetchVideo,
2019-08-20 13:52:49 +02:00
getVideoWithAttributes,
2020-04-23 09:32:53 +02:00
fetchVideoByUrl,
addOptimizeOrMergeAudioJob,
extractVideo,
getExtFromMimetype,
2020-11-04 14:16:57 +01:00
isStateForFederation,
isPrivacyForFederation,
getPrivaciesForFederation
2018-09-19 11:16:23 +02:00
}