Tools/DumpRenderTree/PixelDumpSupport.cpp

   1 /*
   2  * Copyright (C) 2009 Apple, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "config.h"
  30 #include "PixelDumpSupport.h"
  31
  32 #include "CyclicRedundancyCheck.h"
  33 #include "DumpRenderTree.h"
  34 #include "LayoutTestController.h"
  35 #include <cstdio>
  36 #include <wtf/Assertions.h>
  37 #include <wtf/RefPtr.h>
  38 #include <wtf/Vector.h>
  39
  40 #if USE(CG)
  41 #include "PixelDumpSupportCG.h"
  42 #elif USE(CAIRO)
  43 #include "PixelDumpSupportCairo.h"
  44 #elif PLATFORM(BLACKBERRY)
  45 #include "PixelDumpSupportBlackBerry.h"
  46 #endif
  47
  48 void dumpWebViewAsPixelsAndCompareWithExpected(const std::string& expectedHash)
  49 {
  50     RefPtr<BitmapContext> context;
  51 #if PLATFORM(MAC)
  52     if (gLayoutTestController->isPrinting())
  53         context = createPagedBitmapContext();
  54     else
  55 #endif
  56         context = createBitmapContextFromWebView(gLayoutTestController->testOnscreen(), gLayoutTestController->testRepaint(), gLayoutTestController->testRepaintSweepHorizontally(), gLayoutTestController->dumpSelectionRect());
  57     ASSERT(context);
  58
  59     // Compute the hash of the bitmap context pixels
  60     char actualHash[33];
  61     computeMD5HashStringForBitmapContext(context.get(), actualHash);
  62     printf("\nActualHash: %s\n", actualHash); // FIXME: No need for the leading newline.
  63
  64     // Check the computed hash against the expected one and dump image on mismatch
  65     bool dumpImage = true;
  66     if (expectedHash.length() > 0) {
  67         ASSERT(expectedHash.length() == 32);
  68
  69         printf("\nExpectedHash: %s\n", expectedHash.c_str()); // FIXME: No need for the leading newline.
  70
  71         if (expectedHash == actualHash) // FIXME: do case insensitive compare
  72             dumpImage = false;
  73     }
  74
  75     if (dumpImage)
  76         dumpBitmap(context.get(), actualHash);
  77 }
  78
  79 static void appendIntToVector(unsigned number, Vector<unsigned char>& vector)
  80 {
  81     size_t offset = vector.size();
  82     vector.grow(offset + 4);
  83     vector[offset] = ((number >> 24) & 0xff);
  84     vector[offset + 1] = ((number >> 16) & 0xff);
  85     vector[offset + 2] = ((number >> 8) & 0xff);
  86     vector[offset + 3] = (number & 0xff);
  87 }
  88
  89 static void convertChecksumToPNGComment(const char* checksum, Vector<unsigned char>& bytesToAdd)
  90 {
  91     // Chunks of PNG files are <length>, <type>, <data>, <crc>.
  92     static const char textCommentPrefix[] = "\x00\x00\x00\x29tEXtchecksum\x00";
  93     static const size_t prefixLength = sizeof(textCommentPrefix) - 1; // The -1 is for the null at the end of the char[].
  94     static const size_t checksumLength = 32;
  95
  96     bytesToAdd.append(textCommentPrefix, prefixLength);
  97     bytesToAdd.append(checksum, checksumLength);
  98
  99     Vector<unsigned char> dataToCrc;
 100     dataToCrc.append(textCommentPrefix + 4, prefixLength - 4); // Don't include the chunk length in the crc.
 101     dataToCrc.append(checksum, checksumLength);
 102     unsigned crc32 = computeCrc(dataToCrc);
 103
 104     appendIntToVector(crc32, bytesToAdd);
 105 }
 106
 107 static size_t offsetAfterIHDRChunk(const unsigned char* data, const size_t dataLength)
 108 {
 109     const int pngHeaderLength = 8;
 110     const int pngIHDRChunkLength = 25; // chunk length + "IHDR" + 13 bytes of data + checksum
 111     return pngHeaderLength + pngIHDRChunkLength;
 112 }
 113
 114 void printPNG(const unsigned char* data, const size_t dataLength, const char* checksum)
 115 {
 116     Vector<unsigned char> bytesToAdd;
 117     convertChecksumToPNGComment(checksum, bytesToAdd);
 118
 119     printf("Content-Type: %s\n", "image/png");
 120     printf("Content-Length: %lu\n", static_cast<unsigned long>(dataLength + bytesToAdd.size()));
 121
 122     size_t insertOffset = offsetAfterIHDRChunk(data, dataLength);
 123
 124     fwrite(data, 1, insertOffset, stdout);
 125     fwrite(bytesToAdd.data(), 1, bytesToAdd.size(), stdout);
 126
 127     const size_t bytesToWriteInOneChunk = 1 << 15;
 128     data += insertOffset;
 129     size_t dataRemainingToWrite = dataLength - insertOffset;
 130     while (dataRemainingToWrite) {
 131         size_t bytesToWriteInThisChunk = std::min(dataRemainingToWrite, bytesToWriteInOneChunk);
 132         size_t bytesWritten = fwrite(data, 1, bytesToWriteInThisChunk, stdout);
 133         if (bytesWritten != bytesToWriteInThisChunk)
 134             break;
 135         dataRemainingToWrite -= bytesWritten;
 136         data += bytesWritten;
 137     }
 138 }