Merge pull request #227 from markus-wa/pov-demos

markus-wa · web-flow · commit 2a0d19c9268c · 2020-07-15T00:47:31.000+01:00
full support for POV demos
diff --git a/README.md b/README.md
@@ -129,13 +129,13 @@ Check out the [examples](examples) folder for more examples, like [how to genera
 * Access to all net-messages - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs?tab=doc#NetMessageCreator) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/net-messages)
 * Chat & console messages <sup id="achat1">1</sup> - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#ChatMessage) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
 * Matchmaking ranks (official MM demos only) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#RankUpdate)
-* POV demo support <sup id="achat1">2</sup>
+* Full POV demo support <sup id="achat1">2</sup>
 * JavaScript (browser / Node.js) support via WebAssembly - [example](https://github.com/markus-wa/demoinfocs-wasm)
 * [Easy debugging via build-flags](#debugging)
 * Built with performance & concurrency in mind
 
 1. <small id="f1">Only for some demos; in MM demos the chat is encrypted for example.</small>
-2. <small id="f2">Only partially supported (as good as other parsers), some POV demos seem to be inherently broken</small>
+2. <small id="f2">Better than some other parsers at the time of writing.</small>
 
 ## Performance / Benchmarks
 
diff --git a/examples/print-events/print_events.go b/examples/print-events/print_events.go
@@ -35,7 +35,7 @@ func main() {
 		if e.PenetratedObjects > 0 {
 			wallBang = " (WB)"
 		}
-		fmt.Printf("%s <%v%s%s> %s\n", formatPlayer(e.Killer), e.Weapon.Type, hs, wallBang, formatPlayer(e.Victim))
+		fmt.Printf("%s <%v%s%s> %s\n", formatPlayer(e.Killer), e.Weapon, hs, wallBang, formatPlayer(e.Victim))
 	})
 
 	// Register handler on round end to figure out who won
@@ -78,6 +78,7 @@ func formatPlayer(p *common.Player) string {
 	case common.TeamCounterTerrorists:
 		return "[CT]" + p.Name
 	}
+
 	return p.Name
 }
 
diff --git a/pkg/demoinfocs/datatables.go b/pkg/demoinfocs/datatables.go
@@ -472,26 +472,24 @@ func (p *parser) bindWeapon(entity st.Entity, wepType common.EquipmentType) {
 	modelIndex := entity.Property("m_nModelIndex").Value().IntVal
 	eq.OriginalString = p.modelPreCache[modelIndex]
 
-	wepFix := func(defaultName, altName string, alt common.EquipmentType) {
+	wepFix := func(altName string, alt common.EquipmentType) {
 		// Check 'altName' first because otherwise the m4a1_s is recognized as m4a4
 		if strings.Contains(eq.OriginalString, altName) {
 			eq.Type = alt
-		} else if !strings.Contains(eq.OriginalString, defaultName) {
-			p.setError(fmt.Errorf("unknown weapon model %q", eq.OriginalString))
 		}
 	}
 
 	switch eq.Type {
 	case common.EqP2000:
-		wepFix("_pist_hkp2000", "_pist_223", common.EqUSP)
+		wepFix("_pist_223", common.EqUSP)
 	case common.EqM4A4:
-		wepFix("_rif_m4a1", "_rif_m4a1_s", common.EqM4A1)
+		wepFix("_rif_m4a1_s", common.EqM4A1)
 	case common.EqP250:
-		wepFix("_pist_p250", "_pist_cz_75", common.EqCZ)
+		wepFix("_pist_cz_75", common.EqCZ)
 	case common.EqDeagle:
-		wepFix("_pist_deagle", "_pist_revolver", common.EqRevolver)
+		wepFix("_pist_revolver", common.EqRevolver)
 	case common.EqMP7:
-		wepFix("_smg_mp7", "_smg_mp5sd", common.EqMP5)
+		wepFix("_smg_mp5sd", common.EqMP5)
 	}
 }
 
diff --git a/pkg/demoinfocs/game_events.go b/pkg/demoinfocs/game_events.go
@@ -22,7 +22,6 @@ func (p *parser) handleGameEventList(gel *msg.CSVCMsg_GameEventList) {
 func (p *parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 	if p.gameEventDescs == nil {
 		p.eventDispatcher.Dispatch(events.ParserWarn{Message: "received GameEvent but event descriptors are missing"})
-		unassert.Error("received GameEvent but event descriptors are missing")
 
 		return
 	}
@@ -107,6 +106,7 @@ func newGameEventHandler(parser *parser) gameEventHandler {
 
 	geh.gameEventNameToHandler = map[string]gameEventHandlerFunc{
 		// sorted alphabetically
+		"ammo_pickup":                     nil,                                   // Dunno, only in locally recorded (POV) demo
 		"announce_phase_end":              nil,                                   // Dunno
 		"begin_new_match":                 geh.beginNewMatch,                     // Match started
 		"bomb_beep":                       nil,                                   // Bomb beep
@@ -119,6 +119,7 @@ func newGameEventHandler(parser *parser) gameEventHandler {
 		"bomb_planted":                    delayIfNoPlayers(geh.bombPlanted),     // Plant finished
 		"bot_takeover":                    delay(geh.botTakeover),                // Bot got taken over
 		"buytime_ended":                   nil,                                   // Not actually end of buy time, seems to only be sent once per game at the start
+		"cs_intermission":                 nil,                                   // Dunno, only in locally recorded (POV) demo
 		"cs_match_end_restart":            nil,                                   // Yawn
 		"cs_pre_restart":                  nil,                                   // Not sure, doesn't seem to be important
 		"cs_round_final_beep":             nil,                                   // Final beep
@@ -128,24 +129,26 @@ func newGameEventHandler(parser *parser) gameEventHandler {
 		"decoy_detonate":                  geh.decoyDetonate,                     // Decoy exploded/expired
 		"decoy_started":                   delay(geh.decoyStarted),               // Decoy started. Delayed because projectile entity is not yet created
 		"endmatch_cmm_start_reveal_items": nil,                                   // Drops
-		"entity_visible":                  nil,                                   // Dunno, only in locally recorded demo
-		"enter_bombzone":                  nil,                                   // Dunno, only in locally recorded demo
-		"exit_bombzone":                   nil,                                   // Dunno, only in locally recorded demo
-		"enter_buyzone":                   nil,                                   // Dunno, only in locally recorded demo
-		"exit_buyzone":                    nil,                                   // Dunno, only in locally recorded demo
+		"entity_visible":                  nil,                                   // Dunno, only in locally recorded (POV) demo
+		"enter_bombzone":                  nil,                                   // Dunno, only in locally recorded (POV) demo
+		"exit_bombzone":                   nil,                                   // Dunno, only in locally recorded (POV) demo
+		"enter_buyzone":                   nil,                                   // Dunno, only in locally recorded (POV) demo
+		"exit_buyzone":                    nil,                                   // Dunno, only in locally recorded (POV) demo
 		"flashbang_detonate":              geh.flashBangDetonate,                 // Flash exploded
 		"hegrenade_detonate":              geh.heGrenadeDetonate,                 // HE exploded
 		"hltv_chase":                      nil,                                   // Don't care
 		"hltv_fixed":                      nil,                                   // Dunno
 		"hltv_message":                    nil,                                   // No clue
 		"hltv_status":                     nil,                                   // Don't know
+		"hostname_changed":                nil,                                   // Only present in locally recorded (POV) demos
 		"inferno_expire":                  geh.infernoExpire,                     // Incendiary expired
 		"inferno_startburn":               delay(geh.infernoStartBurn),           // Incendiary exploded/started. Delayed because inferno entity is not yet created
-		"inspect_weapon":                  nil,                                   // Dunno, only in locally recorded demo
+		"inspect_weapon":                  nil,                                   // Dunno, only in locally recorded (POV) demos
 		"item_equip":                      delay(geh.itemEquip),                  // Equipped / weapon swap, I think. Delayed because of #142 - Bot entity possibly not yet created
 		"item_pickup":                     delay(geh.itemPickup),                 // Picked up or bought? Delayed because of #119 - Equipment.UniqueID()
+		"item_pickup_slerp":               nil,                                   // Not sure, only in locally recorded (POV) demos
 		"item_remove":                     geh.itemRemove,                        // Dropped?
-		"jointeam_failed":                 nil,                                   // Dunno, only in locally recorded demo
+		"jointeam_failed":                 nil,                                   // Dunno, only in locally recorded (POV) demos
 		"other_death":                     nil,                                   // Dunno
 		"player_blind":                    delay(geh.playerBlind),                // Player got blinded by a flash. Delayed because Player.FlashDuration hasn't been updated yet
 		"player_changename":               nil,                                   // Name change
@@ -158,7 +161,8 @@ func newGameEventHandler(parser *parser) gameEventHandler {
 		"player_hurt":                     geh.playerHurt,                        // Player got hurt
 		"player_jump":                     geh.playerJump,                        // Player jumped
 		"player_spawn":                    nil,                                   // Player spawn
-		"player_given_c4":                 nil,                                   // Dunno, only present in POV demos
+		"player_spawned":                  nil,                                   // Only present in locally recorded (POV) demos
+		"player_given_c4":                 nil,                                   // Dunno, only present in locally recorded (POV) demos
 
 		// Player changed team. Delayed for two reasons
 		// - team IDs of other players changing teams in the same tick might not have changed yet
@@ -187,7 +191,7 @@ func newGameEventHandler(parser *parser) gameEventHandler {
 		"weapon_fire_on_empty":           nil,                              // Sounds boring
 		"weapon_reload":                  geh.weaponReload,                 // Weapon reloaded
 		"weapon_zoom":                    nil,                              // Zooming in
-		"weapon_zoom_rifle":              nil,                              // Dunno, only in locally recorded demo
+		"weapon_zoom_rifle":              nil,                              // Dunno, only in locally recorded (POV) demo
 	}
 
 	return geh
@@ -523,7 +527,11 @@ func (geh gameEventHandler) bombPlanted(data map[string]*msg.CSVCMsg_GameEventKe
 	}
 
 	event := events.BombPlanted{BombEvent: bombEvent}
-	event.Player.IsPlanting = false
+
+	if event.Player != nil { // if not nil check is necessary for POV demos
+		event.Player.IsPlanting = false
+	}
+
 	geh.parser.gameState.currentPlanter = nil
 	geh.dispatch(event)
 }
@@ -681,10 +689,6 @@ func (geh gameEventHandler) getThrownGrenade(p *common.Player, wepType common.Eq
 		}
 	}
 
-	// smokes might have duplicate smokegrenade_expired events, so it could have already been deleted.
-	// if it's not a smoke this should never be reached
-	unassert.Samef(wepType, common.EqSmoke, "tried to get non-existing grenade from gameState.thrownGrenades")
-
 	return nil
 }
 
@@ -705,10 +709,6 @@ func (geh gameEventHandler) deleteThrownGrenade(p *common.Player, wepType common
 			return
 		}
 	}
-
-	// smokes might have duplicate smokegrenade_expired events, so it might already be deleted.
-	// besides that this code should never be reached
-	unassert.Samef(wepType, common.EqSmoke, "trying to delete non-existing grenade from gameState.thrownGrenades")
 }
 
 func (geh gameEventHandler) attackerWeaponType(wepType common.EquipmentType, victimUserID int32) common.EquipmentType {
diff --git a/pkg/demoinfocs/game_state.go b/pkg/demoinfocs/game_state.go
@@ -276,18 +276,8 @@ func (ptcp participants) FindByHandle(handle int) *common.Player {
 	}
 
 	entityID := handle & constants.EntityHandleIndexMask
-	player := ptcp.playersByEntityID[entityID]
-
-	if player == nil {
-		for _, p := range ptcp.playersByUserID {
-			if p.EntityID == entityID {
-				player = p
-				break
-			}
-		}
-	}
 
-	return player
+	return ptcp.playersByEntityID[entityID]
 }
 
 func (ptcp participants) initializeSliceFromByUserID() ([]*common.Player, map[int]*common.Player) {
diff --git a/pkg/demoinfocs/net_messages.go b/pkg/demoinfocs/net_messages.go
@@ -8,8 +8,6 @@ import (
 	msg "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/msg"
 )
 
-const entitySentinel = 9999
-
 func (p *parser) handlePacketEntities(pe *msg.CSVCMsg_PacketEntities) {
 	defer func() {
 		p.setError(recoverFromUnexpectedEOF(recover()))
@@ -21,31 +19,30 @@ func (p *parser) handlePacketEntities(pe *msg.CSVCMsg_PacketEntities) {
 	for i := 0; i < int(pe.UpdatedEntries); i++ {
 		currentEntity += 1 + int(r.ReadUBitInt())
 
-		if currentEntity > entitySentinel {
-			break
-		}
-
-		if r.ReadBit() {
-			// Leave PVS
-			if entity := p.gameState.entities[currentEntity]; entity != nil {
-				entity.Destroy()
-				delete(p.gameState.entities, currentEntity)
-			}
+		cmd := r.ReadBitsToByte(2)
+		if cmd&1 == 0 {
+			if cmd&2 != 0 {
+				// Enter PVS
+				if existing := p.gameState.entities[currentEntity]; existing != nil {
+					// Sometimes entities don't get destroyed when they should be
+					// For instance when a player is replaced by a BOT
+					existing.Destroy()
+				}
 
-			// 'Force Delete' flag, not exactly sure what it's supposed to do
-			r.ReadBit()
-		} else if r.ReadBit() {
-			// Enter PVS
-			if existing := p.gameState.entities[currentEntity]; existing != nil {
-				// Sometimes entities don't get destroyed when they should be
-				// For instance when a player is replaced by a BOT
-				existing.Destroy()
+				p.gameState.entities[currentEntity] = p.stParser.ReadEnterPVS(r, currentEntity)
+			} else { //nolint:gocritic
+				// Delta Update
+				if entity := p.gameState.entities[currentEntity]; entity != nil {
+					entity.ApplyUpdate(r)
+				}
 			}
-			p.gameState.entities[currentEntity] = p.stParser.ReadEnterPVS(r, currentEntity)
-		} else { //nolint:gocritic
-			// Delta Update
-			if entity := p.gameState.entities[currentEntity]; entity != nil {
-				entity.ApplyUpdate(r)
+		} else {
+			if cmd&2 != 0 {
+				// Leave PVS
+				if entity := p.gameState.entities[currentEntity]; entity != nil {
+					entity.Destroy()
+					delete(p.gameState.entities, currentEntity)
+				}
 			}
 		}
 	}
diff --git a/test/cs-demos b/test/cs-demos
@@ -1 +1 @@
-Subproject commit e8d28514ca84407b4140d79e3595eca74f624ab3
+Subproject commit 87e0ac713768d21b54e9cd7574f08f194837ec83

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func main() {`
`35`	`35`	`if e.PenetratedObjects > 0 {`
`36`	`36`	`wallBang = " (WB)"`
`37`	`37`	`}`
`38`		`- fmt.Printf("%s <%v%s%s> %s\n", formatPlayer(e.Killer), e.Weapon.Type, hs, wallBang, formatPlayer(e.Victim))`
	`38`	`+ fmt.Printf("%s <%v%s%s> %s\n", formatPlayer(e.Killer), e.Weapon, hs, wallBang, formatPlayer(e.Victim))`
`39`	`39`	`})`
`40`	`40`
`41`	`41`	`// Register handler on round end to figure out who won`
`@@ -78,6 +78,7 @@ func formatPlayer(p *common.Player) string {`
`78`	`78`	`case common.TeamCounterTerrorists:`
`79`	`79`	`return "[CT]" + p.Name`
`80`	`80`	`}`
	`81`	`+`
`81`	`82`	`return p.Name`
`82`	`83`	`}`
`83`	`84`