1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "strings.h"

     8

#include "table/strings.h"

     9

#include "gfx.h"

    10

#include "hal.h"

    11

#include "viewport.h"

    12

#include "player.h"

    13

#include "screenshot.h"

    14

#include "variables.h"

    15

#include "date.h"

    16

#include "helpers.hpp"

    17

    18

char _screenshot_format_name[8];

    19

uint _num_screenshot_formats;

    20

uint _cur_screenshot_format;

    21

ScreenshotType current_screenshot_type;

    22

    23

/* called by the ScreenShot proc to generate screenshot lines. */

    24

typedef void ScreenshotCallback(void *userdata, Pixel *buf, uint y, uint pitch, uint n);

    25

typedef bool ScreenshotHandlerProc(const char *name, ScreenshotCallback *callb, void *userdata, uint w, uint h, int pixelformat, const Colour *palette);

    26

    27

struct ScreenshotFormat {

    28

	const char *name;

    29

	const char *extension;

    30

	ScreenshotHandlerProc *proc;

    31

};

    32

    33

//************************************************

    34

//*** SCREENSHOT CODE FOR WINDOWS BITMAP (.BMP)

    35

//************************************************

    36

#if defined(_MSC_VER) || defined(__WATCOMC__)

    37

#pragma pack(push, 1)

    38

#endif

    39

    40

struct BitmapFileHeader {

    41

	uint16 type;

    42

	uint32 size;

    43

	uint32 reserved;

    44

	uint32 off_bits;

    45

} GCC_PACK;

    46

assert_compile(sizeof(BitmapFileHeader) == 14);

    47

    48

#if defined(_MSC_VER) || defined(__WATCOMC__)

    49

#pragma pack(pop)

    50

#endif

    51

    52

struct BitmapInfoHeader {

    53

	uint32 size;

    54

	int32 width, height;

    55

	uint16 planes, bitcount;

    56

	uint32 compression, sizeimage, xpels, ypels, clrused, clrimp;

    57

};

    58

assert_compile(sizeof(BitmapInfoHeader) == 40);

    59

    60

struct RgbQuad {

    61

	byte blue, green, red, reserved;

    62

};

    63

assert_compile(sizeof(RgbQuad) == 4);

    64

    65

/* generic .BMP writer */

    66

static bool MakeBmpImage(const char *name, ScreenshotCallback *callb, void *userdata, uint w, uint h, int pixelformat, const Colour *palette)

    67

{

    68

	BitmapFileHeader bfh;

    69

	BitmapInfoHeader bih;

    70

	RgbQuad rq[256];

    71

	FILE *f;

    72

	uint i, padw;

    73

	uint n, maxlines;

    74

    75

	/* only implemented for 8bit images so far. */

    76

	if (pixelformat != 8)

    77

		return false;

    78

    79

	f = fopen(name, "wb");

    80

	if (f == NULL) return false;

    81

    82

	/* each scanline must be aligned on a 32bit boundary */

    83

	padw = ALIGN(w, 4);

    84

    85

	/* setup the file header */

    86

	bfh.type = TO_LE16('MB');

    87

	bfh.size = TO_LE32(sizeof(bfh) + sizeof(bih) + sizeof(RgbQuad) * 256 + padw * h);

    88

	bfh.reserved = 0;

    89

	bfh.off_bits = TO_LE32(sizeof(bfh) + sizeof(bih) + sizeof(RgbQuad) * 256);

    90

    91

	/* setup the info header */

    92

	bih.size = TO_LE32(sizeof(BitmapInfoHeader));

    93

	bih.width = TO_LE32(w);

    94

	bih.height = TO_LE32(h);

    95

	bih.planes = TO_LE16(1);

    96

	bih.bitcount = TO_LE16(8);

    97

	bih.compression = 0;

    98

	bih.sizeimage = 0;

    99

	bih.xpels = 0;

   100

	bih.ypels = 0;

   101

	bih.clrused = 0;

   102

	bih.clrimp = 0;

   103

   104

	/* convert the palette to the windows format */

   105

	for (i = 0; i != 256; i++) {

   106

		rq[i].red   = palette[i].r;

   107

		rq[i].green = palette[i].g;

   108

		rq[i].blue  = palette[i].b;

   109

		rq[i].reserved = 0;

   110

	}

   111

   112

	/* write file header and info header and palette */

   113

	if (fwrite(&bfh, sizeof(bfh), 1, f) != 1) return false;

   114

	if (fwrite(&bih, sizeof(bih), 1, f) != 1) return false;

   115

	if (fwrite(rq, sizeof(rq), 1, f) != 1) return false;

   116

   117

	/* use by default 64k temp memory */

   118

	maxlines = clamp(65536 / padw, 16, 128);

   119

   120

	/* now generate the bitmap bits */

   121

	Pixel *buff = MallocT<Pixel>(padw * maxlines); // by default generate 128 lines at a time.

   122

	if (buff == NULL) {

   123

		fclose(f);

   124

		return false;

   125

	}

   126

	memset(buff, 0, padw * maxlines); // zero the buffer to have the padding bytes set to 0

   127

   128

	/* start at the bottom, since bitmaps are stored bottom up. */

   129

	do {

   130

		/* determine # lines */

   131

		n = min(h, maxlines);

   132

		h -= n;

   133

   134

		/* render the pixels */

   135

		callb(userdata, buff, h, padw, n);

   136

   137

		/* write each line */

   138

		while (n)

   139

			if (fwrite(buff + (--n) * padw, padw, 1, f) != 1) {

   140

				free(buff);

   141

				fclose(f);

   142

				return false;

   143

			}

   144

	} while (h != 0);

   145

   146

	free(buff);

   147

	fclose(f);

   148

   149

	return true;

   150

}

   151

   152

