initial import
[vuplus_webkit] / 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 #endif
45
46 void dumpWebViewAsPixelsAndCompareWithExpected(const std::string& expectedHash)
47 {
48     RefPtr<BitmapContext> context;
49 #if PLATFORM(MAC)
50     if (gLayoutTestController->isPrinting())
51         context = createPagedBitmapContext();
52     else
53 #endif
54         context = createBitmapContextFromWebView(gLayoutTestController->testOnscreen(), gLayoutTestController->testRepaint(), gLayoutTestController->testRepaintSweepHorizontally(), gLayoutTestController->dumpSelectionRect());
55     ASSERT(context);
56     
57     // Compute the hash of the bitmap context pixels
58     char actualHash[33];
59     computeMD5HashStringForBitmapContext(context.get(), actualHash);
60     printf("\nActualHash: %s\n", actualHash);
61     
62     // Check the computed hash against the expected one and dump image on mismatch
63     bool dumpImage = true;
64     if (expectedHash.length() > 0) {
65         ASSERT(expectedHash.length() == 32);
66         
67         printf("\nExpectedHash: %s\n", expectedHash.c_str());
68         
69         if (expectedHash == actualHash)     // FIXME: do case insensitive compare
70             dumpImage = false;
71     }
72     
73     if (dumpImage)
74       dumpBitmap(context.get(), actualHash);
75 }
76
77 static void appendIntToVector(unsigned number, Vector<unsigned char>& vector)
78 {
79     size_t offset = vector.size();
80     vector.grow(offset + 4);
81     vector[offset] = ((number >> 24) & 0xff);
82     vector[offset + 1] = ((number >> 16) & 0xff);
83     vector[offset + 2] = ((number >> 8) & 0xff);
84     vector[offset + 3] = (number & 0xff);
85 }
86
87 static void convertChecksumToPNGComment(const char* checksum, Vector<unsigned char>& bytesToAdd)
88 {
89     // Chunks of PNG files are <length>, <type>, <data>, <crc>.
90     static const char textCommentPrefix[] = "\x00\x00\x00\x29tEXtchecksum\x00";
91     static const size_t prefixLength = sizeof(textCommentPrefix) - 1; // The -1 is for the null at the end of the char[].
92     static const size_t checksumLength = 32;
93
94     bytesToAdd.append(textCommentPrefix, prefixLength);
95     bytesToAdd.append(checksum, checksumLength);
96
97     Vector<unsigned char> dataToCrc;
98     dataToCrc.append(textCommentPrefix + 4, prefixLength - 4); // Don't include the chunk length in the crc.
99     dataToCrc.append(checksum, checksumLength);
100     unsigned crc32 = computeCrc(dataToCrc);
101
102     appendIntToVector(crc32, bytesToAdd);
103 }
104
105 static size_t offsetAfterIHDRChunk(const unsigned char* data, const size_t dataLength)
106 {
107     const int pngHeaderLength = 8;
108     const int pngIHDRChunkLength = 25; // chunk length + "IHDR" + 13 bytes of data + checksum
109     return pngHeaderLength + pngIHDRChunkLength;
110 }
111
112 void printPNG(const unsigned char* data, const size_t dataLength, const char* checksum)
113 {
114     Vector<unsigned char> bytesToAdd;
115     convertChecksumToPNGComment(checksum, bytesToAdd);
116
117     printf("Content-Type: %s\n", "image/png");
118     printf("Content-Length: %lu\n", static_cast<unsigned long>(dataLength + bytesToAdd.size()));
119
120     size_t insertOffset = offsetAfterIHDRChunk(data, dataLength);
121
122     fwrite(data, 1, insertOffset, stdout);
123     fwrite(bytesToAdd.data(), 1, bytesToAdd.size(), stdout);
124
125     const size_t bytesToWriteInOneChunk = 1 << 15;
126     data += insertOffset;
127     size_t dataRemainingToWrite = dataLength - insertOffset;
128     while (dataRemainingToWrite) {
129         size_t bytesToWriteInThisChunk = std::min(dataRemainingToWrite, bytesToWriteInOneChunk);
130         size_t bytesWritten = fwrite(data, 1, bytesToWriteInThisChunk, stdout);
131         if (bytesWritten != bytesToWriteInThisChunk)
132             break;
133         dataRemainingToWrite -= bytesWritten;
134         data += bytesWritten;
135     }
136 }