1

#include "stdafx.h"

     2

#include "ttd.h"

     3

#include "debug.h"

     4

#include "npf.h"

     5

#include "aystar.h"

     6

#include "macros.h"

     7

#include "pathfind.h"

     8

#include "station.h"

     9

#include "tile.h"

    10

#include "depot.h"

    11

    12

AyStar _train_find_station;

    13

AyStar _train_find_depot;

    14

AyStar _road_find_station;

    15

AyStar _road_find_depot;

    16

AyStar _npf_aystar;

    17

    18

/* Maps a trackdir to the bit that stores its status in the map arrays, in the

    19

 * direction along with the trackdir */

    20

const byte _signal_along_trackdir[14] = {

    21

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10, 0, 0,

    22

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20

    23

};

    24

    25

/* Maps a trackdir to the bit that stores its status in the map arrays, in the

    26

 * direction against the trackdir */

    27

const byte _signal_against_trackdir[14] = {

    28

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20, 0, 0,

    29

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10

    30

};

    31

    32

/* Maps a trackdir to the trackdirs that can be reached from it (ie, when

    33

 * entering the next tile */

    34

const uint16 _trackdir_reaches_trackdirs[14] = {

    35

	0x1009, 0x0016, 0x1009, 0x0016, 0x0520, 0x0016, 0, 0,

    36

	0x0520, 0x2A00, 0x2A00, 0x0520, 0x2A00, 0x1009

    37

};

    38

    39

/* Maps a trackdir to all trackdirs that make 90 deg turns with it. */

    40

const uint16 _trackdir_crosses_trackdirs[14] = {

    41

	0x0202, 0x0101, 0x3030, 0x3030, 0x0C0C, 0x0C0C, 0, 0,

    42

	0x0202, 0x0101, 0x3030, 0x3030, 0x0C0C, 0x0C0C

    43

};

    44

    45

/* Maps a track to all tracks that make 90 deg turns with it. */

    46

const byte _track_crosses_tracks[6] = {

    47

	0x2, /* Track 1 -> Track 2 */

    48

	0x1, /* Track 2 -> Track 1 */

    49

	0x30, /* Upper -> Left | Right */

    50

	0x30, /* Lower -> Left | Right */

    51

	0x0C, /* Left -> Upper | Lower */

    52

	0x0C, /* Right -> Upper | Lower */

    53

};

    54

    55

/* Maps a trackdir to the (4-way) direction the tile is exited when following

    56

 * that trackdir */

    57

const byte _trackdir_to_exitdir[14] = {

    58

	0,1,0,1,2,1, 0,0,

    59

	2,3,3,2,3,0,

    60

};

    61

    62

const byte _track_exitdir_to_trackdir[6][4] = {

    63

	{0,    0xff, 8,    0xff},

    64

	{0xff, 1,    0xff, 9},

    65

	{2,    0xff, 0xff, 10},

    66

	{0xff, 3,    11,   0xf},

    67

	{0xff, 0xff, 4,    12},

    68

	{13,   5,    0xff, 0xff}

    69

};

    70

    71

const byte _track_direction_to_trackdir[6][8] = {

    72

	{0xff, 0,    0xff, 0xff, 0xff, 8,    0xff, 0xff},

    73

	{0xff, 0xff, 0xff, 1,    0xff, 0xff, 0xff, 9},

    74

	{0xff, 0xff, 2,    0xff, 0xff, 0xff, 10,   0xff},

    75

	{0xff, 0xff, 3,    0xff, 0xff, 0xff, 11,   0xff},

    76

	{12,   0xff, 0xff, 0xff, 4,    0xff, 0xff, 0xff},

    77

	{13,   0xff, 0xff, 0xff, 5,    0xff, 0xff, 0xff}

    78

};

    79

    80

const byte _dir_to_diag_trackdir[4] = {

    81

	0, 1, 8, 9,

    82

};

    83

    84

const byte _reverse_dir[4] = {

    85

	2, 3, 0, 1

    86

};

    87

    88

const byte _reverse_trackdir[14] = {

    89

	8, 9, 10, 11, 12, 13, 0xFF, 0xFF,

    90

	0, 1, 2,  3,  4,  5

    91

};

    92

    93

/* The cost of each trackdir. A diagonal piece is the full NPF_TILE_LENGTH,

    94

 * the shorter piece is sqrt(2)/2*NPF_TILE_LENGTH =~ 0.7071

    95

 */

    96

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * 0.7071)

    97

