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

    11

#include "viewport.h"

    12

#include "player.h"

    13

#include "screenshot.h"

    14

#include "variables.h"

    15

#include "date.h"

    16

#include "string.h"

    17

#include "helpers.hpp"

    18

#include "blitter/factory.hpp"

    19

#include "fileio.h"

    20

    21

char _screenshot_format_name[8];

    22

uint _num_screenshot_formats;

    23

uint _cur_screenshot_format;

    24

ScreenshotType current_screenshot_type;

    25

    26

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

    27

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

    28

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

    29

    30

struct ScreenshotFormat {

    31

	const char *name;

    32

	const char *extension;

    33

	ScreenshotHandlerProc *proc;

    34

};

    35

    36

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

    37

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

    38

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

    39

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

    40

#pragma pack(push, 1)

    41

#endif

    42

    43

struct BitmapFileHeader {

    44

	uint16 type;

    45

	uint32 size;

    46

	uint32 reserved;

    47

	uint32 off_bits;

    48

} GCC_PACK;

    49

assert_compile(sizeof(BitmapFileHeader) == 14);

    50

    51

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

    52

#pragma pack(pop)

    53

#endif

    54

    55

struct BitmapInfoHeader {

    56

	uint32 size;

    57

	int32 width, height;

    58

	uint16 planes, bitcount;

    59

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

    60

};

    61

assert_compile(sizeof(BitmapInfoHeader) == 40);

    62

    63

struct RgbQuad {

    64

	byte blue, green, red, reserved;

    65

};

    66

assert_compile(sizeof(RgbQuad) == 4);

    67

    68

/* generic .BMP writer */

    69

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

    70

{

    71

	BitmapFileHeader bfh;

    72

	BitmapInfoHeader bih;

    73

	RgbQuad rq[256];

    74

	FILE *f;

    75

	uint i, padw;

    76

	uint n, maxlines;

    77

	uint pal_size = 0;

    78

	uint bpp = pixelformat / 8;

    79

    80

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

    81

	if (pixelformat != 8 && pixelformat != 32) return false;

    82

    83

	f = fopen(name, "wb");

    84

	if (f == NULL) return false;

    85

    86

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

    87

	padw = ALIGN(w, 4);

    88

    89

	if (pixelformat == 8) pal_size = sizeof(RgbQuad) * 256;

    90

    91

	/* setup the file header */

    92

	bfh.type = TO_LE16('MB');

    93

	bfh.size = TO_LE32(sizeof(bfh) + sizeof(bih) + pal_size + padw * h * bpp);

    94

	bfh.reserved = 0;

    95

	bfh.off_bits = TO_LE32(sizeof(bfh) + sizeof(bih) + pal_size);

    96

    97

	/* setup the info header */

    98

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

    99

	bih.width = TO_LE32(w);

   100

	bih.height = TO_LE32(h);

   101

	bih.planes = TO_LE16(1);

   102

	bih.bitcount = TO_LE16(pixelformat);

   103

	bih.compression = 0;

   104

	bih.sizeimage = 0;

   105

	bih.xpels = 0;

   106

	bih.ypels = 0;

   107

	bih.clrused = 0;

   108

	bih.clrimp = 0;

   109

   110

	if (pixelformat == 8) {

   111

		/* convert the palette to the windows format */

   112

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

   113

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

   114

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

   115

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

   116

			rq[i].reserved = 0;

   117

		}

   118

	}

   119

   120

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

   121

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

   122

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

   123

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

   124

   125

	/* use by default 64k temp memory */

   126

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

   127

   128

	/* now generate the bitmap bits */

   129

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

   130

	if (buff == NULL) {

   131

		fclose(f);

   132

		return false;

   133

	}

   134

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

   135

   136

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

   137

	do {

   138

		/* determine # lines */

   139

		n = min(h, maxlines);

   140

		h -= n;

   141

   142

		/* render the pixels */

   143

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

   144

   145

		/* write each line */

   146

		while (n)

   147

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

   148

				free(buff);

   149

				fclose(f);

   150

				return false;

   151

			}

   152

	} while (h != 0);

   153

   154

	free(buff);

   155

	fclose(f);

   156

   157

	return true;

   158

}

   159

   160

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

   161

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

   162

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

   163

#if defined(WITH_PNG)

   164

#include <png.h>

   165

   166

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   167

{

   168

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

   169

	longjmp(png_ptr->jmpbuf, 1);

   170

}

   171

   172

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   173

