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