static const uint _trackdir_length[14] = {

    98

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH,

    99

	0, 0,

   100

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

   101

};

   102

   103

uint NTPHash(uint key1, uint key2)

   104

{

   105

	/* This function uses the old hash, which is fixed on 10 bits (1024 buckets) */

   106

	return PATHFIND_HASH_TILE(key1);

   107

}

   108

   109

uint NPFHash(uint key1, uint key2)

   110

{

   111

	/* TODO: think of a better hash? */

   112

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

   113

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

   114

	/* The value of 14 below is based on the maximum value of key2 (13) */

   115

	return ((((part1 << NPF_HASH_HALFBITS) | part2)) + (NPF_HASH_SIZE * key2 / 14)) % NPF_HASH_SIZE;

   116

}

   117

   118

int32 NPFCalcZero(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   119

	return 0;

   120

}

   121

   122

/* Calcs the tile of given station that is closest to a given tile

   123

 * for this we assume the station is a rectangle,

   124

 * as defined by its top tile (st->train_tile) and its width/height (st->trainst_w, st->trainst_h)

   125

 */

   126

TileIndex CalcClosestStationTile(int station, TileIndex tile) {

   127

	const Station* st = GetStation(station);

   128

   129

	int x1,x2,x3,tx;

   130

	int y1,y2,y3,ty;

   131

   132

	x1 = TileX(st->train_tile);  y1 = TileY(st->train_tile);  // topmost corner of station

   133

	x2 = x1 + st->trainst_w - 1; y2 = y1 + st->trainst_h - 1; // lowermost corner of station

   134

	x3 = TileX(tile);            y3 = TileY(tile);            // tile we take the distance from

   135

   136

	// we are going the aim for the x coordinate of the closest corner

   137

	// but if we are between those coordinates, we will aim for our own x coordinate

   138

	if (x3 < x1)

   139

		tx = x1;

   140

	else if (x3 > x2)

   141

		tx = x2;

   142

	else

   143

		tx = x3;

   144

   145

	// same for y coordinate, see above comment

   146

	if (y3 < y1)

   147

		ty = y1;

   148

	else if (y3 > y2)

   149

		ty = y2;

   150

	else

   151

		ty = y3;

   152

   153

	// return the tile of our target coordinates

   154

	return TILE_XY(tx,ty);

   155

};

   156

   157

/* Calcs the heuristic to the target tile (using NPFFindStationOrTileData).

   158

 * If the target is a station, the heuristic is probably "wrong"! Normally

   159

 * this shouldn't matter, but if it turns out to be a problem, we could use

   160

 * the heuristic below?

   161

 * Afterthis  will save the heuristic into NPFFoundTargetData if it is the

   162

 * smallest until now. It will then also save

   163

 * AyStarNode.user_data[NPF_TRACKDIR_CHOICE] in best_trackdir

   164

 */

   165

