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_func.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 "strings_func.h"

    16

#include "zoom_func.h"

    17

#include "core/alloc_func.hpp"

    18

#include "core/endian_func.hpp"

    19

#include "map_func.h"

    20

#include "date_func.h"

    21

#include "company_func.h"

    22

    23

#include "table/strings.h"

    24

    25

char _screenshot_format_name[8];

    26

uint _num_screenshot_formats;

    27

uint _cur_screenshot_format;

    28

ScreenshotType current_screenshot_type;

    29

    30

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

    31

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

    32

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

    33

    34

struct ScreenshotFormat {

    35

	const char *name;

    36

	const char *extension;

    37

	ScreenshotHandlerProc *proc;

    38

};

    39

    40

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

    41

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

    42

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

    43

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

    44

#pragma pack(push, 1)

    45

#endif

    46

    47

struct BitmapFileHeader {

    48

	uint16 type;

    49

	uint32 size;

    50

	uint32 reserved;

    51

	uint32 off_bits;

    52

} GCC_PACK;

    53

assert_compile(sizeof(BitmapFileHeader) == 14);

    54

    55

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

    56

#pragma pack(pop)

    57

#endif

    58

    59

struct BitmapInfoHeader {

    60

	uint32 size;

    61

	int32 width, height;

    62

	uint16 planes, bitcount;

    63

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

    64

};

    65

assert_compile(sizeof(BitmapInfoHeader) == 40);

    66

    67

struct RgbQuad {

    68

	byte blue, green, red, reserved;

    69

};

    70

assert_compile(sizeof(RgbQuad) == 4);

    71

    72

/* generic .BMP writer */

    73

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

    74

{

    75

	BitmapFileHeader bfh;

    76

	BitmapInfoHeader bih;

    77

	RgbQuad rq[256];

    78

	FILE *f;

    79

	uint i, padw;

    80

	uint n, maxlines;

    81

	uint pal_size = 0;

    82

	uint bpp = pixelformat / 8;

    83

    84

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

    85

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

    86

    87

	f = fopen(name, "wb");

    88

	if (f == NULL) return false;

    89

    90

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

    91

	padw = Align(w, 4);

    92

    93

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

    94

    95

	/* setup the file header */

    96

	bfh.type = TO_LE16('MB');

    97

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

    98

	bfh.reserved = 0;

    99

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

   100

   101

	/* setup the info header */

   102

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

   103

	bih.width = TO_LE32(w);

   104

	bih.height = TO_LE32(h);

   105

	bih.planes = TO_LE16(1);

   106

	bih.bitcount = TO_LE16(pixelformat);

   107

	bih.compression = 0;

   108

	bih.sizeimage = 0;

   109

	bih.xpels = 0;

   110

	bih.ypels = 0;

   111

	bih.clrused = 0;

   112

	bih.clrimp = 0;

   113

   114

	if (pixelformat == 8) {

   115

		/* convert the palette to the windows format */

   116

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

   117

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

   118

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

   119

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

   120

			rq[i].reserved = 0;

   121

		}

   122

	}

   123

   124

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

   125

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

   126

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

   127

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

   128

   129

	/* use by default 64k temp memory */

   130

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

   131

   132

	/* now generate the bitmap bits */

   133

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

   134

	if (buff == NULL) {

   135

		fclose(f);

   136

		return false;

   137

	}

   138

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

   139

   140

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

   141

	do {

   142

		/* determine # lines */

   143

		n = min(h, maxlines);

   144

		h -= n;

   145

   146

		/* render the pixels */

   147

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

   148

   149

		/* write each line */

   150

		while (n)

   151

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

   152

				free(buff);

   153

				fclose(f);

   154

				return false;

   155

			}

   156

	} while (h != 0);

   157

   158

	free(buff);

   159

	fclose(f);

   160

   161

	return true;

   162

}

   163

   164

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

   165

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

   166

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

   167

#if defined(WITH_PNG)

   168

#include <png.h>

   169

   170

static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)

   171

{

   172

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

   173

	longjmp(png_ptr->jmpbuf, 1);

   174

}

   175

   176

static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)

   177

{

   178

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

   179

}

   180

   181

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

   182

