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

    17

char _screenshot_format_name[8];

    18

uint _num_screenshot_formats;

    19

uint _cur_screenshot_format;

    20

ScreenshotType current_screenshot_type;

    21

    22

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

    23

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

    24

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

    25

    26

typedef struct {

    27

	const char *name;

    28

	const char *extension;

    29

	ScreenshotHandlerProc *proc;

    30

} ScreenshotFormat;

    31

    32

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

    33

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

    34

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

    35

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

    36

#pragma pack(push, 1)

    37

#endif

    38

    39

typedef struct BitmapFileHeader {

    40

	uint16 type;

    41

	uint32 size;

    42

	uint32 reserved;

    43

	uint32 off_bits;

    44

} GCC_PACK BitmapFileHeader;

    45

assert_compile(sizeof(BitmapFileHeader) == 14);

    46

    47

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

    48

#pragma pack(pop)

    49

#endif

    50

    51

typedef struct BitmapInfoHeader {

    52

	uint32 size;

    53

	int32 width, height;

    54

	uint16 planes, bitcount;

    55

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

    56

} BitmapInfoHeader;

    57

assert_compile(sizeof(BitmapInfoHeader) == 40);

    58

    59

typedef struct RgbQuad {

    60

	byte blue, green, red, reserved;

    61

} RgbQuad;

    62

assert_compile(sizeof(RgbQuad) == 4);

    63

    64

// generic .BMP writer

    65

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

    66

{

    67

	BitmapFileHeader bfh;

    68

	BitmapInfoHeader bih;

    69

	RgbQuad rq[256];

    70

	Pixel *buff;

    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

	buff = malloc(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

	Pixel *buff;

   173

	FILE *f;

   174

	uint i, y, n;

   175

	uint maxlines;

   176

	png_structp png_ptr;

   177

	png_infop info_ptr;

   178

   179

	// only implemented for 8bit images so far.

   180

	if (pixelformat != 8)

   181

		return false;

   182

   183

	f = fopen(name, "wb");

   184

	if (f == NULL) return false;

   185

   186

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

   187

   188

	if (png_ptr == NULL) {

   189

		fclose(f);

   190

		return false;

   191

	}

   192

   193

	info_ptr = png_create_info_struct(png_ptr);

   194

	if (info_ptr == NULL) {

   195

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   196

		fclose(f);

   197

		return false;

   198

	}

   199

   200

	if (setjmp(png_jmpbuf(png_ptr))) {

   201

		png_destroy_write_struct(&png_ptr, &info_ptr);

   202

		fclose(f);

   203

		return false;

   204

	}

   205

   206

	png_init_io(png_ptr, f);

   207

   208

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   209

   210

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

   211

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   212

   213

	// convert the palette to the .PNG format.

   214

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

   215

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

   216

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

   217

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

   218

	}

   219

   220

	png_set_PLTE(png_ptr, info_ptr, rq, 256);

   221

	png_write_info(png_ptr, info_ptr);

   222

	png_set_flush(png_ptr, 512);

   223

   224

	// use by default 64k temp memory

   225

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

   226

   227

	// now generate the bitmap bits

   228

	buff = malloc(w * maxlines); // by default generate 128 lines at a time.

   229

	if (buff == NULL) {

   230

		png_destroy_write_struct(&png_ptr, &info_ptr);

   231

		fclose(f);

   232

		return false;

   233

	}

   234

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

   235

   236

	y = 0;

   237

	do {

   238

		// determine # lines to write

   239

		n = min(h - y, maxlines);

   240

   241

		// render the pixels into the buffer

   242

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

   243

		y += n;

   244

   245

		// write them to png

   246

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

   247

			png_write_row(png_ptr, buff + i * w);

   248

	} while (y != h);

   249

   250

	png_write_end(png_ptr, info_ptr);

   251

	png_destroy_write_struct(&png_ptr, &info_ptr);

   252

   253

	free(buff);

   254

	fclose(f);

   255

	return true;

   256

}

   257

#endif /* WITH_PNG */

   258

   259

   260

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

   261

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

   262

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

   263

   264

typedef struct {

   265

	byte manufacturer;

   266

	byte version;

   267

	byte rle;

   268

	byte bpp;

   269

	uint32 unused;

   270

	uint16 xmax, ymax;

   271

	uint16 hdpi, vdpi;

   272

	byte pal_small[16*3];

   273

	byte reserved;

   274

	byte planes;

   275

	uint16 pitch;

   276

	uint16 cpal;

   277

	uint16 width;

   278

	uint16 height;

   279

	byte filler[54];

   280

} PcxHeader;

   281

assert_compile(sizeof(PcxHeader) == 128);

   282

   283

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

   284

