(API Change) Use 'get' convention in libobs (base)

Instead of having functions like obs_signal_handler() that can fail to
properly specify their actual intent in the name (does it signal a
handler, or does it return a signal handler?), always prefix functions
that are meant to get information with 'get' to make its functionality
more explicit.

Previous names:             New names:
-----------------------------------------------------------
obs_audio                   obs_get_audio
obs_video                   obs_get_video
obs_signalhandler           obs_get_signal_handler
obs_prochandler             obs_get_proc_handler
obs_source_signalhandler    obs_source_get_signal_handler
obs_source_prochandler      obs_source_get_proc_handler
obs_output_signalhandler    obs_output_get_signal_handler
obs_output_prochandler      obs_output_get_proc_handler
obs_service_signalhandler   obs_service_get_signal_handler
obs_service_prochandler     obs_service_get_proc_handler
This commit is contained in:
jp9000 2014-08-04 09:09:02 -07:00
parent 73baaa59e9
commit a3682fc8fb
12 changed files with 50 additions and 49 deletions

View file

@ -76,8 +76,8 @@ obs_output_t obs_output_create(const char *id, const char *name,
goto fail;
output->info = *info;
output->video = obs_video();
output->audio = obs_audio();
output->video = obs_get_video();
output->audio = obs_get_audio();
if (output->info.defaults)
output->info.defaults(output->context.settings);
@ -247,12 +247,12 @@ void obs_output_pause(obs_output_t output)
output->info.pause(output->context.data);
}
signal_handler_t obs_output_signalhandler(obs_output_t output)
signal_handler_t obs_output_get_signal_handler(obs_output_t output)
{
return output ? output->context.signals : NULL;
}
proc_handler_t obs_output_prochandler(obs_output_t output)
proc_handler_t obs_output_get_proc_handler(obs_output_t output)
{
return output ? output->context.procs : NULL;
}

View file

@ -56,7 +56,7 @@ static void *scene_create(obs_data_t settings, struct obs_source *source)
scene->source = source;
scene->first_item = NULL;
signal_handler_add_array(obs_source_signalhandler(source),
signal_handler_add_array(obs_source_get_signal_handler(source),
obs_scene_signals);
if (pthread_mutexattr_init(&attr) != 0)

View file

@ -167,12 +167,12 @@ obs_data_t obs_service_get_settings(obs_service_t service)
return service->context.settings;
}
signal_handler_t obs_service_signalhandler(obs_service_t service)
signal_handler_t obs_service_get_signal_handler(obs_service_t service)
{
return service ? service->context.signals : NULL;
}
proc_handler_t obs_service_prochandler(obs_service_t service)
proc_handler_t obs_service_get_proc_handler(obs_service_t service)
{
return service ? service->context.procs : NULL;
}

View file

@ -559,8 +559,9 @@ static void calc_volume_levels(struct obs_source *source, float *array,
float max_val = 0.0f;
float rms_val = 0.0f;
const uint32_t sample_rate = audio_output_samplerate(obs_audio());
const size_t channels = audio_output_channels(obs_audio());
audio_t audio = obs_get_audio();
const uint32_t sample_rate = audio_output_samplerate(audio);
const size_t channels = audio_output_channels(audio);
const size_t count = frames * channels;
const size_t vol_peak_delay = sample_rate * 3;
const float alpha = 0.15f;
@ -1735,12 +1736,12 @@ void obs_source_process_filter(obs_source_t filter, effect_t effect,
effect, width, height, use_matrix);
}
signal_handler_t obs_source_signalhandler(obs_source_t source)
signal_handler_t obs_source_get_signal_handler(obs_source_t source)
{
return source ? source->context.signals : NULL;
}
proc_handler_t obs_source_prochandler(obs_source_t source)
proc_handler_t obs_source_get_proc_handler(obs_source_t source)
{
return source ? source->context.procs : NULL;
}

View file

@ -820,12 +820,12 @@ void obs_leave_graphics(void)
gs_leavecontext();
}
audio_t obs_audio(void)
audio_t obs_get_audio(void)
{
return (obs != NULL) ? obs->audio.audio : NULL;
}
video_t obs_video(void)
video_t obs_get_video(void)
{
return (obs != NULL) ? obs->video.video : NULL;
}
@ -1086,13 +1086,13 @@ effect_t obs_get_solid_effect(void)
return obs->video.solid_effect;
}
signal_handler_t obs_signalhandler(void)
signal_handler_t obs_get_signal_handler(void)
{
if (!obs) return NULL;
return obs->signals;
}
proc_handler_t obs_prochandler(void)
proc_handler_t obs_get_proc_handler(void)
{
if (!obs) return NULL;
return obs->procs;

View file

@ -387,10 +387,10 @@ EXPORT void obs_enter_graphics(void);
EXPORT void obs_leave_graphics(void);
/** Gets the main audio output handler for this OBS context */
EXPORT audio_t obs_audio(void);
EXPORT audio_t obs_get_audio(void);
/** Gets the main video output handler for this OBS context */
EXPORT video_t obs_video(void);
EXPORT video_t obs_get_video(void);
/**
* Adds a source to the user source list and increments the reference counter
@ -456,10 +456,10 @@ EXPORT effect_t obs_get_default_effect(void);
EXPORT effect_t obs_get_solid_effect(void);
/** Returns the primary obs signal handler */
EXPORT signal_handler_t obs_signalhandler(void);
EXPORT signal_handler_t obs_get_signal_handler(void);
/** Returns the primary obs procedure handler */
EXPORT proc_handler_t obs_prochandler(void);
EXPORT proc_handler_t obs_get_proc_handler(void);
/** Adds a draw callback to the main render context */
EXPORT void obs_add_draw_callback(
@ -656,10 +656,10 @@ EXPORT enum obs_source_type obs_source_get_type(obs_source_t source);
EXPORT const char *obs_source_get_id(obs_source_t source);
/** Returns the signal handler for a source */
EXPORT signal_handler_t obs_source_signalhandler(obs_source_t source);
EXPORT signal_handler_t obs_source_get_signal_handler(obs_source_t source);
/** Returns the procedure handler for a source */
EXPORT proc_handler_t obs_source_prochandler(obs_source_t source);
EXPORT proc_handler_t obs_source_get_proc_handler(obs_source_t source);
/** Sets the user volume for a source that has audio output */
EXPORT void obs_source_set_volume(obs_source_t source, float volume);
@ -893,10 +893,10 @@ EXPORT void obs_output_pause(obs_output_t output);
EXPORT obs_data_t obs_output_get_settings(obs_output_t output);
/** Returns the signal handler for an output */
EXPORT signal_handler_t obs_output_signalhandler(obs_output_t output);
EXPORT signal_handler_t obs_output_get_signal_handler(obs_output_t output);
/** Returns the procedure handler for an output */
EXPORT proc_handler_t obs_output_prochandler(obs_output_t output);
EXPORT proc_handler_t obs_output_get_proc_handler(obs_output_t output);
/**
* Sets the current video media context associated with this output,

View file

@ -86,12 +86,12 @@ void VolControl::VolumeLevel(float mag, float peak, float peakHold)
void VolControl::SliderChanged(int vol)
{
if (signalChanged) {
signal_handler_disconnect(obs_source_signalhandler(source),
signal_handler_disconnect(obs_source_get_signal_handler(source),
"volume", OBSVolumeChanged, this);
obs_source_set_volume(source, float(vol)*0.01f);
signal_handler_connect(obs_source_signalhandler(source),
signal_handler_connect(obs_source_get_signal_handler(source),
"volume", OBSVolumeChanged, this);
}
@ -150,10 +150,10 @@ VolControl::VolControl(OBSSource source_)
setLayout(mainLayout);
signal_handler_connect(obs_source_signalhandler(source),
signal_handler_connect(obs_source_get_signal_handler(source),
"volume", OBSVolumeChanged, this);
signal_handler_connect(obs_source_signalhandler(source),
signal_handler_connect(obs_source_get_signal_handler(source),
"volume_level", OBSVolumeLevel, this);
QWidget::connect(slider, SIGNAL(valueChanged(int)),
@ -162,10 +162,10 @@ VolControl::VolControl(OBSSource source_)
VolControl::~VolControl()
{
signal_handler_disconnect(obs_source_signalhandler(source),
signal_handler_disconnect(obs_source_get_signal_handler(source),
"volume", OBSVolumeChanged, this);
signal_handler_disconnect(obs_source_signalhandler(source),
signal_handler_disconnect(obs_source_get_signal_handler(source),
"volume_level", OBSVolumeLevel, this);
}

View file

@ -352,12 +352,12 @@ bool OBSBasic::InitOutputs()
if (!streamOutput)
return false;
signal_handler_connect(obs_output_signalhandler(streamOutput),
signal_handler_connect(obs_output_get_signal_handler(streamOutput),
"start", OBSStartStreaming, this);
signal_handler_connect(obs_output_signalhandler(streamOutput),
signal_handler_connect(obs_output_get_signal_handler(streamOutput),
"stop", OBSStopStreaming, this);
signal_handler_connect(obs_output_signalhandler(fileOutput),
signal_handler_connect(obs_output_get_signal_handler(fileOutput),
"stop", OBSStopRecording, this);
return true;
@ -475,17 +475,17 @@ bool OBSBasic::InitBasicConfig()
void OBSBasic::InitOBSCallbacks()
{
signal_handler_connect(obs_signalhandler(), "source_add",
signal_handler_connect(obs_get_signal_handler(), "source_add",
OBSBasic::SourceAdded, this);
signal_handler_connect(obs_signalhandler(), "source_remove",
signal_handler_connect(obs_get_signal_handler(), "source_remove",
OBSBasic::SourceRemoved, this);
signal_handler_connect(obs_signalhandler(), "channel_change",
signal_handler_connect(obs_get_signal_handler(), "channel_change",
OBSBasic::ChannelChanged, this);
signal_handler_connect(obs_signalhandler(), "source_activate",
signal_handler_connect(obs_get_signal_handler(), "source_activate",
OBSBasic::SourceActivated, this);
signal_handler_connect(obs_signalhandler(), "source_deactivate",
signal_handler_connect(obs_get_signal_handler(), "source_deactivate",
OBSBasic::SourceDeactivated, this);
signal_handler_connect(obs_signalhandler(), "source_rename",
signal_handler_connect(obs_get_signal_handler(), "source_rename",
OBSBasic::SourceRenamed, this);
}
@ -667,7 +667,7 @@ void OBSBasic::AddScene(OBSSource source)
item->setData(Qt::UserRole, QVariant::fromValue(OBSScene(scene)));
ui->scenes->addItem(item);
signal_handler_t handler = obs_source_signalhandler(source);
signal_handler_t handler = obs_source_get_signal_handler(source);
signal_handler_connect(handler, "item_add",
OBSBasic::SceneItemAdded, this);
signal_handler_connect(handler, "item_remove",
@ -1940,8 +1940,8 @@ void OBSBasic::SetupEncoders()
obs_data_release(x264Settings);
obs_data_release(aacSettings);
obs_encoder_set_video(x264, obs_video());
obs_encoder_set_audio(aac, obs_audio());
obs_encoder_set_video(x264, obs_get_video());
obs_encoder_set_audio(aac, obs_get_audio());
}
}

View file

@ -33,7 +33,7 @@ OBSBasicProperties::OBSBasicProperties(QWidget *parent, OBSSource source_)
resizeTimer (0),
ui (new Ui::OBSBasicProperties),
source (source_),
removedSignal (obs_source_signalhandler(source), "remove",
removedSignal (obs_source_get_signal_handler(source), "remove",
OBSBasicProperties::SourceRemoved, this)
{
ui->setupUi(this);

View file

@ -405,7 +405,7 @@ void OBSBasicSettings::LoadVideoSettings()
{
loading = true;
if (video_output_active(obs_video())) {
if (video_output_active(obs_get_video())) {
ui->videoPage->setEnabled(false);
ui->videoMsg->setText(
QTStr("Basic.Settings.Video.CurrentlyActive"));

View file

@ -173,9 +173,9 @@ void OBSBasicStatusBar::StreamStarted(obs_output_t output)
{
streamOutput = output;
signal_handler_connect(obs_output_signalhandler(streamOutput),
signal_handler_connect(obs_output_get_signal_handler(streamOutput),
"reconnect", OBSOutputReconnect, this);
signal_handler_connect(obs_output_signalhandler(streamOutput),
signal_handler_connect(obs_output_get_signal_handler(streamOutput),
"reconnect_success", OBSOutputReconnectSuccess, this);
retries = 0;
@ -188,10 +188,10 @@ void OBSBasicStatusBar::StreamStopped()
{
if (streamOutput) {
signal_handler_disconnect(
obs_output_signalhandler(streamOutput),
obs_output_get_signal_handler(streamOutput),
"reconnect", OBSOutputReconnect, this);
signal_handler_disconnect(
obs_output_signalhandler(streamOutput),
obs_output_get_signal_handler(streamOutput),
"reconnect_success", OBSOutputReconnectSuccess,
this);

View file

@ -54,7 +54,7 @@ OBSBasicTransform::OBSBasicTransform(OBSBasic *parent)
SetScene(curScene);
SetItem(FindASelectedItem(curScene));
channelChangedSignal.Connect(obs_signalhandler(), "channel_change",
channelChangedSignal.Connect(obs_get_signal_handler(), "channel_change",
OBSChannelChanged, this);
}
@ -67,7 +67,7 @@ void OBSBasicTransform::SetScene(OBSScene scene)
if (scene) {
OBSSource source = obs_scene_get_source(scene);
signal_handler_t signal = obs_source_signalhandler(source);
signal_handler_t signal = obs_source_get_signal_handler(source);
transformSignal.Connect(signal, "item_transform",
OBSSceneItemTransform, this);