(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-08 11:04:46 -07:00
parent 73baaa59e9
commit a3682fc8fb
12 changed files with 50 additions and 49 deletions
+4 -4
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;
}
+1 -1
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)
+2 -2
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;
}
+5 -4
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;
}
+4 -4
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;
+8 -8
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,