3 from __future__ import unicode_literals
5 # Allow direct execution
9 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
13 from test.helper import FakeYDL, assertRegexpMatches
14 from youtube_dl import YoutubeDL
15 from youtube_dl.compat import compat_str
16 from youtube_dl.extractor import YoutubeIE
17 from youtube_dl.postprocessor.common import PostProcessor
18 from youtube_dl.utils import ExtractorError, match_filter_func
20 TEST_URL = 'http://localhost/sample.mp4'
24 def __init__(self, *args, **kwargs):
25 super(YDL, self).__init__(*args, **kwargs)
26 self.downloaded_info_dicts = []
29 def process_info(self, info_dict):
30 self.downloaded_info_dicts.append(info_dict)
32 def to_screen(self, msg):
36 def _make_result(formats, **kwargs):
40 'title': 'testttitle',
41 'extractor': 'testex',
47 class TestFormatSelection(unittest.TestCase):
48 def test_prefer_free_formats(self):
49 # Same resolution => download webm
51 ydl.params['prefer_free_formats'] = True
53 {'ext': 'webm', 'height': 460, 'url': TEST_URL},
54 {'ext': 'mp4', 'height': 460, 'url': TEST_URL},
56 info_dict = _make_result(formats)
58 yie._sort_formats(info_dict['formats'])
59 ydl.process_ie_result(info_dict)
60 downloaded = ydl.downloaded_info_dicts[0]
61 self.assertEqual(downloaded['ext'], 'webm')
63 # Different resolution => download best quality (mp4)
65 ydl.params['prefer_free_formats'] = True
67 {'ext': 'webm', 'height': 720, 'url': TEST_URL},
68 {'ext': 'mp4', 'height': 1080, 'url': TEST_URL},
70 info_dict['formats'] = formats
72 yie._sort_formats(info_dict['formats'])
73 ydl.process_ie_result(info_dict)
74 downloaded = ydl.downloaded_info_dicts[0]
75 self.assertEqual(downloaded['ext'], 'mp4')
77 # No prefer_free_formats => prefer mp4 and flv for greater compatibility
79 ydl.params['prefer_free_formats'] = False
81 {'ext': 'webm', 'height': 720, 'url': TEST_URL},
82 {'ext': 'mp4', 'height': 720, 'url': TEST_URL},
83 {'ext': 'flv', 'height': 720, 'url': TEST_URL},
85 info_dict['formats'] = formats
87 yie._sort_formats(info_dict['formats'])
88 ydl.process_ie_result(info_dict)
89 downloaded = ydl.downloaded_info_dicts[0]
90 self.assertEqual(downloaded['ext'], 'mp4')
93 ydl.params['prefer_free_formats'] = False
95 {'ext': 'flv', 'height': 720, 'url': TEST_URL},
96 {'ext': 'webm', 'height': 720, 'url': TEST_URL},
98 info_dict['formats'] = formats
100 yie._sort_formats(info_dict['formats'])
101 ydl.process_ie_result(info_dict)
102 downloaded = ydl.downloaded_info_dicts[0]
103 self.assertEqual(downloaded['ext'], 'flv')
105 def test_format_selection(self):
107 {'format_id': '35', 'ext': 'mp4', 'preference': 1, 'url': TEST_URL},
108 {'format_id': '45', 'ext': 'webm', 'preference': 2, 'url': TEST_URL},
109 {'format_id': '47', 'ext': 'webm', 'preference': 3, 'url': TEST_URL},
110 {'format_id': '2', 'ext': 'flv', 'preference': 4, 'url': TEST_URL},
112 info_dict = _make_result(formats)
114 ydl = YDL({'format': '20/47'})
115 ydl.process_ie_result(info_dict.copy())
116 downloaded = ydl.downloaded_info_dicts[0]
117 self.assertEqual(downloaded['format_id'], '47')
119 ydl = YDL({'format': '20/71/worst'})
120 ydl.process_ie_result(info_dict.copy())
121 downloaded = ydl.downloaded_info_dicts[0]
122 self.assertEqual(downloaded['format_id'], '35')
125 ydl.process_ie_result(info_dict.copy())
126 downloaded = ydl.downloaded_info_dicts[0]
127 self.assertEqual(downloaded['format_id'], '2')
129 ydl = YDL({'format': 'webm/mp4'})
130 ydl.process_ie_result(info_dict.copy())
131 downloaded = ydl.downloaded_info_dicts[0]
132 self.assertEqual(downloaded['format_id'], '47')
134 ydl = YDL({'format': '3gp/40/mp4'})
135 ydl.process_ie_result(info_dict.copy())
136 downloaded = ydl.downloaded_info_dicts[0]
137 self.assertEqual(downloaded['format_id'], '35')
139 def test_format_selection_audio(self):
141 {'format_id': 'audio-low', 'ext': 'webm', 'preference': 1, 'vcodec': 'none', 'url': TEST_URL},
142 {'format_id': 'audio-mid', 'ext': 'webm', 'preference': 2, 'vcodec': 'none', 'url': TEST_URL},
143 {'format_id': 'audio-high', 'ext': 'flv', 'preference': 3, 'vcodec': 'none', 'url': TEST_URL},
144 {'format_id': 'vid', 'ext': 'mp4', 'preference': 4, 'url': TEST_URL},
146 info_dict = _make_result(formats)
148 ydl = YDL({'format': 'bestaudio'})
149 ydl.process_ie_result(info_dict.copy())
150 downloaded = ydl.downloaded_info_dicts[0]
151 self.assertEqual(downloaded['format_id'], 'audio-high')
153 ydl = YDL({'format': 'worstaudio'})
154 ydl.process_ie_result(info_dict.copy())
155 downloaded = ydl.downloaded_info_dicts[0]
156 self.assertEqual(downloaded['format_id'], 'audio-low')
159 {'format_id': 'vid-low', 'ext': 'mp4', 'preference': 1, 'url': TEST_URL},
160 {'format_id': 'vid-high', 'ext': 'mp4', 'preference': 2, 'url': TEST_URL},
162 info_dict = _make_result(formats)
164 ydl = YDL({'format': 'bestaudio/worstaudio/best'})
165 ydl.process_ie_result(info_dict.copy())
166 downloaded = ydl.downloaded_info_dicts[0]
167 self.assertEqual(downloaded['format_id'], 'vid-high')
169 def test_format_selection_audio_exts(self):
171 {'format_id': 'mp3-64', 'ext': 'mp3', 'abr': 64, 'url': 'http://_', 'vcodec': 'none'},
172 {'format_id': 'ogg-64', 'ext': 'ogg', 'abr': 64, 'url': 'http://_', 'vcodec': 'none'},
173 {'format_id': 'aac-64', 'ext': 'aac', 'abr': 64, 'url': 'http://_', 'vcodec': 'none'},
174 {'format_id': 'mp3-32', 'ext': 'mp3', 'abr': 32, 'url': 'http://_', 'vcodec': 'none'},
175 {'format_id': 'aac-32', 'ext': 'aac', 'abr': 32, 'url': 'http://_', 'vcodec': 'none'},
178 info_dict = _make_result(formats)
179 ydl = YDL({'format': 'best'})
181 ie._sort_formats(info_dict['formats'])
182 ydl.process_ie_result(copy.deepcopy(info_dict))
183 downloaded = ydl.downloaded_info_dicts[0]
184 self.assertEqual(downloaded['format_id'], 'aac-64')
186 ydl = YDL({'format': 'mp3'})
188 ie._sort_formats(info_dict['formats'])
189 ydl.process_ie_result(copy.deepcopy(info_dict))
190 downloaded = ydl.downloaded_info_dicts[0]
191 self.assertEqual(downloaded['format_id'], 'mp3-64')
193 ydl = YDL({'prefer_free_formats': True})
195 ie._sort_formats(info_dict['formats'])
196 ydl.process_ie_result(copy.deepcopy(info_dict))
197 downloaded = ydl.downloaded_info_dicts[0]
198 self.assertEqual(downloaded['format_id'], 'ogg-64')
200 def test_format_selection_video(self):
202 {'format_id': 'dash-video-low', 'ext': 'mp4', 'preference': 1, 'acodec': 'none', 'url': TEST_URL},
203 {'format_id': 'dash-video-high', 'ext': 'mp4', 'preference': 2, 'acodec': 'none', 'url': TEST_URL},
204 {'format_id': 'vid', 'ext': 'mp4', 'preference': 3, 'url': TEST_URL},
206 info_dict = _make_result(formats)
208 ydl = YDL({'format': 'bestvideo'})
209 ydl.process_ie_result(info_dict.copy())
210 downloaded = ydl.downloaded_info_dicts[0]
211 self.assertEqual(downloaded['format_id'], 'dash-video-high')
213 ydl = YDL({'format': 'worstvideo'})
214 ydl.process_ie_result(info_dict.copy())
215 downloaded = ydl.downloaded_info_dicts[0]
216 self.assertEqual(downloaded['format_id'], 'dash-video-low')
218 def test_youtube_format_selection(self):
220 '38', '37', '46', '22', '45', '35', '44', '18', '34', '43', '6', '5', '36', '17', '13',
221 # Apple HTTP Live Streaming
222 '96', '95', '94', '93', '92', '132', '151',
224 '85', '84', '102', '83', '101', '82', '100',
226 '137', '248', '136', '247', '135', '246',
227 '245', '244', '134', '243', '133', '242', '160',
229 '141', '172', '140', '171', '139',
232 def format_info(f_id):
233 info = YoutubeIE._formats[f_id].copy()
234 info['format_id'] = f_id
235 info['url'] = 'url:' + f_id
237 formats_order = [format_info(f_id) for f_id in order]
239 info_dict = _make_result(list(formats_order), extractor='youtube')
240 ydl = YDL({'format': 'bestvideo+bestaudio'})
242 yie._sort_formats(info_dict['formats'])
243 ydl.process_ie_result(info_dict)
244 downloaded = ydl.downloaded_info_dicts[0]
245 self.assertEqual(downloaded['format_id'], '137+141')
246 self.assertEqual(downloaded['ext'], 'mp4')
248 info_dict = _make_result(list(formats_order), extractor='youtube')
249 ydl = YDL({'format': 'bestvideo[height>=999999]+bestaudio/best'})
251 yie._sort_formats(info_dict['formats'])
252 ydl.process_ie_result(info_dict)
253 downloaded = ydl.downloaded_info_dicts[0]
254 self.assertEqual(downloaded['format_id'], '38')
256 info_dict = _make_result(list(formats_order), extractor='youtube')
257 ydl = YDL({'format': 'bestvideo/best,bestaudio'})
259 yie._sort_formats(info_dict['formats'])
260 ydl.process_ie_result(info_dict)
261 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
262 self.assertEqual(downloaded_ids, ['137', '141'])
264 info_dict = _make_result(list(formats_order), extractor='youtube')
265 ydl = YDL({'format': '(bestvideo[ext=mp4],bestvideo[ext=webm])+bestaudio'})
267 yie._sort_formats(info_dict['formats'])
268 ydl.process_ie_result(info_dict)
269 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
270 self.assertEqual(downloaded_ids, ['137+141', '248+141'])
272 info_dict = _make_result(list(formats_order), extractor='youtube')
273 ydl = YDL({'format': '(bestvideo[ext=mp4],bestvideo[ext=webm])[height<=720]+bestaudio'})
275 yie._sort_formats(info_dict['formats'])
276 ydl.process_ie_result(info_dict)
277 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
278 self.assertEqual(downloaded_ids, ['136+141', '247+141'])
280 info_dict = _make_result(list(formats_order), extractor='youtube')
281 ydl = YDL({'format': '(bestvideo[ext=none]/bestvideo[ext=webm])+bestaudio'})
283 yie._sort_formats(info_dict['formats'])
284 ydl.process_ie_result(info_dict)
285 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
286 self.assertEqual(downloaded_ids, ['248+141'])
288 for f1, f2 in zip(formats_order, formats_order[1:]):
289 info_dict = _make_result([f1, f2], extractor='youtube')
290 ydl = YDL({'format': 'best/bestvideo'})
292 yie._sort_formats(info_dict['formats'])
293 ydl.process_ie_result(info_dict)
294 downloaded = ydl.downloaded_info_dicts[0]
295 self.assertEqual(downloaded['format_id'], f1['format_id'])
297 info_dict = _make_result([f2, f1], extractor='youtube')
298 ydl = YDL({'format': 'best/bestvideo'})
300 yie._sort_formats(info_dict['formats'])
301 ydl.process_ie_result(info_dict)
302 downloaded = ydl.downloaded_info_dicts[0]
303 self.assertEqual(downloaded['format_id'], f1['format_id'])
305 def test_format_filtering(self):
307 {'format_id': 'A', 'filesize': 500, 'width': 1000},
308 {'format_id': 'B', 'filesize': 1000, 'width': 500},
309 {'format_id': 'C', 'filesize': 1000, 'width': 400},
310 {'format_id': 'D', 'filesize': 2000, 'width': 600},
311 {'format_id': 'E', 'filesize': 3000},
313 {'format_id': 'G', 'filesize': 1000000},
316 f['url'] = 'http://_/'
318 info_dict = _make_result(formats)
320 ydl = YDL({'format': 'best[filesize<3000]'})
321 ydl.process_ie_result(info_dict)
322 downloaded = ydl.downloaded_info_dicts[0]
323 self.assertEqual(downloaded['format_id'], 'D')
325 ydl = YDL({'format': 'best[filesize<=3000]'})
326 ydl.process_ie_result(info_dict)
327 downloaded = ydl.downloaded_info_dicts[0]
328 self.assertEqual(downloaded['format_id'], 'E')
330 ydl = YDL({'format': 'best[filesize <= ? 3000]'})
331 ydl.process_ie_result(info_dict)
332 downloaded = ydl.downloaded_info_dicts[0]
333 self.assertEqual(downloaded['format_id'], 'F')
335 ydl = YDL({'format': 'best [filesize = 1000] [width>450]'})
336 ydl.process_ie_result(info_dict)
337 downloaded = ydl.downloaded_info_dicts[0]
338 self.assertEqual(downloaded['format_id'], 'B')
340 ydl = YDL({'format': 'best [filesize = 1000] [width!=450]'})
341 ydl.process_ie_result(info_dict)
342 downloaded = ydl.downloaded_info_dicts[0]
343 self.assertEqual(downloaded['format_id'], 'C')
345 ydl = YDL({'format': '[filesize>?1]'})
346 ydl.process_ie_result(info_dict)
347 downloaded = ydl.downloaded_info_dicts[0]
348 self.assertEqual(downloaded['format_id'], 'G')
350 ydl = YDL({'format': '[filesize<1M]'})
351 ydl.process_ie_result(info_dict)
352 downloaded = ydl.downloaded_info_dicts[0]
353 self.assertEqual(downloaded['format_id'], 'E')
355 ydl = YDL({'format': '[filesize<1MiB]'})
356 ydl.process_ie_result(info_dict)
357 downloaded = ydl.downloaded_info_dicts[0]
358 self.assertEqual(downloaded['format_id'], 'G')
360 ydl = YDL({'format': 'all[width>=400][width<=600]'})
361 ydl.process_ie_result(info_dict)
362 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
363 self.assertEqual(downloaded_ids, ['B', 'C', 'D'])
365 ydl = YDL({'format': 'best[height<40]'})
367 ydl.process_ie_result(info_dict)
368 except ExtractorError:
370 self.assertEqual(ydl.downloaded_info_dicts, [])
373 class TestYoutubeDL(unittest.TestCase):
374 def test_subtitles(self):
375 def s_formats(lang, autocaption=False):
378 'url': 'http://localhost/video.%s.%s' % (lang, ext),
379 '_auto': autocaption,
380 } for ext in ['vtt', 'srt', 'ass']]
381 subtitles = dict((l, s_formats(l)) for l in ['en', 'fr', 'es'])
382 auto_captions = dict((l, s_formats(l, True)) for l in ['it', 'pt', 'es'])
386 'url': 'http://localhost/video.mp4',
387 'subtitles': subtitles,
388 'automatic_captions': auto_captions,
392 def get_info(params={}):
393 params.setdefault('simulate', True)
395 ydl.report_warning = lambda *args, **kargs: None
396 return ydl.process_video_result(info_dict, download=False)
399 self.assertFalse(result.get('requested_subtitles'))
400 self.assertEqual(result['subtitles'], subtitles)
401 self.assertEqual(result['automatic_captions'], auto_captions)
403 result = get_info({'writesubtitles': True})
404 subs = result['requested_subtitles']
405 self.assertTrue(subs)
406 self.assertEqual(set(subs.keys()), set(['en']))
407 self.assertTrue(subs['en'].get('data') is None)
408 self.assertEqual(subs['en']['ext'], 'ass')
410 result = get_info({'writesubtitles': True, 'subtitlesformat': 'foo/srt'})
411 subs = result['requested_subtitles']
412 self.assertEqual(subs['en']['ext'], 'srt')
414 result = get_info({'writesubtitles': True, 'subtitleslangs': ['es', 'fr', 'it']})
415 subs = result['requested_subtitles']
416 self.assertTrue(subs)
417 self.assertEqual(set(subs.keys()), set(['es', 'fr']))
419 result = get_info({'writesubtitles': True, 'writeautomaticsub': True, 'subtitleslangs': ['es', 'pt']})
420 subs = result['requested_subtitles']
421 self.assertTrue(subs)
422 self.assertEqual(set(subs.keys()), set(['es', 'pt']))
423 self.assertFalse(subs['es']['_auto'])
424 self.assertTrue(subs['pt']['_auto'])
426 result = get_info({'writeautomaticsub': True, 'subtitleslangs': ['es', 'pt']})
427 subs = result['requested_subtitles']
428 self.assertTrue(subs)
429 self.assertEqual(set(subs.keys()), set(['es', 'pt']))
430 self.assertTrue(subs['es']['_auto'])
431 self.assertTrue(subs['pt']['_auto'])
433 def test_add_extra_info(self):
439 'playlist': 'funny videos',
441 YDL.add_extra_info(test_dict, extra_info)
442 self.assertEqual(test_dict['extractor'], 'Foo')
443 self.assertEqual(test_dict['playlist'], 'funny videos')
445 def test_prepare_filename(self):
453 ydl = YoutubeDL({'outtmpl': templ})
454 return ydl.prepare_filename(info)
455 self.assertEqual(fname('%(id)s.%(ext)s'), '1234.mp4')
456 self.assertEqual(fname('%(id)s-%(width)s.%(ext)s'), '1234-NA.mp4')
457 # Replace missing fields with 'NA'
458 self.assertEqual(fname('%(uploader_date)s-%(id)s.%(ext)s'), 'NA-1234.mp4')
460 def test_format_note(self):
462 self.assertEqual(ydl._format_note({}), '')
463 assertRegexpMatches(self, ydl._format_note({
467 def test_postprocessors(self):
468 filename = 'post-processor-testfile.mp4'
469 audiofile = filename + '.mp3'
471 class SimplePP(PostProcessor):
473 with open(audiofile, 'wt') as f:
475 return [info['filepath']], info
477 def run_pp(params, PP):
478 with open(filename, 'wt') as f:
480 ydl = YoutubeDL(params)
481 ydl.add_post_processor(PP())
482 ydl.post_process(filename, {'filepath': filename})
484 run_pp({'keepvideo': True}, SimplePP)
485 self.assertTrue(os.path.exists(filename), '%s doesn\'t exist' % filename)
486 self.assertTrue(os.path.exists(audiofile), '%s doesn\'t exist' % audiofile)
490 run_pp({'keepvideo': False}, SimplePP)
491 self.assertFalse(os.path.exists(filename), '%s exists' % filename)
492 self.assertTrue(os.path.exists(audiofile), '%s doesn\'t exist' % audiofile)
495 class ModifierPP(PostProcessor):
497 with open(info['filepath'], 'wt') as f:
501 run_pp({'keepvideo': False}, ModifierPP)
502 self.assertTrue(os.path.exists(filename), '%s doesn\'t exist' % filename)
505 def test_match_filter(self):
506 class FilterYDL(YDL):
507 def __init__(self, *args, **kwargs):
508 super(FilterYDL, self).__init__(*args, **kwargs)
509 self.params['simulate'] = True
511 def process_info(self, info_dict):
512 super(YDL, self).process_info(info_dict)
514 def _match_entry(self, info_dict, incomplete):
515 res = super(FilterYDL, self)._match_entry(info_dict, incomplete)
517 self.downloaded_info_dicts.append(info_dict)
526 'filesize': 10 * 1024,
534 'description': 'foo',
535 'filesize': 5 * 1024,
537 videos = [first, second]
539 def get_videos(filter_=None):
540 ydl = FilterYDL({'match_filter': filter_})
542 ydl.process_ie_result(v, download=True)
543 return [v['id'] for v in ydl.downloaded_info_dicts]
546 self.assertEqual(res, ['1', '2'])
552 return 'Video id is not 1'
554 self.assertEqual(res, ['1'])
556 f = match_filter_func('duration < 30')
558 self.assertEqual(res, ['2'])
560 f = match_filter_func('description = foo')
562 self.assertEqual(res, ['2'])
564 f = match_filter_func('description =? foo')
566 self.assertEqual(res, ['1', '2'])
568 f = match_filter_func('filesize > 5KiB')
570 self.assertEqual(res, ['1'])
572 def test_playlist_items_selection(self):
575 'title': compat_str(i),
577 } for i in range(1, 5)]
582 'extractor': 'test:playlist',
583 'extractor_key': 'test:playlist',
584 'webpage_url': 'http://example.com',
589 # make a copy because the dictionary can be modified
590 ydl.process_ie_result(playlist.copy())
591 return [int(v['id']) for v in ydl.downloaded_info_dicts]
594 self.assertEqual(result, [1, 2, 3, 4])
596 result = get_ids({'playlistend': 10})
597 self.assertEqual(result, [1, 2, 3, 4])
599 result = get_ids({'playlistend': 2})
600 self.assertEqual(result, [1, 2])
602 result = get_ids({'playliststart': 10})
603 self.assertEqual(result, [])
605 result = get_ids({'playliststart': 2})
606 self.assertEqual(result, [2, 3, 4])
608 result = get_ids({'playlist_items': '2-4'})
609 self.assertEqual(result, [2, 3, 4])
611 result = get_ids({'playlist_items': '2,4'})
612 self.assertEqual(result, [2, 4])
614 result = get_ids({'playlist_items': '10'})
615 self.assertEqual(result, [])
618 if __name__ == '__main__':