tools/gstreamer-completion: Bash 3.2 compatibility fixes

Compatible with bash 3.2; doesn't require the bash-completion package at
all (though the easiest way to install this script is still to install
bash-completion, and then drop this script into /etc/bash_completion.d).

Note that bash 3 doesn't break COMP_WORDS according to characters in
COMP_WORDBREAKS, so "property=val" looks like a single word, so this
won't complete property values (on bash 3). Similarly,
"--gst-debug-level=<TAB>" won't complete properly (on bash 3), but
"--gst-debug-level <TAB>" will.

For that reason, I now offer "--gst-debug-level" etc as completions
instead of "--gst-debug-level=".

Functions "_init_completion" and "_parse_help" were provided by the
bash-completion package >= 2.0; now I roll my own equivalent of
"_parse_help", and instead of "_init_completion" I use
"_get_comp_words_by_ref" which is available from bash-completion 1.2
onwards. If the bash-completion package isn't available at all I use
bash's raw facilities, at the expense of not completing properly when
the cursor is in the middle of a word.

The builtin "compopt" doesn't exist in bash 3; those users will just
have to live with the inconvenience of "property=" completing to
"property= " with a trailing space. Property values aren't completed
properly anyway on bash 3 (see above).

"[[ -v var ]]" to test whether a variable is set, also doesn't exist in
bash 3. Neither does ";;&" to fall through in a "case" statement.

In the unit tests:

* On my system (OS X), "#!/bin/bash" is bash 3.2, whereas
  "#!/usr/bin/env bash" is the 4.2 version I built myself.
* I have to initialise array variables like "expected=()", or bash 3
  treats "+=" as appending to an array already populated with one empty
  string.

tools/gstreamer-completion: Support gst-inspect, and gst-launch element properties

Completes options like "--gst-debug-level" and the values of some of
those options; completes gst-launch pipeline element names, property
names, and even property values (for enum or boolean properties only).

Doesn't complete all caps specifications, nor element names specified
earlier in the pipeline with "name=...".

The GStreamer version number is hard-coded into the completion script:
This patch is off the master branch and has the version hard-coded as
"1.0"; it needs to be updated if backported to the 0.10 branch. You
could always create a "gstreamer-completion.in" that has the appropriate
version inserted by "configure", but I'd rather not do that. The
hard-coded version is consistent with the previous implementation of
gstreamer-completion, which had the registry path hard-coded as
~/.gstreamer-1.0/registry.xml.

Note that GStreamer 0.10 installs "gst-inspect" and "gst-inspect-0.10".
"gst-inspect --help" only prints 4 flags (--help, --print, --gst-mm,
gst-list-mm) whereas "gst-inspect-0.10 --help-all" prints the full list
of flags. The same applies to "gst-launch" and "gst-launch-0.10".
GStreamer 1.0 only installs "gst-inspect-1.0", not "gst-inspect".

Requires bash 4; only tested with bash 4.2. Requires "bash-completion"
(which you install with your system's package manager).

Put this in /etc/bash_completion.d/ or in `pkg-config
--variable=compatdir bash-completion`, where it will be loaded at the
beginning of every new terminal session;
or in `pgk-config --variable=completionsdir bash-completion`, renamed to
match the name of the command it completes (e.g. "gst-launch-1.0", with
an additional symlink named "gst-inspect-1.0"), where it will be
autoloaded when needed.

test-gstreamer-completion.sh is (for now) in tests/misc -- it might be
worth creating "tests/check/tools", with all the necessary automake
boilerplate, and moving test-gstreamer-completion.sh there, and have it
run automatically with "make check".

IF YOU'RE NEW TO BASH COMPLETION SCRIPTS
----------------------------------------

"complete -F _gst_launch gst-launch-1.0" means that bash will run the
function "_gst_launch" to generate possible completions for the command
"gst-launch-1.0".

"_gst_launch" must return the possible completions in the array variable
COMPREPLY. (Note on bash syntax: "V=(a b c)" assigns three elements to
the array "V").

"compgen" prints a list of possible completions to standard output. Try
it:

    compgen -W "abc1 abc2 def" -- "a"
    compgen -f -- "/"

The last argument is the word currently being completed; compgen uses it
to filter out the non-matching completions. We put "--" first, in case
the word currently being completed starts with "-" or "--", so that it
isn't treated as a flag to compgen.

For the documentation of COMP_WORDS, COMP_CWORD, etc see
http://www.gnu.org/software/bash/manual/html_node/Bash-Variables.html#index-COMP_005fCWORD-180

See also:
* http://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html
* http://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html

The bash-completion package provides the helper function
"_init_completion" which populates variables "cur", "prev", and "words".
See
http://anonscm.debian.org/gitweb/?p=bash-completion/bash-completion.git;a=blob;f=bash_completion;h=870811b4;hb=HEAD#l634

Note that by default, bash appends a space to the completed word. When
the completion is "property=" we don't want a trailing space; calling
"compopt -o nospace" modifies the currently-executing completion
accordingly. See
http://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html#index-compopt

tools/gstreamer-completion: Updated to work with the binary registry

The original registry was in xml format (~/.gstreamer-*/registry.xml). A
binary registry format was added in 2007 (commit ebf0c9d3) and made the
default in 2008 (commit 3f39fd7e). In 0.10 you could still choose at
"configure" time to use the xml registry instead; in 1.0 the binary
registry is your only choice.

This change to gstreamer-completion should work with either format
because it parses the output of "gst-inspect" instead of reading the
registry file directly.

Note that _gst_launch no longer needs an explicit "return 0" because,
unlike the previous grep command, compgen always returns 0 (unless a
genuine error occurs).

Just like the previous implementation by David Schleef, this "only
completes names of features, but that's 90% of what I want it for."

porting-to-1.0.txt: nit clarification

It is the process context that matters.

typefind: Always leave TYPEFIND mode when we're stopping typefinding

typefind: Simplify code

This is only called when in TYPEFIND mode.

typefind: Push pending events independent of the existence of a downstream chain function and peer

Downstream might create a peer only as result of the events in theory.

typefind: Only push CAPS event once if we get one from upstream

https://bugzilla.gnome.org/show_bug.cgi?id=692784

typefind: Stop typefinding if we get a CAPS event from upstream

typefind: Improve handling of GAP events

There's still room for improvement though.

typefind: Forward events that should happen before the caps event directly

There's no point in storing them and sending them later, and doing so would
later require to distinguish between events that should come before caps and
after.

https://bugzilla.gnome.org/show_bug.cgi?id=692784

typefind: Only push pending buffers and events if we have caps

typefind: Remove code that would cause caps to be sent twice

Whenever we set typefind->caps we will also send a caps event downstream.

pwg: improve allocation docs

check: set CK_TIMEOUT_MULTIPLIER on ARM

https://bugzilla.gnome.org/show_bug.cgi?id=695599

typefind: fix caps leak when used in connection with uridecodebin and playbin

Don't leak forced sink caps.

controller: Fix element-type annotations

inputselector: Try to not push read-only buffers

We should only increase the refcount before pushing if we're
really going to use the buffer afterwards.

tests: add check for FLUSH pad probes

gstpad: run probes for FLUSH events sent with gst_pad_send_event

Move probe handling in gst_pad_send_event_unchecked so that probes are run for
FLUSH events too.

netclock: Add support for IPv6

porting-to-1.0.txt: add troubleshooting section

Add note about "cannot register existing type `GstObject'" warning.

baseparse: Only infer TS if PTS interpolation is enabled

Otherwise this is breaking timestamps of formats that
need reordering.

https://bugzilla.gnome.org/show_bug.cgi?id=597662

pad: notify caps property on NULL as well

Also notify the caps property when it changes to NULL

pad: clarify locking

Automatic update of common submodule

From 3cb3d3c to 5edcd85

part-context: Write some design documentation about GstContext

part-caps: Add more information about caps features, caps semantics and how to use them

capsfeatures: Add documentation about ANY GstCapsFeatures

basesink: Don't set last_render_time if we're checking for a late buffer before ::prepare()

This makes sure that at least one buffer per second is rendered if buffers
are dropped before ::prepare. Without this change, at least one buffer per
second wouldn't be too late before ::prepare anymore but would be dropped
before ::render because of last_render_time being set before ::prepare
already.

gstvalue: Add compare function for caps

dataqueue: add gst_data_queue_peek

This function works just like gst_data_queue_pop, but it doesn't
remove the object from the queue.

Useful when inspecting multiple GstDataQueues to decide from which
to pop the element from.

Add: gst_data_queue_peek

tests: ignore new test binary

tools: update for latest context API changes

context: Add gst_context_writable_structure() and let get_structure() return const again

printf: fix handling of old printf extension specifiers for ABI compatibility

Fixes abort when the old specifiers are used. Fix up the conversion
specifier, it would get overwritten with 'c' below to the extension
format char, which then later is unhandled, leading to the abort.
Also fix up and enable unit test for this.

https://bugzilla.gnome.org/process_bug.cgi

tests: add unit test for old printf extension specifiers

To make sure we maintain binary compatibility with the old
specifiers.

https://bugzilla.gnome.org/show_bug.cgi?id=698242

check: run skipped tests if explicitly requested via GST_CHECKS

If a test that's disabled with tcase_skip_broken_test() is listed
in the GST_CHECKS environment variable, run it anyway.

gst-launch: Add GstContext support

gst-launch will collect all the contexts from the pipeline elements
and update the overall pipeline context with it.

context: Add unit test for GstContext

context: Return a non-const GstStructure to make code simpler and update docs

query: new _BANDWIDTH_LIMITED flag

Source elements with limited bandwidth capabilities and supporting
buffering for downstream elements should set this flag when answering
a scheduling query. This is useful for the on-disk buffering scenario
of uridecodebin to avoid checking the URI protocol against a list of
hardcoded protocols.

Bug 693484

docs: fix missing flacdec in porting-to-1.0 pipeline example

docs: add note about decoders and parsers to porting-to-1.0 doc

gst: Add better support for static plugins

API: GST_PLUGIN_STATIC_DECLARE()
API: GST_PLUGIN_STATIC_REGISTER()

Based on a patch by Håvard Graff <havard.graff@tandberg.com>.

This now allows GST_PLUGIN_DEFINE() to create a static plugin if
GST_PLUGIN_BUILD_STATIC is defined. The resulting plugin can be
statically linked or dynamically linked during compilation but
can't be dynamically loaded during runtime.

Also adds GST_PLUGIN_STATIC_DECLARE() and GST_PLUGIN_STATIC_REGISTER(),
which allows to register a static linked plugin easily.
It is still required to manually register every single statically linked
plugin from inside the application as this can't be automated in a portable
way.

A new configure parameter --enable-static-plugins was added that allows
to build all plugins we build here as static plugins.

Fixes bug #667305.

manual: Patch manual to refer to porting guide

https://bugzilla.gnome.org/show_bug.cgi?id=697845

pluginfeature: Fix the GstPluginFeature name comparison.

The gst_plugin_feature_rank_compare_func() should return
negative value, if the rank of both PluginFeatures are equal and
the name of first PluginFeature comes before the second one.

https://bugzilla.gnome.org/show_bug.cgi?id=697990

Automatic update of common submodule

From 2736592 to 3cb3d3c

Automatic update of common submodule

From aed87ae to 2736592

printf: disable some unused printf variants

printf: use sprintf() to work around glibc complaining about %n in a writable format string

Don't use snprintf(), but use sprintf instead and do our own
length calculations, because glibc may complain about us passing
%n in a format string if the string is in writable memory, and
here the format string is always in writable memory since we
construct it on the fly. This happens if glibc has been compiled
with _FORTIFY_SOURCE=2, which seems to be the case on some
distros/systems). On the upside, we now use the sprintf code path
on all systems which should be better from a maintenance point
of view.

