encoder: reduce function parameters and change variable names
[vaapi:windyuan-gstreamer-vaapi.git] / gst-libs / gst / vaapi / gstvaapibaseencoder.h
1 /*
2  *  gstvaapibaseencoder.h - VA-API base encoder
3  *
4  *  Copyright (C) 2011 Intel Corporation
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public License
8  *  as published by the Free Software Foundation; either version 2.1
9  *  of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free
18  *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301 USA
20  */
21
22 #ifndef GST_VAAPI_BASE_ENCODER_H
23 #define GST_VAAPI_BASE_ENCODER_H
24
25 #include "gstvaapiencoder.h"
26 #include "gst/vaapi/gstvaapivideobuffer.h"
27
28 G_BEGIN_DECLS
29
30 typedef struct _GstVaapiBaseEncoder              GstVaapiBaseEncoder;
31 typedef struct _GstVaapiBaseEncoderPrivate       GstVaapiBaseEncoderPrivate;
32 typedef struct _GstVaapiBaseEncoderClass         GstVaapiBaseEncoderClass;
33
34 #define GST_TYPE_VAAPI_BASE_ENCODER             (gst_vaapi_base_encoder_get_type())
35 #define GST_IS_VAAPI_BASE_ENCODER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VAAPI_BASE_ENCODER))
36 #define GST_IS_VAAPI_BASE_ENCODER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_VAAPI_BASE_ENCODER))
37 #define GST_VAAPI_BASE_ENCODER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_VAAPI_BASE_ENCODER,  GstVaapiBaseEncoderClass))
38 #define GST_VAAPI_BASE_ENCODER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VAAPI_BASE_ENCODER, GstVaapiBaseEncoder))
39 #define GST_VAAPI_BASE_ENCODER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_VAAPI_BASE_ENCODER,  GstVaapiBaseEncoderClass))
40 #define GST_VAAPI_BASE_ENCODER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj),GST_TYPE_VAAPI_BASE_ENCODER,  GstVaapiBaseEncoderPrivate))
41
42 struct _GstVaapiBaseEncoder {
43   GstVaapiEncoder parent;
44
45   GstVaapiBaseEncoderPrivate *priv;
46 };
47
48 struct _GstVaapiBaseEncoderClass {
49   GstVaapiEncoderClass parent_class;
50
51   /* in <open> function*/
52   gboolean (*validate_attributes)   (GstVaapiBaseEncoder* encoder);
53   gboolean (*pre_alloc_resource)    (GstVaapiBaseEncoder *encoder, GstVaapiContext* context);
54
55   /* in <close> function */
56   gboolean (*release_resource)      (GstVaapiBaseEncoder* encoder);
57
58   /* in <encode> function */
59   EncoderStatus (*prepare_next_input_buffer)(GstVaapiBaseEncoder* encoder,
60                                              GstVaapiVideoBuffer *display_buf,
61                                              gboolean need_flush,
62                                              GstVaapiVideoBuffer **out_buf);
63   EncoderStatus (*render_frame)     (GstVaapiBaseEncoder *encoder, GstVaapiSurface *surface,
64                                      guint frame_index, VABufferID coded_buf, gboolean *is_key);
65   void (*encode_frame_failed)       (GstVaapiBaseEncoder *encoder, GstVaapiVideoBuffer* buffer);
66   void (*notify_frame)              (GstVaapiBaseEncoder *encoder, guint8 *buf, guint32 size);
67   GstBuffer *(*copy_coded_frame)    (GstVaapiBaseEncoder *encoder, guint8 *buf, guint32 size, VABufferID *coded_buf);
68 };
69
70 GType    gst_vaapi_base_encoder_get_type(void);
71 void     gst_vaapi_base_encoder_set_frame_notify(GstVaapiBaseEncoder *encoder, gboolean flag);
72 gboolean gst_vaapi_base_encoder_set_va_profile(GstVaapiBaseEncoder *encoder, guint profile);
73 void     gst_vaapi_base_encoder_set_input_format(GstVaapiBaseEncoder* encoder, guint32 format);
74
75
76 G_END_DECLS
77
78 #endif
79