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_invalid_format_specs(self):
306 def assert_syntax_error(format_spec):
307 ydl = YDL({'format': format_spec})
308 info_dict = _make_result([{'format_id': 'foo', 'url': TEST_URL}])
309 self.assertRaises(SyntaxError, ydl.process_ie_result, info_dict)
311 assert_syntax_error('bestvideo,,best')
312 assert_syntax_error('+bestaudio')
313 assert_syntax_error('bestvideo+')
315 def test_format_filtering(self):
317 {'format_id': 'A', 'filesize': 500, 'width': 1000},
318 {'format_id': 'B', 'filesize': 1000, 'width': 500},
319 {'format_id': 'C', 'filesize': 1000, 'width': 400},
320 {'format_id': 'D', 'filesize': 2000, 'width': 600},
321 {'format_id': 'E', 'filesize': 3000},
323 {'format_id': 'G', 'filesize': 1000000},
326 f['url'] = 'http://_/'
328 info_dict = _make_result(formats)
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'], 'D')
335 ydl = YDL({'format': 'best[filesize<=3000]'})
336 ydl.process_ie_result(info_dict)
337 downloaded = ydl.downloaded_info_dicts[0]
338 self.assertEqual(downloaded['format_id'], 'E')
340 ydl = YDL({'format': 'best[filesize <= ? 3000]'})
341 ydl.process_ie_result(info_dict)
342 downloaded = ydl.downloaded_info_dicts[0]
343 self.assertEqual(downloaded['format_id'], 'F')
345 ydl = YDL({'format': 'best [filesize = 1000] [width>450]'})
346 ydl.process_ie_result(info_dict)
347 downloaded = ydl.downloaded_info_dicts[0]
348 self.assertEqual(downloaded['format_id'], 'B')
350 ydl = YDL({'format': 'best [filesize = 1000] [width!=450]'})
351 ydl.process_ie_result(info_dict)
352 downloaded = ydl.downloaded_info_dicts[0]
353 self.assertEqual(downloaded['format_id'], 'C')
355 ydl = YDL({'format': '[filesize>?1]'})
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': '[filesize<1M]'})
361 ydl.process_ie_result(info_dict)
362 downloaded = ydl.downloaded_info_dicts[0]
363 self.assertEqual(downloaded['format_id'], 'E')
365 ydl = YDL({'format': '[filesize<1MiB]'})
366 ydl.process_ie_result(info_dict)
367 downloaded = ydl.downloaded_info_dicts[0]
368 self.assertEqual(downloaded['format_id'], 'G')
370 ydl = YDL({'format': 'all[width>=400][width<=600]'})
371 ydl.process_ie_result(info_dict)
372 downloaded_ids = [info['format_id'] for info in ydl.downloaded_info_dicts]
373 self.assertEqual(downloaded_ids, ['B', 'C', 'D'])
375 ydl = YDL({'format': 'best[height<40]'})
377 ydl.process_ie_result(info_dict)
378 except ExtractorError:
380 self.assertEqual(ydl.downloaded_info_dicts, [])
383 class TestYoutubeDL(unittest.TestCase):
384 def test_subtitles(self):
385 def s_formats(lang, autocaption=False):
388 'url': 'http://localhost/video.%s.%s' % (lang, ext),
389 '_auto': autocaption,
390 } for ext in ['vtt', 'srt', 'ass']]
391 subtitles = dict((l, s_formats(l)) for l in ['en', 'fr', 'es'])
392 auto_captions = dict((l, s_formats(l, True)) for l in ['it', 'pt', 'es'])
396 'url': 'http://localhost/video.mp4',
397 'subtitles': subtitles,
398 'automatic_captions': auto_captions,
402 def get_info(params={}):
403 params.setdefault('simulate', True)
405 ydl.report_warning = lambda *args, **kargs: None
406 return ydl.process_video_result(info_dict, download=False)
409 self.assertFalse(result.get('requested_subtitles'))
410 self.assertEqual(result['subtitles'], subtitles)
411 self.assertEqual(result['automatic_captions'], auto_captions)
413 result = get_info({'writesubtitles': True})
414 subs = result['requested_subtitles']
415 self.assertTrue(subs)
416 self.assertEqual(set(subs.keys()), set(['en']))
417 self.assertTrue(subs['en'].get('data') is None)
418 self.assertEqual(subs['en']['ext'], 'ass')
420 result = get_info({'writesubtitles': True, 'subtitlesformat': 'foo/srt'})
421 subs = result['requested_subtitles']
422 self.assertEqual(subs['en']['ext'], 'srt')
424 result = get_info({'writesubtitles': True, 'subtitleslangs': ['es', 'fr', 'it']})
425 subs = result['requested_subtitles']
426 self.assertTrue(subs)
427 self.assertEqual(set(subs.keys()), set(['es', 'fr']))
429 result = get_info({'writesubtitles': True, 'writeautomaticsub': True, 'subtitleslangs': ['es', 'pt']})
430 subs = result['requested_subtitles']
431 self.assertTrue(subs)
432 self.assertEqual(set(subs.keys()), set(['es', 'pt']))
433 self.assertFalse(subs['es']['_auto'])
434 self.assertTrue(subs['pt']['_auto'])
436 result = get_info({'writeautomaticsub': True, 'subtitleslangs': ['es', 'pt']})
437 subs = result['requested_subtitles']
438 self.assertTrue(subs)
439 self.assertEqual(set(subs.keys()), set(['es', 'pt']))
440 self.assertTrue(subs['es']['_auto'])
441 self.assertTrue(subs['pt']['_auto'])
443 def test_add_extra_info(self):
449 'playlist': 'funny videos',
451 YDL.add_extra_info(test_dict, extra_info)
452 self.assertEqual(test_dict['extractor'], 'Foo')
453 self.assertEqual(test_dict['playlist'], 'funny videos')
455 def test_prepare_filename(self):
463 ydl = YoutubeDL({'outtmpl': templ})
464 return ydl.prepare_filename(info)
465 self.assertEqual(fname('%(id)s.%(ext)s'), '1234.mp4')
466 self.assertEqual(fname('%(id)s-%(width)s.%(ext)s'), '1234-NA.mp4')
467 # Replace missing fields with 'NA'
468 self.assertEqual(fname('%(uploader_date)s-%(id)s.%(ext)s'), 'NA-1234.mp4')
470 def test_format_note(self):
472 self.assertEqual(ydl._format_note({}), '')
473 assertRegexpMatches(self, ydl._format_note({
477 def test_postprocessors(self):
478 filename = 'post-processor-testfile.mp4'
479 audiofile = filename + '.mp3'
481 class SimplePP(PostProcessor):
483 with open(audiofile, 'wt') as f:
485 return [info['filepath']], info
487 def run_pp(params, PP):
488 with open(filename, 'wt') as f:
490 ydl = YoutubeDL(params)
491 ydl.add_post_processor(PP())
492 ydl.post_process(filename, {'filepath': filename})
494 run_pp({'keepvideo': True}, SimplePP)
495 self.assertTrue(os.path.exists(filename), '%s doesn\'t exist' % filename)
496 self.assertTrue(os.path.exists(audiofile), '%s doesn\'t exist' % audiofile)
500 run_pp({'keepvideo': False}, SimplePP)
501 self.assertFalse(os.path.exists(filename), '%s exists' % filename)
502 self.assertTrue(os.path.exists(audiofile), '%s doesn\'t exist' % audiofile)
505 class ModifierPP(PostProcessor):
507 with open(info['filepath'], 'wt') as f:
511 run_pp({'keepvideo': False}, ModifierPP)
512 self.assertTrue(os.path.exists(filename), '%s doesn\'t exist' % filename)
515 def test_match_filter(self):
516 class FilterYDL(YDL):
517 def __init__(self, *args, **kwargs):
518 super(FilterYDL, self).__init__(*args, **kwargs)
519 self.params['simulate'] = True
521 def process_info(self, info_dict):
522 super(YDL, self).process_info(info_dict)
524 def _match_entry(self, info_dict, incomplete):
525 res = super(FilterYDL, self)._match_entry(info_dict, incomplete)
527 self.downloaded_info_dicts.append(info_dict)
536 'filesize': 10 * 1024,
544 'description': 'foo',
545 'filesize': 5 * 1024,
547 videos = [first, second]
549 def get_videos(filter_=None):
550 ydl = FilterYDL({'match_filter': filter_})
552 ydl.process_ie_result(v, download=True)
553 return [v['id'] for v in ydl.downloaded_info_dicts]
556 self.assertEqual(res, ['1', '2'])
562 return 'Video id is not 1'
564 self.assertEqual(res, ['1'])
566 f = match_filter_func('duration < 30')
568 self.assertEqual(res, ['2'])
570 f = match_filter_func('description = foo')
572 self.assertEqual(res, ['2'])
574 f = match_filter_func('description =? foo')
576 self.assertEqual(res, ['1', '2'])
578 f = match_filter_func('filesize > 5KiB')
580 self.assertEqual(res, ['1'])
582 def test_playlist_items_selection(self):
585 'title': compat_str(i),
587 } for i in range(1, 5)]
592 'extractor': 'test:playlist',
593 'extractor_key': 'test:playlist',
594 'webpage_url': 'http://example.com',
599 # make a copy because the dictionary can be modified
600 ydl.process_ie_result(playlist.copy())
601 return [int(v['id']) for v in ydl.downloaded_info_dicts]
604 self.assertEqual(result, [1, 2, 3, 4])
606 result = get_ids({'playlistend': 10})
607 self.assertEqual(result, [1, 2, 3, 4])
609 result = get_ids({'playlistend': 2})
610 self.assertEqual(result, [1, 2])
612 result = get_ids({'playliststart': 10})
613 self.assertEqual(result, [])
615 result = get_ids({'playliststart': 2})
616 self.assertEqual(result, [2, 3, 4])
618 result = get_ids({'playlist_items': '2-4'})
619 self.assertEqual(result, [2, 3, 4])
621 result = get_ids({'playlist_items': '2,4'})
622 self.assertEqual(result, [2, 4])
624 result = get_ids({'playlist_items': '10'})
625 self.assertEqual(result, [])
628 if __name__ == '__main__':