//********************************************************

   153

//*** SCREENSHOT CODE FOR PORTABLE NETWORK GRAPHICS (.PNG)

   154

//********************************************************

   155

#if defined(WITH_PNG)

   156

#include <png.h>

   157

   158

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   159

{

   160

	DEBUG(misc, 0, "[libpng] error: %s - %s", message, (char *)png_get_error_ptr(png_ptr));

   161

	longjmp(png_ptr->jmpbuf, 1);

   162

}

   163

   164

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   165

{

   166

	DEBUG(misc, 1, "[libpng] warning: %s - %s", message, (char *)png_get_error_ptr(png_ptr));

   167

}

   168

   169

static bool MakePNGImage(const char *name, ScreenshotCallback *callb, void *userdata, uint w, uint h, int pixelformat, const Colour *palette)

   170

{

   171

	png_color rq[256];

   172

	FILE *f;

   173

	uint i, y, n;

   174

	uint maxlines;

   175

	png_structp png_ptr;

   176

	png_infop info_ptr;

   177

   178

	/* only implemented for 8bit images so far. */

   179

	if (pixelformat != 8)

   180

		return false;

   181

   182

	f = fopen(name, "wb");

   183

	if (f == NULL) return false;

   184

   185

	png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, (char *)name, png_my_error, png_my_warning);

   186

   187

	if (png_ptr == NULL) {

   188

		fclose(f);

   189

		return false;

   190

	}

   191

   192

	info_ptr = png_create_info_struct(png_ptr);

   193

	if (info_ptr == NULL) {

   194

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   195

		fclose(f);

   196

		return false;

   197

	}

   198

   199

	if (setjmp(png_jmpbuf(png_ptr))) {

   200

		png_destroy_write_struct(&png_ptr, &info_ptr);

   201

		fclose(f);

   202

		return false;

   203

	}

   204

   205

	png_init_io(png_ptr, f);

   206

   207

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   208

   209

	png_set_IHDR(png_ptr, info_ptr, w, h, pixelformat, PNG_COLOR_TYPE_PALETTE,

   210

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   211

   212

	/* convert the palette to the .PNG format. */

   213

	for (i = 0; i != 256; i++) {

   214

		rq[i].red   = palette[i].r;

   215

		rq[i].green = palette[i].g;

   216

		rq[i].blue  = palette[i].b;

   217

	}

   218

   219

	png_set_PLTE(png_ptr, info_ptr, rq, 256);

   220

	png_write_info(png_ptr, info_ptr);

   221

	png_set_flush(png_ptr, 512);

   222

   223

	/* use by default 64k temp memory */

   224

	maxlines = clamp(65536 / w, 16, 128);

   225

   226

	/* now generate the bitmap bits */

   227

	Pixel *buff = MallocT<Pixel>(w * maxlines); // by default generate 128 lines at a time.

   228

	if (buff == NULL) {

   229

		png_destroy_write_struct(&png_ptr, &info_ptr);

   230

		fclose(f);

   231

		return false;

   232

	}

   233

	memset(buff, 0, w * maxlines); // zero the buffer to have the padding bytes set to 0

   234

   235

	y = 0;

   236

	do {

   237

		/* determine # lines to write */

   238

		n = min(h - y, maxlines);

   239

   240

		/* render the pixels into the buffer */

   241

		callb(userdata, buff, y, w, n);

   242

		y += n;

   243

   244

		/* write them to png */

   245

		for (i = 0; i != n; i++)

   246

			png_write_row(png_ptr, buff + i * w);

   247

	} while (y != h);

   248

   249

	png_write_end(png_ptr, info_ptr);

   250

	png_destroy_write_struct(&png_ptr, &info_ptr);

   251

   252

	free(buff);

   253

	fclose(f);

   254

	return true;

   255

}

   256

