Commit graph

84 commits

Author SHA1 Message Date
Edward Hervey
a3980f4838 docs: Use Discourse and Matrix as prefered communication channels
Part of: https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6220
2024-02-27 09:35:47 +01:00
Markus Ebner
bf936fa6c0 docs: Minor correction in keyframe-force.md
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6090>
2024-02-10 16:03:51 +00:00
Hosang Lee
df0be57d38 tracing: Fix some typos
Fix example commands to work when copied/pasted to the terminal.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6064>
2024-02-07 03:59:31 +00:00
Paul Fee
30d34a99f1 docs: Minor updates to Plugin Writer's Guide
boiler.md:
    Update meson command to avoid warning.

states.md:
    Clarify that a sink element accepting only one buffer only happens when paused.
    Link text duplicated normal text.

args.md:
    A valid range is between values, not between ranges.  Reword for clarity.

testapp.md:
    Clarify linking refers to the pipeline, not build time compilation and linking.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5939>
2024-01-24 16:40:17 +00:00
Tim-Philipp Müller
888e5905d8 docs: contributing: add merging section to developer workflows
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5847>
2023-12-24 13:06:30 +00:00
Alexander Slobodeniuk
263b08bc53 doc/pipeline-manipulation: mention "insertbin" and "switchbin"
Using one of these elements might save a lot of struggle hours
to the user, because they actually target the case.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5514>
2023-11-17 01:09:49 +01:00
Jordan Petridis
7d64943b9d docs: Remove obselete appendix about parsing cli argumnets
It's a bad idea trying to mix the Options from GStramer and
GTK, in addition with cli argument being a bit wonky thing for
GUI applications in general. In the rare, now, occasion
that an application wants to parse arguments, its preferable
to parse them manually and use library apis afterwards
rather than trying to combine the option groups and hope it
works.

In addition, applications should be opening files using
`g_application_open` instead of parsing random arguments.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4788>
2023-10-27 04:46:17 +00:00
Leif Andersen
d1aaf8ba0d docs: Fix line numbers in tutorials 1 and 2
It seems that the lines for the C code for tutorials 1 and 2 are all
off.

The remaining tutorials seem uneffected.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5387>
2023-10-05 21:54:17 +00:00
Leif Andersen
60b93fd593 docs: Fix markdown link in contribution page
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5348>
2023-09-18 22:44:25 -04:00
Leif Andersen
2fb819a549 docs: Meson has deprecated the implicit setup command
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5342>
2023-09-18 15:32:15 +00:00
Nirbheek Chauhan
46a4b07fe5 docs: Update docs for installing on windows
This page has been only sporadically updated for a decade, and it is
unlikely to be updated properly anytime soon. Update the top half, and
add a note about the tutorial section being out of date.

The trigger for this was a question on the mailing list about Windows
11 support, since it's not listed in the supported platforms list.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5239>
2023-08-25 15:16:07 +00:00
Jordan Petridis
9fdf3dbc7f docs: Port toolkit integration tutorial to gtksink
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4789>
2023-07-20 00:27:37 +00:00
He Junyan
5a3b31108d Doc: Dmabuf: Set drm caps' format field to DMA_DRM
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4981>
2023-07-19 09:57:50 +00:00
Olivier Crête
e8731f26de docs: Replace gst-omx with v4l2 in memory allocation example
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4976>
2023-07-16 19:10:03 +00:00
Olivier Crête
48c43e5b7f gst-omx: Retire the whole package
The OpenMAX standard is long dead and even the Raspberry Pi OS
no longer supports it.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4976>
2023-07-16 19:10:03 +00:00
Tim-Philipp Müller
26a451b59d docs: contributing: mention user verification to get forking rights
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4708>
2023-05-26 23:24:16 +00:00
Tim-Philipp Müller
f58416b1a4 docs: tutorials: fix 0.10-isms in "Shortcutting the pipeline"
GST_BUFFER_DATA and GST_BUFFER_SIZE are no more.

https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/121

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4691>
2023-05-23 23:48:27 +00:00
Michael Bunk
dc64f3e6cf docs: fix typos and grammar
https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/50

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4690>
2023-05-23 23:36:49 +00:00
Mathieu Duponchelle
3868771191 docs-index: de-hardcode toned row color
Instead use a bootstrap panel and let styling occur based on that,
making the index page work well with the dark theme.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4488>
2023-04-26 13:50:21 +02:00
Ruben Gonzalez
a7f4d5716a gst: Delete inoperative ARG_PLUGIN_SPEW
Logic related with the option was deleted 20 years ago in commit:
086de421dc

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4452>
2023-04-21 12:35:39 +00:00
Tim-Philipp Müller
bbb0a30f32 docs: update old gstreamer-sdk media urls
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4406>
2023-04-13 03:20:36 +00:00
Eva Pace
f3ab697d2a docs: Add missing dot in handy elements (tutorial 14)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4353>
2023-04-06 15:16:15 +00:00
Eva Pace
ce467b72aa docs: Update tutorial 14 to 1.0 (audio/x-raw)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4353>
2023-04-06 15:16:15 +00:00
Rhythm Narula
0db0fdd00a docs: gstreamer1.0-doc plugin removed
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4214>
2023-03-17 23:35:11 +00:00
Ivan Tishchenko
0269c6cf79 docs: fix typo in pipeline manipulation tutorial
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4165>
2023-03-15 03:21:29 +00:00
Alicia Boya García
136b2e0eae tracers: Document the 'log' tracer
This patch adds documentation to the 'log' tracer and amends the design
document of Tracers to replace a misleading example of the 'log' tracer
with a different example that uses tracer arguments with tracers that do
actually handle said arguments.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4153>
2023-03-14 01:35:14 +00:00
Tim-Philipp Müller
e0cf1ebff2 docs: iOS tutorials: update for pending ivorbisdec plugin removal
See https://gitlab.freedesktop.org/gstreamer/cerbero/-/merge_requests/1103

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4073>
2023-02-27 17:24:16 +00:00
Tim-Philipp Müller
0d9bdf238c gst-docs: drop use of GSlice in example code
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3784>
2023-02-03 17:48:09 +00:00
Nirbheek Chauhan
41ac00c373 docs: Need to use versioned paths on macOS
Especially with pkg-config, it needs to be called with the right path
otherwise it might not pick up the prefix correctly.

Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/1677

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3706>
2023-01-10 20:20:19 +00:00
tasoss foobaridis
684e9b2499 Change name of property from Exists to Availability
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3510>
2022-12-02 19:19:38 +00:00
Edward Hervey
65e142c6ed docs/design: Add document detailing the new gapless/instant-uri changes
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3457>
2022-11-23 12:19:22 +00:00
Piotr Brzeziński
64aad21f98 gst-docs: Fix broken tables in Cerbero docs
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3425>
2022-11-16 22:41:01 +01:00
Taruntej Kanakamalla
0d5c89a3b4 Updated the Pango broken link
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2723>
2022-11-11 12:17:40 +00:00
Taruntej Kanakamalla
ba49efa8f2 Updated the GObject tutorial link
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2723>
2022-11-11 12:17:40 +00:00
Sebastian Dröge
d2c13f0c26 test-effect-switch: Fix some memory leaks and make effect element ownership clearer
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3091>
2022-09-29 22:34:37 +00:00
Aleix Conchillo Flaqué
453b0cec82 gst-docs: update macOS new project instructions
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3074>
2022-09-28 06:36:05 +00:00
Stéphane Cerveau
0c96e838e8 docs: update to mono repo locations
Some links/repos in the documentation were still pointing to old
repositories, change to mono repository

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2982>
2022-09-06 14:20:49 +02:00
Olivier Crête
96422cc9cf dmabuf: Make it clear that the FORMAT is a DRM fourcc
Some of the formats in GstVideoFormat are a combination
of a DRM format and modifier, making them unclear.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2616>
2022-08-22 22:43:54 +00:00
Krystian Wojtas
73c75479d6 doc: Fix typo
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2903>
2022-08-17 07:45:01 +00:00
Krystian Wojtas
16a3fc3c6d docs: copy-paste fix
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2857>
2022-08-10 12:56:02 +00:00
Olivier Crête
62c7402dbb dmabuf: Always skip modifier if it's linear
Accepting both NV12 and NV12:0x0000000000000000 will make the
intersection code too painful to write.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2617>
2022-08-08 13:30:57 +00:00
He Junyan
91b7d3679e Docs: Add the design document for DMA buffer sharing.
Co-authored-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
Co-authored-by: Victor Jaquez <vjaquez@igalia.com>
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1431>
2022-06-07 02:28:49 +00:00
Tim-Philipp Müller
819d436ec4 docs: design: fix up some document titles
These show up in the index.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2222>
2022-04-18 21:39:32 +00:00
Tim-Philipp Müller
d726a839e4 docs: design: add adaptive streaming design docs to sitemap
.. and some small additions to make it clearer what exist
and what's new.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2222>
2022-04-18 21:39:32 +00:00
Edward Hervey
af78c16dd5 New HLS, DASH and MSS adaptive demuxer elements
This provides new HLS, DASH and MSS adaptive demuxer elements as a single plugin.

These elements offer many improvements over the legacy elements. They will only
work within a streams-aware context (`urisourcebin`, `uridecodebin3`,
`decodebin3`, `playbin3`, ...).

Stream selection and buffering is handled internally, this allows them to
directly manage the elementary streams and stream selection.

Authors:
* Edward Hervey <edward@centricular.com>
* Jan Schmidt <jan@centricular.com>
* Piotrek Brzeziński <piotr@centricular.com>
* Tim-Philipp Müller <tim@centricular.com>

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2117>
2022-04-18 14:11:23 +00:00
Seungha Yang
04bb1ac3ef docs: Update for Windows specific parts
* glimagesink is not a recommended one on Windows
* Remove directdrawsink section
* d3dvideosink is legacy and should not be recommended
* Add d3d11videosink part
* directsoundsink should be deprecated
* Add wasapisink/wasapi2sink part

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2144>
2022-04-14 03:55:56 +09:00
Fuga Kato
8a55dd9233 docs: design: negotiation: Fix indentation in pseudo-code
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2120>
2022-04-06 09:05:53 +00:00
Edward Hervey
656baad90f docs/design: Updates for upstream selection
Update existing documentation for various behaviours.

Add new information on how selection "upstream" of decodebin3 happens.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1905>
2022-03-30 14:30:54 +00:00
MGlolenstine
5c54cad469 doc: handy-elements: fix audiotestsrc description
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1966>
2022-03-16 06:00:08 +00:00
Sebastian Fricke
7063aa1471 docs: Fix typos in documentation
In building-from-source-using-meson.md:
s/implicitely/implicitly/

In README.md:
s/uncompatible/incompatible/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00