1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "table/strings.h"

     8

#include "fileio.h"

     9

#include "viewport.h"

    10

#include "player.h"

    11

#include "screenshot.h"

    12

#include "variables.h"

    13

#include "date.h"

    14

#include "string.h"

    15

#include "helpers.hpp"

    16

#include "blitter/factory.hpp"

    17

#include "fileio.h"

    18

#include "strings_func.h"

    19

    20

char _screenshot_format_name[8];

    21

uint _num_screenshot_formats;

    22

uint _cur_screenshot_format;

    23

ScreenshotType current_screenshot_type;

    24

    25

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

    26

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

    27

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

    28

    29

struct ScreenshotFormat {

    30

	const char *name;

    31

	const char *extension;

    32

	ScreenshotHandlerProc *proc;

    33

};

    34

    35

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

    36

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

    37

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

    38

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

    39

#pragma pack(push, 1)

    40

#endif

    41

    42

struct BitmapFileHeader {

    43

	uint16 type;

    44

	uint32 size;

    45

	uint32 reserved;

    46

	uint32 off_bits;

    47

} GCC_PACK;

    48

assert_compile(sizeof(BitmapFileHeader) == 14);

    49

    50

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

    51

#pragma pack(pop)

    52

#endif

    53

    54

struct BitmapInfoHeader {

    55

	uint32 size;

    56

	int32 width, height;

    57

	uint16 planes, bitcount;

    58

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

    59

};

    60

assert_compile(sizeof(BitmapInfoHeader) == 40);

    61

    62

struct RgbQuad {

    63

	byte blue, green, red, reserved;

    64

};

    65

assert_compile(sizeof(RgbQuad) == 4);

    66

    67

/* generic .BMP writer */

    68

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

    69

{

    70

	BitmapFileHeader bfh;

    71

	BitmapInfoHeader bih;

    72

	RgbQuad rq[256];

    73

	FILE *f;

    74

	uint i, padw;

    75

	uint n, maxlines;

    76

	uint pal_size = 0;

    77

	uint bpp = pixelformat / 8;

    78

    79

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

    80

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

    81

    82

	f = fopen(name, "wb");

    83

	if (f == NULL) return false;

    84

    85

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

    86

	padw = Align(w, 4);

    87

    88

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

    89

    90

	/* setup the file header */

    91

	bfh.type = TO_LE16('MB');

    92

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

    93

	bfh.reserved = 0;

    94

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

    95

    96

	/* setup the info header */

    97

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

    98

	bih.width = TO_LE32(w);

    99

	bih.height = TO_LE32(h);

   100

	bih.planes = TO_LE16(1);

   101

	bih.bitcount = TO_LE16(pixelformat);

   102

	bih.compression = 0;

   103

	bih.sizeimage = 0;

   104

	bih.xpels = 0;

   105

	bih.ypels = 0;

   106

	bih.clrused = 0;

   107

	bih.clrimp = 0;

   108

   109

	if (pixelformat == 8) {

   110

		/* convert the palette to the windows format */

   111

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

   112

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

   113

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

   114

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

   115

			rq[i].reserved = 0;

   116

		}

   117

	}

   118

   119

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

   120

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

   121

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

   122

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

   123

   124

	/* use by default 64k temp memory */

   125

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

   126

   127

	/* now generate the bitmap bits */

   128

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

   129

	if (buff == NULL) {

   130

		fclose(f);

   131

		return false;

   132

	}

   133

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

   134

   135

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

   136

	do {

   137

		/* determine # lines */

   138

		n = min(h, maxlines);

   139

		h -= n;

   140

   141

		/* render the pixels */

   142

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

   143

   144

		/* write each line */

   145

		while (n)

   146

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

   147

				free(buff);

   148

				fclose(f);

   149

				return false;

   150

			}

   151

	} while (h != 0);

   152

   153

	free(buff);

   154

	fclose(f);

   155

   156

	return true;

   157

}

   158

   159

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

   160

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

   161

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

   162

#if defined(WITH_PNG)

   163

#include <png.h>

   164

   165

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   166