https://bugzilla.gnome.org/show_bug.cgi?id=697970

tests: skip all GstPoll tests on Windows

As they don't work there, and it's non-trivial to fix.

https://bugzilla.gnome.org/show_bug.cgi?id=697609

gst-inspect: only add a '*' for non-'gpointer' pointers

Spotted by Jose Antonio Santos Cadena.

https://bugzilla.gnome.org/show_bug.cgi?id=697791

plugin: fix name expansion for GST_PLUGIN_DEFINE macro

Make GST_PLUGIN_DEFINE use G_STRINGIFY() to convert the name argument
into a meaningful string. The advantage of this is that `name' can be
expanded from other macros defined in the plug-in element.

Signed-off-by: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
https://bugzilla.gnome.org/show_bug.cgi?id=697872

po: add new translatable strings

printf: don't build if debugging subsystem was disabled

printf: deal with some of the HAVE_FOO used in the printf code

Probably needs some more work for MSVC.

printf: fix alloca use for windows with mingw32

Don't use just GLIB_HAVE_ALLOCA_H to check if alloca is available,
that's just for the header. GLib may define alloca for us otherwise
too irrespective of GLIB_HAVE_ALLOCA_H.

Fixes compiler warning with mingw32:
gst/printf/vasnprintf.c:73:0: warning: "alloca" redefined

printf: enable and fix compiler warnings

But suppress -Wformat-nonliteral warnings since sprintf
is used with a runtime-generated format string in our
vasnprintf implementation.

printf: fix up dodgy use of #if HAVE_FOO and #if !HAVE_FOO

Should use #ifdef and #ifndef.

printf: mark internal functions as internal

printf: skip pointer extension signifier chars after %p

So they don't get printed after the serialised pointer string.

printf: don't leak serialised pointer extension strings

printf: handle old GST_PTR_FORMAT %P and GST_SEGMENT_FORMAT %Q defines too

For binary backwards compatibility.

printf: make printf parser recognise our pointer extension format

and call the hook to get a string for the pointer instead.

https://bugzilla.gnome.org/show_bug.cgi?id=613081

printf: add infrastructure for pointer extensions hook

Does not do anything yet. On a sidenote, we can't just use
%p\001 or so to signal the extension because g-i complains
about an invalid ascii character then, so have to resort to
something more elaborate, such as %p\aA etc.

https://bugzilla.gnome.org/show_bug.cgi?id=613081

info: use new internal printf for debug message printing

and remove all the printf extension/specifier stuff for
the system printf. Next we need to add back the custom
specifiers to our own printf implementation.

https://bugzilla.gnome.org/show_bug.cgi?id=613081

printf: add our own printf implementation for debug logging

We will add support for our own printf modifiers, so we can
get nice debug log output on all operating systems irrespective
of the specific libc version used.

https://bugzilla.gnome.org/show_bug.cgi?id=613081

taglist: avoid triggering an assertion

When deserialization of the structure fails, return a NULL taglist instead of
asserting.

gst-inspect: add pointer mark to signal and action return types that are pointers

When the return type of a signal or action is a pointer, it
should have an asterisk to mark it as such.

https://bugzilla.gnome.org/show_bug.cgi?id=697791

docs: document type change of playbin's connection-speed property in porting docs

buffer: add _gst_max_memory() function

Add the a function to query the maximum amount of memory blocks that can be
added to a buffer. Also improve the docs for _insert_memory().

nettimeprovider: notify of changed bound address

Notify when the bound address is known, just like the port.

launch: handle PROGRESS messages

Wait for all PROGRESS messages (if any) to complete before going to the PLAYING
state. This is the only way we can wait for live elements to complete their
operations.

This is interesting for elements like rtspsrc that do some asynchronous network
requests as part of going to the PAUSED state. It could be possible that it, for
example, provides a clock and then we would like to wait until it completes
so that we can use the provided clock when going to PLAYING.

Toggle upstream and downstream in RECONFIGURE paragraph.

GstCollectPads documentation: gst_collect_pads_read is gone.

bus: fix the precondition for gst_bus_disable_sync_message_emission()

Use the right variable and invert the test. The precondition should catch
someone calling to once too often.

capsfeatures: Init debug category before ever using it

Automatic update of common submodule

From 04c7a1e to aed87ae

Use xlstproc instead of docbook2html

netclientclock: bind socket before querying local address

Fails on windows otherwise.

https://bugzilla.gnome.org/show_bug.cgi?id=697608

configure: Also check for clock_gettime in libpthread

libwinpthreads provides POSIX time API.
It also provides libpthread alias for itself, for compatibility, so that
is what we will link with.

Fixes #697550

clock: Do use HAVE_CLOCK_GETTIME

Fixes #697549

libsabi: Special struct size values for W32

These account for both possible type size mismatch AND -mms-bitfields
packing. Sizes are taken from an i686-w64-mingw32-built GStreamer,
gcc 4.8.0, mingw-w64 svn-r5685.

Fixes #697551

tests: fix GstPad test on windows and in CK_FORK=no mode

Need to clear buffer lists at the end of each test.

https://bugzilla.gnome.org/show_bug.cgi?id=697610

gst-launch: Fix space in fault message

capsfeatures: Copy ANY flag when copying caps features too

caps: Handle ANY caps features properly in more places

caps: Add test for operations on caps with ANY features

caps: Properly handle ANY caps features in caps operations

bus: update signal docs for gst_bus_enable_sync_message_emission()

multiqueue: ignore empty not-linked queues

We need to ignore the not-linked queues in the underrun and overrun callbacks
because they are expected to be empty.

caps: fix caps feature leak

Fixes leaks in 14 core unit tests including
gst/gstcaps.

multiqueue: start pushing again on RECONFIGURE

When we got NOT_LINKED before and we receive a RECONFIGURE event, start pushing
again on the source pad.

See https://bugzilla.gnome.org/show_bug.cgi?id=676304

queue2: start pushing again on RECONFIGURE

When we got NOT_LINKED before and we receive a RECONFIGURE event, start pushing
again on the source pad.

See https://bugzilla.gnome.org/show_bug.cgi?id=676304

queue: start pushing again on RECONFIGURE

When we got NOT_LINKED before and we receive a RECONFIGURE event, start pushing
again on the source pad.

See https://bugzilla.gnome.org/show_bug.cgi?id=676304

structure: simplify is_subset check

Iterate over the fields of the superset instead of those of the subset.
This way we can check the presence of the subset field and do the subset check
in one iteration.

caps: update docs, is_subset() works now

bufferpool: fix docs

pad: add gst_pad_store_sticky_event()

Rewire some internal functions and expose a new
gst_pad_store_sticky_event() function.

API: gst_pad_store_sticky_event()