Added status of the documents
[platform/upstream/gstreamer.git] / docs / random / hierarchy
1 OUTDATED
2 --------
3
4
5 Face it, the plugins/ directory hierarchy is crap. We want to propose a
6 better layout for it now. Some things to consider:
7
8  - Elements have a klass member in the factory that is used to
9    denote the functional type of the element. For example, the
10    mp3 encoder has a klass of Filter/Encoder/Audio
11    
12  - The plugins can be grouped together by the media type they
13    operate on or by the way they work (decoder/encoder)
14    
15 In GStreamer all plugins are techically filters, the only way they
16 can be considered sources or sinks (input/output) elements is
17 by the absence of src/sink pads. At first sight the source/filter/
18 sink distinction is quite useless because most of the plugins
19 will go into the filters category anyway. 
20
21 We don't want to make the hierarchy too deep, yet provide a 
22 clean way to ask for a mp3 decoder element..
23
24 Anyway this is a rough proposal to fire off the discussions...
25
26 Wim
27
28 Source 
29   Disk
30     disksrc
31     fdsrc
32     multifilesrc
33   Network
34     HTTPsrc
35     RTPsrc
36   CDDA
37     cdparanoia
38   XMMS
39     ..
40   DVD
41     dvdsrc
42   Audio
43     ASLA
44     OSS
45   Capture
46     v4lsrc
47     firewire
48   
49 Demuxer     
50   AVI
51   MPEG1
52   MPEG2
53   QT
54   
55 Muxer
56   AVI
57   MPEG1
58   QT
59   
60 Aggregator
61
62 Tee
63   gsttee
64   
65 Connection
66   queue
67   CORBA
68
69 Parser
70   MPEG1
71   MPEG2
72   AC3
73
74 Mixer
75   Audio
76     Merge
77   Video
78     Subtitles
79     Merge
80
81 Filters
82   Audio
83     ladspa
84     resample
85   Video
86     colorspace
87   
88 Effect
89   Audio
90     stereo
91     volume
92     delay
93     chorus
94   Video
95     median
96     smooth
97   XMMS
98
99 Decoder
100   MPEG1
101   MPEG2
102   MP3
103     mpg123
104     xing
105   win32
106   AU
107   WAV
108   JPEG
109   AC3
110     ac3dec
111   RTJPEG
112   vorbis
113
114 Encoder
115   MPEG1
116   MPEG2
117   MP3
118     lame
119     mpegaudio
120   win32
121   JPEG
122   AU
123   WAV
124   RTJPEG
125   Vorbis
126
127 Visualisation
128   Video
129     histogram  
130   Audio
131     smoothwave
132     spectrum
133     synaesthesia
134     vumeter
135   XMMS
136
137 Sink
138   Disk
139     filesink
140     multifilesink
141   Network
142     ICECASTsink
143     FTPsink
144     RTPsink
145   XMMS
146   ESD
147   Video
148     videosink
149     SDLsink
150   Audio
151     OSSsink
152     ALSAsink
153