Blob creation methods for ImageBitmap.

Source/modules/imagebitmap/ImageBitmapFactories.cpp

+/*
+ * Copyright (c) 2013, Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+#include "modules/imagebitmap/ImageBitmapFactories.h"
+
+#include "RuntimeEnabledFeatures.h"
+#include "V8ImageBitmap.h"
+#include "bindings/v8/ExceptionState.h"
+#include "bindings/v8/ScriptScope.h"
+#include "bindings/v8/ScriptState.h"
+#include "core/html/HTMLCanvasElement.h"
+#include "core/html/HTMLImageElement.h"
+#include "core/html/HTMLVideoElement.h"
+#include "core/html/ImageData.h"
+#include "core/html/canvas/CanvasRenderingContext2D.h"
+#include "core/page/DOMWindow.h"
+#include "core/page/ImageBitmap.h"
+#include "core/platform/SharedBuffer.h"
+#include "core/platform/graphics/BitmapImage.h"
+#include "core/platform/graphics/ImageSource.h"
+#include "core/platform/graphics/skia/NativeImageSkia.h"
+
+namespace WebCore {
+
+static LayoutSize sizeFor(HTMLImageElement* image)
+{
+    if (ImageResource* cachedImage = image->cachedImage())
+        return cachedImage->imageSizeForRenderer(image->renderer(), 1.0f); // FIXME: Not sure about this.
+    return IntSize();
+}
+
+static IntSize sizeFor(HTMLVideoElement* video)
+{
+    if (MediaPlayer* player = video->player())
+        return player->naturalSize();
+    return IntSize();
+}
+
+static ScriptObject fulfillImageBitmap(ScriptExecutionContext* context, PassRefPtr<ImageBitmap> imageBitmap)
+{
+    // Promises must be enabled.
+    ASSERT(RuntimeEnabledFeatures::promiseEnabled());
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(context);
+    resolver->fulfill(imageBitmap);
+    return resolver->promise();
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLImageElement* image, ExceptionState& es)
+{
+    LayoutSize s = sizeFor(image);
+    return createImageBitmap(eventTarget, image, 0, 0, s.width(), s.height(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLImageElement* image, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    if (!image) {
+        es.throwTypeError();
+        return ScriptObject();
+    }
+    if (!image->cachedImage()) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (image->cachedImage()->image()->isSVGImage()) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    if (!image->cachedImage()->image()->hasSingleSecurityOrigin()) {
+        es.throwDOMException(SecurityError);
+        return ScriptObject();
+    }
+    if (!image->cachedImage()->passesAccessControlCheck(eventTarget->toDOMWindow()->document()->securityOrigin())
+    && eventTarget->toDOMWindow()->document()->securityOrigin()->taintsCanvas(image->src())) {
+        es.throwDOMException(SecurityError);
+        return ScriptObject();
+    }
+    // FIXME: make ImageBitmap creation asynchronous crbug.com/258082
+    return fulfillImageBitmap(eventTarget->scriptExecutionContext(), ImageBitmap::create(image, IntRect(sx, sy, sw, sh)));
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLVideoElement* video, ExceptionState& es)
+{
+    IntSize s = sizeFor(video);
+    return createImageBitmap(eventTarget, video, 0, 0, s.width(), s.height(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLVideoElement* video, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    if (!video) {
+        es.throwTypeError();
+        return ScriptObject();
+    }
+    if (!video->player()) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (video->networkState() == HTMLMediaElement::NETWORK_EMPTY) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (video->player()->readyState() <= MediaPlayer::HaveMetadata) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    if (!video->hasSingleSecurityOrigin()) {
+        es.throwDOMException(SecurityError);
+        return ScriptObject();
+    }
+    if (!video->player()->didPassCORSAccessCheck() && eventTarget->toDOMWindow()->document()->securityOrigin()->taintsCanvas(video->currentSrc())) {
+        es.throwDOMException(SecurityError);
+        return ScriptObject();
+    }
+    // FIXME: make ImageBitmap creation asynchronous crbug.com/258082
+    return fulfillImageBitmap(eventTarget->scriptExecutionContext(), ImageBitmap::create(video, IntRect(sx, sy, sw, sh)));
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, CanvasRenderingContext2D* context, ExceptionState& es)
+{
+    return createImageBitmap(eventTarget, context->canvas(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, CanvasRenderingContext2D* context, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    return createImageBitmap(eventTarget, context->canvas(), sx, sy, sw, sh, es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLCanvasElement* canvas, ExceptionState& es)
+{
+    return createImageBitmap(eventTarget, canvas, 0, 0, canvas->width(), canvas->height(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, HTMLCanvasElement* canvas, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    if (!canvas) {
+        es.throwTypeError();
+        return ScriptObject();
+    }
+    if (!canvas->originClean()) {
+        es.throwDOMException(InvalidStateError);
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    // FIXME: make ImageBitmap creation asynchronous crbug.com/258082
+    return fulfillImageBitmap(eventTarget->scriptExecutionContext(), ImageBitmap::create(canvas, IntRect(sx, sy, sw, sh)));
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, Blob* blob, ExceptionState& es)
+{
+    // Promises must be enabled.
+    ASSERT(RuntimeEnabledFeatures::promiseEnabled());
+
+    if (!blob) {
+        es.throwDOMException(TypeError);
+        return ScriptObject();
+    }
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(eventTarget->scriptExecutionContext());
+    RefPtr<ImageBitmapLoader> loader = ImageBitmapFactories::ImageBitmapLoader::create(from(eventTarget->toDOMWindow()), resolver, IntRect(0, 0, 0, 0));
+    from(eventTarget->toDOMWindow())->addLoader(loader);
+    loader->loadBlobAsync(eventTarget->scriptExecutionContext(), blob);
+    return resolver->promise();
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, Blob* blob, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    // Promises must be enabled.
+    ASSERT(RuntimeEnabledFeatures::promiseEnabled());
+
+    if (!blob) {
+        es.throwDOMException(TypeError);
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(eventTarget->scriptExecutionContext());
+    RefPtr<ImageBitmapLoader> loader = ImageBitmapFactories::ImageBitmapLoader::create(from(eventTarget->toDOMWindow()), resolver, IntRect(sx, sy, sw, sh));
+    from(eventTarget->toDOMWindow())->addLoader(loader);
+    loader->loadBlobAsync(eventTarget->scriptExecutionContext(), blob);
+    return resolver->promise();
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, ImageData* data, ExceptionState& es)
+{
+    return createImageBitmap(eventTarget, data, 0, 0, data->width(), data->height(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, ImageData* data, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    if (!data) {
+        es.throwTypeError();
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    // FIXME: make ImageBitmap creation asynchronous crbug.com/258082
+    return fulfillImageBitmap(eventTarget->scriptExecutionContext(), ImageBitmap::create(data, IntRect(sx, sy, sw, sh)));
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, ImageBitmap* bitmap, ExceptionState& es)
+{
+    return createImageBitmap(eventTarget, bitmap, 0, 0, bitmap->width(), bitmap->height(), es);
+}
+
+ScriptObject ImageBitmapFactories::createImageBitmap(EventTarget* eventTarget, ImageBitmap* bitmap, int sx, int sy, int sw, int sh, ExceptionState& es)
+{
+    if (!bitmap) {
+        es.throwTypeError();
+        return ScriptObject();
+    }
+    if (!sw || !sh) {
+        es.throwDOMException(IndexSizeError);
+        return ScriptObject();
+    }
+    // FIXME: make ImageBitmap creation asynchronous crbug.com/258082
+    return fulfillImageBitmap(eventTarget->scriptExecutionContext(), ImageBitmap::create(bitmap, IntRect(sx, sy, sw, sh)));
+}
+
+const char* ImageBitmapFactories::supplementName()
+{
+    return "ImageBitmapFactories";
+}
+
+ImageBitmapFactories* ImageBitmapFactories::from(DOMWindow* window)
+{
+    ImageBitmapFactories* supplement = static_cast<ImageBitmapFactories*>(Supplement<DOMWindow>::from(window, supplementName()));
+    if (!supplement) {
+        supplement = new ImageBitmapFactories();
+        provideTo(window, supplementName(), adoptPtr(supplement));

[Stephen White, 2013/08/14 14:39:13]

Nit: kind of a style thing, but I prefer that you immediately adoptRef() what is
returned by new into a local RefPtr, even if you then pass ownership elsewhere.
It's easy to forget to adoptPtr() when constructing a PassRefPtr in the argument
list.

i.e., something like:

RefPtr<ImageBitmapFactories> newFactories = adoptRef(new
ImageBitmapFactories());
provideTo(window, supplementName(), newFactories);
supplement = newFactories;

If you're in the habit of adoptRef(new ...), it's easier to spot potential leaks
from new objects which are not adopted.

[Stephen White, 2013/08/14 15:16:18]

Matthew pointed out to me that this is an OwnPtr not a RefPtr, and that
provideTo() wants a PassOwnPtr to the base class, not the derived class. Which
makes this kind of tricky.

I suppose you could do:
OwnPtr<ImageBitmapFactories> newFactories = adoptPtr(new
ImageBitmapFactories());
supplement = newFactories.get();
provideTo(window, supplementName(), newFactories.release());

but feel free to leave it as-is, if that's standard practice in the other
Supplements.

+    }
+    return supplement;
+}
+
+void ImageBitmapFactories::addLoader(PassRefPtr<ImageBitmapLoader> loader)
+{
+    m_pendingLoaders.add(loader);
+}
+
+void ImageBitmapFactories::didFinishLoading(ImageBitmapLoader* loader)
+{
+    ASSERT(m_pendingLoaders.contains(loader));
+    m_pendingLoaders.remove(loader);
+}
+
+ImageBitmapFactories::ImageBitmapLoader::ImageBitmapLoader(ImageBitmapFactories* factory, PassRefPtr<ScriptPromiseResolver> resolver, const IntRect& cropRect)
+    : m_loader(FileReaderLoader::ReadAsArrayBuffer, this)
+    , m_scriptState(ScriptState::current())
+    , m_factory(factory)
+    , m_resolver(resolver)
+    , m_cropRect(cropRect)
+{
+}
+
+void ImageBitmapFactories::ImageBitmapLoader::loadBlobAsync(ScriptExecutionContext* context, Blob* blob)
+{
+    m_loader.start(context, *blob);
+}
+
+void ImageBitmapFactories::ImageBitmapLoader::rejectPromise()
+{
+    ScriptScope scope(m_scriptState);
+    m_resolver->reject(ScriptValue::createNull());
+    m_factory->didFinishLoading(this);
+}
+
+void ImageBitmapFactories::ImageBitmapLoader::didFinishLoading()
+{
+    if (!m_loader.arrayBufferResult()) {
+        rejectPromise();
+        return;
+    }
+    RefPtr<SharedBuffer> sharedBuffer = SharedBuffer::create((char*)m_loader.arrayBufferResult()->data(), m_loader.arrayBufferResult()->byteLength());
+
+    OwnPtr<ImageSource> source = adoptPtr(new ImageSource());
+    source->setData(sharedBuffer.get(), true);
+    RefPtr<NativeImageSkia> imageSkia = source->createFrameAtIndex(0);
+    if (!imageSkia) {
+        rejectPromise();
+        return;
+    }
+
+    RefPtr<Image> image = BitmapImage::create(imageSkia);
+    if (!image->width() || !image->height()) {
+        rejectPromise();
+        return;
+    }
+    if (!m_cropRect.width() && !m_cropRect.height()) {
+        // No cropping variant was called.
+        m_cropRect = IntRect(IntPoint(), image->size());
+    }
+
+    RefPtr<ImageBitmap> imageBitmap = ImageBitmap::create(image.get(), m_cropRect);
+    ScriptScope scope(m_scriptState);
+    m_resolver->fulfill(imageBitmap.release());
+    m_factory->didFinishLoading(this);
+}
+
+void ImageBitmapFactories::ImageBitmapLoader::didFail(FileError::ErrorCode)
+{
+    rejectPromise();
+}
+
+} // namespace WebCore