PictureTest.cpp revision 8e7d37d8fea8c002c152a1509c461dba87d9eaca 
1/*
2 * Copyright 2012 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8#include "SkBitmapDevice.h"
9#include "SkBlurImageFilter.h"
10#include "SkCanvas.h"
11#include "SkColorPriv.h"
12#include "SkDashPathEffect.h"
13#include "SkData.h"
14#include "SkDecodingImageGenerator.h"
15#include "SkError.h"
16#if SK_SUPPORT_GPU
17#include "SkGpuDevice.h"
18#endif
19#include "SkImageEncoder.h"
20#include "SkImageGenerator.h"
21#include "SkPaint.h"
22#include "SkPicture.h"
23#include "SkPictureRecorder.h"
24#include "SkPictureUtils.h"
25#include "SkRRect.h"
26#include "SkRandom.h"
27#include "SkShader.h"
28#include "SkStream.h"
29
30#if SK_SUPPORT_GPU
31#include "SkSurface.h"
32#include "GrContextFactory.h"
33#include "GrPictureUtils.h"
34#endif
35#include "Test.h"
36
37#include "SkLumaColorFilter.h"
38#include "SkColorFilterImageFilter.h"
39
40static const int gColorScale = 30;
41static const int gColorOffset = 60;
42
43static void make_bm(SkBitmap* bm, int w, int h, SkColor color, bool immutable) {
44    bm->allocN32Pixels(w, h);
45    bm->eraseColor(color);
46    if (immutable) {
47        bm->setImmutable();
48    }
49}
50
51static void make_checkerboard(SkBitmap* bm, int w, int h, bool immutable) {
52    SkASSERT(w % 2 == 0);
53    SkASSERT(h % 2 == 0);
54    bm->allocPixels(SkImageInfo::Make(w, h, kAlpha_8_SkColorType,
55                                      kPremul_SkAlphaType));
56    SkAutoLockPixels lock(*bm);
57    for (int y = 0; y < h; y += 2) {
58        uint8_t* s = bm->getAddr8(0, y);
59        for (int x = 0; x < w; x += 2) {
60            *s++ = 0xFF;
61            *s++ = 0x00;
62        }
63        s = bm->getAddr8(0, y + 1);
64        for (int x = 0; x < w; x += 2) {
65            *s++ = 0x00;
66            *s++ = 0xFF;
67        }
68    }
69    if (immutable) {
70        bm->setImmutable();
71    }
72}
73
74static void init_paint(SkPaint* paint, const SkBitmap &bm) {
75    SkShader* shader = SkShader::CreateBitmapShader(bm,
76                                                    SkShader::kClamp_TileMode,
77                                                    SkShader::kClamp_TileMode);
78    paint->setShader(shader)->unref();
79}
80
81typedef void (*DrawBitmapProc)(SkCanvas*, const SkBitmap&,
82                               const SkBitmap&, const SkPoint&,
83                               SkTDArray<SkPixelRef*>* usedPixRefs);
84
85static void drawpaint_proc(SkCanvas* canvas, const SkBitmap& bm,
86                           const SkBitmap& altBM, const SkPoint& pos,
87                           SkTDArray<SkPixelRef*>* usedPixRefs) {
88    SkPaint paint;
89    init_paint(&paint, bm);
90
91    canvas->drawPaint(paint);
92    *usedPixRefs->append() = bm.pixelRef();
93}
94
95static void drawpoints_proc(SkCanvas* canvas, const SkBitmap& bm,
96                            const SkBitmap& altBM, const SkPoint& pos,
97                            SkTDArray<SkPixelRef*>* usedPixRefs) {
98    SkPaint paint;
99    init_paint(&paint, bm);
100
101    // draw a rect
102    SkPoint points[5] = {
103        { pos.fX, pos.fY },
104        { pos.fX + bm.width() - 1, pos.fY },
105        { pos.fX + bm.width() - 1, pos.fY + bm.height() - 1 },
106        { pos.fX, pos.fY + bm.height() - 1 },
107        { pos.fX, pos.fY },
108    };
109
110    canvas->drawPoints(SkCanvas::kPolygon_PointMode, 5, points, paint);
111    *usedPixRefs->append() = bm.pixelRef();
112}
113
114static void drawrect_proc(SkCanvas* canvas, const SkBitmap& bm,
115                          const SkBitmap& altBM, const SkPoint& pos,
116                          SkTDArray<SkPixelRef*>* usedPixRefs) {
117    SkPaint paint;
118    init_paint(&paint, bm);
119
120    SkRect r = { 0, 0, SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) };
121    r.offset(pos.fX, pos.fY);
122
123    canvas->drawRect(r, paint);
124    *usedPixRefs->append() = bm.pixelRef();
125}
126
127static void drawoval_proc(SkCanvas* canvas, const SkBitmap& bm,
128                          const SkBitmap& altBM, const SkPoint& pos,
129                          SkTDArray<SkPixelRef*>* usedPixRefs) {
130    SkPaint paint;
131    init_paint(&paint, bm);
132
133    SkRect r = { 0, 0, SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) };
134    r.offset(pos.fX, pos.fY);
135
136    canvas->drawOval(r, paint);
137    *usedPixRefs->append() = bm.pixelRef();
138}
139
140static void drawrrect_proc(SkCanvas* canvas, const SkBitmap& bm,
141                           const SkBitmap& altBM, const SkPoint& pos,
142                           SkTDArray<SkPixelRef*>* usedPixRefs) {
143    SkPaint paint;
144    init_paint(&paint, bm);
145
146    SkRect r = { 0, 0, SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) };
147    r.offset(pos.fX, pos.fY);
148
149    SkRRect rr;
150    rr.setRectXY(r, SkIntToScalar(bm.width())/4, SkIntToScalar(bm.height())/4);
151    canvas->drawRRect(rr, paint);
152    *usedPixRefs->append() = bm.pixelRef();
153}
154
155static void drawpath_proc(SkCanvas* canvas, const SkBitmap& bm,
156                          const SkBitmap& altBM, const SkPoint& pos,
157                          SkTDArray<SkPixelRef*>* usedPixRefs) {
158    SkPaint paint;
159    init_paint(&paint, bm);
160
161    SkPath path;
162    path.lineTo(bm.width()/2.0f, SkIntToScalar(bm.height()));
163    path.lineTo(SkIntToScalar(bm.width()), 0);
164    path.close();
165    path.offset(pos.fX, pos.fY);
166
167    canvas->drawPath(path, paint);
168    *usedPixRefs->append() = bm.pixelRef();
169}
170
171static void drawbitmap_proc(SkCanvas* canvas, const SkBitmap& bm,
172                            const SkBitmap& altBM, const SkPoint& pos,
173                            SkTDArray<SkPixelRef*>* usedPixRefs) {
174    canvas->drawBitmap(bm, pos.fX, pos.fY, NULL);
175    *usedPixRefs->append() = bm.pixelRef();
176}
177
178static void drawbitmap_withshader_proc(SkCanvas* canvas, const SkBitmap& bm,
179                                       const SkBitmap& altBM, const SkPoint& pos,
180                                       SkTDArray<SkPixelRef*>* usedPixRefs) {
181    SkPaint paint;
182    init_paint(&paint, bm);
183
184    // The bitmap in the paint is ignored unless we're drawing an A8 bitmap
185    canvas->drawBitmap(altBM, pos.fX, pos.fY, &paint);
186    *usedPixRefs->append() = bm.pixelRef();
187    *usedPixRefs->append() = altBM.pixelRef();
188}
189
190static void drawsprite_proc(SkCanvas* canvas, const SkBitmap& bm,
191                            const SkBitmap& altBM, const SkPoint& pos,
192                            SkTDArray<SkPixelRef*>* usedPixRefs) {
193    const SkMatrix& ctm = canvas->getTotalMatrix();
194
195    SkPoint p(pos);
196    ctm.mapPoints(&p, 1);
197
198    canvas->drawSprite(bm, (int)p.fX, (int)p.fY, NULL);
199    *usedPixRefs->append() = bm.pixelRef();
200}
201
202#if 0
203// Although specifiable, this case doesn't seem to make sense (i.e., the
204// bitmap in the shader is never used).
205static void drawsprite_withshader_proc(SkCanvas* canvas, const SkBitmap& bm,
206                                       const SkBitmap& altBM, const SkPoint& pos,
207                                       SkTDArray<SkPixelRef*>* usedPixRefs) {
208    SkPaint paint;
209    init_paint(&paint, bm);
210
211    const SkMatrix& ctm = canvas->getTotalMatrix();
212
213    SkPoint p(pos);
214    ctm.mapPoints(&p, 1);
215
216    canvas->drawSprite(altBM, (int)p.fX, (int)p.fY, &paint);
217    *usedPixRefs->append() = bm.pixelRef();
218    *usedPixRefs->append() = altBM.pixelRef();
219}
220#endif
221
222static void drawbitmaprect_proc(SkCanvas* canvas, const SkBitmap& bm,
223                                const SkBitmap& altBM, const SkPoint& pos,
224                                SkTDArray<SkPixelRef*>* usedPixRefs) {
225    SkRect r = { 0, 0, SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) };
226
227    r.offset(pos.fX, pos.fY);
228    canvas->drawBitmapRectToRect(bm, NULL, r, NULL);
229    *usedPixRefs->append() = bm.pixelRef();
230}
231
232static void drawbitmaprect_withshader_proc(SkCanvas* canvas,
233                                           const SkBitmap& bm,
234                                           const SkBitmap& altBM,
235                                           const SkPoint& pos,
236                                           SkTDArray<SkPixelRef*>* usedPixRefs) {
237    SkPaint paint;
238    init_paint(&paint, bm);
239
240    SkRect r = { 0, 0, SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) };
241    r.offset(pos.fX, pos.fY);
242
243    // The bitmap in the paint is ignored unless we're drawing an A8 bitmap
244    canvas->drawBitmapRectToRect(altBM, NULL, r, &paint);
245    *usedPixRefs->append() = bm.pixelRef();
246    *usedPixRefs->append() = altBM.pixelRef();
247}
248
249static void drawtext_proc(SkCanvas* canvas, const SkBitmap& bm,
250                          const SkBitmap& altBM, const SkPoint& pos,
251                          SkTDArray<SkPixelRef*>* usedPixRefs) {
252    SkPaint paint;
253    init_paint(&paint, bm);
254    paint.setTextSize(SkIntToScalar(1.5*bm.width()));
255
256    canvas->drawText("0", 1, pos.fX, pos.fY+bm.width(), paint);
257    *usedPixRefs->append() = bm.pixelRef();
258}
259
260static void drawpostext_proc(SkCanvas* canvas, const SkBitmap& bm,
261                             const SkBitmap& altBM, const SkPoint& pos,
262                             SkTDArray<SkPixelRef*>* usedPixRefs) {
263    SkPaint paint;
264    init_paint(&paint, bm);
265    paint.setTextSize(SkIntToScalar(1.5*bm.width()));
266
267    SkPoint point = { pos.fX, pos.fY + bm.height() };
268    canvas->drawPosText("O", 1, &point, paint);
269    *usedPixRefs->append() = bm.pixelRef();
270}
271
272static void drawtextonpath_proc(SkCanvas* canvas, const SkBitmap& bm,
273                                const SkBitmap& altBM, const SkPoint& pos,
274                                SkTDArray<SkPixelRef*>* usedPixRefs) {
275    SkPaint paint;
276
277    init_paint(&paint, bm);
278    paint.setTextSize(SkIntToScalar(1.5*bm.width()));
279
280    SkPath path;
281    path.lineTo(SkIntToScalar(bm.width()), 0);
282    path.offset(pos.fX, pos.fY+bm.height());
283
284    canvas->drawTextOnPath("O", 1, path, NULL, paint);
285    *usedPixRefs->append() = bm.pixelRef();
286}
287
288static void drawverts_proc(SkCanvas* canvas, const SkBitmap& bm,
289                           const SkBitmap& altBM, const SkPoint& pos,
290                           SkTDArray<SkPixelRef*>* usedPixRefs) {
291    SkPaint paint;
292    init_paint(&paint, bm);
293
294    SkPoint verts[4] = {
295        { pos.fX, pos.fY },
296        { pos.fX + bm.width(), pos.fY },
297        { pos.fX + bm.width(), pos.fY + bm.height() },
298        { pos.fX, pos.fY + bm.height() }
299    };
300    SkPoint texs[4] = { { 0, 0 },
301                        { SkIntToScalar(bm.width()), 0 },
302                        { SkIntToScalar(bm.width()), SkIntToScalar(bm.height()) },
303                        { 0, SkIntToScalar(bm.height()) } };
304    uint16_t indices[6] = { 0, 1, 2, 0, 2, 3 };
305
306    canvas->drawVertices(SkCanvas::kTriangles_VertexMode, 4, verts, texs, NULL, NULL,
307                         indices, 6, paint);
308    *usedPixRefs->append() = bm.pixelRef();
309}
310
311// Return a picture with the bitmaps drawn at the specified positions.
312static SkPicture* record_bitmaps(const SkBitmap bm[],
313                                 const SkPoint pos[],
314                                 SkTDArray<SkPixelRef*> analytic[],
315                                 int count,
316                                 DrawBitmapProc proc) {
317    SkPictureRecorder recorder;
318    SkCanvas* canvas = recorder.beginRecording(1000, 1000, NULL, 0);
319    for (int i = 0; i < count; ++i) {
320        analytic[i].rewind();
321        canvas->save();
322        SkRect clipRect = SkRect::MakeXYWH(pos[i].fX, pos[i].fY,
323                                           SkIntToScalar(bm[i].width()),
324                                           SkIntToScalar(bm[i].height()));
325        canvas->clipRect(clipRect, SkRegion::kIntersect_Op);
326        proc(canvas, bm[i], bm[count+i], pos[i], &analytic[i]);
327        canvas->restore();
328    }
329    return recorder.endRecording();
330}
331
332static void rand_rect(SkRect* rect, SkRandom& rand, SkScalar W, SkScalar H) {
333    rect->fLeft   = rand.nextRangeScalar(-W, 2*W);
334    rect->fTop    = rand.nextRangeScalar(-H, 2*H);
335    rect->fRight  = rect->fLeft + rand.nextRangeScalar(0, W);
336    rect->fBottom = rect->fTop + rand.nextRangeScalar(0, H);
337
338    // we integralize rect to make our tests more predictable, since Gather is
339    // a little sloppy.
340    SkIRect ir;
341    rect->round(&ir);
342    rect->set(ir);
343}
344
345static void draw(SkPicture* pic, int width, int height, SkBitmap* result) {
346    make_bm(result, width, height, SK_ColorBLACK, false);
347
348    SkCanvas canvas(*result);
349    canvas.drawPicture(*pic);
350}
351
352template <typename T> int find_index(const T* array, T elem, int count) {
353    for (int i = 0; i < count; ++i) {
354        if (array[i] == elem) {
355            return i;
356        }
357    }
358    return -1;
359}
360
361// Return true if 'ref' is found in array[]
362static bool find(SkPixelRef const * const * array, SkPixelRef const * ref, int count) {
363    return find_index<const SkPixelRef*>(array, ref, count) >= 0;
364}
365
366// Look at each pixel that is inside 'subset', and if its color appears in
367// colors[], find the corresponding value in refs[] and append that ref into
368// array, skipping duplicates of the same value.
369// Note that gathering pixelRefs from rendered colors suffers from the problem
370// that multiple simultaneous textures (e.g., A8 for alpha and 8888 for color)
371// isn't easy to reconstruct.
372static void gather_from_image(const SkBitmap& bm, SkPixelRef* const refs[],
373                              int count, SkTDArray<SkPixelRef*>* array,
374                              const SkRect& subset) {
375    SkIRect ir;
376    subset.roundOut(&ir);
377
378    if (!ir.intersect(0, 0, bm.width()-1, bm.height()-1)) {
379        return;
380    }
381
382    // Since we only want to return unique values in array, when we scan we just
383    // set a bit for each index'd color found. In practice we only have a few
384    // distinct colors, so we just use an int's bits as our array. Hence the
385    // assert that count <= number-of-bits-in-our-int.
386    SkASSERT((unsigned)count <= 32);
387    uint32_t bitarray = 0;
388
389    SkAutoLockPixels alp(bm);
390
391    for (int y = ir.fTop; y < ir.fBottom; ++y) {
392        for (int x = ir.fLeft; x < ir.fRight; ++x) {
393            SkPMColor pmc = *bm.getAddr32(x, y);
394            // the only good case where the color is not found would be if
395            // the color is transparent, meaning no bitmap was drawn in that
396            // pixel.
397            if (pmc) {
398                uint32_t index = SkGetPackedR32(pmc);
399                SkASSERT(SkGetPackedG32(pmc) == index);
400                SkASSERT(SkGetPackedB32(pmc) == index);
401                if (0 == index) {
402                    continue;           // background color
403                }
404                SkASSERT(0 == (index - gColorOffset) % gColorScale);
405                index = (index - gColorOffset) / gColorScale;
406                SkASSERT(static_cast<int>(index) < count);
407                bitarray |= 1 << index;
408            }
409        }
410    }
411
412    for (int i = 0; i < count; ++i) {
413        if (bitarray & (1 << i)) {
414            *array->append() = refs[i];
415        }
416    }
417}
418
419static void gather_from_analytic(const SkPoint pos[], SkScalar w, SkScalar h,
420                                 const SkTDArray<SkPixelRef*> analytic[],
421                                 int count,
422                                 SkTDArray<SkPixelRef*>* result,
423                                 const SkRect& subset) {
424    for (int i = 0; i < count; ++i) {
425        SkRect rect = SkRect::MakeXYWH(pos[i].fX, pos[i].fY, w, h);
426
427        if (SkRect::Intersects(subset, rect)) {
428            result->append(analytic[i].count(), analytic[i].begin());
429        }
430    }
431}
432
433
434static const struct {
435    const DrawBitmapProc proc;
436    const char* const desc;
437} gProcs[] = {
438    {drawpaint_proc, "drawpaint"},
439    {drawpoints_proc, "drawpoints"},
440    {drawrect_proc, "drawrect"},
441    {drawoval_proc, "drawoval"},
442    {drawrrect_proc, "drawrrect"},
443    {drawpath_proc, "drawpath"},
444    {drawbitmap_proc, "drawbitmap"},
445    {drawbitmap_withshader_proc, "drawbitmap_withshader"},
446    {drawsprite_proc, "drawsprite"},
447#if 0
448    {drawsprite_withshader_proc, "drawsprite_withshader"},
449#endif
450    {drawbitmaprect_proc, "drawbitmaprect"},
451    {drawbitmaprect_withshader_proc, "drawbitmaprect_withshader"},
452    {drawtext_proc, "drawtext"},
453    {drawpostext_proc, "drawpostext"},
454    {drawtextonpath_proc, "drawtextonpath"},
455    {drawverts_proc, "drawverts"},
456};
457
458static void create_textures(SkBitmap* bm, SkPixelRef** refs, int num, int w, int h) {
459    // Our convention is that the color components contain an encoding of
460    // the index of their corresponding bitmap/pixelref. (0,0,0,0) is
461    // reserved for the background
462    for (int i = 0; i < num; ++i) {
463        make_bm(&bm[i], w, h,
464                SkColorSetARGB(0xFF,
465                               gColorScale*i+gColorOffset,
466                               gColorScale*i+gColorOffset,
467                               gColorScale*i+gColorOffset),
468                true);
469        refs[i] = bm[i].pixelRef();
470    }
471
472    // The A8 alternate bitmaps are all BW checkerboards
473    for (int i = 0; i < num; ++i) {
474        make_checkerboard(&bm[num+i], w, h, true);
475        refs[num+i] = bm[num+i].pixelRef();
476    }
477}
478
479static void test_gatherpixelrefs(skiatest::Reporter* reporter) {
480    const int IW = 32;
481    const int IH = IW;
482    const SkScalar W = SkIntToScalar(IW);
483    const SkScalar H = W;
484
485    static const int N = 4;
486    SkBitmap bm[2*N];
487    SkPixelRef* refs[2*N];
488    SkTDArray<SkPixelRef*> analytic[N];
489
490    const SkPoint pos[N] = {
491        { 0, 0 }, { W, 0 }, { 0, H }, { W, H }
492    };
493
494    create_textures(bm, refs, N, IW, IH);
495
496    SkRandom rand;
497    for (size_t k = 0; k < SK_ARRAY_COUNT(gProcs); ++k) {
498        SkAutoTUnref<SkPicture> pic(
499            record_bitmaps(bm, pos, analytic, N, gProcs[k].proc));
500
501        REPORTER_ASSERT(reporter, pic->willPlayBackBitmaps() || N == 0);
502        // quick check for a small piece of each quadrant, which should just
503        // contain 1 or 2 bitmaps.
504        for (size_t  i = 0; i < SK_ARRAY_COUNT(pos); ++i) {
505            SkRect r;
506            r.set(2, 2, W - 2, H - 2);
507            r.offset(pos[i].fX, pos[i].fY);
508            SkAutoDataUnref data(SkPictureUtils::GatherPixelRefs(pic, r));
509            if (!data) {
510                ERRORF(reporter, "SkPictureUtils::GatherPixelRefs returned "
511                       "NULL for %s.", gProcs[k].desc);
512                continue;
513            }
514            SkPixelRef** gatheredRefs = (SkPixelRef**)data->data();
515            int count = static_cast<int>(data->size() / sizeof(SkPixelRef*));
516            REPORTER_ASSERT(reporter, 1 == count || 2 == count);
517            if (1 == count) {
518                REPORTER_ASSERT(reporter, gatheredRefs[0] == refs[i]);
519            } else if (2 == count) {
520                REPORTER_ASSERT(reporter,
521                    (gatheredRefs[0] == refs[i] && gatheredRefs[1] == refs[i+N]) ||
522                    (gatheredRefs[1] == refs[i] && gatheredRefs[0] == refs[i+N]));
523            }
524        }
525
526        SkBitmap image;
527        draw(pic, 2*IW, 2*IH, &image);
528
529        // Test a bunch of random (mostly) rects, and compare the gather results
530        // with a deduced list of refs by looking at the colors drawn.
531        for (int j = 0; j < 100; ++j) {
532            SkRect r;
533            rand_rect(&r, rand, 2*W, 2*H);
534
535            SkTDArray<SkPixelRef*> fromImage;
536            gather_from_image(image, refs, N, &fromImage, r);
537
538            SkTDArray<SkPixelRef*> fromAnalytic;
539            gather_from_analytic(pos, W, H, analytic, N, &fromAnalytic, r);
540
541            SkData* data = SkPictureUtils::GatherPixelRefs(pic, r);
542            size_t dataSize = data ? data->size() : 0;
543            int gatherCount = static_cast<int>(dataSize / sizeof(SkPixelRef*));
544            SkASSERT(gatherCount * sizeof(SkPixelRef*) == dataSize);
545            SkPixelRef** gatherRefs = data ? (SkPixelRef**)(data->data()) : NULL;
546            SkAutoDataUnref adu(data);
547
548            // Everything that we saw drawn should appear in the analytic list
549            // but the analytic list may contain some pixelRefs that were not
550            // seen in the image (e.g., A8 textures used as masks)
551            for (int i = 0; i < fromImage.count(); ++i) {
552                if (-1 == fromAnalytic.find(fromImage[i])) {
553                    ERRORF(reporter, "PixelRef missing %d %s",
554                           i, gProcs[k].desc);
555                }
556            }
557
558            /*
559             *  GatherPixelRefs is conservative, so it can return more bitmaps
560             *  than are strictly required. Thus our check here is only that
561             *  Gather didn't miss any that we actually needed. Even that isn't
562             *  a strict requirement on Gather, which is meant to be quick and
563             *  only mostly-correct, but at the moment this test should work.
564             */
565            for (int i = 0; i < fromAnalytic.count(); ++i) {
566                bool found = find(gatherRefs, fromAnalytic[i], gatherCount);
567                if (!found) {
568                    ERRORF(reporter, "PixelRef missing %d %s",
569                           i, gProcs[k].desc);
570                }
571#if 0
572                // enable this block of code to debug failures, as it will rerun
573                // the case that failed.
574                if (!found) {
575                    SkData* data = SkPictureUtils::GatherPixelRefs(pic, r);
576                    size_t dataSize = data ? data->size() : 0;
577                }
578#endif
579            }
580        }
581    }
582}
583
584static void test_gatherpixelrefsandrects(skiatest::Reporter* reporter) {
585    const int IW = 32;
586    const int IH = IW;
587    const SkScalar W = SkIntToScalar(IW);
588    const SkScalar H = W;
589
590    static const int N = 4;
591    SkBitmap bm[2*N];
592    SkPixelRef* refs[2*N];
593    SkTDArray<SkPixelRef*> analytic[N];
594
595    const SkPoint pos[N] = {
596        { 0, 0 }, { W, 0 }, { 0, H }, { W, H }
597    };
598
599    create_textures(bm, refs, N, IW, IH);
600
601    SkRandom rand;
602    for (size_t k = 0; k < SK_ARRAY_COUNT(gProcs); ++k) {
603        SkAutoTUnref<SkPicture> pic(
604            record_bitmaps(bm, pos, analytic, N, gProcs[k].proc));
605
606        REPORTER_ASSERT(reporter, pic->willPlayBackBitmaps() || N == 0);
607
608        SkAutoTUnref<SkPictureUtils::SkPixelRefContainer> prCont(
609                                new SkPictureUtils::SkPixelRefsAndRectsList);
610
611        SkPictureUtils::GatherPixelRefsAndRects(pic, prCont);
612
613        // quick check for a small piece of each quadrant, which should just
614        // contain 1 or 2 bitmaps.
615        for (size_t  i = 0; i < SK_ARRAY_COUNT(pos); ++i) {
616            SkRect r;
617            r.set(2, 2, W - 2, H - 2);
618            r.offset(pos[i].fX, pos[i].fY);
619
620            SkTDArray<SkPixelRef*> gatheredRefs;
621            prCont->query(r, &gatheredRefs);
622
623            int count = gatheredRefs.count();
624            REPORTER_ASSERT(reporter, 1 == count || 2 == count);
625            if (1 == count) {
626                REPORTER_ASSERT(reporter, gatheredRefs[0] == refs[i]);
627            } else if (2 == count) {
628                REPORTER_ASSERT(reporter,
629                    (gatheredRefs[0] == refs[i] && gatheredRefs[1] == refs[i+N]) ||
630                    (gatheredRefs[1] == refs[i] && gatheredRefs[0] == refs[i+N]));
631            }
632        }
633
634        SkBitmap image;
635        draw(pic, 2*IW, 2*IH, &image);
636
637        // Test a bunch of random (mostly) rects, and compare the gather results
638        // with the analytic results and the pixel refs seen in a rendering.
639        for (int j = 0; j < 100; ++j) {
640            SkRect r;
641            rand_rect(&r, rand, 2*W, 2*H);
642
643            SkTDArray<SkPixelRef*> fromImage;
644            gather_from_image(image, refs, N, &fromImage, r);
645
646            SkTDArray<SkPixelRef*> fromAnalytic;
647            gather_from_analytic(pos, W, H, analytic, N, &fromAnalytic, r);
648
649            SkTDArray<SkPixelRef*> gatheredRefs;
650            prCont->query(r, &gatheredRefs);
651
652            // Everything that we saw drawn should appear in the analytic list
653            // but the analytic list may contain some pixelRefs that were not
654            // seen in the image (e.g., A8 textures used as masks)
655            for (int i = 0; i < fromImage.count(); ++i) {
656                REPORTER_ASSERT(reporter, -1 != fromAnalytic.find(fromImage[i]));
657            }
658
659            // Everything in the analytic list should appear in the gathered
660            // list.
661            for (int i = 0; i < fromAnalytic.count(); ++i) {
662                REPORTER_ASSERT(reporter, -1 != gatheredRefs.find(fromAnalytic[i]));
663            }
664        }
665    }
666}
667
668#ifdef SK_DEBUG
669// Ensure that deleting SkPicturePlayback does not assert. Asserts only fire in debug mode, so only
670// run in debug mode.
671static void test_deleting_empty_playback() {
672    SkPictureRecorder recorder;
673    // Creates an SkPictureRecord
674    recorder.beginRecording(0, 0, NULL, 0);
675    // Turns that into an SkPicturePlayback
676    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
677    // Deletes the old SkPicturePlayback, and creates a new SkPictureRecord
678    recorder.beginRecording(0, 0, NULL, 0);
679}
680
681// Ensure that serializing an empty picture does not assert. Likewise only runs in debug mode.
682static void test_serializing_empty_picture() {
683    SkPictureRecorder recorder;
684    recorder.beginRecording(0, 0, NULL, 0);
685    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
686    SkDynamicMemoryWStream stream;
687    picture->serialize(&stream);
688}
689#endif
690
691static void rand_op(SkCanvas* canvas, SkRandom& rand) {
692    SkPaint paint;
693    SkRect rect = SkRect::MakeWH(50, 50);
694
695    SkScalar unit = rand.nextUScalar1();
696    if (unit <= 0.3) {
697//        SkDebugf("save\n");
698        canvas->save();
699    } else if (unit <= 0.6) {
700//        SkDebugf("restore\n");
701        canvas->restore();
702    } else if (unit <= 0.9) {
703//        SkDebugf("clip\n");
704        canvas->clipRect(rect);
705    } else {
706//        SkDebugf("draw\n");
707        canvas->drawPaint(paint);
708    }
709}
710
711#if SK_SUPPORT_GPU
712static void test_gpu_veto(skiatest::Reporter* reporter) {
713
714    SkPictureRecorder recorder;
715
716    SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
717    {
718        SkPath path;
719        path.moveTo(0, 0);
720        path.lineTo(50, 50);
721
722        SkScalar intervals[] = { 1.0f, 1.0f };
723        SkAutoTUnref<SkDashPathEffect> dash(SkDashPathEffect::Create(intervals, 2, 0));
724
725        SkPaint paint;
726        paint.setStyle(SkPaint::kStroke_Style);
727        paint.setPathEffect(dash);
728
729        canvas->drawPath(path, paint);
730    }
731    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
732    // path effects currently render an SkPicture undesireable for GPU rendering
733    REPORTER_ASSERT(reporter, !picture->suitableForGpuRasterization(NULL));
734
735    canvas = recorder.beginRecording(100, 100, NULL, 0);
736    {
737        SkPath path;
738
739        path.moveTo(0, 0);
740        path.lineTo(0, 50);
741        path.lineTo(25, 25);
742        path.lineTo(50, 50);
743        path.lineTo(50, 0);
744        path.close();
745        REPORTER_ASSERT(reporter, !path.isConvex());
746
747        SkPaint paint;
748        paint.setAntiAlias(true);
749        for (int i = 0; i < 50; ++i) {
750            canvas->drawPath(path, paint);
751        }
752    }
753    picture.reset(recorder.endRecording());
754    // A lot of AA concave paths currently render an SkPicture undesireable for GPU rendering
755    REPORTER_ASSERT(reporter, !picture->suitableForGpuRasterization(NULL));
756
757    canvas = recorder.beginRecording(100, 100, NULL, 0);
758    {
759        SkPath path;
760
761        path.moveTo(0, 0);
762        path.lineTo(0, 50);
763        path.lineTo(25, 25);
764        path.lineTo(50, 50);
765        path.lineTo(50, 0);
766        path.close();
767        REPORTER_ASSERT(reporter, !path.isConvex());
768
769        SkPaint paint;
770        paint.setAntiAlias(true);
771        paint.setStyle(SkPaint::kStroke_Style);
772        paint.setStrokeWidth(0);
773        for (int i = 0; i < 50; ++i) {
774            canvas->drawPath(path, paint);
775        }
776    }
777    picture.reset(recorder.endRecording());
778    // hairline stroked AA concave paths are fine for GPU rendering
779    REPORTER_ASSERT(reporter, picture->suitableForGpuRasterization(NULL));
780}
781
782static void test_gpu_picture_optimization(skiatest::Reporter* reporter,
783                                          GrContextFactory* factory) {
784
785    GrContext* context = factory->get(GrContextFactory::kNative_GLContextType);
786
787    static const int kWidth = 100;
788    static const int kHeight = 100;
789
790    SkAutoTUnref<SkPicture> pict;
791
792    // create a picture with the structure:
793    // 1)
794    //      SaveLayer
795    //      Restore
796    // 2)
797    //      SaveLayer
798    //          Translate
799    //          SaveLayer w/ bound
800    //          Restore
801    //      Restore
802    // 3)
803    //      SaveLayer w/ copyable paint
804    //      Restore
805    // 4)
806    //      SaveLayer w/ non-copyable paint
807    //      Restore
808    {
809        SkPictureRecorder recorder;
810
811        SkCanvas* c = recorder.beginRecording(kWidth, kHeight, NULL, 0);
812        // 1)
813        c->saveLayer(NULL, NULL);
814        c->restore();
815
816        // 2)
817        c->saveLayer(NULL, NULL);
818            c->translate(kWidth/2, kHeight/2);
819            SkRect r = SkRect::MakeXYWH(0, 0, kWidth/2, kHeight/2);
820            c->saveLayer(&r, NULL);
821            c->restore();
822        c->restore();
823
824        // 3)
825        {
826            SkPaint p;
827            p.setColor(SK_ColorRED);
828            c->saveLayer(NULL, &p);
829            c->restore();
830        }
831        // 4)
832        // TODO: this case will need to be removed once the paint's are immutable
833        {
834            SkPaint p;
835            SkAutoTUnref<SkColorFilter> cf(SkLumaColorFilter::Create());
836            p.setImageFilter(SkColorFilterImageFilter::Create(cf.get()))->unref();
837            c->saveLayer(NULL, &p);
838            c->restore();
839        }
840
841        pict.reset(recorder.endRecording());
842    }
843
844    // Now test out the SaveLayer extraction
845    {
846        SkImageInfo info = SkImageInfo::MakeN32Premul(kWidth, kHeight);
847
848        SkAutoTUnref<SkSurface> surface(SkSurface::NewScratchRenderTarget(context, info));
849
850        SkCanvas* canvas = surface->getCanvas();
851
852        canvas->EXPERIMENTAL_optimize(pict);
853
854        SkPicture::AccelData::Key key = GPUAccelData::ComputeAccelDataKey();
855
856        const SkPicture::AccelData* data = pict->EXPERIMENTAL_getAccelData(key);
857        REPORTER_ASSERT(reporter, NULL != data);
858
859        const GPUAccelData *gpuData = static_cast<const GPUAccelData*>(data);
860        REPORTER_ASSERT(reporter, 5 == gpuData->numSaveLayers());
861
862        const GPUAccelData::SaveLayerInfo& info0 = gpuData->saveLayerInfo(0);
863        // The parent/child layer appear in reverse order
864        const GPUAccelData::SaveLayerInfo& info1 = gpuData->saveLayerInfo(2);
865        const GPUAccelData::SaveLayerInfo& info2 = gpuData->saveLayerInfo(1);
866        const GPUAccelData::SaveLayerInfo& info3 = gpuData->saveLayerInfo(3);
867//        const GPUAccelData::SaveLayerInfo& info4 = gpuData->saveLayerInfo(4);
868
869        REPORTER_ASSERT(reporter, info0.fValid);
870        REPORTER_ASSERT(reporter, kWidth == info0.fSize.fWidth && kHeight == info0.fSize.fHeight);
871        REPORTER_ASSERT(reporter, info0.fCTM.isIdentity());
872        REPORTER_ASSERT(reporter, 0 == info0.fOffset.fX && 0 == info0.fOffset.fY);
873        REPORTER_ASSERT(reporter, NULL != info0.fPaint);
874        REPORTER_ASSERT(reporter, !info0.fIsNested && !info0.fHasNestedLayers);
875
876        REPORTER_ASSERT(reporter, info1.fValid);
877        REPORTER_ASSERT(reporter, kWidth == info1.fSize.fWidth && kHeight == info1.fSize.fHeight);
878        REPORTER_ASSERT(reporter, info1.fCTM.isIdentity());
879        REPORTER_ASSERT(reporter, 0 == info1.fOffset.fX && 0 == info1.fOffset.fY);
880        REPORTER_ASSERT(reporter, NULL != info1.fPaint);
881        REPORTER_ASSERT(reporter, !info1.fIsNested && info1.fHasNestedLayers); // has a nested SL
882
883        REPORTER_ASSERT(reporter, info2.fValid);
884        REPORTER_ASSERT(reporter, kWidth/2 == info2.fSize.fWidth &&
885                                  kHeight/2 == info2.fSize.fHeight); // bound reduces size
886        REPORTER_ASSERT(reporter, info2.fCTM.isIdentity());         // translated
887        REPORTER_ASSERT(reporter, kWidth/2 == info2.fOffset.fX &&
888                                  kHeight/2 == info2.fOffset.fY);
889        REPORTER_ASSERT(reporter, NULL != info1.fPaint);
890        REPORTER_ASSERT(reporter, info2.fIsNested && !info2.fHasNestedLayers); // is nested
891
892        REPORTER_ASSERT(reporter, info3.fValid);
893        REPORTER_ASSERT(reporter, kWidth == info3.fSize.fWidth && kHeight == info3.fSize.fHeight);
894        REPORTER_ASSERT(reporter, info3.fCTM.isIdentity());
895        REPORTER_ASSERT(reporter, 0 == info3.fOffset.fX && 0 == info3.fOffset.fY);
896        REPORTER_ASSERT(reporter, NULL != info3.fPaint);
897        REPORTER_ASSERT(reporter, !info3.fIsNested && !info3.fHasNestedLayers);
898
899#if 0 // needs more though for GrGatherCanvas
900        REPORTER_ASSERT(reporter, !info4.fValid);                 // paint is/was uncopyable
901        REPORTER_ASSERT(reporter, kWidth == info4.fSize.fWidth && kHeight == info4.fSize.fHeight);
902        REPORTER_ASSERT(reporter, 0 == info4.fOffset.fX && 0 == info4.fOffset.fY);
903        REPORTER_ASSERT(reporter, info4.fCTM.isIdentity());
904        REPORTER_ASSERT(reporter, NULL == info4.fPaint);     // paint is/was uncopyable
905        REPORTER_ASSERT(reporter, !info4.fIsNested && !info4.fHasNestedLayers);
906#endif
907    }
908}
909
910#endif
911
912static void set_canvas_to_save_count_4(SkCanvas* canvas) {
913    canvas->restoreToCount(1);
914    canvas->save();
915    canvas->save();
916    canvas->save();
917}
918
919#ifdef SK_BUILD_FOR_ANDROID
920/**
921 * A canvas that records the number of saves, saveLayers and restores.
922 */
923class SaveCountingCanvas : public SkCanvas {
924public:
925    SaveCountingCanvas(int width, int height)
926        : INHERITED(width, height)
927        , fSaveCount(0)
928        , fSaveLayerCount(0)
929        , fRestoreCount(0){
930    }
931
932    virtual SaveLayerStrategy willSaveLayer(const SkRect* bounds, const SkPaint* paint,
933                                            SaveFlags flags) SK_OVERRIDE {
934        ++fSaveLayerCount;
935        return this->INHERITED::willSaveLayer(bounds, paint, flags);
936    }
937
938    virtual void willSave(SaveFlags flags) SK_OVERRIDE {
939        ++fSaveCount;
940        this->INHERITED::willSave(flags);
941    }
942
943    virtual void willRestore() SK_OVERRIDE {
944        ++fRestoreCount;
945        this->INHERITED::willRestore();
946    }
947
948    unsigned int getSaveCount() const { return fSaveCount; }
949    unsigned int getSaveLayerCount() const { return fSaveLayerCount; }
950    unsigned int getRestoreCount() const { return fRestoreCount; }
951
952private:
953    unsigned int fSaveCount;
954    unsigned int fSaveLayerCount;
955    unsigned int fRestoreCount;
956
957    typedef SkCanvas INHERITED;
958};
959
960void check_save_state(skiatest::Reporter* reporter, SkPicture* picture,
961                      unsigned int numSaves, unsigned int numSaveLayers,
962                      unsigned int numRestores) {
963    SaveCountingCanvas canvas(picture->width(), picture->height());
964
965    picture->draw(&canvas);
966
967    REPORTER_ASSERT(reporter, numSaves == canvas.getSaveCount());
968    REPORTER_ASSERT(reporter, numSaveLayers == canvas.getSaveLayerCount());
969    REPORTER_ASSERT(reporter, numRestores == canvas.getRestoreCount());
970}
971
972// This class exists so SkPicture can friend it and give it access to
973// the 'partialReplay' method.
974class SkPictureRecorderReplayTester {
975public:
976    static SkPicture* Copy(SkPictureRecorder* recorder) {
977        SkPictureRecorder recorder2;
978
979        SkCanvas* canvas = recorder2.beginRecording(10, 10, NULL, 0);
980
981        recorder->partialReplay(canvas);
982
983        return recorder2.endRecording();
984    }
985};
986
987// Test out SkPictureRecorder::partialReplay
988DEF_TEST(PictureRecorder_replay, reporter) {
989    // check save/saveLayer state
990    {
991        SkPictureRecorder recorder;
992
993        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
994
995        canvas->saveLayer(NULL, NULL);
996
997        SkAutoTUnref<SkPicture> copy(SkPictureRecorderReplayTester::Copy(&recorder));
998
999        // The extra save and restore comes from the Copy process.
1000        check_save_state(reporter, copy, 2, 1, 3);
1001
1002        canvas->saveLayer(NULL, NULL);
1003
1004        SkAutoTUnref<SkPicture> final(recorder.endRecording());
1005
1006        check_save_state(reporter, final, 1, 2, 3);
1007
1008        // The copy shouldn't pick up any operations added after it was made
1009        check_save_state(reporter, copy, 2, 1, 3);
1010    }
1011
1012    // (partially) check leakage of draw ops
1013    {
1014        SkPictureRecorder recorder;
1015
1016        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1017
1018        SkRect r = SkRect::MakeWH(5, 5);
1019        SkPaint p;
1020
1021        canvas->drawRect(r, p);
1022
1023        SkAutoTUnref<SkPicture> copy(SkPictureRecorderReplayTester::Copy(&recorder));
1024
1025        REPORTER_ASSERT(reporter, !copy->willPlayBackBitmaps());
1026
1027        SkBitmap bm;
1028        make_bm(&bm, 10, 10, SK_ColorRED, true);
1029
1030        r.offset(5.0f, 5.0f);
1031        canvas->drawBitmapRectToRect(bm, NULL, r);
1032
1033        SkAutoTUnref<SkPicture> final(recorder.endRecording());
1034        REPORTER_ASSERT(reporter, final->willPlayBackBitmaps());
1035
1036        REPORTER_ASSERT(reporter, copy->uniqueID() != final->uniqueID());
1037
1038        // The snapshot shouldn't pick up any operations added after it was made
1039        REPORTER_ASSERT(reporter, !copy->willPlayBackBitmaps());
1040    }
1041}
1042#endif
1043
1044static void test_unbalanced_save_restores(skiatest::Reporter* reporter) {
1045    SkCanvas testCanvas(100, 100);
1046    set_canvas_to_save_count_4(&testCanvas);
1047
1048    REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1049
1050    SkPaint paint;
1051    SkRect rect = SkRect::MakeLTRB(-10000000, -10000000, 10000000, 10000000);
1052
1053    SkPictureRecorder recorder;
1054
1055    {
1056        // Create picture with 2 unbalanced saves
1057        SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
1058        canvas->save();
1059        canvas->translate(10, 10);
1060        canvas->drawRect(rect, paint);
1061        canvas->save();
1062        canvas->translate(10, 10);
1063        canvas->drawRect(rect, paint);
1064        SkAutoTUnref<SkPicture> extraSavePicture(recorder.endRecording());
1065
1066        testCanvas.drawPicture(*extraSavePicture);
1067        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1068    }
1069
1070    set_canvas_to_save_count_4(&testCanvas);
1071
1072    {
1073        // Create picture with 2 unbalanced restores
1074        SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
1075        canvas->save();
1076        canvas->translate(10, 10);
1077        canvas->drawRect(rect, paint);
1078        canvas->save();
1079        canvas->translate(10, 10);
1080        canvas->drawRect(rect, paint);
1081        canvas->restore();
1082        canvas->restore();
1083        canvas->restore();
1084        canvas->restore();
1085        SkAutoTUnref<SkPicture> extraRestorePicture(recorder.endRecording());
1086
1087        testCanvas.drawPicture(*extraRestorePicture);
1088        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1089    }
1090
1091    set_canvas_to_save_count_4(&testCanvas);
1092
1093    {
1094        SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
1095        canvas->translate(10, 10);
1096        canvas->drawRect(rect, paint);
1097        SkAutoTUnref<SkPicture> noSavePicture(recorder.endRecording());
1098
1099        testCanvas.drawPicture(*noSavePicture);
1100        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1101        REPORTER_ASSERT(reporter, testCanvas.getTotalMatrix().isIdentity());
1102    }
1103
1104#if defined(SK_SUPPORT_LEGACY_PICTURE_CAN_RECORD) && \
1105    defined(SK_SUPPORT_LEGACY_DERIVED_PICTURE_CLASSES)
1106    set_canvas_to_save_count_4(&testCanvas);
1107
1108    // Due to "fake" endRecording, the old SkPicture recording interface
1109    // allowed unbalanced saves/restores to leak out. This sub-test checks
1110    // that the situation has been remedied.
1111    {
1112        SkPicture p;
1113
1114        SkCanvas* canvas = p.beginRecording(100, 100);
1115        for (int i = 0; i < 4; ++i) {
1116           canvas->save();
1117        }
1118        SkRect r = SkRect::MakeWH(50, 50);
1119        SkPaint paint;
1120        canvas->drawRect(r, paint);
1121
1122        // Check that copying a mid-recording picture does not result in unbalanced saves/restores
1123        SkPicture p2(p);
1124
1125        testCanvas.drawPicture(p2);
1126        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1127        set_canvas_to_save_count_4(&testCanvas);
1128
1129        // Check that cloning a mid-recording picture does not result in unbalanced saves/restores
1130        SkAutoTUnref<SkPicture> p3(p.clone());
1131        testCanvas.drawPicture(*p3);
1132        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1133        set_canvas_to_save_count_4(&testCanvas);
1134
1135        // Check that serializing a mid-recording picture doesn't result in unbalanced
1136        // saves/restores
1137        SkDynamicMemoryWStream wStream;
1138        p.serialize(&wStream);
1139        SkAutoDataUnref data(wStream.copyToData());
1140        SkMemoryStream stream(data);
1141        SkAutoTUnref<SkPicture> p4(SkPicture::CreateFromStream(&stream, NULL));
1142        testCanvas.drawPicture(*p4);
1143        REPORTER_ASSERT(reporter, 4 == testCanvas.getSaveCount());
1144    }
1145#endif
1146}
1147
1148static void test_peephole() {
1149    SkRandom rand;
1150
1151    SkPictureRecorder recorder;
1152
1153    for (int j = 0; j < 100; j++) {
1154        SkRandom rand2(rand); // remember the seed
1155
1156        SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
1157
1158        for (int i = 0; i < 1000; ++i) {
1159            rand_op(canvas, rand);
1160        }
1161        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1162
1163        rand = rand2;
1164    }
1165
1166    {
1167        SkCanvas* canvas = recorder.beginRecording(100, 100, NULL, 0);
1168        SkRect rect = SkRect::MakeWH(50, 50);
1169
1170        for (int i = 0; i < 100; ++i) {
1171            canvas->save();
1172        }
1173        while (canvas->getSaveCount() > 1) {
1174            canvas->clipRect(rect);
1175            canvas->restore();
1176        }
1177        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1178    }
1179}
1180
1181#ifndef SK_DEBUG
1182// Only test this is in release mode. We deliberately crash in debug mode, since a valid caller
1183// should never do this.
1184static void test_bad_bitmap() {
1185    // This bitmap has a width and height but no pixels. As a result, attempting to record it will
1186    // fail.
1187    SkBitmap bm;
1188    bm.setConfig(SkImageInfo::MakeN32Premul(100, 100));
1189    SkPictureRecorder recorder;
1190    SkCanvas* recordingCanvas = recorder.beginRecording(100, 100, NULL, 0);
1191    recordingCanvas->drawBitmap(bm, 0, 0);
1192    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1193
1194    SkCanvas canvas;
1195    canvas.drawPicture(*picture);
1196}
1197#endif
1198
1199static SkData* encode_bitmap_to_data(size_t*, const SkBitmap& bm) {
1200    return SkImageEncoder::EncodeData(bm, SkImageEncoder::kPNG_Type, 100);
1201}
1202
1203static SkData* serialized_picture_from_bitmap(const SkBitmap& bitmap) {
1204    SkPictureRecorder recorder;
1205    SkCanvas* canvas = recorder.beginRecording(bitmap.width(), bitmap.height(), NULL, 0);
1206    canvas->drawBitmap(bitmap, 0, 0);
1207    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1208
1209    SkDynamicMemoryWStream wStream;
1210    picture->serialize(&wStream, &encode_bitmap_to_data);
1211    return wStream.copyToData();
1212}
1213
1214struct ErrorContext {
1215    int fErrors;
1216    skiatest::Reporter* fReporter;
1217};
1218
1219static void assert_one_parse_error_cb(SkError error, void* context) {
1220    ErrorContext* errorContext = static_cast<ErrorContext*>(context);
1221    errorContext->fErrors++;
1222    // This test only expects one error, and that is a kParseError. If there are others,
1223    // there is some unknown problem.
1224    REPORTER_ASSERT_MESSAGE(errorContext->fReporter, 1 == errorContext->fErrors,
1225                            "This threw more errors than expected.");
1226    REPORTER_ASSERT_MESSAGE(errorContext->fReporter, kParseError_SkError == error,
1227                            SkGetLastErrorString());
1228}
1229
1230static void test_bitmap_with_encoded_data(skiatest::Reporter* reporter) {
1231    // Create a bitmap that will be encoded.
1232    SkBitmap original;
1233    make_bm(&original, 100, 100, SK_ColorBLUE, true);
1234    SkDynamicMemoryWStream wStream;
1235    if (!SkImageEncoder::EncodeStream(&wStream, original, SkImageEncoder::kPNG_Type, 100)) {
1236        return;
1237    }
1238    SkAutoDataUnref data(wStream.copyToData());
1239
1240    SkBitmap bm;
1241    bool installSuccess = SkInstallDiscardablePixelRef(
1242         SkDecodingImageGenerator::Create(data, SkDecodingImageGenerator::Options()), &bm);
1243    REPORTER_ASSERT(reporter, installSuccess);
1244
1245    // Write both bitmaps to pictures, and ensure that the resulting data streams are the same.
1246    // Flattening original will follow the old path of performing an encode, while flattening bm
1247    // will use the already encoded data.
1248    SkAutoDataUnref picture1(serialized_picture_from_bitmap(original));
1249    SkAutoDataUnref picture2(serialized_picture_from_bitmap(bm));
1250    REPORTER_ASSERT(reporter, picture1->equals(picture2));
1251    // Now test that a parse error was generated when trying to create a new SkPicture without
1252    // providing a function to decode the bitmap.
1253    ErrorContext context;
1254    context.fErrors = 0;
1255    context.fReporter = reporter;
1256    SkSetErrorCallback(assert_one_parse_error_cb, &context);
1257    SkMemoryStream pictureStream(picture1);
1258    SkClearLastError();
1259    SkAutoUnref pictureFromStream(SkPicture::CreateFromStream(&pictureStream, NULL));
1260    REPORTER_ASSERT(reporter, pictureFromStream.get() != NULL);
1261    SkClearLastError();
1262    SkSetErrorCallback(NULL, NULL);
1263}
1264
1265static void test_clone_empty(skiatest::Reporter* reporter) {
1266    // This is a regression test for crbug.com/172062
1267    // Before the fix, we used to crash accessing a null pointer when we
1268    // had a picture with no paints. This test passes by not crashing.
1269    {
1270        SkPictureRecorder recorder;
1271        recorder.beginRecording(1, 1, NULL, 0);
1272        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1273        SkAutoTUnref<SkPicture> destPicture(picture->clone());
1274        REPORTER_ASSERT(reporter, NULL != destPicture);
1275    }
1276}
1277
1278static void test_draw_empty(skiatest::Reporter* reporter) {
1279    SkBitmap result;
1280    make_bm(&result, 2, 2, SK_ColorBLACK, false);
1281
1282    SkCanvas canvas(result);
1283
1284    {
1285        // stock SkPicture
1286        SkPictureRecorder recorder;
1287        recorder.beginRecording(1, 1, NULL, 0);
1288        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1289
1290        canvas.drawPicture(*picture);
1291    }
1292
1293    {
1294        // tile grid
1295        SkTileGridFactory::TileGridInfo gridInfo;
1296        gridInfo.fMargin.setEmpty();
1297        gridInfo.fOffset.setZero();
1298        gridInfo.fTileInterval.set(1, 1);
1299
1300        SkTileGridFactory factory(gridInfo);
1301        SkPictureRecorder recorder;
1302        recorder.beginRecording(1, 1, &factory, 0);
1303        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1304
1305        canvas.drawPicture(*picture);
1306    }
1307
1308    {
1309        // RTree
1310        SkRTreeFactory factory;
1311        SkPictureRecorder recorder;
1312        recorder.beginRecording(1, 1, &factory, 0);
1313        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1314
1315        canvas.drawPicture(*picture);
1316    }
1317
1318    {
1319        // quad tree
1320        SkQuadTreeFactory factory;
1321        SkPictureRecorder recorder;
1322        recorder.beginRecording(1, 1, &factory, 0);
1323        SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1324
1325        canvas.drawPicture(*picture);
1326    }
1327}
1328
1329static void test_clip_bound_opt(skiatest::Reporter* reporter) {
1330    // Test for crbug.com/229011
1331    SkRect rect1 = SkRect::MakeXYWH(SkIntToScalar(4), SkIntToScalar(4),
1332                                    SkIntToScalar(2), SkIntToScalar(2));
1333    SkRect rect2 = SkRect::MakeXYWH(SkIntToScalar(7), SkIntToScalar(7),
1334                                    SkIntToScalar(1), SkIntToScalar(1));
1335    SkRect rect3 = SkRect::MakeXYWH(SkIntToScalar(6), SkIntToScalar(6),
1336                                    SkIntToScalar(1), SkIntToScalar(1));
1337
1338    SkPath invPath;
1339    invPath.addOval(rect1);
1340    invPath.setFillType(SkPath::kInverseEvenOdd_FillType);
1341    SkPath path;
1342    path.addOval(rect2);
1343    SkPath path2;
1344    path2.addOval(rect3);
1345    SkIRect clipBounds;
1346    SkPictureRecorder recorder;
1347    // Minimalist test set for 100% code coverage of
1348    // SkPictureRecord::updateClipConservativelyUsingBounds
1349    {
1350        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1351            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1352        canvas->clipPath(invPath, SkRegion::kIntersect_Op);
1353        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1354        REPORTER_ASSERT(reporter, true == nonEmpty);
1355        REPORTER_ASSERT(reporter, 0 == clipBounds.fLeft);
1356        REPORTER_ASSERT(reporter, 0 == clipBounds.fTop);
1357        REPORTER_ASSERT(reporter, 10 == clipBounds.fBottom);
1358        REPORTER_ASSERT(reporter, 10 == clipBounds.fRight);
1359    }
1360    {
1361        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1362            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1363        canvas->clipPath(path, SkRegion::kIntersect_Op);
1364        canvas->clipPath(invPath, SkRegion::kIntersect_Op);
1365        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1366        REPORTER_ASSERT(reporter, true == nonEmpty);
1367        REPORTER_ASSERT(reporter, 7 == clipBounds.fLeft);
1368        REPORTER_ASSERT(reporter, 7 == clipBounds.fTop);
1369        REPORTER_ASSERT(reporter, 8 == clipBounds.fBottom);
1370        REPORTER_ASSERT(reporter, 8 == clipBounds.fRight);
1371    }
1372    {
1373        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1374            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1375        canvas->clipPath(path, SkRegion::kIntersect_Op);
1376        canvas->clipPath(invPath, SkRegion::kUnion_Op);
1377        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1378        REPORTER_ASSERT(reporter, true == nonEmpty);
1379        REPORTER_ASSERT(reporter, 0 == clipBounds.fLeft);
1380        REPORTER_ASSERT(reporter, 0 == clipBounds.fTop);
1381        REPORTER_ASSERT(reporter, 10 == clipBounds.fBottom);
1382        REPORTER_ASSERT(reporter, 10 == clipBounds.fRight);
1383    }
1384    {
1385        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1386            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1387        canvas->clipPath(path, SkRegion::kDifference_Op);
1388        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1389        REPORTER_ASSERT(reporter, true == nonEmpty);
1390        REPORTER_ASSERT(reporter, 0 == clipBounds.fLeft);
1391        REPORTER_ASSERT(reporter, 0 == clipBounds.fTop);
1392        REPORTER_ASSERT(reporter, 10 == clipBounds.fBottom);
1393        REPORTER_ASSERT(reporter, 10 == clipBounds.fRight);
1394    }
1395    {
1396        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1397            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1398        canvas->clipPath(path, SkRegion::kReverseDifference_Op);
1399        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1400        // True clip is actually empty in this case, but the best
1401        // determination we can make using only bounds as input is that the
1402        // clip is included in the bounds of 'path'.
1403        REPORTER_ASSERT(reporter, true == nonEmpty);
1404        REPORTER_ASSERT(reporter, 7 == clipBounds.fLeft);
1405        REPORTER_ASSERT(reporter, 7 == clipBounds.fTop);
1406        REPORTER_ASSERT(reporter, 8 == clipBounds.fBottom);
1407        REPORTER_ASSERT(reporter, 8 == clipBounds.fRight);
1408    }
1409    {
1410        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL,
1411            SkPicture::kUsePathBoundsForClip_RecordingFlag);
1412        canvas->clipPath(path, SkRegion::kIntersect_Op);
1413        canvas->clipPath(path2, SkRegion::kXOR_Op);
1414        bool nonEmpty = canvas->getClipDeviceBounds(&clipBounds);
1415        REPORTER_ASSERT(reporter, true == nonEmpty);
1416        REPORTER_ASSERT(reporter, 6 == clipBounds.fLeft);
1417        REPORTER_ASSERT(reporter, 6 == clipBounds.fTop);
1418        REPORTER_ASSERT(reporter, 8 == clipBounds.fBottom);
1419        REPORTER_ASSERT(reporter, 8 == clipBounds.fRight);
1420    }
1421}
1422
1423/**
1424 * A canvas that records the number of clip commands.
1425 */
1426class ClipCountingCanvas : public SkCanvas {
1427public:
1428    ClipCountingCanvas(int width, int height)
1429        : INHERITED(width, height)
1430        , fClipCount(0){
1431    }
1432
1433    virtual void onClipRect(const SkRect& r,
1434                            SkRegion::Op op,
1435                            ClipEdgeStyle edgeStyle) SK_OVERRIDE {
1436        fClipCount += 1;
1437        this->INHERITED::onClipRect(r, op, edgeStyle);
1438    }
1439
1440    virtual void onClipRRect(const SkRRect& rrect,
1441                             SkRegion::Op op,
1442                             ClipEdgeStyle edgeStyle)SK_OVERRIDE {
1443        fClipCount += 1;
1444        this->INHERITED::onClipRRect(rrect, op, edgeStyle);
1445    }
1446
1447    virtual void onClipPath(const SkPath& path,
1448                            SkRegion::Op op,
1449                            ClipEdgeStyle edgeStyle) SK_OVERRIDE {
1450        fClipCount += 1;
1451        this->INHERITED::onClipPath(path, op, edgeStyle);
1452    }
1453
1454    virtual void onClipRegion(const SkRegion& deviceRgn, SkRegion::Op op) SK_OVERRIDE {
1455        fClipCount += 1;
1456        this->INHERITED::onClipRegion(deviceRgn, op);
1457    }
1458
1459    unsigned getClipCount() const { return fClipCount; }
1460
1461private:
1462    unsigned fClipCount;
1463
1464    typedef SkCanvas INHERITED;
1465};
1466
1467static void test_clip_expansion(skiatest::Reporter* reporter) {
1468    SkPictureRecorder recorder;
1469    SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1470
1471    canvas->clipRect(SkRect::MakeEmpty(), SkRegion::kReplace_Op);
1472    // The following expanding clip should not be skipped.
1473    canvas->clipRect(SkRect::MakeXYWH(4, 4, 3, 3), SkRegion::kUnion_Op);
1474    // Draw something so the optimizer doesn't just fold the world.
1475    SkPaint p;
1476    p.setColor(SK_ColorBLUE);
1477    canvas->drawPaint(p);
1478    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1479
1480    ClipCountingCanvas testCanvas(10, 10);
1481    picture->draw(&testCanvas);
1482
1483    // Both clips should be present on playback.
1484    REPORTER_ASSERT(reporter, testCanvas.getClipCount() == 2);
1485}
1486
1487static void test_hierarchical(skiatest::Reporter* reporter) {
1488    SkBitmap bm;
1489    make_bm(&bm, 10, 10, SK_ColorRED, true);
1490
1491    SkPictureRecorder recorder;
1492
1493    recorder.beginRecording(10, 10, NULL, 0);
1494    SkAutoTUnref<SkPicture> childPlain(recorder.endRecording());
1495    REPORTER_ASSERT(reporter, !childPlain->willPlayBackBitmaps()); // 0
1496
1497    recorder.beginRecording(10, 10, NULL, 0)->drawBitmap(bm, 0, 0);
1498    SkAutoTUnref<SkPicture> childWithBitmap(recorder.endRecording());
1499    REPORTER_ASSERT(reporter, childWithBitmap->willPlayBackBitmaps()); // 1
1500
1501    {
1502        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1503        canvas->drawPicture(*childPlain);
1504        SkAutoTUnref<SkPicture> parentPP(recorder.endRecording());
1505        REPORTER_ASSERT(reporter, !parentPP->willPlayBackBitmaps()); // 0
1506    }
1507    {
1508        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1509        canvas->drawPicture(*childWithBitmap);
1510        SkAutoTUnref<SkPicture> parentPWB(recorder.endRecording());
1511        REPORTER_ASSERT(reporter, parentPWB->willPlayBackBitmaps()); // 1
1512    }
1513    {
1514        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1515        canvas->drawBitmap(bm, 0, 0);
1516        canvas->drawPicture(*childPlain);
1517        SkAutoTUnref<SkPicture> parentWBP(recorder.endRecording());
1518        REPORTER_ASSERT(reporter, parentWBP->willPlayBackBitmaps()); // 1
1519    }
1520    {
1521        SkCanvas* canvas = recorder.beginRecording(10, 10, NULL, 0);
1522        canvas->drawBitmap(bm, 0, 0);
1523        canvas->drawPicture(*childWithBitmap);
1524        SkAutoTUnref<SkPicture> parentWBWB(recorder.endRecording());
1525        REPORTER_ASSERT(reporter, parentWBWB->willPlayBackBitmaps()); // 2
1526    }
1527}
1528
1529static void test_gen_id(skiatest::Reporter* reporter) {
1530
1531    SkPicture empty;
1532
1533    // Empty pictures should still have a valid ID
1534    REPORTER_ASSERT(reporter, empty.uniqueID() != SK_InvalidGenID);
1535
1536    SkPictureRecorder recorder;
1537
1538    SkCanvas* canvas = recorder.beginRecording(1, 1, NULL, 0);
1539    canvas->drawARGB(255, 255, 255, 255);
1540    SkAutoTUnref<SkPicture> hasData(recorder.endRecording());
1541    // picture should have a non-zero id after recording
1542    REPORTER_ASSERT(reporter, hasData->uniqueID() != SK_InvalidGenID);
1543
1544    // both pictures should have different ids
1545    REPORTER_ASSERT(reporter, hasData->uniqueID() != empty.uniqueID());
1546
1547    // test out copy constructor
1548    SkPicture copyWithData(*hasData);
1549    REPORTER_ASSERT(reporter, hasData->uniqueID() == copyWithData.uniqueID());
1550
1551    SkPicture emptyCopy(empty);
1552    REPORTER_ASSERT(reporter, empty.uniqueID() != emptyCopy.uniqueID());
1553
1554    // test out swap
1555    {
1556        SkPicture swapWithData;
1557        uint32_t beforeID1 = swapWithData.uniqueID();
1558        uint32_t beforeID2 = copyWithData.uniqueID();
1559        swapWithData.swap(copyWithData);
1560        REPORTER_ASSERT(reporter, copyWithData.uniqueID() == beforeID1);
1561        REPORTER_ASSERT(reporter, swapWithData.uniqueID() == beforeID2);
1562    }
1563
1564    // test out clone
1565    {
1566        SkAutoTUnref<SkPicture> cloneWithData(hasData->clone());
1567        REPORTER_ASSERT(reporter, hasData->uniqueID() == cloneWithData->uniqueID());
1568
1569        SkAutoTUnref<SkPicture> emptyClone(empty.clone());
1570        REPORTER_ASSERT(reporter, empty.uniqueID() != emptyClone->uniqueID());
1571    }
1572}
1573
1574DEF_TEST(Picture, reporter) {
1575#ifdef SK_DEBUG
1576    test_deleting_empty_playback();
1577    test_serializing_empty_picture();
1578#else
1579    test_bad_bitmap();
1580#endif
1581    test_unbalanced_save_restores(reporter);
1582    test_peephole();
1583#if SK_SUPPORT_GPU
1584    test_gpu_veto(reporter);
1585#endif
1586    test_gatherpixelrefs(reporter);
1587    test_gatherpixelrefsandrects(reporter);
1588    test_bitmap_with_encoded_data(reporter);
1589    test_clone_empty(reporter);
1590    test_draw_empty(reporter);
1591    test_clip_bound_opt(reporter);
1592    test_clip_expansion(reporter);
1593    test_hierarchical(reporter);
1594    test_gen_id(reporter);
1595}
1596
1597#if SK_SUPPORT_GPU
1598DEF_GPUTEST(GPUPicture, reporter, factory) {
1599    test_gpu_picture_optimization(reporter, factory);
1600}
1601#endif
1602
1603static void draw_bitmaps(const SkBitmap bitmap, SkCanvas* canvas) {
1604    const SkPaint paint;
1605    const SkRect rect = { 5.0f, 5.0f, 8.0f, 8.0f };
1606    const SkIRect irect =  { 2, 2, 3, 3 };
1607
1608    // Don't care what these record, as long as they're legal.
1609    canvas->drawBitmap(bitmap, 0.0f, 0.0f, &paint);
1610    canvas->drawBitmapRectToRect(bitmap, &rect, rect, &paint, SkCanvas::kNone_DrawBitmapRectFlag);
1611    canvas->drawBitmapMatrix(bitmap, SkMatrix::I(), &paint);
1612    canvas->drawBitmapNine(bitmap, irect, rect, &paint);
1613    canvas->drawSprite(bitmap, 1, 1);
1614}
1615
1616static void test_draw_bitmaps(SkCanvas* canvas) {
1617    SkBitmap empty;
1618    draw_bitmaps(empty, canvas);
1619    empty.setConfig(SkImageInfo::MakeN32Premul(10, 10));
1620    draw_bitmaps(empty, canvas);
1621}
1622
1623DEF_TEST(Picture_EmptyBitmap, r) {
1624    SkPictureRecorder recorder;
1625    test_draw_bitmaps(recorder.beginRecording(10, 10, NULL, 0));
1626    SkAutoTUnref<SkPicture> picture(recorder.endRecording());
1627}
1628
1629DEF_TEST(Canvas_EmptyBitmap, r) {
1630    SkBitmap dst;
1631    dst.allocN32Pixels(10, 10);
1632    SkCanvas canvas(dst);
1633
1634    test_draw_bitmaps(&canvas);
1635}
1636