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 * STRAIGHT_TRACK_LENGTH)

    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 station or tile. For train stations, it

   158

 * takes into account the direction of approach.

   159

 */

   160

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

   161

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

   162

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

   163

	TileIndex from = current->tile;

   164

	TileIndex to = fstd->dest_coords;

   165

	uint dist;

   166

   167

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

   168

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

   169

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

   170

   171

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

   172

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

   173

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   174

	else

   175

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

   176

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   177

   178

	if (dist < ftd->best_bird_dist) {

   179

		ftd->best_bird_dist = dist;

   180

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

   181

	}

   182

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

   183

	return dist;

   184

}

   185

   186

   187

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

   188

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

   189

 * choice */

   190

void NPFFillTrackdirChoice(AyStarNode* current, OpenListNode* parent)

   191

{

   192

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

   193

		byte trackdir = current->direction;

   194

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

   195

		 * direction we chose */

   196

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   197

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

   198

	} else {

   199

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

   200

		 * decision */

   201

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

   202

	}

   203

   204

}

   205

   206

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

   207

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

   208

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

   209

uint NPFTunnelCost(AyStarNode* current) {

   210

	byte exitdir = _trackdir_to_exitdir[current->direction];

   211

	TileIndex tile = current->tile;

   212

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

   213

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

   214

		 * facing the tunnel exit */

   215

		FindLengthOfTunnelResult flotr;

   216

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

   217

		return flotr.length * NPF_TILE_LENGTH;

   218

		//TODO: Penalty for tunnels?

   219

	} else {

   220

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

   221

		 * straight track */

   222

		return NPF_TILE_LENGTH;

   223

	}

   224

}

   225

   226

uint NPFSlopeCost(AyStarNode* current) {

   227

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

   228

	int x,y;

   229

	int8 z1,z2;

   230

   231

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

   232

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

   233

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

   234

   235

	x = TileX(next) * 16;

   236

	y = TileY(next) * 16;

   237

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

   238

   239

	if ((z2 - z1) > 1) {

   240

		/* Slope up */

   241

		return _patches.npf_rail_slope_penalty;

   242

	}

   243

	return 0;

   244

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

   245

	 * could just substract that bonus from the penalty, because

   246

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

   247

}

   248

   249

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

   250

void NPFMarkTile(TileIndex tile) {

   251

#ifdef NO_DEBUG_MESSAGES

   252

	return;

   253

#else

   254

	if (_debug_npf_level >= 1)

   255

		switch(GetTileType(tile)) {

   256

			case MP_RAILWAY:

   257

			case MP_STREET:

   258

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

   259

				 * ;-) */

   260

				_map2[tile] &= ~15;

   261

				MarkTileDirtyByTile(tile);

   262

				break;

   263

			default:

   264

				break;

   265

		}

   266

#endif

   267

}

   268

   269

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

   270

	//TileIndex tile = current->tile;

   271

	int32 cost = 0;

   272

	byte trackdir = current->direction;

   273

   274

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

   275

   276

	/* TODO Penalties? */

   277

   278

	return cost;

   279

}

   280

   281

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

   282

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

   283

	TileIndex tile = current->tile;

   284

	int32 cost = 0;

   285

	/* Determine base length */

   286

	switch (GetTileType(tile)) {

   287

		case MP_TUNNELBRIDGE:

   288

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

   289

				cost = NPFTunnelCost(current);

   290

				break;

   291

			}

   292

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

   293

			 * then. We treat that as ordinary rail */

   294

		case MP_STREET:

   295

			cost = NPF_TILE_LENGTH;

   296

			break;

   297

		default:

   298

			break;

   299

	}

   300

   301

	/* Determine extra costs */

   302

   303

	/* Check for slope */

   304

	cost += NPFSlopeCost(current);

   305

   306

	/* Check for turns */

   307

	//TODO

   308

   309

	NPFMarkTile(tile);

   310

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

   311

	return cost;

   312

}

   313

   314

   315

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

   316

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

   317

	TileIndex tile = current->tile;

   318

	byte trackdir = current->direction;

   319

	int32 cost = 0;

   320

	OpenListNode new_node;

   321

   322

	/* Determine base length */

   323

	switch (GetTileType(tile)) {

   324

		case MP_TUNNELBRIDGE:

   325

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

   326

				cost = NPFTunnelCost(current);

   327

				break;

   328

			}

   329

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

   330

			 * then. We treat that as ordinary rail */

   331

		case MP_RAILWAY:

   332

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

   333

			break;

   334

		case MP_STREET: /* Railway crossing */

   335

			cost = NPF_TILE_LENGTH;

   336

			break;

   337

		case MP_STATION:

   338

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

   339

					* want to give station tiles that are not our destination

   340

					* this penalty. This would discourage trains to drive through

   341

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

   342

					* penalty, because every possible route will get this penalty

   343

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

   344

			* will therefore not make a difference. */

   345

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   346

			break;

   347

		default:

   348

			break;

   349

	}

   350

   351

	/* Determine extra costs */

   352

   353

	/* Check for signals */

   354

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

   355

		/* Ordinary track with signals */

   356

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

   357

			/* Signal facing us is red */

   358

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   359

				/* Penalize the first signal we

   360

				 * encounter, if it is red */

   361

   362

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

   363

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

   364

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

   365

					cost += _patches.npf_rail_firstred_exit_penalty;

   366

				else

   367

					cost += _patches.npf_rail_firstred_penalty;

   368

			}

   369

			/* Record the state of this signal */

   370

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   371

		} else {

   372

			/* Record the state of this signal */

   373

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   374

		}

   375

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   376

	}

   377

   378

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

   379

	 * red */

   380

	new_node.path.node = *current;

   381

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

   382

		cost += _patches.npf_rail_lastred_penalty;

   383

   384

	/* Check for slope */

   385

	cost += NPFSlopeCost(current);

   386

   387

	/* Check for turns */

   388

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

   389

		cost += _patches.npf_rail_curve_penalty;

   390

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

   391

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

   392

   393

	/* Check for occupied track */

   394

	//TODO

   395

   396

	NPFMarkTile(tile);

   397

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

   398

	return cost;

   399

}

   400

   401

