obs-studio/libobs/obs-service.h
jp9000 84e1f47ced (API Change) Add support for multiple audio mixers
API changed:
--------------------------

void obs_output_set_audio_encoder(
		obs_output_t *output,
		obs_encoder_t *encoder);

obs_encoder_t *obs_output_get_audio_encoder(
		const obs_output_t *output);

obs_encoder_t *obs_audio_encoder_create(
		const char *id,
		const char *name,
		obs_data_t *settings);

Changed to:
--------------------------

/* 'idx' specifies the track index of the output */
void obs_output_set_audio_encoder(
		obs_output_t *output,
		obs_encoder_t *encoder,
		size_t idx);

/* 'idx' specifies the track index of the output */
obs_encoder_t *obs_output_get_audio_encoder(
		const obs_output_t *output,
		size_t idx);

/* 'mixer_idx' specifies the mixer index to capture audio from */
obs_encoder_t *obs_audio_encoder_create(
		const char *id,
		const char *name,
		obs_data_t *settings,
		size_t mixer_idx);

Overview
--------------------------
This feature allows multiple audio mixers to be used at a time.  This
capability was able to be added with surprisingly very little extra
overhead.  Audio will not be mixed unless it's assigned to a specific
mixer, and mixers will not mix unless they have an active mix
connection.

Mostly this will be useful for being able to separate out specific audio
for recording versus streaming, but will also be useful for certain
streaming services that support multiple audio streams via RTMP.

I didn't want to use a variable amount of mixers due to the desire to
reduce heap allocations, so currently I set the limit to 4 simultaneous
mixers; this number can be increased later if needed, but honestly I
feel like it's just the right number to use.

Sources:

Sources can now specify which audio mixers their audio is mixed to; this
can be a single mixer or multiple mixers at a time.  The
obs_source_set_audio_mixers function sets the audio mixer which an audio
source applies to.  For example, 0xF would mean that the source applies
to all four mixers.

Audio Encoders:

Audio encoders now must specify which specific audio mixer they use when
they encode audio data.

Outputs:

Outputs that use encoders can now support multiple audio tracks at once
if they have the OBS_OUTPUT_MULTI_TRACK capability flag set.  This is
mostly only useful for certain types of RTMP transmissions, though may
be useful for file formats that support multiple audio tracks as well
later on.
2015-02-04 16:51:29 -08:00

79 lines
2.3 KiB
C

/******************************************************************************
Copyright (C) 2013-2014 by Hugh Bailey <obs.jim@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
#pragma once
/**
* @file
* @brief header for modules implementing services.
*
* Services are modules that implement provider specific settings for outputs.
*/
#ifdef __cplusplus
extern "C" {
#endif
struct obs_service_info {
/* required */
const char *id;
const char *(*get_name)(void);
void *(*create)(obs_data_t *settings, obs_service_t *service);
void (*destroy)(void *data);
/* optional */
void (*activate)(void *data, obs_data_t *settings);
void (*deactivate)(void *data);
void (*update)(void *data, obs_data_t *settings);
void (*get_defaults)(obs_data_t *settings);
obs_properties_t *(*get_properties)(void *data);
/**
* Called when getting ready to start up an output, before the encoders
* and output are initialized
*
* @param data Internal service data
* @param output Output context
* @eturn true to allow the output to start up,
* false to prevent output from starting up
*/
bool (*initialize)(void *data, obs_output_t *output);
const char *(*get_url)(void *data);
const char *(*get_key)(void *data);
const char *(*get_username)(void *data);
const char *(*get_password)(void *data);
bool (*supports_multitrack)(void *data);
/* TODO: more stuff later */
};
EXPORT void obs_register_service_s(const struct obs_service_info *info,
size_t size);
#define obs_register_service(info) \
obs_register_service_s(info, sizeof(struct obs_service_info))
#ifdef __cplusplus
}
#endif