int32 NPFCalcTileHeuristic(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   166

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   167

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   168

	TileIndex from = current->tile;

   169

	TileIndex to = fstd->dest_coords;

   170

	uint dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   171

   172

	if (dist < ftd->best_bird_dist) {

   173

		ftd->best_bird_dist = dist;

   174

		ftd->best_trackdir = current->user_data[NPF_TRACKDIR_CHOICE];

   175

	}

   176

#ifdef NPF_DEBUG

   177

	debug("Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);

   178

#endif

   179

	return dist;

   180

}

   181

   182

/* Calcs the heuristic to the target station or tile. Almost the same as above

   183

 * function, but calculates the distance to train stations with

   184

 * CalcClosestStationTile instead. So is somewhat more correct for stations

   185

 * (truly optimistic), but this added correctness is not really required we

   186

 * believe (matthijs & Hackykid)

   187

 */

   188

int32 NPFCalcStationOrTileHeuristic(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   189

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   190

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   191

	TileIndex from = current->tile;

   192

	TileIndex to = fstd->dest_coords;

   193

	uint dist;

   194

   195

	// for train-stations, we are going to aim for the closest station tile

   196

	if ((as->user_data[NPF_TYPE] == TRANSPORT_RAIL) && (fstd->station_index != -1))

   197

		to = CalcClosestStationTile(fstd->station_index, from);

   198

   199

	dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   200

   201

	if (dist < ftd->best_bird_dist) {

   202

		ftd->best_bird_dist = dist;

   203

		ftd->best_trackdir = current->user_data[NPF_TRACKDIR_CHOICE];

   204

	}

   205

#ifdef NPF_DEBUG

   206

	debug("Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);

   207

#endif

   208

	return dist;

   209

}

   210

   211

   212

/* Fills AyStarNode.user_data[NPF_TRACKDIRCHOICE] with the chosen direction to

   213

 * get here, either getting it from the current choice or from the parent's

   214

 * choice */

   215

void NPFFillTrackdirChoice(AyStarNode* current, OpenListNode* parent)

   216

{

   217

	if (parent->path.parent == NULL) {

   218

		byte trackdir = current->direction;

   219

		/* This is a first order decision, so we'd better save the

   220

		 * direction we chose */

   221

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   222

#ifdef NPF_DEBUG

   223

		debug("Saving trackdir: %#x", trackdir);

   224

#endif

   225

	} else {

   226

		/* We've already made the decision, so just save our parent's

   227

		 * decision */

   228

		current->user_data[NPF_TRACKDIR_CHOICE] = parent->path.node.user_data[NPF_TRACKDIR_CHOICE];

   229

	}

   230

   231

}

   232

   233

/* Will return the cost of the tunnel. If it is an entry, it will return the

   234

 * cost of that tile. If the tile is an exit, it will return the tunnel length

   235

 * including the exit tile. Requires that this is a Tunnel tile */

   236

uint NPFTunnelCost(AyStarNode* current) {

   237

	byte exitdir = _trackdir_to_exitdir[current->direction];

   238

	TileIndex tile = current->tile;

   239

	if ( (uint)(_map5[tile] & 3) == _reverse_dir[exitdir]) {

   240

		/* We just popped out if this tunnel, since were

   241

		 * facing the tunnel exit */

   242

		FindLengthOfTunnelResult flotr;

   243

		flotr = FindLengthOfTunnel(tile, _reverse_dir[exitdir]);

   244

		return flotr.length * NPF_TILE_LENGTH;

   245

		//TODO: Penalty for tunnels?

   246

	} else {

   247

		/* We are entering the tunnel, the enter tile is just a

   248

		 * straight track */

   249

		return NPF_TILE_LENGTH;

   250

	}

   251

}

   252

   253

uint NPFSlopeCost(AyStarNode* current) {

   254

	TileIndex next = current->tile + TileOffsByDir(_trackdir_to_exitdir[current->direction]);

   255

	int x,y;

   256

	int8 z1,z2;

   257

   258

	x = TileX(current->tile) * 16;

   259

	y = TileY(current->tile) * 16;

   260

	z1 = GetSlopeZ(x+8, y+8);

   261

   262

	x = TileX(next) * 16;

   263

	y = TileY(next) * 16;

   264

	z2 = GetSlopeZ(x+8, y+8);

   265

   266

	if ((z2 - z1) > 1) {

   267

		/* Slope up */

   268

		return _patches.npf_rail_slope_penalty;

   269

	}

   270

	return 0;

   271

	/* Should we give a bonus for slope down? Probably not, we

   272

	 * could just substract that bonus from the penalty, because

   273

	 * there is only one level of steepness... */

   274

}

   275

   276

void NPFMarkTile(TileIndex tile) {

   277

	switch(GetTileType(tile)) {

   278

		case MP_RAILWAY:

   279

		case MP_STREET:

   280

			/* DEBUG: mark visited tiles by mowing the grass under them

   281

			 * ;-) */

   282

			_map2[tile] &= ~15;

   283

			MarkTileDirtyByTile(tile);

   284

			break;

   285

		default:

   286

			break;

   287

	}

   288

}

   289

   290

int32 NPFWaterPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   291

	//TileIndex tile = current->tile;

   292

	int32 cost = 0;

   293

	byte trackdir = current->direction;

   294

   295

	cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   296

   297

	/* TODO Penalties? */

   298

   299

	return cost;

   300

}

   301

   302

/* Determine the cost of this node, for road tracks */

   303

int32 NPFRoadPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   304

	TileIndex tile = current->tile;

   305

	int32 cost = 0;

   306

	/* Determine base length */

   307

	switch (GetTileType(tile)) {

   308

		case MP_TUNNELBRIDGE:

   309

			if ((_map5[tile] & 0xF0)==0) {

   310

				cost = NPFTunnelCost(current);

   311

				break;

   312

			}

   313

			/* Fall through if above if is false, it is a bridge

   314

			 * then. We treat that as ordinary rail */

   315

		case MP_STREET:

   316

			cost = NPF_TILE_LENGTH;

   317

			break;

   318

		default:

   319

			break;

   320

	}

   321

   322

	/* Determine extra costs */

   323

   324

	/* Check for slope */

   325

	cost += NPFSlopeCost(current);

   326

   327

	/* Check for turns */

   328

	//TODO

   329

   330

#ifdef NPF_MARKROUTE

   331

	NPFMarkTile(tile);

   332

#endif

   333

#ifdef NPF_DEBUG

   334

	debug("Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);

   335

#endif

   336

	return cost;

   337

}

   338

   339

   340

/* Determine the cost of this node, for railway tracks */

   341

int32 NPFRailPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   342

	TileIndex tile = current->tile;

   343

	byte trackdir = current->direction;

   344

	int32 cost = 0;

   345

	OpenListNode new_node;

   346

   347

	/* Determine base length */

   348

	switch (GetTileType(tile)) {

   349

		case MP_TUNNELBRIDGE:

   350

			if ((_map5[tile] & 0xF0)==0) {

   351

				cost = NPFTunnelCost(current);

   352

				break;

   353

			}

   354

			/* Fall through if above if is false, it is a bridge

   355

			 * then. We treat that as ordinary rail */

   356

		case MP_RAILWAY:

   357

			cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   358

			break;

   359

		case MP_STREET: /* Railway crossing */

   360

			cost = NPF_TILE_LENGTH;

   361

			break;

   362

		case MP_STATION:

   363

			/* We give a station tile a penalty. Logically we would only

   364

					* want to give station tiles that are not our destination

   365

					* this penalty. This would discourage trains to drive through

   366

					* busy stations. But, we can just give any station tile a

   367

					* penalty, because every possible route will get this penalty

   368

					* exactly once, on its end tile (if it's a station) and it

   369

			* will therefore not make a difference. */

   370

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   371

			break;

   372

		default:

   373

			break;

   374

	}

   375

   376

	/* Determine extra costs */

   377

   378

	/* Check for signals */

   379

	if (IsTileType(tile, MP_RAILWAY) && (_map5[tile] & 0xC0) == 0x40 && (_map3_lo[tile] & _signal_along_trackdir[trackdir]) != 0) {

   380

		/* Ordinary track with signals */

   381

		if ((_map2[tile] & _signal_along_trackdir[trackdir]) == 0) {

   382

			/* Signal facing us is red */

   383

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   384

				/* Penalize the first signal we

   385

				 * encounter, if it is red */

   386

   387

				/* Is this a presignal exit or combo? */

   388

				if ((_map3_hi[tile] & 0x3) == 0x2 || (_map3_hi[tile] & 0x3) == 0x3)

   389

					/* Penalise exit and combo signals differently (heavier) */

   390

					cost += _patches.npf_rail_firstred_exit_penalty;

   391

				else

   392

					cost += _patches.npf_rail_firstred_penalty;

   393

			}

   394

			/* Record the state of this signal */

   395

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   396

		} else {

   397

			/* Record the state of this signal */

   398

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   399

		}

   400

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   401

	}

   402

   403

	/* Penalise the tile if it is a target tile and the last signal was

   404

	 * red */

   405

	new_node.path.node = *current;

   406

	if (as->EndNodeCheck(as, &new_node)==AYSTAR_FOUND_END_NODE && NPFGetFlag(current, NPF_FLAG_LAST_SIGNAL_RED))

   407

		cost += _patches.npf_rail_lastred_penalty;

   408

   409

	/* Check for slope */

   410

	cost += NPFSlopeCost(current);

   411

   412

	/* Check for turns */

   413

	if (current->direction != parent->path.node.direction)

   414

		cost += _patches.npf_rail_curve_penalty;

   415

	//TODO, with realistic acceleration, also the amount of straight track between

   416

	//      curves should be taken into account, as this affects the speed limit.

   417

   418

	/* Check for occupied track */

   419

	//TODO

   420

   421

