[yt-dlp.git] / youtube_dl / downloader / rtmp.py

from __future__ import unicode_literals

import os
import re
import subprocess
import sys
import time

from .common import FileDownloader
from ..compat import compat_str
from ..utils import (
    check_executable,
    encodeFilename,
    format_bytes,
    get_exe_version,
)


def rtmpdump_version():
    return get_exe_version(
        'rtmpdump', ['--help'], r'(?i)RTMPDump\s*v?([0-9a-zA-Z._-]+)')


class RtmpFD(FileDownloader):
    def real_download(self, filename, info_dict):
        def run_rtmpdump(args):
            start = time.time()
            resume_percent = None
            resume_downloaded_data_len = None
            proc = subprocess.Popen(args, stderr=subprocess.PIPE)
            cursor_in_new_line = True
            proc_stderr_closed = False
            while not proc_stderr_closed:
                # read line from stderr
                line = ''
                while True:
                    char = proc.stderr.read(1)
                    if not char:
                        proc_stderr_closed = True
                        break
                    if char in [b'\r', b'\n']:
                        break
                    line += char.decode('ascii', 'replace')
                if not line:
                    # proc_stderr_closed is True
                    continue
                mobj = re.search(r'([0-9]+\.[0-9]{3}) kB / [0-9]+\.[0-9]{2} sec \(([0-9]{1,2}\.[0-9])%\)', line)
                if mobj:
                    downloaded_data_len = int(float(mobj.group(1)) * 1024)
                    percent = float(mobj.group(2))
                    if not resume_percent:
                        resume_percent = percent
                        resume_downloaded_data_len = downloaded_data_len
                    eta = self.calc_eta(start, time.time(), 100 - resume_percent, percent - resume_percent)
                    speed = self.calc_speed(start, time.time(), downloaded_data_len - resume_downloaded_data_len)
                    data_len = None
                    if percent > 0:
                        data_len = int(downloaded_data_len * 100 / percent)
                    data_len_str = '~' + format_bytes(data_len)
                    self.report_progress(percent, data_len_str, speed, eta)
                    cursor_in_new_line = False
                    self._hook_progress({
                        'downloaded_bytes': downloaded_data_len,
                        'total_bytes': data_len,
                        'tmpfilename': tmpfilename,
                        'filename': filename,
                        'status': 'downloading',
                        'eta': eta,
                        'speed': speed,
                    })
                else:
                    # no percent for live streams
                    mobj = re.search(r'([0-9]+\.[0-9]{3}) kB / [0-9]+\.[0-9]{2} sec', line)
                    if mobj:
                        downloaded_data_len = int(float(mobj.group(1)) * 1024)
                        time_now = time.time()
                        speed = self.calc_speed(start, time_now, downloaded_data_len)
                        self.report_progress_live_stream(downloaded_data_len, speed, time_now - start)
                        cursor_in_new_line = False
                        self._hook_progress({
                            'downloaded_bytes': downloaded_data_len,
                            'tmpfilename': tmpfilename,
                            'filename': filename,
                            'status': 'downloading',
                            'speed': speed,
                        })
                    elif self.params.get('verbose', False):
                        if not cursor_in_new_line:
                            self.to_screen('')
                        cursor_in_new_line = True
                        self.to_screen('[rtmpdump] ' + line)
            proc.wait()
            if not cursor_in_new_line:
                self.to_screen('')
            return proc.returncode

        url = info_dict['url']
        player_url = info_dict.get('player_url', None)
        page_url = info_dict.get('page_url', None)
        app = info_dict.get('app', None)
        play_path = info_dict.get('play_path', None)
        tc_url = info_dict.get('tc_url', None)
        flash_version = info_dict.get('flash_version', None)
        live = info_dict.get('rtmp_live', False)
        conn = info_dict.get('rtmp_conn', None)
        protocol = info_dict.get('rtmp_protocol', None)
        no_resume = info_dict.get('no_resume', False)
        continue_dl = info_dict.get('continuedl', False)

        self.report_destination(filename)
        tmpfilename = self.temp_name(filename)
        test = self.params.get('test', False)

        # Check for rtmpdump first
        if not check_executable('rtmpdump', ['-h']):
            self.report_error('RTMP download detected but "rtmpdump" could not be run. Please install it.')
            return False

        # Download using rtmpdump. rtmpdump returns exit code 2 when
        # the connection was interrumpted and resuming appears to be
        # possible. This is part of rtmpdump's normal usage, AFAIK.
        basic_args = ['rtmpdump', '--verbose', '-r', url, '-o', tmpfilename]
        if player_url is not None:
            basic_args += ['--swfVfy', player_url]
        if page_url is not None:
            basic_args += ['--pageUrl', page_url]
        if app is not None:
            basic_args += ['--app', app]
        if play_path is not None:
            basic_args += ['--playpath', play_path]
        if tc_url is not None:
            basic_args += ['--tcUrl', url]
        if test:
            basic_args += ['--stop', '1']
        if flash_version is not None:
            basic_args += ['--flashVer', flash_version]
        if live:
            basic_args += ['--live']
        if isinstance(conn, list):
            for entry in conn:
                basic_args += ['--conn', entry]
        elif isinstance(conn, compat_str):
            basic_args += ['--conn', conn]
        if protocol is not None:
            basic_args += ['--protocol', protocol]

        args = basic_args
        if not no_resume and continue_dl and not live:
            args += ['--resume']
        if not live and continue_dl:
            args += ['--skip', '1']

        if sys.platform == 'win32' and sys.version_info < (3, 0):
            # Windows subprocess module does not actually support Unicode
            # on Python 2.x
            # See http://stackoverflow.com/a/9951851/35070
            subprocess_encoding = sys.getfilesystemencoding()
            args = [a.encode(subprocess_encoding, 'ignore') for a in args]
        else:
            subprocess_encoding = None

        self._debug_cmd(args, subprocess_encoding, exe='rtmpdump')

        RD_SUCCESS = 0
        RD_FAILED = 1
        RD_INCOMPLETE = 2
        RD_NO_CONNECT = 3

        retval = run_rtmpdump(args)

        if retval == RD_NO_CONNECT:
            self.report_error('[rtmpdump] Could not connect to RTMP server.')
            return False

        while (retval == RD_INCOMPLETE or retval == RD_FAILED) and not test and not live:
            prevsize = os.path.getsize(encodeFilename(tmpfilename))
            self.to_screen('[rtmpdump] %s bytes' % prevsize)
            time.sleep(5.0)  # This seems to be needed
            retval = run_rtmpdump(basic_args + ['-e'] + [[], ['-k', '1']][retval == RD_FAILED])
            cursize = os.path.getsize(encodeFilename(tmpfilename))
            if prevsize == cursize and retval == RD_FAILED:
                break
            # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
            if prevsize == cursize and retval == RD_INCOMPLETE and cursize > 1024:
                self.to_screen('[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
                retval = RD_SUCCESS
                break
        if retval == RD_SUCCESS or (test and retval == RD_INCOMPLETE):
            fsize = os.path.getsize(encodeFilename(tmpfilename))
            self.to_screen('[rtmpdump] %s bytes' % fsize)
            self.try_rename(tmpfilename, filename)
            self._hook_progress({
                'downloaded_bytes': fsize,
                'total_bytes': fsize,
                'filename': filename,
                'status': 'finished',
            })
            return True
        else:
            self.to_stderr('\n')
            self.report_error('rtmpdump exited with code %d' % retval)
            return False
Commit	Line	Data
8dec03ec S	1	from __future__ import unicode_literals
8dec03ec S	2
3bc2ddcc JMF	3	import os
	4	import re
	5	import subprocess
	6	import sys
	7	import time
	8
	9	from .common import FileDownloader
1cc79574	10	from ..compat import compat_str
3bc2ddcc	11	from ..utils import (
7798fad5	12	check_executable,
3bc2ddcc JMF	13	encodeFilename,
3bc2ddcc JMF	14	format_bytes,
4c83c967	15	get_exe_version,
3bc2ddcc JMF	16	)
	17
	18
4c83c967 PH	19	def rtmpdump_version():
	20	return get_exe_version(
	21	'rtmpdump', ['--help'], r'(?i)RTMPDump\s*v?([0-9a-zA-Z._-]+)')
	22
	23
3bc2ddcc JMF	24	class RtmpFD(FileDownloader):
	25	def real_download(self, filename, info_dict):
	26	def run_rtmpdump(args):
	27	start = time.time()
	28	resume_percent = None
	29	resume_downloaded_data_len = None
	30	proc = subprocess.Popen(args, stderr=subprocess.PIPE)
	31	cursor_in_new_line = True
	32	proc_stderr_closed = False
	33	while not proc_stderr_closed:
	34	# read line from stderr
8dec03ec	35	line = ''
3bc2ddcc JMF	36	while True:
	37	char = proc.stderr.read(1)
	38	if not char:
	39	proc_stderr_closed = True
	40	break
	41	if char in [b'\r', b'\n']:
	42	break
	43	line += char.decode('ascii', 'replace')
	44	if not line:
	45	# proc_stderr_closed is True
	46	continue
	47	mobj = re.search(r'([0-9]+\.[0-9]{3}) kB / [0-9]+\.[0-9]{2} sec \(([0-9]{1,2}\.[0-9])%\)', line)
	48	if mobj:
2514d263	49	downloaded_data_len = int(float(mobj.group(1)) * 1024)
3bc2ddcc JMF	50	percent = float(mobj.group(2))
	51	if not resume_percent:
	52	resume_percent = percent
	53	resume_downloaded_data_len = downloaded_data_len
2514d263 JW	54	eta = self.calc_eta(start, time.time(), 100 - resume_percent, percent - resume_percent)
2514d263 JW	55	speed = self.calc_speed(start, time.time(), downloaded_data_len - resume_downloaded_data_len)
3bc2ddcc JMF	56	data_len = None
	57	if percent > 0:
	58	data_len = int(downloaded_data_len * 100 / percent)
8dec03ec	59	data_len_str = '~' + format_bytes(data_len)
3bc2ddcc JMF	60	self.report_progress(percent, data_len_str, speed, eta)
	61	cursor_in_new_line = False
	62	self._hook_progress({
	63	'downloaded_bytes': downloaded_data_len,
	64	'total_bytes': data_len,
	65	'tmpfilename': tmpfilename,
	66	'filename': filename,
	67	'status': 'downloading',
	68	'eta': eta,
	69	'speed': speed,
	70	})
	71	else:
	72	# no percent for live streams
	73	mobj = re.search(r'([0-9]+\.[0-9]{3}) kB / [0-9]+\.[0-9]{2} sec', line)
	74	if mobj:
2514d263	75	downloaded_data_len = int(float(mobj.group(1)) * 1024)
3bc2ddcc JMF	76	time_now = time.time()
	77	speed = self.calc_speed(start, time_now, downloaded_data_len)
	78	self.report_progress_live_stream(downloaded_data_len, speed, time_now - start)
	79	cursor_in_new_line = False
	80	self._hook_progress({
	81	'downloaded_bytes': downloaded_data_len,
	82	'tmpfilename': tmpfilename,
	83	'filename': filename,
	84	'status': 'downloading',
	85	'speed': speed,
	86	})
	87	elif self.params.get('verbose', False):
	88	if not cursor_in_new_line:
8dec03ec	89	self.to_screen('')
3bc2ddcc	90	cursor_in_new_line = True
2514d263	91	self.to_screen('[rtmpdump] ' + line)
3bc2ddcc JMF	92	proc.wait()
3bc2ddcc JMF	93	if not cursor_in_new_line:
8dec03ec	94	self.to_screen('')
3bc2ddcc JMF	95	return proc.returncode
	96
	97	url = info_dict['url']
	98	player_url = info_dict.get('player_url', None)
	99	page_url = info_dict.get('page_url', None)
082c6c86	100	app = info_dict.get('app', None)
3bc2ddcc JMF	101	play_path = info_dict.get('play_path', None)
3bc2ddcc JMF	102	tc_url = info_dict.get('tc_url', None)
082c6c86	103	flash_version = info_dict.get('flash_version', None)
3bc2ddcc JMF	104	live = info_dict.get('rtmp_live', False)
3bc2ddcc JMF	105	conn = info_dict.get('rtmp_conn', None)
087ca2cb	106	protocol = info_dict.get('rtmp_protocol', None)
7906d199	107	no_resume = info_dict.get('no_resume', False)
3dee7826 PH	108	continue_dl = info_dict.get('continuedl', False)
3dee7826 PH	109
3bc2ddcc JMF	110	self.report_destination(filename)
	111	tmpfilename = self.temp_name(filename)
	112	test = self.params.get('test', False)
	113
	114	# Check for rtmpdump first
7798fad5	115	if not check_executable('rtmpdump', ['-h']):
23566e0d	116	self.report_error('RTMP download detected but "rtmpdump" could not be run. Please install it.')
3bc2ddcc JMF	117	return False
	118
	119	# Download using rtmpdump. rtmpdump returns exit code 2 when
	120	# the connection was interrumpted and resuming appears to be
	121	# possible. This is part of rtmpdump's normal usage, AFAIK.
	122	basic_args = ['rtmpdump', '--verbose', '-r', url, '-o', tmpfilename]
	123	if player_url is not None:
	124	basic_args += ['--swfVfy', player_url]
	125	if page_url is not None:
	126	basic_args += ['--pageUrl', page_url]
082c6c86 S	127	if app is not None:
082c6c86 S	128	basic_args += ['--app', app]
3bc2ddcc JMF	129	if play_path is not None:
	130	basic_args += ['--playpath', play_path]
	131	if tc_url is not None:
	132	basic_args += ['--tcUrl', url]
	133	if test:
	134	basic_args += ['--stop', '1']
082c6c86 S	135	if flash_version is not None:
082c6c86 S	136	basic_args += ['--flashVer', flash_version]
3bc2ddcc JMF	137	if live:
3bc2ddcc JMF	138	basic_args += ['--live']
eb451334 S	139	if isinstance(conn, list):
	140	for entry in conn:
	141	basic_args += ['--conn', entry]
	142	elif isinstance(conn, compat_str):
3bc2ddcc	143	basic_args += ['--conn', conn]
087ca2cb JMF	144	if protocol is not None:
087ca2cb JMF	145	basic_args += ['--protocol', protocol]
3dee7826 PH	146
	147	args = basic_args
	148	if not no_resume and continue_dl and not live:
	149	args += ['--resume']
	150	if not live and continue_dl:
	151	args += ['--skip', '1']
3bc2ddcc JMF	152
	153	if sys.platform == 'win32' and sys.version_info < (3, 0):
	154	# Windows subprocess module does not actually support Unicode
	155	# on Python 2.x
	156	# See http://stackoverflow.com/a/9951851/35070
	157	subprocess_encoding = sys.getfilesystemencoding()
	158	args = [a.encode(subprocess_encoding, 'ignore') for a in args]
	159	else:
	160	subprocess_encoding = None
	161
222516d9	162	self._debug_cmd(args, subprocess_encoding, exe='rtmpdump')
3bc2ddcc	163
35241756 S	164	RD_SUCCESS = 0
	165	RD_FAILED = 1
	166	RD_INCOMPLETE = 2
52d6a9a6	167	RD_NO_CONNECT = 3
35241756	168
3bc2ddcc JMF	169	retval = run_rtmpdump(args)
3bc2ddcc JMF	170
52d6a9a6	171	if retval == RD_NO_CONNECT:
8dec03ec	172	self.report_error('[rtmpdump] Could not connect to RTMP server.')
52d6a9a6 S	173	return False
52d6a9a6 S	174
9d6105c9	175	while (retval == RD_INCOMPLETE or retval == RD_FAILED) and not test and not live:
3bc2ddcc	176	prevsize = os.path.getsize(encodeFilename(tmpfilename))
8dec03ec	177	self.to_screen('[rtmpdump] %s bytes' % prevsize)
5f6a1245	178	time.sleep(5.0) # This seems to be needed
35241756	179	retval = run_rtmpdump(basic_args + ['-e'] + [[], ['-k', '1']][retval == RD_FAILED])
3bc2ddcc	180	cursize = os.path.getsize(encodeFilename(tmpfilename))
35241756	181	if prevsize == cursize and retval == RD_FAILED:
3bc2ddcc	182	break
7af808a5	183	# Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
35241756	184	if prevsize == cursize and retval == RD_INCOMPLETE and cursize > 1024:
8dec03ec	185	self.to_screen('[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
35241756	186	retval = RD_SUCCESS
3bc2ddcc	187	break
35241756	188	if retval == RD_SUCCESS or (test and retval == RD_INCOMPLETE):
3bc2ddcc	189	fsize = os.path.getsize(encodeFilename(tmpfilename))
8dec03ec	190	self.to_screen('[rtmpdump] %s bytes' % fsize)
3bc2ddcc JMF	191	self.try_rename(tmpfilename, filename)
	192	self._hook_progress({
	193	'downloaded_bytes': fsize,
	194	'total_bytes': fsize,
	195	'filename': filename,
	196	'status': 'finished',
	197	})
	198	return True
	199	else:
8dec03ec S	200	self.to_stderr('\n')
8dec03ec S	201	self.report_error('rtmpdump exited with code %d' % retval)
3bc2ddcc	202	return False