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 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 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 */
41struct 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
51static inline void
52vl_video_buffer_adjust_size(unsigned *width, unsigned *height, unsigned plane,
53                            enum pipe_video_chroma_format chroma_format,
54                            bool interlaced)
55{
56   if (interlaced) {
57      *height = align(*height, 2) / 2;
58   }
59   if (plane > 0) {
60      if (chroma_format == PIPE_VIDEO_CHROMA_FORMAT_420) {
61         *width = align(*width, 2) / 2;
62         *height = align(*height, 2) / 2;
63      } else if (chroma_format == PIPE_VIDEO_CHROMA_FORMAT_422) {
64         *width = align(*width, 2) / 2;
65      }
66   }
67}
68
69/**
70 * get subformats for each plane
71 */
72void
73vl_get_video_buffer_formats(struct pipe_screen *screen, enum pipe_format format,
74                            enum pipe_format out_format[VL_NUM_COMPONENTS]);
75
76/**
77 * get YUV plane order
78 */
79const unsigned *
80vl_video_buffer_plane_order(enum pipe_format format);
81
82/**
83 * get maximum size of video buffers
84 */
85unsigned
86vl_video_buffer_max_size(struct pipe_screen *screen);
87
88/**
89 * check if video buffer format is supported for a codec/profile
90 * can be used as default implementation of screen->is_video_format_supported
91 */
92bool
93vl_video_buffer_is_format_supported(struct pipe_screen *screen,
94                                    enum pipe_format format,
95                                    enum pipe_video_profile profile,
96                                    enum pipe_video_entrypoint entrypoint);
97
98/*
99 * set the associated data for the given video buffer
100 */
101void
102vl_video_buffer_set_associated_data(struct pipe_video_buffer *vbuf,
103                                    struct pipe_video_codec *vcodec,
104                                    void *associated_data,
105                                    void (*destroy_associated_data)(void *));
106
107/*
108 * get the associated data for the given video buffer
109 */
110void *
111vl_video_buffer_get_associated_data(struct pipe_video_buffer *vbuf,
112                                    struct pipe_video_codec *vcodec);
113
114/**
115 * fill a resource template for the given plane
116 */
117void
118vl_video_buffer_template(struct pipe_resource *templ,
119                         const struct pipe_video_buffer *templat,
120                         enum pipe_format resource_format,
121                         unsigned depth, unsigned array_size,
122                         unsigned usage, unsigned plane,
123                         enum pipe_video_chroma_format chroma_format);
124
125/**
126 * creates a video buffer, can be used as a standard implementation for pipe->create_video_buffer
127 */
128struct pipe_video_buffer *
129vl_video_buffer_create(struct pipe_context *pipe,
130                       const struct pipe_video_buffer *templat);
131
132/**
133 * extended create function, gets depth, array_size, usage and formats for each plane seperately
134 */
135struct pipe_video_buffer *
136vl_video_buffer_create_ex(struct pipe_context *pipe,
137                          const struct pipe_video_buffer *templat,
138                          const enum pipe_format resource_formats[VL_NUM_COMPONENTS],
139                          unsigned depth, unsigned array_size, unsigned usage,
140                          enum pipe_video_chroma_format chroma_format);
141
142/**
143 * even more extended create function, provide the pipe_resource for each plane
144 */
145struct pipe_video_buffer *
146vl_video_buffer_create_ex2(struct pipe_context *pipe,
147                           const struct pipe_video_buffer *templat,
148                           struct pipe_resource *resources[VL_NUM_COMPONENTS]);
149
150/* Create pipe_video_buffer by using resource_create with planar formats. */
151struct pipe_video_buffer *
152vl_video_buffer_create_as_resource(struct pipe_context *pipe,
153                                   const struct pipe_video_buffer *tmpl,
154                                   const uint64_t *modifiers,
155                                   int modifiers_count);
156
157#endif /* vl_video_buffer_h */
158