cairo-surface-snapshot.c 9.36 KB
Newer Older
Chris Wilson's avatar
Chris Wilson committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/* cairo - a vector graphics library with display and print output
 *
 * Copyright © 2002 University of Southern California
 * Copyright © 2005 Red Hat, Inc.
 * Copyright © 2009 Intel Corporation
 *
 * This library is free software; you can redistribute it and/or
 * modify it either under the terms of the GNU Lesser General Public
 * License version 2.1 as published by the Free Software Foundation
 * (the "LGPL") or, at your option, under the terms of the Mozilla
 * Public License Version 1.1 (the "MPL"). If you do not alter this
 * notice, a recipient may use your version of this file under either
 * the MPL or the LGPL.
 *
 * You should have received a copy of the LGPL along with this library
 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
Andrea Canciani's avatar
Andrea Canciani committed
17
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
Chris Wilson's avatar
Chris Wilson committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 * You should have received a copy of the MPL along with this library
 * in the file COPYING-MPL-1.1
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
 * OF ANY KIND, either express or implied. See the LGPL or the MPL for
 * the specific language governing rights and limitations.
 *
 * The Original Code is the cairo graphics library.
 *
 * The Initial Developer of the Original Code is University of Southern
 * California.
 *
 * Contributor(s):
 *	Carl D. Worth <cworth@cworth.org>
 *      Chris Wilson <chris@chris-wilson.co.uk>
 */

#include "cairoint.h"

#include "cairo-error-private.h"
43
#include "cairo-image-surface-private.h"
44
#include "cairo-surface-snapshot-inline.h"
Chris Wilson's avatar
Chris Wilson committed
45
46
47
48
49

static cairo_status_t
_cairo_surface_snapshot_finish (void *abstract_surface)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
50
    cairo_status_t status = CAIRO_STATUS_SUCCESS;
Chris Wilson's avatar
Chris Wilson committed
51

52
53
    TRACE ((stderr, "%s\n", __FUNCTION__));

54
55
56
    if (surface->clone != NULL) {
	cairo_surface_finish (surface->clone);
	status = surface->clone->status;
Chris Wilson's avatar
Chris Wilson committed
57

58
59
60
	cairo_surface_destroy (surface->clone);
    }

61
62
    CAIRO_MUTEX_FINI (surface->mutex);

63
    return status;
Chris Wilson's avatar
Chris Wilson committed
64
65
}

66
static cairo_status_t
67
_cairo_surface_snapshot_flush (void *abstract_surface, unsigned flags)
68
69
{
    cairo_surface_snapshot_t *surface = abstract_surface;
70
71
72
73
    cairo_surface_t *target;
    cairo_status_t status;

    target = _cairo_surface_snapshot_get_target (&surface->base);
74
75
76
    status = target->status;
    if (status == CAIRO_STATUS_SUCCESS)
	status = _cairo_surface_flush (target, flags);
77
    cairo_surface_destroy (target);
78

79
    return status;
80
81
}

82
83
84
85
86
static cairo_surface_t *
_cairo_surface_snapshot_source (void                    *abstract_surface,
				cairo_rectangle_int_t *extents)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
87
    return _cairo_surface_get_source (surface->target, extents); /* XXX racy */
88
89
}

90
91
92
93
94
struct snapshot_extra {
    cairo_surface_t *target;
    void *extra;
};

Chris Wilson's avatar
Chris Wilson committed
95
96
97
98
99
100
static cairo_status_t
_cairo_surface_snapshot_acquire_source_image (void                    *abstract_surface,
					      cairo_image_surface_t  **image_out,
					      void                   **extra_out)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
101
102
103
    struct snapshot_extra *extra;
    cairo_status_t status;

104
    extra = _cairo_malloc (sizeof (*extra));
105
106
    if (unlikely (extra == NULL)) {
	*extra_out = NULL;
107
	return _cairo_error (CAIRO_STATUS_NO_MEMORY);
108
    }
109
110
111
112
113
114

    extra->target = _cairo_surface_snapshot_get_target (&surface->base);
    status =  _cairo_surface_acquire_source_image (extra->target, image_out, &extra->extra);
    if (unlikely (status)) {
	cairo_surface_destroy (extra->target);
	free (extra);
115
	extra = NULL;
116
    }
Chris Wilson's avatar
Chris Wilson committed
117

118
119
    *extra_out = extra;
    return status;
