summaryrefslogtreecommitdiff
path: root/gst-libs/gst/vaapi/gstvaapifilter.h
blob: fcd2e45b44ad2e7c0a797ee69a9e74272d6df905 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/*
 *  gstvaapifilter.h - Video processing abstraction
 *
 *  Copyright (C) 2013 Intel Corporation
 *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1
 *  of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301 USA
 */

#ifndef GST_VAAPI_FILTER_H
#define GST_VAAPI_FILTER_H

#include <gst/vaapi/gstvaapisurface.h>
#include <gst/vaapi/video-format.h>

G_BEGIN_DECLS

#define GST_TYPE_VAAPI_FILTER \
    (gst_vaapi_filter_get_type ())
#define GST_VAAPI_FILTER(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VAAPI_FILTER, GstVaapiFilter))
#define GST_VAAPI_IS_FILTER(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VAAPI_FILTER))

typedef struct _GstVaapiFilter                  GstVaapiFilter;
typedef struct _GstVaapiFilterOpInfo            GstVaapiFilterOpInfo;

/**
 * @GST_VAAPI_FILTER_OP_FORMAT: Force output pixel format (#GstVideoFormat).
 * @GST_VAAPI_FILTER_OP_CROP: Crop source surface (#GstVaapiRectangle).
 * @GST_VAAPI_FILTER_OP_DENOISE: Noise reduction (float).
 * @GST_VAAPI_FILTER_OP_SHARPEN: Sharpening (float).
 * @GST_VAAPI_FILTER_OP_HUE: Change color hue (float).
 * @GST_VAAPI_FILTER_OP_SATURATION: Change saturation (float).
 * @GST_VAAPI_FILTER_OP_BRIGHTNESS: Change brightness (float).
 * @GST_VAAPI_FILTER_OP_CONTRAST: Change contrast (float).
 * @GST_VAAPI_FILTER_OP_SCALING: Change scaling method (#GstVaapiScaleMethod).
 * @GST_VAAPI_FILTER_OP_VIDEO_DIRECTION: Change video direction
 *   (#GstVideoOrientationMethod).
 * @GST_VAAPI_FILTER_OP_SKINTONE: Skin tone enhancement (bool).
 * @GST_VAAPI_FILTER_OP_SKINTONE_LEVEL: Skin tone enhancement (uint).
 *
 * The set of operations that could be applied to the filter.
 */
typedef enum {
  GST_VAAPI_FILTER_OP_FORMAT = 1,
  GST_VAAPI_FILTER_OP_CROP,
  GST_VAAPI_FILTER_OP_DENOISE,
  GST_VAAPI_FILTER_OP_SHARPEN,
  GST_VAAPI_FILTER_OP_HUE,
  GST_VAAPI_FILTER_OP_SATURATION,
  GST_VAAPI_FILTER_OP_BRIGHTNESS,
  GST_VAAPI_FILTER_OP_CONTRAST,
  GST_VAAPI_FILTER_OP_DEINTERLACING,
  GST_VAAPI_FILTER_OP_SCALING,
  GST_VAAPI_FILTER_OP_VIDEO_DIRECTION,
#ifndef GST_REMOVE_DEPRECATED
  GST_VAAPI_FILTER_OP_SKINTONE,
#endif
  GST_VAAPI_FILTER_OP_SKINTONE_LEVEL,
} GstVaapiFilterOp;

/**
 * GstVaapiFilterOpInfo:
 * @operation: the #GstVaapiFilterOp
 * @pspec: the #GParamSpec describing the associated configurable value
 *
 * A #GstVaapiFilterOp descriptor.
 */
struct _GstVaapiFilterOpInfo
{
  const GstVaapiFilterOp op;
  GParamSpec *const pspec;
};

/**
 * GstVaapiFilterStatus:
 * @GST_VAAPI_FILTER_STATUS_SUCCESS: Success.
 * @GST_VAAPI_FILTER_STATUS_ERROR_ALLOCATION_FAILED: No memory left.
 * @GST_VAAPI_FILTER_STATUS_ERROR_OPERATION_FAILED: Operation failed.
 * @GST_VAAPI_FILTER_STATUS_ERROR_INVALID_PARAMETER: Invalid parameter.
 * @GST_VAAPI_FILTER_STATUS_ERROR_UNSUPPORTED_OPERATION: Unsupported operation.
 * @GST_VAAPI_FILTER_STATUS_ERROR_UNSUPPORTED_FORMAT: Unsupported target format.
 *
 * Video processing status for gst_vaapi_filter_process().
 */
