diff options
author | Edward Hervey <edward@centricular.com> | 2020-05-12 17:58:13 +0200 |
---|---|---|
committer | Edward Hervey <bilboed@bilboed.com> | 2020-05-12 17:58:13 +0200 |
commit | 22e51b0972ab4f01647fa1087a9e8104442e2167 (patch) | |
tree | 880329ebb482e7f252be68350fa39de87cc1ce1b | |
parent | 8d54941cd00e797a1f4b94308fd73f95fdd571fd (diff) |
gst-plugin: Move instructions up to main README
And remove no-longer needed NEWS file
-rw-r--r-- | README.md | 22 | ||||
-rw-r--r-- | gst-plugin/NEWS | 1 | ||||
-rw-r--r-- | gst-plugin/README | 34 |
3 files changed, 22 insertions, 35 deletions
@@ -50,6 +50,28 @@ You can also check if it has been built correctly with: gst-inspect-1.0 builddir/gst-plugins/src/libgstplugin.so +## Auto-generating your own plugin + +You will find a helper script in `gst-plugins/tools/make_element` to generate +the source/header files for a new plugin. + +To create sources for `myfilter` based on the `gsttransform` template run: + +``` shell +cd src; +../tools/make_element myfilter gsttransform +``` + +This will create `gstmyfilter.c` and `gstmyfilter.h`. Open them in an editor and +start editing. There are several occurances of the string `template`, update +those with real values. The plugin will be called `myfilter` and it will have +one element called `myfilter` too. Also look for `FIXME:` markers that point you +to places where you need to edit the code. + +You can then add your sources files to `gst-plugins/meson.build` and re-run +ninja to have your plugin built. + + [MIT]: http://www.opensource.org/licenses/mit-license.php or COPYING.MIT [LGPL]: http://www.opensource.org/licenses/lgpl-license.php or COPYING.LIB [Licensing]: https://gstreamer.freedesktop.org/documentation/application-development/appendix/licensing.html diff --git a/gst-plugin/NEWS b/gst-plugin/NEWS deleted file mode 100644 index 3474a99..0000000 --- a/gst-plugin/NEWS +++ /dev/null @@ -1 +0,0 @@ -Nothing much yet. diff --git a/gst-plugin/README b/gst-plugin/README deleted file mode 100644 index 1905684..0000000 --- a/gst-plugin/README +++ /dev/null @@ -1,34 +0,0 @@ -WHAT IT IS ----------- - -gst-plugin is a template for writing your own GStreamer plug-in. - -The code is deliberately kept simple so that you quickly understand the basics -of how to set up autotools and your source tree. - -This template demonstrates : -- what to do in autogen.sh -- how to setup configure.ac (your package name and version, GStreamer flags) -- how to setup your source dir -- what to put in Makefile.am - -More features and templates might get added later on. - -HOW TO USE IT -------------- - -To use it, either make a copy for yourself and rename the parts or use the -make_element script in tools. To create sources for "myfilter" based on the -"gsttransform" template run: - -cd src; -../tools/make_element myfilter gsttransform - -This will create gstmyfilter.c and gstmyfilter.h. Open them in an editor and -start editing. There are several occurances of the string "template", update -those with real values. The plugin will be called 'myfilter' and it will have -one element called 'myfilter' too. Also look for "FIXME:" markers that point you -to places where you need to edit the code. - -You still need to adjust the Makefile.am. - |