1 import execa from 'execa'
2 import { ensureDir, pathExists, writeFile } from 'fs-extra'
3 import { dirname, join } from 'path'
4 import { CONFIG } from '@server/initializers/config'
5 import { VideoResolution } from '@shared/models'
6 import { logger, loggerTagsFactory } from '../logger'
7 import { getProxy, isProxyEnabled } from '../proxy'
8 import { isBinaryResponse, peertubeGot } from '../requests'
10 const lTags = loggerTagsFactory('youtube-dl')
12 const youtubeDLBinaryPath = join(CONFIG.STORAGE.BIN_DIR, CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.NAME)
14 export class YoutubeDLCLI {
16 static async safeGet () {
17 if (!await pathExists(youtubeDLBinaryPath)) {
18 await ensureDir(dirname(youtubeDLBinaryPath))
20 await this.updateYoutubeDLBinary()
23 return new YoutubeDLCLI()
26 static async updateYoutubeDLBinary () {
27 const url = CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.URL
29 logger.info('Updating youtubeDL binary from %s.', url, lTags())
31 const gotOptions = { context: { bodyKBLimit: 20_000 }, responseType: 'buffer' as 'buffer' }
34 let gotResult = await peertubeGot(url, gotOptions)
36 if (!isBinaryResponse(gotResult)) {
37 const json = JSON.parse(gotResult.body.toString())
38 const latest = json.filter(release => release.prerelease === false)[0]
39 if (!latest) throw new Error('Cannot find latest release')
41 const releaseName = CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.NAME
42 const releaseAsset = latest.assets.find(a => a.name === releaseName)
43 if (!releaseAsset) throw new Error(`Cannot find appropriate release with name ${releaseName} in release assets`)
45 gotResult = await peertubeGot(releaseAsset.browser_download_url, gotOptions)
48 if (!isBinaryResponse(gotResult)) {
49 throw new Error('Not a binary response')
52 await writeFile(youtubeDLBinaryPath, gotResult.body)
54 logger.info('youtube-dl updated %s.', youtubeDLBinaryPath, lTags())
56 logger.error('Cannot update youtube-dl from %s.', url, { err, ...lTags() })
60 static getYoutubeDLVideoFormat (enabledResolutions: VideoResolution[], useBestFormat: boolean) {
62 * list of format selectors in order or preference
63 * see https://github.com/ytdl-org/youtube-dl#format-selection
65 * case #1 asks for a mp4 using h264 (avc1) and the exact resolution in the hope
66 * of being able to do a "quick-transcode"
67 * case #2 is the first fallback. No "quick-transcode" means we can get anything else (like vp9)
68 * case #3 is the resolution-degraded equivalent of #1, and already a pretty safe fallback
70 * in any case we avoid AV1, see https://github.com/Chocobozzz/PeerTube/issues/3499
73 let result: string[] = []
76 const resolution = enabledResolutions.length === 0
77 ? VideoResolution.H_720P
78 : Math.max(...enabledResolutions)
81 `bestvideo[vcodec^=avc1][height=${resolution}]+bestaudio[ext=m4a]`, // case #1
82 `bestvideo[vcodec!*=av01][vcodec!*=vp9.2][height=${resolution}]+bestaudio`, // case #2
83 `bestvideo[vcodec^=avc1][height<=${resolution}]+bestaudio[ext=m4a]` // case #
87 return result.concat([
88 'bestvideo[vcodec!*=av01][vcodec!*=vp9.2]+bestaudio',
89 'best[vcodec!*=av01][vcodec!*=vp9.2]', // case fallback for known formats
90 'bestvideo[ext=mp4]+bestaudio[ext=m4a]',
91 'best' // Ultimate fallback
95 private constructor () {
103 processOptions: execa.NodeOptions
105 additionalYoutubeDLArgs?: string[]
107 let args = options.additionalYoutubeDLArgs || []
108 args = args.concat([ '--merge-output-format', 'mp4', '-f', options.format, '-o', options.output ])
112 processOptions: options.processOptions,
113 timeout: options.timeout,
118 async getInfo (options: {
121 processOptions: execa.NodeOptions
122 additionalYoutubeDLArgs?: string[]
124 const { url, format, additionalYoutubeDLArgs = [], processOptions } = options
126 const completeArgs = additionalYoutubeDLArgs.concat([ '--dump-json', '-f', format ])
128 const data = await this.run({ url, args: completeArgs, processOptions })
129 if (!data) return undefined
131 const info = data.map(this.parseInfo)
133 return info.length === 1
138 getListInfo (options: {
140 latestVideosCount?: number
141 processOptions: execa.NodeOptions
142 }): Promise<{ upload_date: string, webpage_url: string }[]> {
143 const additionalYoutubeDLArgs = [ '--skip-download', '--playlist-reverse' ]
145 if (CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.NAME === 'yt-dlp') {
146 // Optimize listing videos only when using yt-dlp because it is bugged with youtube-dl when fetching a channel
147 additionalYoutubeDLArgs.push('--flat-playlist')
150 if (options.latestVideosCount !== undefined) {
151 additionalYoutubeDLArgs.push('--playlist-end', options.latestVideosCount.toString())
154 return this.getInfo({
156 format: YoutubeDLCLI.getYoutubeDLVideoFormat([], false),
157 processOptions: options.processOptions,
158 additionalYoutubeDLArgs
162 async getSubs (options: {
165 processOptions: execa.NodeOptions
167 const { url, format, processOptions } = options
169 const args = [ '--skip-download', '--all-subs', `--sub-format=${format}` ]
171 const data = await this.run({ url, args, processOptions })
172 const files: string[] = []
174 const skipString = '[info] Writing video subtitles to: '
176 for (let i = 0, len = data.length; i < len; i++) {
179 if (line.indexOf(skipString) === 0) {
180 files.push(line.slice(skipString.length))
187 private async run (options: {
191 processOptions: execa.NodeOptions
193 const { url, args, timeout, processOptions } = options
195 let completeArgs = this.wrapWithProxyOptions(args)
196 completeArgs = this.wrapWithIPOptions(completeArgs)
197 completeArgs = this.wrapWithFFmpegOptions(completeArgs)
199 const { PYTHON_PATH } = CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE
200 const subProcess = execa(PYTHON_PATH, [ youtubeDLBinaryPath, ...completeArgs, url ], processOptions)
203 setTimeout(() => subProcess.cancel(), timeout)
206 const output = await subProcess
208 logger.debug('Run youtube-dl command.', { command: output.command, ...lTags() })
211 ? output.stdout.trim().split(/\r?\n/)
215 private wrapWithProxyOptions (args: string[]) {
216 if (isProxyEnabled()) {
217 logger.debug('Using proxy %s for YoutubeDL', getProxy(), lTags())
219 return [ '--proxy', getProxy() ].concat(args)
225 private wrapWithIPOptions (args: string[]) {
226 if (CONFIG.IMPORT.VIDEOS.HTTP.FORCE_IPV4) {
227 logger.debug('Force ipv4 for YoutubeDL')
229 return [ '--force-ipv4' ].concat(args)
235 private wrapWithFFmpegOptions (args: string[]) {
236 if (process.env.FFMPEG_PATH) {
237 logger.debug('Using ffmpeg location %s for YoutubeDL', process.env.FFMPEG_PATH, lTags())
239 return [ '--ffmpeg-location', process.env.FFMPEG_PATH ].concat(args)
245 private parseInfo (data: string) {
246 return JSON.parse(data)