]> jfr.im git - yt-dlp.git/blame - yt_dlp/downloader/ism.py
Standardize retry mechanism (#1649)
[yt-dlp.git] / yt_dlp / downloader / ism.py
CommitLineData
b2758123
RA
1import binascii
2import io
f9934b96 3import struct
f8271158 4import time
ac668111 5import urllib.error
b2758123
RA
6
7from .fragment import FragmentFD
be5c1ae8 8from ..utils import RetryManager
65220c3b 9
f9934b96 10u8 = struct.Struct('>B')
11u88 = struct.Struct('>Bx')
12u16 = struct.Struct('>H')
13u1616 = struct.Struct('>Hxx')
14u32 = struct.Struct('>I')
15u64 = struct.Struct('>Q')
65220c3b 16
f9934b96 17s88 = struct.Struct('>bx')
18s16 = struct.Struct('>h')
19s1616 = struct.Struct('>hxx')
20s32 = struct.Struct('>i')
b2758123
RA
21
22unity_matrix = (s32.pack(0x10000) + s32.pack(0) * 3) * 2 + s32.pack(0x40000000)
23
24TRACK_ENABLED = 0x1
25TRACK_IN_MOVIE = 0x2
26TRACK_IN_PREVIEW = 0x4
27
28SELF_CONTAINED = 0x1
29
30
31def box(box_type, payload):
32 return u32.pack(8 + len(payload)) + box_type + payload
33
34
35def full_box(box_type, version, flags, payload):
36 return box(box_type, u8.pack(version) + u32.pack(flags)[1:] + payload)
37
38
39def write_piff_header(stream, params):
40 track_id = params['track_id']
41 fourcc = params['fourcc']
42 duration = params['duration']
43 timescale = params.get('timescale', 10000000)
44 language = params.get('language', 'und')
45 height = params.get('height', 0)
46 width = params.get('width', 0)
fd76a142 47 stream_type = params['stream_type']
b2758123
RA
48 creation_time = modification_time = int(time.time())
49
50 ftyp_payload = b'isml' # major brand
51 ftyp_payload += u32.pack(1) # minor version
52 ftyp_payload += b'piff' + b'iso2' # compatible brands
53 stream.write(box(b'ftyp', ftyp_payload)) # File Type Box
54
55 mvhd_payload = u64.pack(creation_time)
56 mvhd_payload += u64.pack(modification_time)
57 mvhd_payload += u32.pack(timescale)
58 mvhd_payload += u64.pack(duration)
59 mvhd_payload += s1616.pack(1) # rate
60 mvhd_payload += s88.pack(1) # volume
61 mvhd_payload += u16.pack(0) # reserved
62 mvhd_payload += u32.pack(0) * 2 # reserved
63 mvhd_payload += unity_matrix
64 mvhd_payload += u32.pack(0) * 6 # pre defined
65 mvhd_payload += u32.pack(0xffffffff) # next track id
66 moov_payload = full_box(b'mvhd', 1, 0, mvhd_payload) # Movie Header Box
67
68 tkhd_payload = u64.pack(creation_time)
69 tkhd_payload += u64.pack(modification_time)
70 tkhd_payload += u32.pack(track_id) # track id
71 tkhd_payload += u32.pack(0) # reserved
72 tkhd_payload += u64.pack(duration)
73 tkhd_payload += u32.pack(0) * 2 # reserved
74 tkhd_payload += s16.pack(0) # layer
75 tkhd_payload += s16.pack(0) # alternate group
fd76a142 76 tkhd_payload += s88.pack(1 if stream_type == 'audio' else 0) # volume
b2758123
RA
77 tkhd_payload += u16.pack(0) # reserved
78 tkhd_payload += unity_matrix
79 tkhd_payload += u1616.pack(width)
80 tkhd_payload += u1616.pack(height)
81 trak_payload = full_box(b'tkhd', 1, TRACK_ENABLED | TRACK_IN_MOVIE | TRACK_IN_PREVIEW, tkhd_payload) # Track Header Box
82
83 mdhd_payload = u64.pack(creation_time)
84 mdhd_payload += u64.pack(modification_time)
85 mdhd_payload += u32.pack(timescale)
86 mdhd_payload += u64.pack(duration)
87 mdhd_payload += u16.pack(((ord(language[0]) - 0x60) << 10) | ((ord(language[1]) - 0x60) << 5) | (ord(language[2]) - 0x60))
88 mdhd_payload += u16.pack(0) # pre defined
89 mdia_payload = full_box(b'mdhd', 1, 0, mdhd_payload) # Media Header Box
90
91 hdlr_payload = u32.pack(0) # pre defined
fd76a142
F
92 if stream_type == 'audio': # handler type
93 hdlr_payload += b'soun'
94 hdlr_payload += u32.pack(0) * 3 # reserved
95 hdlr_payload += b'SoundHandler\0' # name
96 elif stream_type == 'video':
97 hdlr_payload += b'vide'
98 hdlr_payload += u32.pack(0) * 3 # reserved
99 hdlr_payload += b'VideoHandler\0' # name
100 elif stream_type == 'text':
101 hdlr_payload += b'subt'
102 hdlr_payload += u32.pack(0) * 3 # reserved
103 hdlr_payload += b'SubtitleHandler\0' # name
104 else:
105 assert False
b2758123
RA
106 mdia_payload += full_box(b'hdlr', 0, 0, hdlr_payload) # Handler Reference Box
107
fd76a142 108 if stream_type == 'audio':
b2758123 109 smhd_payload = s88.pack(0) # balance
2583c0b5 110 smhd_payload += u16.pack(0) # reserved
b2758123 111 media_header_box = full_box(b'smhd', 0, 0, smhd_payload) # Sound Media Header
fd76a142 112 elif stream_type == 'video':
b2758123
RA
113 vmhd_payload = u16.pack(0) # graphics mode
114 vmhd_payload += u16.pack(0) * 3 # opcolor
115 media_header_box = full_box(b'vmhd', 0, 1, vmhd_payload) # Video Media Header
fd76a142 116 elif stream_type == 'text':
66a1b864 117 media_header_box = full_box(b'sthd', 0, 0, b'') # Subtitle Media Header
fd76a142
F
118 else:
119 assert False
b2758123
RA
120 minf_payload = media_header_box
121
122 dref_payload = u32.pack(1) # entry count
123 dref_payload += full_box(b'url ', 0, SELF_CONTAINED, b'') # Data Entry URL Box
124 dinf_payload = full_box(b'dref', 0, 0, dref_payload) # Data Reference Box
125 minf_payload += box(b'dinf', dinf_payload) # Data Information Box
126
127 stsd_payload = u32.pack(1) # entry count
128
129 sample_entry_payload = u8.pack(0) * 6 # reserved
130 sample_entry_payload += u16.pack(1) # data reference index
fd76a142 131 if stream_type == 'audio':
b2758123
RA
132 sample_entry_payload += u32.pack(0) * 2 # reserved
133 sample_entry_payload += u16.pack(params.get('channels', 2))
134 sample_entry_payload += u16.pack(params.get('bits_per_sample', 16))
135 sample_entry_payload += u16.pack(0) # pre defined
136 sample_entry_payload += u16.pack(0) # reserved
137 sample_entry_payload += u1616.pack(params['sampling_rate'])
138
139 if fourcc == 'AACL':
9d64e1dc 140 sample_entry_box = box(b'mp4a', sample_entry_payload)
fd76a142 141 elif stream_type == 'video':
b2758123
RA
142 sample_entry_payload += u16.pack(0) # pre defined
143 sample_entry_payload += u16.pack(0) # reserved
144 sample_entry_payload += u32.pack(0) * 3 # pre defined
145 sample_entry_payload += u16.pack(width)
146 sample_entry_payload += u16.pack(height)
147 sample_entry_payload += u1616.pack(0x48) # horiz resolution 72 dpi
148 sample_entry_payload += u1616.pack(0x48) # vert resolution 72 dpi
149 sample_entry_payload += u32.pack(0) # reserved
150 sample_entry_payload += u16.pack(1) # frame count
151 sample_entry_payload += u8.pack(0) * 32 # compressor name
152 sample_entry_payload += u16.pack(0x18) # depth
153 sample_entry_payload += s16.pack(-1) # pre defined
154
0f06bcd7 155 codec_private_data = binascii.unhexlify(params['codec_private_data'].encode())
b2758123
RA
156 if fourcc in ('H264', 'AVC1'):
157 sps, pps = codec_private_data.split(u32.pack(1))[1:]
158 avcc_payload = u8.pack(1) # configuration version
10380e55 159 avcc_payload += sps[1:4] # avc profile indication + profile compatibility + avc level indication
843ad179 160 avcc_payload += u8.pack(0xfc | (params.get('nal_unit_length_field', 4) - 1)) # complete representation (1) + reserved (11111) + length size minus one
b2758123
RA
161 avcc_payload += u8.pack(1) # reserved (0) + number of sps (0000001)
162 avcc_payload += u16.pack(len(sps))
163 avcc_payload += sps
164 avcc_payload += u8.pack(1) # number of pps
165 avcc_payload += u16.pack(len(pps))
166 avcc_payload += pps
167 sample_entry_payload += box(b'avcC', avcc_payload) # AVC Decoder Configuration Record
9d64e1dc 168 sample_entry_box = box(b'avc1', sample_entry_payload) # AVC Simple Entry
fd76a142
F
169 else:
170 assert False
66a1b864
F
171 elif stream_type == 'text':
172 if fourcc == 'TTML':
173 sample_entry_payload += b'http://www.w3.org/ns/ttml\0' # namespace
174 sample_entry_payload += b'\0' # schema location
175 sample_entry_payload += b'\0' # auxilary mime types(??)
176 sample_entry_box = box(b'stpp', sample_entry_payload)
177 else:
178 assert False
fd76a142
F
179 else:
180 assert False
9d64e1dc 181 stsd_payload += sample_entry_box
b2758123
RA
182
183 stbl_payload = full_box(b'stsd', 0, 0, stsd_payload) # Sample Description Box
184
185 stts_payload = u32.pack(0) # entry count
186 stbl_payload += full_box(b'stts', 0, 0, stts_payload) # Decoding Time to Sample Box
187
188 stsc_payload = u32.pack(0) # entry count
189 stbl_payload += full_box(b'stsc', 0, 0, stsc_payload) # Sample To Chunk Box
190
191 stco_payload = u32.pack(0) # entry count
192 stbl_payload += full_box(b'stco', 0, 0, stco_payload) # Chunk Offset Box
193
194 minf_payload += box(b'stbl', stbl_payload) # Sample Table Box
195
196 mdia_payload += box(b'minf', minf_payload) # Media Information Box
197
198 trak_payload += box(b'mdia', mdia_payload) # Media Box
199
200 moov_payload += box(b'trak', trak_payload) # Track Box
201
202 mehd_payload = u64.pack(duration)
203 mvex_payload = full_box(b'mehd', 1, 0, mehd_payload) # Movie Extends Header Box
204
205 trex_payload = u32.pack(track_id) # track id
206 trex_payload += u32.pack(1) # default sample description index
207 trex_payload += u32.pack(0) # default sample duration
208 trex_payload += u32.pack(0) # default sample size
209 trex_payload += u32.pack(0) # default sample flags
210 mvex_payload += full_box(b'trex', 0, 0, trex_payload) # Track Extends Box
211
212 moov_payload += box(b'mvex', mvex_payload) # Movie Extends Box
213 stream.write(box(b'moov', moov_payload)) # Movie Box
214
215
216def extract_box_data(data, box_sequence):
217 data_reader = io.BytesIO(data)
218 while True:
219 box_size = u32.unpack(data_reader.read(4))[0]
220 box_type = data_reader.read(4)
221 if box_type == box_sequence[0]:
222 box_data = data_reader.read(box_size - 8)
223 if len(box_sequence) == 1:
224 return box_data
225 return extract_box_data(box_data, box_sequence[1:])
226 data_reader.seek(box_size - 8, 1)
227
228
229class IsmFD(FragmentFD):
230 """
231 Download segments in a ISM manifest
232 """
233
b2758123
RA
234 def real_download(self, filename, info_dict):
235 segments = info_dict['fragments'][:1] if self.params.get(
236 'test', False) else info_dict['fragments']
237
238 ctx = {
239 'filename': filename,
240 'total_frags': len(segments),
241 }
242
3ba7740d 243 self._prepare_and_start_frag_download(ctx, info_dict)
b2758123 244
d4553567
F
245 extra_state = ctx.setdefault('extra_state', {
246 'ism_track_written': False,
247 })
248
b2758123
RA
249 skip_unavailable_fragments = self.params.get('skip_unavailable_fragments', True)
250
75a24854 251 frag_index = 0
b2758123 252 for i, segment in enumerate(segments):
75a24854 253 frag_index += 1
3e0304fe 254 if frag_index <= ctx['fragment_index']:
75a24854 255 continue
be5c1ae8 256
257 retry_manager = RetryManager(self.params.get('fragment_retries'), self.report_retry,
258 frag_index=frag_index, fatal=not skip_unavailable_fragments)
259 for retry in retry_manager:
b2758123 260 try:
d71fd412 261 success = self._download_fragment(ctx, segment['url'], info_dict)
b2758123
RA
262 if not success:
263 return False
d71fd412
LNO
264 frag_content = self._read_fragment(ctx)
265
d4553567 266 if not extra_state['ism_track_written']:
75a24854 267 tfhd_data = extract_box_data(frag_content, [b'moof', b'traf', b'tfhd'])
b2758123
RA
268 info_dict['_download_params']['track_id'] = u32.unpack(tfhd_data[4:8])[0]
269 write_piff_header(ctx['dest_stream'], info_dict['_download_params'])
d4553567 270 extra_state['ism_track_written'] = True
75a24854 271 self._append_fragment(ctx, frag_content)
ac668111 272 except urllib.error.HTTPError as err:
be5c1ae8 273 retry.error = err
b2758123 274 continue
b2758123 275
be5c1ae8 276 if retry_manager.error:
277 if not skip_unavailable_fragments:
278 return False
279 self.report_skip_fragment(frag_index)
b2758123 280
be5c1ae8 281 self._finish_frag_download(ctx, info_dict)
b2758123 282 return True