Merge https://codereview.chromium.org/897973002/ and https://codereview.chromium...
[pdfium.git] / samples / pdfium_test.cc
1 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include <limits.h>
6 #include <stdio.h>
7 #include <stdlib.h>
8 #include <string.h>
9 #include <wchar.h>
10
11 #include <list>
12 #include <sstream>
13 #include <string>
14 #include <utility>
15 #include <vector>
16
17 #include "../fpdfsdk/include/fpdf_dataavail.h"
18 #include "../fpdfsdk/include/fpdf_ext.h"
19 #include "../fpdfsdk/include/fpdfformfill.h"
20 #include "../fpdfsdk/include/fpdftext.h"
21 #include "../fpdfsdk/include/fpdfview.h"
22 #include "../core/include/fxcrt/fx_system.h"
23 #include "image_diff_png.h"
24 #include "v8/include/v8.h"
25 #include "v8/include/libplatform/libplatform.h"
26
27
28 #ifdef _WIN32
29 #define snprintf _snprintf
30 #define PATH_SEPARATOR '\\'
31 #else
32 #define PATH_SEPARATOR '/'
33 #endif
34
35 enum OutputFormat {
36   OUTPUT_NONE,
37   OUTPUT_PPM,
38   OUTPUT_PNG,
39 #ifdef _WIN32
40   OUTPUT_BMP,
41   OUTPUT_EMF,
42 #endif
43 };
44
45 struct Options {
46   Options() : output_format(OUTPUT_NONE) { }
47
48   OutputFormat output_format;
49   std::string scale_factor_as_string;
50   std::string exe_path;
51   std::string bin_directory;
52 };
53
54 // Reads the entire contents of a file into a newly malloc'd buffer.
55 static char* GetFileContents(const char* filename, size_t* retlen) {
56   FILE* file = fopen(filename, "rb");
57   if (!file) {
58     fprintf(stderr, "Failed to open: %s\n", filename);
59     return NULL;
60   }
61   (void) fseek(file, 0, SEEK_END);
62   size_t file_length = ftell(file);
63   if (!file_length) {
64     return NULL;
65   }
66   (void) fseek(file, 0, SEEK_SET);
67   char* buffer = (char*) malloc(file_length);
68   if (!buffer) {
69     return NULL;
70   }
71   size_t bytes_read = fread(buffer, 1, file_length, file);
72   (void) fclose(file);
73   if (bytes_read != file_length) {
74     fprintf(stderr, "Failed to read: %s\n", filename);
75     free(buffer);
76     return NULL;
77   }
78   *retlen = bytes_read;
79   return buffer;
80 }
81
82 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
83 // Returns the full path for an external V8 data file based on either
84 // the currect exectuable path or an explicit override.
85 static std::string GetFullPathForSnapshotFile(const Options& options,
86                                               const std::string& filename) {
87   std::string result;
88   if (!options.bin_directory.empty()) {
89     result = options.bin_directory;
90     if (*options.bin_directory.rbegin() != PATH_SEPARATOR) {
91       result += PATH_SEPARATOR;
92     }
93   } else if (!options.exe_path.empty()) {
94     size_t last_separator = options.exe_path.rfind(PATH_SEPARATOR);
95     if (last_separator != std::string::npos)  {
96       result = options.exe_path.substr(0, last_separator + 1);
97     }
98   }
99   result += filename;
100   return result;
101 }
102
103 // Reads an extenal V8 data file from the |options|-indicated location,
104 // returing true on success and false on error.
105 static bool GetExternalData(const Options& options,
106                             const std::string& bin_filename,
107                             v8::StartupData* result_data) {
108   std::string full_path = GetFullPathForSnapshotFile(options, bin_filename);
109   size_t data_length = 0;
110   char* data_buffer = GetFileContents(full_path.c_str(), &data_length);
111   if (!data_buffer) {
112     return false;
113   }
114   result_data->data = const_cast<const char*>(data_buffer);
115   result_data->raw_size = data_length;
116   return true;
117 }
118 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
119
120 static bool CheckDimensions(int stride, int width, int height) {
121   if (stride < 0 || width < 0 || height < 0)
122     return false;
123   if (height > 0 && width > INT_MAX / height)
124     return false;
125   return true;
126 }
127
128 static void WritePpm(const char* pdf_name, int num, const void* buffer_void,
129                      int stride, int width, int height) {
130   const char* buffer = reinterpret_cast<const char*>(buffer_void);
131
132   if (!CheckDimensions(stride, width, height))
133     return;
134
135   int out_len = width * height;
136   if (out_len > INT_MAX / 3)
137     return;
138   out_len *= 3;
139
140   char filename[256];
141   snprintf(filename, sizeof(filename), "%s.%d.ppm", pdf_name, num);
142   FILE* fp = fopen(filename, "wb");
143   if (!fp)
144     return;
145   fprintf(fp, "P6\n# PDF test render\n%d %d\n255\n", width, height);
146   // Source data is B, G, R, unused.
147   // Dest data is R, G, B.
148   char* result = new char[out_len];
149   if (result) {
150     for (int h = 0; h < height; ++h) {
151       const char* src_line = buffer + (stride * h);
152       char* dest_line = result + (width * h * 3);
153       for (int w = 0; w < width; ++w) {
154         // R
155         dest_line[w * 3] = src_line[(w * 4) + 2];
156         // G
157         dest_line[(w * 3) + 1] = src_line[(w * 4) + 1];
158         // B
159         dest_line[(w * 3) + 2] = src_line[w * 4];
160       }
161     }
162     fwrite(result, out_len, 1, fp);
163     delete [] result;
164   }
165   fclose(fp);
166 }
167
168 static void WritePng(const char* pdf_name, int num, const void* buffer_void,
169                      int stride, int width, int height) {
170   if (!CheckDimensions(stride, width, height))
171     return;
172
173   std::vector<unsigned char> png_encoding;
174   const unsigned char* buffer = static_cast<const unsigned char*>(buffer_void);
175   if (!image_diff_png::EncodeBGRAPNG(
176           buffer, width, height, stride, false, &png_encoding)) {
177     fprintf(stderr, "Failed to convert bitmap to PNG\n");
178     return;
179   }
180
181   char filename[256];
182   int chars_formatted = snprintf(
183       filename, sizeof(filename), "%s.%d.png", pdf_name, num);
184   if (chars_formatted < 0 ||
185       static_cast<size_t>(chars_formatted) >= sizeof(filename)) {
186     fprintf(stderr, "Filname %s is too long\n", filename);
187     return;
188   }
189
190   FILE* fp = fopen(filename, "wb");
191   if (!fp) {
192     fprintf(stderr, "Failed to open %s for output\n", filename);
193     return;
194   }
195
196   size_t bytes_written = fwrite(
197       &png_encoding.front(), 1, png_encoding.size(), fp);
198   if (bytes_written != png_encoding.size())
199     fprintf(stderr, "Failed to write to  %s\n", filename);
200
201   (void) fclose(fp);
202 }
203
204 #ifdef _WIN32
205 static void WriteBmp(const char* pdf_name, int num, const void* buffer,
206                      int stride, int width, int height) {
207   if (!CheckDimensions(stride, width, height))
208     return;
209
210   int out_len = stride * height;
211   if (out_len > INT_MAX / 3)
212     return;
213
214   char filename[256];
215   snprintf(filename, sizeof(filename), "%s.%d.bmp", pdf_name, num);
216   FILE* fp = fopen(filename, "wb");
217   if (!fp)
218     return;
219
220   BITMAPINFO bmi = {0};
221   bmi.bmiHeader.biSize = sizeof(bmi) - sizeof(RGBQUAD);
222   bmi.bmiHeader.biWidth = width;
223   bmi.bmiHeader.biHeight = -height;  // top-down image
224   bmi.bmiHeader.biPlanes = 1;
225   bmi.bmiHeader.biBitCount = 32;
226   bmi.bmiHeader.biCompression = BI_RGB;
227   bmi.bmiHeader.biSizeImage = 0;
228
229   BITMAPFILEHEADER file_header = {0};
230   file_header.bfType = 0x4d42;
231   file_header.bfSize = sizeof(file_header) + bmi.bmiHeader.biSize + out_len;
232   file_header.bfOffBits = file_header.bfSize - out_len;
233
234   fwrite(&file_header, sizeof(file_header), 1, fp);
235   fwrite(&bmi, bmi.bmiHeader.biSize, 1, fp);
236   fwrite(buffer, out_len, 1, fp);
237   fclose(fp);
238 }
239
240 void WriteEmf(FPDF_PAGE page, const char* pdf_name, int num) {
241   int width = static_cast<int>(FPDF_GetPageWidth(page));
242   int height = static_cast<int>(FPDF_GetPageHeight(page));
243
244   char filename[256];
245   snprintf(filename, sizeof(filename), "%s.%d.emf", pdf_name, num);
246
247   HDC dc = CreateEnhMetaFileA(NULL, filename, NULL, NULL);
248
249   HRGN rgn = CreateRectRgn(0, 0, width, height);
250   SelectClipRgn(dc, rgn);
251   DeleteObject(rgn);
252
253   SelectObject(dc, GetStockObject(NULL_PEN));
254   SelectObject(dc, GetStockObject(WHITE_BRUSH));
255   // If a PS_NULL pen is used, the dimensions of the rectangle are 1 pixel less.
256   Rectangle(dc, 0, 0, width + 1, height + 1);
257
258   FPDF_RenderPage(dc, page, 0, 0, width, height, 0,
259                   FPDF_ANNOT | FPDF_PRINTING | FPDF_NO_CATCH);
260
261   DeleteEnhMetaFile(CloseEnhMetaFile(dc));
262 }
263 #endif
264
265 int Form_Alert(IPDF_JSPLATFORM*, FPDF_WIDESTRING msg, FPDF_WIDESTRING,
266                int, int) {
267   // Deal with differences between UTF16LE and wchar_t on this platform.
268   size_t characters = 0;
269   while (msg[characters]) {
270     ++characters;
271   }
272   wchar_t* platform_string =
273       (wchar_t*)malloc((characters + 1) * sizeof(wchar_t));
274   for (size_t i = 0; i < characters + 1; ++i) {
275     unsigned char* ptr = (unsigned char*)&msg[i];
276     platform_string[i] = ptr[0] + 256 * ptr[1];
277   }
278   printf("Alert: %ls\n", platform_string);
279   free(platform_string);
280   return 0;
281 }
282
283 void Unsupported_Handler(UNSUPPORT_INFO*, int type) {
284   std::string feature = "Unknown";
285   switch (type) {
286     case FPDF_UNSP_DOC_XFAFORM:
287       feature = "XFA";
288       break;
289     case FPDF_UNSP_DOC_PORTABLECOLLECTION:
290       feature = "Portfolios_Packages";
291       break;
292     case FPDF_UNSP_DOC_ATTACHMENT:
293     case FPDF_UNSP_ANNOT_ATTACHMENT:
294       feature = "Attachment";
295       break;
296     case FPDF_UNSP_DOC_SECURITY:
297       feature = "Rights_Management";
298       break;
299     case FPDF_UNSP_DOC_SHAREDREVIEW:
300       feature = "Shared_Review";
301       break;
302     case FPDF_UNSP_DOC_SHAREDFORM_ACROBAT:
303     case FPDF_UNSP_DOC_SHAREDFORM_FILESYSTEM:
304     case FPDF_UNSP_DOC_SHAREDFORM_EMAIL:
305       feature = "Shared_Form";
306       break;
307     case FPDF_UNSP_ANNOT_3DANNOT:
308       feature = "3D";
309       break;
310     case FPDF_UNSP_ANNOT_MOVIE:
311       feature = "Movie";
312       break;
313     case FPDF_UNSP_ANNOT_SOUND:
314       feature = "Sound";
315       break;
316     case FPDF_UNSP_ANNOT_SCREEN_MEDIA:
317     case FPDF_UNSP_ANNOT_SCREEN_RICHMEDIA:
318       feature = "Screen";
319       break;
320     case FPDF_UNSP_ANNOT_SIG:
321       feature = "Digital_Signature";
322       break;
323   }
324   printf("Unsupported feature: %s.\n", feature.c_str());
325 }
326
327 bool ParseCommandLine(const std::vector<std::string>& args,
328                       Options* options, std::list<std::string>* files) {
329   if (args.empty()) {
330     return false;
331   }
332   options->exe_path = args[0];
333   size_t cur_idx = 1;
334   for (; cur_idx < args.size(); ++cur_idx) {
335     const std::string& cur_arg = args[cur_idx];
336     if (cur_arg == "--ppm") {
337       if (options->output_format != OUTPUT_NONE) {
338         fprintf(stderr, "Duplicate or conflicting --ppm argument\n");
339         return false;
340       }
341       options->output_format = OUTPUT_PPM;
342     } else if (cur_arg == "--png") {
343       if (options->output_format != OUTPUT_NONE) {
344         fprintf(stderr, "Duplicate or conflicting --png argument\n");
345         return false;
346       }
347       options->output_format = OUTPUT_PNG;
348     }
349 #ifdef _WIN32
350     else if (cur_arg == "--emf") {
351       if (options->output_format != OUTPUT_NONE) {
352         fprintf(stderr, "Duplicate or conflicting --emf argument\n");
353         return false;
354       }
355       options->output_format = OUTPUT_EMF;
356     }
357     else if (cur_arg == "--bmp") {
358       if (options->output_format != OUTPUT_NONE) {
359         fprintf(stderr, "Duplicate or conflicting --bmp argument\n");
360         return false;
361       }
362       options->output_format = OUTPUT_BMP;
363     }
364 #endif  // _WIN32
365 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
366     else if (cur_arg.size() > 10 && cur_arg.compare(0, 10, "--bin-dir=") == 0) {
367       if (!options->bin_directory.empty()) {
368         fprintf(stderr, "Duplicate --bin-dir argument\n");
369         return false;
370       }
371       options->bin_directory = cur_arg.substr(10);
372     }
373 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
374     else if (cur_arg.size() > 8 && cur_arg.compare(0, 8, "--scale=") == 0) {
375       if (!options->scale_factor_as_string.empty()) {
376         fprintf(stderr, "Duplicate --scale argument\n");
377         return false;
378       }
379       options->scale_factor_as_string = cur_arg.substr(8);
380     }
381     else
382       break;
383   }
384   if (cur_idx >= args.size()) {
385     fprintf(stderr, "No input files.\n");
386     return false;
387   }
388   for (size_t i = cur_idx; i < args.size(); i++) {
389     files->push_back(args[i]);
390   }
391   return true;
392 }
393
394 class TestLoader {
395  public:
396   TestLoader(const char* pBuf, size_t len);
397
398   const char* m_pBuf;
399   size_t m_Len;
400 };
401
402 TestLoader::TestLoader(const char* pBuf, size_t len)
403     : m_pBuf(pBuf), m_Len(len) {
404 }
405
406 int Get_Block(void* param, unsigned long pos, unsigned char* pBuf,
407               unsigned long size) {
408   TestLoader* pLoader = (TestLoader*) param;
409   if (pos + size < pos || pos + size > pLoader->m_Len) return 0;
410   memcpy(pBuf, pLoader->m_pBuf + pos, size);
411   return 1;
412 }
413
414 bool Is_Data_Avail(FX_FILEAVAIL* pThis, size_t offset, size_t size) {
415   return true;
416 }
417
418 void Add_Segment(FX_DOWNLOADHINTS* pThis, size_t offset, size_t size) {
419 }
420
421 void RenderPdf(const std::string& name, const char* pBuf, size_t len,
422                const Options& options) {
423   fprintf(stderr, "Rendering PDF file %s.\n", name.c_str());
424
425   IPDF_JSPLATFORM platform_callbacks;
426   memset(&platform_callbacks, '\0', sizeof(platform_callbacks));
427   platform_callbacks.version = 1;
428   platform_callbacks.app_alert = Form_Alert;
429
430   FPDF_FORMFILLINFO form_callbacks;
431   memset(&form_callbacks, '\0', sizeof(form_callbacks));
432   form_callbacks.version = 2;
433   form_callbacks.m_pJsPlatform = &platform_callbacks;
434
435   TestLoader loader(pBuf, len);
436
437   FPDF_FILEACCESS file_access;
438   memset(&file_access, '\0', sizeof(file_access));
439   file_access.m_FileLen = static_cast<unsigned long>(len);
440   file_access.m_GetBlock = Get_Block;
441   file_access.m_Param = &loader;
442
443   FX_FILEAVAIL file_avail;
444   memset(&file_avail, '\0', sizeof(file_avail));
445   file_avail.version = 1;
446   file_avail.IsDataAvail = Is_Data_Avail;
447
448   FX_DOWNLOADHINTS hints;
449   memset(&hints, '\0', sizeof(hints));
450   hints.version = 1;
451   hints.AddSegment = Add_Segment;
452
453   FPDF_DOCUMENT doc;
454   FPDF_AVAIL pdf_avail = FPDFAvail_Create(&file_avail, &file_access);
455
456   (void) FPDFAvail_IsDocAvail(pdf_avail, &hints);
457
458   if (!FPDFAvail_IsLinearized(pdf_avail)) {
459     fprintf(stderr, "Non-linearized path...\n");
460     doc = FPDF_LoadCustomDocument(&file_access, NULL);
461   } else {
462     fprintf(stderr, "Linearized path...\n");
463     doc = FPDFAvail_GetDocument(pdf_avail, NULL);
464   }
465
466   (void) FPDF_GetDocPermissions(doc);
467   (void) FPDFAvail_IsFormAvail(pdf_avail, &hints);
468
469   FPDF_FORMHANDLE form = FPDFDOC_InitFormFillEnvironment(doc, &form_callbacks);
470   if (!FPDF_LoadXFA(doc)) {
471     printf("LoadXFA unsuccessful, continuing anyway.\n");
472   }
473   FPDF_SetFormFieldHighlightColor(form, 0, 0xFFE4DD);
474   FPDF_SetFormFieldHighlightAlpha(form, 100);
475
476   int first_page = FPDFAvail_GetFirstPageNum(doc);
477   (void) FPDFAvail_IsPageAvail(pdf_avail, first_page, &hints);
478
479   int page_count = FPDF_GetPageCount(doc);
480   for (int i = 0; i < page_count; ++i) {
481     (void) FPDFAvail_IsPageAvail(pdf_avail, i, &hints);
482   }
483
484   FORM_DoDocumentJSAction(form);
485   FORM_DoDocumentOpenAction(form);
486
487   size_t rendered_pages = 0;
488   size_t bad_pages = 0;
489   for (int i = 0; i < page_count; ++i) {
490     FPDF_PAGE page = FPDF_LoadPage(doc, i);
491     if (!page) {
492         bad_pages ++;
493         continue;
494     }
495     FPDF_TEXTPAGE text_page = FPDFText_LoadPage(page);
496     FORM_OnAfterLoadPage(page, form);
497     FORM_DoPageAAction(page, form, FPDFPAGE_AACTION_OPEN);
498
499     int width = static_cast<int>(FPDF_GetPageWidth(page));
500     int height = static_cast<int>(FPDF_GetPageHeight(page));
501     if (!options.scale_factor_as_string.empty()) {
502       double scale = 1.0;
503       std::stringstream(options.scale_factor_as_string) >> scale;
504       width *= scale;
505       height *= scale;
506     }
507
508     FPDF_BITMAP bitmap = FPDFBitmap_Create(width, height, 0);
509     FPDFBitmap_FillRect(bitmap, 0, 0, width, height, 0xFFFFFFFF);
510     FPDF_RenderPageBitmap(bitmap, page, 0, 0, width, height, 0, 0);
511     rendered_pages ++;
512
513     FPDF_FFLDraw(form, bitmap, page, 0, 0, width, height, 0, 0);
514     int stride = FPDFBitmap_GetStride(bitmap);
515     const char* buffer =
516         reinterpret_cast<const char*>(FPDFBitmap_GetBuffer(bitmap));
517
518     switch (options.output_format) {
519 #ifdef _WIN32
520       case OUTPUT_BMP:
521         WriteBmp(name.c_str(), i, buffer, stride, width, height);
522         break;
523
524       case OUTPUT_EMF:
525         WriteEmf(page, name.c_str(), i);
526         break;
527 #endif
528       case OUTPUT_PPM:
529         WritePpm(name.c_str(), i, buffer, stride, width, height);
530         break;
531
532       case OUTPUT_PNG:
533         WritePng(name.c_str(), i, buffer, stride, width, height);
534         break;
535
536       default:
537         break;
538     }
539
540     FPDFBitmap_Destroy(bitmap);
541
542     FORM_DoPageAAction(page, form, FPDFPAGE_AACTION_CLOSE);
543     FORM_OnBeforeClosePage(page, form);
544     FPDFText_ClosePage(text_page);
545     FPDF_ClosePage(page);
546   }
547
548   FORM_DoDocumentAAction(form, FPDFDOC_AACTION_WC);
549   FPDF_CloseDocument(doc);
550   FPDFDOC_ExitFormFillEnvironment(form);
551   FPDFAvail_Destroy(pdf_avail);
552
553   fprintf(stderr, "Rendered %" PRIuS " pages.\n", rendered_pages);
554   fprintf(stderr, "Skipped %" PRIuS " bad pages.\n", bad_pages);
555 }
556
557 static const char usage_string[] =
558     "Usage: pdfium_test [OPTION] [FILE]...\n"
559     "  --bin-dir=<path> - override path to v8 external data\n"
560     "  --scale=<number> - scale output size by number (e.g. 0.5)\n"
561 #ifdef _WIN32
562     "  --bmp - write page images <pdf-name>.<page-number>.bmp\n"
563     "  --emf - write page meta files <pdf-name>.<page-number>.emf\n"
564 #endif
565     "  --png - write page images <pdf-name>.<page-number>.png\n"
566     "  --ppm - write page images <pdf-name>.<page-number>.ppm\n";
567
568 int main(int argc, const char* argv[]) {
569   std::vector<std::string> args(argv, argv + argc);
570   Options options;
571   std::list<std::string> files;
572   if (!ParseCommandLine(args, &options, &files)) {
573     fprintf(stderr, "%s", usage_string);
574     return 1;
575   }
576
577   v8::V8::InitializeICU();
578   v8::Platform* platform = v8::platform::CreateDefaultPlatform();
579   v8::V8::InitializePlatform(platform);
580   v8::V8::Initialize();
581
582 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
583   v8::StartupData natives;
584   v8::StartupData snapshot;
585   if (!GetExternalData(options, "natives_blob.bin", &natives) ||
586       !GetExternalData(options, "snapshot_blob.bin", &snapshot)) {
587     return 1;
588   }
589   v8::V8::SetNativesDataBlob(&natives);
590   v8::V8::SetSnapshotDataBlob(&snapshot);
591 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
592
593   FPDF_InitLibrary();
594
595   UNSUPPORT_INFO unsuppored_info;
596   memset(&unsuppored_info, '\0', sizeof(unsuppored_info));
597   unsuppored_info.version = 1;
598   unsuppored_info.FSDK_UnSupport_Handler = Unsupported_Handler;
599
600   FSDK_SetUnSpObjProcessHandler(&unsuppored_info);
601
602   while (!files.empty()) {
603     std::string filename = files.front();
604     files.pop_front();
605     size_t file_length = 0;
606     char* file_contents = GetFileContents(filename.c_str(), &file_length);
607     if (!file_contents)
608       continue;
609     RenderPdf(filename, file_contents, file_length, options);
610     free(file_contents);
611   }
612
613   FPDF_DestroyLibrary();
614   v8::V8::ShutdownPlatform();
615   delete platform;
616
617   return 0;
618 }