Revert the second half of r151257. WebGLRenderingContext::create can return null.
[WebKit-https.git] / Source / WebCore / html / HTMLCanvasElement.cpp
1 /*
2  * Copyright (C) 2004, 2006, 2007 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #include "config.h"
29 #include "HTMLCanvasElement.h"
30
31 #include "Attribute.h"
32 #include "CanvasContextAttributes.h"
33 #include "CanvasGradient.h"
34 #include "CanvasPattern.h"
35 #include "CanvasRenderingContext2D.h"
36 #include "Chrome.h"
37 #include "Document.h"
38 #include "ExceptionCode.h"
39 #include "Frame.h"
40 #include "GraphicsContext.h"
41 #include "HTMLNames.h"
42 #include "ImageBuffer.h"
43 #include "ImageData.h"
44 #include "MIMETypeRegistry.h"
45 #include "Page.h"
46 #include "RenderHTMLCanvas.h"
47 #include "ScriptController.h"
48 #include "Settings.h"
49 #include <math.h>
50 #include <stdio.h>
51
52 #include <runtime/JSLock.h>
53 #include <runtime/Operations.h>
54
55 #if ENABLE(WEBGL)    
56 #include "WebGLContextAttributes.h"
57 #include "WebGLRenderingContext.h"
58 #endif
59
60 namespace WebCore {
61
62 using namespace HTMLNames;
63
64 // These values come from the WhatWG spec.
65 static const int DefaultWidth = 300;
66 static const int DefaultHeight = 150;
67
68 // Firefox limits width/height to 32767 pixels, but slows down dramatically before it
69 // reaches that limit. We limit by area instead, giving us larger maximum dimensions,
70 // in exchange for a smaller maximum canvas size.
71 static const float MaxCanvasArea = 32768 * 8192; // Maximum canvas area in CSS pixels
72
73 HTMLCanvasElement::HTMLCanvasElement(const QualifiedName& tagName, Document* document)
74     : HTMLElement(tagName, document)
75     , m_size(DefaultWidth, DefaultHeight)
76     , m_rendererIsCanvas(false)
77     , m_ignoreReset(false)
78     , m_deviceScaleFactor(targetDeviceScaleFactor())
79     , m_originClean(true)
80     , m_hasCreatedImageBuffer(false)
81     , m_didClearImageBuffer(false)
82 {
83     ASSERT(hasTagName(canvasTag));
84 }
85
86 PassRefPtr<HTMLCanvasElement> HTMLCanvasElement::create(Document* document)
87 {
88     return adoptRef(new HTMLCanvasElement(canvasTag, document));
89 }
90
91 PassRefPtr<HTMLCanvasElement> HTMLCanvasElement::create(const QualifiedName& tagName, Document* document)
92 {
93     return adoptRef(new HTMLCanvasElement(tagName, document));
94 }
95
96 HTMLCanvasElement::~HTMLCanvasElement()
97 {
98     HashSet<CanvasObserver*>::iterator end = m_observers.end();
99     for (HashSet<CanvasObserver*>::iterator it = m_observers.begin(); it != end; ++it)
100         (*it)->canvasDestroyed(this);
101
102     m_context.clear(); // Ensure this goes away before the ImageBuffer.
103 }
104
105 void HTMLCanvasElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
106 {
107     if (name == widthAttr || name == heightAttr)
108         reset();
109     HTMLElement::parseAttribute(name, value);
110 }
111
112 RenderObject* HTMLCanvasElement::createRenderer(RenderArena* arena, RenderStyle* style)
113 {
114     Frame* frame = document()->frame();
115     if (frame && frame->script()->canExecuteScripts(NotAboutToExecuteScript)) {
116         m_rendererIsCanvas = true;
117         return new (arena) RenderHTMLCanvas(this);
118     }
119
120     m_rendererIsCanvas = false;
121     return HTMLElement::createRenderer(arena, style);
122 }
123
124 void HTMLCanvasElement::attach()
125 {
126     setIsInCanvasSubtree(true);
127     HTMLElement::attach();
128 }
129
130 void HTMLCanvasElement::addObserver(CanvasObserver* observer)
131 {
132     m_observers.add(observer);
133 }
134
135 void HTMLCanvasElement::removeObserver(CanvasObserver* observer)
136 {
137     m_observers.remove(observer);
138 }
139
140 void HTMLCanvasElement::setHeight(int value)
141 {
142     setAttribute(heightAttr, String::number(value));
143 }
144
145 void HTMLCanvasElement::setWidth(int value)
146 {
147     setAttribute(widthAttr, String::number(value));
148 }
149
150 #if ENABLE(WEBGL)
151 static bool requiresAcceleratedCompositingForWebGL()
152 {
153 #if PLATFORM(GTK) || PLATFORM(EFL) || PLATFORM(QT)
154     return false;
155 #else
156     return true;
157 #endif
158
159 }
160 static bool shouldEnableWebGL(Settings* settings)
161 {
162     if (!settings)
163         return false;
164
165     if (!settings->webGLEnabled())
166         return false;
167
168     if (!requiresAcceleratedCompositingForWebGL())
169         return true;
170
171     return settings->acceleratedCompositingEnabled();
172 }
173 #endif
174
175 CanvasRenderingContext* HTMLCanvasElement::getContext(const String& type, CanvasContextAttributes* attrs)
176 {
177     // A Canvas can either be "2D" or "webgl" but never both. If you request a 2D canvas and the existing
178     // context is already 2D, just return that. If the existing context is WebGL, then destroy it
179     // before creating a new 2D context. Vice versa when requesting a WebGL canvas. Requesting a
180     // context with any other type string will destroy any existing context.
181     
182     // FIXME - The code depends on the context not going away once created, to prevent JS from
183     // seeing a dangling pointer. So for now we will disallow the context from being changed
184     // once it is created.
185     if (type == "2d") {
186         if (m_context && !m_context->is2d())
187             return 0;
188         if (!m_context) {
189             bool usesDashbardCompatibilityMode = false;
190 #if ENABLE(DASHBOARD_SUPPORT)
191             if (Settings* settings = document()->settings())
192                 usesDashbardCompatibilityMode = settings->usesDashboardBackwardCompatibilityMode();
193 #endif
194             m_context = CanvasRenderingContext2D::create(this, document()->inQuirksMode(), usesDashbardCompatibilityMode);
195 #if USE(IOSURFACE_CANVAS_BACKING_STORE) || (ENABLE(ACCELERATED_2D_CANVAS) && USE(ACCELERATED_COMPOSITING))
196             // Need to make sure a RenderLayer and compositing layer get created for the Canvas
197             setNeedsStyleRecalc(SyntheticStyleChange);
198 #endif
199         }
200         return m_context.get();
201     }
202 #if ENABLE(WEBGL)
203     if (shouldEnableWebGL(document()->settings())) {
204         // Accept the legacy "webkit-3d" name as well as the provisional "experimental-webgl" name.
205         bool is3dContext = (type == "webkit-3d") || (type == "experimental-webgl");
206
207         if (is3dContext) {
208             if (m_context && !m_context->is3d())
209                 return 0;
210             if (!m_context) {
211                 m_context = WebGLRenderingContext::create(this, static_cast<WebGLContextAttributes*>(attrs));
212                 if (m_context) {
213                     // Need to make sure a RenderLayer and compositing layer get created for the Canvas
214                     setNeedsStyleRecalc(SyntheticStyleChange);
215                 }
216             }
217             return m_context.get();
218         }
219     }
220 #else
221     UNUSED_PARAM(attrs);
222 #endif
223     return 0;
224 }
225
226 void HTMLCanvasElement::didDraw(const FloatRect& rect)
227 {
228     clearCopiedImage();
229
230     if (RenderBox* ro = renderBox()) {
231         FloatRect destRect = ro->contentBoxRect();
232         FloatRect r = mapRect(rect, FloatRect(0, 0, size().width(), size().height()), destRect);
233         r.intersect(destRect);
234         if (r.isEmpty() || m_dirtyRect.contains(r))
235             return;
236
237         m_dirtyRect.unite(r);
238         ro->repaintRectangle(enclosingIntRect(m_dirtyRect));
239     }
240
241     notifyObserversCanvasChanged(rect);
242 }
243
244 void HTMLCanvasElement::notifyObserversCanvasChanged(const FloatRect& rect)
245 {
246     HashSet<CanvasObserver*>::iterator end = m_observers.end();
247     for (HashSet<CanvasObserver*>::iterator it = m_observers.begin(); it != end; ++it)
248         (*it)->canvasChanged(this, rect);
249 }
250
251 void HTMLCanvasElement::reset()
252 {
253     if (m_ignoreReset)
254         return;
255
256     bool ok;
257     bool hadImageBuffer = hasCreatedImageBuffer();
258
259     int w = getAttribute(widthAttr).toInt(&ok);
260     if (!ok || w < 0)
261         w = DefaultWidth;
262
263     int h = getAttribute(heightAttr).toInt(&ok);
264     if (!ok || h < 0)
265         h = DefaultHeight;
266
267     if (m_contextStateSaver) {
268         // Reset to the initial graphics context state.
269         m_contextStateSaver->restore();
270         m_contextStateSaver->save();
271     }
272
273     if (m_context && m_context->is2d()) {
274         CanvasRenderingContext2D* context2D = static_cast<CanvasRenderingContext2D*>(m_context.get());
275         context2D->reset();
276     }
277
278     IntSize oldSize = size();
279     IntSize newSize(w, h);
280     float newDeviceScaleFactor = targetDeviceScaleFactor();
281
282     // If the size of an existing buffer matches, we can just clear it instead of reallocating.
283     // This optimization is only done for 2D canvases for now.
284     if (m_hasCreatedImageBuffer && oldSize == newSize && m_deviceScaleFactor == newDeviceScaleFactor && m_context && m_context->is2d()) {
285         if (!m_didClearImageBuffer)
286             clearImageBuffer();
287         return;
288     }
289
290     m_deviceScaleFactor = newDeviceScaleFactor;
291
292     setSurfaceSize(newSize);
293
294 #if ENABLE(WEBGL)
295     if (m_context && m_context->is3d() && oldSize != size())
296         static_cast<WebGLRenderingContext*>(m_context.get())->reshape(width(), height());
297 #endif
298
299     if (RenderObject* renderer = this->renderer()) {
300         if (m_rendererIsCanvas) {
301             if (oldSize != size()) {
302                 toRenderHTMLCanvas(renderer)->canvasSizeChanged();
303 #if USE(ACCELERATED_COMPOSITING)
304                 if (renderBox() && renderBox()->hasAcceleratedCompositing())
305                     renderBox()->contentChanged(CanvasChanged);
306 #endif
307             }
308             if (hadImageBuffer)
309                 renderer->repaint();
310         }
311     }
312
313     HashSet<CanvasObserver*>::iterator end = m_observers.end();
314     for (HashSet<CanvasObserver*>::iterator it = m_observers.begin(); it != end; ++it)
315         (*it)->canvasResized(this);
316 }
317
318 float HTMLCanvasElement::targetDeviceScaleFactor() const
319 {
320 #if ENABLE(HIGH_DPI_CANVAS)
321     return document()->frame() ? document()->frame()->page()->deviceScaleFactor() : 1;
322 #else
323     return 1;
324 #endif
325 }
326
327 bool HTMLCanvasElement::paintsIntoCanvasBuffer() const
328 {
329     ASSERT(m_context);
330 #if USE(IOSURFACE_CANVAS_BACKING_STORE)
331     if (m_context->is2d())
332         return true;
333 #endif
334
335 #if USE(ACCELERATED_COMPOSITING)
336     if (!m_context->isAccelerated())
337         return true;
338
339     if (renderBox() && renderBox()->hasAcceleratedCompositing())
340         return false;
341 #endif
342     return true;
343 }
344
345
346 void HTMLCanvasElement::paint(GraphicsContext* context, const LayoutRect& r, bool useLowQualityScale)
347 {
348     // Clear the dirty rect
349     m_dirtyRect = FloatRect();
350
351     if (context->paintingDisabled())
352         return;
353     
354     if (m_context) {
355         if (!paintsIntoCanvasBuffer() && !document()->printing())
356             return;
357         m_context->paintRenderingResultsToCanvas();
358     }
359
360     if (hasCreatedImageBuffer()) {
361         ImageBuffer* imageBuffer = buffer();
362         if (imageBuffer) {
363             if (m_presentedImage)
364                 context->drawImage(m_presentedImage.get(), ColorSpaceDeviceRGB, pixelSnappedIntRect(r), CompositeSourceOver, DoNotRespectImageOrientation, useLowQualityScale);
365             else
366                 context->drawImageBuffer(imageBuffer, ColorSpaceDeviceRGB, pixelSnappedIntRect(r), CompositeSourceOver, BlendModeNormal, useLowQualityScale);
367         }
368     }
369
370 #if ENABLE(WEBGL)    
371     if (is3D())
372         static_cast<WebGLRenderingContext*>(m_context.get())->markLayerComposited();
373 #endif
374 }
375
376 #if ENABLE(WEBGL)
377 bool HTMLCanvasElement::is3D() const
378 {
379     return m_context && m_context->is3d();
380 }
381 #endif
382
383 void HTMLCanvasElement::makeRenderingResultsAvailable()
384 {
385     if (m_context)
386         m_context->paintRenderingResultsToCanvas();
387 }
388
389 void HTMLCanvasElement::makePresentationCopy()
390 {
391     if (!m_presentedImage) {
392         // The buffer contains the last presented data, so save a copy of it.
393         m_presentedImage = buffer()->copyImage(CopyBackingStore, Unscaled);
394     }
395 }
396
397 void HTMLCanvasElement::clearPresentationCopy()
398 {
399     m_presentedImage.clear();
400 }
401
402 void HTMLCanvasElement::setSurfaceSize(const IntSize& size)
403 {
404     m_size = size;
405     m_hasCreatedImageBuffer = false;
406     m_contextStateSaver.clear();
407     m_imageBuffer.clear();
408     clearCopiedImage();
409 }
410
411 String HTMLCanvasElement::toEncodingMimeType(const String& mimeType)
412 {
413     String lowercaseMimeType = mimeType.lower();
414
415     // FIXME: Make isSupportedImageMIMETypeForEncoding threadsafe (to allow this method to be used on a worker thread).
416     if (mimeType.isNull() || !MIMETypeRegistry::isSupportedImageMIMETypeForEncoding(lowercaseMimeType))
417         lowercaseMimeType = "image/png";
418
419     return lowercaseMimeType;
420 }
421
422 String HTMLCanvasElement::toDataURL(const String& mimeType, const double* quality, ExceptionCode& ec)
423 {
424     if (!m_originClean) {
425         ec = SECURITY_ERR;
426         return String();
427     }
428
429     if (m_size.isEmpty() || !buffer())
430         return String("data:,");
431
432     String encodingMimeType = toEncodingMimeType(mimeType);
433
434 #if USE(CG)
435     // Try to get ImageData first, as that may avoid lossy conversions.
436     RefPtr<ImageData> imageData = getImageData();
437
438     if (imageData)
439         return ImageDataToDataURL(*imageData, encodingMimeType, quality);
440 #endif
441
442     makeRenderingResultsAvailable();
443
444     return buffer()->toDataURL(encodingMimeType, quality);
445 }
446
447 PassRefPtr<ImageData> HTMLCanvasElement::getImageData()
448 {
449     if (!m_context || !m_context->is3d())
450        return 0;
451
452 #if ENABLE(WEBGL)    
453     WebGLRenderingContext* ctx = static_cast<WebGLRenderingContext*>(m_context.get());
454
455     return ctx->paintRenderingResultsToImageData();
456 #else
457     return 0;
458 #endif
459 }
460
461 FloatRect HTMLCanvasElement::convertLogicalToDevice(const FloatRect& logicalRect) const
462 {
463     FloatRect deviceRect(logicalRect);
464     deviceRect.scale(m_deviceScaleFactor);
465
466     float x = floorf(deviceRect.x());
467     float y = floorf(deviceRect.y());
468     float w = ceilf(deviceRect.maxX() - x);
469     float h = ceilf(deviceRect.maxY() - y);
470     deviceRect.setX(x);
471     deviceRect.setY(y);
472     deviceRect.setWidth(w);
473     deviceRect.setHeight(h);
474
475     return deviceRect;
476 }
477
478 FloatSize HTMLCanvasElement::convertLogicalToDevice(const FloatSize& logicalSize) const
479 {
480     float width = ceilf(logicalSize.width() * m_deviceScaleFactor);
481     float height = ceilf(logicalSize.height() * m_deviceScaleFactor);
482     return FloatSize(width, height);
483 }
484
485 FloatSize HTMLCanvasElement::convertDeviceToLogical(const FloatSize& deviceSize) const
486 {
487     float width = ceilf(deviceSize.width() / m_deviceScaleFactor);
488     float height = ceilf(deviceSize.height() / m_deviceScaleFactor);
489     return FloatSize(width, height);
490 }
491
492 SecurityOrigin* HTMLCanvasElement::securityOrigin() const
493 {
494     return document()->securityOrigin();
495 }
496
497 bool HTMLCanvasElement::shouldAccelerate(const IntSize& size) const
498 {
499 #if USE(IOSURFACE_CANVAS_BACKING_STORE)
500     UNUSED_PARAM(size);
501     return document()->settings() && document()->settings()->canvasUsesAcceleratedDrawing();
502 #elif ENABLE(ACCELERATED_2D_CANVAS)
503     if (m_context && !m_context->is2d())
504         return false;
505
506     Settings* settings = document()->settings();
507     if (!settings || !settings->accelerated2dCanvasEnabled())
508         return false;
509
510     // Do not use acceleration for small canvas.
511     if (size.width() * size.height() < settings->minimumAccelerated2dCanvasSize())
512         return false;
513
514     return true;
515 #else
516     UNUSED_PARAM(size);
517     return false;
518 #endif
519 }
520
521 void HTMLCanvasElement::createImageBuffer() const
522 {
523     ASSERT(!m_imageBuffer);
524
525     m_hasCreatedImageBuffer = true;
526     m_didClearImageBuffer = true;
527
528     FloatSize logicalSize = size();
529     FloatSize deviceSize = convertLogicalToDevice(logicalSize);
530     if (!deviceSize.isExpressibleAsIntSize())
531         return;
532
533     if (deviceSize.width() * deviceSize.height() > MaxCanvasArea)
534         return;
535
536     IntSize bufferSize(deviceSize.width(), deviceSize.height());
537     if (!bufferSize.width() || !bufferSize.height())
538         return;
539
540     RenderingMode renderingMode = shouldAccelerate(bufferSize) ? Accelerated : Unaccelerated;
541     m_imageBuffer = ImageBuffer::create(size(), m_deviceScaleFactor, ColorSpaceDeviceRGB, renderingMode);
542     if (!m_imageBuffer)
543         return;
544     m_imageBuffer->context()->setShadowsIgnoreTransforms(true);
545     m_imageBuffer->context()->setImageInterpolationQuality(DefaultInterpolationQuality);
546     if (document()->settings() && !document()->settings()->antialiased2dCanvasEnabled())
547         m_imageBuffer->context()->setShouldAntialias(false);
548     m_imageBuffer->context()->setStrokeThickness(1);
549     m_contextStateSaver = adoptPtr(new GraphicsContextStateSaver(*m_imageBuffer->context()));
550
551     JSC::JSLockHolder lock(scriptExecutionContext()->vm());
552     size_t numBytes = 4 * m_imageBuffer->internalSize().width() * m_imageBuffer->internalSize().height();
553     scriptExecutionContext()->vm()->heap.reportExtraMemoryCost(numBytes);
554
555 #if USE(IOSURFACE_CANVAS_BACKING_STORE) || (ENABLE(ACCELERATED_2D_CANVAS) && USE(ACCELERATED_COMPOSITING))
556     if (m_context && m_context->is2d())
557         // Recalculate compositing requirements if acceleration state changed.
558         const_cast<HTMLCanvasElement*>(this)->setNeedsStyleRecalc(SyntheticStyleChange);
559 #endif
560 }
561
562 GraphicsContext* HTMLCanvasElement::drawingContext() const
563 {
564     return buffer() ? m_imageBuffer->context() : 0;
565 }
566
567 GraphicsContext* HTMLCanvasElement::existingDrawingContext() const
568 {
569     if (!m_hasCreatedImageBuffer)
570         return 0;
571
572     return drawingContext();
573 }
574
575 ImageBuffer* HTMLCanvasElement::buffer() const
576 {
577     if (!m_hasCreatedImageBuffer)
578         createImageBuffer();
579     return m_imageBuffer.get();
580 }
581
582 Image* HTMLCanvasElement::copiedImage() const
583 {
584     if (!m_copiedImage && buffer()) {
585         if (m_context)
586             m_context->paintRenderingResultsToCanvas();
587         m_copiedImage = buffer()->copyImage(CopyBackingStore, Unscaled);
588     }
589     return m_copiedImage.get();
590 }
591
592 void HTMLCanvasElement::clearImageBuffer() const
593 {
594     ASSERT(m_hasCreatedImageBuffer);
595     ASSERT(!m_didClearImageBuffer);
596     ASSERT(m_context);
597
598     m_didClearImageBuffer = true;
599
600     if (m_context->is2d()) {
601         CanvasRenderingContext2D* context2D = static_cast<CanvasRenderingContext2D*>(m_context.get());
602         // No need to undo transforms/clip/etc. because we are called right after the context is reset.
603         context2D->clearRect(0, 0, width(), height());
604     }
605 }
606
607 void HTMLCanvasElement::clearCopiedImage()
608 {
609     m_copiedImage.clear();
610     m_didClearImageBuffer = false;
611 }
612
613 AffineTransform HTMLCanvasElement::baseTransform() const
614 {
615     ASSERT(m_hasCreatedImageBuffer);
616     FloatSize unscaledSize = size();
617     FloatSize deviceSize = convertLogicalToDevice(unscaledSize);
618     IntSize size(deviceSize.width(), deviceSize.height());
619     AffineTransform transform;
620     if (size.width() && size.height())
621         transform.scaleNonUniform(size.width() / unscaledSize.width(), size.height() / unscaledSize.height());
622     return m_imageBuffer->baseTransform() * transform;
623 }
624
625 }