{

   167

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

   168

	longjmp(png_ptr->jmpbuf, 1);

   169

}

   170

   171

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   172

{

   173

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

   174

}

   175

   176

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

   177

{

   178

	png_color rq[256];

   179

	FILE *f;

   180

	uint i, y, n;

   181

	uint maxlines;

   182

	uint bpp = pixelformat / 8;

   183

	png_structp png_ptr;

   184

	png_infop info_ptr;

   185

   186

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

   187

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

   188

   189

	f = fopen(name, "wb");

   190

	if (f == NULL) return false;

   191

   192

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

   193

   194

	if (png_ptr == NULL) {

   195

		fclose(f);

   196

		return false;

   197

	}

   198

   199

	info_ptr = png_create_info_struct(png_ptr);

   200

	if (info_ptr == NULL) {

   201

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   202

		fclose(f);

   203

		return false;

   204

	}

   205

   206

	if (setjmp(png_jmpbuf(png_ptr))) {

   207

		png_destroy_write_struct(&png_ptr, &info_ptr);

   208

		fclose(f);

   209

		return false;

   210

	}

   211

   212

	png_init_io(png_ptr, f);

   213

   214

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   215

   216

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

   217

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   218

   219

	if (pixelformat == 8) {

   220

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

   221

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

   222

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

   223

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

   224

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

   225

		}

   226

   227

		png_set_PLTE(png_ptr, info_ptr, rq, 256);

   228

	}

   229

   230

	png_write_info(png_ptr, info_ptr);

   231

	png_set_flush(png_ptr, 512);

   232

   233

	if (pixelformat == 32) {

   234

		png_color_8 sig_bit;

   235

   236

		/* Save exact color/alpha resolution */

   237

		sig_bit.alpha = 0;

   238

		sig_bit.blue  = 8;

   239

		sig_bit.green = 8;

   240

		sig_bit.red   = 8;

   241

		sig_bit.gray  = 8;

   242

		png_set_sBIT(png_ptr, info_ptr, &sig_bit);

   243

   244

#ifdef TTD_LITTLE_ENDIAN

   245

		png_set_bgr(png_ptr);

   246

		png_set_filler(png_ptr, 0, PNG_FILLER_AFTER);

   247

#else

   248

		png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

   249

#endif

   250

	}

   251

   252

	/* use by default 64k temp memory */

   253

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

   254

   255

	/* now generate the bitmap bits */

   256

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

   257

	if (buff == NULL) {

   258

		png_destroy_write_struct(&png_ptr, &info_ptr);

   259

		fclose(f);

   260

		return false;

   261

	}

   262

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

   263

   264

	y = 0;

   265

	do {

   266

		/* determine # lines to write */

   267

		n = min(h - y, maxlines);

   268

   269

		/* render the pixels into the buffer */

   270

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

   271

		y += n;

   272

   273

		/* write them to png */

   274

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

   275

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

   276

	} while (y != h);

   277

   278

	png_write_end(png_ptr, info_ptr);

   279

	png_destroy_write_struct(&png_ptr, &info_ptr);

   280

   281

	free(buff);

   282

	fclose(f);

   283

	return true;

   284

}

   285

#endif /* WITH_PNG */

   286

   287

   288

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

   289

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

   290

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

   291

   292

struct PcxHeader {

   293

	byte manufacturer;

   294

	byte version;

   295

	byte rle;

   296

	byte bpp;

   297

	uint32 unused;

   298

	uint16 xmax, ymax;

   299

	uint16 hdpi, vdpi;

   300

	byte pal_small[16 * 3];

   301

	byte reserved;

   302

	byte planes;

   303

	uint16 pitch;

   304

	uint16 cpal;

   305

	uint16 width;

   306

	uint16 height;

   307

	byte filler[54];

   308

};

   309

assert_compile(sizeof(PcxHeader) == 128);

   310

   311

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

   312

