src/gallium/include/pipe/p_video_decoder.h

   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 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 PIPE_VIDEO_CONTEXT_H
  29 #define PIPE_VIDEO_CONTEXT_H
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include "pipe/p_video_state.h"
  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 decoder for a specific codec/profile
  45  */
  46 struct pipe_video_decoder
  47 {
  48    struct pipe_context *context;
  49
  50    enum pipe_video_profile profile;
  51    enum pipe_video_entrypoint entrypoint;
  52    enum pipe_video_chroma_format chroma_format;
  53    unsigned width;
  54    unsigned height;
  55
  56    /**
  57     * destroy this video decoder
  58     */
  59    void (*destroy)(struct pipe_video_decoder *decoder);
  60
  61    /**
  62     * Creates a decoder buffer
  63     */
  64    void *(*create_buffer)(struct pipe_video_decoder *decoder);
  65
  66    /**
  67     * Destroys a decoder buffer
  68     */
  69    void (*destroy_buffer)(struct pipe_video_decoder *decoder, void *buffer);
  70
  71    /**
  72     * set the current decoder buffer
  73     */
  74    void (*set_decode_buffer)(struct pipe_video_decoder *decoder, void *buffer);
  75
  76    /**
  77     * set the picture parameters for the next frame
  78     * only used for bitstream decoding
  79     */
  80    void (*set_picture_parameters)(struct pipe_video_decoder *decoder,
  81                                   struct pipe_picture_desc *picture);
  82
  83    /**
  84     * set the quantification matrixes
  85     */
  86    void (*set_quant_matrix)(struct pipe_video_decoder *decoder,
  87                             const struct pipe_quant_matrix *matrix);
  88
  89    /**
  90     * set target where video data is decoded to
  91     */
  92    void (*set_decode_target)(struct pipe_video_decoder *decoder,
  93                              struct pipe_video_buffer *target);
  94
  95    /**
  96     * set reference frames for motion compensation
  97     */
  98    void (*set_reference_frames)(struct pipe_video_decoder *decoder,
  99                                 struct pipe_video_buffer **ref_frames,
 100                                 unsigned num_ref_frames);
 101
 102    /**
 103     * start decoding of a new frame
 104     */
 105    void (*begin_frame)(struct pipe_video_decoder *decoder);
 106
 107    /**
 108     * decode a macroblock
 109     */
 110    void (*decode_macroblock)(struct pipe_video_decoder *decoder,
 111                              const struct pipe_macroblock *macroblocks,
 112                              unsigned num_macroblocks);
 113
 114    /**
 115     * decode a bitstream
 116     */
 117    void (*decode_bitstream)(struct pipe_video_decoder *decoder,
 118                             unsigned num_bytes, const void *data);
 119
 120    /**
 121     * end decoding of the current frame
 122     */
 123    void (*end_frame)(struct pipe_video_decoder *decoder);
 124
 125    /**
 126     * flush any outstanding command buffers to the hardware
 127     * should be called before a video_buffer is acessed by the state tracker again
 128     */
 129    void (*flush)(struct pipe_video_decoder *decoder);
 130 };
 131
 132 /**
 133  * output for decoding / input for displaying
 134  */
 135 struct pipe_video_buffer
 136 {
 137    struct pipe_context *context;
 138
 139    enum pipe_format buffer_format;
 140    enum pipe_video_chroma_format chroma_format;
 141    unsigned width;
 142    unsigned height;
 143
 144    /**
 145     * destroy this video buffer
 146     */
 147    void (*destroy)(struct pipe_video_buffer *buffer);
 148
 149    /**
 150     * get a individual sampler view for each plane
 151     */
 152    struct pipe_sampler_view **(*get_sampler_view_planes)(struct pipe_video_buffer *buffer);
 153
 154    /**
 155     * get a individual sampler view for each component
 156     */
 157    struct pipe_sampler_view **(*get_sampler_view_components)(struct pipe_video_buffer *buffer);
 158
 159    /**
 160     * get a individual surfaces for each plane
 161     */
 162    struct pipe_surface **(*get_surfaces)(struct pipe_video_buffer *buffer);
 163 };
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168
 169 #endif /* PIPE_VIDEO_CONTEXT_H */