1a93bd4289132a9d8e525aa1f5532a05e26c624b
[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                 // Need to make sure a RenderLayer and compositing layer get created for the Canvas
213                 setNeedsStyleRecalc(SyntheticStyleChange);
214             }
215             return m_context.get();
216         }
217     }
218 #else
219     UNUSED_PARAM(attrs);
220 #endif
221     return 0;
222 }
223
224 void HTMLCanvasElement::didDraw(const FloatRect& rect)
225 {
226     clearCopiedImage();
227
228     if (RenderBox* ro = renderBox()) {
229         FloatRect destRect = ro->contentBoxRect();
230         FloatRect r = mapRect(rect, FloatRect(0, 0, size().width(), size().height()), destRect);
231         r.intersect(destRect);
232         if (r.isEmpty() || m_dirtyRect.contains(r))
233             return;
234
235         m_dirtyRect.unite(r);
236         ro->repaintRectangle(enclosingIntRect(m_dirtyRect));
237     }
238
239     notifyObserversCanvasChanged(rect);
240 }
241
242 void HTMLCanvasElement::notifyObserversCanvasChanged(const FloatRect& rect)
243 {
244     HashSet<CanvasObserver*>::iterator end = m_observers.end();
245     for (HashSet<CanvasObserver*>::iterator it = m_observers.begin(); it != end; ++it)
246         (*it)->canvasChanged(this, rect);
247 }
248
249 void HTMLCanvasElement::reset()
250 {
251     if (m_ignoreReset)
252         return;
253
254     bool ok;
255     bool hadImageBuffer = hasCreatedImageBuffer();
256
257     int w = getAttribute(widthAttr).toInt(&ok);
258     if (!ok || w < 0)
259         w = DefaultWidth;
260
261     int h = getAttribute(heightAttr).toInt(&ok);
262     if (!ok || h < 0)
263         h = DefaultHeight;
264
265     if (m_contextStateSaver) {
266         // Reset to the initial graphics context state.
267         m_contextStateSaver->restore();
268         m_contextStateSaver->save();
269     }
270
271     if (m_context && m_context->is2d()) {
272         CanvasRenderingContext2D* context2D = static_cast<CanvasRenderingContext2D*>(m_context.get());
273         context2D->reset();
274     }
275
276     IntSize oldSize = size();
277     IntSize newSize(w, h);
278     float newDeviceScaleFactor = targetDeviceScaleFactor();
279
280     // If the size of an existing buffer matches, we can just clear it instead of reallocating.
281     // This optimization is only done for 2D canvases for now.
282     if (m_hasCreatedImageBuffer && oldSize == newSize && m_deviceScaleFactor == newDeviceScaleFactor && m_context && m_context->is2d()) {
283         if (!m_didClearImageBuffer)
284             clearImageBuffer();
285         return;
286     }
287
288     m_deviceScaleFactor = newDeviceScaleFactor;
289
290     setSurfaceSize(newSize);
291
292 #if ENABLE(WEBGL)
293     if (m_context && m_context->is3d() && oldSize != size())
294         static_cast<WebGLRenderingContext*>(m_context.get())->reshape(width(), height());
295 #endif
296
297     if (RenderObject* renderer = this->renderer()) {
298         if (m_rendererIsCanvas) {
299             if (oldSize != size()) {
300                 toRenderHTMLCanvas(renderer)->canvasSizeChanged();
301 #if USE(ACCELERATED_COMPOSITING)
302                 if (renderBox() && renderBox()->hasAcceleratedCompositing())
303                     renderBox()->contentChanged(CanvasChanged);
304 #endif
305             }
306             if (hadImageBuffer)
307                 renderer->repaint();
308         }
309     }
310
311     HashSet<CanvasObserver*>::iterator end = m_observers.end();
312     for (HashSet<CanvasObserver*>::iterator it = m_observers.begin(); it != end; ++it)
313         (*it)->canvasResized(this);
314 }
315
316 float HTMLCanvasElement::targetDeviceScaleFactor() const
317 {
318 #if ENABLE(HIGH_DPI_CANVAS)
319     return document()->frame() ? document()->frame()->page()->deviceScaleFactor() : 1;
320 #else
321     return 1;
322 #endif
323 }
324
325 bool HTMLCanvasElement::paintsIntoCanvasBuffer() const
326 {
327     ASSERT(m_context);
328 #if USE(IOSURFACE_CANVAS_BACKING_STORE)
329     if (m_context->is2d())
330         return true;
331 #endif
332
333 #if USE(ACCELERATED_COMPOSITING)
334     if (!m_context->isAccelerated())
335         return true;
336
337     if (renderBox() && renderBox()->hasAcceleratedCompositing())
338         return false;
339 #endif
340     return true;
341 }
342
343
344 void HTMLCanvasElement::paint(GraphicsContext* context, const LayoutRect& r, bool useLowQualityScale)
345 {
346     // Clear the dirty rect
347     m_dirtyRect = FloatRect();
348
349     if (context->paintingDisabled())
350         return;
351     
352     if (m_context) {
353         if (!paintsIntoCanvasBuffer() && !document()->printing())
354             return;
355         m_context->paintRenderingResultsToCanvas();
356     }
357
358     if (hasCreatedImageBuffer()) {
359         ImageBuffer* imageBuffer = buffer();
360         if (imageBuffer) {
361             if (m_presentedImage)
362                 context->drawImage(m_presentedImage.get(), ColorSpaceDeviceRGB, pixelSnappedIntRect(r), CompositeSourceOver, DoNotRespectImageOrientation, useLowQualityScale);
363             else
364                 context->drawImageBuffer(imageBuffer, ColorSpaceDeviceRGB, pixelSnappedIntRect(r), CompositeSourceOver, BlendModeNormal, useLowQualityScale);
365         }
366     }
367
368 #if ENABLE(WEBGL)    
369     if (is3D())
370         static_cast<WebGLRenderingContext*>(m_context.get())->markLayerComposited();
371 #endif
372 }
373
374 #if ENABLE(WEBGL)
375 bool HTMLCanvasElement::is3D() const
376 {
377     return m_context && m_context->is3d();
378 }
379 #endif
380
381 void HTMLCanvasElement::makeRenderingResultsAvailable()
382 {
383     if (m_context)
384         m_context->paintRenderingResultsToCanvas();
385 }
386
387 void HTMLCanvasElement::makePresentationCopy()
388 {
389     if (!m_presentedImage) {
390         // The buffer contains the last presented data, so save a copy of it.
391         m_presentedImage = buffer()->copyImage(CopyBackingStore, Unscaled);
392     }
393 }
394
395 void HTMLCanvasElement::clearPresentationCopy()
396 {
397     m_presentedImage.clear();
398 }
399
400 void HTMLCanvasElement::setSurfaceSize(const IntSize& size)
401 {
402     m_size = size;
403     m_hasCreatedImageBuffer = false;
404     m_contextStateSaver.clear();
405     m_imageBuffer.clear();
406     clearCopiedImage();
407 }
408
409 String HTMLCanvasElement::toEncodingMimeType(const String& mimeType)
410 {
411     String lowercaseMimeType = mimeType.lower();
412
413     // FIXME: Make isSupportedImageMIMETypeForEncoding threadsafe (to allow this method to be used on a worker thread).
414     if (mimeType.isNull() || !MIMETypeRegistry::isSupportedImageMIMETypeForEncoding(lowercaseMimeType))
415         lowercaseMimeType = "image/png";
416
417     return lowercaseMimeType;
418 }
419
420 String HTMLCanvasElement::toDataURL(const String& mimeType, const double* quality, ExceptionCode& ec)
421 {
422     if (!m_originClean) {
423         ec = SECURITY_ERR;
424         return String();
425     }
426
427     if (m_size.isEmpty() || !buffer())
428         return String("data:,");
429
430     String encodingMimeType = toEncodingMimeType(mimeType);
431
432 #if USE(CG)
433     // Try to get ImageData first, as that may avoid lossy conversions.
434     RefPtr<ImageData> imageData = getImageData();
435
436     if (imageData)
437         return ImageDataToDataURL(*imageData, encodingMimeType, quality);
438 #endif
439
440     makeRenderingResultsAvailable();
441
442     return buffer()->toDataURL(encodingMimeType, quality);
443 }
444
445 PassRefPtr<ImageData> HTMLCanvasElement::getImageData()
446 {
447     if (!m_context || !m_context->is3d())
448        return 0;
449
450 #if ENABLE(WEBGL)    
451     WebGLRenderingContext* ctx = static_cast<WebGLRenderingContext*>(m_context.get());
452
453     return ctx->paintRenderingResultsToImageData();
454 #else
455     return 0;
456 #endif
457 }
458
459 FloatRect HTMLCanvasElement::convertLogicalToDevice(const FloatRect& logicalRect) const
460 {
461     FloatRect deviceRect(logicalRect);
462     deviceRect.scale(m_deviceScaleFactor);
463
464     float x = floorf(deviceRect.x());
465     float y = floorf(deviceRect.y());
466     float w = ceilf(deviceRect.maxX() - x);
467     float h = ceilf(deviceRect.maxY() - y);
468     deviceRect.setX(x);
469     deviceRect.setY(y);
470     deviceRect.setWidth(w);
471     deviceRect.setHeight(h);
472
473     return deviceRect;
474 }
475
476 FloatSize HTMLCanvasElement::convertLogicalToDevice(const FloatSize& logicalSize) const
477 {
478     float width = ceilf(logicalSize.width() * m_deviceScaleFactor);
479     float height = ceilf(logicalSize.height() * m_deviceScaleFactor);
480     return FloatSize(width, height);
481 }
482
483 FloatSize HTMLCanvasElement::convertDeviceToLogical(const FloatSize& deviceSize) const
484 {
485     float width = ceilf(deviceSize.width() / m_deviceScaleFactor);
486     float height = ceilf(deviceSize.height() / m_deviceScaleFactor);
487     return FloatSize(width, height);
488 }
489
490 SecurityOrigin* HTMLCanvasElement::securityOrigin() const
491 {
492     return document()->securityOrigin();
493 }
494
495 bool HTMLCanvasElement::shouldAccelerate(const IntSize& size) const
496 {
497 #if USE(IOSURFACE_CANVAS_BACKING_STORE)
498     UNUSED_PARAM(size);
499     return document()->settings() && document()->settings()->canvasUsesAcceleratedDrawing();
500 #elif ENABLE(ACCELERATED_2D_CANVAS)
501     if (m_context && !m_context->is2d())
502         return false;
503
504     Settings* settings = document()->settings();
505     if (!settings || !settings->accelerated2dCanvasEnabled())
506         return false;
507
508     // Do not use acceleration for small canvas.
509     if (size.width() * size.height() < settings->minimumAccelerated2dCanvasSize())
510         return false;
511
512     return true;
513 #else
514     UNUSED_PARAM(size);
515     return false;
516 #endif
517 }
518
519 void HTMLCanvasElement::createImageBuffer() const
520 {
521     ASSERT(!m_imageBuffer);
522
523     m_hasCreatedImageBuffer = true;
524     m_didClearImageBuffer = true;
525
526     FloatSize logicalSize = size();
527     FloatSize deviceSize = convertLogicalToDevice(logicalSize);
528     if (!deviceSize.isExpressibleAsIntSize())
529         return;
530
531     if (deviceSize.width() * deviceSize.height() > MaxCanvasArea)
532         return;
533
534     IntSize bufferSize(deviceSize.width(), deviceSize.height());
535     if (!bufferSize.width() || !bufferSize.height())
536         return;
537
538     RenderingMode renderingMode = shouldAccelerate(bufferSize) ? Accelerated : Unaccelerated;
539     m_imageBuffer = ImageBuffer::create(size(), m_deviceScaleFactor, ColorSpaceDeviceRGB, renderingMode);
540     if (!m_imageBuffer)
541         return;
542     m_imageBuffer->context()->setShadowsIgnoreTransforms(true);
543     m_imageBuffer->context()->setImageInterpolationQuality(DefaultInterpolationQuality);
544     if (document()->settings() && !document()->settings()->antialiased2dCanvasEnabled())
545         m_imageBuffer->context()->setShouldAntialias(false);
546     m_imageBuffer->context()->setStrokeThickness(1);
547     m_contextStateSaver = adoptPtr(new GraphicsContextStateSaver(*m_imageBuffer->context()));
548
549     JSC::JSLockHolder lock(scriptExecutionContext()->vm());
550     size_t numBytes = 4 * m_imageBuffer->internalSize().width() * m_imageBuffer->internalSize().height();
551     scriptExecutionContext()->vm()->heap.reportExtraMemoryCost(numBytes);
552
553 #if USE(IOSURFACE_CANVAS_BACKING_STORE) || (ENABLE(ACCELERATED_2D_CANVAS) && USE(ACCELERATED_COMPOSITING))
554     if (m_context && m_context->is2d())
555         // Recalculate compositing requirements if acceleration state changed.
556         const_cast<HTMLCanvasElement*>(this)->setNeedsStyleRecalc(SyntheticStyleChange);
557 #endif
558 }
559
560 GraphicsContext* HTMLCanvasElement::drawingContext() const
561 {
562     return buffer() ? m_imageBuffer->context() : 0;
563 }
564
565 GraphicsContext* HTMLCanvasElement::existingDrawingContext() const
566 {
567     if (!m_hasCreatedImageBuffer)
568         return 0;
569
570     return drawingContext();
571 }
572
573 ImageBuffer* HTMLCanvasElement::buffer() const
574 {
575     if (!m_hasCreatedImageBuffer)
576         createImageBuffer();
577     return m_imageBuffer.get();
578 }
579
580 Image* HTMLCanvasElement::copiedImage() const
581 {
582     if (!m_copiedImage && buffer()) {
583         if (m_context)
584             m_context->paintRenderingResultsToCanvas();
585         m_copiedImage = buffer()->copyImage(CopyBackingStore, Unscaled);
586     }
587     return m_copiedImage.get();
588 }
589
590 void HTMLCanvasElement::clearImageBuffer() const
591 {
592     ASSERT(m_hasCreatedImageBuffer);
593     ASSERT(!m_didClearImageBuffer);
594     ASSERT(m_context);
595
596     m_didClearImageBuffer = true;
597
598     if (m_context->is2d()) {
599         CanvasRenderingContext2D* context2D = static_cast<CanvasRenderingContext2D*>(m_context.get());
600         // No need to undo transforms/clip/etc. because we are called right after the context is reset.
601         context2D->clearRect(0, 0, width(), height());
602     }
603 }
604
605 void HTMLCanvasElement::clearCopiedImage()
606 {
607     m_copiedImage.clear();
608     m_didClearImageBuffer = false;
609 }
610
611 AffineTransform HTMLCanvasElement::baseTransform() const
612 {
613     ASSERT(m_hasCreatedImageBuffer);
614     FloatSize unscaledSize = size();
615     FloatSize deviceSize = convertLogicalToDevice(unscaledSize);
616     IntSize size(deviceSize.width(), deviceSize.height());
617     AffineTransform transform;
618     if (size.width() && size.height())
619         transform.scaleNonUniform(size.width() / unscaledSize.width(), size.height() / unscaledSize.height());
620     return m_imageBuffer->baseTransform() * transform;
621 }
622
623 }