#ifdef NPF_MARKROUTE

   422

	NPFMarkTile(tile);

   423

#endif

   424

#ifdef NPF_DEBUG

   425

	debug("Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);

   426

#endif

   427

	return cost;

   428

}

   429

   430

/* Will find any depot */

   431

int32 NPFFindDepot(AyStar* as, OpenListNode *current) {

   432

	TileIndex tile = current->path.node.tile;

   433

	if (IsTileDepotType(tile, as->user_data[NPF_TYPE]))

   434

		return AYSTAR_FOUND_END_NODE;

   435

	else

   436

		return AYSTAR_DONE;

   437

}

   438

   439

/* Will find a station identified using the NPFFindStationOrTileData */

   440

int32 NPFFindStationOrTile(AyStar* as, OpenListNode *current) {

   441

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   442

	AyStarNode *node = &current->path.node;

   443

	TileIndex tile = node->tile;

   444

   445

	/* See if we checked this before */

   446

	if (NPFGetFlag(node, NPF_FLAG_TARGET_CHECKED))

   447

		return NPFGetFlag(node, NPF_FLAG_IS_TARGET);

   448

	/* We're gonna check this now and store the result, let's mark that */

   449

	NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   450

   451

	/* If GetNeighbours said we could get here, we assume the station type

   452

	 * is correct */

   453

	if (

   454

		(fstd->station_index == -1 && tile == fstd->dest_coords) || /* We've found the tile, or */

   455

		(IsTileType(tile, MP_STATION) && _map2[tile] == fstd->station_index) /* the station */

   456

	) {

   457

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   458

		return AYSTAR_FOUND_END_NODE;

   459

	} else {

   460

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, false);

   461

		return AYSTAR_DONE;

   462

	}

   463

}

   464

   465

