pick up signals and args for vorbis; add some docs for vorbis
[platform/upstream/gst-plugins-base.git] / ext / theora / gsttheoraenc.h
1 /* GStreamer
2  * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __GST_THEORAENC_H__
21 #define __GST_THEORAENC_H__
22
23 #include <gst/gst.h>
24 #include <theora/theora.h>
25
26 G_BEGIN_DECLS
27
28 #define GST_TYPE_THEORA_ENC \
29   (gst_theora_enc_get_type())
30 #define GST_THEORA_ENC(obj) \
31   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_THEORA_ENC,GstTheoraEnc))
32 #define GST_THEORA_ENC_CLASS(klass) \
33   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_THEORA_ENC,GstTheoraEnc))
34 #define GST_IS_THEORA_ENC(obj) \
35   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_THEORA_ENC))
36 #define GST_IS_THEORA_ENC_CLASS(obj) \
37   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_THEORA_ENC))
38
39 typedef struct _GstTheoraEnc GstTheoraEnc;
40 typedef struct _GstTheoraEncClass GstTheoraEncClass;
41
42 typedef enum
43 {
44   BORDER_NONE,
45   BORDER_BLACK,
46   BORDER_MIRROR
47 }
48 GstTheoraEncBorderMode;
49
50 struct _GstTheoraEnc
51 {
52   GstElement element;
53
54   GstPad *sinkpad;
55   GstPad *srcpad;
56
57   ogg_stream_state to;
58
59   theora_state state;
60   theora_info info;
61   theora_comment comment;
62
63   gboolean center;
64   GstTheoraEncBorderMode border;
65
66   gint video_bitrate;           /* bitrate target for Theora video */
67   gint video_quality;           /* Theora quality selector 0 = low, 63 = high */
68   gboolean quick;
69   gboolean keyframe_auto;
70   gint keyframe_freq;
71   gint keyframe_force;
72   gint keyframe_threshold;
73   gint keyframe_mindistance;
74   gint noise_sensitivity;
75   gint sharpness;
76
77   gint info_width, info_height;
78   gint width, height;
79   gint offset_x, offset_y;
80   gdouble fps;
81
82   guint packetno;
83   guint64 bytes_out;
84   guint64 initial_delay;
85 };
86
87 struct _GstTheoraEncClass
88 {
89   GstElementClass parent_class;
90 };
91
92 G_END_DECLS
93
94 #endif /* __GST_THEORAENC_H__ */
95