Merge pull request #1480 from kkartaltepe/module-descriptions

Plugins: Add descriptions to modules

plugins/coreaudio-encoder/encoder.cpp

@@ -1366,6 +1366,10 @@ static obs_properties_t *aac_properties(void *data)
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("coreaudio-encoder", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Apple CoreAudio based encoder";
+}
 
 bool obs_module_load(void)
 {

plugins/decklink/plugin-main.cpp

@@ -6,6 +6,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("decklink", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Blackmagic DeckLink source";
+}
 
 #define DEVICE_HASH     "device_hash"
 #define DEVICE_NAME     "device_name"

plugins/image-source/image-source.c

@@ -270,6 +270,10 @@ static struct obs_source_info image_source_info = {
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("image-source", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Image/color/slideshow sources";
+}
 
 extern struct obs_source_info slideshow_info;
 extern struct obs_source_info color_source_info;

plugins/linux-alsa/linux-alsa.c

@@ -18,6 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("linux-alsa", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Linux ALSA audio input capture";
+}
 
 extern struct obs_source_info alsa_input_capture;
 

plugins/linux-capture/linux-capture.c

@@ -18,6 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("linux-xshm", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "xcomposite/xshm based window/screen capture for X11";
+}
 
 extern struct obs_source_info xshm_input;
 

plugins/linux-jack/linux-jack.c

@@ -18,6 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("linux-jack", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "JACK Audio Connection Kit output capture";
+}
 
 extern struct obs_source_info jack_output_capture;
 

plugins/linux-pulseaudio/linux-pulseaudio.c

@@ -18,6 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("linux-pulseaudio", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Linux PulseAudio input/output capture";
+}
 
 extern struct obs_source_info pulse_input_capture;
 extern struct obs_source_info pulse_output_capture;

plugins/linux-v4l2/linux-v4l2.c

@@ -18,6 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("linux-v4l2", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Video4Linux2(V4L2) sources";
+}
 
 extern struct obs_source_info v4l2_input;
 

plugins/mac-avcapture/av-capture.mm

@@ -2175,6 +2175,10 @@ static void av_capture_update(void *data, obs_data_t *settings)
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("mac-avcapture", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "MacOS AVFoundation Capture source";
+}
 
 bool obs_module_load(void)
 {

plugins/mac-capture/plugin-main.c

@@ -2,6 +2,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("mac-capture", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "macOS audio input/output and window/display capture";
+}
 
 extern struct obs_source_info coreaudio_input_capture_info;
 extern struct obs_source_info coreaudio_output_capture_info;

plugins/mac-syphon/plugin-main.c

@@ -2,6 +2,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("syphon", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Syphon based game capture for macOS";
+}
 
 extern struct obs_source_info syphon_info;
 

plugins/obs-ffmpeg/obs-ffmpeg.c

@@ -8,6 +8,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-ffmpeg", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "FFmpeg based sources/outputs/encoders";
+}
 
 extern struct obs_source_info  ffmpeg_source;
 extern struct obs_output_info  ffmpeg_output;

plugins/obs-filters/obs-filters.c

@@ -2,8 +2,11 @@
 #include "obs-filters-config.h"
 
 OBS_DECLARE_MODULE()
-
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-filters", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "OBS core filters";
+}
 
 extern struct obs_source_info mask_filter;
 extern struct obs_source_info crop_filter;

plugins/obs-outputs/obs-outputs.c

@@ -9,6 +9,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-outputs", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "OBS core RTMP/FLV/null/FTL outputs";
+}
 
 extern struct obs_output_info rtmp_output_info;
 extern struct obs_output_info null_output_info;

plugins/obs-qsv11/obs-qsv11-plugin-main.c

@@ -58,6 +58,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-qsv11", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Intel Quick Sync Video H.264 encoder support for Windows";
+}
 
 extern struct obs_encoder_info obs_qsv_encoder;
 

plugins/obs-text/gdiplus/obs-text.cpp

@@ -804,6 +804,10 @@ static ULONG_PTR gdip_token = 0;
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-text", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Windows GDI+ text source";
+}
 
 #define set_vis(var, val, show) \
 	do { \

plugins/obs-transitions/obs-transitions.c

@@ -1,8 +1,11 @@
 #include <obs-module.h>
 
 OBS_DECLARE_MODULE()
-
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-transitions", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "OBS core transitions";
+}
 
 extern struct obs_source_info cut_transition;
 extern struct obs_source_info fade_transition;

plugins/obs-x264/obs-x264-plugin-main.c

@@ -2,6 +2,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-x264", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "x264 based encoder";
+}
 
 extern struct obs_encoder_info obs_x264_encoder;
 

plugins/rtmp-services/rtmp-services-main.c

@@ -10,6 +10,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("rtmp-services", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "OBS core RTMP services";
+}
 
 #define RTMP_SERVICES_LOG_STR "[rtmp-services plugin] "
 #define RTMP_SERVICES_VER_STR "rtmp-services plugin (libobs " OBS_VERSION ")"

plugins/text-freetype2/text-freetype2.c

@@ -28,6 +28,10 @@ FT_Library ft2_lib;
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("text-freetype2", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "FreeType2 text source";
+}
 
 uint32_t texbuf_w = 2048, texbuf_h = 2048;
 

plugins/vlc-video/vlc-video-plugin.c

@@ -7,6 +7,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("vlc-video", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "VLC playlist source";
+}
 
 /* libvlc core */
 LIBVLC_NEW libvlc_new_;

plugins/win-capture/plugin-main.c

@@ -5,6 +5,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("win-capture", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Windows game/screen/window capture";
+}
 
 extern struct obs_source_info duplicator_capture_info;
 extern struct obs_source_info monitor_capture_info;

plugins/win-dshow/dshow-plugin.cpp

@@ -2,6 +2,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("win-dshow", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Windows DirectShow source/encoder";
+}
 
 extern void RegisterDShowSource();
 extern void RegisterDShowEncoders();

plugins/win-mf/mf-plugin.cpp

@@ -30,6 +30,10 @@ extern "C" void obs_module_unload(void)
 }
 
 OBS_DECLARE_MODULE()
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Windows Media Foundations H.264/AAC encoder";
+}
 
 #if ENABLE_WINMF
 OBS_MODULE_USE_DEFAULT_LOCALE("win-mf", "en-US")

plugins/win-wasapi/plugin-main.cpp

@@ -2,6 +2,10 @@
 
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("win-wasapi", "en-US")
+MODULE_EXPORT const char *obs_module_description(void)
+{
+	return "Windows WASAPI audio input/ouput sources";
+}
 
 void RegisterWASAPIInput();
 void RegisterWASAPIOutput();