yt_dlp/downloader/rtmp.py

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