Go to file
VodBox a8c30373d6 libobs: Add AutoRelease OBSRef wrappers for OBS types
These AutoRelease versions of the C++ OBSRef types do not add a ref on
construction, which is useful when accepting the result of a function
that turns a raw C pointer type that has had a reference added.

Not having these types has resulted in multiple awkward anti-patterns.
Such as immediately releasing after construction to account for the
extra addref, or avoiding using the C++ type entirely and manually
releasing it later.

Example:
```
OBSSource source = obs_get_source_by_name(name.c_str());
obs_source_release(source);
```

The whole point of these types is to avoid the need for manual releases,
and rely on the RAII mechanisms inside of C++. Additionally, the
immediate release isn't commented anywhere, resulting in confusion for
other developers looking at the code as to why things are being
immediately released.

The AutoRelease types and names are taken from obs-websocket.
2021-11-26 22:35:03 +13:00
.github CI: Add Crowdin Synchronization 2021-11-25 20:59:11 +11:00
CI CI: Allow Flatpak audio plugins be found 2021-11-25 09:20:05 -03:00
UI UI: Add separator before Custom Browser Docks in Dock menu 2021-11-26 18:06:51 +11:00
additional_install_files Improve additional_install_files for debug/release 2014-07-18 22:41:11 -07:00
cmake aja: Capture and Output plugin for AJA Video Systems IO devices 2021-11-23 20:31:11 -06:00
deps ipc-util: Fix potential ready_event hang 2021-11-21 01:38:36 -08:00
docs/sphinx libobs: Add raw audio callback function 2021-11-24 01:32:31 -08:00
libobs libobs: Add AutoRelease OBSRef wrappers for OBS types 2021-11-26 22:35:03 +13:00
libobs-d3d11 libobs: Fix gs_texture_2d::BackupTexture with GS_TEXTURE_CUBE 2021-11-23 20:52:40 -08:00
libobs-opengl libobs-opengl: Use PBO in device_stage_texture on macOS 2021-11-02 06:05:18 -07:00
libobs-winrt libobs-winrt: Require Windows 10 SDK 20348 2021-09-11 13:00:28 -07:00
plugins linux-capture: Implement stream restoration 2021-11-24 11:42:06 -08:00
test decklink: Clean up warnings introduced by caption code 2020-11-03 17:00:14 -08:00
.cirrus.yml CI: Fix swig dependency on FreeBSD 2020-10-03 05:38:46 -07:00
.clang-format Apply clang-format to objective c code 2019-07-09 13:39:13 -05:00
.editorconfig .editorconfig: Add file to speed up editor configuration 2017-06-14 21:35:09 -05:00
.git-blame-ignore-revs .git-blame-ignore-revs: Add file to handle mass reformatting 2019-06-27 01:09:31 +09:00
.gitattributes CI: Add Crowdin Synchronization 2021-11-25 20:59:11 +11:00
.gitignore .gitignore: Add flatpak-builder folders 2021-11-24 17:48:26 -03:00
.gitmodules enc-amf: Update to 2.5.0.1 and update repository address 2018-09-28 10:54:19 +02:00
.mailmap .mailmap: Disambiguate many more authors 2021-01-11 17:45:01 -08:00
AUTHORS Update translations from Crowdin 2021-09-24 09:42:08 -07:00
CMakeLists.txt libobs/util: Add type test in darray macros for GCC 2021-10-01 13:00:00 +09:00
COC.rst Revert "docs: Rename Code of Conduct to fix GitHub detection" 2021-08-07 20:40:29 +10:00
COMMITMENT Add GPL Cooperation Commitment to base directory 2019-01-24 02:02:49 -05:00
CONTRIBUTING.rst CONTRIBUTING.rst: Add service submission guidelines (#5562) 2021-11-22 08:29:39 -06:00
COPYING COPYING: Use license file from gnu.org 2021-10-24 00:35:27 -07:00
INSTALL Update INSTALL 2018-07-14 08:21:00 +01:00
README.rst docs: Remove block quotes (#4621) 2021-05-01 19:46:54 -05:00
formatcode.sh aja: Capture and Output plugin for AJA Video Systems IO devices 2021-11-23 20:31:11 -06:00

README.rst

OBS Studio <https://obsproject.com>
===================================

.. image:: https://github.com/obsproject/obs-studio/actions/workflows/main.yml/badge.svg?branch=master&event=push
   :alt: OBS Studio Build Status - GitHub Actions
   :target: https://github.com/obsproject/obs-studio/actions/workflows/main.yml?query=event%3Apush+branch%3Amaster

.. image:: https://d322cqt584bo4o.cloudfront.net/obs-studio/localized.svg
   :alt: OBS Studio Translation Project Progress
   :target: https://crowdin.com/project/obs-studio

.. image:: https://img.shields.io/discord/348973006581923840.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
   :alt: OBS Studio Discord Server
   :target: https://obsproject.com/discord

What is OBS Studio?
-------------------

OBS Studio is software designed for capturing, compositing, encoding,
recording, and streaming video content, efficiently.

It's distributed under the GNU General Public License v2 (or any later
version) - see the accompanying COPYING file for more details.

Quick Links
-----------

- Website: https://obsproject.com

- Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki

- Forums: https://obsproject.com/forum/

- Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions

- Developer/API Documentation: https://obsproject.com/docs

- Donating/backing/sponsoring: https://obsproject.com/contribute

- Bug Tracker: https://github.com/obsproject/obs-studio/issues

Contributing
------------

- If you would like to help fund or sponsor the project, you can do so
  via `Patreon <https://www.patreon.com/obsproject>`_, `OpenCollective
  <https://opencollective.com/obsproject>`_, or `PayPal
  <https://www.paypal.me/obsproject>`_.  See our `contribute page
  <https://obsproject.com/contribute>`_ for more information.

- If you wish to contribute code to the project, please make sure to
  read the coding and commit guidelines:
  https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst

- Developer/API documentation can be found here:
  https://obsproject.com/docs

- If you wish to contribute translations, do not submit pull requests.
  Instead, please use Crowdin.  For more information read this thread:
  https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/

- Other ways to contribute are by helping people out with support on
  our forums or in our community chat.  Please limit support to topics
  you fully understand -- bad advice is worse than no advice.  When it
  comes to something that you don't fully know or understand, please
  defer to the official help or official channels.