{

   183

	png_color rq[256];

   184

	FILE *f;

   185

	uint i, y, n;

   186

	uint maxlines;

   187

	uint bpp = pixelformat / 8;

   188

	png_structp png_ptr;

   189

	png_infop info_ptr;

   190

   191

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

   192

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

   193

   194

	f = fopen(name, "wb");

   195

	if (f == NULL) return false;

   196

   197

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

   198

   199

	if (png_ptr == NULL) {

   200

		fclose(f);

   201

		return false;

   202

	}

   203

   204

	info_ptr = png_create_info_struct(png_ptr);

   205

	if (info_ptr == NULL) {

   206

		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);

   207

		fclose(f);

   208

		return false;

   209

	}

   210

   211

	if (setjmp(png_jmpbuf(png_ptr))) {

   212

		png_destroy_write_struct(&png_ptr, &info_ptr);

   213

		fclose(f);

   214

		return false;

   215

	}

   216

   217

	png_init_io(png_ptr, f);

   218

   219

	png_set_filter(png_ptr, 0, PNG_FILTER_NONE);

   220

   221

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

   222

		PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

   223

   224

	if (pixelformat == 8) {

   225

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

   226

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

   227

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

   228

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

   229

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

   230

		}

   231

   232

		png_set_PLTE(png_ptr, info_ptr, rq, 256);

   233

	}

   234

   235

	png_write_info(png_ptr, info_ptr);

   236

	png_set_flush(png_ptr, 512);

   237

   238

	if (pixelformat == 32) {

   239

		png_color_8 sig_bit;

   240

   241

		/* Save exact color/alpha resolution */

   242

		sig_bit.alpha = 0;

   243

		sig_bit.blue  = 8;

   244

		sig_bit.green = 8;

   245

		sig_bit.red   = 8;

   246

		sig_bit.gray  = 8;

   247

		png_set_sBIT(png_ptr, info_ptr, &sig_bit);

   248

   249

#if TTD_ENDIAN == TTD_LITTLE_ENDIAN

   250

		png_set_bgr(png_ptr);

   251

		png_set_filler(png_ptr, 0, PNG_FILLER_AFTER);

   252

#else

   253

		png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

   254

#endif /* TTD_ENDIAN == TTD_LITTLE_ENDIAN */

   255

	}

   256

   257

	/* use by default 64k temp memory */

   258

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

   259

   260

	/* now generate the bitmap bits */

   261

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

   262

	if (buff == NULL) {

   263

		png_destroy_write_struct(&png_ptr, &info_ptr);

   264

		fclose(f);

   265

		return false;

   266

	}

   267

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

   268

   269

	y = 0;

   270

	do {

   271

		/* determine # lines to write */

   272

		n = min(h - y, maxlines);

   273

   274

		/* render the pixels into the buffer */

   275

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

   276

		y += n;

   277

   278

		/* write them to png */

   279

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

   280

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

   281

	} while (y != h);

   282

   283

	png_write_end(png_ptr, info_ptr);

   284

	png_destroy_write_struct(&png_ptr, &info_ptr);

   285

   286

	free(buff);

   287

	fclose(f);

   288

	return true;

   289

}

   290

#endif /* WITH_PNG */

   291

   292

   293

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

   294

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

   295

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

   296

   297

struct PcxHeader {

   298

	byte manufacturer;

   299

	byte version;

   300

	byte rle;

   301

	byte bpp;

   302

	uint32 unused;

   303

	uint16 xmax, ymax;

   304

	uint16 hdpi, vdpi;

   305

	byte pal_small[16 * 3];

   306

	byte reserved;

   307

	byte planes;

   308

	uint16 pitch;

   309

	uint16 cpal;

   310

	uint16 width;

   311

	uint16 height;

   312

	byte filler[54];

   313

};

   314

assert_compile(sizeof(PcxHeader) == 128);

   315

   316

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

   317

{

   318

	FILE *f;

   319

	uint maxlines;

   320

	uint y;

   321

	PcxHeader pcx;

   322

	bool success;

   323

   324

	if (pixelformat == 32) {

   325

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

   326

		return false;

   327

	}

   328

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

   329

		return false;

   330

   331

	f = fopen(name, "wb");

   332

	if (f == NULL) return false;

   333

   334

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

   335

   336

	/* setup pcx header */

   337

	pcx.manufacturer = 10;

   338

	pcx.version = 5;

   339

	pcx.rle = 1;

   340

	pcx.bpp = 8;

   341

	pcx.xmax = TO_LE16(w - 1);

   342

	pcx.ymax = TO_LE16(h - 1);

   343

	pcx.hdpi = TO_LE16(320);

   344

	pcx.vdpi = TO_LE16(320);

   345

   346

	pcx.planes = 1;

   347

	pcx.cpal = TO_LE16(1);

   348

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

   349

	pcx.height = TO_LE16(h);

   350

   351

	/* write pcx header */

   352

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

   353

		fclose(f);

   354

		return false;

   355

	}

   356

   357

	/* use by default 64k temp memory */

   358

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

   359

   360

	/* now generate the bitmap bits */

   361

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

   362

	if (buff == NULL) {

   363

		fclose(f);

   364

		return false;

   365

	}

   366

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

   367

   368

	y = 0;

   369

	do {

   370

		/* determine # lines to write */

   371

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

   372

		uint i;

   373

   374

		/* render the pixels into the buffer */

   375

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

   376

		y += n;

   377

   378

		/* write them to pcx */

   379

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

   380

			const uint8 *bufp = buff + i * w;

   381

			byte runchar = bufp[0];

   382

			uint runcount = 1;

   383

			uint j;

   384

   385

			/* for each pixel... */

   386

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

   387

				uint8 ch = bufp[j];

   388

   389

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

   390

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

   391

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

   392

							free(buff);

   393

							fclose(f);

   394

							return false;

   395

						}

   396

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

   397

						free(buff);

   398

						fclose(f);

   399

						return false;

   400

					}

   401

					runcount = 0;

   402

					runchar = ch;

   403

				}

   404

				runcount++;

   405

			}

   406

   407

			/* write remaining bytes.. */

   408

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

   409

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

   410

					free(buff);

   411

					fclose(f);

   412

					return false;

   413

				}

   414

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

   415

				free(buff);

   416

				fclose(f);

   417

				return false;

   418

			}

   419

		}

   420

	} while (y != h);

   421

   422

	free(buff);

   423

   424

	/* write 8-bit color palette */

   425

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

   426

		fclose(f);

   427

		return false;

   428

	}

   429

   430

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

   431

	byte tmp[256 * 3];

   432

   433

	for (uint 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

	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

 * @param userdata Viewport area to draw

   491

 * @param buf Videobuffer with same bitdepth as current blitter

   492

 * @param y First line to render

   493

 * @param pitch Pitch of the videobuffer

   494

 * @param n Number of lines to render

   495

 */

   496

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

   497

{