1 /************************************************************************** 2 * 3 * Copyright 2009 Younes Manton. 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 VMWARE 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 PIPE_VIDEO_CONTEXT_H 29 #define PIPE_VIDEO_CONTEXT_H 30 31 #include "pipe/p_video_state.h" 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 struct pipe_screen; 38 struct pipe_surface; 39 struct pipe_macroblock; 40 struct pipe_picture_desc; 41 struct pipe_fence_handle; 42 43 /** 44 * Gallium video codec for a specific format/profile 45 */ 46 struct pipe_video_codec 47 { 48 struct pipe_context *context; 49 50 enum pipe_video_profile profile; 51 unsigned level; 52 enum pipe_video_entrypoint entrypoint; 53 enum pipe_video_chroma_format chroma_format; 54 unsigned width; 55 unsigned height; 56 unsigned max_references; 57 bool expect_chunked_decode; 58 59 /** 60 * destroy this video decoder 61 */ 62 void (*destroy)(struct pipe_video_codec *codec); 63 64 /** 65 * start decoding of a new frame 66 */ 67 void (*begin_frame)(struct pipe_video_codec *codec, 68 struct pipe_video_buffer *target, 69 struct pipe_picture_desc *picture); 70 71 /** 72 * decode a macroblock 73 */ 74 void (*decode_macroblock)(struct pipe_video_codec *codec, 75 struct pipe_video_buffer *target, 76 struct pipe_picture_desc *picture, 77 const struct pipe_macroblock *macroblocks, 78 unsigned num_macroblocks); 79 80 /** 81 * decode a bitstream 82 */ 83 void (*decode_bitstream)(struct pipe_video_codec *codec, 84 struct pipe_video_buffer *target, 85 struct pipe_picture_desc *picture, 86 unsigned num_buffers, 87 const void * const *buffers, 88 const unsigned *sizes); 89 90 /** 91 * encode to a bitstream 92 */ 93 void (*encode_bitstream)(struct pipe_video_codec *codec, 94 struct pipe_video_buffer *source, 95 struct pipe_resource *destination, 96 void **feedback); 97 98 /** 99 * Perform post-process effect 100 */ 101 void (*process_frame)(struct pipe_video_codec *codec, 102 struct pipe_video_buffer *source, 103 const struct pipe_vpp_desc *process_properties); 104 105 /** 106 * end decoding of the current frame 107 * returns 0 on success 108 */ 109 int (*end_frame)(struct pipe_video_codec *codec, 110 struct pipe_video_buffer *target, 111 struct pipe_picture_desc *picture); 112 113 /** 114 * flush any outstanding command buffers to the hardware 115 * should be called before a video_buffer is acessed by the gallium frontend again 116 */ 117 void (*flush)(struct pipe_video_codec *codec); 118 119 /** 120 * get encoder feedback 121 */ 122 void (*get_feedback)(struct pipe_video_codec *codec, 123 void *feedback, 124 unsigned *size, 125 struct pipe_enc_feedback_metadata* metadata /* opt NULL */); 126 127 /** 128 * Get decoder fence. 129 * 130 * Can be used to query the status of the previous decode job denoted by 131 * 'fence' given 'timeout'. 132 * 133 * A pointer to a fence pointer can be passed to the codecs before the 134 * end_frame vfunc and the codec should then be responsible for allocating a 135 * fence on command stream submission. 136 */ 137 int (*get_decoder_fence)(struct pipe_video_codec *codec, 138 struct pipe_fence_handle *fence, 139 uint64_t timeout); 140 141 /** 142 * Get processor fence. 143 * 144 * Can be used to query the status of the previous process job denoted by 145 * 'fence' given 'timeout'. 146 * 147 * A pointer to a fence pointer can be passed to the codecs before the 148 * end_frame vfunc and the codec should then be responsible for allocating a 149 * fence on command stream submission. 150 */ 151 int (*get_processor_fence)(struct pipe_video_codec *codec, 152 struct pipe_fence_handle *fence, 153 uint64_t timeout); 154 155 /** 156 * Get feedback fence. 157 * 158 * Can be used to query the status of the previous process job denoted by 159 * 'fence' given 'timeout'. 160 * 161 * A pointer to a fence pointer can be passed to the codecs before the 162 * end_frame vfunc and the codec should then be responsible for allocating a 163 * fence on command stream submission. 164 */ 165 int (*get_feedback_fence)(struct pipe_video_codec *codec, 166 struct pipe_fence_handle *fence, 167 uint64_t timeout); 168 169 /** 170 * Destroy fence. 171 */ 172 void (*destroy_fence)(struct pipe_video_codec *codec, 173 struct pipe_fence_handle *fence); 174 175 /** 176 * Update target buffer address. 177 * 178 * Due to reallocation, target buffer address has changed, and the 179 * changed buffer will need to update to decoder so that when this buffer 180 * used as a reference frame, decoder can obtain its recorded information. 181 * Failed updating this buffer will miss reference frames and 182 * cause image corruption in the sebsequent output. 183 * If no target buffer change, this call is not necessary. 184 */ 185 void (*update_decoder_target)(struct pipe_video_codec *codec, 186 struct pipe_video_buffer *old, 187 struct pipe_video_buffer *updated); 188 189 /** 190 * Gets the bitstream headers for a given pipe_picture_desc 191 * of an encode operation 192 * 193 * User passes a buffer and its allocated size and 194 * driver writes the bitstream headers in the buffer, 195 * updating the size parameter as well. 196 * 197 * Returns 0 on success or an errno error code otherwise. 198 * such as ENOMEM if the buffer passed was not big enough 199 */ 200 int (*get_encode_headers)(struct pipe_video_codec *codec, 201 struct pipe_picture_desc *picture, 202 void* bitstream_buf, 203 unsigned *size); 204 205 /** 206 * Creates a DPB buffer used for a single reconstructed picture. 207 */ 208 struct pipe_video_buffer *(*create_dpb_buffer)(struct pipe_video_codec *codec, 209 struct pipe_picture_desc *picture, 210 const struct pipe_video_buffer *templat); 211 }; 212 213 /** 214 * output for decoding / input for displaying 215 */ 216 struct pipe_video_buffer 217 { 218 struct pipe_context *context; 219 220 enum pipe_format buffer_format; 221 unsigned width; 222 unsigned height; 223 bool interlaced; 224 unsigned bind; 225 bool contiguous_planes; 226 227 /** 228 * destroy this video buffer 229 */ 230 void (*destroy)(struct pipe_video_buffer *buffer); 231 232 /** 233 * get an individual resource for each plane, 234 * only returns existing resources by reference 235 */ 236 void (*get_resources)(struct pipe_video_buffer *buffer, struct pipe_resource **resources); 237 238 /** 239 * get an individual sampler view for each plane 240 */ 241 struct pipe_sampler_view **(*get_sampler_view_planes)(struct pipe_video_buffer *buffer); 242 243 /** 244 * get an individual sampler view for each component 245 */ 246 struct pipe_sampler_view **(*get_sampler_view_components)(struct pipe_video_buffer *buffer); 247 248 /** 249 * get an individual surfaces for each plane 250 */ 251 struct pipe_surface **(*get_surfaces)(struct pipe_video_buffer *buffer); 252 253 /* 254 * auxiliary associated data 255 */ 256 void *associated_data; 257 258 /* 259 * codec where the associated data came from 260 */ 261 struct pipe_video_codec *codec; 262 263 /* 264 * destroy the associated data 265 */ 266 void (*destroy_associated_data)(void *associated_data); 267 268 /* 269 * encoded frame statistics for this particular picture 270 */ 271 void *statistics_data; 272 }; 273 274 #ifdef __cplusplus 275 } 276 #endif 277 278 #endif /* PIPE_VIDEO_CONTEXT_H */ 279