mutter/cogl/cogl-blit.c

439 lines
14 KiB
C
Raw Normal View History

/*
* Cogl
*
This re-licenses Cogl 1.18 under the MIT license Since the Cogl 1.18 branch is actively maintained in parallel with the master branch; this is a counter part to commit 1b83ef938fc16b which re-licensed the master branch to use the MIT license. This re-licensing is a follow up to the proposal that was sent to the Cogl mailing list: http://lists.freedesktop.org/archives/cogl/2013-December/001465.html Note: there was a copyright assignment policy in place for Clutter (and therefore Cogl which was part of Clutter at the time) until the 11th of June 2010 and so we only checked the details after that point (commit 0bbf50f905) For each file, authors were identified via this Git command: $ git blame -p -C -C -C20 -M -M10 0bbf50f905..HEAD We received blanket approvals for re-licensing all Red Hat and Collabora contributions which reduced how many people needed to be contacted individually: - http://lists.freedesktop.org/archives/cogl/2013-December/001470.html - http://lists.freedesktop.org/archives/cogl/2014-January/001536.html Individual approval requests were sent to all the other identified authors who all confirmed the re-license on the Cogl mailinglist: http://lists.freedesktop.org/archives/cogl/2014-January As well as updating the copyright header in all sources files, the COPYING file has been updated to reflect the license change and also document the other licenses used in Cogl such as the SGI Free Software License B, version 2.0 and the 3-clause BSD license. This patch was not simply cherry-picked from master; but the same methodology was used to check the source files.
2014-02-22 01:28:54 +00:00
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2011 Intel Corporation.
*
This re-licenses Cogl 1.18 under the MIT license Since the Cogl 1.18 branch is actively maintained in parallel with the master branch; this is a counter part to commit 1b83ef938fc16b which re-licensed the master branch to use the MIT license. This re-licensing is a follow up to the proposal that was sent to the Cogl mailing list: http://lists.freedesktop.org/archives/cogl/2013-December/001465.html Note: there was a copyright assignment policy in place for Clutter (and therefore Cogl which was part of Clutter at the time) until the 11th of June 2010 and so we only checked the details after that point (commit 0bbf50f905) For each file, authors were identified via this Git command: $ git blame -p -C -C -C20 -M -M10 0bbf50f905..HEAD We received blanket approvals for re-licensing all Red Hat and Collabora contributions which reduced how many people needed to be contacted individually: - http://lists.freedesktop.org/archives/cogl/2013-December/001470.html - http://lists.freedesktop.org/archives/cogl/2014-January/001536.html Individual approval requests were sent to all the other identified authors who all confirmed the re-license on the Cogl mailinglist: http://lists.freedesktop.org/archives/cogl/2014-January As well as updating the copyright header in all sources files, the COPYING file has been updated to reflect the license change and also document the other licenses used in Cogl such as the SGI Free Software License B, version 2.0 and the 3-clause BSD license. This patch was not simply cherry-picked from master; but the same methodology was used to check the source files.
2014-02-22 01:28:54 +00:00
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
This re-licenses Cogl 1.18 under the MIT license Since the Cogl 1.18 branch is actively maintained in parallel with the master branch; this is a counter part to commit 1b83ef938fc16b which re-licensed the master branch to use the MIT license. This re-licensing is a follow up to the proposal that was sent to the Cogl mailing list: http://lists.freedesktop.org/archives/cogl/2013-December/001465.html Note: there was a copyright assignment policy in place for Clutter (and therefore Cogl which was part of Clutter at the time) until the 11th of June 2010 and so we only checked the details after that point (commit 0bbf50f905) For each file, authors were identified via this Git command: $ git blame -p -C -C -C20 -M -M10 0bbf50f905..HEAD We received blanket approvals for re-licensing all Red Hat and Collabora contributions which reduced how many people needed to be contacted individually: - http://lists.freedesktop.org/archives/cogl/2013-December/001470.html - http://lists.freedesktop.org/archives/cogl/2014-January/001536.html Individual approval requests were sent to all the other identified authors who all confirmed the re-license on the Cogl mailinglist: http://lists.freedesktop.org/archives/cogl/2014-January As well as updating the copyright header in all sources files, the COPYING file has been updated to reflect the license change and also document the other licenses used in Cogl such as the SGI Free Software License B, version 2.0 and the 3-clause BSD license. This patch was not simply cherry-picked from master; but the same methodology was used to check the source files.
2014-02-22 01:28:54 +00:00
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
This re-licenses Cogl 1.18 under the MIT license Since the Cogl 1.18 branch is actively maintained in parallel with the master branch; this is a counter part to commit 1b83ef938fc16b which re-licensed the master branch to use the MIT license. This re-licensing is a follow up to the proposal that was sent to the Cogl mailing list: http://lists.freedesktop.org/archives/cogl/2013-December/001465.html Note: there was a copyright assignment policy in place for Clutter (and therefore Cogl which was part of Clutter at the time) until the 11th of June 2010 and so we only checked the details after that point (commit 0bbf50f905) For each file, authors were identified via this Git command: $ git blame -p -C -C -C20 -M -M10 0bbf50f905..HEAD We received blanket approvals for re-licensing all Red Hat and Collabora contributions which reduced how many people needed to be contacted individually: - http://lists.freedesktop.org/archives/cogl/2013-December/001470.html - http://lists.freedesktop.org/archives/cogl/2014-January/001536.html Individual approval requests were sent to all the other identified authors who all confirmed the re-license on the Cogl mailinglist: http://lists.freedesktop.org/archives/cogl/2014-January As well as updating the copyright header in all sources files, the COPYING file has been updated to reflect the license change and also document the other licenses used in Cogl such as the SGI Free Software License B, version 2.0 and the 3-clause BSD license. This patch was not simply cherry-picked from master; but the same methodology was used to check the source files.
2014-02-22 01:28:54 +00:00
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Authors:
* Neil Roberts <neil@linux.intel.com>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include "cogl-util.h"
#include "cogl-blit.h"
#include "cogl-context-private.h"
#include "cogl-framebuffer-private.h"
#include "cogl-texture-private.h"
#include "cogl-texture-2d-private.h"
Add internal _cogl_push_source to optionally disable legacy state Some code in Cogl such as when flushing a stencil clip assumes that it can push a temporary simple pipeline to reset to a known state for internal drawing operations. However this breaks down if the application has set any legacy state because that is set globally so it will also get applied to the internal pipeline. _cogl_draw_attributes already had an internal flag to disable applying the legacy state but I think this is quite awkward to use because not all places that push a pipeline draw the attribute buffers directly so it is difficult to pass the flag down through the layers. Conceptually the legacy state is meant to be like a layer on top of the purely pipeline-based state API so I think ideally we should have an internal function to push the source without the applying the legacy state. The legacy state can't be applied as the pipeline is pushed because the global state can be modified even after it is pushed. This patch adds a _cogl_push_source() function which takes an extra boolean flag to mark whether to enable the legacy state. The value of this flag is stored alongside the pipeline in the pipeline stack. Another new internal function called _cogl_get_enable_legacy_state queries whether the top entry in the pipeline stack has legacy state enabled. cogl-primitives and the vertex array drawing code now use this to determine whether to apply the legacy state when drawing. The COGL_DRAW_SKIP_LEGACY_STATE flag is now removed. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-09-14 11:17:09 +00:00
#include "cogl-private.h"
#include "cogl1-context.h"
static const CoglBlitMode *_cogl_blit_default_mode = NULL;
static CoglBool
_cogl_blit_texture_render_begin (CoglBlitData *data)
{
CoglContext *ctx = data->src_tex->context;
CoglOffscreen *offscreen;
CoglFramebuffer *fb;
CoglPipeline *pipeline;
unsigned int dst_width, dst_height;
CoglError *ignore_error = NULL;
offscreen = _cogl_offscreen_new_with_texture_full
(data->dst_tex, COGL_OFFSCREEN_DISABLE_DEPTH_AND_STENCIL, 0 /* level */);
fb = COGL_FRAMEBUFFER (offscreen);
if (!cogl_framebuffer_allocate (fb, &ignore_error))
{
cogl_error_free (ignore_error);
cogl_object_unref (fb);
return FALSE;
}
data->dest_fb = fb;
dst_width = cogl_texture_get_width (data->dst_tex);
dst_height = cogl_texture_get_height (data->dst_tex);
/* Set up an orthographic projection so we can use pixel
coordinates to render to the texture */
cogl_framebuffer_orthographic (fb,
0, 0, dst_width, dst_height,
-1 /* near */, 1 /* far */);
/* We cache a pipeline used for migrating on to the context so
that it doesn't have to continuously regenerate a shader
program */
if (ctx->blit_texture_pipeline == NULL)
{
ctx->blit_texture_pipeline = cogl_pipeline_new (ctx);
cogl_pipeline_set_layer_filters (ctx->blit_texture_pipeline, 0,
COGL_PIPELINE_FILTER_NEAREST,
COGL_PIPELINE_FILTER_NEAREST);
/* Disable blending by just directly taking the contents of the
source texture */
cogl_pipeline_set_blend (ctx->blit_texture_pipeline,
"RGBA = ADD(SRC_COLOR, 0)",
NULL);
}
pipeline = ctx->blit_texture_pipeline;
cogl_pipeline_set_layer_texture (pipeline, 0, data->src_tex);
data->pipeline = pipeline;
return TRUE;
}
static void
_cogl_blit_texture_render_blit (CoglBlitData *data,
int src_x,
int src_y,
int dst_x,
int dst_y,
int width,
int height)
{
cogl_framebuffer_draw_textured_rectangle (data->dest_fb,
data->pipeline,
dst_x, dst_y,
dst_x + width,
dst_y + height,
src_x / (float) data->src_width,
src_y / (float) data->src_height,
(src_x + width) /
(float) data->src_width,
(src_y + height) /
(float) data->src_height);
}
static void
_cogl_blit_texture_render_end (CoglBlitData *data)
{
CoglContext *ctx = data->src_tex->context;
/* Attach the target texture to the texture render pipeline so that
we don't keep a reference to the source texture forever. This is
assuming that the destination texture will live for a long time
which is currently the case when cogl_blit_* is used from the
atlas code. It may be better in future to keep around a set of
dummy 1x1 textures for each texture target that we could bind
instead. This would also be useful when using a pipeline as a
hash table key such as for the ARBfp program cache. */
cogl_pipeline_set_layer_texture (ctx->blit_texture_pipeline, 0,
data->dst_tex);
cogl_object_unref (data->dest_fb);
}
static CoglBool
_cogl_blit_framebuffer_begin (CoglBlitData *data)
{
CoglContext *ctx = data->src_tex->context;
CoglOffscreen *dst_offscreen = NULL, *src_offscreen = NULL;
CoglFramebuffer *dst_fb, *src_fb;
CoglError *ignore_error = NULL;
/* We can only blit between FBOs if both textures are the same
format and the blit framebuffer extension is supported */
if ((_cogl_texture_get_format (data->src_tex) & ~COGL_A_BIT) !=
(_cogl_texture_get_format (data->dst_tex) & ~COGL_A_BIT) ||
!_cogl_has_private_feature (ctx, COGL_PRIVATE_FEATURE_OFFSCREEN_BLIT))
return FALSE;
dst_offscreen = _cogl_offscreen_new_with_texture_full
(data->dst_tex, COGL_OFFSCREEN_DISABLE_DEPTH_AND_STENCIL, 0 /* level */);
dst_fb = COGL_FRAMEBUFFER (dst_offscreen);
if (!cogl_framebuffer_allocate (dst_fb, &ignore_error))
{
cogl_error_free (ignore_error);
goto error;
}
src_offscreen= _cogl_offscreen_new_with_texture_full
(data->src_tex,
COGL_OFFSCREEN_DISABLE_DEPTH_AND_STENCIL,
0 /* level */);
src_fb = COGL_FRAMEBUFFER (src_offscreen);
if (!cogl_framebuffer_allocate (src_fb, &ignore_error))
{
cogl_error_free (ignore_error);
goto error;
}
data->src_fb = src_fb;
data->dest_fb = dst_fb;
return TRUE;
error:
if (dst_offscreen)
cogl_object_unref (dst_offscreen);
if (src_offscreen)
cogl_object_unref (src_offscreen);
return FALSE;
}
static void
_cogl_blit_framebuffer_blit (CoglBlitData *data,
int src_x,
int src_y,
int dst_x,
int dst_y,
int width,
int height)
{
_cogl_blit_framebuffer (data->src_fb,
data->dest_fb,
src_x, src_y,
dst_x, dst_y,
width, height);
}
static void
_cogl_blit_framebuffer_end (CoglBlitData *data)
{
cogl_object_unref (data->src_fb);
cogl_object_unref (data->dest_fb);
}
static CoglBool
_cogl_blit_copy_tex_sub_image_begin (CoglBlitData *data)
{
CoglOffscreen *offscreen;
CoglFramebuffer *fb;
CoglError *ignore_error = NULL;
/* This will only work if the target texture is a CoglTexture2D */
if (!cogl_is_texture_2d (data->dst_tex))
return FALSE;
offscreen = _cogl_offscreen_new_with_texture_full
(data->src_tex, COGL_OFFSCREEN_DISABLE_DEPTH_AND_STENCIL, 0 /* level */);
fb = COGL_FRAMEBUFFER (offscreen);
if (!cogl_framebuffer_allocate (fb, &ignore_error))
{
cogl_error_free (ignore_error);
cogl_object_unref (fb);
return FALSE;
}
data->src_fb = fb;
return TRUE;
}
static void
_cogl_blit_copy_tex_sub_image_blit (CoglBlitData *data,
int src_x,
int src_y,
int dst_x,
int dst_y,
int width,
int height)
{
_cogl_texture_2d_copy_from_framebuffer (COGL_TEXTURE_2D (data->dst_tex),
src_x, src_y,
width, height,
data->src_fb,
dst_x, dst_y,
0); /* level */
}
static void
_cogl_blit_copy_tex_sub_image_end (CoglBlitData *data)
{
cogl_object_unref (data->src_fb);
}
static CoglBool
_cogl_blit_get_tex_data_begin (CoglBlitData *data)
{
data->format = _cogl_texture_get_format (data->src_tex);
data->bpp = _cogl_pixel_format_get_bytes_per_pixel (data->format);
data->image_data = g_malloc (data->bpp * data->src_width *
data->src_height);
cogl_texture_get_data (data->src_tex, data->format,
data->src_width * data->bpp, data->image_data);
return TRUE;
}
static void
_cogl_blit_get_tex_data_blit (CoglBlitData *data,
int src_x,
int src_y,
int dst_x,
int dst_y,
int width,
int height)
{
CoglError *ignore = NULL;
int rowstride = data->src_width * data->bpp;
int offset = rowstride * src_y + src_x * data->bpp;
_cogl_texture_set_region (data->dst_tex,
width, height,
data->format,
rowstride,
data->image_data + offset,
dst_x, dst_y,
0, /* level */
&ignore);
Allow propogation of OOM errors to apps This allows apps to catch out-of-memory errors when allocating textures. Textures can be pretty huge at times and so it's quite possible for an application to try and allocate more memory than is available. It's also very possible that the application can take some action in response to reduce memory pressure (such as freeing up texture caches perhaps) so we shouldn't just automatically abort like we do for trivial heap allocations. These public functions now take a CoglError argument so applications can catch out of memory errors: cogl_buffer_map cogl_buffer_map_range cogl_buffer_set_data cogl_framebuffer_read_pixels_into_bitmap cogl_pixel_buffer_new cogl_texture_new_from_data cogl_texture_new_from_bitmap Note: we've been quite conservative with how many apis we let throw OOM CoglErrors since we don't really want to put a burdon on developers to be checking for errors with every cogl api call. So long as there is some lower level api for apps to use that let them catch OOM errors for everything necessary that's enough and we don't have to make more convenient apis more awkward to use. The main focus is on bitmaps and texture allocations since they can be particularly large and prone to failing. A new cogl_attribute_buffer_new_with_size() function has been added in case developers need to catch OOM errors when allocating attribute buffers whereby they can first use _buffer_new_with_size() (which doesn't take a CoglError) followed by cogl_buffer_set_data() which will lazily allocate the buffer storage and report OOM errors. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit f7735e141ad537a253b02afa2a8238f96340b978) Note: since we can't break the API for Cogl 1.x then actually the main purpose of cherry picking this patch is to keep in-line with changes on the master branch so that we can easily cherry-pick patches. All the api changes relating stable apis released on the 1.12 branch have been reverted as part of cherry-picking this patch so this most just applies all the internal plumbing changes that enable us to correctly propagate OOM errors.
2012-11-08 17:54:10 +00:00
/* TODO: support chaining up errors during the blit */
}
static void
_cogl_blit_get_tex_data_end (CoglBlitData *data)
{
g_free (data->image_data);
}
/* These should be specified in order of preference */
static const CoglBlitMode
_cogl_blit_modes[] =
{
{
"texture-render",
_cogl_blit_texture_render_begin,
_cogl_blit_texture_render_blit,
_cogl_blit_texture_render_end
},
{
"framebuffer",
_cogl_blit_framebuffer_begin,
_cogl_blit_framebuffer_blit,
_cogl_blit_framebuffer_end
},
{
"copy-tex-sub-image",
_cogl_blit_copy_tex_sub_image_begin,
_cogl_blit_copy_tex_sub_image_blit,
_cogl_blit_copy_tex_sub_image_end
},
{
"get-tex-data",
_cogl_blit_get_tex_data_begin,
_cogl_blit_get_tex_data_blit,
_cogl_blit_get_tex_data_end
}
};
void
_cogl_blit_begin (CoglBlitData *data,
CoglTexture *dst_tex,
CoglTexture *src_tex)
{
int i;
if (_cogl_blit_default_mode == NULL)
{
const char *default_mode_string;
/* Allow the default to be specified with an environment
variable. For the time being these functions are only used
when blitting between atlas textures so the environment
variable is named to be specific to the atlas code. If we
want to use the code in other places we should create another
environment variable for each specific use case */
if ((default_mode_string = g_getenv ("COGL_ATLAS_DEFAULT_BLIT_MODE")))
{
for (i = 0; i < G_N_ELEMENTS (_cogl_blit_modes); i++)
if (!strcmp (_cogl_blit_modes[i].name, default_mode_string))
{
_cogl_blit_default_mode = _cogl_blit_modes + i;
break;
}
if (i >= G_N_ELEMENTS (_cogl_blit_modes))
{
g_warning ("Unknown blit mode %s", default_mode_string);
_cogl_blit_default_mode = _cogl_blit_modes;
}
}
else
/* Default to the first blit mode */
_cogl_blit_default_mode = _cogl_blit_modes;
}
memset (data, 0, sizeof (CoglBlitData));
data->dst_tex = dst_tex;
data->src_tex = src_tex;
data->src_width = cogl_texture_get_width (src_tex);
data->src_height = cogl_texture_get_height (src_tex);
/* Try the default blit mode first */
if (!_cogl_blit_default_mode->begin_func (data))
{
COGL_NOTE (ATLAS, "Failed to set up blit mode %s",
_cogl_blit_default_mode->name);
/* Try all of the other modes in order */
for (i = 0; i < G_N_ELEMENTS (_cogl_blit_modes); i++)
if (_cogl_blit_modes + i != _cogl_blit_default_mode &&
_cogl_blit_modes[i].begin_func (data))
{
/* Use this mode as the default from now on */
_cogl_blit_default_mode = _cogl_blit_modes + i;
break;
}
else
COGL_NOTE (ATLAS,
"Failed to set up blit mode %s",
_cogl_blit_modes[i].name);
/* The last blit mode can't fail so this should never happen */
_COGL_RETURN_IF_FAIL (i < G_N_ELEMENTS (_cogl_blit_modes));
}
data->blit_mode = _cogl_blit_default_mode;
COGL_NOTE (ATLAS, "Setup blit using %s", _cogl_blit_default_mode->name);
}
void
_cogl_blit (CoglBlitData *data,
int src_x,
int src_y,
int dst_x,
int dst_y,
int width,
int height)
{
data->blit_mode->blit_func (data, src_x, src_y, dst_x, dst_y, width, height);
}
void
_cogl_blit_end (CoglBlitData *data)
{
data->blit_mode->end_func (data);
}