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