1

/* $Id$ */

     2

     3

/** @file screenshot.cpp The creation of screenshots! */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "fileio.h"

     9

#include "viewport_func.h"

    10

#include "gfx_func.h"

    11

#include "core/math_func.hpp"

    12

#include "screenshot.h"

    13

#include "variables.h"

    14

#include "blitter/factory.hpp"

    15

#include "fileio.h"

    16

#include "strings_func.h"

    17

#include "zoom_func.h"

    18

#include "core/alloc_func.hpp"

    19

#include "core/endian_func.hpp"

    20

#include "map_func.h"

    21

#include "date_func.h"

    22

#include "player_func.h"

    23

    24

#include "table/strings.h"

    25

    26

char _screenshot_format_name[8];

    27

uint _num_screenshot_formats;

    28

uint _cur_screenshot_format;

    29

ScreenshotType current_screenshot_type;

    30

    31

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

    32

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

    33

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

    34

    35

struct ScreenshotFormat {

    36

	const char *name;

    37

	const char *extension;

    38

	ScreenshotHandlerProc *proc;

    39

};

    40

    41

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

    42

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

    43

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

    44

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

    45

#pragma pack(push, 1)

    46

#endif

    47

    48

struct BitmapFileHeader {

    49

	uint16 type;

    50

	uint32 size;

    51

	uint32 reserved;

    52

	uint32 off_bits;

    53

} GCC_PACK;

    54

assert_compile(sizeof(BitmapFileHeader) == 14);

    55

    56

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

    57

#pragma pack(pop)

    58

#endif

    59

    60

struct BitmapInfoHeader {

    61

	uint32 size;

    62

	int32 width, height;

    63

	uint16 planes, bitcount;

    64

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

    65

};

    66

assert_compile(sizeof(BitmapInfoHeader) == 40);

    67

    68

struct RgbQuad {

    69

	byte blue, green, red, reserved;

    70

};

    71

assert_compile(sizeof(RgbQuad) == 4);

    72

    73

/* generic .BMP writer */

    74

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

    75

{

    76

	BitmapFileHeader bfh;

    77

	BitmapInfoHeader bih;

    78

	RgbQuad rq[256];

    79

	FILE *f;

    80

	uint i, padw;

    81

	uint n, maxlines;

    82

	uint pal_size = 0;

    83

	uint bpp = pixelformat / 8;

    84

    85

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

    86

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

    87

    88

	f = fopen(name, "wb");

    89

	if (f == NULL) return false;

    90

    91

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

    92

	padw = Align(w, 4);

    93

    94

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

    95

    96

	/* setup the file header */

    97

	bfh.type = TO_LE16('MB');

    98

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

    99

	bfh.reserved = 0;

   100

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

   101

   102

	/* setup the info header */

   103

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

   104

	bih.width = TO_LE32(w);

   105

	bih.height = TO_LE32(h);

   106

	bih.planes = TO_LE16(1);

   107

	bih.bitcount = TO_LE16(pixelformat);

   108

	bih.compression = 0;

   109

	bih.sizeimage = 0;

   110

	bih.xpels = 0;

   111

	bih.ypels = 0;

   112

	bih.clrused = 0;

   113

	bih.clrimp = 0;

   114

   115

	if (pixelformat == 8) {

   116

		/* convert the palette to the windows format */

   117

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

   118

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

   119

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

   120

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

   121

			rq[i].reserved = 0;

   122

		}

   123

	}

   124

   125

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

   126

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

   127

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

   128

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

   129

   130

	/* use by default 64k temp memory */

   131

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

   132

   133

	/* now generate the bitmap bits */

   134

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

   135

	if (buff == NULL) {

   136

		fclose(f);

   137

		return false;

   138

	}

   139

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

   140

   141

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

   142

	do {

   143

		/* determine # lines */

   144

		n = min(h, maxlines);

   145

		h -= n;

   146

   147

		/* render the pixels */

   148

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

   149

   150

		/* write each line */

   151

		while (n)

   152

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

   153

				free(buff);

   154

				fclose(f);

   155

				return false;

   156

			}

   157

	} while (h != 0);

   158

   159

	free(buff);

   160

	fclose(f);

   161

   162

	return true;

   163

}

   164

   165

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

   166

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

   167

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

   168

#if defined(WITH_PNG)

   169

#include <png.h>

   170

   171

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   172

{

   173

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

   174

	longjmp(png_ptr->jmpbuf, 1);

   175

}

   176

   177

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   178

{

   179

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

   180

}

   181

   182

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

   183

