po: Update French translation.
[wine] / dlls / wined3d / volume.c
1 /*
2  * Copyright 2002-2005 Jason Edmeades
3  * Copyright 2002-2005 Raphael Junqueira
4  * Copyright 2005 Oliver Stieber
5  * Copyright 2009-2011 Henri Verbeet for CodeWeavers
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #include "config.h"
23 #include "wined3d_private.h"
24
25 WINE_DEFAULT_DEBUG_CHANNEL(d3d_surface);
26
27 /* Context activation is done by the caller. */
28 static void volume_bind_and_dirtify(const struct wined3d_volume *volume, struct wined3d_context *context)
29 {
30     struct wined3d_texture *container = volume->container;
31     DWORD active_sampler;
32
33     /* We don't need a specific texture unit, but after binding the texture the current unit is dirty.
34      * Read the unit back instead of switching to 0, this avoids messing around with the state manager's
35      * gl states. The current texture unit should always be a valid one.
36      *
37      * To be more specific, this is tricky because we can implicitly be called
38      * from sampler() in state.c. This means we can't touch anything other than
39      * whatever happens to be the currently active texture, or we would risk
40      * marking already applied sampler states dirty again. */
41     active_sampler = volume->resource.device->rev_tex_unit_map[context->active_texture];
42
43     if (active_sampler != WINED3D_UNMAPPED_STAGE)
44         device_invalidate_state(volume->resource.device, STATE_SAMPLER(active_sampler));
45
46     container->texture_ops->texture_bind(container, context, FALSE);
47 }
48
49 void volume_add_dirty_box(struct wined3d_volume *volume, const struct wined3d_box *dirty_box)
50 {
51     volume->dirty = TRUE;
52     if (dirty_box)
53     {
54         volume->lockedBox.left = min(volume->lockedBox.left, dirty_box->left);
55         volume->lockedBox.top = min(volume->lockedBox.top, dirty_box->top);
56         volume->lockedBox.front = min(volume->lockedBox.front, dirty_box->front);
57         volume->lockedBox.right = max(volume->lockedBox.right, dirty_box->right);
58         volume->lockedBox.bottom = max(volume->lockedBox.bottom, dirty_box->bottom);
59         volume->lockedBox.back = max(volume->lockedBox.back, dirty_box->back);
60     }
61     else
62     {
63         volume->lockedBox.left = 0;
64         volume->lockedBox.top = 0;
65         volume->lockedBox.front = 0;
66         volume->lockedBox.right = volume->resource.width;
67         volume->lockedBox.bottom = volume->resource.height;
68         volume->lockedBox.back = volume->resource.depth;
69     }
70 }
71
72 void volume_set_container(struct wined3d_volume *volume, struct wined3d_texture *container)
73 {
74     TRACE("volume %p, container %p.\n", volume, container);
75
76     volume->container = container;
77 }
78
79 /* Context activation is done by the caller. */
80 void volume_load(const struct wined3d_volume *volume, struct wined3d_context *context, UINT level, BOOL srgb_mode)
81 {
82     const struct wined3d_gl_info *gl_info = context->gl_info;
83     const struct wined3d_format *format = volume->resource.format;
84
85     TRACE("volume %p, context %p, level %u, srgb %#x, format %s (%#x).\n",
86             volume, context, level, srgb_mode, debug_d3dformat(format->id), format->id);
87
88     volume_bind_and_dirtify(volume, context);
89
90     ENTER_GL();
91     GL_EXTCALL(glTexImage3DEXT(GL_TEXTURE_3D, level, format->glInternal,
92             volume->resource.width, volume->resource.height, volume->resource.depth,
93             0, format->glFormat, format->glType, volume->resource.allocatedMemory));
94     checkGLcall("glTexImage3D");
95     LEAVE_GL();
96
97     /* When adding code releasing volume->resource.allocatedMemory to save
98      * data keep in mind that GL_UNPACK_CLIENT_STORAGE_APPLE is enabled by
99      * default if supported(GL_APPLE_client_storage). Thus do not release
100      * volume->resource.allocatedMemory if GL_APPLE_client_storage is
101      * supported. */
102 }
103
104 /* Do not call while under the GL lock. */
105 static void volume_unload(struct wined3d_resource *resource)
106 {
107     TRACE("texture %p.\n", resource);
108
109     /* The whole content is shadowed on This->resource.allocatedMemory, and
110      * the texture name is managed by the VolumeTexture container. */
111
112     resource_unload(resource);
113 }
114
115 ULONG CDECL wined3d_volume_incref(struct wined3d_volume *volume)
116 {
117     ULONG refcount;
118
119     if (volume->container)
120     {
121         TRACE("Forwarding to container %p.\n", volume->container);
122         return wined3d_texture_incref(volume->container);
123     }
124
125     refcount = InterlockedIncrement(&volume->resource.ref);
126
127     TRACE("%p increasing refcount to %u.\n", volume, refcount);
128
129     return refcount;
130 }
131
132 /* Do not call while under the GL lock. */
133 ULONG CDECL wined3d_volume_decref(struct wined3d_volume *volume)
134 {
135     ULONG refcount;
136
137     if (volume->container)
138     {
139         TRACE("Forwarding to container %p.\n", volume->container);
140         return wined3d_texture_decref(volume->container);
141     }
142
143     refcount = InterlockedDecrement(&volume->resource.ref);
144
145     TRACE("%p decreasing refcount to %u.\n", volume, refcount);
146
147     if (!refcount)
148     {
149         resource_cleanup(&volume->resource);
150         volume->resource.parent_ops->wined3d_object_destroyed(volume->resource.parent);
151         HeapFree(GetProcessHeap(), 0, volume);
152     }
153
154     return refcount;
155 }
156
157 void * CDECL wined3d_volume_get_parent(const struct wined3d_volume *volume)
158 {
159     TRACE("volume %p.\n", volume);
160
161     return volume->resource.parent;
162 }
163
164 DWORD CDECL wined3d_volume_set_priority(struct wined3d_volume *volume, DWORD priority)
165 {
166     return resource_set_priority(&volume->resource, priority);
167 }
168
169 DWORD CDECL wined3d_volume_get_priority(const struct wined3d_volume *volume)
170 {
171     return resource_get_priority(&volume->resource);
172 }
173
174 /* Do not call while under the GL lock. */
175 void CDECL wined3d_volume_preload(struct wined3d_volume *volume)
176 {
177     FIXME("volume %p stub!\n", volume);
178 }
179
180 struct wined3d_resource * CDECL wined3d_volume_get_resource(struct wined3d_volume *volume)
181 {
182     TRACE("volume %p.\n", volume);
183
184     return &volume->resource;
185 }
186
187 HRESULT CDECL wined3d_volume_map(struct wined3d_volume *volume,
188         struct wined3d_map_desc *map_desc, const struct wined3d_box *box, DWORD flags)
189 {
190     TRACE("volume %p, map_desc %p, box %p, flags %#x.\n",
191             volume, map_desc, box, flags);
192
193     if (!volume->resource.allocatedMemory)
194         volume->resource.allocatedMemory = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, volume->resource.size);
195
196     TRACE("allocatedMemory %p.\n", volume->resource.allocatedMemory);
197
198     map_desc->row_pitch = volume->resource.format->byte_count * volume->resource.width; /* Bytes / row */
199     map_desc->slice_pitch = volume->resource.format->byte_count
200             * volume->resource.width * volume->resource.height; /* Bytes / slice */
201     if (!box)
202     {
203         TRACE("No box supplied - all is ok\n");
204         map_desc->data = volume->resource.allocatedMemory;
205         volume->lockedBox.left   = 0;
206         volume->lockedBox.top    = 0;
207         volume->lockedBox.front  = 0;
208         volume->lockedBox.right  = volume->resource.width;
209         volume->lockedBox.bottom = volume->resource.height;
210         volume->lockedBox.back   = volume->resource.depth;
211     }
212     else
213     {
214         TRACE("Lock Box (%p) = l %u, t %u, r %u, b %u, fr %u, ba %u\n",
215                 box, box->left, box->top, box->right, box->bottom, box->front, box->back);
216         map_desc->data = volume->resource.allocatedMemory
217                 + (map_desc->slice_pitch * box->front)     /* FIXME: is front < back or vica versa? */
218                 + (map_desc->row_pitch * box->top)
219                 + (box->left * volume->resource.format->byte_count);
220         volume->lockedBox.left   = box->left;
221         volume->lockedBox.top    = box->top;
222         volume->lockedBox.front  = box->front;
223         volume->lockedBox.right  = box->right;
224         volume->lockedBox.bottom = box->bottom;
225         volume->lockedBox.back   = box->back;
226     }
227
228     if (!(flags & (WINED3DLOCK_NO_DIRTY_UPDATE | WINED3DLOCK_READONLY)))
229     {
230         volume_add_dirty_box(volume, &volume->lockedBox);
231         wined3d_texture_set_dirty(volume->container, TRUE);
232     }
233
234     volume->locked = TRUE;
235
236     TRACE("Returning memory %p, row pitch %d, slice pitch %d.\n",
237             map_desc->data, map_desc->row_pitch, map_desc->slice_pitch);
238
239     return WINED3D_OK;
240 }
241
242 struct wined3d_volume * CDECL wined3d_volume_from_resource(struct wined3d_resource *resource)
243 {
244     return volume_from_resource(resource);
245 }
246
247 HRESULT CDECL wined3d_volume_unmap(struct wined3d_volume *volume)
248 {
249     TRACE("volume %p.\n", volume);
250
251     if (!volume->locked)
252     {
253         WARN("Trying to unlock unlocked volume %p.\n", volume);
254         return WINED3DERR_INVALIDCALL;
255     }
256
257     volume->locked = FALSE;
258     memset(&volume->lockedBox, 0, sizeof(volume->lockedBox));
259
260     return WINED3D_OK;
261 }
262
263 static const struct wined3d_resource_ops volume_resource_ops =
264 {
265     volume_unload,
266 };
267
268 static HRESULT volume_init(struct wined3d_volume *volume, struct wined3d_device *device, UINT width,
269         UINT height, UINT depth, DWORD usage, enum wined3d_format_id format_id, enum wined3d_pool pool,
270         void *parent, const struct wined3d_parent_ops *parent_ops)
271 {
272     const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
273     const struct wined3d_format *format = wined3d_get_format(gl_info, format_id);
274     HRESULT hr;
275
276     if (!gl_info->supported[EXT_TEXTURE3D])
277     {
278         WARN("Volume cannot be created - no volume texture support.\n");
279         return WINED3DERR_INVALIDCALL;
280     }
281
282     hr = resource_init(&volume->resource, device, WINED3D_RTYPE_VOLUME, format,
283             WINED3D_MULTISAMPLE_NONE, 0, usage, pool, width, height, depth,
284             width * height * depth * format->byte_count, parent, parent_ops,
285             &volume_resource_ops);
286     if (FAILED(hr))
287     {
288         WARN("Failed to initialize resource, returning %#x.\n", hr);
289         return hr;
290     }
291
292     volume->lockable = TRUE;
293     volume->locked = FALSE;
294     memset(&volume->lockedBox, 0, sizeof(volume->lockedBox));
295     volume->dirty = TRUE;
296
297     volume_add_dirty_box(volume, NULL);
298
299     return WINED3D_OK;
300 }
301
302 HRESULT CDECL wined3d_volume_create(struct wined3d_device *device, UINT width, UINT height,
303         UINT depth, DWORD usage, enum wined3d_format_id format_id, enum wined3d_pool pool, void *parent,
304         const struct wined3d_parent_ops *parent_ops, struct wined3d_volume **volume)
305 {
306     struct wined3d_volume *object;
307     HRESULT hr;
308
309     TRACE("device %p, width %u, height %u, depth %u, usage %#x, format %s, pool %s\n",
310             device, width, height, depth, usage, debug_d3dformat(format_id), debug_d3dpool(pool));
311     TRACE("parent %p, parent_ops %p, volume %p.\n", parent, parent_ops, volume);
312
313     object = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*object));
314     if (!object)
315     {
316         ERR("Out of memory\n");
317         *volume = NULL;
318         return WINED3DERR_OUTOFVIDEOMEMORY;
319     }
320
321     hr = volume_init(object, device, width, height, depth, usage, format_id, pool, parent, parent_ops);
322     if (FAILED(hr))
323     {
324         WARN("Failed to initialize volume, returning %#x.\n", hr);
325         HeapFree(GetProcessHeap(), 0, object);
326         return hr;
327     }
328
329     TRACE("Created volume %p.\n", object);
330     *volume = object;
331
332     return WINED3D_OK;
333 }