typedef enum {
  GST_VAAPI_FILTER_STATUS_SUCCESS = 0,
  GST_VAAPI_FILTER_STATUS_ERROR_ALLOCATION_FAILED,
  GST_VAAPI_FILTER_STATUS_ERROR_OPERATION_FAILED,
  GST_VAAPI_FILTER_STATUS_ERROR_INVALID_PARAMETER,
  GST_VAAPI_FILTER_STATUS_ERROR_UNSUPPORTED_OPERATION,
  GST_VAAPI_FILTER_STATUS_ERROR_UNSUPPORTED_FORMAT,
} GstVaapiFilterStatus;

/**
 * GstVaapiScaleMethod:
 * @GST_VAAPI_SCALE_METHOD_DEFAULT: Default scaling mode.
 * @GST_VAAPI_SCALE_METHOD_FAST: Fast scaling mode, at the expense of quality.
 * @GST_VAAPI_SCALE_METHOD_HQ: High quality scaling mode, at the
 *   expense of speed.
 *
 * Scaling algorithms.
 */
typedef enum {
  GST_VAAPI_SCALE_METHOD_DEFAULT,
  GST_VAAPI_SCALE_METHOD_FAST,
  GST_VAAPI_SCALE_METHOD_HQ,
} GstVaapiScaleMethod;

/**
 * GstVaapiDeinterlaceMethod:
 * @GST_VAAPI_DEINTERLACE_METHOD_NONE: No deinterlacing.
 * @GST_VAAPI_DEINTERLACE_METHOD_BOB: Basic bob deinterlacing algorithm.
 * @GST_VAAPI_DEINTERLACE_METHOD_WEAVE: Weave deinterlacing algorithm.
 * @GST_VAAPI_DEINTERLACE_METHOD_MOTION_ADAPTIVE: Motion adaptive
 *   deinterlacing algorithm.
 * @GST_VAAPI_DEINTERLACE_METHOD_MOTION_COMPENSATED: Motion compensated
 *   deinterlacing algorithm.
 *
 * Deinterlacing algorithms.
 */
typedef enum {
  GST_VAAPI_DEINTERLACE_METHOD_NONE,
  GST_VAAPI_DEINTERLACE_METHOD_BOB,
  GST_VAAPI_DEINTERLACE_METHOD_WEAVE,
  GST_VAAPI_DEINTERLACE_METHOD_MOTION_ADAPTIVE,
  GST_VAAPI_DEINTERLACE_METHOD_MOTION_COMPENSATED,
} GstVaapiDeinterlaceMethod;

/**
 * GstVaapiDeinterlaceFlags:
 * @GST_VAAPI_DEINTERLACE_FLAG_TFF: Top-field first. If this flag is
 *   not set, then bottom-field first order is assumed. Note: this
 *   only affects the way reference frames are organized for advanced
 *   deinterlacing modes.
 * @GST_VAAPI_DEINTERLACE_FLAG_ONEFIELD: The input frame represents a
 *   single field. If this flag is not set, then the whole frame holds
 *   two interleaved fields.
 * @GST_VAAPI_DEINTERLACE_FLAG_TOPFIELD: The top field of the input
 *   frame is to be used for deinterlacing. Otherwise, if this flag is
 *   not set, then the bottom field of the input frame will be used
 *   for deinterlacing.
 *
 * The set of gst_vaapi_filter_set_deinterlacing() flags.
 */
typedef enum {
  GST_VAAPI_DEINTERLACE_FLAG_TFF = 1 << 31,
  GST_VAAPI_DEINTERLACE_FLAG_ONEFIELD = 1 << 30,
  GST_VAAPI_DEINTERLACE_FLAG_TOPFIELD = 1 << 29,
} GstVaapiDeinterlaceFlags;

#define GST_VAAPI_TYPE_SCALE_METHOD \
    gst_vaapi_scale_method_get_type()

#define GST_VAAPI_TYPE_DEINTERLACE_METHOD \
    gst_vaapi_deinterlace_method_get_type()

#define GST_VAAPI_TYPE_DEINTERLACE_FLAGS \
    gst_vaapi_deinterlace_flags_get_type()

GType
gst_vaapiscale_method_get_type (void) G_GNUC_CONST;

GType
gst_vaapi_deinterlace_method_get_type (void) G_GNUC_CONST;