/* To be called when current contains the (shortest route to) the target node.

   466

 * Will fill the contents of the NPFFoundTargetData using

   467

 * AyStarNode[NPF_TRACKDIR_CHOICE].

   468

 */

   469

void NPFSaveTargetData(AyStar* as, OpenListNode* current) {

   470

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   471

	ftd->best_trackdir = current->path.node.user_data[NPF_TRACKDIR_CHOICE];

   472

	ftd->best_path_dist = current->g;

   473

	ftd->best_bird_dist = 0;

   474

	ftd->node = current->path.node;

   475

}

   476

   477

/* Will just follow the results of GetTileTrackStatus concerning where we can

   478

 * go and where not. Uses AyStar.user_data[NPF_TYPE] as the transport type and

   479

 * an argument to GetTileTrackStatus. Will skip tunnels, meaning that the

   480

 * entry and exit are neighbours. Will fill

   481

 * AyStarNode.user_data[NPF_TRACKDIR_CHOICE] with an appropriate value, and

   482

 * copy AyStarNode.user_data[NPF_NODE_FLAGS] from the parent */

   483

void NPFFollowTrack(AyStar* aystar, OpenListNode* current) {

   484

	byte src_trackdir = current->path.node.direction;

   485

	TileIndex src_tile = current->path.node.tile;

   486

	byte src_exitdir = _trackdir_to_exitdir[src_trackdir];

   487

	FindLengthOfTunnelResult flotr;

   488

	TileIndex dst_tile;

   489

	int i = 0;

   490

	uint trackdirs, ts;

   491

	TransportType type = aystar->user_data[NPF_TYPE];

   492

	/* Initialize to 0, so we can jump out (return) somewhere an have no neighbours */

   493

	aystar->num_neighbours = 0;

   494

#ifdef NPF_DEBUG

   495

	debug("Expanding: (%d, %d, %d) [%d]", TileX(src_tile), TileY(src_tile), src_trackdir, src_tile);

   496

#endif

   497

   498

	/* Find dest tile */

   499

	if (IsTileType(src_tile, MP_TUNNELBRIDGE) && (_map5[src_tile] & 0xF0)==0 && (_map5[src_tile] & 3) == src_exitdir) {

   500

		/* This is a tunnel. We know this tunnel is our type,

   501

		 * otherwise we wouldn't have got here. It is also facing us,

   502

		 * so we should skip it's body */

   503

		flotr = FindLengthOfTunnel(src_tile, src_exitdir);

   504

		dst_tile = flotr.tile;

   505

	} else {

   506

		if (type != TRANSPORT_WATER && (IsRoadStationTile(src_tile) || IsTileDepotType(src_tile, type))){

   507

			/* This is a road station or a train or road depot. We can enter and exit

   508

			 * those from one side only. Trackdirs don't support that (yet), so we'll

   509

			 * do this here. */

   510

   511

			byte exitdir;