...
 
Commits (668)
......@@ -52,6 +52,7 @@ Makefile
/gst-libs/gst/audio/audio-marshal.[ch]
/gst-libs/gst/video/video-marshal.[ch]
/gst-libs/gst/*/*-enumtypes.[ch]
/tests/examples/compositor/crossfade
/tests/examples/playback/playback-test
tmp-orc.c
......
This diff is collapsed.
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
if BUILD_EXTERNAL
SUBDIRS_EXT = ext
else
......@@ -12,14 +10,12 @@ SUBDIRS = \
gst sys $(SUBDIRS_EXT) \
tools \
tests \
docs \
po \
common \
m4
DIST_SUBDIRS = \
pkgconfig \
docs \
gst-libs \
gst sys ext \
tools \
......@@ -79,7 +75,6 @@ CRUFT_FILES = \
CRUFT_DIRS = \
$(top_srcdir)/docs/design \
$(top_srcdir)/docs/plugins/tmpl \
$(top_srcdir)/ext/gio \
$(top_srcdir)/gst/gdp \
$(top_srcdir)/sys/v4l \
......
This diff is collapsed.
GStreamer 1.15.x development series
GStreamer 1.17.x development series
WHAT IT IS
----------
......
This is GStreamer gst-plugins-base 1.15.0.1.
This is GStreamer gst-plugins-base 1.17.0.1.
GStreamer 1.15 is the development version leading up to the next major
stable version which will be 1.16.
The GStreamer team is thrilled to announce a new major feature release in the
stable 1.0 API series of your favourite cross-platform multimedia framework!
The 1.15 development series adds new features on top of the 1.14 series and is
As always, this release is again packed with new features, bug fixes and
other improvements.
The 1.16 release series adds new features on top of the 1.14 series and is
part of the API and ABI-stable 1.x release series of the GStreamer multimedia
framework.
......@@ -11,8 +14,8 @@ Full release notes will one day be found at:
https://gstreamer.freedesktop.org/releases/1.16/
Binaries for Android, iOS, Mac OS X and Windows will be provided shortly
after the release.
Binaries for Android, iOS, Mac OS X and Windows will usually be provided
shortly after the release.
This module will not be very useful by itself and should be used in conjunction
with other GStreamer modules for a complete multimedia experience.
......@@ -57,7 +60,7 @@ You can find source releases of gstreamer in the download
directory: https://gstreamer.freedesktop.org/src/gstreamer/
The git repository and details how to clone it can be found at
http://cgit.freedesktop.org/gstreamer/gstreamer/
https://cgit.freedesktop.org/gstreamer/gstreamer/
==== Homepage ====
......@@ -65,10 +68,16 @@ The project's website is https://gstreamer.freedesktop.org/
==== Support and Bugs ====
We use GNOME's bugzilla for bug reports and feature requests:
http://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer
We have recently moved from GNOME Bugzilla to GitLab on freedesktop.org
for bug reports and feature requests:
https://gitlab.freedesktop.org/gstreamer
Please submit patches via GitLab as well, in form of Merge Requests. See
https://gstreamer.freedesktop.org/documentation/contribute/
Please submit patches via bugzilla as well.
for more details.
For help and support, please subscribe to and send questions to the
gstreamer-devel mailing list (see below for details).
......@@ -77,8 +86,14 @@ There is also a #gstreamer IRC channel on the Freenode IRC network.
==== Developers ====
GStreamer is stored in Git, hosted at git.freedesktop.org, and can be cloned
from there (see link above).
GStreamer source code repositories can be found on GitLab on freedesktop.org:
https://gitlab.freedesktop.org/gstreamer
and can also be cloned from there and this is also where you can submit
Merge Requests or file issues for bugs or feature requests.
Interested developers of the core library, plugins, and applications should
subscribe to the gstreamer-devel list.
subscribe to the gstreamer-devel list:
https://lists.freedesktop.org/mailman/listinfo/gstreamer-devel
Subproject commit cd1dee06bf07f094677d0cf3eea4a2e8c2636b24
Subproject commit 59cb678164719ff59dcf6c8b93df4617a1075d11
AC_PREREQ([2.69])
dnl please read gstreamer/docs/random/autotools before changing this file
dnl initialize autoconf
dnl releases only do -Wall, git and prerelease does -Werror too
dnl use a three digit version number for releases, and four for git/prerelease
AC_INIT([GStreamer Base Plug-ins],[1.15.0.1],[http://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer],[gst-plugins-base])
AC_INIT([GStreamer Base Plug-ins],[1.17.0.1],[http://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer],[gst-plugins-base])
AG_GST_INIT
......@@ -56,10 +54,10 @@ dnl 1.2.5 => 205
dnl 1.10.9 (who knows) => 1009
dnl
dnl sets GST_LT_LDFLAGS
AS_LIBTOOL(GST, 1500, 0, 1500)
AS_LIBTOOL(GST, 1700, 0, 1700)
dnl *** required versions of GStreamer stuff ***
GST_REQ=1.15.0.1
GST_REQ=1.17.0.1
dnl *** autotools stuff ****
......@@ -157,10 +155,6 @@ AM_CONDITIONAL(HAVE_VALGRIND, test ! "x$VALGRIND_PATH" = "xno")
dnl check for gobject-introspection
GOBJECT_INTROSPECTION_CHECK([1.31.1])
dnl check for documentation tools
GTK_DOC_CHECK([1.12])
AG_GST_PLUGIN_DOCS([1.12])
dnl *** checks for libraries ***
dnl libm, for sin() etc.
......@@ -498,6 +492,7 @@ AG_GST_CHECK_PLUGIN(audioconvert)
AG_GST_CHECK_PLUGIN(audiomixer)
AG_GST_CHECK_PLUGIN(audiorate)
AG_GST_CHECK_PLUGIN(audiotestsrc)
AG_GST_CHECK_PLUGIN(compositor)
AG_GST_CHECK_PLUGIN(encoding)
AG_GST_CHECK_PLUGIN(videoconvert)
AG_GST_CHECK_PLUGIN(gio)
......@@ -922,6 +917,7 @@ gst/audiomixer/Makefile
gst/audiorate/Makefile
gst/audioresample/Makefile
gst/audiotestsrc/Makefile
gst/compositor/Makefile
gst/encoding/Makefile
gst/videoconvert/Makefile
gst/gio/Makefile
......@@ -1008,6 +1004,7 @@ tests/check/Makefile
tests/examples/Makefile
tests/examples/app/Makefile
tests/examples/audio/Makefile
tests/examples/compositor/Makefile
tests/examples/decodebin_next/Makefile
tests/examples/dynamic/Makefile
tests/examples/encoding/Makefile
......@@ -1037,10 +1034,6 @@ tests/examples/playrec/Makefile
tests/files/Makefile
tests/icles/Makefile
tests/icles/playback/Makefile
docs/Makefile
docs/libs/Makefile
docs/plugins/Makefile
docs/version.entities
po/Makefile.in
common/Makefile
common/m4/Makefile
......
if ENABLE_GTK_DOC
if ENABLE_PLUGIN_DOCS
PLUGIN_DOCS_DIRS = plugins
else
PLUGIN_DOCS_DIRS =
endif
else
PLUGIN_DOCS_DIRS = plugins
endif
SUBDIRS = libs $(PLUGIN_DOCS_DIRS)
DIST_SUBDIRS = libs plugins
EXTRA_DIST = \
version.entities.in
upload:
@if test "x$(SUBDIRS)" != x; then for a in $(SUBDIRS); do cd $$a; make upload; cd ..; done; fi
@GST_API_VERSION@
---
short-description: GStreamer Base Plugins API reference.
...
# GStreamer Base Plugins
*.stamp
html
tmpl
xml
Makefile
Makefile.in
*-decl.txt
*-decl-list.txt
*-presed-scan.c
*-undeclared.txt
*-undocumented.txt
*-unused.txt
*.args
*.hierarchy
*.interfaces
*.prerequisites
*.signals
doc-registry.xml
*-unused.sgml
*.bak
## Process this file with automake to produce Makefile.in
# FIXME: fix the docs then remove this variable
DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
DOC_MODULE=gst-plugins-base-libs
# for upload-doc.mak
DOC=gst-plugins-base-libs
FORMATS=html
html: html-build.stamp
include $(top_srcdir)/common/upload-doc.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code.
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
--ignore-decorators="GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API|GST_ALLOCATORS_API|GST_APP_API|GST_AUDIO_API|GST_FFT_API|GST_GL_API|GST_PBUTILS_API|GST_RIFF_API|GST_RTP_API|GST_RTSP_API|GST_SDP_API|GST_TAG_API|GST_VIDEO_API"
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
--extra-dir=$(GST_PREFIX)/share/gtk-doc/html
# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
KISS_FFT_HFILES=$(wildcard $(top_srcdir)/gst-libs/gst/fft/*kiss_fft*.h)
# Header files to ignore when scanning.
# Note that you can't use glob, so all headers to be ignored must be specified
IGNORE_HFILES = \
$(top_srcdir)/gst-libs/gst/gettext.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-app.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-plugin.h \
$(top_srcdir)/gst-libs/gst/glib-compat-private.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudioutilsprivate.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack-dist.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-private.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-macros.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse2.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse41.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-neon.h \
$(top_srcdir)/gst-libs/gst/gl/gstglcontext_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglfeature_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglfuncs.h \
$(top_srcdir)/gst-libs/gst/gl/gstglsl_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglutil_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglwindow_private.h \
$(top_srcdir)/gst-libs/gst/gl/android/gstglwindow_android_egl.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglcontext_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglwindow_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstgl_cocoa_private.h \
$(top_srcdir)/gst-libs/gst/gl/dispmanx/gstglwindow_dispmanx_egl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglwindow_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglcontext_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/egl/gstglcontext_egl.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgl_gbm_utils.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgldisplay_gbm.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstglwindow_gbm_egl.h \
$(top_srcdir)/gst-libs/gst/gl/utils/opengl_versions.h \
$(top_srcdir)/gst-libs/gst/gl/utils/gles_versions.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstgldisplay_viv_fb.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstglwindow_viv_fb_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/gstglwindow_wayland_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/wayland_event_source.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglcontext_wgl.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglwindow_win32.h \
$(top_srcdir)/gst-libs/gst/gl/win32/win32_message_source.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglwindow_x11.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglcontext_glx.h \
$(top_srcdir)/gst-libs/gst/gl/x11/xcb_event_source.h \
$(KISS_FFT_HFILES) \
$(top_srcdir)/gst-libs/gst/pbutils/pbutils-private.h \
$(top_srcdir)/gst-libs/gst/tag/gsttageditingprivate.h \
$(top_srcdir)/gst-libs/gst/tag/id3v2.h \
$(top_srcdir)/gst-libs/gst/video/gstvideoutilsprivate.h \
$(top_srcdir)/gst-libs/gst/video/video-orc.h \
$(top_srcdir)/gst-libs/gst/video/video-orc-dist.h
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files = compiling.sgml
# Other files to distribute.
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
GTKDOC_LIBS = \
$(top_builddir)/gst-libs/gst/allocators/libgstallocators-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/rtsp/libgstrtsp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/app/libgstapp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/riff/libgstriff-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/gl/libgstgl-@GST_API_VERSION@.la \
$(GST_BASE_LIBS)
# If you need to override some of the declarations, place them in this file
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
include $(top_srcdir)/common/gtk-doc.mak
# Allocators Library
This library should be linked to by getting cflags and libs from
gstreamer-plugins-base-{{ gst_api_version.md }}.pc and adding
-lgstallocators-{{ gst_api_version.md }} to the library flags.
# App Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}pc` and adding
-lgstapp-{{ gst_api_version.md }} to the library flags.
To use it the functionality, insert an `appsrc` or `appsink` element
into a pipeline and call the appropriate functions on the element.
# Audio Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstaudio-{{ gst_api_version.md }}` to the library flags.
<?xml version="1.0"?>
<!DOCTYPE refentry 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;
]>
<refentry id="compiling" revision="17 Jan 2002">
<refmeta>
<refentrytitle>Compiling</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GStreamer-Base 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>
$ pkg-config --cflags gstreamer-plugins-base-&GST_API_VERSION;
-D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -pthread -I/usr/include/gstreamer-&GST_API_VERSION; -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/libxml2
$ pkg-config --libs gstreamer-plugins-base-&GST_API_VERSION;
-Wl,--export-dynamic -pthread -lgstreamer-&GST_API_VERSION; -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>
# FFT Library
The gstfft library is based on
[kissfft](http://sourceforge.net/projects/kissfft) by Mark Borgerding.
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstfft-{{ gst_api_version.md }}` to the library flags.
This diff is collapsed.
This diff is collapsed.
#include <gst/gst.h>
#include <gst/allocators/allocators.h>
gst_dmabuf_allocator_get_type
gst_fd_allocator_get_type
gst_phys_memory_allocator_get_type
#include <gst/app/app.h>
gst_app_src_get_type
gst_app_sink_get_type
gst_app_stream_type_get_type
#include <gst/audio/audio.h>
gst_audio_info_get_type
gst_audio_flags_get_type
gst_audio_format_flags_get_type
gst_audio_format_get_type
gst_audio_format_info_get_type
gst_audio_layout_get_type
gst_audio_pack_flags_get_type
gst_audio_resampler_filter_interpolation_get_type
gst_audio_resampler_filter_mode_get_type
gst_audio_resampler_flags_get_type
gst_audio_resampler_method_get_type
gst_audio_stream_align_get_type
gst_audio_aggregator_get_type
gst_audio_aggregator_pad_get_type
gst_audio_aggregator_convert_pad_get_type
gst_audio_cd_src_get_type
gst_audio_clock_get_type
gst_audio_decoder_get_type
gst_audio_encoder_get_type
gst_audio_filter_get_type
gst_audio_sink_get_type
gst_audio_src_get_type
gst_audio_base_sink_get_type
gst_audio_base_sink_slave_method_get_type
gst_audio_base_sink_discont_reason_get_type
gst_audio_base_src_get_type
gst_audio_ring_buffer_get_type
gst_stream_volume_get_type
#include <gst/rtp/rtp.h>
gst_rtp_base_depayload_get_type
gst_rtp_base_payload_get_type
gst_rtp_base_audio_payload_get_type
#include <gst/video/video.h>
gst_video_filter_get_type
gst_video_sink_get_type
gst_color_balance_get_type
gst_color_balance_channel_get_type
gst_video_direction_get_type
gst_video_orientation_get_type
gst_video_overlay_get_type
gst_video_encoder_get_type
gst_video_decoder_get_type
gst_video_buffer_pool_get_type
gst_navigation_get_type
#include <gst/pbutils/pbutils.h>
gst_discoverer_get_type
gst_discoverer_serialize_flags_get_type
gst_audio_visualizer_get_type
gst_encoding_profile_get_type
gst_encoding_video_profile_get_type
gst_encoding_video_profile_get_type
gst_encoding_audio_profile_get_type
gst_encoding_container_profile_get_type
gst_encoding_target_get_type
#include <gst/gl/gl.h>
gst_gl_allocation_params_get_type
gst_gl_base_memory_allocator_get_type
gst_gl_buffer_allocation_params_get_type
gst_gl_buffer_allocator_get_type
gst_gl_video_allocation_params_get_type
gst_gl_memory_allocator_get_type
gst_gl_memory_pbo_allocator_get_type
gst_gl_renderbuffer_allocation_params_get_type
gst_gl_renderbuffer_allocator_get_type
gst_gl_base_filter_get_type
gst_gl_buffer_pool_get_type
gst_gl_color_convert_get_type
gst_gl_context_get_type
gst_gl_display_get_type
gst_gl_filter_get_type
gst_gl_framebuffer_get_type
gst_gl_shader_get_type
gst_glsl_stage_get_type
gst_gl_overlay_compositor_get_type
gst_gl_upload_get_type
gst_gl_view_convert_get_type
gst_gl_window_get_type
#include <gst/gl/wayland/gstgldisplay_wayland.h>
gst_gl_display_wayland_get_type
#include <gst/rtsp/rtsp.h>
gst_rtsp_auth_method_get_type
gst_rtsp_auth_credential_get_type
gst_rtsp_event_get_type
gst_rtsp_family_get_type
gst_rtsp_header_field_get_type
gst_rtsp_lower_trans_get_type
gst_rtsp_method_get_type
gst_rtsp_msg_type_get_type
gst_rtsp_profile_get_type
gst_rtsp_range_unit_get_type
gst_rtsp_result_get_type
gst_rtsp_state_get_type
gst_rtsp_status_code_get_type
gst_rtsp_time_type_get_type
gst_rtsp_trans_mode_get_type
gst_rtsp_version_get_type
gst_rtsp_extension_get_type
gst_rtsp_auth_credential_get_type
gst_rtsp_auth_param_get_type
gst_rtsp_msg_get_type
gst_rtsp_url_get_type
# FIXME: .types file shouldn't have gl types in it if we don't build gstgl,
# but then what about the other files (sections, sgml)
types = configure_file(input : 'gst-plugins-base-libs.types',
output : 'gst-plugins-base-libs.types',
copy : true)
ignored_headers = ['pbutils-private.h', 'gsttageditingprivate.h', 'id3v2.h',
'kiss_fft_f32.h', 'kiss_fft_f64.h', 'kiss_fftr_f32.h', 'kiss_fftr_f64.h',
'kiss_fftr_s16.h', 'kiss_fftr_s32.h', 'kiss_fft_s16.h', 'kiss_fft_s32.h',
'_kiss_fft_guts_f32.h', '_kiss_fft_guts_f64.h', '_kiss_fft_guts_s16.h',
'_kiss_fft_guts_s16.h', '_kiss_fft_guts_s32.h', '_kiss_fft_guts_s32.h',
'pbutils-marshal.h']
if build_gstgl
doc_extra_deps = [gstgl_dep]
else
doc_extra_deps = []
endif
gnome.gtkdoc('gst-plugins-base-libs',
main_sgml : 'gst-plugins-base-libs-docs.sgml',
src_dir : '@0@/../../gst-libs/gst'.format(meson.current_source_dir()),
scan_args : ['--deprecated-guards=GST_DISABLE_DEPRECATED',
'--ignore-decorators=GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API|GST_ALLOCATORS_API|GST_APP_API|GST_AUDIO_API|GST_FFT_API|GST_GL_API|GST_PBUTILS_API|GST_RIFF_API|GST_RTP_API|GST_RTSP_API|GST_SDP_API|GST_TAG_API|GST_VIDEO_API'],
ignore_headers : ignored_headers,
scanobjs_args : ['--type-init-func=gst_init(NULL,NULL)'],
gobject_typesfile : types,
content_files : [version_entities],
dependencies : [gst_base_dep, app_dep, allocators_dep, audio_dep,
fft_dep, pbutils_dep, riff_dep, rtp_dep, rtsp_dep, sdp_dep,
tag_dep, video_dep] + doc_extra_deps,
install : true)
# Base Utils Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstpbutils-{{ gst_api_version.md }}` to the library
flags.
gi-index
pbutils.h
encoding-profile.h
# Riff Media Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstriff-{{ gst_api_version.md }}` to the library flags.
# RTP Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstrtp-{{ gst_api_version.md }}` to the library flags.
# RTSP Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstrtsp-{{ gst_api_version.md }}` to the library flags.
# SDP Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstsdp-{{ gst_api_version.md }}` to the library flags.
# Tag Support Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgsttag-{{ gst_api_version.md }}` to the library flags.
# Video Library
This library should be linked to by getting cflags and libs from
`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
`-lgstvideo-{{ gst_api_version.md }}` to the library flags.
docconf = configuration_data()
build_hotdoc = false
if meson.is_cross_build()
if get_option('doc').enabled()
error('Documentation enabled but building the doc while cross building is not supported yet.')
endif
message('Documentation not built as building it while cross building is not supported yet.')
subdir_done()
endif
required_hotdoc_extensions = ['gi-extension', 'gst-extension']
if gst_dep.type_name() == 'internal'
gst_proj = subproject('gstreamer')
plugins_cache_generator = gst_proj.get_variable('plugins_cache_generator')
else
plugins_cache_generator = find_program(join_paths(gst_dep.get_pkgconfig_variable('libexecdir'), 'gstreamer-' + api_version, 'gst-plugins-doc-cache-generator'),
required: false)
endif
plugins_cache = join_paths(meson.current_source_dir(), 'plugins', 'gst_plugins_cache.json')
if plugins_cache_generator.found()
plugins_doc_dep = custom_target('base-plugins-doc-cache',
command: [plugins_cache_generator, plugins_cache, '@OUTPUT@', '@INPUT@'],
input: plugins,
output: 'gst_plugins_cache.json',
)
else
warning('GStreamer plugin inspector for documentation not found, can\'t update the cache')
endif
hotdoc_p = find_program('hotdoc', required: get_option('doc'))
if not hotdoc_p.found()
message('Hotdoc not found, not building the documentation')
subdir_done()
endif
hotdoc = import('hotdoc')
foreach extension: required_hotdoc_extensions
if not hotdoc.has_extensions(extension)
if get_option('doc').enabled()
error('Documentation enabled but @0@ missing'.format(extension))
endif
message('@0@ extension not found, not building documentation'.format(extension))
subdir_done()
endif
endforeach
if not build_gir
if get_option('doc').enabled()
error('Documentation enabled but introspection not built.')
endif
message('Introspection not built, can\'t build the documentation')
subdir_done()
endif
build_hotdoc = true
docconf = configuration_data()
docconf.set('GST_API_VERSION', api_version)
docconf.set('VERSION', gst_version)
docconf.set('PLUGINDIR', '@0@/lib/gstreamer-1.0'.format(get_option('prefix')))
version_entities = configure_file(input : 'version.entities.in',
output : 'version.entities',
configuration : docconf)
version_entities = configure_file(input : 'version.in',
output : 'gst_api_version.md',
configuration : docconf)
libs_excludes = []
foreach h: ['pbutils-private.h', 'gsttageditingprivate.h', 'id3v2.h',
'kiss_fft_f32.h', 'kiss_fft_f64.h', 'kiss_fftr_f32.h', 'kiss_fftr_f64.h',
'kiss_fftr_s16.h', 'kiss_fftr_s32.h', 'kiss_fft_s16.h', 'kiss_fft_s32.h',
'_kiss_fft_guts_f32.h', '_kiss_fft_guts_f64.h', '_kiss_fft_guts_s16.h',
'_kiss_fft_guts_s16.h', '_kiss_fft_guts_s32.h', '_kiss_fft_guts_s32.h',
'pbutils-marshal.h', 'audio-resampler-private.h', '*orc-dist.*',
'*-neon.h', 'audio-resampler-macros.[ch]', '*-prelude.h'
]
libs_excludes += [join_paths(meson.current_source_dir(), '..', 'gst-libs/gst/*/', h)]
endforeach
libs = [
['allocators', allocators_gir, allocators_dep],
['app', app_gir, app_dep],
['audio', audio_gir, audio_dep],
# FIXME! ['fft', fft_gir, fft_dep],
['pbutils', pbutils_gir, pbutils_dep],
['rtp', rtp_gir, rtp_dep],
['rtsp', rtsp_gir, rtsp_dep],
['sdp', sdp_gir, sdp_dep],
['tag', tag_gir, tag_dep],
['video', video_gir, video_dep],
]
if build_gstgl
libs + [['gl', gl_gir, gstgl_dep]]
endif
libs_doc = []
foreach lib: libs
name = lib[0]
gir = lib[1]
deps = [lib[2], gir]
libs_doc += [hotdoc.generate_doc('gst-plugins-base-' + name,
project_version: api_version,
gi_c_sources: [join_paths('../gst-libs/gst', name, '*.[hc]')],
gi_sources: gir[0].full_path(),
gi_c_source_filters: libs_excludes,
gi_c_source_roots: [join_paths(meson.current_source_dir(), '../gst-libs/gst/' + name), ],
sitemap: 'libs/' + name + '/sitemap.txt',
index: 'libs/' + name + '/index.md',
gi_index: 'libs/' + name + '/index.md',
gi_smart_index: true,
gi_order_generated_subpages: true,
dependencies: deps,
install: false,
)]
endforeach
if not hotdoc.has_extensions('c-extension')
if get_option('doc').enabled()
error('Documentation enabled but c-extension missing')
endif
message('c-extension not found, not building documentation')
else
libs_doc += [hotdoc.generate_doc('gst-plugins-base-riff',
project_version: api_version,
c_sources: ['../gst-libs/gst/riff/*.[hc]'],
c_source_filters: libs_excludes,
sitemap: 'libs/riff/sitemap.txt',
index: 'libs/riff/index.md',
c_index: 'libs/riff/index.md',
c_smart_index: true,
c_order_generated_subpages: true,
dependencies: [gst_base_dep, riff_dep],
install: false,
disable_incremental_build: true,
)]
endif
plugins_doc = []
sitemap = 'all_index.md\n'
list_plugin_res = run_command(python3, '-c',
'''
import sys
import json
with open("@0@") as f:
print(':'.join(json.load(f).keys()), end='')
'''.format(plugins_cache))
assert(list_plugin_res.returncode() == 0,
'Could not list plugins from @0@\n@1@\n@1@'.format(plugins_cache, list_plugin_res.stdout(), list_plugin_res.stderr()))
subdir('libs')
foreach plugin_name: list_plugin_res.stdout().split(':')
plugins_doc += [hotdoc.generate_doc(plugin_name,
project_version: api_version,
sitemap: 'plugins/sitemap.txt',
index: 'plugins/index.md',
gst_index: 'plugins/index.md',
gst_smart_index: true,
gst_c_sources: ['../sys/*/*.[ch]',
'../ext/*/*.[ch]',
'../gst/*/*.[ch]',
],
dependencies: [gst_dep, plugins],
gst_order_generated_subpages: true,
gst_cache_file: plugins_cache,
gst_plugin_name: plugin_name,
)]
sitemap += ' @0@-doc.json\n'.format(plugin_name)
endforeach
Makefile
Makefile.in
*-decl.txt
*-decl-list.txt
*-undeclared.txt
*-undocumented.txt
*-unused.txt
tmpl
xml
html
tmpl/*.sgml
gst-plugins-base-plugins-scan
gst-plugins-base-plugins-scan.c
inspect-registry.*
*.new
html-build.stamp
html.stamp
scan-build.stamp
sgml-build.stamp
sgml.stamp
tmpl-build.stamp
tmpl.stamp
GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
MODULE=gst-plugins-base
DOC_MODULE=$(MODULE)-plugins
# for upload-doc.mak
DOC=$(MODULE)-plugins
FORMATS=html
html: html-build.stamp
include $(top_srcdir)/common/upload-doc.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code.
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR = $(top_srcdir)/gst $(top_srcdir)/ext $(top_srcdir)/sys
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/libs/html \
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
--extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
--extra-dir=$(datadir)/gtk-doc/html
# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h
CFILE_GLOB=$(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c $(top_srcdir)/ext/*/*.m
# Header files to ignore when scanning.
IGNORE_HFILES = avcodec.h dsputil.h arch.h speex_resampler.h speex_resampler_wrapper.h fixed_arm4.h fixed_arm5e.h fixed_bfin.h fixed_debug.h fixed_generic.h resample_sse.h
IGNORE_CFILES = utils.c mem.c imgconvert.c
# we add all .h files of elements that have signals/args we want
# sadly this also pulls in the private methods - maybe we should
# move those around in the source ?
# also, we should add some stuff here conditionally based on whether
# or not the plugin will actually build
# but I'm not sure about that - it might be this Just Works given that
# the registry won't have the element
EXTRA_HFILES = \
$(top_srcdir)/ext/alsa/gstalsasink.h \
$(top_srcdir)/ext/alsa/gstalsasrc.h \
$(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
$(top_srcdir)/ext/ogg/gstoggdemux.h \
$(top_srcdir)/ext/ogg/gstoggmux.h \
$(top_srcdir)/ext/opus/gstopusdec.h \
$(top_srcdir)/ext/opus/gstopusenc.h \
$(top_srcdir)/ext/pango/gstclockoverlay.h \
$(top_srcdir)/ext/pango/gsttextoverlay.h \
$(top_srcdir)/ext/pango/gsttextrender.h \
$(top_srcdir)/ext/pango/gsttimeoverlay.h \
$(top_srcdir)/ext/theora/gsttheoradec.h \
$(top_srcdir)/ext/theora/gsttheoraenc.h \
$(top_srcdir)/ext/theora/gsttheoraparse.h \
$(top_srcdir)/ext/vorbis/gstvorbisdec.h \
$(top_srcdir)/ext/vorbis/gstvorbisenc.h \
$(top_srcdir)/ext/vorbis/gstvorbisparse.h \
$(top_srcdir)/ext/vorbis/gstvorbistag.h \
$(top_srcdir)/gst/adder/gstadder.h \
$(top_srcdir)/gst/audioconvert/gstaudioconvert.h \
$(top_srcdir)/gst/audiorate/gstaudiorate.h \
$(top_srcdir)/gst/audioresample/gstaudioresample.h \
$(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \
$(top_srcdir)/gst/encoding/gstencodebin.h \
$(top_srcdir)/gst/gio/gstgiosink.h \
$(top_srcdir)/gst/gio/gstgiosrc.h \
$(top_srcdir)/gst/gio/gstgiostreamsink.h \
$(top_srcdir)/gst/gio/gstgiostreamsrc.h \
$(top_srcdir)/gst/playback/gstplay-enum.h \
$(top_srcdir)/gst/playback/gstplaysink.h \
$(top_srcdir)/gst/playback/gststreamsynchronizer.h \
$(top_srcdir)/gst/playback/gstsubtitleoverlay.h \
$(top_srcdir)/gst/audiorate/gstaudiorate.h \
$(top_srcdir)/gst/audioresample/gstaudioresample.h \
$(top_srcdir)/gst/overlaycomposition/gstoverlaycomposition.h \
$(top_srcdir)/gst/rawparse/gstrawaudioparse.h \
$(top_srcdir)/gst/rawparse/gstrawvideoparse.h \
$(top_srcdir)/gst/rawparse/gstunalignedaudioparse.h \
$(top_srcdir)/gst/rawparse/gstunalignedvideoparse.h \
$(top_srcdir)/gst/subparse/gstssaparse.h \
$(top_srcdir)/gst/subparse/gstsubparse.h \
$(top_srcdir)/gst/tcp/gstmultifdsink.h \
$(top_srcdir)/gst/tcp/gstmultihandlesink.h \
$(top_srcdir)/gst/tcp/gstmultisocketsink.h \
$(top_srcdir)/gst/tcp/gstsocketsrc.h \
$(top_srcdir)/gst/tcp/gsttcpclientsink.h \
$(top_srcdir)/gst/tcp/gsttcpclientsrc.h \
$(top_srcdir)/gst/tcp/gsttcp.h \
$(top_srcdir)/gst/tcp/gsttcpserversink.h \
$(top_srcdir)/gst/tcp/gsttcpserversrc.h \
$(top_srcdir)/gst/videoconvert/gstvideoconvert.h \
$(top_srcdir)/gst/videorate/gstvideorate.h \
$(top_srcdir)/gst/videoscale/gstvideoscale.h \
$(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \
$(top_srcdir)/gst/volume/gstvolume.h \
$(top_srcdir)/sys/ximage/ximagesink.h \
$(top_srcdir)/sys/xvimage/xvimagesink.h \
$(top_srcdir)/gst-libs/gst/app/gstappsrc.h \
$(top_srcdir)/gst-libs/gst/app/gstappsink.h
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files =
# Other files to distribute.
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
GTKDOC_LIBS = $(GST_BASE_LIBS)
# If you need to override some of the declarations, place them in this file
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
include $(top_srcdir)/common/gtk-doc-plugins.mak
---
short-description: Plugins from gst-plugins-base
...
# Plugins
<?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;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>GStreamer Base Plugins &GST_API_VERSION; Plugins Reference Manual</title>
<releaseinfo>
for GStreamer Base Plugins &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/</ulink>.
</releaseinfo>
</bookinfo>
<chapter>
<title>gst-plugins-base Elements</title>
<xi:include href="xml/element-adder.xml" />
<xi:include href="xml/element-alsamidisrc.xml" />
<xi:include href="xml/element-alsasink.xml" />
<xi:include href="xml/element-appsink.xml" />
<xi:include href="xml/element-alsasrc.xml" />
<xi:include href="xml/element-appsrc.xml" />
<xi:include href="xml/element-audioconvert.xml" />
<xi:include href="xml/element-audiointerleave.xml" />
<xi:include href="xml/element-audiomixer.xml" />
<xi:include href="xml/element-audiorate.xml" />
<xi:include href="xml/element-audioresample.xml" />
<xi:include href="xml/element-audiotestsrc.xml" />
<xi:include href="xml/element-cdparanoiasrc.xml" />
<xi:include href="xml/element-clockoverlay.xml" />
<xi:include href="xml/element-decodebin.xml" />
<xi:include href="xml/element-decodebin3.xml" />
<xi:include href="xml/element-encodebin.xml" />
<xi:include href="xml/element-giosink.xml" />
<xi:include href="xml/element-giosrc.xml" />
<xi:include href="xml/element-giostreamsink.xml" />
<xi:include href="xml/element-giostreamsrc.xml" />
<xi:include href="xml/element-glcolorbalance.xml" />
<xi:include href="xml/element-glcolorconvert.xml" />
<xi:include href="xml/element-glcolorscale.xml" />
<xi:include href="xml/element-gldeinterlace.xml" />
<xi:include href="xml/element-gldifferencematte.xml" />
<xi:include href="xml/element-gldownload.xml" />
<xi:include href="xml/element-gleffects_blur.xml" />
<xi:include href="xml/element-gleffects_bulge.xml" />
<xi:include href="xml/element-gleffects_fisheye.xml" />
<xi:include href="xml/element-gleffects_glow.xml" />
<xi:include href="xml/element-gleffects_heat.xml" />
<xi:include href="xml/element-gleffects_identity.xml" />
<xi:include href="xml/element-gleffects_laplacian.xml" />
<xi:include href="xml/element-gleffects_lumaxpro.xml" />
<xi:include href="xml/element-gleffects_mirror.xml" />
<xi:include href="xml/element-gleffects_sepia.xml" />
<xi:include href="xml/element-gleffects_sin.xml" />
<xi:include href="xml/element-gleffects_sobel.xml" />
<xi:include href="xml/element-gleffects_square.xml" />
<xi:include href="xml/element-gleffects_squeeze.xml" />
<xi:include href="xml/element-gleffects_stretch.xml" />
<xi:include href="xml/element-gleffects_tunnel.xml" />
<xi:include href="xml/element-gleffects_twirl.xml" />
<xi:include href="xml/element-gleffects.xml" />
<xi:include href="xml/element-gleffects_xpro.xml" />
<xi:include href="xml/element-gleffects_xray.xml" />
<xi:include href="xml/element-glfilterapp.xml" />
<xi:include href="xml/element-glfilterbin.xml" />
<xi:include href="xml/element-glfiltercube.xml" />
<xi:include href="xml/element-glfilterglass.xml" />
<xi:include href="xml/element-glimagesinkelement.xml" />
<xi:include href="xml/element-glimagesink.xml" />
<xi:include href="xml/element-gloverlay.xml" />
<xi:include href="xml/element-glshader.xml" />
<xi:include href="xml/element-glsinkbin.xml" />
<xi:include href="xml/element-glsrcbin.xml" />
<xi:include href="xml/element-glstereosplit.xml" />
<xi:include href="xml/element-gltestsrc.xml" />
<xi:include href="xml/element-gltransformation.xml" />
<xi:include href="xml/element-glupload.xml" />
<xi:include href="xml/element-glviewconvert.xml" />
<xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-multisocketsink.xml" />
<xi:include href="xml/element-oggaviparse.xml" />
<xi:include href="xml/element-oggdemux.xml" />
<xi:include href="xml/element-oggmux.xml" />
<xi:include href="xml/element-oggparse.xml" />
<xi:include href="xml/element-ogmaudioparse.xml" />
<xi:include href="xml/element-ogmtextparse.xml" />
<xi:include href="xml/element-ogmvideoparse.xml" />
<xi:include href="xml/element-opusdec.xml" />
<xi:include href="xml/element-opusenc.xml" />
<xi:include href="xml/element-overlaycomposition.xml" />
<xi:include href="xml/element-parsebin.xml" />
<xi:include href="xml/element-playbin.xml" />
<xi:include href="xml/element-playbin3.xml" />
<xi:include href="xml/element-playsink.xml" />
<xi:include href="xml/element-rawaudioparse.xml" />
<xi:include href="xml/element-rawvideoparse.xml" />
<xi:include href="xml/element-socketsrc.xml" />
<xi:include href="xml/element-ssaparse.xml" />
<xi:include href="xml/element-streamsynchronizer.xml" />
<xi:include href="xml/element-subparse.xml" />
<xi:include href="xml/element-subtitleoverlay.xml" />
<xi:include href="xml/element-tcpclientsink.xml" />
<xi:include href="xml/element-tcpclientsrc.xml" />
<xi:include href="xml/element-tcpserversink.xml" />
<xi:include href="xml/element-tcpserversrc.xml" /><