Chris Wilson's avatar
Chris Wilson committed
120
121
122
123
124
}

static void
_cairo_surface_snapshot_release_source_image (void                   *abstract_surface,
					      cairo_image_surface_t  *image,
125
					      void                   *_extra)
Chris Wilson's avatar
Chris Wilson committed
126
{
127
    struct snapshot_extra *extra = _extra;
Chris Wilson's avatar
Chris Wilson committed
128

129
130
131
    _cairo_surface_release_source_image (extra->target, image, extra->extra);
    cairo_surface_destroy (extra->target);
    free (extra);
Chris Wilson's avatar
Chris Wilson committed
132
133
134
135
136
137
138
}

static cairo_bool_t
_cairo_surface_snapshot_get_extents (void                  *abstract_surface,
				     cairo_rectangle_int_t *extents)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
139
140
141
142
143
144
    cairo_surface_t *target;
    cairo_bool_t bounded;

    target = _cairo_surface_snapshot_get_target (&surface->base);
    bounded = _cairo_surface_get_extents (target, extents);
    cairo_surface_destroy (target);
Chris Wilson's avatar
Chris Wilson committed
145

146
    return bounded;
Chris Wilson's avatar
Chris Wilson committed
147
148
149
150
}

static const cairo_surface_backend_t _cairo_surface_snapshot_backend = {
    CAIRO_INTERNAL_SURFACE_TYPE_SNAPSHOT,
151
    _cairo_surface_snapshot_finish,
Chris Wilson's avatar
Chris Wilson committed
152
    NULL,
Chris Wilson's avatar
Chris Wilson committed
153
154

    NULL, /* create similar */
155
156
157
    NULL, /* create similar image  */
    NULL, /* map to image */
    NULL, /* unmap image  */
Chris Wilson's avatar
Chris Wilson committed
158

159
    _cairo_surface_snapshot_source,
Chris Wilson's avatar
Chris Wilson committed
160
161
    _cairo_surface_snapshot_acquire_source_image,
    _cairo_surface_snapshot_release_source_image,
162
163
    NULL, /* snapshot */

Chris Wilson's avatar
Chris Wilson committed
164
165
    NULL, /* copy_page */
    NULL, /* show_page */
166

Chris Wilson's avatar
Chris Wilson committed
167
    _cairo_surface_snapshot_get_extents,
168
    NULL, /* get-font-options */
169

170
    _cairo_surface_snapshot_flush,
Chris Wilson's avatar
Chris Wilson committed
171
172
173
174
175
176
177
};

static void
_cairo_surface_snapshot_copy_on_write (cairo_surface_t *surface)
{
    cairo_surface_snapshot_t *snapshot = (cairo_surface_snapshot_t *) surface;
    cairo_image_surface_t *image;
Chris Wilson's avatar
Chris Wilson committed
178
    cairo_surface_t *clone;
Chris Wilson's avatar
Chris Wilson committed
179
180
181
    void *extra;
    cairo_status_t status;

182
183
184
    TRACE ((stderr, "%s: target=%d\n",
	    __FUNCTION__, snapshot->target->unique_id));

Chris Wilson's avatar
Chris Wilson committed
185
186
187
188
189
190
    /* We need to make an image copy of the original surface since the
     * snapshot may exceed the lifetime of the original device, i.e.
     * when we later need to use the snapshot the data may have already
     * been lost.
     */

191
192
    CAIRO_MUTEX_LOCK (snapshot->mutex);

Chris Wilson's avatar
Chris Wilson committed
193
194
    if (snapshot->target->backend->snapshot != NULL) {
	clone = snapshot->target->backend->snapshot (snapshot->target);
195
196
	if (clone != NULL) {
	    assert (clone->status || ! _cairo_surface_is_snapshot (clone));
Chris Wilson's avatar
Chris Wilson committed
197
	    goto done;
198
	}
Chris Wilson's avatar
Chris Wilson committed
199
200
    }

201
202
203
204
    /* XXX copy to a similar surface, leave acquisition till later?
     * We should probably leave such decisions to the backend in case we
     * rely upon devices/connections like Xlib.
    */
Chris Wilson's avatar
Chris Wilson committed
205
206
207
    status = _cairo_surface_acquire_source_image (snapshot->target, &image, &extra);
    if (unlikely (status)) {
	snapshot->target = _cairo_surface_create_in_error (status);
208
	status = _cairo_surface_set_error (surface, status);
209
	goto unlock;
Chris Wilson's avatar
Chris Wilson committed
210
    }
Chris Wilson's avatar
Chris Wilson committed
211
    clone = image->base.backend->snapshot (&image->base);
Chris Wilson's avatar
Chris Wilson committed
212
    _cairo_surface_release_source_image (snapshot->target, image, extra);
Chris Wilson's avatar
Chris Wilson committed
213
214
215
216
217

done:
    status = _cairo_surface_set_error (surface, clone->status);
    snapshot->target = snapshot->clone = clone;
    snapshot->base.type = clone->type;
218
219
unlock:
    CAIRO_MUTEX_UNLOCK (snapshot->mutex);
Chris Wilson's avatar
Chris Wilson committed
220
221
222
}

