[g3dvl] rework video buffer format handling
[mesa.git] / src / gallium / include / pipe / p_video_context.h
index 2d59741ec18e889f63bda30ee0ad1e4c7a1cfd24..c9e618b60800eca5ff832074b6a6edf201a4fd00 100644 (file)
@@ -34,11 +34,7 @@ extern "C" {
 
 #include <pipe/p_video_state.h>
 
-/* XXX: Move to an appropriate place */
-#define PIPE_CAP_DECODE_TARGET_PREFERRED_FORMAT 256
-
 struct pipe_screen;
-struct pipe_buffer;
 struct pipe_surface;
 struct pipe_macroblock;
 struct pipe_picture_desc;
@@ -50,129 +46,289 @@ struct pipe_fence_handle;
 struct pipe_video_context
 {
    struct pipe_screen *screen;
-   enum pipe_video_profile profile;
-   enum pipe_video_chroma_format chroma_format;
-   unsigned width;
-   unsigned height;
 
    void *priv; /**< context private data (for DRI for example) */
 
+   /**
+    * destroy context, all objects created from this context
+    * (buffers, decoders, compositors etc...) must be freed before calling this
+    */
+   void (*destroy)(struct pipe_video_context *context);
+
    /**
     * Query an integer-valued capability/parameter/limit
     * \param param  one of PIPE_CAP_x
     */
-   int (*get_param)(struct pipe_video_context *vpipe, int param);
+   int (*get_param)(struct pipe_video_context *context, int param);
 
    /**
-    * Check if the given pipe_format is supported as a texture or
-    * drawing surface.
+    * Check if the given pipe_format is supported as a video buffer
     */
-   boolean (*is_format_supported)(struct pipe_video_context *vpipe,
+   boolean (*is_format_supported)(struct pipe_video_context *context,
                                   enum pipe_format format,
-                                  unsigned usage);
-
-   void (*destroy)(struct pipe_video_context *vpipe);
+                                  enum pipe_video_profile profile);
 
-   struct pipe_surface *(*create_surface)(struct pipe_video_context *vpipe,
+   /**
+    * create a surface of a texture
+    */
+   struct pipe_surface *(*create_surface)(struct pipe_video_context *context,
                                           struct pipe_resource *resource,
-                                          const struct pipe_surface *templat);
+                                          const struct pipe_surface *templ);
 
    /**
-    * Picture decoding and displaying
+    * sampler view handling, used for subpictures for example
     */
    /*@{*/
-   void (*decode_bitstream)(struct pipe_video_context *vpipe,
-                            unsigned num_bufs,
-                            struct pipe_buffer **bitstream_buf);
-
-   void (*decode_macroblocks)(struct pipe_video_context *vpipe,
-                              struct pipe_surface *past,
-                              struct pipe_surface *future,
-                              unsigned num_macroblocks,
-                              struct pipe_macroblock *macroblocks,
-                              struct pipe_fence_handle **fence);
-
-   void (*render_picture)(struct pipe_video_context     *vpipe,
-                          struct pipe_surface           *src_surface,
-                          enum pipe_mpeg12_picture_type picture_type,
-                          /*unsigned                    num_past_surfaces,
-                          struct pipe_surface           *past_surfaces,
-                          unsigned                      num_future_surfaces,
-                          struct pipe_surface           *future_surfaces,*/
-                          struct pipe_video_rect        *src_area,
-                          struct pipe_surface           *dst_surface,
-                          struct pipe_video_rect        *dst_area,
-                          struct pipe_fence_handle      **fence);
 
-   void (*clear_render_target)(struct pipe_video_context *vpipe,
-                               struct pipe_surface *dst,
-                               unsigned dstx, unsigned dsty,
-                               const float *rgba,
-                               unsigned width, unsigned height);
-
-   void (*resource_copy_region)(struct pipe_video_context *vpipe,
-                                struct pipe_resource *dst,
-                                unsigned dstx, unsigned dsty, unsigned dstz,
-                                struct pipe_resource *src,
-                                unsigned srcx, unsigned srcy, unsigned srcz,
-                                unsigned width, unsigned height);
-
-   struct pipe_transfer *(*get_transfer)(struct pipe_video_context *vpipe,
-                                         struct pipe_resource *resource,
-                                         unsigned level,
-                                         unsigned usage,  /* a combination of PIPE_TRANSFER_x */
-                                         const struct pipe_box *box);
-
-   void (*transfer_destroy)(struct pipe_video_context *vpipe,
-                            struct pipe_transfer *transfer);
-
-   void* (*transfer_map)(struct pipe_video_context *vpipe,
-                         struct pipe_transfer *transfer);
-
-   void (*transfer_flush_region)(struct pipe_video_context *vpipe,
-                                 struct pipe_transfer *transfer,
-                                 const struct pipe_box *box);
-
-   void (*transfer_unmap)(struct pipe_video_context *vpipe,
-                          struct pipe_transfer *transfer);
-
-   void (*transfer_inline_write)(struct pipe_video_context *vpipe,
-                                 struct pipe_resource *resource,
-                                 unsigned level,
-                                 unsigned usage, /* a combination of PIPE_TRANSFER_x */
-                                 const struct pipe_box *box,
-                                 const void *data,
-                                 unsigned stride,
-                                 unsigned slice_stride);
+   /**
+    * create a sampler view of a texture, for subpictures for example
+    */
+   struct pipe_sampler_view *(*create_sampler_view)(struct pipe_video_context *context,
+                                                    struct pipe_resource *resource,
+                                                    const struct pipe_sampler_view *templ);
 
-   /*@}*/
+   /**
+    * upload image data to a sampler
+    */
+   void (*upload_sampler)(struct pipe_video_context *context,
+                          struct pipe_sampler_view *dst,
+                          const struct pipe_box *dst_box,
+                          const void *src, unsigned src_stride,
+                          unsigned src_x, unsigned src_y);
+
+   /**
+    * clear a sampler with a specific rgba color
+    */
+   void (*clear_sampler)(struct pipe_video_context *context,
+                         struct pipe_sampler_view *dst,
+                         const struct pipe_box *dst_box,
+                         const float *rgba);
+
+   /*}@*/
+
+   /**
+    * create a decoder for a specific video profile
+    */
+   struct pipe_video_decoder *(*create_decoder)(struct pipe_video_context *context,
+                                                enum pipe_video_profile profile,
+                                                enum pipe_video_entrypoint entrypoint,
+                                                enum pipe_video_chroma_format chroma_format,
+                                                unsigned width, unsigned height);
+
+   /**
+    * Creates a buffer as decoding target
+    */
+   struct pipe_video_buffer *(*create_buffer)(struct pipe_video_context *context,
+                                              enum pipe_format buffer_format,
+                                              enum pipe_video_chroma_format chroma_format,
+                                              unsigned width, unsigned height);
+
+   /**
+    * Creates a video compositor
+    */
+   struct pipe_video_compositor *(*create_compositor)(struct pipe_video_context *context);
+};
+
+/**
+ * decoder for a specific video codec
+ */
+struct pipe_video_decoder
+{
+   struct pipe_video_context *context;
+
+   enum pipe_video_profile profile;
+   enum pipe_video_entrypoint entrypoint;
+   enum pipe_video_chroma_format chroma_format;
+   unsigned width;
+   unsigned height;
+
+   /**
+    * destroy this video decoder
+    */
+   void (*destroy)(struct pipe_video_decoder *decoder);
+
+   /**
+    * Creates a buffer as decoding input
+    */
+   struct pipe_video_decode_buffer *(*create_buffer)(struct pipe_video_decoder *decoder);
 
    /**
-    * Parameter-like states (or properties)
+    * flush decoder buffer to video hardware
+    */
+   void (*flush_buffer)(struct pipe_video_decode_buffer *decbuf,
+                        unsigned num_ycbcr_blocks[3],
+                        struct pipe_video_buffer *ref_frames[2],
+                        struct pipe_video_buffer *dst);
+};
+
+/**
+ * input buffer for a decoder
+ */
+struct pipe_video_decode_buffer
+{
+   struct pipe_video_decoder *decoder;
+
+   /**
+    * destroy this decode buffer
+    */
+   void (*destroy)(struct pipe_video_decode_buffer *decbuf);
+
+   /**
+    * map the input buffer into memory before starting decoding
+    */
+   void (*begin_frame)(struct pipe_video_decode_buffer *decbuf);
+
+   /**
+    * set the quantification matrixes
+    */
+   void (*set_quant_matrix)(struct pipe_video_decode_buffer *decbuf,
+                            const uint8_t intra_matrix[64],
+                            const uint8_t non_intra_matrix[64]);
+
+   /**
+    * get the pointer where to put the ycbcr blocks of a component
+    */
+   struct pipe_ycbcr_block *(*get_ycbcr_stream)(struct pipe_video_decode_buffer *, int component);
+
+   /**
+    * get the pointer where to put the ycbcr dct block data of a component
+    */
+   short *(*get_ycbcr_buffer)(struct pipe_video_decode_buffer *, int component);
+
+   /**
+    * get the stride of the mv buffer
+    */
+   unsigned (*get_mv_stream_stride)(struct pipe_video_decode_buffer *decbuf);
+
+   /**
+    * get the pointer where to put the motion vectors of a ref frame
+    */
+   struct pipe_motionvector *(*get_mv_stream)(struct pipe_video_decode_buffer *decbuf, int ref_frame);
+
+   /**
+    * decode a bitstream
+    */
+   void (*decode_bitstream)(struct pipe_video_decode_buffer *decbuf,
+                            unsigned num_bytes, const void *data,
+                            struct pipe_mpeg12_picture_desc *picture,
+                            unsigned num_ycbcr_blocks[3]);
+
+   /**
+    * unmap decoder buffer before flushing
+    */
+   void (*end_frame)(struct pipe_video_decode_buffer *decbuf);
+};
+
+/**
+ * output for decoding / input for displaying
+ */
+struct pipe_video_buffer
+{
+   struct pipe_video_context *context;
+
+   enum pipe_format buffer_format;
+   enum pipe_video_chroma_format chroma_format;
+   unsigned width;
+   unsigned height;
+
+   /**
+    * destroy this video buffer
+    */
+   void (*destroy)(struct pipe_video_buffer *buffer);
+
+   /**
+    * get a individual sampler view for each plane
+    */
+   struct pipe_sampler_view **(*get_sampler_view_planes)(struct pipe_video_buffer *buffer);
+
+   /**
+    * get a individual sampler view for each component
+    */
+   struct pipe_sampler_view **(*get_sampler_view_components)(struct pipe_video_buffer *buffer);
+
+   /**
+    * get a individual surfaces for each plane
+    */
+   struct pipe_surface **(*get_surfaces)(struct pipe_video_buffer *buffer);
+};
+
+/**
+ * composing and displaying of image data
+ */
+struct pipe_video_compositor
+{
+   struct pipe_video_context *context;
+
+   /**
+    * destroy this compositor
+    */
+   void (*destroy)(struct pipe_video_compositor *compositor);
+
+   /**
+    * set yuv -> rgba conversion matrix
+    */
+   void (*set_csc_matrix)(struct pipe_video_compositor *compositor, const float mat[16]);
+
+   /**
+    * reset dirty area, so it's cleared with the clear colour
+    */
+   void (*reset_dirty_area)(struct pipe_video_compositor *compositor);
+
+   /**
+    * set the clear color
+    */
+   void (*set_clear_color)(struct pipe_video_compositor *compositor, float color[4]);
+
+   /**
+    * set overlay samplers
     */
    /*@{*/
-   void (*set_picture_background)(struct pipe_video_context *vpipe,
-                                  struct pipe_surface *bg,
-                                  struct pipe_video_rect *bg_src_rect);
 
-   void (*set_picture_layers)(struct pipe_video_context *vpipe,
-                              struct pipe_surface *layers[],
-                              struct pipe_video_rect *src_rects[],
-                              struct pipe_video_rect *dst_rects[],
-                              unsigned num_layers);
+   /**
+    * reset all currently set layers
+    */
+   void (*clear_layers)(struct pipe_video_compositor *compositor);
 
-   void (*set_picture_desc)(struct pipe_video_context *vpipe,
-                            const struct pipe_picture_desc *desc);
+   /**
+    * set a video buffer as a layer to render
+    */
+   void (*set_buffer_layer)(struct pipe_video_compositor *compositor,
+                            unsigned layer,
+                            struct pipe_video_buffer *buffer,
+                            struct pipe_video_rect *src_rect,
+                            struct pipe_video_rect *dst_rect);
 
-   void (*set_decode_target)(struct pipe_video_context *vpipe,
-                             struct pipe_surface *dt);
+   /**
+    * set a paletted sampler as a layer to render
+    */
+   void (*set_palette_layer)(struct pipe_video_compositor *compositor,
+                             unsigned layer,
+                             struct pipe_sampler_view *indexes,
+                             struct pipe_sampler_view *palette,
+                             struct pipe_video_rect *src_rect,
+                             struct pipe_video_rect *dst_rect);
 
-   void (*set_csc_matrix)(struct pipe_video_context *vpipe, const float *mat);
+   /**
+    * set a rgba sampler as a layer to render
+    */
+   void (*set_rgba_layer)(struct pipe_video_compositor *compositor,
+                          unsigned layer,
+                          struct pipe_sampler_view *rgba,
+                          struct pipe_video_rect *src_rect,
+                          struct pipe_video_rect *dst_rect);
 
-   /* TODO: Interface for scaling modes, post-processing, etc. */
    /*@}*/
-};
 
+   /**
+    * render the layers to the frontbuffer
+    */
+   void (*render_picture)(struct pipe_video_compositor  *compositor,
+                          enum pipe_mpeg12_picture_type picture_type,
+                          struct pipe_surface           *dst_surface,
+                          struct pipe_video_rect        *dst_area,
+                          struct pipe_fence_handle      **fence);
+
+};
 
 #ifdef __cplusplus
 }