{

   174

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

   175

}

   176

   177

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

   178

{

   179

	png_color rq[256];

   180

	FILE *f;

   181

	uint i, y, n;

   182

	uint maxlines;

   183

	uint bpp = pixelformat / 8;

   184

	png_structp png_ptr;

   185

	png_infop info_ptr;

   186

   187

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

   188

	if (pixelformat != 8 && pixelformat != 32) return false;

   189

   190

	f = fopen(name, "wb");

   191

	if (f == NULL) return false;

   192

   193

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

   194

   195

	if (png_ptr == NULL) {

   196

		fclose(f);

   197

		return false;

   198

	}

   199

   200

	info_ptr = png_create_info_struct(png_ptr);

   201

	if (info_ptr == NULL) {

   202

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   203

		fclose(f);

   204

		return false;

   205

	}

   206

   207

	if (setjmp(png_jmpbuf(png_ptr))) {

   208

		png_destroy_write_struct(&png_ptr, &info_ptr);

   209

		fclose(f);

   210

		return false;

   211

	}

   212

   213

	png_init_io(png_ptr, f);

   214

   215

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   216

   217

	png_set_IHDR(png_ptr, info_ptr, w, h, 8, pixelformat == 8 ? PNG_COLOR_TYPE_PALETTE : PNG_COLOR_TYPE_RGB,

   218

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   219

   220

	if (pixelformat == 8) {

   221

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

   222

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

   223

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

   224

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

   225

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

   226

		}

   227

   228

		png_set_PLTE(png_ptr, info_ptr, rq, 256);

   229

	}

   230

   231

	png_write_info(png_ptr, info_ptr);

   232

	png_set_flush(png_ptr, 512);

   233

   234

	if (pixelformat == 32) {

   235

		png_color_8 sig_bit;

   236

   237

		/* Save exact color/alpha resolution */

   238

		sig_bit.alpha = 0;

   239

		sig_bit.blue  = 8;

   240

		sig_bit.green = 8;

   241

		sig_bit.red   = 8;

   242

		sig_bit.gray  = 8;

   243

		png_set_sBIT(png_ptr, info_ptr, &sig_bit);

   244

   245

#ifdef TTD_LITTLE_ENDIAN

   246

		png_set_bgr(png_ptr);

   247

		png_set_filler(png_ptr, 0, PNG_FILLER_AFTER);

   248

#else

   249

		png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

   250

#endif

   251

	}

   252

   253

	/* use by default 64k temp memory */

   254

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

   255

   256

	/* now generate the bitmap bits */

   257

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

   258

	if (buff == NULL) {

   259

		png_destroy_write_struct(&png_ptr, &info_ptr);

   260

		fclose(f);

   261

		return false;

   262

	}

   263

	memset(buff, 0, w * maxlines * bpp);

   264

   265

	y = 0;

   266

	do {

   267

		/* determine # lines to write */

   268

		n = min(h - y, maxlines);

   269

   270

		/* render the pixels into the buffer */

   271

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

   272

		y += n;

   273

   274

		/* write them to png */

   275

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

   276

			png_write_row(png_ptr, (png_bytep)buff + i * w * bpp);

   277

	} while (y != h);

   278

   279

	png_write_end(png_ptr, info_ptr);

   280

	png_destroy_write_struct(&png_ptr, &info_ptr);

   281

   282

	free(buff);

   283

	fclose(f);

   284

	return true;

   285

}

   286

#endif /* WITH_PNG */

   287

   288

   289

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

   290

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

   291

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

   292

   293

struct PcxHeader {

   294

	byte manufacturer;

   295

	byte version;

   296

	byte rle;

   297

	byte bpp;

   298

	uint32 unused;

   299

	uint16 xmax, ymax;

   300

	uint16 hdpi, vdpi;

   301

	byte pal_small[16 * 3];

   302

	byte reserved;

   303

	byte planes;

   304

	uint16 pitch;

   305

	uint16 cpal;

   306

	uint16 width;

   307

	uint16 height;

   308

	byte filler[54];

   309

};

   310

assert_compile(sizeof(PcxHeader) == 128);

   311

   312

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

   313

