aout: add distinct start/stop callbacks (refs #4787, refs #7601)

[vlc] / include / vlc_playlist.h

diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h
index 8674f553a9dac01eda8675043072627c29646d47..ca422608889bdea7adfa1dbe03a1f580e9b92e0c 100644 (file)
--- a/include/vlc_playlist.h
+++ b/include/vlc_playlist.h
@@ -1,24 +1,24 @@
 /*****************************************************************************
  * vlc_playlist.h : Playlist functions
  *****************************************************************************
- * Copyright (C) 1999-2004 the VideoLAN team
+ * Copyright (C) 1999-2004 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifndef VLC_PLAYLIST_H_
@@ -109,9 +109,8 @@ TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
  * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
  * deleted playlist_item_t.
  *
- * - "leaf-to-parent": Set when an item gets subitems and is transformed to a
- * node. It will contain a pointer to the input_item_t bound to the transformed
- * playlist item.
+ * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
+ *   into a node.
  *
  * The playlist contains rate-variable which is propagated to current input if available
  * also rate-slower/rate-faster is in use
@@ -135,23 +134,26 @@ typedef struct playlist_export_t
 struct playlist_item_t
 {
     input_item_t           *p_input;    /**< Linked input item */
-    /** Number of children, -1 if not a node */
+
     playlist_item_t      **pp_children; /**< Children nodes/items */
     playlist_item_t       *p_parent;    /**< Item parent */
-    int                    i_children;
+    int                    i_children;  /**< Number of children, -1 if not a node */
 
     int                    i_id;        /**< Playlist item specific id */
-    uint8_t                i_flags;     /**< Flags */
+    uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */
+
     playlist_t            *p_playlist;  /**< Parent playlist */
 };
 
-#define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
-#define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
-#define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
-#define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
-#define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
-#define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
-#define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/
+typedef enum {
+    PLAYLIST_SAVE_FLAG         = 0x0001,  /**< Must it be saved */
+    PLAYLIST_SKIP_FLAG         = 0x0002,  /**< Must playlist skip after it ? */
+    PLAYLIST_DBL_FLAG          = 0x0004,  /**< Is it disabled ? */
+    PLAYLIST_RO_FLAG           = 0x0008,  /**< Write-enabled ? */
+    PLAYLIST_REMOVE_FLAG       = 0x0010,  /**< Remove this item at the end */
+    PLAYLIST_EXPANDED_FLAG     = 0x0020,  /**< Expanded node */
+    PLAYLIST_SUBITEM_STOP_FLAG = 0x0040,  /**< Must playlist stop if the item gets subitems ?*/
+} playlist_item_flags_e;
 
 /** Playlist status */
 typedef enum
@@ -322,7 +324,7 @@ VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
 /** Remove a services discovery module by name */
 VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
 /** Check whether a given SD is loaded */
-VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *);
+VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
 /** Query a services discovery */
 VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );