blob: 190568447535a2e7c7b73edd9d5813c085a066de [file] [log] [blame]
xuesong.jiang1801e172021-10-11 10:56:41 +08001WHAT IT IS
2----------
3
4gst-plugin is a template for writing your own GStreamer plug-in.
5
6The code is deliberately kept simple so that you quickly understand the basics
7of how to set up autotools and your source tree.
8
9This template demonstrates :
10- what to do in autogen.sh
11- how to setup configure.ac (your package name and version, GStreamer flags)
12- how to setup your source dir
13- what to put in Makefile.am
14
15More features and templates might get added later on.
16
17HOW TO USE IT
18-------------
19
20To use it, either make a copy for yourself and rename the parts or use the
21make_element script in tools. To create sources for "myfilter" based on the
22"gsttransform" template run:
23
24cd src;
25../tools/make_element myfilter gsttransform
26
27This will create gstmyfilter.c and gstmyfilter.h. Open them in an editor and
28start editing. There are several occurances of the string "template", update
29those with real values. The plugin will be called 'myfilter' and it will have
30one element called 'myfilter' too. Also look for "FIXME:" markers that point you
31to places where you need to edit the code.
32
33You still need to adjust the Makefile.am.
34