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 "viewport.h"

    11

#include "player.h"

    12

#include "gui.h"

    13

#include "screenshot.h"

    14

#include "variables.h"

    15

    16

char _screenshot_format_name[8];

    17

uint _num_screenshot_formats;

    18

uint _cur_screenshot_format;

    19

    20

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

    21

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

    22

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

    23

    24

typedef struct {

    25

	const char *name;

    26

	const char *extension;

    27

	ScreenshotHandlerProc *proc;

    28

} ScreenshotFormat;

    29

    30

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

    31

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

    32

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

    33

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

    34

#pragma pack(push, 1)

    35

#endif

    36

    37

typedef struct BitmapFileHeader {

    38

	uint16 type;

    39

	uint32 size;

    40

	uint32 reserved;

    41

	uint32 off_bits;

    42

} GCC_PACK BitmapFileHeader;

    43

assert_compile(sizeof(BitmapFileHeader) == 14);

    44

    45

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

    46

#pragma pack(pop)

    47

#endif

    48

    49

typedef struct BitmapInfoHeader {

    50

	uint32 size;

    51

	int32 width, height;

    52

	uint16 planes, bitcount;

    53

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

    54

} BitmapInfoHeader;

    55

assert_compile(sizeof(BitmapInfoHeader) == 40);

    56

    57

typedef struct RgbQuad {

    58

	byte blue, green, red, reserved;

    59

} RgbQuad;

    60

assert_compile(sizeof(RgbQuad) == 4);

    61

    62

// generic .BMP writer

    63

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

    64

{

    65

	BitmapFileHeader bfh;

    66

	BitmapInfoHeader bih;

    67

	RgbQuad rq[256];

    68

	Pixel *buff;

    69

	FILE *f;

    70

	uint i, padw;

    71

	uint n, maxlines;

    72

    73

	// only implemented for 8bit images so far.

    74

	if (pixelformat != 8)

    75

		return false;

    76

    77

	f = fopen(name, "wb");

    78

	if (f == NULL) return false;

    79

    80

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

    81

	padw = ALIGN(w, 4);

    82

    83

	// setup the file header

    84

	bfh.type = TO_LE16('MB');

    85

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

    86

	bfh.reserved = 0;

    87

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

    88

    89

	// setup the info header

    90

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

    91

	bih.width = TO_LE32(w);

    92

	bih.height = TO_LE32(h);

    93

	bih.planes = TO_LE16(1);

    94

	bih.bitcount = TO_LE16(8);

    95

	bih.compression = 0;

    96

	bih.sizeimage = 0;

    97

	bih.xpels = 0;

    98

	bih.ypels = 0;

    99

	bih.clrused = 0;

   100

	bih.clrimp = 0;

   101

   102

	// convert the palette to the windows format

   103

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

   104

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

   105

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

   106

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

   107

		rq[i].reserved = 0;

   108

	}

   109

   110

	// write file header and info header and palette

   111

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

   112

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

   113

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

   114

   115

	// use by default 64k temp memory

   116

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

   117

   118

	// now generate the bitmap bits

   119

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

   120

	if (buff == NULL) {

   121

		fclose(f);

   122

		return false;

   123

	}

   124

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

   125

   126

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

   127

	do {

   128

		// determine # lines

   129

		n = min(h, maxlines);

   130

		h -= n;

   131

   132

		// render the pixels

   133

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

   134

   135

		// write each line

   136

		while (n)

   137

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

   138

				free(buff);

   139

				fclose(f);

   140

				return false;

   141

			}

   142

	} while (h != 0);

   143

   144

	free(buff);

   145

	fclose(f);

   146

   147

	return true;

   148

}

   149

   150

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

   151

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

   152

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

   153

#if defined(WITH_PNG)

   154

#include <png.h>

   155

   156

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   157

{

   158

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

   159

	longjmp(png_ptr->jmpbuf, 1);

   160

}

   161

   162

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   163

{

   164

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

   165

}

   166

   167

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

   168

