summaryrefslogtreecommitdiff
path: root/gst-libs/gst/codecs/gstvp9decoder.h
blob: 8a6b9b4fc1d68a6c50def773229bf681f6a19a13 (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
/* GStreamer
 * Copyright (C) 2019 Seungha Yang <seungha.yang@navercorp.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __GST_VP9_DECODER_H__
#define __GST_VP9_DECODER_H__

#include <gst/codecs/codecs-prelude.h>

#include <gst/video/video.h>
#include <gst/codecs/gstvp9picture.h>

G_BEGIN_DECLS

#define GST_TYPE_VP9_DECODER            (gst_vp9_decoder_get_type())
#define GST_VP9_DECODER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VP9_DECODER,GstVp9Decoder))
#define GST_VP9_DECODER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VP9_DECODER,GstVp9DecoderClass))
#define GST_VP9_DECODER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_VP9_DECODER,GstVp9DecoderClass))
#define GST_IS_VP9_DECODER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VP9_DECODER))
#define GST_IS_VP9_DECODER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VP9_DECODER))
#define GST_VP9_DECODER_CAST(obj)       ((GstVP9Decoder*)obj)

typedef struct _GstVp9Decoder GstVp9Decoder;
typedef struct _GstVp9DecoderClass GstVp9DecoderClass;
typedef struct _GstVp9DecoderPrivate GstVp9DecoderPrivate;

/**
 * GstVp9Decoder:
 *
 * The opaque #GstVp9Decoder data structure.
 */
struct _GstVp9Decoder
{
  /*< private >*/
  GstVideoDecoder parent;

  /*< protected >*/
  GstVideoCodecState * input_state;

  /*< private >*/
  GstVp9DecoderPrivate *priv;
  gpointer padding[GST_PADDING_LARGE];
};

/**
 * GstVp9DecoderClass:
 */
struct _GstVp9DecoderClass
{
  GstVideoDecoderClass parent_class;

  /**
   * GstVp9Decoder::new_sequence:
   *
   * Notifies subclass of video sequence update such as resolution, bitdepth,
   * profile.
   *
   * Since: 1.18
   */
  gboolean        (*new_sequence)      (GstVp9Decoder * decoder,
                                        const GstVp9FrameHeader *frame_hdr);

  /**
   * GstVp9Decoder:new_picture:
   * @decoder: a #GstVp9Decoder
   * @frame: (transfer none): a #GstVideoCodecFrame
   * @picture: (transfer none): a #GstVp9Picture
   *
   * Optional. Called whenever new #GstVp9Picture is created.
   * Subclass can set implementation specific user data on the #GstVp9Picture
   * via gst_vp9_picture_set_user_data()
   *
   * Since: 1.18
   */
  gboolean        (*new_picture)       (GstVp9Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstVp9Picture * picture);

  /**
   * GstVp9Decoder:duplicate_picture:
   * @decoder: a #GstVp9Decoder
   * @frame: (transfer none): a #GstVideoCodecFrame
   * @picture: (transfer none): a #GstVp9Picture to be duplicated
   *
   * Optional. Called to duplicate @picture when show_existing_frame flag is set
   * in the parsed vp9 frame header. Returned #GstVp9Picture from this method
   * should hold already decoded picture data corresponding to the @picture,
   * since the returned #GstVp9Picture from this method will be passed to
   * the output_picture method immediately without additional decoding process.
   *
   * If this method is not implemented by subclass, baseclass will drop
   * current #GstVideoCodecFrame without additional processing for the current
   * frame.
   *
   * Returns: (transfer full): a #GstVp9Picture or %NULL if failed to duplicate
   * @picture.
   *
   * Since: 1.18
   */
  GstVp9Picture * (*duplicate_picture) (GstVp9Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstVp9Picture * picture);

  /**
   * GstVp9Decoder:start_picture:
   * @decoder: a #GstVp9Decoder
   * @picture: (transfer none): a #GstVp9Picture
   *
   * Optional. Called to notify subclass to prepare decoding process for
   * @picture
   *
   * Since: 1.18
   */
  gboolean        (*start_picture)     (GstVp9Decoder * decoder,
                                        GstVp9Picture * picture);

  /**
   * GstVp9Decoder:decode_picture:
   * @decoder: a #GstVp9Decoder
   * @picture: (transfer none): a #GstVp9Picture to decoder
   * @dpb: (transfer none): a #GstVp9Dpb
   *
   * Called to notify decoding for subclass to decoder given @picture with
   * given @dpb
   *
   * Since: 1.18
   */
  gboolean        (*decode_picture)    (GstVp9Decoder * decoder,
                                        GstVp9Picture * picture,
                                        GstVp9Dpb * dpb);

  /**
   * GstVp9Decoder::end_picture:
   * @decoder: a #GstVp9Decoder
   * @picture: (transfer none): a #GstVp9Picture
   *
   * Optional. Called per one #GstVp9Picture to notify subclass to finish
   * decoding process for the #GstVp9Picture
   *
   * Since: 1.18
   */
  gboolean        (*end_picture)       (GstVp9Decoder * decoder,
                                        GstVp9Picture * picture);

  /**
   * GstVp9Decoder:output_picture:
   * @decoder: a #GstVp9Decoder
   * @frame: (transfer full): a #GstVideoCodecFrame
   * @picture: (transfer full): a #GstVp9Picture
   *
   * Called to notify @picture is ready to be outputted.
   *
   * Since: 1.18
   */
  GstFlowReturn   (*output_picture)    (GstVp9Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstVp9Picture * picture);

  /*< private >*/
  gpointer padding[GST_PADDING_LARGE];
};

G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVp9Decoder, gst_object_unref)

GST_CODECS_API
GType gst_vp9_decoder_get_type (void);

G_END_DECLS

#endif /* __GST_VP9_DECODER_H__ */