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

const uint16 _next_trackdir[14] = {

    40

	0,  1,  3,  2,  5,  4, 0, 0,

    41

	8,  9,  11, 10, 13, 12

    42

};

    43

    44

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

    45

const uint16 _trackdir_crosses_trackdirs[14] = {

    46

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

    47

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

    48

};

    49

    50

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

    51

const byte _track_crosses_tracks[6] = {

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

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

    61

 * that trackdir */

    62

const byte _trackdir_to_exitdir[14] = {

    63

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

    64

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

    65

};

    66

    67

const byte _track_exitdir_to_trackdir[6][4] = {

    68

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

    69

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

    70

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

    71

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

    72

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

    73

	{13,   5,    0xff, 0xff}

    74

};

    75

    76

const byte _track_direction_to_trackdir[6][8] = {

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

};

    84

    85

const byte _dir_to_diag_trackdir[4] = {

    86

	0, 1, 8, 9,

    87

};

    88

    89

const byte _reverse_dir[4] = {

    90

	2, 3, 0, 1

    91

};

    92

    93

const byte _reverse_trackdir[14] = {

    94

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

    95

	0, 1, 2,  3,  4,  5

    96

};

    97

    98

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

    99

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

   100

 */

   101

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH)

   102

static const uint _trackdir_length[14] = {

   103

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

   104

	0, 0,

   105

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

   106

};

   107

   108

uint NTPHash(uint key1, uint key2)

   109

{

   110

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

   111

	return PATHFIND_HASH_TILE(key1);

   112

}

   113

   114

uint NPFHash(uint key1, uint key2)

   115

{

   116

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

   117

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

   118

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

   119

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

   120

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

   121

}

   122

   123

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

   124

	return 0;

   125

}

   126

   127

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

   128

 * for this we assume the station is a rectangle,

   129

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

   130

 */

   131

TileIndex CalcClosestStationTile(int station, TileIndex tile) {

   132

	const Station* st = GetStation(station);

   133

   134

	int x1,x2,x3,tx;

   135

	int y1,y2,y3,ty;

   136

   137

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

   138

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

   139

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

   140

   141

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

   142

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

   143

	if (x3 < x1)

   144

		tx = x1;

   145

	else if (x3 > x2)

   146

		tx = x2;

   147

	else

   148

		tx = x3;

   149

   150

	// same for y coordinate, see above comment

   151

	if (y3 < y1)

   152

		ty = y1;

   153

	else if (y3 > y2)

   154

		ty = y2;

   155

	else

   156

		ty = y3;

   157

   158

	// return the tile of our target coordinates

   159

	return TILE_XY(tx,ty);

   160

};

   161

   162

/* Calcs the heuristic to the target station or tile. For train stations, it

   163

 * takes into account the direction of approach.

   164

 */

   165

int32 NPFCalcStationOrTileHeuristic(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;

   171

   172

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

   173

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

   174

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

   175

   176

	if (as->user_data[NPF_TYPE] == TRANSPORT_ROAD)

   177

		/* Since roads only have diagonal pieces, we use manhattan distance here */

   178

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   179

	else

   180

		/* Ships and trains can also go diagonal, so the minimum distance is shorter */

   181

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   182

   183

	if (dist < ftd->best_bird_dist) {

   184

		ftd->best_bird_dist = dist;

   185

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

   186

	}

   187

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

   188

	return dist;

   189

}

   190

   191

   192

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

   193

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

   194

 * choice */

   195

void NPFFillTrackdirChoice(AyStarNode* current, OpenListNode* parent)

   196

{

   197

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

   198

		byte trackdir = current->direction;

   199

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

   200

		 * direction we chose */

   201

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   202

		DEBUG(npf, 6)("Saving trackdir: %#x", trackdir);

   203

	} else {

   204

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

   205

		 * decision */

   206

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

   207

	}

   208

   209

}

   210

   211

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

   212

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

   213

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

   214

uint NPFTunnelCost(AyStarNode* current) {

   215

	byte exitdir = _trackdir_to_exitdir[current->direction];

   216

	TileIndex tile = current->tile;

   217

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

   218

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

   219

		 * facing the tunnel exit */

   220

		FindLengthOfTunnelResult flotr;

   221

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

   222

		return flotr.length * NPF_TILE_LENGTH;

   223

		//TODO: Penalty for tunnels?

   224

	} else {

   225

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

   226

		 * straight track */

   227

		return NPF_TILE_LENGTH;

   228

	}

   229

}

   230

   231

uint NPFSlopeCost(AyStarNode* current) {

   232

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

   233

	int x,y;

   234

	int8 z1,z2;

   235

   236

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

   237

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

   238

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

   239

   240

	x = TileX(next) * 16;

   241

	y = TileY(next) * 16;

   242

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

   243

   244

	if ((z2 - z1) > 1) {

   245

		/* Slope up */

   246

		return _patches.npf_rail_slope_penalty;

   247

	}

   248

	return 0;

   249

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

   250

	 * could just substract that bonus from the penalty, because

   251

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

   252

}

   253

   254

/* Mark tiles by mowing the grass when npf debug level >= 1 */

   255

void NPFMarkTile(TileIndex tile) {

   256

#ifdef NO_DEBUG_MESSAGES

   257

	return;

   258

#else

   259

	if (_debug_npf_level >= 1)

   260

		switch(GetTileType(tile)) {

   261

			case MP_RAILWAY:

   262

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

   263

				 * ;-) */

   264

				if (!IsTileDepotType(tile, TRANSPORT_RAIL)) {

   265

					_map2[tile] &= ~15; /* Clear bits 0-3 */

   266

					MarkTileDirtyByTile(tile);

   267

				}

   268

				break;

   269

			case MP_STREET:

   270

				if (!IsTileDepotType(tile, TRANSPORT_ROAD)) {

   271

					_map3_hi[tile] &= ~0x70; /* Clear bits 4-6 */

   272

					MarkTileDirtyByTile(tile);

   273

				}

   274

				break;

   275

			default:

   276

				break;

   277

		}

   278

#endif

   279

}

   280

   281

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

   282

	//TileIndex tile = current->tile;

   283

	int32 cost = 0;

   284

	byte trackdir = current->direction;

   285

   286

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

   287

   288

	if (IsBuoyTile(current->tile) && IsDiagonalTrackdir(current->direction))

   289

		cost += _patches.npf_buoy_penalty; /* A small penalty for going over buoys */

   290

   291

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

   292

		cost += _patches.npf_water_curve_penalty;

   293

   294

	/* TODO More penalties? */

   295

   296

	return cost;

   297

}

   298

   299

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

   300

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

   301

	TileIndex tile = current->tile;

   302

	int32 cost = 0;

   303

   304

	/* Determine base length */

   305

	switch (GetTileType(tile)) {

   306

		case MP_TUNNELBRIDGE:

   307

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

   308

				cost = NPFTunnelCost(current);

   309

				break;

   310

			}

   311

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

   312

			 * then. We treat that as ordinary rail */

   313

		case MP_STREET:

   314

			cost = NPF_TILE_LENGTH;

   315

			break;

   316

		default:

   317

			break;

   318

	}

   319

   320

	/* Determine extra costs */

   321

   322

	/* Check for slope */

   323

	cost += NPFSlopeCost(current);

   324

   325

	/* Check for turns */

   326

	//TODO

   327

   328

	NPFMarkTile(tile);

   329

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

   330

	return cost;

   331

}

   332

   333

   334

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

   335

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

   336

	TileIndex tile = current->tile;

   337

	byte trackdir = current->direction;

   338

	int32 cost = 0;

   339

	/* HACK: We create a OpenListNode manualy, so we can call EndNodeCheck */

   340

	OpenListNode new_node;

   341

   342

	/* Determine base length */

   343

	switch (GetTileType(tile)) {

   344

		case MP_TUNNELBRIDGE:

   345

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

   346

				cost = NPFTunnelCost(current);

   347

				break;

   348

			}

   349

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

   350

			 * then. We treat that as ordinary rail */

   351

		case MP_RAILWAY:

   352

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

   353

			break;

   354

		case MP_STREET: /* Railway crossing */

   355

			cost = NPF_TILE_LENGTH;

   356

			break;

   357

		case MP_STATION:

   358

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

   359

					* want to give station tiles that are not our destination

   360

					* this penalty. This would discourage trains to drive through

   361

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

   362

					* penalty, because every possible route will get this penalty

   363

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

   364

			* will therefore not make a difference. */

   365

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   366

			break;

   367

		default:

   368

			break;

   369

	}

   370

   371

	/* Determine extra costs */

   372

   373

	/* Check for signals */

   374

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

   375

		/* Ordinary track with signals */

   376

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

   377

			/* Signal facing us is red */

   378

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   379

				/* Penalize the first signal we

   380

				 * encounter, if it is red */

   381

   382

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

   383

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

   384

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

   385

					cost += _patches.npf_rail_firstred_exit_penalty;

   386

				else

   387

					cost += _patches.npf_rail_firstred_penalty;

   388

			}

   389

			/* Record the state of this signal */

   390

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   391

		} else {

   392

			/* Record the state of this signal */

   393

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   394

		}

   395

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   396

	}

   397

   398

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

   399

	 * red */

   400

	new_node.path.node = *current;

   401

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

   402

		cost += _patches.npf_rail_lastred_penalty;

   403

   404

	/* Check for slope */

   405

	cost += NPFSlopeCost(current);

   406

   407

	/* Check for turns */

   408

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

   409

		cost += _patches.npf_rail_curve_penalty;

   410

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

   411

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

   412

   413

	/* Check for reverse in depot */

   414

	if (IsTileDepotType(tile, TRANSPORT_RAIL) && !as->EndNodeCheck(as, &new_node)==AYSTAR_FOUND_END_NODE)

   415

		/* Penalise any depot tile that is not the last tile in the path. This

   416

		 * _should_ penalise every occurence of reversing in a depot (and only

   417

		 * that) */

   418

		cost += _patches.npf_rail_depot_reverse_penalty;

   419

   420

	/* Check for occupied track */

   421

	//TODO

   422

   423

	NPFMarkTile(tile);

   424

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

   425

	return cost;

   426

}

   427

   428