#endif /* WITH_PNG */

   257

   258

   259

//************************************************

   260

//*** SCREENSHOT CODE FOR ZSOFT PAINTBRUSH (.PCX)

   261

//************************************************

   262

   263

struct PcxHeader {

   264

	byte manufacturer;

   265

	byte version;

   266

	byte rle;

   267

	byte bpp;

   268

	uint32 unused;

   269

	uint16 xmax, ymax;

   270

	uint16 hdpi, vdpi;

   272

	byte reserved;

   273

	byte planes;

   274

	uint16 pitch;

   275

	uint16 cpal;

   276

	uint16 width;

   277

	uint16 height;

   278

	byte filler[54];

   279

};

   280

assert_compile(sizeof(PcxHeader) == 128);

   281

   282

static bool MakePCXImage(const char *name, ScreenshotCallback *callb, void *userdata, uint w, uint h, int pixelformat, const Colour *palette)

   283

{

   284

	FILE *f;

   285

	uint maxlines;

   286

	uint y;

   287

	PcxHeader pcx;

   288

	bool success;

   289

   290

	if (pixelformat != 8 || w == 0)

   291

		return false;

   292

   293

	f = fopen(name, "wb");

   294

	if (f == NULL) return false;

   295

   296

	memset(&pcx, 0, sizeof(pcx));

   297

   298

	/* setup pcx header */

   299

	pcx.manufacturer = 10;

   300

	pcx.version = 5;

   301

	pcx.rle = 1;

   302

	pcx.bpp = 8;

   303

	pcx.xmax = TO_LE16(w - 1);

   304

	pcx.ymax = TO_LE16(h - 1);

   305

	pcx.hdpi = TO_LE16(320);

   306

	pcx.vdpi = TO_LE16(320);

   307

   308

	pcx.planes = 1;

   309

	pcx.cpal = TO_LE16(1);

   310

	pcx.width = pcx.pitch = TO_LE16(w);

   311

	pcx.height = TO_LE16(h);

   312

   313

	/* write pcx header */

   314

	if (fwrite(&pcx, sizeof(pcx), 1, f) != 1) {

   315

		fclose(f);

   316

		return false;

   317

	}

   318

   319

	/* use by default 64k temp memory */

   320

	maxlines = clamp(65536 / w, 16, 128);

   321

   322

	/* now generate the bitmap bits */

   323

	Pixel *buff = MallocT<Pixel>(w * maxlines); // by default generate 128 lines at a time.

   324

	if (buff == NULL) {

   325

		fclose(f);

   326

		return false;

   327

	}

   328

	memset(buff, 0, w * maxlines); // zero the buffer to have the padding bytes set to 0

   329

   330

	y = 0;

   331

	do {

   332

		/* determine # lines to write */

   333

		uint n = min(h - y, maxlines);

   334

		uint i;

   335

   336

		/* render the pixels into the buffer */

   337

		callb(userdata, buff, y, w, n);

   338

		y += n;

   339

   340

		/* write them to pcx */

   341

		for (i = 0; i != n; i++) {

   342

			const Pixel* bufp = buff + i * w;

   343

			byte runchar = bufp[0];

   344

			uint runcount = 1;

   345

			uint j;

   346

   347

			/* for each pixel... */

   348

			for (j = 1; j < w; j++) {

   349

				Pixel ch = bufp[j];

   350

   351

				if (ch != runchar || runcount >= 0x3f) {

   352

					if (runcount > 1 || (runchar & 0xC0) == 0xC0)

   353

						if (fputc(0xC0 | runcount, f) == EOF) {

   354

							free(buff);

   355

							fclose(f);

   356

							return false;

   357

						}

   358

					if (fputc(runchar, f) == EOF) {

   359

						free(buff);

   360

						fclose(f);

   361

						return false;

   362

					}

   363

					runcount = 0;

   364

					runchar = ch;

   365

				}

   366

				runcount++;

   367

			}

   368

   369

			/* write remaining bytes.. */

   370

			if (runcount > 1 || (runchar & 0xC0) == 0xC0)

   371

				if (fputc(0xC0 | runcount, f) == EOF) {

   372

					free(buff);

   373

					fclose(f);

   374

					return false;

   375

				}

   376

			if (fputc(runchar, f) == EOF) {

   377

				free(buff);

   378

				fclose(f);

   379

				return false;

   380

			}

   381

		}

   382

	} while (y != h);

   383

   384

	free(buff);

   385

   386

	/* write 8-bit color palette */

   387

	if (fputc(12, f) == EOF) {

   388

		fclose(f);

   389

		return false;

   390

	}

   391

   392

	if (sizeof(*palette) == 3) {

   393

		success = fwrite(palette, 256 * sizeof(*palette), 1, f) == 1;

   394

	} else {

   395

		/* If the palette is word-aligned, copy it to a temporary byte array */

   396

		byte tmp[256 * 3];

   397

		uint i;

   398

   399

		for (i = 0; i < 256; i++) {

   400

			tmp[i * 3 + 0] = palette[i].r;

   401

			tmp[i * 3 + 1] = palette[i].g;

   402

			tmp[i * 3 + 2] = palette[i].b;

   403

		}

   404

		success = fwrite(tmp, sizeof(tmp), 1, f) == 1;

   405

	}

   406

   407

	fclose(f);

   408

   409

	return success;

   410

}

   411

   412