{

   285

	Pixel *buff;

   286

	FILE *f;

   287

	uint maxlines;

   288

	uint y;

   289

	PcxHeader pcx;

   290

	bool success;

   291

   292

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

   293

		return false;

   294

   295

	f = fopen(name, "wb");

   296

	if (f == NULL) return false;

   297

   298

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

   299

   300

	// setup pcx header

   301

	pcx.manufacturer = 10;

   302

	pcx.version = 5;

   303

	pcx.rle = 1;

   304

	pcx.bpp = 8;

   305

	pcx.xmax = TO_LE16(w - 1);

   306

	pcx.ymax = TO_LE16(h - 1);

   307

	pcx.hdpi = TO_LE16(320);

   308

	pcx.vdpi = TO_LE16(320);

   309

   310

	pcx.planes = 1;

   311

	pcx.cpal = TO_LE16(1);

   312

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

   313

	pcx.height = TO_LE16(h);

   314

   315

	// write pcx header

   316

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

   317

		fclose(f);

   318

		return false;

   319

	}

   320

   321

	// use by default 64k temp memory

   322

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

   323

   324

	// now generate the bitmap bits

   325

	buff = malloc(w * maxlines); // by default generate 128 lines at a time.

   326

	if (buff == NULL) {

   327

		fclose(f);

   328

		return false;

   329

	}

   330

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

   331

   332

	y = 0;

   333

	do {

   334

		// determine # lines to write

   335

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

   336

		uint i;

   337

   338

		// render the pixels into the buffer

   339

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

   340

		y += n;

   341

   342

		// write them to pcx

   343

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

   344

			const Pixel* bufp = buff + i * w;

   345

			byte runchar = bufp[0];

   346

			uint runcount = 1;

   347

			uint j;

   348

   349

			// for each pixel...

   350

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

   351

				Pixel ch = bufp[j];

   352

   353

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

   354

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

   355

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

   356

							free(buff);

   357

							fclose(f);

   358

							return false;

   359

						}

   360

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

   361

						free(buff);

   362

						fclose(f);

   363

						return false;

   364

					}

   365

					runcount = 0;

   366

					runchar = ch;

   367

				}

   368

				runcount++;

   369

			}

   370

   371

			// write remaining bytes..

   372

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

   373

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

   374

					free(buff);

   375

					fclose(f);

   376

					return false;

   377

				}

   378

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

   379

				free(buff);

   380

				fclose(f);

   381

				return false;

   382

			}

   383

		}

   384

	} while (y != h);

   385

   386

	free(buff);

   387

   388

	// write 8-bit color palette

   389

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

   390

		fclose(f);

   391

		return false;

   392

	}

   393

   394

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

   395

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

   396

	} else {

   397

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

   398

		byte tmp[256 * 3];

   399

		uint i;

   400

   401

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

   402

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

   403

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

   404

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

   405

		}

   406

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

   407

	}

   408

   409

	fclose(f);

   410

   411

	return success;

   412

}

   413

   414

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

   415

//*** GENERIC SCREENSHOT CODE

   416

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

   417

   418

static const ScreenshotFormat _screenshot_formats[] = {

   419

#if defined(WITH_PNG)

   420

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

   421

#endif

   422

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

   423

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

   424

};

   425

   426

void InitializeScreenshotFormats(void)

   427

{

   428

	int i, j;

   429

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

   430

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

   431

			j = i;

   432

			break;

   433

		}

   434

	_cur_screenshot_format = j;

   435

	_num_screenshot_formats = lengthof(_screenshot_formats);

   436

	current_screenshot_type = SC_NONE;

   437

}

   438

   439

const char *GetScreenshotFormatDesc(int i)

   440

{

   441

	return _screenshot_formats[i].name;

   442

}

   443

   444

void SetScreenshotFormat(int i)

   445

{

   446

	_cur_screenshot_format = i;

   447

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

   448

}

   449

   450

// screenshot generator that dumps the current video buffer

   451

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

   452

{

   453

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

   454

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

   455

		++y;

   456

		buf += pitch;

   457

	}

   458

}

   459

   460

// generate a large piece of the world

   461

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

   462

{

   463

	ViewPort *vp = (ViewPort *)userdata;

   464

	DrawPixelInfo dpi, *old_dpi;

   465

	int wx, left;

   466

   467

	old_dpi = _cur_dpi;

   468

	_cur_dpi = &dpi;

   469

   470

	dpi.dst_ptr = buf;

   471

	dpi.height = n;

   472

	dpi.width = vp->width;

   473

	dpi.pitch = pitch;

   474

	dpi.zoom = 0;

   475

	dpi.left = 0;

   476

	dpi.top = y;

   477

   478

	left = 0;

   479

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

   480

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

   481

		left += wx;

   482

   483

		ViewportDoDraw(vp,

   484

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

   485

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

   486

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

   487

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

   488

		);

   489

	}

   490

   491

	_cur_dpi = old_dpi;

   492

}

   493

   494

static char *MakeScreenshotName(const char *ext)

   495

{

   496

	static char filename[256];

   497

	char *base;

   498

	int serial;

   499

   500

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

   501

		sprintf(_screenshot_name, "screenshot");

   502

	} else {

   503

		const Player* p = GetPlayer(_local_player);

   504

		SetDParam(0, p->name_1);

   505

		SetDParam(1, p->name_2);

   506

		SetDParam(2, _date);

   507

		GetString(_screenshot_name, STR_4004, lastof(_screenshot_name));