docs/sphinx: Fix various typos

(This modifies UI, libobs, deps/obs-scripting, various cmake files)

Found using:
`codespell -q 3 -S *.ini,./UI/data/locale,./deps/w32-pthreads -L aci,dur,iff,mut,numer,uint`
master
luz.paz 2019-09-19 07:31:17 -04:00 committed by jp9000
parent 6b08c064f6
commit d124e6402c
33 changed files with 57 additions and 57 deletions

View File

@ -175,7 +175,7 @@ static void PopulateBitrateMap()
if (aac_ != GetCodec(encoder.c_str()))
continue;
// disable mf_aac if audio ouput is not stereo nor mono
// disable mf_aac if audio output is not stereo nor mono
if ((output_channels >= 3) && (encoder == "mf_aac"))
continue;

View File

@ -957,7 +957,7 @@ LockedCheckBox::indicator:unchecked:hover {
image: url(:res/images/unlocked.svg);
}
/* Visibilty CheckBox */
/* Visibility CheckBox */
VisibilityCheckBox {
outline: none;

View File

@ -715,7 +715,7 @@ LockedCheckBox::indicator:unchecked {
image: url(:res/images/unlocked.svg);
}
/* Visibilty CheckBox */
/* Visibility CheckBox */
VisibilityCheckBox {
outline: none;

View File

@ -1293,7 +1293,7 @@ LockedCheckBox::indicator:unchecked:hover {
image: url(:res/images/unlocked.svg);
}
/* Visibilty CheckBox */
/* Visibility CheckBox */
VisibilityCheckBox {
outline: none;

View File

@ -186,7 +186,7 @@ LockedCheckBox::indicator:unchecked {
image: url(:res/images/unlocked.svg);
}
/* Visibilty CheckBox */
/* Visibility CheckBox */
VisibilityCheckBox {
outline: none;

View File

@ -488,7 +488,7 @@ void VolumeMeter::setPeakMeterType(enum obs_peak_meter_type peakMeterType)
// processing required by lossy audio compression.
//
// The alignment level was not specified, but I've adjusted
// it compared to a sample-peak meter. Incidently Youtube
// it compared to a sample-peak meter. Incidentally Youtube
// uses this new Alignment Level as the maximum integrated
// loudness of a video.
//

View File

@ -591,7 +591,7 @@ void OBSProjector::OBSRenderMultiview(void *data, uint32_t cx, uint32_t cy)
gs_matrix_pop();
}
// Region for future usage with aditional info.
// Region for future usage with additional info.
if (multiviewLayout == MultiviewLayout::HORIZONTAL_TOP_24_SCENES) {
// Just paint the background for now
paintAreaWithColor(window->thickness, window->thickness,

View File

@ -1,4 +1,4 @@
# Doesn't realy make sense anywhere else
# Doesn't really make sense anywhere else
if(NOT MSVC)
return()
endif()
@ -8,7 +8,7 @@ if(COPIED_DEPENDENCIES)
return()
endif()
option(COPY_DEPENDENCIES "Automaticaly try copying all dependencies" ON)
option(COPY_DEPENDENCIES "Automatically try copying all dependencies" ON)
if(NOT COPY_DEPENDENCIES)
return()
endif()

View File

@ -3,7 +3,7 @@
#
# FFMPEG_FOUND - All required components and the core library were found
# FFMPEG_INCLUDE_DIRS - Combined list of all components include dirs
# FFMPEG_LIBRARIES - Combined list of all componenets libraries
# FFMPEG_LIBRARIES - Combined list of all components libraries
# FFMPEG_VERSION_STRING - Version of the first component requested
#
# For each requested component the following variables are defined:

View File

@ -70,7 +70,7 @@ if(NOT PYTHONLIBS_FOUND AND NOT LUAJIT_FOUND)
return()
endif()
set(SCRIPTING_ENABLED ON CACHE BOOL "Interal global cmake variable" FORCE)
set(SCRIPTING_ENABLED ON CACHE BOOL "Internal global cmake variable" FORCE)
if(UI_ENABLED)
set(EXTRA_LIBS obs-frontend-api)

View File

@ -98,7 +98,7 @@ save/load individual sources manually by using
:c:func:`obs_save_source()` and :c:func:`obs_load_source()`.
*(Author's note: I should not have written those helper functions; the
downside is I had to add "private" sources that aren't savable via the*
downside is I had to add "private" sources that aren't saveable via the*
:c:func:`obs_source_create_private()` *function. Just one of the many
minor design flaws that can occur during long-term development.)*

View File

@ -826,7 +826,7 @@ Draw Functions
Gets the current viewport
:param rect: Pointer to recieve viewport rectangle
:param rect: Pointer to receive viewport rectangle
---------------------

View File

@ -249,5 +249,5 @@
Normalizes a vector
:param dst: Desination
:param dst: Destination
:param v: Vector to normalize

View File

@ -273,7 +273,7 @@
Normalizes a vector
:param dst: Desination
:param dst: Destination
:param v: Vector to normalize
---------------------

View File

@ -268,7 +268,7 @@
Normalizes a vector
:param dst: Desination
:param dst: Destination
:param v: Vector to normalize
---------------------

View File

@ -95,7 +95,7 @@ dynamic array value with a reference (&) operator. For example:
.. function:: void da_copy(da_dst, da_src)
Makes a copy of a dyanmic array.
Makes a copy of a dynamic array.
:param da_dst: The dynamic array to copy to
:param da_src: The dynamic array to copy from

View File

@ -188,7 +188,7 @@ Dynamic String Functions
Copies a specific number of characters from another dynamic string.
:param dst: Dynamic string
:param src: Dynamic tring to copy
:param src: Dynamic string to copy
:param len: Number of characters to copy
----------------------
@ -234,7 +234,7 @@ Dynamic String Functions
.. function:: void dstr_cat_dstr(struct dstr *dst, const struct dstr *str)
Concatenates a dyanmic string with another dynamic string.
Concatenates a dynamic string with another dynamic string.
:param dst: Dynamic string to concatenate to
:param str: Dynamic string to concatenate with
@ -308,7 +308,7 @@ Dynamic String Functions
Removes a specific number of characters starting from a specific
index.
:param dst: Dyanmic string
:param dst: Dynamic string
:param idx: Index to start removing characters at
:param count: Number of characters to remove

View File

@ -355,7 +355,7 @@ Other Path/File Functions
.. function:: int os_copyfile(const char *file_in, const char *file_out)
Copys a file.
Copies a file.
---------------------

View File

@ -159,7 +159,7 @@ Profiler Data Access Functions
:param snap: A profiler snapshot
:param filename: The path to the CSV file to save
:return: *true* if successfuly written, *false* otherwise
:return: *true* if successfully written, *false* otherwise
----------------------
@ -169,7 +169,7 @@ Profiler Data Access Functions
:param snap: A profiler snapshot
:param filename: The path to the gzipped CSV file to save
:return: *true* if successfuly written, *false* otherwise
:return: *true* if successfully written, *false* otherwise
----------------------

View File

@ -73,7 +73,7 @@ Event Functions
- 0 - successful
- ETIMEDOUT - Timed out
- EINVAL - An unexpected error occured
- EINVAL - An unexpected error occurred
----------------------
@ -86,7 +86,7 @@ Event Functions
- 0 - successful
- EAGAIN - The event is not signaled
- EINVAL - An unexpected error occured
- EINVAL - An unexpected error occurred
----------------------
@ -123,7 +123,7 @@ Semaphore Functions
.. function:: void os_sem_destroy(os_sem_t *sem)
Destroys a sempahore object.
Destroys a semaphore object.
:param sem: Semaphore object
@ -140,7 +140,7 @@ Semaphore Functions
.. function:: int os_sem_wait(os_sem_t *sem)
Decrements the semphore or waits until the semaphore has been
Decrements the semaphore or waits until the semaphore has been
incremented.
:param sem: Semaphore object

View File

@ -98,7 +98,7 @@ to communicate with libobs and front-ends.
Module Externs
--------------
These functions are externs that are useable throughout the module.
These functions are externs that are usable throughout the module.
.. function:: const char *obs_module_text(const char *lookup_string)

View File

@ -122,7 +122,7 @@ Output Definition Structure (obs_output_info)
.. member:: void (*obs_output_info.raw_audio)(void *data, struct audio_data *frames)
This is called when the output recieves raw audio data. Only applies
This is called when the output receives raw audio data. Only applies
to outputs that are not encoded.
**This callback must be used with single-track raw outputs.**
@ -131,7 +131,7 @@ Output Definition Structure (obs_output_info)
.. member:: void (*obs_output_info.raw_audio2)(void *data, size_t idx, struct audio_data *frames)
This is called when the output recieves raw audio data. Only applies
This is called when the output receives raw audio data. Only applies
to outputs that are not encoded.
**This callback must be used with multi-track raw outputs.**
@ -251,7 +251,7 @@ Output Signals
:Parameters: - **code** - Can be one of the following values:
| OBS_OUTPUT_SUCCESS - Successfuly stopped
| OBS_OUTPUT_SUCCESS - Successfully stopped
| OBS_OUTPUT_BAD_PATH - The specified path was invalid
| OBS_OUTPUT_CONNECT_FAILED - Failed to connect to a server
| OBS_OUTPUT_INVALID_STREAM - Invalid stream path
@ -368,7 +368,7 @@ General Output Functions
Starts the output.
:return: *true* if output successfuly started, *false* otherwise. If
:return: *true* if output successfully started, *false* otherwise. If
the output failed to start,
:c:func:`obs_output_get_last_error()` may contain a specific
error string related to the reason
@ -460,7 +460,7 @@ General Output Functions
Pause an output (if supported by the output).
:return: *true* if the output was paused successfuly, *false*
:return: *true* if the output was paused successfully, *false*
otherwise
---------------------
@ -818,7 +818,7 @@ Functions used by outputs
to the user
:param code: | Can be one of the following values:
| OBS_OUTPUT_SUCCESS - Successfuly stopped
| OBS_OUTPUT_SUCCESS - Successfully stopped
| OBS_OUTPUT_BAD_PATH - The specified path was invalid
| OBS_OUTPUT_CONNECT_FAILED - Failed to connect to a server
| OBS_OUTPUT_INVALID_STREAM - Invalid stream path

View File

@ -182,7 +182,7 @@ Property Object Functions
- **OBS_COMBO_TYPE_EDITABLE** - Can be edited.
Only used with string lists.
- **OBS_COMBO_TYPE_LIST** - Not ediable.
- **OBS_COMBO_TYPE_LIST** - Not editable.
:param format: Can be one of the following values:

View File

@ -398,7 +398,7 @@ Scene Item Functions
.. function:: void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item, struct matrix4 *transform)
Gets the transform matrix of the scene item used for the bouding box
Gets the transform matrix of the scene item used for the bounding box
or edges of the scene item.
---------------------

View File

@ -96,7 +96,7 @@ Source Definition Structure (obs_source_info)
user.
When this is used, the source will receive interaction events if
theese callbacks are provided:
these callbacks are provided:
:c:member:`obs_source_info.mouse_click`,
:c:member:`obs_source_info.mouse_move`,
:c:member:`obs_source_info.mouse_wheel`,
@ -286,7 +286,7 @@ Source Definition Structure (obs_source_info)
Called to enumerate all active sources being used within this
source. If the source has children that render audio/video it must
implement this callback. Only used with sources that have tha
implement this callback. Only used with sources that have the
OBS_SOURCE_COMPOSITE output capability flag.
:param enum_callback: Enumeration callback
@ -391,14 +391,14 @@ Source Definition Structure (obs_source_info)
.. member:: bool (*obs_source_info.audio_render)(void *data, uint64_t *ts_out, struct obs_source_audio_mix *audio_output, uint32_t mixers, size_t channels, size_t sample_rate)
Called to render audio of composite sources. Only used with sources
that have tha OBS_SOURCE_COMPOSITE output capability flag.
that have the OBS_SOURCE_COMPOSITE output capability flag.
.. member:: void (*obs_source_info.enum_all_sources)(void *data, obs_source_enum_proc_t enum_callback, void *param)
Called to enumerate all active and inactive sources being used
within this source. If this callback isn't implemented,
enum_active_sources will be called instead. Only used with sources
that have tha OBS_SOURCE_COMPOSITE output capability flag.
that have the OBS_SOURCE_COMPOSITE output capability flag.
This is typically used if a source can have inactive child sources.
@ -836,7 +836,7 @@ General Source Functions
.. function:: bool obs_source_active(const obs_source_t *source)
:return: *true* if active, *false* if not. A source is only
consdiered active if it's being shown on the final mix
considered active if it's being shown on the final mix
---------------------
@ -1268,8 +1268,8 @@ Transitions
Sets/gets the scale type for sources within the transition.
:param type: | OBS_TRANSITION_SCALE_MAX_ONLY - Scale to aspect ratio, but only to the maximum size of each source
| OBS_TRANSITION_SCALE_ASPECT - Alwasy scale the sources, but keep aspect ratio
| OBS_TRANSITION_SCALE_STRETCH - Scale and stretch the sources to the size of the transision
| OBS_TRANSITION_SCALE_ASPECT - Always scale the sources, but keep aspect ratio
| OBS_TRANSITION_SCALE_STRETCH - Scale and stretch the sources to the size of the transition
---------------------

View File

@ -287,7 +287,7 @@ static void pulseaudio_source_info(pa_context *c, const pa_source_info *i,
{
UNUSED_PARAMETER(c);
PULSE_DATA(userdata);
// An error occured
// An error occurred
if (eol < 0) {
data->format = PA_SAMPLE_INVALID;
goto skip;

View File

@ -79,7 +79,7 @@ void pulseaudio_wait();
/**
* Wait for accept signal from calling thread
*
* This function tells the pulseaudio mainloop wheter the data provided to
* This function tells the pulseaudio mainloop whether the data provided to
* the callback should be retained until the calling thread executes
* pulseaudio_accept()
*

View File

@ -41,7 +41,7 @@
'buffer_position' should initially be 0, and will be internally updated
as the decoding commences. The caller should then repeatedly call
gif_initialise() with the structure until the function returns 1, or
no more data is avaliable.
no more data is available.
Once the initialisation has begun, the decoder completes the variables
'frame_count' and 'frame_count_partial'. The former being the total
@ -54,7 +54,7 @@
the current 'frame_image' to reflect the desired frame. The required
'disposal_method' is also updated to reflect how the frame should be
plotted. The caller must not assume that the current 'frame_image' will
be valid between calls if initialisation is still occuring, and should
be valid between calls if initialisation is still occurring, and should
either always request that the frame is decoded (no processing will
occur if the 'decoded_frame' has not been invalidated by initialisation)
or perform the check itself.

View File

@ -51,7 +51,7 @@ typedef struct gif_frame {
bool opaque; /**< whether the frame is totally opaque */
bool redraw_required; /**< whether a forcable screen redraw is required */
unsigned char disposal_method; /**< how the previous frame should be disposed; affects plotting */
bool transparency; /**< whether we acknoledge transparency */
bool transparency; /**< whether we acknowledge transparency */
unsigned char transparency_index; /**< the index designating a transparent pixel */
unsigned int redraw_x; /**< x co-ordinate of redraw rectangle */
unsigned int redraw_y; /**< y co-ordinate of redraw rectangle */
@ -78,7 +78,7 @@ typedef struct gif_bitmap_callback_vt {
*/
gif_bitmap_cb_set_opaque bitmap_set_opaque; /**< Sets whether a bitmap should be plotted opaque. */
gif_bitmap_cb_test_opaque bitmap_test_opaque; /**< Tests whether a bitmap has an opaque alpha channel. */
gif_bitmap_cb_modified bitmap_modified; /**< The bitmap image has changed, so flush any persistant cache. */
gif_bitmap_cb_modified bitmap_modified; /**< The bitmap image has changed, so flush any persistent cache. */
} gif_bitmap_callback_vt;
/* The GIF animation data
@ -87,7 +87,7 @@ typedef struct gif_animation {
gif_bitmap_callback_vt bitmap_callbacks; /**< callbacks for bitmap functions */
unsigned char *gif_data; /**< pointer to GIF data */
unsigned int width; /**< width of GIF (may increase during decoding) */
unsigned int height; /**< heigth of GIF (may increase during decoding) */
unsigned int height; /**< height of GIF (may increase during decoding) */
unsigned int frame_count; /**< number of frames decoded */
unsigned int frame_count_partial; /**< number of frames partially decoded */
gif_frame *frames; /**< decoded frames */

View File

@ -52,7 +52,7 @@ struct obs_service_info {
*
* @param data Internal service data
* @param output Output context
* @eturn true to allow the output to start up,
* @return true to allow the output to start up,
* false to prevent output from starting up
*/
bool (*initialize)(void *data, obs_output_t *output);

View File

@ -46,7 +46,7 @@ struct obs_modal_ui {
* Callback to execute modal interface.
*
* The @b object variable points to the input/output/encoder/etc. The
* @b ui_data varaible points to the UI parent or UI-specific data to
* @b ui_data variable points to the UI parent or UI-specific data to
* be used with the custom user interface.
*
* What @b ui_data points to differs depending on the target, and you

View File

@ -317,7 +317,7 @@ EXPORT uint32_t obs_get_version(void);
EXPORT const char *obs_get_version_string(void);
/**
* Sets things up for calls to obs_get_cmdline_args. Called onl yonce at startup
* Sets things up for calls to obs_get_cmdline_args. Called only once at startup
* and safely copies argv/argc from main(). Subsequent calls do nothing.
*
* @param argc The count of command line arguments, from main()
@ -1489,7 +1489,7 @@ EXPORT obs_scene_t *obs_sceneitem_get_scene(const obs_sceneitem_t *item);
EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
/* FIXME: The following functions should be deprecated and replaced with a way
* to specify savable private user data. -Jim */
* to specify saveable private user data. -Jim */
EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
EXPORT bool obs_sceneitem_locked(const obs_sceneitem_t *item);

View File

@ -53,13 +53,13 @@ if(WIN32 OR APPLE)
if (BUILD_BROWSER)
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/obs-browser/CMakeLists.txt")
add_subdirectory(obs-browser)
set(BROWSER_AVAILABLE_INTERNAL ON CACHE BOOL "Interal global cmake variable" FORCE)
set(BROWSER_AVAILABLE_INTERNAL ON CACHE BOOL "Internal global cmake variable" FORCE)
else()
message(STATUS "obs-browser submodule not found! Please fetch submodules. obs-browser plugin disabled.")
set(BROWSER_AVAILABLE_INTERNAL OFF CACHE BOOL "Interal global cmake variable" FORCE)
set(BROWSER_AVAILABLE_INTERNAL OFF CACHE BOOL "Internal global cmake variable" FORCE)
endif()
else()
set(BROWSER_AVAILABLE_INTERNAL OFF CACHE BOOL "Interal global cmake variable" FORCE)
set(BROWSER_AVAILABLE_INTERNAL OFF CACHE BOOL "Internal global cmake variable" FORCE)
endif()
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/obs-vst/CMakeLists.txt")