{

   313

	FILE *f;

   314

	uint maxlines;

   315

	uint y;

   316

	PcxHeader pcx;

   317

	bool success;

   318

   319

	if (pixelformat == 32) {

   320

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

   321

		return false;

   322

	}

   323

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

   324

		return false;

   325

   326

	f = fopen(name, "wb");

   327

	if (f == NULL) return false;

   328

   329

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

   330

   331

	/* setup pcx header */

   332

	pcx.manufacturer = 10;

   333

	pcx.version = 5;

   334

	pcx.rle = 1;

   335

	pcx.bpp = 8;

   336

	pcx.xmax = TO_LE16(w - 1);

   337

	pcx.ymax = TO_LE16(h - 1);

   338

	pcx.hdpi = TO_LE16(320);

   339

	pcx.vdpi = TO_LE16(320);

   340

   341

	pcx.planes = 1;

   342

	pcx.cpal = TO_LE16(1);

   343

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

   344

	pcx.height = TO_LE16(h);

   345

   346

	/* write pcx header */

   347

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

   348

		fclose(f);

   349

		return false;

   350

	}

   351

   352

	/* use by default 64k temp memory */

   353

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

   354

   355

	/* now generate the bitmap bits */

   356

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

   357

	if (buff == NULL) {

   358

		fclose(f);

   359

		return false;

   360

	}

   361

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

   362

   363

	y = 0;

   364

	do {

   365

		/* determine # lines to write */

   366

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

   367

		uint i;

   368

   369

		/* render the pixels into the buffer */

   370

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

   371

		y += n;

   372

   373

		/* write them to pcx */

   374

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

   375

			const uint8 *bufp = buff + i * w;

   376

			byte runchar = bufp[0];

   377

			uint runcount = 1;

   378

			uint j;

   379

   380

			/* for each pixel... */

   381

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

   382

				uint8 ch = bufp[j];

   383

   384

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

   385

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

   386

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

   387

							free(buff);

   388

							fclose(f);

   389

							return false;

   390

						}

   391

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

   392

						free(buff);

   393

						fclose(f);

   394

						return false;

   395

					}

   396

					runcount = 0;

   397

					runchar = ch;

   398

				}

   399

				runcount++;

   400

			}

   401

   402

			/* write remaining bytes.. */

   403

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

   404

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

   405

					free(buff);

   406

					fclose(f);

   407

					return false;

   408

				}

   409

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

   410

				free(buff);

   411

				fclose(f);

   412

				return false;

   413

			}

   414

		}

   415

	} while (y != h);

   416

   417

	free(buff);

   418

   419

	/* write 8-bit color palette */

   420

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

   421

		fclose(f);

   422

		return false;

   423

	}

   424

   425

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

   426

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

   427

	} else {

   428

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

   429

		byte tmp[256 * 3];

   430

		uint i;

   431

   432

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

   433

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

   434

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

   435

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

   436

		}

   437

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

   438

	}

   439

   440

	fclose(f);

   441

   442

	return success;

   443

}

   444

   445

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

   446

//*** GENERIC SCREENSHOT CODE

   447

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

   448

   449

static const ScreenshotFormat _screenshot_formats[] = {

   450

#if defined(WITH_PNG)

   451

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

   452

#endif

   453

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

   454

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

   455

};

   456

   457

void InitializeScreenshotFormats()

   458

{

   459

	int i, j;

   460

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

   461

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

   462

			j = i;

   463

			break;

   464

		}

   465

	_cur_screenshot_format = j;

   466

	_num_screenshot_formats = lengthof(_screenshot_formats);

   467

	current_screenshot_type = SC_NONE;

   468

}

   469

   470

const char *GetScreenshotFormatDesc(int i)

   471

{

   472

	return _screenshot_formats[i].name;

   473

}

   474

   475

void SetScreenshotFormat(int i)

   476

{

   477

	_cur_screenshot_format = i;

   478

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

   479

}

   480

   481

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

   482

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

   483

{

   484

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   485

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

   486

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

   487

}

   488

   489

/* generate a large piece of the world */

   490

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

   491

{

   492

	ViewPort *vp = (ViewPort *)userdata;

   493

	DrawPixelInfo dpi, *old_dpi;

   494

	int wx, left;

   495

   496

	old_dpi = _cur_dpi;

   497

	_cur_dpi = &dpi;