src/gallium/auxiliary/vl/vl_video_buffer.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2011 Christian König.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef vl_video_buffer_h
  29 #define vl_video_buffer_h
  30
  31 #include "pipe/p_context.h"
  32 #include "pipe/p_video_codec.h"
  33
  34 #include "vl_defines.h"
  35
  36 /**
  37  * implementation of a planar ycbcr buffer
  38  */
  39
  40 /* planar buffer for vl data upload and manipulation */
  41 struct vl_video_buffer
  42 {
  43    struct pipe_video_buffer base;
  44    unsigned                 num_planes;
  45    struct pipe_resource     *resources[VL_NUM_COMPONENTS];
  46    struct pipe_sampler_view *sampler_view_planes[VL_NUM_COMPONENTS];
  47    struct pipe_sampler_view *sampler_view_components[VL_NUM_COMPONENTS];
  48    struct pipe_surface      *surfaces[VL_MAX_SURFACES];
  49 };
  50
  51 /**
  52  * get subformats for each plane
  53  */
  54 const enum pipe_format *
  55 vl_video_buffer_formats(struct pipe_screen *screen, enum pipe_format format);
  56
  57 /**
  58  * get YUV plane order
  59  */
  60 const unsigned *
  61 vl_video_buffer_plane_order(enum pipe_format format);
  62
  63 /**
  64  * get maximum size of video buffers
  65  */
  66 unsigned
  67 vl_video_buffer_max_size(struct pipe_screen *screen);
  68
  69 /**
  70  * check if video buffer format is supported for a codec/profile
  71  * can be used as default implementation of screen->is_video_format_supported
  72  */
  73 boolean
  74 vl_video_buffer_is_format_supported(struct pipe_screen *screen,
  75                                     enum pipe_format format,
  76                                     enum pipe_video_profile profile,
  77                                     enum pipe_video_entrypoint entrypoint);
  78
  79 /*
  80  * set the associated data for the given video buffer
  81  */
  82 void
  83 vl_video_buffer_set_associated_data(struct pipe_video_buffer *vbuf,
  84                                     struct pipe_video_codec *vcodec,
  85                                     void *associated_data,
  86                                     void (*destroy_associated_data)(void *));
  87
  88 /*
  89  * get the associated data for the given video buffer
  90  */
  91 void *
  92 vl_video_buffer_get_associated_data(struct pipe_video_buffer *vbuf,
  93                                     struct pipe_video_codec *vcodec);
  94
  95 /**
  96  * fill a resource template for the given plane
  97  */
  98 void
  99 vl_video_buffer_template(struct pipe_resource *templ,
 100                          const struct pipe_video_buffer *templat,
 101                          enum pipe_format resource_format,
 102                          unsigned depth, unsigned array_size,
 103                          unsigned usage, unsigned plane);
 104
 105 /**
 106  * creates a video buffer, can be used as a standard implementation for pipe->create_video_buffer
 107  */
 108 struct pipe_video_buffer *
 109 vl_video_buffer_create(struct pipe_context *pipe,
 110                        const struct pipe_video_buffer *templat);
 111
 112 /**
 113  * extended create function, gets depth, array_size, usage and formats for each plane seperately
 114  */
 115 struct pipe_video_buffer *
 116 vl_video_buffer_create_ex(struct pipe_context *pipe,
 117                           const struct pipe_video_buffer *templat,
 118                           const enum pipe_format resource_formats[VL_NUM_COMPONENTS],
 119                           unsigned depth, unsigned array_size, unsigned usage);
 120
 121 /**
 122  * even more extended create function, provide the pipe_resource for each plane
 123  */
 124 struct pipe_video_buffer *
 125 vl_video_buffer_create_ex2(struct pipe_context *pipe,
 126                            const struct pipe_video_buffer *templat,
 127                            struct pipe_resource *resources[VL_NUM_COMPONENTS]);
 128
 129 #endif /* vl_video_buffer_h */