Merge branch 'jukebox' of https://github.com/remitamine/youtube-dl into remitamine...
[youtube-dl] / youtube_dl / downloader / fragment.py
1 from __future__ import division, unicode_literals
2
3 import os
4 import time
5
6 from .common import FileDownloader
7 from .http import HttpFD
8 from ..utils import (
9     encodeFilename,
10     sanitize_open,
11 )
12
13
14 class HttpQuietDownloader(HttpFD):
15     def to_screen(self, *args, **kargs):
16         pass
17
18
19 class FragmentFD(FileDownloader):
20     """
21     A base file downloader class for fragmented media (e.g. f4m/m3u8 manifests).
22     """
23
24     def _prepare_and_start_frag_download(self, ctx):
25         self._prepare_frag_download(ctx)
26         self._start_frag_download(ctx)
27
28     def _prepare_frag_download(self, ctx):
29         self.to_screen('[%s] Total fragments: %d' % (self.FD_NAME, ctx['total_frags']))
30         self.report_destination(ctx['filename'])
31         dl = HttpQuietDownloader(
32             self.ydl,
33             {
34                 'continuedl': True,
35                 'quiet': True,
36                 'noprogress': True,
37                 'ratelimit': self.params.get('ratelimit', None),
38                 'retries': self.params.get('retries', 0),
39                 'test': self.params.get('test', False),
40             }
41         )
42         tmpfilename = self.temp_name(ctx['filename'])
43         dest_stream, tmpfilename = sanitize_open(tmpfilename, 'wb')
44         ctx.update({
45             'dl': dl,
46             'dest_stream': dest_stream,
47             'tmpfilename': tmpfilename,
48         })
49
50     def _start_frag_download(self, ctx):
51         total_frags = ctx['total_frags']
52         # This dict stores the download progress, it's updated by the progress
53         # hook
54         state = {
55             'status': 'downloading',
56             'downloaded_bytes': 0,
57             'frag_index': 0,
58             'frag_count': total_frags,
59             'filename': ctx['filename'],
60             'tmpfilename': ctx['tmpfilename'],
61         }
62         start = time.time()
63         ctx['started'] = start
64
65         def frag_progress_hook(s):
66             if s['status'] not in ('downloading', 'finished'):
67                 return
68
69             frag_total_bytes = s.get('total_bytes', 0)
70             if s['status'] == 'finished':
71                 state['downloaded_bytes'] += frag_total_bytes
72                 state['frag_index'] += 1
73
74             estimated_size = (
75                 (state['downloaded_bytes'] + frag_total_bytes) /
76                 (state['frag_index'] + 1) * total_frags)
77             time_now = time.time()
78             state['total_bytes_estimate'] = estimated_size
79             state['elapsed'] = time_now - start
80
81             if s['status'] == 'finished':
82                 progress = self.calc_percent(state['frag_index'], total_frags)
83             else:
84                 frag_downloaded_bytes = s['downloaded_bytes']
85                 frag_progress = self.calc_percent(frag_downloaded_bytes,
86                                                   frag_total_bytes)
87                 progress = self.calc_percent(state['frag_index'], total_frags)
88                 progress += frag_progress / float(total_frags)
89
90                 state['eta'] = self.calc_eta(
91                     start, time_now, estimated_size, state['downloaded_bytes'] + frag_downloaded_bytes)
92                 state['speed'] = s.get('speed')
93             self._hook_progress(state)
94
95         ctx['dl'].add_progress_hook(frag_progress_hook)
96
97         return start
98
99     def _finish_frag_download(self, ctx):
100         ctx['dest_stream'].close()
101         elapsed = time.time() - ctx['started']
102         self.try_rename(ctx['tmpfilename'], ctx['filename'])
103         fsize = os.path.getsize(encodeFilename(ctx['filename']))
104
105         self._hook_progress({
106             'downloaded_bytes': fsize,
107             'total_bytes': fsize,
108             'filename': ctx['filename'],
109             'status': 'finished',
110             'elapsed': elapsed,
111         })