summaryrefslogtreecommitdiff
path: root/gst-libs/gst/codecs/gstav1decoder.h
blob: 4e5d0ebf6d81e78fa93611aa8ed61e82b7653472 (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
/* GStreamer
 * Copyright (C) 2020 He Junyan <junyan.he@intel.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_AV1_DECODER_H__
#define __GST_AV1_DECODER_H__

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

#include <gst/video/video.h>
#include <gst/codecparsers/gstav1parser.h>
#include <gst/codecs/gstav1picture.h>

G_BEGIN_DECLS

#define GST_TYPE_AV1_DECODER            (gst_av1_decoder_get_type())
#define GST_AV1_DECODER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AV1_DECODER,GstAV1Decoder))
#define GST_AV1_DECODER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AV1_DECODER,GstAV1DecoderClass))
#define GST_AV1_DECODER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_AV1_DECODER,GstAV1DecoderClass))
#define GST_IS_AV1_DECODER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AV1_DECODER))
#define GST_IS_AV1_DECODER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AV1_DECODER))

typedef struct _GstAV1Decoder GstAV1Decoder;
typedef struct _GstAV1DecoderClass GstAV1DecoderClass;
typedef struct _GstAV1DecoderPrivate GstAV1DecoderPrivate;

/**
 * GstAV1Decoder:
 *
 * The opaque #GstAV1Decoder data structure.
 *
 * Since: 1.20
 */
struct _GstAV1Decoder
{
  /*< private >*/
  GstVideoDecoder parent;

  /*< protected >*/
  GstVideoCodecState * input_state;

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

/**
 * GstAV1DecoderClass:
 */
struct _GstAV1DecoderClass
{
  GstVideoDecoderClass parent_class;

  /**
   * GstAV1DecoderClass::new_sequence:
   * @decoder: a #GstAV1Decoder
   * @seq_hdr: a #GstAV1SequenceHeaderOBU
   *
   * Notifies subclass of SPS update
   *
   * Since: 1.20
   */
  gboolean        (*new_sequence)      (GstAV1Decoder * decoder,
                                        const GstAV1SequenceHeaderOBU * seq_hdr);
  /**
   * GstAV1DecoderClass::new_picture:
   * @decoder: a #GstAV1Decoder
   * @frame: (transfer none): a #GstVideoCodecFrame
   * @picture: (transfer none): a #GstAV1Picture
   *
   * Optional. Called whenever new #GstAV1Picture is created.
   * Subclass can set implementation specific user data
   * on the #GstAV1Picture via gst_av1_picture_set_user_data()
   *
   * Since: 1.20
   */
  gboolean        (*new_picture)       (GstAV1Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstAV1Picture * picture);
  /**
   * GstAV1DecoderClass::duplicate_picture:
   * @decoder: a #GstAV1Decoder
   * @picture: (transfer none): a #GstAV1Picture
   *
   * Optional. Called when need to duplicate an existing
   * #GstAV1Picture.
   *
   * Since: 1.20
   */
  GstAV1Picture * (*duplicate_picture) (GstAV1Decoder * decoder,
                                        GstAV1Picture * picture);
  /**
   * GstAV1DecoderClass::start_picture:
   * @decoder: a #GstAV1Decoder
   * @picture: (transfer none): a #GstAV1Picture
   * @dpb: (transfer none): a #GstAV1Dpb
   *
   * Optional. Called per one #GstAV1Picture to notify subclass to prepare
   * decoding process for the #GstAV1Picture
   *
   * Since: 1.20
   */
  gboolean        (*start_picture)     (GstAV1Decoder * decoder,
                                        GstAV1Picture * picture,
                                        GstAV1Dpb * dpb);
  /**
   * GstAV1DecoderClass::decode_tile:
   * @decoder: a #GstAV1Decoder
   * @picture: (transfer none): a #GstAV1Picture
   * @tile: (transfer none): a #GstAV1Tile
   *
   * Provides the tile data with tile group header and required raw
   * bitstream for subclass to decode it.
   *
   * Since: 1.20
   */
  gboolean        (*decode_tile)       (GstAV1Decoder * decoder,
                                        GstAV1Picture * picture,
                                        GstAV1Tile * tile);
  /**
   * GstAV1DecoderClass::end_picture:
   * @decoder: a #GstAV1Decoder
   * @picture: (transfer none): a #GstAV1Picture
   *
   * Optional. Called per one #GstAV1Picture to notify subclass to finish
   * decoding process for the #GstAV1Picture
   *
   * Since: 1.20
   */
  gboolean        (*end_picture)       (GstAV1Decoder * decoder,
                                        GstAV1Picture * picture);
  /**
   * GstAV1DecoderClass::output_picture:
   * @decoder: a #GstAV1Decoder
   * @frame: (transfer full): a #GstVideoCodecFrame
   * @picture: (transfer full): a #GstAV1Picture
   *
   * Called with a #GstAV1Picture which is required to be outputted.
   * The #GstVideoCodecFrame must be consumed by subclass.
   *
   * Since: 1.20
   */
  GstFlowReturn   (*output_picture)    (GstAV1Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstAV1Picture * picture);

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

G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAV1Decoder, gst_object_unref)

GST_CODECS_API
GType gst_av1_decoder_get_type (void);

G_END_DECLS

#endif /* __GST_AV1_DECODER_H__ */