//************************************************

   413

//*** GENERIC SCREENSHOT CODE

   414

//************************************************

   415

   416

static const ScreenshotFormat _screenshot_formats[] = {

   417

#if defined(WITH_PNG)

   418

	{"PNG", "png", &MakePNGImage},

   419

#endif

   420

	{"BMP", "bmp", &MakeBmpImage},

   421

	{"PCX", "pcx", &MakePCXImage},

   422

};

   423

   424

void InitializeScreenshotFormats()

   425

{

   426

	int i, j;

   427

	for (i = 0, j = 0; i != lengthof(_screenshot_formats); i++)

   428

		if (!strcmp(_screenshot_format_name, _screenshot_formats[i].extension)) {

   429

			j = i;

   430

			break;

   431

		}

   432

	_cur_screenshot_format = j;

   433

	_num_screenshot_formats = lengthof(_screenshot_formats);

   434

	current_screenshot_type = SC_NONE;

   435

}

   436

   437

const char *GetScreenshotFormatDesc(int i)

   438

{

   439

	return _screenshot_formats[i].name;

   440

}

   441

   442

void SetScreenshotFormat(int i)

   443

{

   444

	_cur_screenshot_format = i;

   445

	strcpy(_screenshot_format_name, _screenshot_formats[i].extension);

   446

}

   447

   448

/* screenshot generator that dumps the current video buffer */

   449

static void CurrentScreenCallback(void *userdata, Pixel *buf, uint y, uint pitch, uint n)

   450

{

   451

	for (; n > 0; --n) {

   452

		memcpy(buf, _screen.dst_ptr + y * _screen.pitch, _screen.width);

   453

		++y;

   454

		buf += pitch;

   455

	}

   456

}

   457

   458

/* generate a large piece of the world */

   459

static void LargeWorldCallback(void *userdata, Pixel *buf, uint y, uint pitch, uint n)

   460

{

   461

	ViewPort *vp = (ViewPort *)userdata;

   462

	DrawPixelInfo dpi, *old_dpi;

   463

	int wx, left;

   464

   465

	old_dpi = _cur_dpi;

   466

	_cur_dpi = &dpi;

   467

   468

	dpi.dst_ptr = buf;

   469

	dpi.height = n;

   470

	dpi.width = vp->width;

   471

	dpi.pitch = pitch;

   472

	dpi.zoom = 0;

   473

	dpi.left = 0;

   474

	dpi.top = y;

   475

   476

	left = 0;

   477

	while (vp->width - left != 0) {

   478

		wx = min(vp->width - left, 1600);

   479

		left += wx;

   480

   481

		ViewportDoDraw(vp,

   482

			((left - wx - vp->left) << vp->zoom) + vp->virtual_left,

   483

			((y - vp->top) << vp->zoom) + vp->virtual_top,

   484

			((left - vp->left) << vp->zoom) + vp->virtual_left,

   485

			(((y + n) - vp->top) << vp->zoom) + vp->virtual_top

   486

		);

   487

	}

   488

   489

	_cur_dpi = old_dpi;

   490

}

   491

   492

static char *MakeScreenshotName(const char *ext)

   493

{

   494

	static char filename[256];

   495

	char *base;

   496

	int serial;

   497

   498

	if (_game_mode == GM_EDITOR || _game_mode == GM_MENU || _local_player == PLAYER_SPECTATOR) {

   499

		sprintf(_screenshot_name, "screenshot");

   500

	} else {

   501

		const Player* p = GetPlayer(_local_player);