surfaceproxy: add TFF property.
[profile/ivi/gstreamer-vaapi.git] / gst-libs / gst / vaapi / gstvaapisurfaceproxy.h
1 /*
2  *  gstvaapisurfaceproxy.h - VA surface proxy
3  *
4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
5  *  Copyright (C) 2011-2012 Intel Corporation
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Lesser General Public License
9  *  as published by the Free Software Foundation; either version 2.1
10  *  of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Lesser General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Lesser General Public
18  *  License along with this library; if not, write to the Free
19  *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  *  Boston, MA 02110-1301 USA
21  */
22
23 #ifndef GST_VAAPI_SURFACE_PROXY_H
24 #define GST_VAAPI_SURFACE_PROXY_H
25
26 #include <glib-object.h>
27 #include <gst/vaapi/gstvaapicontext.h>
28 #include <gst/vaapi/gstvaapisurface.h>
29
30 G_BEGIN_DECLS
31
32 #define GST_VAAPI_TYPE_SURFACE_PROXY \
33     (gst_vaapi_surface_proxy_get_type())
34
35 #define GST_VAAPI_SURFACE_PROXY(obj)                            \
36     (G_TYPE_CHECK_INSTANCE_CAST((obj),                          \
37                                 GST_VAAPI_TYPE_SURFACE_PROXY,   \
38                                 GstVaapiSurfaceProxy))
39
40 #define GST_VAAPI_SURFACE_PROXY_CLASS(klass)                    \
41     (G_TYPE_CHECK_CLASS_CAST((klass),                           \
42                              GST_VAAPI_TYPE_SURFACE_PROXY,      \
43                              GstVaapiSurfaceProxyClass))
44
45 #define GST_VAAPI_IS_SURFACE_PROXY(obj) \
46     (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_VAAPI_TYPE_SURFACE_PROXY))
47
48 #define GST_VAAPI_IS_SURFACE_PROXY_CLASS(klass) \
49     (G_TYPE_CHECK_CLASS_TYPE((klass), GST_VAAPI_TYPE_SURFACE_PROXY))
50
51 #define GST_VAAPI_SURFACE_PROXY_GET_CLASS(obj)                  \
52     (G_TYPE_INSTANCE_GET_CLASS((obj),                           \
53                                GST_VAAPI_TYPE_SURFACE_PROXY,    \
54                                GstVaapiSurfaceProxyClass))
55
56 /**
57  * GST_VAAPI_SURFACE_PROXY_SURFACE:
58  * @surface: a #GstVaapiSurfaceProxy
59  *
60  * Macro that evaluates to the #GstVaapiSurface of @surface.
61  */
62 #define GST_VAAPI_SURFACE_PROXY_SURFACE(surface) \
63     gst_vaapi_surface_proxy_get_surface(surface)
64
65 /**
66  * GST_VAAPI_SURFACE_PROXY_TIMESTAMP:
67  * @surface: a #GstVaapiSurfaceProxy
68  *
69  * Macro that evaluates to the @surface timestamp, or
70  * %GST_CLOCK_TIME_NONE if none was set.
71  */
72 #define GST_VAAPI_SURFACE_PROXY_TIMESTAMP(surface) \
73     gst_vaapi_surface_proxy_get_timestamp(surface)
74
75 /**
76  * GST_VAAPI_SURFACE_PROXY_TFF:
77  * @surface: a #GstVaapiSurfaceProxy
78  *
79  * Macro that evaluates to the tff flag of the @surface
80  */
81 #define GST_VAAPI_SURFACE_PROXY_TFF(surface) \
82     gst_vaapi_surface_proxy_get_tff(surface)
83
84 typedef struct _GstVaapiSurfaceProxy            GstVaapiSurfaceProxy;
85 typedef struct _GstVaapiSurfaceProxyPrivate     GstVaapiSurfaceProxyPrivate;
86 typedef struct _GstVaapiSurfaceProxyClass       GstVaapiSurfaceProxyClass;
87
88 /**
89  * GstVaapiSurfaceProxy:
90  *
91  * A wrapper around a VA surface and context.
92  */
93 struct _GstVaapiSurfaceProxy {
94     /*< private >*/
95     GObject parent_instance;
96
97     GstVaapiSurfaceProxyPrivate *priv;
98 };
99
100 /**
101  * GstVaapiSurfaceProxyClass:
102  *
103  * A wrapper around a VA surface and context.
104  */
105 struct _GstVaapiSurfaceProxyClass {
106     /*< private >*/
107     GObjectClass parent_class;
108 };
109
110 GType
111 gst_vaapi_surface_proxy_get_type(void);
112
113 GstVaapiSurfaceProxy *
114 gst_vaapi_surface_proxy_new(GstVaapiContext *context, GstVaapiSurface *surface);
115
116 GstVaapiContext *
117 gst_vaapi_surface_proxy_get_context(GstVaapiSurfaceProxy *proxy);
118
119 void
120 gst_vaapi_surface_proxy_set_context(
121     GstVaapiSurfaceProxy *proxy,
122     GstVaapiContext      *context
123 );
124
125 GstVaapiSurface *
126 gst_vaapi_surface_proxy_get_surface(GstVaapiSurfaceProxy *proxy);
127
128 GstVaapiID
129 gst_vaapi_surface_proxy_get_surface_id(GstVaapiSurfaceProxy *proxy);
130
131 void
132 gst_vaapi_surface_proxy_set_surface(
133     GstVaapiSurfaceProxy *proxy,
134     GstVaapiSurface      *surface
135 );
136
137 GstClockTime
138 gst_vaapi_surface_proxy_get_timestamp(GstVaapiSurfaceProxy *proxy);
139
140 void
141 gst_vaapi_surface_proxy_set_timestamp(
142     GstVaapiSurfaceProxy *proxy,
143     GstClockTime          timestamp
144 );
145
146 gboolean
147 gst_vaapi_surface_proxy_get_tff(GstVaapiSurfaceProxy *proxy);
148
149 void
150 gst_vaapi_surface_proxy_set_tff(GstVaapiSurfaceProxy *proxy, gboolean tff);
151
152 G_END_DECLS
153
154 #endif /* GST_VAAPI_SURFACE_PROXY_H */