/* Will find any depot */

   402

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

   403

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

   404

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

   405

		return AYSTAR_FOUND_END_NODE;

   406

	else

   407

		return AYSTAR_DONE;

   408

}

   409

   410

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

   411

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

   412

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

   413

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

   414

	TileIndex tile = node->tile;

   415

   416

	/* See if we checked this before */

   417

	if (NPFGetFlag(node, NPF_FLAG_TARGET_CHECKED))

   418

		return NPFGetFlag(node, NPF_FLAG_IS_TARGET);

   419

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

   420

	NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   421

   422

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

   423

	 * is correct */

   424

	if (

   425

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

   426

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

   427

	) {

   428

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   429

		return AYSTAR_FOUND_END_NODE;

   430

	} else {

   431

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, false);

   432

		return AYSTAR_DONE;

   433

	}

   434

}

   435

   436

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

   437

 * Will fill the contents of the NPFFoundTargetData using

   438

 * AyStarNode[NPF_TRACKDIR_CHOICE].

   439

 */

   440

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

   441

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

   442

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

   443

	ftd->best_path_dist = current->g;

   444

	ftd->best_bird_dist = 0;

   445

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

   446

}

   447

   448

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

   449

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

   450

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

   451

 * entry and exit are neighbours. Will fill

   452

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

   453

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

   454

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

   455

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

   456

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

   457

	byte src_exitdir = _trackdir_to_exitdir[src_trackdir];

   458

	FindLengthOfTunnelResult flotr;

   459

	TileIndex dst_tile;

   460

	int i = 0;

   461

	uint trackdirs, ts;

   462

	TransportType type = aystar->user_data[NPF_TYPE];

   463

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

   464

	aystar->num_neighbours = 0;

   465

	DEBUG(npf, 4)("Expanding: (%d, %d, %d) [%d]", TileX(src_tile), TileY(src_tile), src_trackdir, src_tile);

   466

   467

	/* Find dest tile */

   468

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

   469

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

   470

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

   471

		 * so we should skip it's body */

   472

		flotr = FindLengthOfTunnel(src_tile, src_exitdir);

   473

		dst_tile = flotr.tile;

   474

	} else {

   475

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

   476

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

   477

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

   478

			 * do this here. */

   479

   480

			byte exitdir;

   481

			/* Find out the exit direction first */

   482

			if (IsRoadStationTile(src_tile))

   483

				exitdir = GetRoadStationDir(src_tile);

   484

			else /* Train or road depot. Direction is stored the same for both, in map5 */

   485

				exitdir = GetDepotDirection(src_tile, type);

   486

   487

			/* Let's see if were headed the right way */

   488

			if (src_trackdir == _dir_to_diag_trackdir[_reverse_dir[exitdir]])

   489

				/* We are headed inwards. We can only reverse here, so we'll not

   490

				 * consider this direction, but jump ahead to the reverse direction.

   491

				 * It would be nicer to return one neighbour here (the reverse

   492

				 * trackdir of the one we are considering now) and then considering

   493

				 * that one to return the tracks outside of the depot. But, because

   494

				 * the code layout is cleaner this way, we will just pretend we are

   495

				 * reversed already */

   496

				src_trackdir = _reverse_trackdir[src_trackdir];

   497

		}

   498

		/* This a normal tile, a bridge, a tunnel exit, etc. */

   499

		dst_tile = AddTileIndexDiffCWrap(src_tile, TileIndexDiffCByDir(_trackdir_to_exitdir[src_trackdir]));

   500

		if (dst_tile == INVALID_TILE) {

   501

			/* We reached the border of the map */

   502

			/* TODO Nicer control flow for this */

   503

			return;

   504

		}

   505

	}

   506

   507

	// TODO: check correct rail type (mono, maglev, etc)

   508

   509

	/* Check the owner of the tile */

   510

	if (