forked from Blizzard/s2protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathprotocol15405.py
382 lines (340 loc) · 19.1 KB
/
protocol15405.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
# Copyright (c) 2013 Blizzard Entertainment
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from decoders import *
# Decoding instructions for each protocol type.
typeinfos = [
('_int',[(0,7)]), #0
('_int',[(0,4)]), #1
('_int',[(0,6)]), #2
('_int',[(0,14)]), #3
('_int',[(0,22)]), #4
('_int',[(0,32)]), #5
('_choice',[(0,2),{0:('m_uint6',2),1:('m_uint14',3),2:('m_uint22',4),3:('m_uint32',5)}]), #6
('_int',[(0,5)]), #7
('_struct',[[('m_playerId',7,-1)]]), #8
('_blob',[(0,8)]), #9
('_int',[(0,8)]), #10
('_struct',[[('m_flags',10,0),('m_major',10,1),('m_minor',10,2),('m_revision',10,3),('m_build',5,4),('m_baseBuild',5,5)]]), #11
('_int',[(0,3)]), #12
('_struct',[[('m_signature',9,0),('m_version',11,1),('m_type',12,2),('m_elapsedGameLoops',5,3)]]), #13
('_fourcc',[]), #14
('_blob',[(0,7)]), #15
('_int',[(0,64)]), #16
('_struct',[[('m_region',10,0),('m_programId',14,1),('m_realm',5,2),('m_name',15,3),('m_id',16,4)]]), #17
('_struct',[[('m_a',10,0),('m_r',10,1),('m_g',10,2),('m_b',10,3)]]), #18
('_int',[(0,2)]), #19
('_struct',[[('m_name',9,0),('m_toon',17,1),('m_race',9,2),('m_color',18,3),('m_control',10,4),('m_teamId',1,5),('m_handicap',0,6),('m_observe',19,7),('m_result',19,8)]]), #20
('_array',[(0,5),20]), #21
('_optional',[21]), #22
('_blob',[(0,10)]), #23
('_blob',[(0,11)]), #24
('_struct',[[('m_file',24,0)]]), #25
('_bool',[]), #26
('_int',[(-9223372036854775808,64)]), #27
('_blob',[(0,12)]), #28
('_blob',[(40,0)]), #29
('_array',[(0,4),29]), #30
('_optional',[30]), #31
('_struct',[[('m_playerList',22,0),('m_title',23,1),('m_difficulty',9,2),('m_thumbnail',25,3),('m_isBlizzardMap',26,4),('m_timeUTC',27,5),('m_timeLocalOffset',27,6),('m_description',28,7),('m_imageFilePath',24,8),('m_mapFileName',24,9),('m_cacheHandles',31,10),('m_miniSave',26,11),('m_gameSpeed',12,12),('m_defaultDifficulty',2,13)]]), #32
('_optional',[10]), #33
('_struct',[[('m_race',33,-1)]]), #34
('_struct',[[('m_name',9,-6),('m_randomSeed',5,-5),('m_racePreference',34,-4),('m_testMap',26,-3),('m_testAuto',26,-2),('m_observe',19,-1)]]), #35
('_array',[(0,5),35]), #36
('_struct',[[('m_lockTeams',26,-11),('m_teamsTogether',26,-10),('m_advancedSharedControl',26,-9),('m_randomRaces',26,-8),('m_battleNet',26,-7),('m_amm',26,-6),('m_ranked',26,-5),('m_noVictoryOrDefeat',26,-4),('m_fog',19,-3),('m_observers',19,-2),('m_userDifficulty',19,-1)]]), #37
('_int',[(1,4)]), #38
('_int',[(1,5)]), #39
('_int',[(1,8)]), #40
('_bitarray',[(0,6)]), #41
('_bitarray',[(0,8)]), #42
('_bitarray',[(0,2)]), #43
('_struct',[[('m_allowedColors',41,-5),('m_allowedRaces',42,-4),('m_allowedDifficulty',41,-3),('m_allowedControls',42,-2),('m_allowedObserveTypes',43,-1)]]), #44
('_array',[(0,5),44]), #45
('_struct',[[('m_randomValue',5,-23),('m_gameCacheName',23,-22),('m_gameOptions',37,-21),('m_gameSpeed',12,-20),('m_gameType',12,-19),('m_maxUsers',7,-18),('m_maxObservers',7,-17),('m_maxPlayers',7,-16),('m_maxTeams',38,-15),('m_maxColors',39,-14),('m_maxRaces',40,-13),('m_maxControls',40,-12),('m_mapSizeX',10,-11),('m_mapSizeY',10,-10),('m_mapFileSyncChecksum',5,-9),('m_mapFileName',24,-8),('m_mapAuthorName',9,-7),('m_modFileSyncChecksum',5,-6),('m_slotDescriptions',45,-5),('m_defaultDifficulty',2,-4),('m_cacheHandles',30,-3),('m_isBlizzardMap',26,-2),('m_isPremadeFFA',26,-1)]]), #46
('_optional',[1]), #47
('_optional',[7]), #48
('_struct',[[('m_color',48,-1)]]), #49
('_array',[(0,5),5]), #50
('_struct',[[('m_control',10,-9),('m_userId',47,-8),('m_teamId',1,-7),('m_colorPref',49,-6),('m_racePref',34,-5),('m_difficulty',2,-4),('m_handicap',0,-3),('m_observe',19,-2),('m_rewards',50,-1)]]), #51
('_array',[(0,5),51]), #52
('_struct',[[('m_phase',12,-9),('m_maxUsers',7,-8),('m_maxObservers',7,-7),('m_slots',52,-6),('m_randomSeed',5,-5),('m_hostUserId',47,-4),('m_isSinglePlayer',26,-3),('m_gameDuration',5,-2),('m_defaultDifficulty',2,-1)]]), #53
('_struct',[[('m_userInitialData',36,-3),('m_gameDescription',46,-2),('m_lobbyState',53,-1)]]), #54
('_struct',[[('m_syncLobbyState',54,-1)]]), #55
('_struct',[[('m_name',15,-1)]]), #56
('_blob',[(0,6)]), #57
('_struct',[[('m_name',57,-1)]]), #58
('_struct',[[('m_name',57,-3),('m_type',5,-2),('m_data',15,-1)]]), #59
('_struct',[[('m_type',5,-3),('m_name',57,-2),('m_data',28,-1)]]), #60
('_struct',[[('m_developmentCheatsEnabled',26,-4),('m_multiplayerCheatsEnabled',26,-3),('m_syncChecksummingEnabled',26,-2),('m_isMapToMapTransition',26,-1)]]), #61
('_struct',[[]]), #62
('_struct',[[('m_fileName',24,-5),('m_automatic',26,-4),('m_overwrite',26,-3),('m_name',9,-2),('m_description',23,-1)]]), #63
('_int',[(-2147483648,32)]), #64
('_struct',[[('x',64,-2),('y',64,-1)]]), #65
('_struct',[[('m_point',65,-4),('m_time',64,-3),('m_verb',23,-2),('m_arguments',23,-1)]]), #66
('_struct',[[('m_data',66,-1)]]), #67
('_int',[(0,16)]), #68
('_struct',[[('x',64,-3),('y',64,-2),('z',64,-1)]]), #69
('_struct',[[('m_cmdFlags',5,-11),('m_abilLink',68,-10),('m_abilCmdIndex',10,-9),('m_abilCmdData',10,-8),('m_targetUnitFlags',10,-7),('m_targetUnitTimer',10,-6),('m_otherUnit',5,-5),('m_targetUnitTag',5,-4),('m_targetUnitSnapshotUnitLink',68,-3),('m_targetUnitSnapshotPlayerId',47,-2),('m_targetPoint',69,-1)]]), #70
('_struct',[[('__parent',42,-1)]]), #71
('_struct',[[('m_unitLink',68,-3),('m_intraSubgroupPriority',10,-2),('m_count',10,-1)]]), #72
('_array',[(0,8),72]), #73
('_array',[(0,8),5]), #74
('_struct',[[('m_subgroupIndex',10,-4),('m_removeMask',71,-3),('m_addSubgroups',73,-2),('m_addUnitTags',74,-1)]]), #75
('_struct',[[('m_controlGroupId',1,-2),('m_delta',75,-1)]]), #76
('_optional',[71]), #77
('_struct',[[('m_controlGroupIndex',1,-3),('m_controlGroupUpdate',19,-2),('m_mask',77,-1)]]), #78
('_struct',[[('m_count',10,-6),('m_subgroupCount',10,-5),('m_activeSubgroupIndex',10,-4),('m_unitTagsChecksum',5,-3),('m_subgroupIndicesChecksum',5,-2),('m_subgroupsChecksum',5,-1)]]), #79
('_struct',[[('m_controlGroupId',1,-2),('m_selectionSyncData',79,-1)]]), #80
('_array',[(0,3),64]), #81
('_struct',[[('m_recipientId',1,-2),('m_resources',81,-1)]]), #82
('_struct',[[('m_chatMessage',23,-1)]]), #83
('_int',[(-128,8)]), #84
('_struct',[[('m_beacon',84,-7),('m_ally',84,-6),('m_autocast',84,-5),('m_targetUnitTag',5,-4),('m_targetUnitSnapshotUnitLink',68,-3),('m_targetUnitSnapshotPlayerId',47,-2),('m_targetPoint',69,-1)]]), #85
('_struct',[[('m_speed',12,-1)]]), #86
('_struct',[[('m_delta',84,-1)]]), #87
('_struct',[[('m_verb',23,-2),('m_arguments',23,-1)]]), #88
('_struct',[[('m_alliance',5,-2),('m_control',5,-1)]]), #89
('_struct',[[('m_unitTag',5,-1)]]), #90
('_struct',[[('m_unitTag',5,-2),('m_flags',10,-1)]]), #91
('_struct',[[('m_conversationId',64,-2),('m_replyId',64,-1)]]), #92
('_struct',[[('m_purchaseItemId',64,-1)]]), #93
('_struct',[[('m_difficultyLevel',64,-1)]]), #94
('_null',[]), #95
('_choice',[(0,3),{0:('None',95),1:('Checked',26),2:('ValueChanged',5),3:('SelectionChanged',64),4:('TextChanged',24)}]), #96
('_struct',[[('m_controlId',64,-3),('m_eventType',64,-2),('m_eventData',96,-1)]]), #97
('_struct',[[('m_soundHash',5,-2),('m_length',5,-1)]]), #98
('_struct',[[('m_soundHash',74,-2),('m_length',74,-1)]]), #99
('_struct',[[('m_syncInfo',99,-1)]]), #100
('_struct',[[('m_sound',5,-1)]]), #101
('_struct',[[('m_transmissionId',64,-1)]]), #102
('_struct',[[('x',68,-2),('y',68,-1)]]), #103
('_optional',[68]), #104
('_struct',[[('m_target',103,-4),('m_distance',104,-3),('m_pitch',104,-2),('m_yaw',104,-1)]]), #105
('_int',[(0,1)]), #106
('_struct',[[('m_skipType',106,-1)]]), #107
('_struct',[[('m_button',5,-7),('m_down',26,-6),('m_posXUI',5,-5),('m_posYUI',5,-4),('m_posXWorld',64,-3),('m_posYWorld',64,-2),('m_posZWorld',64,-1)]]), #108
('_struct',[[('m_soundtrack',5,-1)]]), #109
('_struct',[[('m_planetId',64,-1)]]), #110
('_struct',[[('m_key',84,-2),('m_flags',84,-1)]]), #111
('_struct',[[('m_resources',81,-1)]]), #112
('_struct',[[('m_fulfillRequestId',64,-1)]]), #113
('_struct',[[('m_cancelRequestId',64,-1)]]), #114
('_struct',[[('m_researchItemId',64,-1)]]), #115
('_struct',[[('m_laggingPlayerId',1,-1)]]), #116
('_struct',[[('m_mercenaryId',64,-1)]]), #117
('_struct',[[('m_battleReportId',64,-2),('m_difficultyLevel',64,-1)]]), #118
('_struct',[[('m_battleReportId',64,-1)]]), #119
('_struct',[[('m_decrementMs',5,-1)]]), #120
('_struct',[[('m_portraitId',64,-1)]]), #121
('_struct',[[('m_functionName',15,-1)]]), #122
('_struct',[[('m_result',64,-1)]]), #123
('_struct',[[('m_gameMenuItemIndex',64,-1)]]), #124
('_struct',[[('m_reason',84,-1)]]), #125
('_struct',[[('m_purchaseCategoryId',64,-1)]]), #126
('_struct',[[('m_button',68,-1)]]), #127
('_struct',[[('m_recipient',19,-2),('m_string',24,-1)]]), #128
('_struct',[[('m_recipient',19,-2),('m_point',65,-1)]]), #129
('_struct',[[('m_progress',64,-1)]]), #130
]
# Map from protocol NNet.Game.*Event eventid to (typeid, name)
game_event_types = {
5: (62, 'NNet.Game.SUserFinishedLoadingSyncEvent'),
7: (56, 'NNet.Game.SBankFileEvent'),
8: (58, 'NNet.Game.SBankSectionEvent'),
9: (59, 'NNet.Game.SBankKeyEvent'),
10: (60, 'NNet.Game.SBankValueEvent'),
11: (61, 'NNet.Game.SUserOptionsEvent'),
22: (63, 'NNet.Game.SSaveGameEvent'),
23: (62, 'NNet.Game.SSaveGameDoneEvent'),
25: (62, 'NNet.Game.SPlayerLeaveEvent'),
26: (67, 'NNet.Game.SGameCheatEvent'),
27: (70, 'NNet.Game.SCmdEvent'),
28: (76, 'NNet.Game.SSelectionDeltaEvent'),
29: (78, 'NNet.Game.SControlGroupUpdateEvent'),
30: (80, 'NNet.Game.SSelectionSyncCheckEvent'),
31: (82, 'NNet.Game.SResourceTradeEvent'),
32: (83, 'NNet.Game.STriggerChatMessageEvent'),
33: (85, 'NNet.Game.SAICommunicateEvent'),
34: (86, 'NNet.Game.SSetAbsoluteGameSpeedEvent'),
35: (87, 'NNet.Game.SAddAbsoluteGameSpeedEvent'),
37: (88, 'NNet.Game.SBroadcastCheatEvent'),
38: (89, 'NNet.Game.SAllianceEvent'),
39: (90, 'NNet.Game.SUnitClickEvent'),
40: (91, 'NNet.Game.SUnitHighlightEvent'),
41: (92, 'NNet.Game.STriggerReplySelectedEvent'),
44: (62, 'NNet.Game.STriggerSkippedEvent'),
45: (98, 'NNet.Game.STriggerSoundLengthQueryEvent'),
46: (101, 'NNet.Game.STriggerSoundOffsetEvent'),
47: (102, 'NNet.Game.STriggerTransmissionOffsetEvent'),
48: (102, 'NNet.Game.STriggerTransmissionCompleteEvent'),
49: (105, 'NNet.Game.SCameraUpdateEvent'),
50: (62, 'NNet.Game.STriggerAbortMissionEvent'),
51: (93, 'NNet.Game.STriggerPurchaseMadeEvent'),
52: (62, 'NNet.Game.STriggerPurchaseExitEvent'),
53: (94, 'NNet.Game.STriggerPlanetMissionLaunchedEvent'),
54: (62, 'NNet.Game.STriggerPlanetPanelCanceledEvent'),
55: (97, 'NNet.Game.STriggerDialogControlEvent'),
56: (100, 'NNet.Game.STriggerSoundLengthSyncEvent'),
57: (107, 'NNet.Game.STriggerConversationSkippedEvent'),
58: (108, 'NNet.Game.STriggerMouseClickedEvent'),
63: (62, 'NNet.Game.STriggerPlanetPanelReplayEvent'),
64: (109, 'NNet.Game.STriggerSoundtrackDoneEvent'),
65: (110, 'NNet.Game.STriggerPlanetMissionSelectedEvent'),
66: (111, 'NNet.Game.STriggerKeyPressedEvent'),
67: (122, 'NNet.Game.STriggerMovieFunctionEvent'),
68: (62, 'NNet.Game.STriggerPlanetPanelBirthCompleteEvent'),
69: (62, 'NNet.Game.STriggerPlanetPanelDeathCompleteEvent'),
70: (112, 'NNet.Game.SResourceRequestEvent'),
71: (113, 'NNet.Game.SResourceRequestFulfillEvent'),
72: (114, 'NNet.Game.SResourceRequestCancelEvent'),
73: (62, 'NNet.Game.STriggerResearchPanelExitEvent'),
74: (62, 'NNet.Game.STriggerResearchPanelPurchaseEvent'),
75: (115, 'NNet.Game.STriggerResearchPanelSelectionChangedEvent'),
76: (116, 'NNet.Game.SLagMessageEvent'),
77: (62, 'NNet.Game.STriggerMercenaryPanelExitEvent'),
78: (62, 'NNet.Game.STriggerMercenaryPanelPurchaseEvent'),
79: (117, 'NNet.Game.STriggerMercenaryPanelSelectionChangedEvent'),
80: (62, 'NNet.Game.STriggerVictoryPanelExitEvent'),
81: (62, 'NNet.Game.STriggerBattleReportPanelExitEvent'),
82: (118, 'NNet.Game.STriggerBattleReportPanelPlayMissionEvent'),
83: (119, 'NNet.Game.STriggerBattleReportPanelPlaySceneEvent'),
84: (119, 'NNet.Game.STriggerBattleReportPanelSelectionChangedEvent'),
85: (94, 'NNet.Game.STriggerVictoryPanelPlayMissionAgainEvent'),
86: (62, 'NNet.Game.STriggerMovieStartedEvent'),
87: (62, 'NNet.Game.STriggerMovieFinishedEvent'),
88: (120, 'NNet.Game.SDecrementGameTimeRemainingEvent'),
89: (121, 'NNet.Game.STriggerPortraitLoadedEvent'),
90: (123, 'NNet.Game.STriggerCustomDialogDismissedEvent'),
91: (124, 'NNet.Game.STriggerGameMenuItemSelectedEvent'),
92: (125, 'NNet.Game.STriggerCameraMoveEvent'),
93: (93, 'NNet.Game.STriggerPurchasePanelSelectedPurchaseItemChangedEvent'),
94: (126, 'NNet.Game.STriggerPurchasePanelSelectedPurchaseCategoryChangedEvent'),
95: (127, 'NNet.Game.STriggerButtonPressedEvent'),
96: (62, 'NNet.Game.STriggerGameCreditsFinishedEvent'),
}
# The typeid of the NNet.Game.EEventId enum.
game_eventid_typeid = 0
# Map from protocol NNet.Game.*Message eventid to (typeid, name)
message_event_types = {
0: (128, 'NNet.Game.SChatMessage'),
1: (129, 'NNet.Game.SPingMessage'),
2: (130, 'NNet.Game.SLoadingProgressMessage'),
3: (62, 'NNet.Game.SServerPingMessage'),
}
# The typeid of the NNet.Game.EMessageId enum.
message_eventid_typeid = 1
# The typeid of NNet.SVarUint32 (the type used to encode gameloop deltas).
svaruint32_typeid = 6
# The typeid of NNet.Replay.SPlayerId (the type used to encode player ids).
replay_playerid_typeid = 8
# The typeid of NNet.Replay.SHeader (the type used to store replay game version and length).
replay_header_typeid = 13
# The typeid of NNet.Game.SDetails (the type used to store overall replay details).
game_details_typeid = 32
# The typeid of NNet.Replay.SInitData (the type used to store the inital lobby).
replay_initdata_typeid = 55
def _varuint32_value(value):
# Returns the numeric value from a SVarUint32 instance.
for k,v in value.iteritems():
return v
return 0
def _decode_event_stream(decoder, eventid_typeid, event_types, decode_player_id):
# Decodes events prefixed with a gameloop and possibly userid
gameloop = 0
while not decoder.done():
start_bits = decoder.used_bits()
# decode the gameloop delta before each event
delta = _varuint32_value(decoder.instance(svaruint32_typeid))
gameloop += delta
# decode the userid before each event
if decode_player_id:
playerid = decoder.instance(replay_playerid_typeid)
# decode the event id
eventid = decoder.instance(eventid_typeid)
typeid, typename = event_types.get(eventid, (None, None))
if typeid is None:
raise CorruptedError('eventid(%d) at %s' % (eventid, decoder))
# decode the event struct instance
event = decoder.instance(typeid)
event['_event'] = typename
event['_eventid'] = eventid
# insert gameloop and userid
event['_gameloop'] = gameloop
if decode_player_id:
event['_playerid'] = playerid
# the next event is byte aligned
decoder.byte_align()
# insert bits used in stream
event['_bits'] = decoder.used_bits() - start_bits
yield event
def decode_replay_game_events(contents):
"""Decodes and yields each game event from the contents byte string."""
decoder = BitPackedDecoder(contents, typeinfos)
for event in _decode_event_stream(decoder,
game_eventid_typeid,
game_event_types,
decode_player_id=True):
yield event
def decode_replay_message_events(contents):
"""Decodes and yields each message event from the contents byte string."""
decoder = BitPackedDecoder(contents, typeinfos)
for event in _decode_event_stream(decoder,
message_eventid_typeid,
message_event_types,
decode_player_id=True):
yield event
def decode_replay_header(contents):
"""Decodes and return the replay header from the contents byte string."""
decoder = VersionedDecoder(contents, typeinfos)
return decoder.instance(replay_header_typeid)
def decode_replay_details(contents):
"""Decodes and returns the game details from the contents byte string."""
decoder = VersionedDecoder(contents, typeinfos)
return decoder.instance(game_details_typeid)
def decode_replay_initdata(contents):
"""Decodes and return the replay init data from the contents byte string."""
decoder = BitPackedDecoder(contents, typeinfos)
return decoder.instance(replay_initdata_typeid)
def decode_replay_attributes_events(contents):
"""Decodes and yields each attribute from the contents byte string."""
buffer = BitPackedBuffer(contents, 'little')
attributes = {}
if not buffer.done():
attributes['source'] = None
attributes['mapNamespace'] = buffer.read_bits(32)
count = buffer.read_bits(32)
attributes['scopes'] = {}
while not buffer.done():
value = {}
value['namespace'] = buffer.read_bits(32)
value['attrid'] = attrid = buffer.read_bits(32)
scope = buffer.read_bits(8)
value['value'] = buffer.read_aligned_bytes(4)[::-1].strip('\x00')
if not scope in attributes['scopes']:
attributes['scopes'][scope] = {}
if not attrid in attributes['scopes'][scope]:
attributes['scopes'][scope][attrid] = []
attributes['scopes'][scope][attrid].append(value)
return attributes
def unit_tag(unitTagIndex, unitTagRecycle):
return (unitTagIndex << 18) + unitTagRecycle
def unit_tag_index(unitTag):
return (unitTag >> 18) & 0x00003fff
def unit_tag_recycle(unitTag):
return (unitTag) & 0x0003ffff