printing/pdf_metafile_skia.cc

   1 // Copyright (c) 2012 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 "printing/pdf_metafile_skia.h"
   6
   7 #include "base/containers/hash_tables.h"
   8 #include "base/files/file_util.h"
   9 #include "base/metrics/histogram.h"
  10 #include "base/numerics/safe_conversions.h"
  11 #include "base/posix/eintr_wrapper.h"
  12 #include "skia/ext/refptr.h"
  13 #include "third_party/skia/include/core/SkData.h"
  14 #include "third_party/skia/include/core/SkDocument.h"
  15 #include "third_party/skia/include/core/SkPictureRecorder.h"
  16 #include "third_party/skia/include/core/SkRect.h"
  17 #include "third_party/skia/include/core/SkRefCnt.h"
  18 #include "third_party/skia/include/core/SkScalar.h"
  19 #include "third_party/skia/include/core/SkSize.h"
  20 #include "third_party/skia/include/core/SkStream.h"
  21 #include "ui/gfx/geometry/point.h"
  22 #include "ui/gfx/geometry/rect.h"
  23 #include "ui/gfx/geometry/size.h"
  24 #include "ui/gfx/geometry/size_conversions.h"
  25 #include "ui/gfx/skia_util.h"
  26
  27 #if defined(OS_MACOSX)
  28 #include "printing/pdf_metafile_cg_mac.h"
  29 #endif
  30
  31 #if defined(OS_POSIX)
  32 #include "base/file_descriptor_posix.h"
  33 #endif
  34
  35 namespace {
  36 // This struct represents all the data we need to draw and redraw this
  37 // page into a SkDocument.
  38 struct Page {
  39   Page(const SkSize& page_size, const SkRect& content_area, float scale)
  40       : page_size_(page_size),
  41         content_area_(content_area),
  42         scale_factor_(scale),
  43         content_(/*NULL*/) {}
  44   SkSize page_size_;
  45   SkRect content_area_;
  46   float scale_factor_;
  47   skia::RefPtr<SkPicture> content_;
  48 };
  49 }  // namespace
  50
  51 static bool WriteAssetToBuffer(const SkStreamAsset* asset,
  52                                void* buffer,
  53                                size_t size) {
  54   // Calling duplicate() keeps original asset state unchanged.
  55   scoped_ptr<SkStreamAsset> assetCopy(asset->duplicate());
  56   size_t length = assetCopy->getLength();
  57   if (length > size)
  58     return false;
  59   return (length == assetCopy->read(buffer, length));
  60 }
  61
  62 namespace printing {
  63
  64 struct PdfMetafileSkiaData {
  65   SkPictureRecorder recorder_;  // Current recording
  66
  67   std::vector<Page> pages_;
  68   scoped_ptr<SkStreamAsset> pdf_data_;
  69
  70 #if defined(OS_MACOSX)
  71   PdfMetafileCg pdf_cg_;
  72 #endif
  73 };
  74
  75 PdfMetafileSkia::~PdfMetafileSkia() {}
  76
  77 bool PdfMetafileSkia::Init() {
  78   return true;
  79 }
  80
  81 // TODO(halcanary): Create a Metafile class that only stores data.
  82 // Metafile::InitFromData is orthogonal to what the rest of
  83 // PdfMetafileSkia does.
  84 bool PdfMetafileSkia::InitFromData(const void* src_buffer,
  85                                    uint32 src_buffer_size) {
  86   data_->pdf_data_.reset(new SkMemoryStream(src_buffer, src_buffer_size, true));
  87   return true;
  88 }
  89
  90 bool PdfMetafileSkia::StartPage(const gfx::Size& page_size,
  91                                 const gfx::Rect& content_area,
  92                                 const float& scale_factor) {
  93   if (data_->recorder_.getRecordingCanvas())
  94     this->FinishPage();
  95   DCHECK(!data_->recorder_.getRecordingCanvas());
  96   SkSize sk_page_size = gfx::SizeFToSkSize(gfx::SizeF(page_size));
  97   data_->pages_.push_back(
  98       Page(sk_page_size, gfx::RectToSkRect(content_area), scale_factor));
  99   DCHECK_GT(scale_factor, 0.0f);
 100   // We scale the recording canvas's size so that
 101   // canvas->getTotalMatrix() returns a value that ignores the scale
 102   // factor.  We store the scale factor and re-apply it to the PDF
 103   // Canvas later.  http://crbug.com/469656
 104   // Recording canvas is owned by the data_->recorder_.  No ref() necessary.
 105   return !!data_->recorder_.beginRecording(sk_page_size.width() / scale_factor,
 106                                            sk_page_size.height() / scale_factor,
 107                                            NULL, 0);
 108 }
 109
 110 skia::PlatformCanvas* PdfMetafileSkia::GetVectorCanvasForNewPage(
 111     const gfx::Size& page_size,
 112     const gfx::Rect& content_area,
 113     const float& scale_factor) {
 114   if (!StartPage(page_size, content_area, scale_factor))
 115     return nullptr;
 116   return data_->recorder_.getRecordingCanvas();
 117 }
 118
 119 bool PdfMetafileSkia::FinishPage() {
 120   if (!data_->recorder_.getRecordingCanvas())
 121     return false;
 122   DCHECK(!(data_->pages_.back().content_));
 123   data_->pages_.back().content_ =
 124       skia::AdoptRef(data_->recorder_.endRecordingAsPicture());
 125   return true;
 126 }
 127
 128 bool PdfMetafileSkia::FinishDocument() {
 129   // If we've already set the data in InitFromData, leave it be.
 130   if (data_->pdf_data_)
 131     return false;
 132
 133   if (data_->recorder_.getRecordingCanvas())
 134     this->FinishPage();
 135
 136   SkDynamicMemoryWStream pdf_stream;
 137   skia::RefPtr<SkDocument> pdf_doc =
 138       skia::AdoptRef(SkDocument::CreatePDF(&pdf_stream));
 139   for (const auto& page : data_->pages_) {
 140     SkCanvas* canvas = pdf_doc->beginPage(
 141         page.page_size_.width(), page.page_size_.height(), &page.content_area_);
 142     // No need to save/restore, since this canvas is not reused after endPage()
 143     canvas->scale(page.scale_factor_, page.scale_factor_);
 144     canvas->drawPicture(page.content_.get());
 145     pdf_doc->endPage();
 146   }
 147   if (!pdf_doc->close())
 148     return false;
 149
 150   data_->pdf_data_.reset(pdf_stream.detachAsStream());
 151   return true;
 152 }
 153
 154 uint32 PdfMetafileSkia::GetDataSize() const {
 155   if (!data_->pdf_data_)
 156     return 0;
 157   return base::checked_cast<uint32>(data_->pdf_data_->getLength());
 158 }
 159
 160 bool PdfMetafileSkia::GetData(void* dst_buffer,
 161                               uint32 dst_buffer_size) const {
 162   if (!data_->pdf_data_)
 163     return false;
 164   return WriteAssetToBuffer(data_->pdf_data_.get(), dst_buffer,
 165                             base::checked_cast<size_t>(dst_buffer_size));
 166 }
 167
 168 gfx::Rect PdfMetafileSkia::GetPageBounds(unsigned int page_number) const {
 169   if (page_number < data_->pages_.size()) {
 170     return gfx::Rect(gfx::ToFlooredSize(
 171         gfx::SkSizeToSizeF(data_->pages_[page_number].page_size_)));
 172   }
 173   return gfx::Rect();
 174 }
 175
 176 unsigned int PdfMetafileSkia::GetPageCount() const {
 177   return base::checked_cast<unsigned int>(data_->pages_.size());
 178 }
 179
 180 gfx::NativeDrawingContext PdfMetafileSkia::context() const {
 181   NOTREACHED();
 182   return NULL;
 183 }
 184
 185 #if defined(OS_WIN)
 186 bool PdfMetafileSkia::Playback(gfx::NativeDrawingContext hdc,
 187                                const RECT* rect) const {
 188   NOTREACHED();
 189   return false;
 190 }
 191
 192 bool PdfMetafileSkia::SafePlayback(gfx::NativeDrawingContext hdc) const {
 193   NOTREACHED();
 194   return false;
 195 }
 196
 197 #elif defined(OS_MACOSX)
 198 /* TODO(caryclark): The set up of PluginInstance::PrintPDFOutput may result in
 199    rasterized output.  Even if that flow uses PdfMetafileCg::RenderPage,
 200    the drawing of the PDF into the canvas may result in a rasterized output.
 201    PDFMetafileSkia::RenderPage should be not implemented as shown and instead
 202    should do something like the following CL in PluginInstance::PrintPDFOutput:
 203 http://codereview.chromium.org/7200040/diff/1/webkit/plugins/ppapi/ppapi_plugin_instance.cc
 204 */
 205 bool PdfMetafileSkia::RenderPage(unsigned int page_number,
 206                                  CGContextRef context,
 207                                  const CGRect rect,
 208                                  const MacRenderPageParams& params) const {
 209   DCHECK_GT(GetDataSize(), 0U);
 210   if (data_->pdf_cg_.GetDataSize() == 0) {
 211     if (GetDataSize() == 0)
 212       return false;
 213     size_t length = data_->pdf_data_->getLength();
 214     std::vector<uint8_t> buffer(length);
 215     (void)WriteAssetToBuffer(data_->pdf_data_.get(), &buffer[0], length);
 216     data_->pdf_cg_.InitFromData(&buffer[0], base::checked_cast<uint32>(length));
 217   }
 218   return data_->pdf_cg_.RenderPage(page_number, context, rect, params);
 219 }
 220 #endif
 221
 222 bool PdfMetafileSkia::SaveTo(base::File* file) const {
 223   if (GetDataSize() == 0U)
 224     return false;
 225
 226   // Calling duplicate() keeps original asset state unchanged.
 227   scoped_ptr<SkStreamAsset> asset(data_->pdf_data_->duplicate());
 228
 229   const size_t maximum_buffer_size = 1024 * 1024;
 230   std::vector<char> buffer(std::min(maximum_buffer_size, asset->getLength()));
 231   do {
 232     size_t read_size = asset->read(&buffer[0], buffer.size());
 233     if (read_size == 0)
 234       break;
 235     DCHECK_GE(buffer.size(), read_size);
 236     if (!file->WriteAtCurrentPos(&buffer[0],
 237                                  base::checked_cast<int>(read_size))) {
 238       return false;
 239     }
 240   } while (!asset->isAtEnd());
 241
 242   return true;
 243 }
 244
 245 #if defined(OS_CHROMEOS) || defined(OS_ANDROID)
 246 bool PdfMetafileSkia::SaveToFD(const base::FileDescriptor& fd) const {
 247   DCHECK_GT(GetDataSize(), 0U);
 248
 249   if (fd.fd < 0) {
 250     DLOG(ERROR) << "Invalid file descriptor!";
 251     return false;
 252   }
 253   base::File file(fd.fd);
 254   bool result = SaveTo(&file);
 255   DLOG_IF(ERROR, !result) << "Failed to save file with fd " << fd.fd;
 256
 257   if (!fd.auto_close)
 258     file.TakePlatformFile();
 259   return result;
 260 }
 261 #endif
 262
 263 PdfMetafileSkia::PdfMetafileSkia() : data_(new PdfMetafileSkiaData) {
 264 }
 265
 266 scoped_ptr<PdfMetafileSkia> PdfMetafileSkia::GetMetafileForCurrentPage() {
 267   // If we only ever need the metafile for the last page, should we
 268   // only keep a handle on one SkPicture?
 269   scoped_ptr<PdfMetafileSkia> metafile(new PdfMetafileSkia);
 270
 271   if (data_->pages_.size() == 0)
 272     return metafile.Pass();
 273
 274   if (data_->recorder_.getRecordingCanvas())  // page outstanding
 275     return metafile.Pass();
 276
 277   const Page& page = data_->pages_.back();
 278
 279   metafile->data_->pages_.push_back(page);
 280
 281   if (!metafile->FinishDocument())  // Generate PDF.
 282     metafile.reset();
 283
 284   return metafile.Pass();
 285 }
 286
 287 }  // namespace printing