diff options
Diffstat (limited to 'server/helpers/youtube-dl/youtube-dl-wrapper.ts')
-rw-r--r-- | server/helpers/youtube-dl/youtube-dl-wrapper.ts | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/server/helpers/youtube-dl/youtube-dl-wrapper.ts b/server/helpers/youtube-dl/youtube-dl-wrapper.ts new file mode 100644 index 000000000..6960fbae4 --- /dev/null +++ b/server/helpers/youtube-dl/youtube-dl-wrapper.ts | |||
@@ -0,0 +1,135 @@ | |||
1 | import { move, pathExists, readdir, remove } from 'fs-extra' | ||
2 | import { dirname, join } from 'path' | ||
3 | import { CONFIG } from '@server/initializers/config' | ||
4 | import { isVideoFileExtnameValid } from '../custom-validators/videos' | ||
5 | import { logger, loggerTagsFactory } from '../logger' | ||
6 | import { generateVideoImportTmpPath } from '../utils' | ||
7 | import { YoutubeDLCLI } from './youtube-dl-cli' | ||
8 | import { YoutubeDLInfo, YoutubeDLInfoBuilder } from './youtube-dl-info-builder' | ||
9 | |||
10 | const lTags = loggerTagsFactory('youtube-dl') | ||
11 | |||
12 | export type YoutubeDLSubs = { | ||
13 | language: string | ||
14 | filename: string | ||
15 | path: string | ||
16 | }[] | ||
17 | |||
18 | const processOptions = { | ||
19 | maxBuffer: 1024 * 1024 * 10 // 10MB | ||
20 | } | ||
21 | |||
22 | class YoutubeDLWrapper { | ||
23 | |||
24 | constructor (private readonly url: string = '', private readonly enabledResolutions: number[] = []) { | ||
25 | |||
26 | } | ||
27 | |||
28 | async getInfoForDownload (youtubeDLArgs: string[] = []): Promise<YoutubeDLInfo> { | ||
29 | const youtubeDL = await YoutubeDLCLI.safeGet() | ||
30 | |||
31 | const info = await youtubeDL.getInfo({ | ||
32 | url: this.url, | ||
33 | format: YoutubeDLCLI.getYoutubeDLVideoFormat(this.enabledResolutions), | ||
34 | additionalYoutubeDLArgs: youtubeDLArgs, | ||
35 | processOptions | ||
36 | }) | ||
37 | |||
38 | if (info.is_live === true) throw new Error('Cannot download a live streaming.') | ||
39 | |||
40 | const infoBuilder = new YoutubeDLInfoBuilder(info) | ||
41 | |||
42 | return infoBuilder.getInfo() | ||
43 | } | ||
44 | |||
45 | async getSubtitles (): Promise<YoutubeDLSubs> { | ||
46 | const cwd = CONFIG.STORAGE.TMP_DIR | ||
47 | |||
48 | const youtubeDL = await YoutubeDLCLI.safeGet() | ||
49 | |||
50 | const files = await youtubeDL.getSubs({ url: this.url, format: 'vtt', processOptions: { cwd } }) | ||
51 | if (!files) return [] | ||
52 | |||
53 | logger.debug('Get subtitles from youtube dl.', { url: this.url, files, ...lTags() }) | ||
54 | |||
55 | const subtitles = files.reduce((acc, filename) => { | ||
56 | const matched = filename.match(/\.([a-z]{2})(-[a-z]+)?\.(vtt|ttml)/i) | ||
57 | if (!matched || !matched[1]) return acc | ||
58 | |||
59 | return [ | ||
60 | ...acc, | ||
61 | { | ||
62 | language: matched[1], | ||
63 | path: join(cwd, filename), | ||
64 | filename | ||
65 | } | ||
66 | ] | ||
67 | }, []) | ||
68 | |||
69 | return subtitles | ||
70 | } | ||
71 | |||
72 | async downloadVideo (fileExt: string, timeout: number): Promise<string> { | ||
73 | // Leave empty the extension, youtube-dl will add it | ||
74 | const pathWithoutExtension = generateVideoImportTmpPath(this.url, '') | ||
75 | |||
76 | let timer: NodeJS.Timeout | ||
77 | |||
78 | logger.info('Importing youtubeDL video %s to %s', this.url, pathWithoutExtension, lTags()) | ||
79 | |||
80 | const youtubeDL = await YoutubeDLCLI.safeGet() | ||
81 | |||
82 | const timeoutPromise = new Promise<string>((_, rej) => { | ||
83 | timer = setTimeout(() => rej(new Error('YoutubeDL download timeout.')), timeout) | ||
84 | }) | ||
85 | |||
86 | const downloadPromise = youtubeDL.download({ | ||
87 | url: this.url, | ||
88 | format: YoutubeDLCLI.getYoutubeDLVideoFormat(this.enabledResolutions), | ||
89 | output: pathWithoutExtension, | ||
90 | processOptions | ||
91 | }).then(() => clearTimeout(timer)) | ||
92 | .then(async () => { | ||
93 | // If youtube-dl did not guess an extension for our file, just use .mp4 as default | ||
94 | if (await pathExists(pathWithoutExtension)) { | ||
95 | await move(pathWithoutExtension, pathWithoutExtension + '.mp4') | ||
96 | } | ||
97 | |||
98 | return this.guessVideoPathWithExtension(pathWithoutExtension, fileExt) | ||
99 | }) | ||
100 | |||
101 | return Promise.race([ downloadPromise, timeoutPromise ]) | ||
102 | .catch(async err => { | ||
103 | const path = await this.guessVideoPathWithExtension(pathWithoutExtension, fileExt) | ||
104 | |||
105 | remove(path) | ||
106 | .catch(err => logger.error('Cannot remove file in youtubeDL timeout.', { err, ...lTags() })) | ||
107 | |||
108 | throw err | ||
109 | }) | ||
110 | } | ||
111 | |||
112 | private async guessVideoPathWithExtension (tmpPath: string, sourceExt: string) { | ||
113 | if (!isVideoFileExtnameValid(sourceExt)) { | ||
114 | throw new Error('Invalid video extension ' + sourceExt) | ||
115 | } | ||
116 | |||
117 | const extensions = [ sourceExt, '.mp4', '.mkv', '.webm' ] | ||
118 | |||
119 | for (const extension of extensions) { | ||
120 | const path = tmpPath + extension | ||
121 | |||
122 | if (await pathExists(path)) return path | ||
123 | } | ||
124 | |||
125 | const directoryContent = await readdir(dirname(tmpPath)) | ||
126 | |||
127 | throw new Error(`Cannot guess path of ${tmpPath}. Directory content: ${directoryContent.join(', ')}`) | ||
128 | } | ||
129 | } | ||
130 | |||
131 | // --------------------------------------------------------------------------- | ||
132 | |||
133 | export { | ||
134 | YoutubeDLWrapper | ||
135 | } | ||