[yt-dlp.git] / test / test_YoutubeDL.py

#!/usr/bin/env python

# Allow direct execution
import os
import sys
import unittest
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

from test.helper import FakeYDL
from youtube_dl import YoutubeDL
from youtube_dl.extractor import YoutubeIE


class YDL(FakeYDL):
    def __init__(self, *args, **kwargs):
        super(YDL, self).__init__(*args, **kwargs)
        self.downloaded_info_dicts = []
        self.msgs = []

    def process_info(self, info_dict):
        self.downloaded_info_dicts.append(info_dict)

    def to_screen(self, msg):
        self.msgs.append(msg)


class TestFormatSelection(unittest.TestCase):
    def test_prefer_free_formats(self):
        # Same resolution => download webm
        ydl = YDL()
        ydl.params['prefer_free_formats'] = True
        formats = [
            {u'ext': u'webm', u'height': 460},
            {u'ext': u'mp4',  u'height': 460},
        ]
        info_dict = {u'formats': formats, u'extractor': u'test'}
        yie = YoutubeIE(ydl)
        yie._sort_formats(info_dict['formats'])
        ydl.process_ie_result(info_dict)
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'ext'], u'webm')

        # Different resolution => download best quality (mp4)
        ydl = YDL()
        ydl.params['prefer_free_formats'] = True
        formats = [
            {u'ext': u'webm', u'height': 720},
            {u'ext': u'mp4', u'height': 1080},
        ]
        info_dict[u'formats'] = formats
        yie = YoutubeIE(ydl)
        yie._sort_formats(info_dict['formats'])
        ydl.process_ie_result(info_dict)
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'ext'], u'mp4')

        # No prefer_free_formats => prefer mp4 and flv for greater compatibilty
        ydl = YDL()
        ydl.params['prefer_free_formats'] = False
        formats = [
            {u'ext': u'webm', u'height': 720},
            {u'ext': u'mp4', u'height': 720},
            {u'ext': u'flv', u'height': 720},
        ]
        info_dict[u'formats'] = formats
        yie = YoutubeIE(ydl)
        yie._sort_formats(info_dict['formats'])
        ydl.process_ie_result(info_dict)
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'ext'], u'mp4')

        ydl = YDL()
        ydl.params['prefer_free_formats'] = False
        formats = [
            {u'ext': u'flv', u'height': 720},
            {u'ext': u'webm', u'height': 720},
        ]
        info_dict[u'formats'] = formats
        yie = YoutubeIE(ydl)
        yie._sort_formats(info_dict['formats'])
        ydl.process_ie_result(info_dict)
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'ext'], u'flv')

    def test_format_limit(self):
        formats = [
            {u'format_id': u'meh', u'url': u'http://example.com/meh', 'preference': 1},
            {u'format_id': u'good', u'url': u'http://example.com/good', 'preference': 2},
            {u'format_id': u'great', u'url': u'http://example.com/great', 'preference': 3},
            {u'format_id': u'excellent', u'url': u'http://example.com/exc', 'preference': 4},
        ]
        info_dict = {
            u'formats': formats, u'extractor': u'test', 'id': 'testvid'}

        ydl = YDL()
        ydl.process_ie_result(info_dict)
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'format_id'], u'excellent')

        ydl = YDL({'format_limit': 'good'})
        assert ydl.params['format_limit'] == 'good'
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'format_id'], u'good')

        ydl = YDL({'format_limit': 'great', 'format': 'all'})
        ydl.process_ie_result(info_dict.copy())
        self.assertEqual(ydl.downloaded_info_dicts[0][u'format_id'], u'meh')
        self.assertEqual(ydl.downloaded_info_dicts[1][u'format_id'], u'good')
        self.assertEqual(ydl.downloaded_info_dicts[2][u'format_id'], u'great')
        self.assertTrue('3' in ydl.msgs[0])

        ydl = YDL()
        ydl.params['format_limit'] = 'excellent'
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded[u'format_id'], u'excellent')

    def test_format_selection(self):
        formats = [
            {u'format_id': u'35', u'ext': u'mp4', 'preference': 1},
            {u'format_id': u'45', u'ext': u'webm', 'preference': 2},
            {u'format_id': u'47', u'ext': u'webm', 'preference': 3},
            {u'format_id': u'2', u'ext': u'flv', 'preference': 4},
        ]
        info_dict = {u'formats': formats, u'extractor': u'test'}

        ydl = YDL({'format': u'20/47'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'47')

        ydl = YDL({'format': u'20/71/worst'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'35')

        ydl = YDL()
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'2')

        ydl = YDL({'format': u'webm/mp4'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'47')

        ydl = YDL({'format': u'3gp/40/mp4'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'35')

    def test_format_selection_audio(self):
        formats = [
            {u'format_id': u'audio-low', u'ext': u'webm', 'preference': 1, 'vcodec': 'none'},
            {u'format_id': u'audio-mid', u'ext': u'webm', 'preference': 2, 'vcodec': 'none'},
            {u'format_id': u'audio-high', u'ext': u'flv', 'preference': 3, 'vcodec': 'none'},
            {u'format_id': u'vid', u'ext': u'mp4', 'preference': 4},
        ]
        info_dict = {u'formats': formats, u'extractor': u'test'}

        ydl = YDL({'format': u'bestaudio'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'audio-high')

        ydl = YDL({'format': u'worstaudio'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'audio-low')

        formats = [
            {u'format_id': u'vid-low', u'ext': u'mp4', 'preference': 1},
            {u'format_id': u'vid-high', u'ext': u'mp4', 'preference': 2},
        ]
        info_dict = {u'formats': formats, u'extractor': u'test'}

        ydl = YDL({'format': u'bestaudio/worstaudio/best'})
        ydl.process_ie_result(info_dict.copy())
        downloaded = ydl.downloaded_info_dicts[0]
        self.assertEqual(downloaded['format_id'], u'vid-high')

    def test_youtube_format_selection(self):
        order = [
            '38', '37', '46', '22', '45', '35', '44', '18', '34', '43', '6', '5', '36', '17', '13',
            # Apple HTTP Live Streaming
            '96', '95', '94', '93', '92', '132', '151',
            # 3D
            '85', '84', '102', '83', '101', '82', '100',
            # Dash video
            '138', '137', '248', '136', '247', '135', '246',
            '245', '244', '134', '243', '133', '242', '160',
            # Dash audio
            '141', '172', '140', '139', '171',
        ]

        for f1id, f2id in zip(order, order[1:]):
            f1 = YoutubeIE._formats[f1id].copy()
            f1['format_id'] = f1id
            f2 = YoutubeIE._formats[f2id].copy()
            f2['format_id'] = f2id

            info_dict = {'formats': [f1, f2], 'extractor': 'youtube'}
            ydl = YDL()
            yie = YoutubeIE(ydl)
            yie._sort_formats(info_dict['formats'])
            ydl.process_ie_result(info_dict)
            downloaded = ydl.downloaded_info_dicts[0]
            self.assertEqual(downloaded['format_id'], f1id)

            info_dict = {'formats': [f2, f1], 'extractor': 'youtube'}
            ydl = YDL()
            yie = YoutubeIE(ydl)
            yie._sort_formats(info_dict['formats'])
            ydl.process_ie_result(info_dict)
            downloaded = ydl.downloaded_info_dicts[0]
            self.assertEqual(downloaded['format_id'], f1id)

    def test_add_extra_info(self):
        test_dict = {
            'extractor': 'Foo',
        }
        extra_info = {
            'extractor': 'Bar',
            'playlist': 'funny videos',
        }
        YDL.add_extra_info(test_dict, extra_info)
        self.assertEqual(test_dict['extractor'], 'Foo')
        self.assertEqual(test_dict['playlist'], 'funny videos')

    def test_prepare_filename(self):
        info = {
            u'id': u'1234',
            u'ext': u'mp4',
            u'width': None,
        }
        def fname(templ):
            ydl = YoutubeDL({'outtmpl': templ})
            return ydl.prepare_filename(info)
        self.assertEqual(fname(u'%(id)s.%(ext)s'), u'1234.mp4')
        self.assertEqual(fname(u'%(id)s-%(width)s.%(ext)s'), u'1234-NA.mp4')
        # Replace missing fields with 'NA'
        self.assertEqual(fname(u'%(uploader_date)s-%(id)s.%(ext)s'), u'NA-1234.mp4')


if __name__ == '__main__':
    unittest.main()
Commit	Line	Data
e028d0d1 JMF	1	#!/usr/bin/env python
e028d0d1 JMF	2
5d254f77 PH	3	# Allow direct execution
5d254f77 PH	4	import os
e028d0d1 JMF	5	import sys
e028d0d1 JMF	6	import unittest
5d254f77	7	sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
e028d0d1	8
5d254f77	9	from test.helper import FakeYDL
26e63931	10	from youtube_dl import YoutubeDL
3d4a70b8	11	from youtube_dl.extractor import YoutubeIE
e028d0d1	12
e028d0d1 JMF	13
e028d0d1 JMF	14	class YDL(FakeYDL):
f4d96df0 PH	15	def __init__(self, args, *kwargs):
f4d96df0 PH	16	super(YDL, self).__init__(args, *kwargs)
e028d0d1	17	self.downloaded_info_dicts = []
f4d96df0	18	self.msgs = []
5d254f77	19
e028d0d1 JMF	20	def process_info(self, info_dict):
	21	self.downloaded_info_dicts.append(info_dict)
	22
f4d96df0 PH	23	def to_screen(self, msg):
	24	self.msgs.append(msg)
	25
5d254f77	26
e028d0d1 JMF	27	class TestFormatSelection(unittest.TestCase):
	28	def test_prefer_free_formats(self):
	29	# Same resolution => download webm
	30	ydl = YDL()
	31	ydl.params['prefer_free_formats'] = True
5d254f77 PH	32	formats = [
	33	{u'ext': u'webm', u'height': 460},
	34	{u'ext': u'mp4', u'height': 460},
	35	]
e028d0d1	36	info_dict = {u'formats': formats, u'extractor': u'test'}
3d4a70b8 PH	37	yie = YoutubeIE(ydl)
3d4a70b8 PH	38	yie._sort_formats(info_dict['formats'])
e028d0d1 JMF	39	ydl.process_ie_result(info_dict)
	40	downloaded = ydl.downloaded_info_dicts[0]
	41	self.assertEqual(downloaded[u'ext'], u'webm')
	42
	43	# Different resolution => download best quality (mp4)
	44	ydl = YDL()
	45	ydl.params['prefer_free_formats'] = True
5d254f77 PH	46	formats = [
	47	{u'ext': u'webm', u'height': 720},
	48	{u'ext': u'mp4', u'height': 1080},
	49	]
e028d0d1	50	info_dict[u'formats'] = formats
3d4a70b8 PH	51	yie = YoutubeIE(ydl)
3d4a70b8 PH	52	yie._sort_formats(info_dict['formats'])
e028d0d1 JMF	53	ydl.process_ie_result(info_dict)
	54	downloaded = ydl.downloaded_info_dicts[0]
	55	self.assertEqual(downloaded[u'ext'], u'mp4')
	56
3d4a70b8	57	# No prefer_free_formats => prefer mp4 and flv for greater compatibilty
e028d0d1 JMF	58	ydl = YDL()
e028d0d1 JMF	59	ydl.params['prefer_free_formats'] = False
5d254f77 PH	60	formats = [
5d254f77 PH	61	{u'ext': u'webm', u'height': 720},
3d4a70b8	62	{u'ext': u'mp4', u'height': 720},
5d254f77 PH	63	{u'ext': u'flv', u'height': 720},
5d254f77 PH	64	]
e028d0d1	65	info_dict[u'formats'] = formats
3d4a70b8 PH	66	yie = YoutubeIE(ydl)
	67	yie._sort_formats(info_dict['formats'])
	68	ydl.process_ie_result(info_dict)
	69	downloaded = ydl.downloaded_info_dicts[0]
	70	self.assertEqual(downloaded[u'ext'], u'mp4')
	71
	72	ydl = YDL()
	73	ydl.params['prefer_free_formats'] = False
	74	formats = [
	75	{u'ext': u'flv', u'height': 720},
	76	{u'ext': u'webm', u'height': 720},
	77	]
	78	info_dict[u'formats'] = formats
	79	yie = YoutubeIE(ydl)
	80	yie._sort_formats(info_dict['formats'])
e028d0d1 JMF	81	ydl.process_ie_result(info_dict)
	82	downloaded = ydl.downloaded_info_dicts[0]
	83	self.assertEqual(downloaded[u'ext'], u'flv')
	84
f4d96df0 PH	85	def test_format_limit(self):
f4d96df0 PH	86	formats = [
3d4a70b8 PH	87	{u'format_id': u'meh', u'url': u'http://example.com/meh', 'preference': 1},
	88	{u'format_id': u'good', u'url': u'http://example.com/good', 'preference': 2},
	89	{u'format_id': u'great', u'url': u'http://example.com/great', 'preference': 3},
	90	{u'format_id': u'excellent', u'url': u'http://example.com/exc', 'preference': 4},
f4d96df0 PH	91	]
	92	info_dict = {
	93	u'formats': formats, u'extractor': u'test', 'id': 'testvid'}
	94
	95	ydl = YDL()
	96	ydl.process_ie_result(info_dict)
	97	downloaded = ydl.downloaded_info_dicts[0]
	98	self.assertEqual(downloaded[u'format_id'], u'excellent')
	99
	100	ydl = YDL({'format_limit': 'good'})
	101	assert ydl.params['format_limit'] == 'good'
8e3e0322	102	ydl.process_ie_result(info_dict.copy())
f4d96df0 PH	103	downloaded = ydl.downloaded_info_dicts[0]
	104	self.assertEqual(downloaded[u'format_id'], u'good')
	105
	106	ydl = YDL({'format_limit': 'great', 'format': 'all'})
8e3e0322	107	ydl.process_ie_result(info_dict.copy())
f4d96df0 PH	108	self.assertEqual(ydl.downloaded_info_dicts[0][u'format_id'], u'meh')
	109	self.assertEqual(ydl.downloaded_info_dicts[1][u'format_id'], u'good')
	110	self.assertEqual(ydl.downloaded_info_dicts[2][u'format_id'], u'great')
	111	self.assertTrue('3' in ydl.msgs[0])
	112
	113	ydl = YDL()
	114	ydl.params['format_limit'] = 'excellent'
8e3e0322	115	ydl.process_ie_result(info_dict.copy())
f4d96df0 PH	116	downloaded = ydl.downloaded_info_dicts[0]
	117	self.assertEqual(downloaded[u'format_id'], u'excellent')
	118
a9c58ad9 JMF	119	def test_format_selection(self):
a9c58ad9 JMF	120	formats = [
3d4a70b8 PH	121	{u'format_id': u'35', u'ext': u'mp4', 'preference': 1},
	122	{u'format_id': u'45', u'ext': u'webm', 'preference': 2},
	123	{u'format_id': u'47', u'ext': u'webm', 'preference': 3},
	124	{u'format_id': u'2', u'ext': u'flv', 'preference': 4},
a9c58ad9 JMF	125	]
	126	info_dict = {u'formats': formats, u'extractor': u'test'}
	127
	128	ydl = YDL({'format': u'20/47'})
8e3e0322	129	ydl.process_ie_result(info_dict.copy())
a9c58ad9 JMF	130	downloaded = ydl.downloaded_info_dicts[0]
	131	self.assertEqual(downloaded['format_id'], u'47')
	132
	133	ydl = YDL({'format': u'20/71/worst'})
8e3e0322	134	ydl.process_ie_result(info_dict.copy())
a9c58ad9 JMF	135	downloaded = ydl.downloaded_info_dicts[0]
	136	self.assertEqual(downloaded['format_id'], u'35')
	137
	138	ydl = YDL()
8e3e0322	139	ydl.process_ie_result(info_dict.copy())
a9c58ad9 JMF	140	downloaded = ydl.downloaded_info_dicts[0]
	141	self.assertEqual(downloaded['format_id'], u'2')
	142
49e86983	143	ydl = YDL({'format': u'webm/mp4'})
8e3e0322	144	ydl.process_ie_result(info_dict.copy())
49e86983 JMF	145	downloaded = ydl.downloaded_info_dicts[0]
	146	self.assertEqual(downloaded['format_id'], u'47')
	147
	148	ydl = YDL({'format': u'3gp/40/mp4'})
8e3e0322	149	ydl.process_ie_result(info_dict.copy())
49e86983 JMF	150	downloaded = ydl.downloaded_info_dicts[0]
	151	self.assertEqual(downloaded['format_id'], u'35')
	152
ba7678f9 PH	153	def test_format_selection_audio(self):
	154	formats = [
	155	{u'format_id': u'audio-low', u'ext': u'webm', 'preference': 1, 'vcodec': 'none'},
	156	{u'format_id': u'audio-mid', u'ext': u'webm', 'preference': 2, 'vcodec': 'none'},
	157	{u'format_id': u'audio-high', u'ext': u'flv', 'preference': 3, 'vcodec': 'none'},
	158	{u'format_id': u'vid', u'ext': u'mp4', 'preference': 4},
	159	]
	160	info_dict = {u'formats': formats, u'extractor': u'test'}
	161
	162	ydl = YDL({'format': u'bestaudio'})
	163	ydl.process_ie_result(info_dict.copy())
	164	downloaded = ydl.downloaded_info_dicts[0]
	165	self.assertEqual(downloaded['format_id'], u'audio-high')
	166
	167	ydl = YDL({'format': u'worstaudio'})
	168	ydl.process_ie_result(info_dict.copy())
	169	downloaded = ydl.downloaded_info_dicts[0]
	170	self.assertEqual(downloaded['format_id'], u'audio-low')
	171
	172	formats = [
	173	{u'format_id': u'vid-low', u'ext': u'mp4', 'preference': 1},
	174	{u'format_id': u'vid-high', u'ext': u'mp4', 'preference': 2},
	175	]
	176	info_dict = {u'formats': formats, u'extractor': u'test'}
	177
	178	ydl = YDL({'format': u'bestaudio/worstaudio/best'})
	179	ydl.process_ie_result(info_dict.copy())
	180	downloaded = ydl.downloaded_info_dicts[0]
	181	self.assertEqual(downloaded['format_id'], u'vid-high')
	182
3d4a70b8 PH	183	def test_youtube_format_selection(self):
	184	order = [
	185	'38', '37', '46', '22', '45', '35', '44', '18', '34', '43', '6', '5', '36', '17', '13',
	186	# Apple HTTP Live Streaming
	187	'96', '95', '94', '93', '92', '132', '151',
	188	# 3D
	189	'85', '84', '102', '83', '101', '82', '100',
	190	# Dash video
	191	'138', '137', '248', '136', '247', '135', '246',
	192	'245', '244', '134', '243', '133', '242', '160',
	193	# Dash audio
	194	'141', '172', '140', '139', '171',
	195	]
	196
	197	for f1id, f2id in zip(order, order[1:]):
	198	f1 = YoutubeIE._formats[f1id].copy()
	199	f1['format_id'] = f1id
	200	f2 = YoutubeIE._formats[f2id].copy()
	201	f2['format_id'] = f2id
	202
	203	info_dict = {'formats': [f1, f2], 'extractor': 'youtube'}
	204	ydl = YDL()
	205	yie = YoutubeIE(ydl)
	206	yie._sort_formats(info_dict['formats'])
	207	ydl.process_ie_result(info_dict)
	208	downloaded = ydl.downloaded_info_dicts[0]
	209	self.assertEqual(downloaded['format_id'], f1id)
	210
	211	info_dict = {'formats': [f2, f1], 'extractor': 'youtube'}
	212	ydl = YDL()
	213	yie = YoutubeIE(ydl)
	214	yie._sort_formats(info_dict['formats'])
	215	ydl.process_ie_result(info_dict)
	216	downloaded = ydl.downloaded_info_dicts[0]
	217	self.assertEqual(downloaded['format_id'], f1id)
	218
b6c45014 JMF	219	def test_add_extra_info(self):
	220	test_dict = {
	221	'extractor': 'Foo',
	222	}
	223	extra_info = {
	224	'extractor': 'Bar',
	225	'playlist': 'funny videos',
	226	}
	227	YDL.add_extra_info(test_dict, extra_info)
	228	self.assertEqual(test_dict['extractor'], 'Foo')
	229	self.assertEqual(test_dict['playlist'], 'funny videos')
	230
26e63931 JMF	231	def test_prepare_filename(self):
	232	info = {
	233	u'id': u'1234',
	234	u'ext': u'mp4',
	235	u'width': None,
	236	}
	237	def fname(templ):
	238	ydl = YoutubeDL({'outtmpl': templ})
	239	return ydl.prepare_filename(info)
	240	self.assertEqual(fname(u'%(id)s.%(ext)s'), u'1234.mp4')
	241	self.assertEqual(fname(u'%(id)s-%(width)s.%(ext)s'), u'1234-NA.mp4')
	242	# Replace missing fields with 'NA'
	243	self.assertEqual(fname(u'%(uploader_date)s-%(id)s.%(ext)s'), u'NA-1234.mp4')
	244
f4d96df0	245
e028d0d1 JMF	246	if __name__ == '__main__':
e028d0d1 JMF	247	unittest.main()