{

   184

	png_color rq[256];

   185

	FILE *f;

   186

	uint i, y, n;

   187

	uint maxlines;

   188

	uint bpp = pixelformat / 8;

   189

	png_structp png_ptr;

   190

	png_infop info_ptr;

   191

   192

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

   193

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

   194

   195

	f = fopen(name, "wb");

   196

	if (f == NULL) return false;

   197

   198

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

   199

   200

	if (png_ptr == NULL) {

   201

		fclose(f);

   202

		return false;

   203

	}

   204

   205

	info_ptr = png_create_info_struct(png_ptr);

   206

	if (info_ptr == NULL) {

   207

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   208

		fclose(f);

   209

		return false;

   210

	}

   211

   212

	if (setjmp(png_jmpbuf(png_ptr))) {

   213

		png_destroy_write_struct(&png_ptr, &info_ptr);

   214

		fclose(f);

   215

		return false;

   216

	}

   217

   218

	png_init_io(png_ptr, f);

   219

   220

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   221

   222

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

   223

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   224

   225

	if (pixelformat == 8) {

   226

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

   227

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

   228

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

   229

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

   230

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

   231

		}

   232

   233

		png_set_PLTE(png_ptr, info_ptr, rq, 256);

   234

	}

   235

   236

	png_write_info(png_ptr, info_ptr);

   237

	png_set_flush(png_ptr, 512);

   238

   239

	if (pixelformat == 32) {

   240

		png_color_8 sig_bit;

   241

   242

		/* Save exact color/alpha resolution */

   243

		sig_bit.alpha = 0;

   244

		sig_bit.blue  = 8;

   245

		sig_bit.green = 8;

   246

		sig_bit.red   = 8;

   247

		sig_bit.gray  = 8;

   248

		png_set_sBIT(png_ptr, info_ptr, &sig_bit);

   249

   250

#if TTD_ENDIAN == TTD_LITTLE_ENDIAN

   251

		png_set_bgr(png_ptr);

   252

		png_set_filler(png_ptr, 0, PNG_FILLER_AFTER);

   253

#else

   254

		png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

   255

#endif /* TTD_ENDIAN == TTD_LITTLE_ENDIAN */

   256

	}

   257

   258

	/* use by default 64k temp memory */

   259

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

   260

   261

	/* now generate the bitmap bits */

   262

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

   263

	if (buff == NULL) {

   264

		png_destroy_write_struct(&png_ptr, &info_ptr);

   265

		fclose(f);

   266

		return false;

   267

	}

   268

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

   269

   270

	y = 0;

   271

	do {

   272

		/* determine # lines to write */

   273

		n = min(h - y, maxlines);

   274

   275

		/* render the pixels into the buffer */

   276

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

   277

		y += n;

   278

   279

		/* write them to png */

   280

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

   281

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

   282

	} while (y != h);

   283

   284

	png_write_end(png_ptr, info_ptr);

   285

	png_destroy_write_struct(&png_ptr, &info_ptr);

   286

   287

	free(buff);

   288

	fclose(f);

   289

	return true;

   290

}

   291

#endif /* WITH_PNG */

   292

   293

   294

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

   295

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

   296

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

   297

   298

struct PcxHeader {

   299

	byte manufacturer;

   300

	byte version;

   301

	byte rle;

   302

	byte bpp;

   303

	uint32 unused;

   304

	uint16 xmax, ymax;

   305

	uint16 hdpi, vdpi;

   306

	byte pal_small[16 * 3];

   307

	byte reserved;

   308

	byte planes;

   309

	uint16 pitch;

   310

	uint16 cpal;

   311

	uint16 width;

   312

	uint16 height;

   313

	byte filler[54];

   314

};

   315

assert_compile(sizeof(PcxHeader) == 128);

   316

   317

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

   318

{

   319

	FILE *f;

   320

	uint maxlines;

   321

	uint y;

   322

	PcxHeader pcx;

   323

	bool success;

   324

   325

	if (pixelformat == 32) {

   326

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

   327

		return false;

   328

	}

   329

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

   330

		return false;

   331

   332

	f = fopen(name, "wb");

   333

	if (f == NULL) return false;

   334

   335

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

   336

   337

	/* setup pcx header */

   338

	pcx.manufacturer = 10;

   339

	pcx.version = 5;

   340

	pcx.rle = 1;

   341

	pcx.bpp = 8;

   342

	pcx.xmax = TO_LE16(w - 1);

   343

	pcx.ymax = TO_LE16(h - 1);

   344

	pcx.hdpi = TO_LE16(320);

   345

	pcx.vdpi = TO_LE16(320);

   346

   347

	pcx.planes = 1;

   348

	pcx.cpal = TO_LE16(1);

   349

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

   350

	pcx.height = TO_LE16(h);

   351

   352

	/* write pcx header */

   353

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

   354

		fclose(f);

   355

		return false;

   356

	}

   357

   358

	/* use by default 64k temp memory */

   359

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

   360

   361

	/* now generate the bitmap bits */

   362

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

   363

	if (buff == NULL) {

   364

		fclose(f);

   365

		return false;

   366

	}

   367

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

   368

   369

	y = 0;

   370

	do {

   371

		/* determine # lines to write */

   372

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

   373

		uint i;

   374

   375

		/* render the pixels into the buffer */

   376

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

   377

		y += n;

   378

   379

		/* write them to pcx */

   380

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

   381

			const uint8 *bufp = buff + i * w;

   382

			byte runchar = bufp[0];

   383

			uint runcount = 1;

   384

			uint j;

   385

   386

			/* for each pixel... */

   387

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

   388

				uint8 ch = bufp[j];

   389

   390

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

   391

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

   392

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

   393

							free(buff);

   394

							fclose(f);

   395

							return false;

   396

						}

   397

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

   398

						free(buff);

   399

						fclose(f);

   400

						return false;

   401

					}

   402

					runcount = 0;

   403

					runchar = ch;

   404

				}

   405

				runcount++;

   406

			}

   407

   408

			/* write remaining bytes.. */

   409

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

   410

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

   411

					free(buff);

   412

					fclose(f);

   413

					return false;

   414

				}

   415

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

   416

				free(buff);

   417

				fclose(f);

   418

				return false;

   419

			}

   420

		}

   421

	} while (y != h);

   422

   423

	free(buff);

   424

   425

	/* write 8-bit color palette */

   426

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

   427

		fclose(f);

   428

		return false;

   429

	}

   430

   431

	/* Palette is word-aligned, copy it to a temporary byte array */

   432

	byte tmp[256 * 3];

   433

   434

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

   435

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

   436

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

   437

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

   438

	}

   439

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

   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

 * @param userdata Viewport area to draw

   492

 * @param buf Videobuffer with same bitdepth as current blitter

   493

 * @param y First line to render

   494

 * @param pitch Pitch of the videobuffer

   495

 * @param n Number of lines to render

   496

 */

   497

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