GType
gst_vaapi_deinterlace_flags_get_type (void) G_GNUC_CONST;

GType
gst_vaapi_filter_get_type (void) G_GNUC_CONST;

GstVaapiFilter *
gst_vaapi_filter_new (GstVaapiDisplay * display);

void
gst_vaapi_filter_replace (GstVaapiFilter ** old_filter_ptr,
    GstVaapiFilter * new_filter);

GPtrArray *
gst_vaapi_filter_get_operations (GstVaapiFilter * filter);

gboolean
gst_vaapi_filter_has_operation (GstVaapiFilter * filter, GstVaapiFilterOp op);

gboolean
gst_vaapi_filter_use_operation (GstVaapiFilter * filter, GstVaapiFilterOp op);

gboolean
gst_vaapi_filter_set_operation (GstVaapiFilter * filter, GstVaapiFilterOp op,
    const GValue * value);

GstVaapiFilterStatus
gst_vaapi_filter_process (GstVaapiFilter * filter,
    GstVaapiSurface * src_surface, GstVaapiSurface * dst_surface, guint flags);

GArray *
gst_vaapi_filter_get_formats (GstVaapiFilter * filter);

gboolean
gst_vaapi_filter_set_format (GstVaapiFilter * filter, GstVideoFormat format);

gboolean
gst_vaapi_filter_append_caps (GstVaapiFilter * filter, GstStructure * structure);

gboolean
gst_vaapi_filter_set_cropping_rectangle (GstVaapiFilter * filter,
    const GstVaapiRectangle * rect);

gboolean
gst_vaapi_filter_set_target_rectangle (GstVaapiFilter * filter,
    const GstVaapiRectangle * rect);

gboolean
gst_vaapi_filter_set_denoising_level (GstVaapiFilter * filter, gfloat level);

gboolean
gst_vaapi_filter_set_sharpening_level (GstVaapiFilter * filter, gfloat level);

gboolean
gst_vaapi_filter_set_hue (GstVaapiFilter * filter, gfloat value);

gboolean
gst_vaapi_filter_set_saturation (GstVaapiFilter * filter, gfloat value);

gboolean
gst_vaapi_filter_set_brightness (GstVaapiFilter * filter, gfloat value);

gboolean
gst_vaapi_filter_set_contrast (GstVaapiFilter * filter, gfloat value);

gboolean
gst_vaapi_filter_set_deinterlacing (GstVaapiFilter * filter,
    GstVaapiDeinterlaceMethod method, guint flags);

gboolean
gst_vaapi_filter_set_deinterlacing_references (GstVaapiFilter * filter,
    GstVaapiSurface ** forward_references, guint num_forward_references,
    GstVaapiSurface ** backward_references, guint num_backward_references);

gboolean
gst_vaapi_filter_set_scaling (GstVaapiFilter * filter,
    GstVaapiScaleMethod method);

gboolean
gst_vaapi_filter_set_video_direction (GstVaapiFilter * filter,
    GstVideoOrientationMethod method);

GstVideoOrientationMethod
gst_vaapi_filter_get_video_direction (GstVaapiFilter * filter);

#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_vaapi_filter_set_skintone (GstVaapiFilter * filter,
    gboolean enhance);
#endif

gboolean
gst_vaapi_filter_set_skintone_level (GstVaapiFilter * filter, guint value);

gfloat
gst_vaapi_filter_get_denoising_level_default (GstVaapiFilter * filter);

gfloat
gst_vaapi_filter_get_sharpening_level_default (GstVaapiFilter * filter);

gfloat
gst_vaapi_filter_get_hue_default (GstVaapiFilter * filter);

gfloat
gst_vaapi_filter_get_saturation_default (GstVaapiFilter * filter);

gfloat
gst_vaapi_filter_get_brightness_default (GstVaapiFilter * filter);

gfloat
gst_vaapi_filter_get_contrast_default (GstVaapiFilter * filter);

GstVaapiScaleMethod
gst_vaapi_filter_get_scaling_default (GstVaapiFilter * filter);

GstVideoOrientationMethod
gst_vaapi_filter_get_video_direction_default (GstVaapiFilter * filter);

#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_vaapi_filter_get_skintone_default (GstVaapiFilter * filter);
#endif

guint
gst_vaapi_filter_get_skintone_level_default (GstVaapiFilter * filter);

#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVaapiFilter, gst_object_unref)
#endif

#endif /* GST_VAAPI_FILTER_H */