/* Will find any depot */

   429

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

   430

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

   431

   432

	/* It's not worth caching the result with NPF_FLAG_IS_TARGET here as below,

   433

	 * since checking the cache not that much faster than the actual check */

   434

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

   435

		return AYSTAR_FOUND_END_NODE;

   436

	else

   437

		return AYSTAR_DONE;

   438

}

   439

   440

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

   441

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

   442

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

   443

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

   444

	TileIndex tile = node->tile;

   445

   446

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

   447

	 * is correct */

   448

	if (

   449

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

   450

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

   451

	) {

   452

		return AYSTAR_FOUND_END_NODE;

   453

	} else {

   454

		return AYSTAR_DONE;

   455

	}

   456

}

   457

   458

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

   459

 * Will fill the contents of the NPFFoundTargetData using

   460

 * AyStarNode[NPF_TRACKDIR_CHOICE].

   461

 */

   462

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

   463

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

   464

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

   465

	ftd->best_path_dist = current->g;

   466

	ftd->best_bird_dist = 0;

   467

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

   468

}

   469

   470

/**

   471

 * Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.

   472

 * Note that there is no check if the given trackdir is actually present on

   473

 * the tile!

   474

 * The given trackdir is used when there are (could be) multiple rail types on

   475

 * one tile.

   476

 */

   477

static inline RailType GetTileRailType(TileIndex tile, byte trackdir)

   478

{

   479

	byte type = INVALID_RAILTYPE;

   480

	switch (GetTileType(tile)) {

   481

		case MP_RAILWAY:

   482

			/* railway track */

   483

			type = _map3_lo[tile] & RAILTYPE_MASK;

   484

			break;

   485

		case MP_STREET:

   486

			/* rail/road crossing */

   487

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

   488

				type = _map3_hi[tile] & RAILTYPE_MASK;

   489

			break;

   490

		case MP_STATION:

   491

			if (IsTrainStationTile(tile))

   492

				type = _map3_lo[tile] & RAILTYPE_MASK;

   493

			break;

   494

		case MP_TUNNELBRIDGE:

   495

			/* railway tunnel */

   496

			if ((_map5[tile] & 0xFC) == 0) type = _map3_lo[tile] & RAILTYPE_MASK;

   497

			/* railway bridge ending */

   498

			if ((_map5[tile] & 0xC6) == 0x80) type = _map3_lo[tile] & RAILTYPE_MASK;

   499

			/* on railway bridge */

   500

			if ((_map5[tile] & 0xC6) == 0xC0 && (_map5[tile] & 0x1) == (_trackdir_to_exitdir[trackdir] & 0x1))

   501

				type = (_map3_lo[tile] >> 4) & RAILTYPE_MASK;

   502

			/* under bridge (any type) */

   503

			if ((_map5[tile] & 0xC0) == 0xC0 && (_map5[tile] & 0x1) != (trackdir & 0x1))

   504

				type = _map3_lo[tile] & RAILTYPE_MASK;

   505

			break;

   506

		default:

   507

			break;