obs-studio/docs/sphinx
tt2468 16f0bb68ae libobs: Add OBS_ENCODER_CAP_SCALING
Adds a new encoder cap which tells libobs that rather than scaling
video frames in software, the encoder is capable of scaling them via
its own (presumably more efficient) means.

An encoder may implement this cap by comparing the VOI of its assigned
`video_t` and the results of `obs_encoder_get_width/height()`. If the
width/height values differ, then the encoder is being asked by libobs
to self-scale, and the resolution in VOI will be the raw frame size,
with the `...get_width/height()` being the intended output resolution
of the encoder.

It is important to note that GPU rescaling mode will take priority
over self-scaling. If GPU rescaling is enabled, the encoder will never
be asked to self-scale.

This is useful for discrete hardware encoders, where they might have
fixed-function video scaling logic that is highly efficient and fast.
Additionally, this feature allows a hardware device which is encoding
a full ABR ladder of tracks to be smart and only copy a video frame
from GPU -> Host -> Device once for the entire ladder, rather than
once for every track.
2024-08-23 14:20:53 -04:00
..
_build docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
_static docs/sphinx: Override RTD style 2022-07-30 11:09:01 +10:00
_templates docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
backend-design.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
conf.py Update copyrights/names 2023-05-20 01:31:18 -07:00
favicon.ico CI: Use ReadTheDocs theme for Sphinx docs 2022-07-30 11:09:01 +10:00
frontends.rst docs/sphinx: Minor formatting corrections 2022-06-05 12:14:05 +10:00
graphics.rst docs/sphinx: Document SRGB changes 2021-01-21 07:42:56 -08:00
index.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
logo.svg docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
make.bat docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
Makefile docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
plugins.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
reference-core-objects.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
reference-core.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-encoders.rst libobs: Add OBS_ENCODER_CAP_SCALING 2024-08-23 14:20:53 -04:00
reference-frontend-api.rst UI,docs: Send a custom event to the dock widget when closing 2024-08-04 10:18:59 +10:00
reference-libobs-callback.rst docs: Clarify signal_handler_connect() 2022-12-03 15:19:06 -08:00
reference-libobs-graphics-axisang.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-effects.rst docs: Fix layout and typos 2023-02-26 10:31:02 +11:00
reference-libobs-graphics-graphics.rst libobs/graphics: Enable DMABUF on FreeBSD and DragonFly 2023-01-24 11:50:13 -05:00
reference-libobs-graphics-image-file.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-math.rst docs: Fix macro definitions 2023-07-08 16:09:09 -07:00
reference-libobs-graphics-matrix4.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-quat.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec2.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec3.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec4.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-media-io.rst libobs: Add VIDEO_FORMAT_R10L 2023-07-29 16:41:31 -07:00
reference-libobs-util-base.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-bmem.rst docs/sphinx: Fix statement typo for bfree() 2022-05-30 20:57:39 -07:00
reference-libobs-util-circlebuf.rst docs: Fix circlebuf deprecation note 2024-02-08 18:21:37 -05:00
reference-libobs-util-config-file.rst docs: Add missing config_t get/set functions 2021-11-23 21:52:30 -08:00
reference-libobs-util-darray.rst docs: Add example for DARRAY as function parameter 2023-07-06 01:47:24 -07:00
reference-libobs-util-deque.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-libobs-util-dstr.rst docs: Clarify strlist_split 2023-08-27 09:55:36 +10:00
reference-libobs-util-platform.rst docs: Add versionadded directives for 29.1 2023-06-25 09:29:25 +10:00
reference-libobs-util-profiler.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-serializers.rst libobs/util: Add buffered file serializer 2024-05-18 16:15:41 -07:00
reference-libobs-util-source-profiler.rst docs: Add source profiler functions 2024-08-10 23:51:39 -07:00
reference-libobs-util-text-lookup.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-threading.rst docs/sphinx: Minor formatting corrections 2022-06-05 12:14:05 +10:00
reference-libobs-util.rst docs: Add source profiler functions 2024-08-10 23:51:39 -07:00
reference-modules.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-outputs.rst libobs: Add VIDEO_FORMAT_R10L 2023-07-29 16:41:31 -07:00
reference-properties.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-scenes.rst docs: Add missing sceneitem functions 2023-12-14 23:25:20 +01:00
reference-services.rst docs: Add versionadded directives for 29.1 2023-06-25 09:29:25 +10:00
reference-settings.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-sources.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
requirements.txt docs: Fix sphinx import error on Python 3.10+ 2022-10-20 21:26:52 +11:00
scripting.rst docs: Add note about instance methods as callbacks in scripting 2023-04-15 16:36:32 -07:00