Fix some more docs.
[platform/upstream/gstreamer.git] / gst / videotestsrc / gstvideotestsrc.h
1 /* GStreamer
2  * Copyright (C) <2002> David A. Schleef <ds@schleef.org>
3  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #ifndef __GST_VIDEO_TEST_SRC_H__
22 #define __GST_VIDEO_TEST_SRC_H__
23
24 #include <gst/gst.h>
25 #include <gst/base/gstpushsrc.h>
26
27 G_BEGIN_DECLS
28
29 #define GST_TYPE_VIDEO_TEST_SRC \
30   (gst_video_test_src_get_type())
31 #define GST_VIDEO_TEST_SRC(obj) \
32   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_TEST_SRC,GstVideoTestSrc))
33 #define GST_VIDEO_TEST_SRC_CLASS(klass) \
34   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_TEST_SRC,GstVideoTestSrc))
35 #define GST_IS_VIDEO_TEST_SRC(obj) \
36   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_TEST_SRC))
37 #define GST_IS_VIDEO_TEST_SRC_CLASS(obj) \
38   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_TEST_SRC))
39
40 /**
41  * GstVideoTestSrcPattern:
42  * @GST_VIDEO_TEST_SRC_SMPTE: A standard SMPTE test pattern
43  * @GST_VIDEO_TEST_SRC_SNOW: Random noise
44  * @GST_VIDEO_TEST_SRC_BLACK: A black image
45  *
46  * The test pattern to produce.
47  */
48 typedef enum {
49   GST_VIDEO_TEST_SRC_SMPTE,
50   GST_VIDEO_TEST_SRC_SNOW,
51   GST_VIDEO_TEST_SRC_BLACK,
52 } GstVideoTestSrcPattern;
53
54 typedef struct _GstVideoTestSrc GstVideoTestSrc;
55 typedef struct _GstVideoTestSrcClass GstVideoTestSrcClass;
56
57 /**
58  * GstVideoTestSrc:
59  *
60  * Opaque data structure.
61  */
62 struct _GstVideoTestSrc {
63   GstPushSrc element;
64
65   /* type of output */
66   GstVideoTestSrcPattern pattern_type;
67
68   /* video state */
69   char *format_name;
70   gint width;
71   gint height;
72   struct fourcc_list_struct *fourcc;
73   gint bpp;
74   gint rate_numerator;
75   gint rate_denominator;
76
77   /* private */
78   gint64 timestamp_offset;              /* base offset */
79   GstClockTime running_time;            /* total running time */
80   gint64 n_frames;                      /* total frames sent */
81
82   void (*make_image) (GstVideoTestSrc *v, unsigned char *dest, int w, int h);
83 };
84
85 struct _GstVideoTestSrcClass {
86   GstPushSrcClass parent_class;
87 };
88
89 GType gst_video_test_src_get_type (void);
90
91 G_END_DECLS
92
93 #endif /* __GST_VIDEO_TEST_SRC_H__ */