summaryrefslogtreecommitdiff
path: root/gst-libs/gst/codecs/gstvp8decoder.h
blob: e147afb95b7a30a2258ebc2e197e8ee967f6512d (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
/* GStreamer
 * Copyright (C) 2020 Seungha Yang <seungha@centricular.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_VP8_DECODER_H__
#define __GST_VP8_DECODER_H__

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

#include <gst/video/video.h>
#include <gst/codecparsers/gstvp8parser.h>
#include <gst/codecs/gstvp8picture.h>

G_BEGIN_DECLS

#define GST_TYPE_VP8_DECODER            (gst_vp8_decoder_get_type())
#define GST_VP8_DECODER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VP8_DECODER,GstVp8Decoder))
#define GST_VP8_DECODER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VP8_DECODER,GstVp8DecoderClass))
#define GST_VP8_DECODER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_VP8_DECODER,GstVp8DecoderClass))
#define GST_IS_VP8_DECODER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VP8_DECODER))
#define GST_IS_VP8_DECODER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VP8_DECODER))
#define GST_VP8_DECODER_CAST(obj)       ((GstVp8Decoder*)obj)

typedef struct _GstVp8Decoder GstVp8Decoder;
typedef struct _GstVp8DecoderClass GstVp8DecoderClass;
typedef struct _GstVp8DecoderPrivate GstVp8DecoderPrivate;

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

  /*< protected >*/
  GstVideoCodecState * input_state;

  /* reference frames */
  GstVp8Picture *last_picture;
  GstVp8Picture *golden_ref_picture;
  GstVp8Picture *alt_ref_picture;

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

/**
 * GstVp8DecoderClass:
 * @new_sequence:      Notifies subclass of SPS update
 * @new_picture:       Optional.
 *                     Called whenever new #GstVp8Picture is created.
 *                     Subclass can set implementation specific user data
 *                     on the #GstVp8Picture via gst_vp8_picture_set_user_data()
 * @start_picture:     Optional.
 *                     Called per one #GstVp8Picture to notify subclass to prepare
 *                     decoding process for the #GstVp8Picture
 * @decode_slice:      Provides per slice data with parsed slice header and
 *                     required raw bitstream for subclass to decode it
 * @end_picture:       Optional.
 *                     Called per one #GstVp8Picture to notify subclass to finish
 *                     decoding process for the #GstVp8Picture
 * @output_picture:    Called with a #GstVp8Picture which is required to be outputted.
 *                     Subclass can retrieve parent #GstVideoCodecFrame by using
 *                     gst_video_decoder_get_frame() with system_frame_number
 *                     and the #GstVideoCodecFrame must be consumed by subclass via
 *                     gst_video_decoder_{finish,drop,release}_frame().
 */
struct _GstVp8DecoderClass
{
  GstVideoDecoderClass parent_class;

  GstFlowReturn   (*new_sequence)      (GstVp8Decoder * decoder,
                                        const GstVp8FrameHdr * frame_hdr);

  /**
   * GstVp8DecoderClass:new_picture:
   * @decoder: a #GstVp8Decoder
   * @frame: (transfer none): a #GstVideoCodecFrame
   * @picture: (transfer none): a #GstVp8Picture
   */
  GstFlowReturn   (*new_picture)       (GstVp8Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstVp8Picture * picture);

  GstFlowReturn   (*start_picture)     (GstVp8Decoder * decoder,
                                        GstVp8Picture * picture);

  GstFlowReturn   (*decode_picture)    (GstVp8Decoder * decoder,
                                        GstVp8Picture * picture,
                                        GstVp8Parser * parser);

  GstFlowReturn   (*end_picture)       (GstVp8Decoder * decoder,
                                        GstVp8Picture * picture);

  /**
   * GstVp8DecoderClass:output_picture:
   * @decoder: a #GstVp8Decoder
   * @frame: (transfer full): a #GstVideoCodecFrame
   * @picture: (transfer full): a #GstVp8Picture
   */
  GstFlowReturn   (*output_picture)    (GstVp8Decoder * decoder,
                                        GstVideoCodecFrame * frame,
                                        GstVp8Picture * picture);

  /**
   * GstVp8DecoderClass::get_preferred_output_delay:
   * @decoder: a #GstVp8Decoder
   * @is_live: whether upstream is live or not
   *
   * Optional. Called by baseclass to query whether delaying output is
   * preferred by subclass or not.
   *
   * Returns: the number of perferred delayed output frame
   *
   * Since: 1.20
   */
  guint           (*get_preferred_output_delay)   (GstVp8Decoder * decoder,
                                                   gboolean is_live);

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

G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVp8Decoder, gst_object_unref)

GST_CODECS_API
GType gst_vp8_decoder_get_type (void);

G_END_DECLS

#endif /* __GST_VP8_DECODER_H__ */