{

   169

	png_color rq[256];

   170

	Pixel *buff;

   171

	FILE *f;

   172

	uint i, y, n;

   173

	uint maxlines;

   174

	png_structp png_ptr;

   175

	png_infop info_ptr;

   176

   177

	// only implemented for 8bit images so far.

   178

	if (pixelformat != 8)

   179

		return false;

   180

   181

	f = fopen(name, "wb");

   182

	if (f == NULL) return false;

   183

   184

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

   185

   186

	if (png_ptr == NULL) {

   187

		fclose(f);

   188

		return false;

   189

	}

   190

   191

	info_ptr = png_create_info_struct(png_ptr);

   192

	if (info_ptr == NULL) {

   193

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   194

		fclose(f);

   195

		return false;

   196

	}

   197

   198

	if (setjmp(png_jmpbuf(png_ptr))) {

   199

		png_destroy_write_struct(&png_ptr, &info_ptr);

   200

		fclose(f);

   201

		return false;

   202

	}

   203

   204

	png_init_io(png_ptr, f);

   205

   206

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   207

   208

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

   209

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   210

   211

	// convert the palette to the .PNG format.

   212

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

   213

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

   214

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

   215

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

   216

	}

   217

   218

	png_set_PLTE(png_ptr, info_ptr, rq, 256);

   219

	png_write_info(png_ptr, info_ptr);

   220

	png_set_flush(png_ptr, 512);

   221

   222

	// use by default 64k temp memory

   223

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

   224

   225

	// now generate the bitmap bits

   226

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

   227

	if (buff == NULL) {

   228

		png_destroy_write_struct(&png_ptr, &info_ptr);

   229

		fclose(f);

   230

		return false;

   231

	}

   232

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

   233

   234

	y = 0;

   235

	do {

   236

		// determine # lines to write

   237

		n = min(h - y, maxlines);

   238

   239

		// render the pixels into the buffer

   240

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

   241

		y += n;

   242

   243

		// write them to png

   244

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

   245

			png_write_row(png_ptr, buff + i * w);

   246

	} while (y != h);

   247

   248

	png_write_end(png_ptr, info_ptr);

   249

	png_destroy_write_struct(&png_ptr, &info_ptr);

   250

   251

	free(buff);

   252

	fclose(f);

   253

	return true;

   254

}

   255

#endif // WITH_PNG

   256

   257

   258

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

   259

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

   260

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

   261

   262

typedef struct {

   263

	byte manufacturer;

   264

	byte version;

   265

	byte rle;

   266

	byte bpp;

   267

	uint32 unused;

   268

	uint16 xmax, ymax;

   269

	uint16 hdpi, vdpi;

   270

	byte pal_small[16*3];

   271

	byte reserved;

   272

	byte planes;

   273

	uint16 pitch;

   274

	uint16 cpal;

   275

	uint16 width;

   276

	uint16 height;

   277

	byte filler[54];

   278

} PcxHeader;

   279

assert_compile(sizeof(PcxHeader) == 128);

   280

   281

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

   282

{

   283

	Pixel *buff;

   284

	FILE *f;

   285

	uint maxlines;

   286

	uint y;

   287

	PcxHeader pcx;

   288

   289

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

   290

		return false;

   291

   292

	f = fopen(name, "wb");

   293

	if (f == NULL) return false;

   294

   295

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

   296

   297

	// setup pcx header

   298

	pcx.manufacturer = 10;

   299

	pcx.version = 5;

   300

	pcx.rle = 1;

   301

	pcx.bpp = 8;

   302

	pcx.xmax = TO_LE16(w - 1);

   303

	pcx.ymax = TO_LE16(h - 1);

   304

	pcx.hdpi = TO_LE16(320);

   305

	pcx.vdpi = TO_LE16(320);

   306

   307

	pcx.planes = 1;

   308

	pcx.cpal = TO_LE16(1);

   309

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

   310

	pcx.height = TO_LE16(h);

   311

   312

	// write pcx header

   313

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

   314

		fclose(f);

   315

		return false;

   316

	}

   317

   318

	// use by default 64k temp memory

   319

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

   320

   321

	// now generate the bitmap bits

   322

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

   323

	if (buff == NULL) {

   324

		fclose(f);

   325

		return false;

   326

	}

   327

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

   328

   329

	y = 0;

   330

	do {

   331

		// determine # lines to write

   332

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

   333

		uint i;

   334

   335

		// render the pixels into the buffer

   336

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

   337

		y += n;

   338

   339

		// write them to pcx

   340

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

   341

			const Pixel* bufp = buff + i * w;

   342

			byte runchar = bufp[0];

   343

			uint runcount = 1;

   344

			uint j;

   345

   346

			// for each pixel...

   347

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

   348

				Pixel ch = bufp[j];

   349

   350

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

   351

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

   352

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

   353

							free(buff);

   354

							fclose(f);

   355

							return false;

   356

						}

   357

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

   358

						free(buff);

   359

						fclose(f);

   360

						return false;

   361

					}

   362

					runcount = 0;

   363

					runchar = ch;

   364

				}

   365

				runcount++;

   366

			}

   367

   368

			// write remaining bytes..

   369

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

   370

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

   371

					free(buff);

   372

					fclose(f);

   373

					return false;

   374

				}

   375

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

   376

				free(buff);

   377

				fclose(f);

   378

				return false;

   379

			}

   380

		}

   381

	} while (y != h);

   382

   383

	free(buff);

   384

   385

	// write 8-bit color palette

   386

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

   387

		fclose(f);

   388

		return false;

   389

	}

   390

   391

	{assert_compile(sizeof(*palette) == 3);}

   392

	if (fwrite(palette, 256 * sizeof(*palette), 1, f) != 1) {

   393

		fclose(f);

   394

		return false;

   395

	}

   396

	fclose(f);

   397

   398

	return true;

   399

}

   400

   401

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

   402

