Update and add documentation for plugins with deps (ext).
[platform/upstream/gst-plugins-good.git] / ext / libcaca / gstcacasink.h
1 /* GStreamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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
21 #ifndef __GST_CACASINK_H__
22 #define __GST_CACASINK_H__
23
24 #include <gst/gst.h>
25 #include <gst/base/gstbasesink.h>
26 #include <gst/video/video.h>
27
28 #include <caca.h>
29 #ifdef CACA_API_VERSION_1
30 #   include <caca0.h>
31 #endif
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
36
37 #define GST_TYPE_CACASINK \
38   (gst_cacasink_get_type())
39 #define GST_CACASINK(obj) \
40   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CACASINK,GstCACASink))
41 #define GST_CACASINK_CLASS(klass) \
42   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CACASINK,GstCACASinkClass))
43 #define GST_IS_CACASINK(obj) \
44   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CACASINK))
45 #define GST_IS_CACASINK_CLASS(klass) \
46   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CACASINK))
47
48 typedef struct _GstCACASink GstCACASink;
49 typedef struct _GstCACASinkClass GstCACASinkClass;
50
51 struct _GstCACASink {
52   GstBaseSink parent;
53
54   GstPad *sinkpad;
55
56   gulong format;
57   gint width, height;
58   gint screen_width, screen_height;
59   guint bpp;
60   guint dither;
61   gboolean antialiasing;
62   guint red_mask, green_mask, blue_mask;
63
64   struct caca_bitmap *bitmap;
65 };
66
67 struct _GstCACASinkClass {
68   GstBaseSinkClass parent_class;
69
70   /* signals */
71 };
72
73 GType gst_cacasink_get_type(void);
74
75 #ifdef __cplusplus
76 }
77 #endif /* __cplusplus */
78
79
80 #endif /* __GST_CACASINKE_H__ */