From 818c60b1582d2559cdda4bdb05482eefeffa8dad Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Thu, 30 Jun 2005 14:42:38 +0000 Subject: [PATCH] add notes on pkg-config Original commit message from CVS: add notes on pkg-config --- docs/libs/.gitignore | 20 +-- docs/libs/Makefile.am | 7 +- docs/libs/compiling.sgml | 42 +++++ docs/libs/gst-plugins-base-libs-docs.sgml | 59 +++++++ docs/libs/gst-plugins-base-libs-sections.txt | 83 ++++++++++ ...gins-libs.types => gst-plugins-base-libs.types} | 0 docs/libs/gst-plugins-libs-docs.sgml | 25 --- docs/libs/gst-plugins-libs-sections.txt | 25 +++ docs/libs/tmpl/gstaudio.sgml | 2 +- docs/libs/tmpl/gstcolorbalance.sgml | 2 +- docs/libs/tmpl/gstringbuffer.sgml | 2 +- docs/libs/tmpl/gsttuner.sgml | 177 +++++++++++++++++++++ 12 files changed, 403 insertions(+), 41 deletions(-) create mode 100644 docs/libs/compiling.sgml create mode 100644 docs/libs/gst-plugins-base-libs-docs.sgml create mode 100644 docs/libs/gst-plugins-base-libs-sections.txt rename docs/libs/{gst-plugins-libs.types => gst-plugins-base-libs.types} (100%) delete mode 100644 docs/libs/gst-plugins-libs-docs.sgml create mode 100644 docs/libs/tmpl/gsttuner.sgml diff --git a/docs/libs/.gitignore b/docs/libs/.gitignore index 471c527..08d7c1e 100644 --- a/docs/libs/.gitignore +++ b/docs/libs/.gitignore @@ -3,13 +3,13 @@ html xml Makefile Makefile.in -gst-plugins-libs-decl.txt -gst-plugins-libs-decl-list.txt -gst-plugins-libs-presed-scan.c -gst-plugins-libs-undocumented.txt -gst-plugins-libs-unused.txt -gst-plugins-libs.args -gst-plugins-libs.hierarchy -gst-plugins-libs.interfaces -gst-plugins-libs.prerequisites -gst-plugins-libs.signals +gst-plugins-base-libs-decl.txt +gst-plugins-base-libs-decl-list.txt +gst-plugins-base-libs-presed-scan.c +gst-plugins-base-libs-undocumented.txt +gst-plugins-base-libs-unused.txt +gst-plugins-base-libs.args +gst-plugins-base-libs.hierarchy +gst-plugins-base-libs.interfaces +gst-plugins-base-libs.prerequisites +gst-plugins-base-libs.signals diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index 404ec7e..6d6fbda 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -2,10 +2,10 @@ # The name of the module, e.g. 'glib'. #DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@ -DOC_MODULE=gst-plugins-libs +DOC_MODULE=gst-plugins-base-libs # for upload.mak -DOC=gst-plugins-libs +DOC=gst-plugins-base-libs FORMATS=html html: html-build.stamp include $(srcdir)/../upload.mak @@ -75,7 +75,7 @@ IGNORE_HFILES = HTML_IMAGES = # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = +content_files = compiling.sgml # Other files to distribute. extra_files = @@ -212,6 +212,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) if test -d html; then rm -rf html; fi mkdir html @cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html + @for f in $(content_files); do cp $(srcdir)/$$f html; done cp -pr xml html cp ../version.entities html cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) diff --git a/docs/libs/compiling.sgml b/docs/libs/compiling.sgml new file mode 100644 index 0000000..4b6ae31 --- /dev/null +++ b/docs/libs/compiling.sgml @@ -0,0 +1,42 @@ + + +Compiling +3 +GLib Library + + + +Compiling against the base plugins libraries + +How to compile against the base plugins libraries + + + + +Compiling against the base plugins libraries + + +To compile against these libraries, you need to tell the compiler where to +find the header files and libraries. This is done with the +pkg-config utility. + + +The following interactive shell session demonstrates how +pkg-config is used: + +$ pk-gconfig --cflags gstreamer-plugins-base-&GST_MAJORMINOR; +-D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -pthread -I/usr/include/gstreamer-&GST_MAJORMINOR; -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/libxml2 +$ pkg-config --libs gstreamer-plugins-base-&GST_MAJORMINOR; +-Wl,--export-dynamic -pthread -lgstreamer-&GST_MAJORMINOR; -lgobject-2.0 -lgmodule-2.0 -ldl -lgthread-2.0 -lxml2 -lpthread -lz -lm -lglib-2.0 + + + + +Note that, because of the number of libraries provided in this package, +the pkg-config information does not add -l flags itself +to choose the libraries to link to. You must add these yourself to select +which of the libraries you want to use. + + + + diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml new file mode 100644 index 0000000..6761cef --- /dev/null +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -0,0 +1,59 @@ + + +%version-entities; + + + + + + + + +]> + + + GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual + + + + GStreamer Base Plugins Libraries + +This manual describes the libraries provided by the GStreamer Base Plugins +package. + + &GstCompiling; + + + + Audio Library + +This library should be linked to by getting cflags and libs from +gstreamer-plugins-base.pc and adding +-lgstaudio-&GST_MAJORMINOR; to the library flags. + + &GstAudio; + &GstRingBuffer; + + + + Interfaces Library + +This library should be linked to by getting cflags and libs from +gstreamer-plugins-base.pc and adding +-lgstinterfaces-&GST_MAJORMINOR; to the library flags. + + &GstColorBalance; + &GstTuner; + + + + GConf Library + +This library should be linked to by getting cflags and libs from +gstreamer-gconf.pc. + + &GstGConf; + + diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt new file mode 100644 index 0000000..65a11c8 --- /dev/null +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -0,0 +1,83 @@ +
+gstaudio +gst/audio/audio.h +GstAudioFieldFlag +gst_audio_frame_byte_size +gst_audio_frame_length +gst_audio_frame_rate +gst_audio_length +gst_audio_highest_sample_value +gst_audio_is_buffer_framed +gst_audio_structure_set_int +
+ +
+gstcolorbalance +gst/interfaces/colorbalance.h +GstColorBalance +GstColorBalanceClass +gst_color_balance_list_channels +gst_color_balance_get_value +gst_color_balance_set_value +gst_color_balance_value_changed +
+ +
+gstgconf +gst/gconf/gconf.h +gst_gconf_get_string +
+ +
+gstringbuffer +gst/audio/gstringbuffer.h +GstRingBuffer +GstRingBufferClass + +gst_ringbuffer_set_callback + +gst_ringbuffer_acquire +gst_ringbuffer_release +gst_ringbuffer_is_acquired + +gst_ringbuffer_play +gst_ringbuffer_pause +gst_ringbuffer_stop + +gst_ringbuffer_delay +gst_ringbuffer_played_samples +gst_ringbuffer_set_sample +gst_ringbuffer_commit + +gst_ringbuffer_prepare_read +gst_ringbuffer_clear +gst_ringbuffer_advance + +
+ +
+gsttuner +gst/interfaces/tuner.h +GstTuner +GstTunerClass +gst_tuner_list_channels +gst_tuner_get_channel +gst_tuner_set_channel + +gst_tuner_list_norms +gst_tuner_get_norm +gst_tuner_set_norm + +gst_tuner_set_frequency +gst_tuner_signal_strength + +gst_tuner_find_norm_by_name +gst_tuner_find_channel_by_name + +gst_tuner_channel_changed +gst_tuner_norm_changed +gst_tuner_frequency_changed +gst_tuner_signal_changed +
+ + diff --git a/docs/libs/gst-plugins-libs.types b/docs/libs/gst-plugins-base-libs.types similarity index 100% rename from docs/libs/gst-plugins-libs.types rename to docs/libs/gst-plugins-base-libs.types diff --git a/docs/libs/gst-plugins-libs-docs.sgml b/docs/libs/gst-plugins-libs-docs.sgml deleted file mode 100644 index d96821a..0000000 --- a/docs/libs/gst-plugins-libs-docs.sgml +++ /dev/null @@ -1,25 +0,0 @@ - - -%version-entities; - - - - - - -]> - - - GStreamer &GST_MAJORMINOR; Plugin Library Reference Manual - - - - GStreamer Plugin Libraries - &GstAudio; - &GstRingBuffer; - &GstColorBalance; - &GstGConf; - - diff --git a/docs/libs/gst-plugins-libs-sections.txt b/docs/libs/gst-plugins-libs-sections.txt index 43e6702..65a11c8 100644 --- a/docs/libs/gst-plugins-libs-sections.txt +++ b/docs/libs/gst-plugins-libs-sections.txt @@ -55,4 +55,29 @@ gst_ringbuffer_advance +
+gsttuner +gst/interfaces/tuner.h +GstTuner +GstTunerClass +gst_tuner_list_channels +gst_tuner_get_channel +gst_tuner_set_channel + +gst_tuner_list_norms +gst_tuner_get_norm +gst_tuner_set_norm + +gst_tuner_set_frequency +gst_tuner_signal_strength + +gst_tuner_find_norm_by_name +gst_tuner_find_channel_by_name + +gst_tuner_channel_changed +gst_tuner_norm_changed +gst_tuner_frequency_changed +gst_tuner_signal_changed +
+ diff --git a/docs/libs/tmpl/gstaudio.sgml b/docs/libs/tmpl/gstaudio.sgml index 2352480..f6ee50a 100644 --- a/docs/libs/tmpl/gstaudio.sgml +++ b/docs/libs/tmpl/gstaudio.sgml @@ -2,7 +2,7 @@ gstaudio - +a support library for audio elements diff --git a/docs/libs/tmpl/gstcolorbalance.sgml b/docs/libs/tmpl/gstcolorbalance.sgml index ed6da75..3d401d8 100644 --- a/docs/libs/tmpl/gstcolorbalance.sgml +++ b/docs/libs/tmpl/gstcolorbalance.sgml @@ -2,7 +2,7 @@ gstcolorbalance - +interface for elements that provide color balance operations diff --git a/docs/libs/tmpl/gstringbuffer.sgml b/docs/libs/tmpl/gstringbuffer.sgml index 7325028..463abfb 100644 --- a/docs/libs/tmpl/gstringbuffer.sgml +++ b/docs/libs/tmpl/gstringbuffer.sgml @@ -2,7 +2,7 @@ gstringbuffer - +an implementation of an audio ringbuffer diff --git a/docs/libs/tmpl/gsttuner.sgml b/docs/libs/tmpl/gsttuner.sgml new file mode 100644 index 0000000..c815a5f --- /dev/null +++ b/docs/libs/tmpl/gsttuner.sgml @@ -0,0 +1,177 @@ + +gsttuner + + +interface for elements that provide tuner operations + + + + + + + + + + + + + + + + + + + + + + +@klass: +@list_channels: +@set_channel: +@get_channel: +@list_norms: +@set_norm: +@get_norm: +@set_frequency: +@get_frequency: +@signal_strength: +@channel_changed: +@norm_changed: +@frequency_changed: +@signal_changed: +@_gst_reserved: + + + + + + +@tuner: +@Returns: + + + + + + + +@tuner: +@Returns: + + + + + + + +@tuner: +@channel: + + + + + + + +@tuner: +@Returns: + + + + + + + +@tuner: +@Returns: + + + + + + + +@tuner: +@norm: + +@channel: + + + + + + + +@tuner: +@channel: +@frequency: + + + + + + + +@tuner: +@channel: +@Returns: + + + + + + + +@tuner: +@norm: +@Returns: + + + + + + + +@tuner: +@channel: +@Returns: + + + + + + + +@tuner: +@channel: + + + + + + + +@tuner: +@norm: + + + + + + + +@tuner: +@channel: +@frequency: + + + + + + + +@tuner: +@channel: +@signal: + + -- 2.7.4