Commit graph

59 commits

Author SHA1 Message Date
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
Sebastian Fricke
5a421886b4 docs: Extend documentation for the GStreamer development environment
Add more extensive documentation for the development environment.
Document how the tool works, how to use it and common use cases.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00
Sebastian Fricke
0b6bbce012 Remove the uninstalled term
Remove the symbolic link `gst-uninstalled` which points to `gst-env`.
The `uninstalled` is the old name and the project should stick to a
single name for the procedure.
Remove the term from all the files, exceptions are variables from
dependencies like `uninstalled_variables` from pkgconfig and
`meson-uninstalled`.
Adjust mentions of the script in the documentation and README.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00
Krystian Wojtas
7bebb2ea38 tutorials: vdpau is ababdoned
https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/issues/828

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1671>
2022-02-08 19:54:24 +00:00
Tim-Philipp Müller
f2375383e5 tutorials: proper links description
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1670>
2022-02-08 19:44:59 +00:00
Krystian Wojtas
70c933ac6a tutorials: links to monorepo
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1670>
2022-02-08 19:44:59 +00:00
Krystian Wojtas
e1ac843ffb tutorials: fixed described log level number to correspond with code
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1669>
2022-02-08 19:34:37 +00:00
Krystian Wojtas
82a9ec9429 tutorials: fix typos
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1669>
2022-02-08 19:34:37 +00:00
Krystian Wojtas
1973334699 tutorials: word hardware instead of h character
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1669>
2022-02-08 19:34:37 +00:00
Alistair Martin
da142983b0 Incl resample in CustomData, tutorial 3
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1619>
2022-02-01 20:08:17 +00:00
Brad Hards
6838742801 docs: Updates to contributing guide
Mostly some modifications for handling security issues.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1370>
2022-01-27 10:24:28 +05:30
Nirbheek Chauhan
8594878337 docs: Explain how to open a merge request with screenshots
The merge request workflow can be confusing to people unfamiliar with
it, so add screenshots.

Also add a new section on how to revise merge requests, since a lot of
people tend to open new merge requests to make any changes.

Eliminate the separate "How to Prepare a Merge Request for Submission"
section -- merge it with the main section.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1367>
2022-01-27 10:11:51 +05:30
Tim-Philipp Müller
2452f0bbcf docs: interlaced video: small additions for alternate interlacing
Clarify that width/height in caps is still the frame height/width,
not field height width, just like framerate is frame rate not
field rate.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1465>
2021-12-23 01:52:04 +00:00
Krystian Wojtas
423acef4d9 tutorials: Fix typos
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1382>
2021-11-23 19:56:27 +01:00
Ralf Sippl
0c9d9d90d9 docs: app-dev: events: seeking: use CLOCK_TIME_NONE instead of -1 and fix parameter names
to match the parameter names in the gst_element_seek() declaration.

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

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
wuchang li
7ac662f19d docs: installing-on-macos: flesh out instructions what to download
Closes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/106/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
Tyler Compton
ebb61c5e24 plugin-development: basics-boilerplate: Remove unneeded meson.build edit step
Closes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/157/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
Teh Yule Kim
c66b10b5cb docs: installing-on-windows: mention packages to download
Closes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/158/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
Teh Yule Kim
bda72282dd docs: tutorials: add link to Rust version of the tutorials
Closes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/159/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
fjmax
5c9fe1dc3c docs: tutorials: playback-3: flesh out build instructions
Add information about how to compile this file. The code in this
tutorial also requires `gstreamer-audio-1.0`, so we cannot use
the commands from the previous tutorial.

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

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
wngecn
bcff6abafd docs: plugin-dev: basics-boilerplate: fix typo in variable name
Closes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/166/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1324>
2021-11-09 17:46:31 +00:00
Piotrek Brzeziński
6aa80270dd mediatype-video-raw: add ARGB64_LE/BE and variants
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1286>
2021-10-31 22:28:23 +00:00
Tim-Philipp Müller
139bfc8aeb docs: contribute: bump compiler reqs and coding style to C99
Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer-project/-/issues/78

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1243>
2021-10-25 09:53:49 +00:00
Tim-Philipp Müller
77a415c460 docs: contribute: update how-to-submit-patches section for monorepo
See https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/840#note_1114907

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1231>
2021-10-22 20:28:22 +00:00
Tim-Philipp Müller
c95a7ab1ca docs: remove mention of mms from docs and mmssrc from tutorials
Prerequisite for our removing it from the cerbero build, see
https://gitlab.freedesktop.org/gstreamer/cerbero/-/merge_requests/760

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1199>
2021-10-20 00:40:22 +00:00
Stéphane Cerveau
7256ddb74a rebase-branch-from-old: few improvments
- Enhance the documentation
- Allow to revert cherry-pick
- coding style

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1094>
2021-10-13 17:03:09 +00:00