cairo-surface-snapshot.c 9.22 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
67
68
69
static cairo_status_t
_cairo_surface_snapshot_flush (void *abstract_surface)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
70
71
72
73
74
75
76
    cairo_surface_t *target;
    cairo_status_t status;

    target = _cairo_surface_snapshot_get_target (&surface->base);
    cairo_surface_flush (target);
    status = target->status;
    cairo_surface_destroy (target);
77

78
    return status;
79
80
}

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

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

Chris Wilson's avatar
Chris Wilson committed
94
95
96
97
98
99
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;
100
101
102
103
104
105
106
107
108
109
110
111
112
    struct snapshot_extra *extra;
    cairo_status_t status;

    extra = malloc (sizeof (*extra));
    if (unlikely (extra == NULL))
	return _cairo_error (CAIRO_STATUS_NO_MEMORY);

    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);
    }
Chris Wilson's avatar
Chris Wilson committed
113

114
115
    *extra_out = extra;
    return status;
Chris Wilson's avatar
Chris Wilson committed
116
117
118
119
120
}

static void
_cairo_surface_snapshot_release_source_image (void                   *abstract_surface,
					      cairo_image_surface_t  *image,
121
					      void                   *_extra)
Chris Wilson's avatar
Chris Wilson committed
122
{
123
    struct snapshot_extra *extra = _extra;
Chris Wilson's avatar
Chris Wilson committed
124

125
126
127
    _cairo_surface_release_source_image (extra->target, image, extra->extra);
    cairo_surface_destroy (extra->target);
    free (extra);
Chris Wilson's avatar
Chris Wilson committed
128
129
130
131
132
133
134
}

static cairo_bool_t
_cairo_surface_snapshot_get_extents (void                  *abstract_surface,
				     cairo_rectangle_int_t *extents)
{
    cairo_surface_snapshot_t *surface = abstract_surface;
135
136
137
138
139
140
    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
141

142
    return bounded;
Chris Wilson's avatar
Chris Wilson committed
143
144
145
146
}

static const cairo_surface_backend_t _cairo_surface_snapshot_backend = {
    CAIRO_INTERNAL_SURFACE_TYPE_SNAPSHOT,
147
    _cairo_surface_snapshot_finish,
Chris Wilson's avatar
Chris Wilson committed
148
    NULL,
Chris Wilson's avatar
Chris Wilson committed
149
150

    NULL, /* create similar */
151
152
153
    NULL, /* create similar image  */
    NULL, /* map to image */
    NULL, /* unmap image  */
Chris Wilson's avatar
Chris Wilson committed
154

155
    _cairo_surface_snapshot_source,
Chris Wilson's avatar
Chris Wilson committed
156
157
    _cairo_surface_snapshot_acquire_source_image,
    _cairo_surface_snapshot_release_source_image,
158
159
    NULL, /* snapshot */

Chris Wilson's avatar
Chris Wilson committed
160
161
    NULL, /* copy_page */
    NULL, /* show_page */
162

Chris Wilson's avatar
Chris Wilson committed
163
    _cairo_surface_snapshot_get_extents,
164
    NULL, /* get-font-options */
165

166
    _cairo_surface_snapshot_flush,
Chris Wilson's avatar
Chris Wilson committed
167
168
169
170
171
172
173
};

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
174
    cairo_surface_t *clone;
Chris Wilson's avatar
Chris Wilson committed
175
176
177
    void *extra;
    cairo_status_t status;

178
179
180
    TRACE ((stderr, "%s: target=%d\n",
	    __FUNCTION__, snapshot->target->unique_id));

Chris Wilson's avatar
Chris Wilson committed
181
182
183
184
185
186
    /* 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.
     */

187
188
    CAIRO_MUTEX_LOCK (snapshot->mutex);

Chris Wilson's avatar
Chris Wilson committed
189
190
    if (snapshot->target->backend->snapshot != NULL) {
	clone = snapshot->target->backend->snapshot (snapshot->target);
191
192
	if (clone != NULL) {
	    assert (clone->status || ! _cairo_surface_is_snapshot (clone));
Chris Wilson's avatar
Chris Wilson committed
193
	    goto done;
194
	}
Chris Wilson's avatar
Chris Wilson committed
195
196
    }

197
198
199
200
    /* 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
201
202
203
    status = _cairo_surface_acquire_source_image (snapshot->target, &image, &extra);
    if (unlikely (status)) {
	snapshot->target = _cairo_surface_create_in_error (status);
204
	status = _cairo_surface_set_error (surface, status);
205
	goto unlock;
Chris Wilson's avatar
Chris Wilson committed
206
    }
Chris Wilson's avatar
Chris Wilson committed
207
    clone = image->base.backend->snapshot (&image->base);
Chris Wilson's avatar
Chris Wilson committed
208
    _cairo_surface_release_source_image (snapshot->target, image, extra);
Chris Wilson's avatar
Chris Wilson committed
209
210
211
212
213

done:
    status = _cairo_surface_set_error (surface, clone->status);
    snapshot->target = snapshot->clone = clone;
    snapshot->base.type = clone->type;
214
215
unlock:
    CAIRO_MUTEX_UNLOCK (snapshot->mutex);
Chris Wilson's avatar
Chris Wilson committed
216
217
218
}

/**
219
 * _cairo_surface_snapshot:
Chris Wilson's avatar
Chris Wilson committed
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 * @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;

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

Chris Wilson's avatar
Chris Wilson committed
245
246
247
    if (unlikely (surface->status))
	return _cairo_surface_create_in_error (surface->status);

Chris Wilson's avatar
Chris Wilson committed
248
    if (unlikely (surface->finished))
Chris Wilson's avatar
Chris Wilson committed
249
250
251
252
253
	return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_SURFACE_FINISHED));

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

254
    if (_cairo_surface_is_snapshot (surface))
Chris Wilson's avatar
Chris Wilson committed
255
	return cairo_surface_reference (surface);
Chris Wilson's avatar
Chris Wilson committed
256
257
258
259
260
261
262
263
264
265
266
267

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

    snapshot = malloc (sizeof (cairo_surface_snapshot_t));
    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
268
			 NULL, /* device */
Chris Wilson's avatar
Chris Wilson committed
269
			 surface->content);
270
    snapshot->base.type = surface->type;
Chris Wilson's avatar
Chris Wilson committed
271

272
    CAIRO_MUTEX_INIT (snapshot->mutex);
Chris Wilson's avatar
Chris Wilson committed
273
274
275
276
277
278
279
280
281
282
283
284
    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;

285
286
287
    _cairo_surface_attach_snapshot (surface,
				    &snapshot->base,
				    _cairo_surface_snapshot_copy_on_write);
Chris Wilson's avatar
Chris Wilson committed
288
289
290

    return &snapshot->base;
}