include/vlc/deprecated.h

   1 /*****************************************************************************
   2  * deprecated.h:  libvlc deprecated API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_DEPRECATED_H
  26 #define LIBVLC_DEPRECATED_H 1
  27
  28 # ifdef __cplusplus
  29 extern "C" {
  30 # endif
  31
  32 /**
  33  * \ingroup libvlc libvlc_media_player
  34  * @{
  35  */
  36
  37 /**
  38  * Get movie fps rate
  39  *
  40  * This function is provided for backward compatibility. It cannot deal with
  41  * multiple video tracks. In LibVLC versions prior to 3.0, it would also fail
  42  * if the file format did not convey the frame rate explicitly.
  43  *
  44  * \deprecated Consider using libvlc_media_tracks_get() instead.
  45  *
  46  * \param p_mi the Media Player
  47  * \return frames per second (fps) for this playing movie, or 0 if unspecified
  48  */
  49 LIBVLC_DEPRECATED
  50 LIBVLC_API float libvlc_media_player_get_fps( libvlc_media_player_t *p_mi );
  51
  52 /** end bug */
  53
  54 /**
  55  * \deprecated Use libvlc_track_description_list_release() instead
  56  */
  57 LIBVLC_DEPRECATED LIBVLC_API
  58 void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
  59
  60 /** @}*/
  61
  62 /**
  63  * \ingroup libvlc libvlc_media
  64  * @{
  65  */
  66
  67 /**
  68  * Parse a media.
  69  *
  70  * This fetches (local) art, meta data and tracks information.
  71  * The method is synchronous.
  72  *
  73  * \deprecated This function could block indefinitely.
  74  *             Use libvlc_media_parse_with_options() instead
  75  *
  76  * \see libvlc_media_parse_with_options
  77  * \see libvlc_media_get_meta
  78  * \see libvlc_media_get_tracks_info
  79  *
  80  * \param p_md media descriptor object
  81  */
  82 LIBVLC_DEPRECATED LIBVLC_API void
  83 libvlc_media_parse( libvlc_media_t *p_md );
  84
  85 /**
  86  * Parse a media.
  87  *
  88  * This fetches (local) art, meta data and tracks information.
  89  * The method is the asynchronous of libvlc_media_parse().
  90  *
  91  * To track when this is over you can listen to libvlc_MediaParsedChanged
  92  * event. However if the media was already parsed you will not receive this
  93  * event.
  94  *
  95  * \deprecated You can't be sure to receive the libvlc_MediaParsedChanged
  96  *             event (you can wait indefinitely for this event).
  97  *             Use libvlc_media_parse_with_options() instead
  98  *
  99  * \see libvlc_media_parse
 100  * \see libvlc_MediaParsedChanged
 101  * \see libvlc_media_get_meta
 102  * \see libvlc_media_get_tracks_info
 103  *
 104  * \param p_md media descriptor object
 105  */
 106 LIBVLC_DEPRECATED LIBVLC_API void
 107 libvlc_media_parse_async( libvlc_media_t *p_md );
 108
 109 /**
 110  * Return true is the media descriptor object is parsed
 111  *
 112  * \deprecated This can return true in case of failure.
 113  *             Use libvlc_media_get_parsed_status() instead
 114  *
 115  * \see libvlc_MediaParsedChanged
 116  *
 117  * \param p_md media descriptor object
 118  * \return true if media object has been parsed otherwise it returns false
 119  *
 120  * \libvlc_return_bool
 121  */
 122 LIBVLC_DEPRECATED LIBVLC_API int
 123    libvlc_media_is_parsed( libvlc_media_t *p_md );
 124
 125 /**
 126  * Get media descriptor's elementary streams description
 127  *
 128  * Note, you need to call libvlc_media_parse() or play the media at least once
 129  * before calling this function.
 130  * Not doing this will result in an empty array.
 131  *
 132  * \deprecated Use libvlc_media_tracks_get() instead
 133  *
 134  * \param p_md media descriptor object
 135  * \param tracks address to store an allocated array of Elementary Streams
 136  *        descriptions (must be freed by the caller) [OUT]
 137  *
 138  * \return the number of Elementary Streams
 139  */
 140 LIBVLC_DEPRECATED LIBVLC_API
 141 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
 142                                   libvlc_media_track_info_t **tracks );
 143
 144 /** @}*/
 145
 146 /**
 147  * \ingroup libvlc libvlc_media_list
 148  * @{
 149  */
 150
 151 LIBVLC_DEPRECATED int
 152     libvlc_media_list_add_file_content( libvlc_media_list_t * p_ml,
 153                                         const char * psz_uri );
 154
 155 /** @}*/
 156
 157 /**
 158  * \ingroup libvlc
 159  * \defgroup libvlc_playlist LibVLC playlist (legacy)
 160  * @deprecated Use @ref libvlc_media_list instead.
 161  * @{
 162  * \file
 163  * LibVLC deprecated playlist API
 164  */
 165
 166 /**
 167  * Start playing (if there is any item in the playlist).
 168  *
 169  * Additionnal playlist item options can be specified for addition to the
 170  * item before it is played.
 171  *
 172  * \param p_instance the playlist instance
 173  */
 174 LIBVLC_DEPRECATED LIBVLC_API
 175 void libvlc_playlist_play( libvlc_instance_t *p_instance );
 176
 177 /** @}*/
 178
 179 # ifdef __cplusplus
 180 }
 181 # endif
 182
 183 #endif /* _LIBVLC_DEPRECATED_H */