New API for encoding bitmaps during serialization.

include/core/SkPicture.h

 
 /*
  * Copyright 2007 The Android Open Source Project
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 
 #ifndef SkPicture_DEFINED
 #define SkPicture_DEFINED
 
 #include "SkBitmap.h"
 #include "SkRefCnt.h"
 
 class SkBBoxHierarchy;
 class SkCanvas;
 class SkDrawPictureCallback;
+class SkData;
 class SkPicturePlayback;
 class SkPictureRecord;
 class SkStream;
 class SkWStream;
 
 /** \class SkPicture
 
     The SkPicture class records the drawing commands made to a canvas, to
     be played back at a later time.
 */
@@ skipping 134 matching lines @@
     int width() const { return fWidth; }
 
     /** Return the height of the picture's recording canvas. This
         value reflects what was passed to setSize(), and does not necessarily
         reflect the bounds of what has been recorded into the picture.
         @return the height of the picture's recording canvas
     */
     int height() const { return fHeight; }
 
     /**
-     *  Function to encode an SkBitmap to an SkWStream. A function with this
-     *  signature can be passed to serialize() and SkOrderedWriteBuffer. The
-     *  function should return true if it succeeds. Otherwise it should return
-     *  false so that SkOrderedWriteBuffer can switch to another method of
-     *  storing SkBitmaps.
+     *  Function to encode an SkBitmap to an SkData. A function with this
+     *  signature can be passed to serialize() and SkOrderedWriteBuffer.
+     *  Returning NULL will tell the SkOrderedWriteBuffer to use
+     *  SkBitmap::flatten() to store the bitmap.
+     *  @param pixelRefOffset Output parameter, telling the deserializer what

[djsollen, 2013/05/21 14:10:44]

what happens if this is null? Also we usually put output params after input
params.

[scroggo, 2013/05/21 16:14:15]

This is a function signature, so it will depend on the caller and
implementation. In the functions that take EncodeBitmap as a parameter, I have
added comments that they will never call the supplied function pointer with a
NULL pixelRefOffset. My implementations do not check for NULL, since the place
they are used will never have a NULL value passed in.
We seem to be pretty inconsistent about this one, and it is not in the style
guide.

+     *      offset in the bm's pixelRef corresponds to the encoded data.
+     *  @return SkData If non-NULL, holds encoded data representing the passed
+     *      in bitmap. The caller is responsible for calling unref().
      */
-    typedef bool (*EncodeBitmap)(SkWStream*, const SkBitmap&);
+    typedef SkData* (*EncodeBitmap)(size_t* pixelRefOffset, const SkBitmap& bm);
 
     /**
      *  Serialize to a stream. If non NULL, encoder will be used to encode
      *  any bitmaps in the picture.
      */
     void serialize(SkWStream*, EncodeBitmap encoder = NULL) const;
 
 #ifdef SK_BUILD_FOR_ANDROID
     /** Signals that the caller is prematurely done replaying the drawing
         commands. This can be called from a canvas virtual while the picture
@@ skipping 69 matching lines @@
  */
 class SkDrawPictureCallback {
 public:
     SkDrawPictureCallback() {}
     virtual ~SkDrawPictureCallback() {}
     
     virtual bool abortDrawing() = 0;
 };
 
 #endif