[vlc-devel] [vlc-commits] Specify parameter names in include files

Jean-Baptiste Kempf jb at videolan.org
Wed Mar 1 17:33:31 CET 2017


Are you changing the libVLC API?!?

On Wed, 1 Mar 2017, at 17:02, Olivier Aubert wrote:
> vlc | branch: master | Olivier Aubert <contact at olivieraubert.net> | Wed
> Mar  1 17:02:03 2017 +0100| [cb1e307b4bac50aa650063fc39452ecae02ed867] |
> committer: Olivier Aubert
> 
> Specify parameter names in include files
> 
> It is necessary for proper automatic generation of python bindings, and
> matches the rest of the include files anyway.
> 
> > http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=cb1e307b4bac50aa650063fc39452ecae02ed867
> ---
> 
>  include/vlc/deprecated.h | 12 ++++++------
>  include/vlc/libvlc.h     |  8 ++++----
>  include/vlc/libvlc_vlm.h | 12 ++++++------
>  3 files changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/include/vlc/deprecated.h b/include/vlc/deprecated.h
> index 1a309e5..bf37287 100644
> --- a/include/vlc/deprecated.h
> +++ b/include/vlc/deprecated.h
> @@ -141,7 +141,7 @@ libvlc_video_set_subtitle_file( libvlc_media_player_t
> *p_mi, const char *psz_sub
>   * \return always 0.
>   */
>  LIBVLC_DEPRECATED LIBVLC_API
> -int libvlc_audio_output_device_count( libvlc_instance_t *, const char *
> );
> +int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
> const char *psz_audio_output );
>  
>  /**
>   * Backward compatibility stub. Do not use in new code.
> @@ -149,8 +149,8 @@ int libvlc_audio_output_device_count(
> libvlc_instance_t *, const char * );
>   * \return always NULL.
>   */
>  LIBVLC_DEPRECATED LIBVLC_API
> -char *libvlc_audio_output_device_longname( libvlc_instance_t *, const
> char *,
> -                                           int );
> +char *libvlc_audio_output_device_longname( libvlc_instance_t
> *p_instance, const char *psz_output,
> +                                           int i_device );
>  
>  /**
>   * Backward compatibility stub. Do not use in new code.
> @@ -158,7 +158,7 @@ char *libvlc_audio_output_device_longname(
> libvlc_instance_t *, const char *,
>   * \return always NULL.
>   */
>  LIBVLC_DEPRECATED LIBVLC_API
> -char *libvlc_audio_output_device_id( libvlc_instance_t *, const char *,
> int );
> +char *libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
> const char *psz_audio_output, int i_device );
>  
>  /**
>   * Stub for backward compatibility.
> @@ -171,8 +171,8 @@ LIBVLC_API int libvlc_audio_output_get_device_type(
> libvlc_media_player_t *p_mi
>   * Stub for backward compatibility.
>   */
>  LIBVLC_DEPRECATED
> -LIBVLC_API void libvlc_audio_output_set_device_type(
> libvlc_media_player_t *,
> -                                                     int );
> +LIBVLC_API void libvlc_audio_output_set_device_type(
> libvlc_media_player_t *p_mp,
> +                                                     int device_type );
>  
>  /** @}*/
>  
> diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
> index 293d2a1..3706a31 100644
> --- a/include/vlc/libvlc.h
> +++ b/include/vlc/libvlc.h
> @@ -308,7 +308,7 @@ typedef int libvlc_event_type_t;
>   * Callback function notification
>   * \param p_event the event triggering the callback
>   */
> -typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void
> * );
> +typedef void ( *libvlc_callback_t )( const struct libvlc_event_t
> *p_event, void *p_data );
>  
>  /**
>   * Register for an event notification.
> @@ -447,7 +447,7 @@ typedef void (*libvlc_log_cb)(void *data, int level,
> const libvlc_log_t *ctx,
>   * \param p_instance libvlc instance
>   * \version LibVLC 2.1.0 or later
>   */
> -LIBVLC_API void libvlc_log_unset( libvlc_instance_t * );
> +LIBVLC_API void libvlc_log_unset( libvlc_instance_t *p_instance );
>  
>  /**
>   * Sets the logging callback for a LibVLC instance.
> @@ -466,7 +466,7 @@ LIBVLC_API void libvlc_log_unset( libvlc_instance_t *
> );
>   * \param p_instance libvlc instance
>   * \version LibVLC 2.1.0 or later
>   */
> -LIBVLC_API void libvlc_log_set( libvlc_instance_t *,
> +LIBVLC_API void libvlc_log_set( libvlc_instance_t *p_instance,
>                                  libvlc_log_cb cb, void *data );
>  
>  
> @@ -477,7 +477,7 @@ LIBVLC_API void libvlc_log_set( libvlc_instance_t *,
>   *         (the FILE pointer must remain valid until libvlc_log_unset())
>   * \version LibVLC 2.1.0 or later
>   */
> -LIBVLC_API void libvlc_log_set_file( libvlc_instance_t *, FILE *stream
> );
> +LIBVLC_API void libvlc_log_set_file( libvlc_instance_t *p_instance, FILE
> *stream );
>  
>  /** @} */
>  
> diff --git a/include/vlc/libvlc_vlm.h b/include/vlc/libvlc_vlm.h
> index a4f335d..cfa2d95 100644
> --- a/include/vlc/libvlc_vlm.h
> +++ b/include/vlc/libvlc_vlm.h
> @@ -298,8 +298,8 @@ LIBVLC_API int libvlc_vlm_get_media_instance_rate(
> libvlc_instance_t *p_instance
>   * \param i_instance instance id
>   * \return title as number or -1 on error
>   */
> -LIBVLC_API int libvlc_vlm_get_media_instance_title( libvlc_instance_t *,
> -                                                        const char *,
> int );
> +LIBVLC_API int libvlc_vlm_get_media_instance_title( libvlc_instance_t
> *p_instance,
> +                                                        const char
> *psz_name, int i_instance );
>  
>  /**
>   * Get vlm_media instance chapter number by name or instance id
> @@ -309,8 +309,8 @@ LIBVLC_API int libvlc_vlm_get_media_instance_title(
> libvlc_instance_t *,
>   * \param i_instance instance id
>   * \return chapter as number or -1 on error
>   */
> -LIBVLC_API int libvlc_vlm_get_media_instance_chapter( libvlc_instance_t
> *,
> -                                                          const char *,
> int );
> +LIBVLC_API int libvlc_vlm_get_media_instance_chapter( libvlc_instance_t
> *p_instance,
> +                                                          const char
> *psz_name, int i_instance );
>  
>  /**
>   * Is libvlc instance seekable ?
> @@ -320,8 +320,8 @@ LIBVLC_API int libvlc_vlm_get_media_instance_chapter(
> libvlc_instance_t *,
>   * \param i_instance instance id
>   * \return 1 if seekable, 0 if not, -1 if media does not exist
>   */
> -LIBVLC_API int libvlc_vlm_get_media_instance_seekable( libvlc_instance_t
> *,
> -                                                           const char *,
> int );
> +LIBVLC_API int libvlc_vlm_get_media_instance_seekable( libvlc_instance_t
> *p_instance,
> +                                                           const char
> *psz_name, int i_instance );
>  #endif
>  /**
>   * Get libvlc_event_manager from a vlm media.
> 
> _______________________________________________
> vlc-commits mailing list
> vlc-commits at videolan.org
> https://mailman.videolan.org/listinfo/vlc-commits


-- 
Jean-Baptiste Kempf -  President
+33 672 704 734


More information about the vlc-devel mailing list