mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-19 14:56:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

add notes on pkg-config

Browse source 
Original commit message from CVS:
add notes on pkg-config
This commit is contained in:
Thomas Vander Stichele 2005-06-30 14:42:38 +00:00
parent 79c44e6e4e
commit 818c60b158
12 changed files with 403 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/libs/.gitignore vendored
View file

@ -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

7
docs/libs/Makefile.am
View file

@ -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)

42
docs/libs/compiling.sgml Normal file
View file

@ -0,0 +1,42 @@
<refentry id="compiling" revision="17 Jan 2002">
<refmeta>
<refentrytitle>Compiling</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GLib Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Compiling against the base plugins libraries</refname>
<refpurpose>
How to compile against the base plugins libraries
</refpurpose>
</refnamediv>
<refsect1>
<title>Compiling against the base plugins libraries</title>
<para>
To compile against these libraries, you need to tell the compiler where to
find the header files and libraries. This is done with the
<application>pkg-config</application> utility.
</para>
<para>
The following interactive shell session demonstrates how
<application>pkg-config</application> is used:
<programlisting>
$ 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
</programlisting>
</para>
<para>
Note that, because of the number of libraries provided in this package,
the pkg-config information <emphasis>does not add -l flags</emphasis> itself
to choose the libraries to link to. You must add these yourself to select
which of the libraries you want to use.
</para>
</refsect1>
</refentry>

59
docs/libs/gst-plugins-base-libs-docs.sgml Normal file
View file

@ -0,0 +1,59 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstCompiling SYSTEM "compiling.sgml">
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
]>
<book id="index">
<bookinfo>
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
</bookinfo>
<chapter id="gstreamer-plugins-base">
<title>GStreamer Base Plugins Libraries</title>
<para>
This manual describes the libraries provided by the GStreamer Base Plugins
package.
</para>
&GstCompiling;
</chapter>
<chapter id="gstreamer-audio">
<title>Audio Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstAudio;
&GstRingBuffer;
</chapter>
<chapter id="gstreamer-interfaces">
<title>Interfaces Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstTuner;
</chapter>
<chapter id="gstreamer-gconf">
<title>GConf Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-gconf.pc</filename>.
</para>
&GstGConf;
</chapter>
</book>

83
docs/libs/gst-plugins-base-libs-sections.txt Normal file
View file

@ -0,0 +1,83 @@
<SECTION>
<FILE>gstaudio</FILE>
<INCLUDE>gst/audio/audio.h</INCLUDE>
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
</SECTION>
<SECTION>
<FILE>gstcolorbalance</FILE>
<INCLUDE>gst/interfaces/colorbalance.h</INCLUDE>
GstColorBalance
GstColorBalanceClass
gst_color_balance_list_channels
gst_color_balance_get_value
gst_color_balance_set_value
gst_color_balance_value_changed
</SECTION>
<SECTION>
<FILE>gstgconf</FILE>
<INCLUDE>gst/gconf/gconf.h</INCLUDE>
gst_gconf_get_string
</SECTION>
<SECTION>
<FILE>gstringbuffer</FILE>
<INCLUDE>gst/audio/gstringbuffer.h</INCLUDE>
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
</SECTION>
<SECTION>
<FILE>gsttuner</FILE>
<INCLUDE>gst/interfaces/tuner.h</INCLUDE>
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
</SECTION>

0
docs/libs/gst-plugins-libs.types → docs/libs/gst-plugins-base-libs.types
View file

25
docs/libs/gst-plugins-libs-docs.sgml
View file

@ -1,25 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
]>
<book id="index">
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Plugin Library Reference Manual</title>
</bookinfo>
<chapter>
<title>GStreamer Plugin Libraries</title>
&GstAudio;
&GstRingBuffer;
&GstColorBalance;
&GstGConf;
</chapter>
</book>

25
docs/libs/gst-plugins-libs-sections.txt
View file

@ -55,4 +55,29 @@ gst_ringbuffer_advance
</SECTION>
<SECTION>
<FILE>gsttuner</FILE>
<INCLUDE>gst/interfaces/tuner.h</INCLUDE>
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
</SECTION>

2
docs/libs/tmpl/gstaudio.sgml
View file

@ -2,7 +2,7 @@
gstaudio
<!-- ##### SECTION Short_Description ##### -->
a support library for audio elements
<!-- ##### SECTION Long_Description ##### -->
<para>

2
docs/libs/tmpl/gstcolorbalance.sgml
View file

@ -2,7 +2,7 @@
gstcolorbalance
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide color balance operations
<!-- ##### SECTION Long_Description ##### -->
<para>

2
docs/libs/tmpl/gstringbuffer.sgml
View file

@ -2,7 +2,7 @@
gstringbuffer
<!-- ##### SECTION Short_Description ##### -->
an implementation of an audio ringbuffer
<!-- ##### SECTION Long_Description ##### -->
<para>

177
docs/libs/tmpl/gsttuner.sgml Normal file
View file

@ -0,0 +1,177 @@
<!-- ##### SECTION Title ##### -->
gsttuner
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide tuner operations
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstTuner ##### -->
<para>
</para>
<!-- ##### STRUCT GstTunerClass ##### -->
<para>
</para>
@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:
<!-- ##### FUNCTION gst_tuner_list_channels ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_channel ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_channel ##### -->
<para>
</para>
@tuner:
@channel:
<!-- ##### FUNCTION gst_tuner_list_norms ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_norm ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_norm ##### -->
<para>
</para>
@tuner:
@norm:
<!-- # Unused Parameters # -->
@channel:
<!-- ##### FUNCTION gst_tuner_set_frequency ##### -->
<para>
</para>
@tuner:
@channel:
@frequency:
<!-- ##### FUNCTION gst_tuner_signal_strength ##### -->
<para>
</para>
@tuner:
@channel:
@Returns:
<!-- ##### FUNCTION gst_tuner_find_norm_by_name ##### -->
<para>
</para>
@tuner:
@norm:
@Returns:
<!-- ##### FUNCTION gst_tuner_find_channel_by_name ##### -->
<para>
</para>
@tuner:
@channel:
@Returns:
<!-- ##### FUNCTION gst_tuner_channel_changed ##### -->
<para>
</para>
@tuner:
@channel:
<!-- ##### FUNCTION gst_tuner_norm_changed ##### -->
<para>
</para>
@tuner:
@norm:
<!-- ##### FUNCTION gst_tuner_frequency_changed ##### -->
<para>
</para>
@tuner:
@channel:
@frequency:
<!-- ##### FUNCTION gst_tuner_signal_changed ##### -->
<para>
</para>
@tuner:
@channel:
@signal: