Commit graph

2855 commits

Author SHA1 Message Date
Tim-Philipp Müller 5bed94924a docs: pwg: fix missing comma and 0.10-ism in code sample
https://bugzilla.gnome.org/show_bug.cgi?id=747267
https://bugzilla.gnome.org/show_bug.cgi?id=747266
2015-04-02 21:18:39 +01:00
Michael Catanzaro 5b6ab53e7f docs: Fix typos
https://bugzilla.gnome.org/show_bug.cgi?id=746585
2015-03-25 23:36:59 +00:00
Tim-Philipp Müller e6a0f52e3c adapter: add gst_adapter_take_buffer_list()
API: gst_adapter_take_buffer_list()
2015-03-14 17:22:22 +00:00
William Manley fc765592a1 meta: Add GstNetControlMessageMeta
GstNetAddress can be used to store ancillary data which was received with
or is to be sent alongside the buffer data.  When used with socket sinks
and sources which understand this meta it allows sending and receiving
ancillary data such as unix credentials (See `GUnixCredentialsMessage`)
and Unix file descriptions (See `GUnixFDMessage`).

This will be useful for implementing protocols which use file-descriptor
passing in payloaders/depayloaders without having to re-implement all the
socket handling code already present in elements such as multisocketsink,
etc.  This, in turn, will be useful for implementing zero-copy video IPC.

This meta uses the platform independent `GSocketControlMessage` API
provided by GLib as a part of GIO.  As a result this new meta does not
require any new dependencies or any conditional compliation for
portablility, although it is unlikely to do anything useful on non-UNIX
platforms.
2015-03-14 13:54:51 +01:00
Vivia Nikolaidou 6ec3c4bc66 utils: Add gst_bin_sync_children_states()
gst_bin_sync_children_states() will iterate over all the elements of a bin and
sync their states with the state of the bin. This is useful when adding many
elements to a bin and would otherwise have to call
gst_element_sync_state_with_parent() on each and every one of them.

https://bugzilla.gnome.org/show_bug.cgi?id=745042
2015-03-13 12:50:48 +00:00
Vincent Penquerc'h 7b48b7a5bc docs: clarify min-latency wording in part-latency.txt
https://bugzilla.gnome.org/show_bug.cgi?id=744338
2015-03-04 11:02:41 +00:00
Luis de Bethencourt f54ef68958 docs: remove dead link
Remove dead link to wiki page for SubmittingPatches

https://bugzilla.gnome.org/show_bug.cgi?id=730311
2015-02-24 18:14:47 +00:00
Sebastian Dröge fd3a064c97 design/part-latency: Minor logic fix
The maximum latency will be the element's minimum latency or bigger,
not bigger than the element's minimum latency or bigger.
2015-02-12 11:26:26 +02:00
Sebastian Dröge ee8d67ef2c design/part-latency: Add more details about min/max latency handling
These docs missed many details that were not obvious and because of that
handled in a few different, incompatible ways in different elements and base
classes.

https://bugzilla.gnome.org/show_bug.cgi?id=744106
2015-02-11 17:53:04 +02:00
Stefan Sauer 0461c9f21d docs: ignore libcheck headers that use doxygen comments 2014-12-29 12:05:27 +01:00
Sebastian Rasmussen 13f9fda2c3 docs: Add missing interfaces to documentation
https://bugzilla.gnome.org/show_bug.cgi?id=742057
2014-12-28 12:22:59 +00:00
Sebastian Dröge 1f6d5d3ff5 structure/caps: Add gst_{structure,caps}_filter_and_map_in_place()
https://bugzilla.gnome.org/show_bug.cgi?id=739765
2014-12-16 18:22:46 +01:00
Sebastian Dröge bc11a1b79d caps: Add gst_caps_foreach() and gst_caps_map_in_place()
https://bugzilla.gnome.org/show_bug.cgi?id=739765
2014-12-16 18:22:46 +01:00
Stefan Sauer 8102b66c41 docs: add new preset api 2014-12-12 21:54:51 +01:00
Sebastian Dröge 154eefecc9 Don't compare booleans for equality to TRUE and FALSE
TRUE is 1, but every other non-zero value is also considered true. Comparing
for equality with TRUE would only consider 1 but not the others.

Also normalize booleans in a few places.
2014-12-01 09:51:37 +01:00
Tim-Philipp Müller a44ae03be1 docs: add GST_GL_* environment variables to 'Running GStreamer' section 2014-11-25 09:39:40 +00:00
Jan Alexander Steffens (heftig) 5a930aa642 gstobject: Add gst_object_has_parent()
Adds gst_object_has_parent, which works like gst_object_has_ancestor
but does not ascend further.

API: gst_object_has_parent()
2014-11-10 10:03:57 +01:00
Felix Schwarz 24428e9326 docs: pwd: fix typos
https://bugzilla.gnome.org/show_bug.cgi?id=738612
2014-10-16 12:53:55 +01:00
Guillaume Desmottes cea054c84a docs: pwg: fix two typos
https://bugzilla.gnome.org/show_bug.cgi?id=738153
2014-10-10 10:32:12 +01:00
Guillaume Desmottes 2cc55af046 docs: pwg: fix typo in 'Dynamic negotiation' section
The point of this example is to show how to set caps
on the source pad once it has been set on the sink pad.
So, in passthrough mode, the caps is just copied to the
source pad.

https://bugzilla.gnome.org/show_bug.cgi?id=738153
2014-10-10 10:31:49 +01:00
David Waring 54c5f1855c GstUri: Add GstUri miniobject to handle URIs in an RFC 3986 compliant fashion
https://bugzilla.gnome.org/show_bug.cgi?id=725221
2014-09-29 12:19:05 +03:00
Jonas Holmberg 4a304a7774 flowcombiner: add a gst_flow_combiner_clear() method
https://bugzilla.gnome.org/show_bug.cgi?id=737359

API: gst_flow_combiner_clear()
2014-09-25 15:40:42 +01:00
Tim-Philipp Müller eefe8be9fe docs: pwg: fix some links to the API docs
https://bugzilla.gnome.org/show_bug.cgi?id=736762
2014-09-19 00:33:58 +01:00
Wim Taymans a7d7d9305f docs: fix typo 2014-09-16 16:08:08 +02:00
Thibault Saunier 87a79673b0 check: Add a function to check destruction of objects
Add a method letting people to ensure that unreffing one object
leads to its destruction, and possibly the destruction of more object
(think destruction of a GstBin etc...).

https://bugzilla.gnome.org/show_bug.cgi?id=736477
2014-09-12 17:18:21 +02:00
Guillaume Desmottes 692606bdd2 manual: fix typo in advanced-dataaccess.xml
https://bugzilla.gnome.org/show_bug.cgi?id=735609
2014-08-29 11:35:09 +03:00
Tim-Philipp Müller 86d7a597f0 bytereader: add gst_byte_reader_peek_sub_reader() and _get_sub_reader()
Adds API to get or peek a sub-reader of a certain size from
a given byte reader. This is useful when parsing nested chunks,
one can easily get a byte reader for a sub-chunk and make
sure one never reads beyond the sub-chunk boundary.

API: gst_byte_reader_peek_sub_reader()
API: gst_byte_reader_get_sub_reader()
2014-08-15 10:03:26 +01:00
Sebastian Dröge 9861003939 concat: Add documentation and integrate into documentation build 2014-08-12 15:39:09 +03:00
Sebastian Rasmussen 4cf6a6e086 tests: Add missing unrefs of objects after use
Unreffing the objects returned by gst_bin_get_by_name() and
gst_pipeline_get_use() were missing in several tests, so add these.

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=734345
2014-08-06 13:47:11 +02:00
Sebastian Dröge 98a5de66b9 Release 1.4.0 2014-07-19 16:46:41 +02:00
Sebastian Dröge ed39f8b5b7 Release 1.3.91 2014-07-11 10:46:01 +02:00
Sebastian Rasmussen 863ba1a598 docs: Fix documentation typos and inconsistencies
* GstGlobalDeviceMonitor was renamed to GstDeviceMonitor
 * Expand GST_MESSAGE_DEVICE to the full enum value names
 * Correct the incorrect references to the GstDeviceProvider interfaces
 * Describe caps arguments for gstcheck interface
 * Add missing docs for GstNetAddressMeta and its add function
 * Add docs for toc helper macros
 * Avoid refering to GstValueList type as done elsewhere

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=732786
2014-07-09 09:22:11 +02:00
Sebastian Rasmussen 05cd4f89d3 docs: Cleanup interface references in docs
* Delete references to removed interfaces
 * Add missing documentation sections
 * Fix duplicate interface references for GstDevice

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=732786
2014-07-09 09:21:32 +02:00
Sebastian Dröge 417fac010b Release 1.3.90 2014-06-28 11:13:13 +02:00
Olivier Crête 6d12b33945 devicemonitor: Make it possible to add multiple filters
Each filter will include a GstCaps and a set of classes to match
2014-06-26 21:01:38 -04:00
Olivier Crête c2583cae90 GstDeviceMonitor: Rename from GstGlobalDeviceMonitor 2014-06-26 15:08:46 -04:00
Olivier Crête 7992174a1a DeviceProvider: Rename from DeviceMonitor 2014-06-26 14:45:30 -04:00
Sebastian Dröge 755ca23148 Release 1.3.3 2014-06-22 18:07:42 +02:00
Tim-Philipp Müller 2092754ed1 device: rename "klass" and get_klass() to "device-class" and _get_device_class()
There's some precedent in GstElementFactory, but a
"klass" property just seems weird.
2014-06-21 01:26:46 +01:00
Olivier Crête 77db6bf3d6 GstDevice: Document GstDevice and related classes 2014-06-20 16:55:06 -04:00
Wim Taymans 45c61db152 downloadbuffer: improve start/stop in buffering query
The start and stop should represent the currently downloading region.
The estimated-total should represent the remaining time to download
the currently downloading region. This makes it a lot more useful
for applications because they can then use those values to update
the fill region and use the estimated time to delay playback.
Update the docs with this clarification.
2014-06-03 22:17:17 +02:00
Tim-Philipp Müller a6d9c1a3c3 docs: add GstFlowCombiner 2014-05-27 10:05:51 +01:00
Nicolas Dufresne 103a40b6ce bufferpool: Add method and virtuals to set flushing state
Currently there is no other way to unlock a buffer pool other then
stopping it. This may have the effect of freeing all the buffers,
which is too heavy for a seek. This patch add a method to enter and
leave flushing state. As a convenience, flush_start/flush_stop
virtual are added so pool implementation can also unblock their own
internal poll atomically with the rest of the pool.  This is fully
backward compatible with doing stop/start to actually flush the pool
(as being done in GstBaseSrc).

https://bugzilla.gnome.org/show_bug.cgi?id=727611
2014-05-26 13:31:21 -04:00
Sebastian Dröge 07334eca5a Release 1.3.2 2014-05-21 13:06:34 +02:00
Tim-Philipp Müller 1cb650383d docs: remove reference to Mandrake and packages we no longer provide
https://bugzilla.gnome.org/show_bug.cgi?id=730312
2014-05-18 10:54:33 +01:00
Wim Taymans 7e60572425 docs: fix typo 2014-05-15 16:41:58 +02:00
Tim-Philipp Müller fa94322349 sparsefile: keep it private as helper API for downloadbuffer
There's no expectation that any other element or applications
might want to use this helper API any time soon, so keep it
private for the time being. There were open questions regarding
portability and binding-friendliness too.

This also removes the gio dependency of -base again.

https://bugzilla.gnome.org/show_bug.cgi?id=729951
https://bugzilla.gnome.org/show_bug.cgi?id=729949
2014-05-13 20:05:55 +01:00
Tim-Philipp Müller b17ea57223 docs: pick up GstBaseParse hierarchy and properties 2014-05-13 19:14:08 +01:00
Tim-Philipp Müller de6968de7f docs: expose GstPushSrcClass in documentation
Might come in handy in case someone wants to derive from it.
2014-05-13 19:10:43 +01:00
Nicolas Dufresne 194db480e0 bufferpool: Add an helper to validate config
When we call gst_buffer_pool_set_config() the pool may return FALSE and
slightly change the parameters. This helper is useful to do the minial required
validation before accepting the modified configuration.

https://bugzilla.gnome.org/show_bug.cgi?id=727916
2014-05-08 13:11:14 -04:00
Wim Taymans 451d0e3b0d downloadbuffer: update docs 2014-05-08 16:54:57 +02:00
Sebastian Dröge 473c008199 Release 1.3.1 2014-05-03 17:41:41 +02:00
Tim-Philipp Müller 3d990799ab docs: add new device probing API to docs table of contents
https://bugzilla.gnome.org/show_bug.cgi?id=729440
2014-05-03 12:14:43 +01:00
Nicolas Dufresne 2077e404ca doc: Add GstDevice* to gstreamer-sections.txt
https://bugzilla.gnome.org/show_bug.cgi?id=729440
2014-05-03 10:22:07 +02:00
Xavi Artigas 3b617f1fb2 docs: enhancements to porting guide documentation
https://bugzilla.gnome.org/show_bug.cgi?id=727754
2014-04-28 10:46:49 +01:00
Sebastian Dröge 3b331155e1 query: Add boolean to URI query to specify if a redirect is permanent or not 2014-04-28 10:03:15 +02:00
Felipe Ortiz c10663ba3e docs: add docs for various GstPad macros
https://bugzilla.gnome.org/show_bug.cgi?id=723652
2014-04-26 23:14:36 +01:00
Tim-Philipp Müller b2722a45dd Revert "docs: add docs for various GstPad macros"
This reverts commit d17438d5fd.

This commit featured the wrong author, sorry.
2014-04-26 23:12:13 +01:00
Tim-Philipp Müller 6eb6d9ec38 docs: remove outdated and pointless 'Last reviewed' lines from docs
They are very confusing for people, and more often than not
also just not very accurate. Seeing 'last reviewed: 2005' in
your docs is not very confidence-inspiring. Let's just remove
those comments.
2014-04-26 21:21:51 +01:00
Showayb Zahda d17438d5fd docs: add docs for various GstPad macros
https://bugzilla.gnome.org/show_bug.cgi?id=723652
2014-04-26 17:05:41 +01:00
Sebastian Dröge d445027ec1 event: Add running-time-offset field to all events
Events passing through #GstPads that have a running time
offset set via gst_pad_set_offset() will get their offset
adjusted according to the pad's offset.

If the event contains any information that related to the
running time, this information will need to be updated
before usage with this offset.
2014-04-10 08:25:50 +02:00
Stefan Sauer 0fb6a15a65 toc: expand GstTocEntry with loop fields
Add loop_type and repeat_count fields to GstTocEntry plus setters and getters.
This allows to represent edit-lists in a toc as well as loops in instruemnts (wav, xi).