//*** GENERIC SCREENSHOT CODE

   403

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

   404

   405

static const ScreenshotFormat _screenshot_formats[] = {

   406

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

   407

#if defined(WITH_PNG)

   408

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

   409

#endif

   410

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

   411

};

   412

   413

void InitializeScreenshotFormats(void)

   414

{

   415

	int i, j;

   416

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

   417

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

   418

			j = i;

   419

			break;

   420

		}

   421

	_cur_screenshot_format = j;

   422

	_num_screenshot_formats = lengthof(_screenshot_formats);

   423

}

   424

   425

const char *GetScreenshotFormatDesc(int i)

   426

{

   427

	return _screenshot_formats[i].name;

   428

}

   429

   430

void SetScreenshotFormat(int i)

   431

{

   432

	_cur_screenshot_format = i;

   433

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

   434

}

   435

   436

// screenshot generator that dumps the current video buffer

   437

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

   438

{

   439

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

   440

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

   441

		++y;

   442

		buf += pitch;

   443

	}

   444

}

   445

   446

// generate a large piece of the world

   447

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

   448

{

   449

	ViewPort *vp = (ViewPort *)userdata;

   450

	DrawPixelInfo dpi, *old_dpi;

   451

	int wx, left;

   452

   453

	old_dpi = _cur_dpi;

   454

	_cur_dpi = &dpi;

   455

   456

	dpi.dst_ptr = buf;

   457

	dpi.height = n;

   458

	dpi.width = vp->width;

   459

	dpi.pitch = pitch;

   460

	dpi.zoom = 0;

   461

	dpi.left = 0;

   462

	dpi.top = y;

   463

   464

	left = 0;

   465

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

   466

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

   467

		left += wx;

   468

   469

		ViewportDoDraw(vp,

   470

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

   471

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

   472

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

   473

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

   474

		);

   475

	}

   476

   477

	_cur_dpi = old_dpi;

   478

}

   479

   480

static char *MakeScreenshotName(const char *ext)

   481

{

   482

	static char filename[256];

   483

	char *base;

   484

	int serial;

   485

   486

	if (_game_mode == GM_EDITOR || _local_player == OWNER_SPECTATOR) {

   487

		sprintf(_screenshot_name, "screenshot");

   488

	} else {

   489

		const Player* p = GetPlayer(_local_player);

   490

		SetDParam(0, p->name_1);

   491

		SetDParam(1, p->name_2);

   492

		SetDParam(2, _date);

   493

		GetString(_screenshot_name, STR_4004);

   494

	}

   495

   496

	base = strchr(_screenshot_name, 0);

   497

	base[0] = '.'; strcpy(base + 1, ext);

   498

   499

	serial = 0;

   500

	for (;;) {

   501

		snprintf(filename, sizeof(filename), "%s%s", _path.personal_dir, _screenshot_name);

   502

		if (!FileExists(filename))

   503

			break;

   504

		sprintf(base, " #%d.%s", ++serial, ext);

   505

	}

   506

   507

	return filename;

   508

}

   509

   510

bool MakeScreenshot(void)