{

   314

	FILE *f;

   315

	uint maxlines;

   316

	uint y;

   317

	PcxHeader pcx;

   318

	bool success;

   319

   320

	if (pixelformat == 32) {

   321

		DEBUG(misc, 0, "Can't convert a 32bpp screenshot to PCX format. Please pick an other format.");

   322

		return false;

   323

	}

   324

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

   325

		return false;

   326

   327

	f = fopen(name, "wb");

   328

	if (f == NULL) return false;

   329

   330

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

   331

   332

	/* setup pcx header */

   333

	pcx.manufacturer = 10;

   334

	pcx.version = 5;

   335

	pcx.rle = 1;

   336

	pcx.bpp = 8;

   337

	pcx.xmax = TO_LE16(w - 1);

   338

	pcx.ymax = TO_LE16(h - 1);

   339

	pcx.hdpi = TO_LE16(320);

   340

	pcx.vdpi = TO_LE16(320);

   341

   342

	pcx.planes = 1;

   343

	pcx.cpal = TO_LE16(1);

   344

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

   345

	pcx.height = TO_LE16(h);

   346

   347

	/* write pcx header */

   348

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

   349

		fclose(f);

   350

		return false;

   351

	}

   352

   353

	/* use by default 64k temp memory */

   354

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

   355

   356

	/* now generate the bitmap bits */

   357

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

   358

	if (buff == NULL) {

   359

		fclose(f);

   360

		return false;

   361

	}

   362

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

   363

   364

	y = 0;

   365

	do {

   366

		/* determine # lines to write */

   367

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

   368

		uint i;

   369

   370

		/* render the pixels into the buffer */

   371

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

   372

		y += n;

   373

   374

		/* write them to pcx */

   375

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

   376

			const uint8 *bufp = buff + i * w;

   377

			byte runchar = bufp[0];

   378

			uint runcount = 1;

   379

			uint j;

   380

   381

			/* for each pixel... */

   382

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

   383

				uint8 ch = bufp[j];

   384

   385

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

   386

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

   387

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

   388

							free(buff);

   389

							fclose(f);

   390

							return false;

   391

						}

   392

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

   393

						free(buff);

   394

						fclose(f);

   395

						return false;

   396

					}

   397

					runcount = 0;

   398

					runchar = ch;

   399

				}

   400

				runcount++;

   401

			}

   402

   403

			/* write remaining bytes.. */

   404

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

   405

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

   406

					free(buff);

   407

					fclose(f);

   408

					return false;

   409

				}

   410

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

   411

				free(buff);

   412

				fclose(f);

   413

				return false;

   414

			}

   415

		}

   416

	} while (y != h);

   417

   418

	free(buff);

   419

   420

	/* write 8-bit color palette */

   421

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

   422

		fclose(f);

   423

		return false;

   424

	}

   425

   426

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

   427

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

   428

	} else {

   429

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

   430

		byte tmp[256 * 3];

   431

		uint i;

   432

   433

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

   434

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

   435

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

   436

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

   437

		}

   438

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

   439

	}

   440

   441

	fclose(f);

   442

   443

	return success;

   444

}

   445

   446

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

   447

//*** GENERIC SCREENSHOT CODE

   448

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

   449

   450

static const ScreenshotFormat _screenshot_formats[] = {

   451

#if defined(WITH_PNG)

   452

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

   453

#endif

   454

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

   455

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

   456

};

   457

   458

void InitializeScreenshotFormats()

   459

{

   460

	int i, j;

   461

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

   462

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

   463

			j = i;

   464

			break;

   465

		}

   466

	_cur_screenshot_format = j;

   467

	_num_screenshot_formats = lengthof(_screenshot_formats);

   468

	current_screenshot_type = SC_NONE;

   469

}

   470

   471

const char *GetScreenshotFormatDesc(int i)

   472

{

   473

	return _screenshot_formats[i].name;

   474

}

   475

   476

void SetScreenshotFormat(int i)

   477

{

   478

	_cur_screenshot_format = i;

   479

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

   480

}

   481

   482

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

   483

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

   484

{

   485

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   486

	void *src = blitter->MoveTo(_screen.dst_ptr, 0, y);

   487

	blitter->CopyImageToBuffer(src, buf, _screen.width, n, pitch);

   488

}

   489

   490

/* generate a large piece of the world */

   491

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

   492

{

   493

	ViewPort *vp = (ViewPort *)userdata;

   494

	DrawPixelInfo dpi, *old_dpi;

   495

	int wx, left;

   496

   497

	old_dpi = _cur_dpi;

   498

	_cur_dpi = &dpi;