API: gst_toc_entry_set_loop
API: gst_toc_entry_get_loop
2014-03-16 16:55:55 +01:00
Sebastian Rasmussen 3de939cb5b adapter: Adapt gst_adapter_copy() for bindings
This is done by introducing a new gst_adapter_copy_bytes() call that
returns a GBytes structure.

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725476
2014-03-15 13:16:16 +01:00
Tim-Philipp Müller 6e56c3df80 docs: update plugin docs 2014-03-11 21:55:46 +00:00
Stefan Sauer 4a38acaa10 pad: add debug helper for GstPadLinkReturn names
Add a helper like gst_flow_get_name() for GstPadLinkReturn. Use this in core.
API: gst_pad_link_get_name()
2014-03-11 21:50:36 +01:00
Wim Taymans 41cdfb710e docs: add some more new API do docs 2014-02-27 16:46:45 +01:00
Sebastian Dröge ab9fdf13a0 structure: Add getters for int64 and uint64 values 2014-02-25 15:41:45 +01:00
Jan Alexander Steffens (heftig) a2742a575b pwg: Update raw properties
Using info from gst-plugins-base/docs/design .

Encoded streams might make use of the raw properties, so list them all under foo/* .
For foo/raw, only note which of these properties are mandatory.

I didn't take a closer look at the raw formats yet. Those might still be out-of-date.

https://bugzilla.gnome.org/show_bug.cgi?id=724187
2014-02-17 18:47:20 +01:00
Stefan Sauer f5fae6f339 docs: add the boxed types to the .types.in
This makes them show up in the object hierarchy.
2014-02-15 22:35:37 +01:00
Stefan Sauer b892b438cc docs: gtkdoc is not good at parsing inline functions in headers
Mark the inline function, so that gtkdoc skips them. Avoids some warnings about
unparsable declarations.
2014-02-15 21:27:23 +01:00
Sebastian Dröge f47c704b99 basesrc: Add gst_base_src_set_automatic_eos() API
This defaults to TRUE and if it is set to FALSE it is the subclasses
responsibility to return GST_FLOW_EOS from the create() vmethod once
the stream is done.
2014-02-13 12:09:06 +01:00
William Manley be8eeabefc docs: Fix location of plugins and registry in home directories
Fixes out of date documentation left over since 0.10.  In 1.0 plugins are
stored in $XDG_DATA_HOME and the registry in $XDG_CACHE_HOME conformant
with the XDG Base Directory Specification[1].

[1]: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

https://bugzilla.gnome.org/show_bug.cgi?id=724132
2014-02-11 20:56:48 +01:00
Sebastian Rasmussen f0047132a1 docs: add missing seqnum file for distribution
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=723997
2014-02-10 09:35:34 +01:00
Tim-Philipp Müller b23af1f2f2 docs: document GST_TAG_*ENCODING environment variables
https://bugzilla.gnome.org/show_bug.cgi?id=721850
2014-02-09 16:53:55 +00:00
Tim-Philipp Müller eee7aa5f15 docs: enable parallel build of subdirectories
We can build gtk docs, ADM, PWG and FAQ in parallel.
2014-02-09 16:47:53 +00:00
Sebastian Dröge a00cc4338a manual: Fix build by using the correct C file name 2014-02-04 22:23:06 +01:00
Sebastian Dröge b110286e95 manual: Clean up code a bit to be suitable for the docs 2014-02-04 21:36:18 +01:00
Todd Agulnick cb1657fcea manual: Replace manual's effectswitch.c with newer test-effect-switch.c
https://bugzilla.gnome.org/show_bug.cgi?id=721100
2014-02-04 21:35:12 +01:00
Stefan Sauer f6d638153c docs: fix more gtk-doc warnings 2014-02-01 16:18:13 +01:00
Stefan Sauer b06e86fb18 docs: unhide docs for allocator
Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
2014-01-31 08:36:55 +01:00
Stefan Sauer 6b5ccf31aa part-toc: emphasize that the later chapters are design draft ideas 2014-01-29 22:48:04 +01:00
Stefan Sauer bdb1f268a6 part-toc: add format specific information 2014-01-29 20:37:34 +01:00
Thiago Santos 5880c9c4c3 docs: design: add part-seqnums
Hopefully clarifies how seqnums should be used and copied from
events to events/messages when those are handled.

https://bugzilla.gnome.org/show_bug.cgi?id=722791
2014-01-24 09:31:44 -03:00
Nicolas Dufresne ba7de077fb doc: Update sections with the new rounding macros 2014-01-14 16:22:31 -05:00
Stefan Sauer 4f70bd5a5a docs: ensure GstBufferPools shows up as with GObject features
GstBufferPool is a GstObject, add the _get_type function to the types file.
2014-01-13 20:51:03 +01:00
Stefan Sauer fb2140b627 design/part-toc.txt: update design docs 2014-01-02 20:18:36 +01:00
Erik Andresen 2cbab400b2 docs: fix memory leak of appsink example in manual
https://bugzilla.gnome.org/show_bug.cgi?id=721076
2013-12-26 11:21:29 +00:00
William Jon McCann 26df7fa26d docs: fix project links
https://bugzilla.gnome.org/show_bug.cgi?id=720665
2013-12-18 11:43:35 +00:00
Tim-Philipp Müller d92361ba52 docs: moving plugins: minor 0.10 -> 1.0 fix
Spotted by Jay Fenlason
2013-12-13 22:52:05 +00:00
Sebastian Rasmussen 53ae1b2c9c docs: Fix typos in function/object descriptions
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=720029
2013-12-07 17:11:12 +00:00
Sebastian Rasmussen 249a775d2b docs: add missing files for distribution
* add some documentation files in docs/design
 * add docs/list-ulink.xsl so check in docs/manual works

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=719814
2013-12-03 23:50:36 +00:00
Sebastian Rasmussen 49950e57ad docs: add missing docs, fixing doc errors
* add many missing declarations to sections
 * GstController has been removed, update docs
 * skip GstIndex when generating documentation
 * rephrase so gtkdoc doesn't imagine return value
 * add missing argument description for gst_context_new()
 * document GstOutputSelectorPadNegotiationMode and move to header-file

https://bugzilla.gnome.org/show_bug.cgi?id=719614
2013-12-03 00:11:59 +00:00
Wim Taymans 02b64ee03b systemclock: Add gst_system_clock_set_default
Used for setting the default system clock that is obtained through
gst_system_clock_obtain(), which is sometimes needed for unit
testing.

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=711269
2013-11-11 12:25:14 +01:00
Reynaldo H. Verdejo Pinochet a3431f5d8b docs: fix common typos emited/eachother/... 2013-10-31 16:28:06 -07:00
Antonio Ospite c76aaaaa1d pwg: rename the "samplerate" variable to make example code compilable
In one of the examples about gst_my_filter_setcaps() there is a variable
declared as "rate", but then the name "samplerate" is used when setting
the caps.

Use the name "rate" everywhere in gst_my_filter_setcaps().

https://bugzilla.gnome.org/show_bug.cgi?id=710876
2013-10-30 18:46:37 +01:00
Fabian Kirsch 4ceeee9ff8 doc: fix forward reference about ghost pads
https://bugzilla.gnome.org/show_bug.cgi?id=711089
2013-10-29 22:06:31 +00:00
Tim-Philipp Müller 40872f26ae docs: design: fix some fixes 2013-10-28 12:55:19 +00:00
Tim-Philipp Müller 20c2008ef8 docs: flesh out gst-uninstalled entry in faq some more
https://bugzilla.gnome.org/show_bug.cgi?id=709916
2013-10-26 09:48:06 +01:00
Fabian Kirsch d0dd23cf9f docs: FAQ update to mention create-uninstalled-setup.sh
https://bugzilla.gnome.org/show_bug.cgi?id=709916
2013-10-26 09:41:26 +01:00
Stefan Sauer 0089bcd3e2 design: flesh out the tracing design a little more 2013-10-25 20:05:03 +02:00