videolan
/
vlc
mirror of https://code.videolan.org/videolan/vlc
1
Fork 0
Code Releases Activity

include: fix typos 

Typos found and reworked from codespell.
This commit is contained in:
Alexandre Janniaux 2021-12-15 15:34:26 +01:00 committed by Rémi Denis-Courmont
parent 8f208ac330
commit b9a270574a
23 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/vlc/deprecated.h
View File

@ -282,7 +282,7 @@ LIBVLC_DEPRECATED LIBVLC_API int libvlc_audio_set_track( libvlc_media_player_t *
/**
* Start playing (if there is any item in the playlist).
*
* Additionnal playlist item options can be specified for addition to the
* Additional playlist item options can be specified for addition to the
* item before it is played.
*
* \param p_instance the playlist instance

4
include/vlc/libvlc.h
View File

@ -538,9 +538,9 @@ libvlc_module_description_t *libvlc_video_filter_list_get( libvlc_instance_t *p_
/**
* Return the current time as defined by LibVLC. The unit is the microsecond.
* Time increases monotonically (regardless of time zone changes and RTC
* adjustements).
* adjustments).
* The origin is arbitrary but consistent across the whole system
* (e.g. the system uptim, the time since the system was booted).
* (e.g. the system uptime, the time since the system was booted).
* \note On systems that support it, the POSIX monotonic clock is used.
*/
LIBVLC_API

18
include/vlc/libvlc_media.h
View File

@ -160,11 +160,11 @@ typedef enum libvlc_media_parse_flag_t
*/
libvlc_media_parse_network = 0x01,
/**
* Fetch meta and covert art using local resources
* Fetch meta and cover art using local resources
*/
libvlc_media_fetch_local = 0x02,
/**
* Fetch meta and covert art using network resources
* Fetch meta and cover art using network resources
*/
libvlc_media_fetch_network = 0x04,
/**
@ -496,7 +496,7 @@ LIBVLC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
/**
* Save the meta previously set
*
* \param p_md the media desriptor
* \param p_md the media descriptor
* \return true if the write operation was successful
*/
LIBVLC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
@ -526,7 +526,7 @@ LIBVLC_API libvlc_state_t libvlc_media_get_state(
LIBVLC_API bool libvlc_media_get_stats(libvlc_media_t *p_md,
libvlc_media_stats_t *p_stats);
/* The following method uses libvlc_media_list_t, however, media_list usage is optionnal
/* The following method uses libvlc_media_list_t, however, media_list usage is optional
* and this is here for convenience */
#define VLC_FORWARD_DECLARE_OBJECT(a) struct a
@ -737,8 +737,8 @@ typedef enum libvlc_thumbnailer_seek_speed_t
/**
* \brief libvlc_media_request_thumbnail_by_time Start an asynchronous thumbnail generation
*
* If the request is successfuly queued, the libvlc_MediaThumbnailGenerated
* is guaranteed to be emited.
* If the request is successfully queued, the libvlc_MediaThumbnailGenerated
* is guaranteed to be emitted.
* The resulting thumbnail size can either be:
* - Hardcoded by providing both width & height. In which case, the image will
* be stretched to match the provided aspect ratio, or cropped if crop is true.
@ -774,8 +774,8 @@ libvlc_media_thumbnail_request_by_time( libvlc_media_t *md,
/**
* \brief libvlc_media_request_thumbnail_by_pos Start an asynchronous thumbnail generation
*
* If the request is successfuly queued, the libvlc_MediaThumbnailGenerated
* is guaranteed to be emited.
* If the request is successfully queued, the libvlc_MediaThumbnailGenerated
* is guaranteed to be emitted.
* The resulting thumbnail size can either be:
* - Hardcoded by providing both width & height. In which case, the image will
* be stretched to match the provided aspect ratio, or cropped if crop is true.
@ -813,7 +813,7 @@ libvlc_media_thumbnail_request_by_pos( libvlc_media_t *md,
* @param p_req An opaque thumbnail request object.
*
* Cancelling the request will still cause libvlc_MediaThumbnailGenerated event
* to be emited, with a NULL libvlc_picture_t
* to be emitted, with a NULL libvlc_picture_t
* If the request is cancelled after its completion, the behavior is undefined.
*/
LIBVLC_API void

10
include/vlc/libvlc_media_player.h
View File

@ -1313,7 +1313,7 @@ LIBVLC_API void libvlc_media_player_set_video_title_display( libvlc_media_player
* this function again to get the updated track.
*
*
* The track list can be used to get track informations and to select specific
* The track list can be used to get track information and to select specific
* tracks.
*
* \param p_mi the media player
@ -1351,7 +1351,7 @@ libvlc_media_player_get_selected_track( libvlc_media_player_t *p_mi,
*
* \version LibVLC 4.0.0 and later.
*
* This function can be used to get the last updated informations of a track.
* This function can be used to get the last updated information of a track.
*
* \param p_mi the media player
* \param psz_id valid string representing a track id (cf. psz_id from \ref
@ -1598,7 +1598,7 @@ libvlc_media_player_get_program_from_id( libvlc_media_player_t *p_mi, int i_grou
* function is called. If a program is updated after this call, the user will
* need to call this function again to get the updated program.
*
* The program list can be used to get program informations and to select
* The program list can be used to get program information and to select
* specific programs.
*
* \param p_mi the media player
@ -2280,7 +2280,7 @@ LIBVLC_API void libvlc_audio_output_device_list_release(
/**
* Configures an explicit audio output device.
*
* If the module paramater is NULL, audio output will be moved to the device
* If the module parameter is NULL, audio output will be moved to the device
* specified by the device identifier string immediately. This is the
* recommended usage.
*
@ -2612,7 +2612,7 @@ typedef enum libvlc_media_player_role {
libvlc_role_Game, /**< Video game */
libvlc_role_Notification, /**< User interaction feedback */
libvlc_role_Animation, /**< Embedded animation (e.g. in web page) */
libvlc_role_Production, /**< Audio editting/production */
libvlc_role_Production, /**< Audio editing/production */
libvlc_role_Accessibility, /**< Accessibility */
libvlc_role_Test /** Testing */
#define libvlc_role_Last libvlc_role_Test

2
include/vlc/libvlc_picture.h
View File

@ -138,7 +138,7 @@ LIBVLC_API libvlc_picture_t* libvlc_picture_list_at( const libvlc_picture_list_t
* Destroys a picture list and releases the pictures it contains
* \param list The list to destroy
*
* Calling this function with a NULL list is safe and will return immediatly
* Calling this function with a NULL list is safe and will return immediately
*/
LIBVLC_API void libvlc_picture_list_destroy( libvlc_picture_list_t* list );

4
include/vlc_aout.h
View File

@ -268,7 +268,7 @@ struct audio_output
*/
int (*mute_set)(audio_output_t *, bool mute);
/**< Changes muting (optinal, may be NULL).
/**< Changes muting (optional, may be NULL).
*
* \param mute true to mute, false to unmute
* \warning The same constraints apply as with volume_set().
@ -287,7 +287,7 @@ struct audio_output
bool headphones; /**< Default to false, set it to true if the current
sink is using headphones */
} current_sink_info;
/**< Current sink informations set by the module from the start() function */
/**< Current sink information set by the module from the start() function */
const struct vlc_audio_output_events *events;
};

2
include/vlc_codec.h
View File

@ -190,7 +190,7 @@ struct decoder_t
vlc_frame_t * ( * pf_get_cc ) ( decoder_t *, decoder_cc_desc_t * );
/* Meta data at codec level
* The decoder owner set it back to NULL once it has retreived what it needs.
* The decoder owner set it back to NULL once it has retrieved what it needs.
* The decoder owner is responsible of its release except when you overwrite it.
*/
vlc_meta_t *p_description;

4
include/vlc_epg.h
View File

@ -32,12 +32,12 @@ typedef struct
{
int64_t i_start; /* Interpreted as a value return by time() */
uint32_t i_duration; /* Duration of the event in second */
uint16_t i_id; /* Unique event id withing the event set */
uint16_t i_id; /* Unique event id within the event set */
char *psz_name;
char *psz_short_description;
char *psz_description;
struct /* Description items in tranmission order */
struct /* Description items in transmission order */
{
char *psz_key;
char *psz_value;

2
include/vlc_es.h
View File

@ -500,7 +500,7 @@ VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t *
/**
* This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
* producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
* producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (palette is not alloc'ed).
*/
VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
const video_format_t *in);

2
include/vlc_es_out.h
View File

@ -55,7 +55,7 @@ enum es_out_query_e
/* */
ES_OUT_SET_GROUP, /* arg1= int */
/* PCR handling, DTS/PTS will be automatically computed using thoses PCR
/* PCR handling, DTS/PTS will be automatically computed using those PCR
* XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
* to slow down the demuxer so that it reads at the right speed.
* XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send

12
include/vlc_frame.h
View File

@ -52,16 +52,16 @@ typedef uint32_t vlc_ancillary_id;
* it depends where you receive the buffer (before/after a packetizer
* and the demux/packetizer implementations.
* - i_dts/i_pts could be VLC_TICK_INVALID, it means no pts/dts
* - i_length: length in microseond of the packet, can be null except in the
* - i_length: length in microsecond of the packet, can be null except in the
* sout where it is mandatory.
*
* - i_buffer number of valid data pointed by p_buffer
* you can freely decrease it but never increase it yourself
* (use vlc_frame_Realloc)
* - p_buffer: pointer over datas. You should never overwrite it, you can
* only incremment it to skip datas, in others cases use vlc_frame_Realloc
* - p_buffer: pointer over data. You should never overwrite it, you can
* only increment it to skip data, in others cases use vlc_frame_Realloc
* (don't duplicate yourself in a bigger buffer, vlc_frame_Realloc is
* optimised for preheader/postdatas increase)
* optimised for preheader/postdata increase)
****************************************************************************/
typedef struct vlc_frame_t vlc_frame_t;
@ -186,7 +186,7 @@ VLC_API vlc_frame_t *vlc_frame_TryRealloc(vlc_frame_t *, ssize_t pre, size_t bod
* count of leading bytes to discard if negative
* @param body new bytes size of the frame
*
* @return the reallocated frame on succes, NULL on error.
* @return the reallocated frame on success, NULL on error.
*
* @note Skipping leading bytes can be achieved directly by subtracting from
* vlc_frame_t.i_buffer and adding vlc_frame_t.p_buffer.
@ -477,7 +477,7 @@ static size_t vlc_frame_ChainExtract( vlc_frame_t *p_list, void *p_data, size_t
}
/**
* Retrives chain properties
* Retrieves chain properties
*
* Can be used to retrieve count of frames, number of bytes and the duration
* of the chain.

4
include/vlc_media_library.h
View File

@ -669,7 +669,7 @@ enum vlc_ml_event_type
* The entry point that was added is stored in
* vlc::ml_event_t::entry_point_added::psz_entry_point, and the success or failure
* state is stored in vlc_ml_event_t::entry_point_added::b_success
* If successful, this event won't be emited again for this entry point.
* If successful, this event won't be emitted again for this entry point.
* In case of failure, this event will be fired again if the same entry point
* is queued for discovery again.
*/
@ -829,7 +829,7 @@ struct vlc_medialibrary_module_t
* \return VLC_SUCCESS or an error code
*
* Refer to the individual list of vlc_ml_list requests for the additional
* per-query input/ouput parameters values & types
* per-query input/output parameters values & types
*/
int (*pf_list)( struct vlc_medialibrary_module_t* p_ml, int i_query,
const vlc_ml_query_params_t* p_params, va_list args );

2
include/vlc_objects.h
View File

@ -25,7 +25,7 @@
* \ingroup vlc
* @{
* \file
* Common VLC object defintions
* Common VLC object definitions
*/
struct vlc_logger;

2
include/vlc_picture_fifo.h
View File

@ -50,7 +50,7 @@ VLC_API picture_fifo_t * picture_fifo_New( void ) VLC_USED;
VLC_API void picture_fifo_Delete( picture_fifo_t * );
/**
* It retreives a picture_t from the fifo.
* It retrieves a picture_t from the fifo.
*
* If the fifo is empty, it return NULL without waiting.
*/

2
include/vlc_renderer_discovery.h
View File

@ -197,7 +197,7 @@ static inline void vlc_rd_remove_item(vlc_renderer_discovery_t * p_rd,
}
/**
* Renderer Discovery proble helpers
* Renderer Discovery probe helpers
*/
VLC_API int
vlc_rd_probe_add(vlc_probe_t *p_probe, const char *psz_name,

2
include/vlc_services_discovery.h
View File

@ -126,7 +126,7 @@ typedef struct
* @param p_sd: the Service Discovery
* @param i_control: the command to issue
* @param args: the argument list
* @return VLC_SUCCESS in case of success, the error code overwise
* @return VLC_SUCCESS in case of success, the error code otherwise
*/
static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_list args )
{

2
include/vlc_spu.h
View File

@ -64,7 +64,7 @@ VLC_API void spu_PutSubpicture( spu_t *, subpicture_t * );
/**
* This function will return an unique subpicture containing the OSD and
* subtitles visibles at the requested date.
* subtitles visible at the requested date.
*
* \param p_chroma_list is a list of supported chroma for the output (can be NULL)
* \param p_fmt_dst is the format of the picture on which the return subpicture will be rendered.

4
include/vlc_strings.h
View File

@ -105,7 +105,7 @@ static inline int vlc_ascii_strncasecmp( const char *psz1, const char *psz2, siz
VLC_API void vlc_xml_decode(char *st);
/**
* Encodes XML entites.
* Encodes XML entities.
*
* Substitutes unsafe characters in a null-terminated UTF-8 strings with an
* XML entity or numerical character reference.
@ -181,7 +181,7 @@ VLC_API char *vlc_strftime( const char * );
* ----- | -------------------------------
* `a` | Artist metadata
* `b` | Album title metadata
* `c` | Copyright infromation metadata
* `c` | Copyright information metadata
* `d` | Description metadata
* `e` | 'Encoded by' metadata
* `f` | Displayed output frame (`-` if not available)

4
include/vlc_text_style.h
View File

@ -185,7 +185,7 @@ VLC_API void text_style_Delete( text_style_t * );
* This function will create a new text segment.
*
* You should use text_segment_ChainDelete to destroy it, to clean all
* the linked segments, or text_segment_Delete to free a specic one
* the linked segments, or text_segment_Delete to free a specific one
*
* This duplicates the string passed as argument
*/
@ -195,7 +195,7 @@ VLC_API text_segment_t *text_segment_New( const char * );
* This function will create a new text segment and duplicates the style passed as argument
*
* You should use text_segment_ChainDelete to destroy it, to clean all
* the linked segments, or text_segment_Delete to free a specic one
* the linked segments, or text_segment_Delete to free a specific one
*
* This doesn't initialize the text.
*/

2
include/vlc_tls.h
View File

@ -300,7 +300,7 @@ VLC_API void vlc_tls_SessionDelete (vlc_tls_t *);
/**
* Generates an event polling description.
*
* This function provides the necessary informations to make an event polling
* This function provides the necessary information to make an event polling
* description for use with poll() or similar event multiplexing functions.
*
* This function is necessary both for receiving and sending data, therefore

4
include/vlc_vector.h
View File

@ -78,7 +78,7 @@
*/
#define vlc_vector_init(pv) (void) \
( \
/* cannot be implemened as do-while(0), called from vlc_vector_clear() */ \
/* cannot be implemented as do-while(0), called from vlc_vector_clear() */ \
(pv)->cap = 0, \
(pv)->size = 0, \
(pv)->data = NULL \
@ -99,7 +99,7 @@
*/
#define vlc_vector_clear(pv) \
( \
/* cannot be implemened as do-while(0), called from vlc_vector_resize_() */ \
/* cannot be implemented as do-while(0), called from vlc_vector_resize_() */ \
vlc_vector_destroy(pv), \
vlc_vector_init(pv) \
)

2
include/vlc_vout_display.h
View File

@ -459,7 +459,7 @@ static inline bool vout_display_cfg_IsWindowed(const vout_display_cfg_t *cfg)
* Computes the default display size given the source and
* the display configuration.
*
* This asssumes that the picture is already cropped.
* This assumes that the picture is already cropped.
*/
VLC_API void vout_display_GetDefaultDisplaySize(unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *);

2
include/vlc_vout_window.h
View File

@ -131,7 +131,7 @@ typedef struct vout_window_mouse_event_t
/**
* Pressed button.
*
* See \ref vlc_mouse_button for possible vaules.
* See \ref vlc_mouse_button for possible values.
*
* This is set if @c event does not equal \ref VOUT_WINDOW_MOUSE_MOVED.
*/