xref: /aosp_15_r20/external/skia/tools/skdiff/skdiff_utils.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker /*
2*c8dee2aaSAndroid Build Coastguard Worker  * Copyright 2012 Google Inc.
3*c8dee2aaSAndroid Build Coastguard Worker  *
4*c8dee2aaSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
5*c8dee2aaSAndroid Build Coastguard Worker  * found in the LICENSE file.
6*c8dee2aaSAndroid Build Coastguard Worker  */
7*c8dee2aaSAndroid Build Coastguard Worker 
8*c8dee2aaSAndroid Build Coastguard Worker #ifndef skdiff_utils_DEFINED
9*c8dee2aaSAndroid Build Coastguard Worker #define skdiff_utils_DEFINED
10*c8dee2aaSAndroid Build Coastguard Worker 
11*c8dee2aaSAndroid Build Coastguard Worker #include "tools/skdiff/skdiff.h"
12*c8dee2aaSAndroid Build Coastguard Worker 
13*c8dee2aaSAndroid Build Coastguard Worker class SkBitmap;
14*c8dee2aaSAndroid Build Coastguard Worker class SkData;
15*c8dee2aaSAndroid Build Coastguard Worker class SkString;
16*c8dee2aaSAndroid Build Coastguard Worker 
17*c8dee2aaSAndroid Build Coastguard Worker /** Returns true if the two buffers passed in are both non-nullptr,
18*c8dee2aaSAndroid Build Coastguard Worker  *  have the same length, and contain exactly the same byte values.
19*c8dee2aaSAndroid Build Coastguard Worker  */
20*c8dee2aaSAndroid Build Coastguard Worker bool are_buffers_equal(SkData* skdata1, SkData* skdata2);
21*c8dee2aaSAndroid Build Coastguard Worker 
22*c8dee2aaSAndroid Build Coastguard Worker /** Reads the file at the given path and returns its complete contents as an
23*c8dee2aaSAndroid Build Coastguard Worker  *  SkData object (or returns nullptr on error).
24*c8dee2aaSAndroid Build Coastguard Worker  */
25*c8dee2aaSAndroid Build Coastguard Worker sk_sp<SkData> read_file(const char* file_path);
26*c8dee2aaSAndroid Build Coastguard Worker 
27*c8dee2aaSAndroid Build Coastguard Worker /** Decodes the fileBits into the resource.fBitmap. Returns false on failure. */
28*c8dee2aaSAndroid Build Coastguard Worker bool get_bitmap(sk_sp<SkData> fileBits, DiffResource& resource, bool sizeOnly,
29*c8dee2aaSAndroid Build Coastguard Worker                 bool ignoreColorSpace);
30*c8dee2aaSAndroid Build Coastguard Worker 
31*c8dee2aaSAndroid Build Coastguard Worker /** Writes the bitmap as a PNG to the path specified. */
32*c8dee2aaSAndroid Build Coastguard Worker bool write_bitmap(const SkString& path, const SkBitmap& bitmap);
33*c8dee2aaSAndroid Build Coastguard Worker 
34*c8dee2aaSAndroid Build Coastguard Worker /** Given an image filename, returns the name of the file containing
35*c8dee2aaSAndroid Build Coastguard Worker  *  the associated difference image.
36*c8dee2aaSAndroid Build Coastguard Worker  */
37*c8dee2aaSAndroid Build Coastguard Worker SkString filename_to_diff_filename(const SkString& filename);
38*c8dee2aaSAndroid Build Coastguard Worker 
39*c8dee2aaSAndroid Build Coastguard Worker /** Given an image filename, returns the name of the file containing
40*c8dee2aaSAndroid Build Coastguard Worker  *  the "white" difference image.
41*c8dee2aaSAndroid Build Coastguard Worker  */
42*c8dee2aaSAndroid Build Coastguard Worker SkString filename_to_white_filename(const SkString& filename);
43*c8dee2aaSAndroid Build Coastguard Worker 
44*c8dee2aaSAndroid Build Coastguard Worker /** Calls compute_diff and handles the difference and white diff resources.
45*c8dee2aaSAndroid Build Coastguard Worker  *  If !outputDir.isEmpty(), writes out difference and white images.
46*c8dee2aaSAndroid Build Coastguard Worker  */
47*c8dee2aaSAndroid Build Coastguard Worker void create_and_write_diff_image(DiffRecord* drp,
48*c8dee2aaSAndroid Build Coastguard Worker                                  DiffMetricProc dmp,
49*c8dee2aaSAndroid Build Coastguard Worker                                  const int colorThreshold,
50*c8dee2aaSAndroid Build Coastguard Worker                                  const SkString& outputDir,
51*c8dee2aaSAndroid Build Coastguard Worker                                  const SkString& filename);
52*c8dee2aaSAndroid Build Coastguard Worker 
53*c8dee2aaSAndroid Build Coastguard Worker #endif
54