/**
223
 * _cairo_surface_snapshot:
Chris Wilson's avatar
Chris Wilson committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 * @surface: a #cairo_surface_t
 *
 * Make an immutable reference to @surface. It is an error to call a
 * surface-modifying function on the result of this function. The
 * resulting 'snapshot' is a lazily copied-on-write surface i.e. it
 * remains a reference to the original surface until that surface is
 * written to again, at which time a copy is made of the original surface
 * and the snapshot then points to that instead. Multiple snapshots of the
 * same unmodified surface point to the same copy.
 *
 * The caller owns the return value and should call
 * cairo_surface_destroy() when finished with it. This function will not
 * return %NULL, but will return a nil surface instead.
 *
 * Return value: The snapshot surface. Note that the return surface
 * may not necessarily be of the same type as @surface.
 **/
cairo_surface_t *
_cairo_surface_snapshot (cairo_surface_t *surface)
{
    cairo_surface_snapshot_t *snapshot;
    cairo_status_t status;

247
248
    TRACE ((stderr, "%s: target=%d\n", __FUNCTION__, surface->unique_id));

Chris Wilson's avatar
Chris Wilson committed
249
250
251
    if (unlikely (surface->status))
	return _cairo_surface_create_in_error (surface->status);

Chris Wilson's avatar
Chris Wilson committed
252
    if (unlikely (surface->finished))
Chris Wilson's avatar
Chris Wilson committed
253
254
255
256
257
	return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_SURFACE_FINISHED));

    if (surface->snapshot_of != NULL)
	return cairo_surface_reference (surface);

258
    if (_cairo_surface_is_snapshot (surface))
Chris Wilson's avatar
Chris Wilson committed
259
	return cairo_surface_reference (surface);
Chris Wilson's avatar
Chris Wilson committed
260
261
262
263
264
265

    snapshot = (cairo_surface_snapshot_t *)
	_cairo_surface_has_snapshot (surface, &_cairo_surface_snapshot_backend);
    if (snapshot != NULL)
	return cairo_surface_reference (&snapshot->base);

266
    snapshot = _cairo_malloc (sizeof (cairo_surface_snapshot_t));
Chris Wilson's avatar
Chris Wilson committed
267
268
269
270
271
    if (unlikely (snapshot == NULL))
	return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_SURFACE_FINISHED));

    _cairo_surface_init (&snapshot->base,
			 &_cairo_surface_snapshot_backend,
Chris Wilson's avatar
Chris Wilson committed
272
			 NULL, /* device */
273
274
			 surface->content,
			 surface->is_vector);
275
    snapshot->base.type = surface->type;
Chris Wilson's avatar
Chris Wilson committed
276

277
    CAIRO_MUTEX_INIT (snapshot->mutex);
Chris Wilson's avatar
Chris Wilson committed
278
279
280
281
282
283
284
285
286
287
288
289
    snapshot->target = surface;
    snapshot->clone = NULL;

    status = _cairo_surface_copy_mime_data (&snapshot->base, surface);
    if (unlikely (status)) {
	cairo_surface_destroy (&snapshot->base);
	return _cairo_surface_create_in_error (status);
    }

    snapshot->base.device_transform = surface->device_transform;
    snapshot->base.device_transform_inverse = surface->device_transform_inverse;

290
291
292
    _cairo_surface_attach_snapshot (surface,
				    &snapshot->base,
				    _cairo_surface_snapshot_copy_on_write);
Chris Wilson's avatar
Chris Wilson committed
293
294
295

    return &snapshot->base;
}