]> git.sesse.net Git - vlc/blobdiff - include/vlc_playlist.h
* src/video_output/vout_subpictures.c: support for subpictures filters.
[vlc] / include / vlc_playlist.h
index 14387d0968a1c48d5dd2190df524923ed0018277..9c9a6ee615a7965bf4c60da3b27cf17a7f120cd3 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * vlc_playlist.h : Playlist functions
  *****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
- * $Id: vlc_playlist.h,v 1.20 2004/01/06 04:57:34 rocky Exp $
+ * Copyright (C) 1999-2004 VideoLAN
+ * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
  */
 
 /**
- * Playlist info item
- * \see playlist_item_t
+ * playlist export helper structure
  */
-
-struct item_info_t
-{
-    char * psz_name;            /**< Name of this info */
-    char * psz_value;           /**< Value of the info */
-};
-
-/**
- * playlist item info category
- * \see playlist_item_t
- * \see item_info_t
- */
-struct item_info_category_t
+struct playlist_export_t
 {
-    char * psz_name;            /**< Name of this category */
-    int i_infos;                /**< Number of infos in the category */
-    item_info_t **pp_infos;     /**< Pointer to an array of infos */
+    char *psz_filename;
+    FILE *p_file;
 };
 
 /**
@@ -62,14 +48,8 @@ struct item_info_category_t
  */
 struct playlist_item_t
 {
-    char *     psz_name;       /**< text describing this item */
-    char *     psz_uri;        /**< mrl of this item */
-    mtime_t    i_duration;     /**< A hint about the duration of this
-                                * item, in milliseconds*/
-    int i_categories;          /**< Number of info categories */
-    item_info_category_t **pp_categories;
-                               /**< Pointer to the first info category */
-    int        i_status;       /**< unused yet */
+    input_item_t input;        /**< input item descriptor */
+
     int        i_nb_played;    /**< How many times was this item played ? */
     vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
                                 * be deleted after playback. True mean
@@ -77,7 +57,7 @@ struct playlist_item_t
                                 * after playback, false otherwise */
     vlc_bool_t b_enabled;      /**< Indicates whether this item is to be
                                 * played or skipped */
-    int        i_group;         /**< Which group does this item belongs to ? */
+    int        i_group;        /**< Which group does this item belongs to ? */
     int        i_id;           /**< Unique id to track this item */
 };
 
@@ -120,16 +100,20 @@ struct playlist_t
     input_thread_t *      p_input;  /**< the input thread ascosiated
                                      * with the current item */
     int                   i_last_id; /**< Last id to an item */
+    int                   i_sort; /**< Last sorting applied to the playlist */
+    int                   i_order; /**< Last ordering applied to the playlist */
     /*@}*/
 };
 
-#define SORT_TITLE 0
-#define SORT_AUTHOR 1
-#define SORT_GROUP 2
-#define SORT_RANDOM 3
+#define SORT_ID 0
+#define SORT_TITLE 1
+#define SORT_AUTHOR 2
+#define SORT_GROUP 3
+#define SORT_RANDOM 4
+#define SORT_DURATION 5
 
-#define SORT_NORMAL 0
-#define SORT_REVERSE 1
+#define ORDER_NORMAL 0
+#define ORDER_REVERSE 1
 
 #define PLAYLIST_TYPE_MANUAL 1
 #define PLAYLIST_TYPE_SAP 2
@@ -152,25 +136,38 @@ void           playlist_Destroy  ( playlist_t * );
 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
 
 
-/* Item functions */
+/* Item management functions */
+#define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
+#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
+VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
+VLC_EXPORT( void, playlist_ItemDelete, ( playlist_item_t * ) );
+VLC_EXPORT( int,  playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
+
+/* Simple add/remove funcctions */
 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
-VLC_EXPORT( int,  playlist_AddWDuration, ( playlist_t *, const char *, const char *, int, int, mtime_t ) );
-/* For internal use. Do not use this one anymore */
-VLC_EXPORT( int,  playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
+VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
+
+
+VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, int ) );
 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, int ) );
 VLC_EXPORT( int,  playlist_DisableGroup, ( playlist_t *, int ) );
 VLC_EXPORT( int,  playlist_EnableGroup, ( playlist_t *, int ) );
 
-/* Basic item informations accessors */
-VLC_EXPORT( int, playlist_SetGroup, (playlist_t *, int, int ) );
-VLC_EXPORT( int, playlist_SetName, (playlist_t *, int, char * ) );
-VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int, int ) );
+/* Basic item information accessors */
+VLC_EXPORT( int, playlist_ItemSetGroup, (playlist_item_t *, int ) );
+VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
+VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
+
+VLC_EXPORT( int, playlist_SetGroup, (playlist_t * , int , int ) );
+VLC_EXPORT( int, playlist_SetName, (playlist_t *, int ,  char * ) );
+VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int , mtime_t ) );
 
 /* Item search functions */
 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
-VLC_EXPORT( playlist_item_t *, playlist_GetItemById, (playlist_t *, int) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
 
 
 /* Group management functions */
@@ -181,22 +178,20 @@ VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
 
 /* Info functions */
 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
-VLC_EXPORT( char * , playlist_GetItemInfo, ( playlist_item_t * , const char *, const char *) );
+VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
 
-VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) );
-VLC_EXPORT( item_info_category_t*, playlist_GetItemCategory, ( playlist_item_t *, const char *) );
+VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
 
-VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) );
-VLC_EXPORT( item_info_category_t*, playlist_CreateItemCategory, ( playlist_item_t *, const char *) );
+VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
 
 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
-VLC_EXPORT( int, playlist_AddItemInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
+VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
 
 /* Option functions */
-VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *, ...) );
-VLC_EXPORT( int, playlist_AddItemOption, (playlist_item_t *, const char *, ...) );
+VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
 
 /* Playlist sorting */
+#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
@@ -204,8 +199,8 @@ VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 
 /* Load/Save */
-VLC_EXPORT( int,  playlist_LoadFile, ( playlist_t *, const char * ) );
-VLC_EXPORT( int,  playlist_SaveFile, ( playlist_t *, const char * ) );
+VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
+VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
 
 /**
  *  tell if a playlist is currently playing.
@@ -217,7 +212,7 @@ static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
     vlc_bool_t b_playing;
 
     vlc_mutex_lock( &p_playlist->object_lock );
-    b_playing = p_playlist->i_status == PLAYLIST_RUNNING; 
+    b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
     vlc_mutex_unlock( &p_playlist->object_lock );
 
     return( b_playing );