home *** CD-ROM | disk | FTP | other *** search
/ mail.altrad.com / 2015.02.mail.altrad.com.tar / mail.altrad.com / TEST / vlc-2-0-5-win32.exe / sdk / include / vlc / plugins / vlc_playlist.h < prev    next >
C/C++ Source or Header  |  2012-12-12  |  16KB  |  397 lines
  1. /*****************************************************************************
  2.  * vlc_playlist.h : Playlist functions
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2004 VLC authors and VideoLAN
  5.  * $Id: ca422608889bdea7adfa1dbe03a1f580e9b92e0c $
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify it
  10.  * under the terms of the GNU Lesser General Public License as published by
  11.  * the Free Software Foundation; either version 2.1 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17.  * GNU Lesser General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU Lesser General Public License
  20.  * along with this program; if not, write to the Free Software Foundation,
  21.  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_PLAYLIST_H_
  25. #define VLC_PLAYLIST_H_
  26.  
  27. # ifdef __cplusplus
  28. extern "C" {
  29. # endif
  30.  
  31. #include <vlc_input.h>
  32. #include <vlc_events.h>
  33.  
  34. TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
  35.  
  36. /**
  37.  * \file
  38.  * This file contain structures and function prototypes related
  39.  * to the playlist in vlc
  40.  *
  41.  * \defgroup vlc_playlist Playlist
  42.  *
  43.  * The VLC playlist system has a tree structure. This allows advanced
  44.  * categorization, like for SAP streams (which are grouped by "sap groups").
  45.  *
  46.  * The base structure for all playlist operations is the input_item_t. This
  47.  * contains all information needed to play a stream and get info, ie, mostly,
  48.  * mrl and metadata. This structure contains a unique i_id field. ids are
  49.  * not recycled when an item is destroyed.
  50.  *
  51.  * Input items are not used directly, but through playlist items.
  52.  * The playlist items are themselves in a tree structure. They only contain
  53.  * a link to the input item, a unique id and a few flags. the playlist
  54.  * item id is NOT the same as the input item id.
  55.  * Several playlist items can be attached to a single input item. The input
  56.  * item is refcounted and is automatically destroyed when it is not used
  57.  * anymore.
  58.  *
  59.  * The top-level items are the main media sources and include:
  60.  * playlist, media library, SAP, Shoutcast, devices, ...
  61.  *
  62.  * It is envisioned that a third tree will appear: VLM, but it's not done yet
  63.  *
  64.  * The playlist also stores, for utility purposes, an array of all input
  65.  * items, an array of all playlist items and an array of all playlist items
  66.  * and nodes (both are represented by the same structure).
  67.  *
  68.  * So, here is an example:
  69.  * \verbatim
  70.  * Inputs array
  71.  *  - input 1 -> name = foo 1 uri = ...
  72.  *  - input 2 -> name = foo 2 uri = ...
  73.  *
  74.  * Playlist items tree
  75.  * - playlist (id 1)
  76.  *    - category 1 (id 2)
  77.  *      - foo 2 (id 6 - input 2)
  78.  * - media library (id 2)
  79.  *    - foo 1 (id 5 - input 1)
  80.  * \endverbatim
  81.  *
  82.  * Sometimes, an item creates subitems. This happens for the directory access
  83.  * for example. In that case, if the item is under the "playlist" top-level item
  84.  * and playlist is configured to be flat then the item will be deleted and
  85.  * replaced with new subitems. If the item is under another top-level item, it
  86.  * will be transformed to a node and removed from the list of all items without
  87.  * nodes.
  88.  *
  89.  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
  90.  * (more options) or playlist_AddInput if you already created your input
  91.  * item. This will add the item at the root of "Playlist" or of "Media library"
  92.  * in each of the two trees.
  93.  *
  94.  * You can create nodes with playlist_NodeCreate and can create items from
  95.  * existing input items to be placed under any node with playlist_NodeAddInput.
  96.  *
  97.  * To delete an item, use playlist_DeleteFromInput( p_item ) which will
  98.  * remove all occurrences of the input.
  99.  *
  100.  *
  101.  * The playlist defines the following event variables:
  102.  *
  103.  * - "item-change": It will contain the input_item_t->i_id of a changed input
  104.  * item monitored by the playlist.
  105.  * - "item-current": It will contain a input_item_t->i_id of the current
  106.  * item being played.
  107.  *
  108.  * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
  109.  * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
  110.  * deleted playlist_item_t.
  111.  *
  112.  * - "leaf-to-parent": It will contain the playlist_item_t->i_id of an item that is transformed
  113.  *   into a node.
  114.  *
  115.  * The playlist contains rate-variable which is propagated to current input if available
  116.  * also rate-slower/rate-faster is in use
  117.  *
  118.  * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
  119.  * the same. Yes, the situation is pretty bad.
  120.  *
  121.  * @{
  122.  */
  123.  
  124. /** Helper structure to export to file part of the playlist */
  125. typedef struct playlist_export_t
  126. {
  127.     VLC_COMMON_MEMBERS
  128.     const char *psz_filename;
  129.     FILE *p_file;
  130.     playlist_item_t *p_root;
  131. } playlist_export_t;
  132.  
  133. /** playlist item / node */
  134. struct playlist_item_t
  135. {
  136.     input_item_t           *p_input;    /**< Linked input item */
  137.  
  138.     playlist_item_t      **pp_children; /**< Children nodes/items */
  139.     playlist_item_t       *p_parent;    /**< Item parent */
  140.     int                    i_children;  /**< Number of children, -1 if not a node */
  141.  
  142.     int                    i_id;        /**< Playlist item specific id */
  143.     uint8_t                i_flags;     /**< Flags \see playlist_item_flags_e */
  144.  
  145.     playlist_t            *p_playlist;  /**< Parent playlist */
  146. };
  147.  
  148. typedef enum {
  149.     PLAYLIST_SAVE_FLAG         = 0x0001,  /**< Must it be saved */
  150.     PLAYLIST_SKIP_FLAG         = 0x0002,  /**< Must playlist skip after it ? */
  151.     PLAYLIST_DBL_FLAG          = 0x0004,  /**< Is it disabled ? */
  152.     PLAYLIST_RO_FLAG           = 0x0008,  /**< Write-enabled ? */
  153.     PLAYLIST_REMOVE_FLAG       = 0x0010,  /**< Remove this item at the end */
  154.     PLAYLIST_EXPANDED_FLAG     = 0x0020,  /**< Expanded node */
  155.     PLAYLIST_SUBITEM_STOP_FLAG = 0x0040,  /**< Must playlist stop if the item gets subitems ?*/
  156. } playlist_item_flags_e;
  157.  
  158. /** Playlist status */
  159. typedef enum
  160. { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
  161.  
  162. /** Structure containing information about the playlist */
  163. struct playlist_t
  164. {
  165.     VLC_COMMON_MEMBERS
  166.  
  167.     playlist_item_array_t items; /**< Arrays of items */
  168.     playlist_item_array_t all_items; /**< Array of items and nodes */
  169.  
  170.     playlist_item_array_t current; /**< Items currently being played */
  171.     int                   i_current_index; /**< Index in current array */
  172.  
  173.     /* Predefined items */
  174.     playlist_item_t *     p_root;
  175.     playlist_item_t *     p_playing;
  176.     playlist_item_t *     p_media_library;
  177.  
  178.     //Phony ones, point to those above;
  179.     playlist_item_t *     p_root_category; /**< Root of category tree */
  180.     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
  181.     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
  182.     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
  183.     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
  184.     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
  185. };
  186.  
  187. /** Helper to add an item */
  188. struct playlist_add_t
  189. {
  190.     int i_node; /**< Playist id of the parent node */
  191.     int i_item; /**< Playist id of the playlist_item_t */
  192. };
  193.  
  194. /* A bit of macro magic to generate an enum out of the following list,
  195.  * and later, to generate a list of static functions out of the same list.
  196.  * There is also SORT_RANDOM, which is always last and handled specially.
  197.  */
  198. #define VLC_DEFINE_SORT_FUNCTIONS \
  199.     DEF( SORT_ID )\
  200.     DEF( SORT_TITLE )\
  201.     DEF( SORT_TITLE_NODES_FIRST )\
  202.     DEF( SORT_ARTIST )\
  203.     DEF( SORT_GENRE )\
  204.     DEF( SORT_DURATION )\
  205.     DEF( SORT_TITLE_NUMERIC )\
  206.     DEF( SORT_ALBUM )\
  207.     DEF( SORT_TRACK_NUMBER )\
  208.     DEF( SORT_DESCRIPTION )\
  209.     DEF( SORT_RATING )\
  210.     DEF( SORT_URI )
  211.  
  212. #define DEF( s ) s,
  213. enum
  214. {
  215.     VLC_DEFINE_SORT_FUNCTIONS
  216.     SORT_RANDOM,
  217.     NUM_SORT_FNS=SORT_RANDOM
  218. };
  219. #undef  DEF
  220. #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
  221. #undef  VLC_DEFINE_SORT_FUNCTIONS
  222. #endif
  223.  
  224. enum
  225. {
  226.     ORDER_NORMAL = 0,
  227.     ORDER_REVERSE = 1,
  228. };
  229.  
  230. /* Used by playlist_Import */
  231. #define PLAYLIST_INSERT          0x0001
  232. #define PLAYLIST_APPEND          0x0002
  233. #define PLAYLIST_GO              0x0004
  234. #define PLAYLIST_PREPARSE        0x0008
  235. #define PLAYLIST_SPREPARSE       0x0010
  236. #define PLAYLIST_NO_REBUILD      0x0020
  237.  
  238. #define PLAYLIST_END           -666
  239.  
  240. enum pl_locked_state
  241. {
  242.     pl_Locked = true,
  243.     pl_Unlocked = false
  244. };
  245.  
  246. /*****************************************************************************
  247.  * Prototypes
  248.  *****************************************************************************/
  249.  
  250. /* Helpers */
  251. #define PL_LOCK playlist_Lock( p_playlist )
  252. #define PL_UNLOCK playlist_Unlock( p_playlist )
  253. #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
  254.  
  255. VLC_API playlist_t * pl_Get( vlc_object_t * ) VLC_USED;
  256. #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
  257.  
  258. /* Playlist control */
  259. #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
  260. #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
  261. #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
  262. #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
  263. #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
  264. #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
  265.  
  266. VLC_API void playlist_Lock( playlist_t * );
  267. VLC_API void playlist_Unlock( playlist_t * );
  268. VLC_API void playlist_AssertLocked( playlist_t * );
  269.  
  270. /**
  271.  * Do a playlist action.
  272.  * If there is something in the playlist then you can do playlist actions.
  273.  * Possible queries are listed in vlc_common.h
  274.  * \param p_playlist the playlist to do the command on
  275.  * \param i_query the command to do
  276.  * \param b_locked TRUE if playlist is locked when entering this function
  277.  * \param variable number of arguments
  278.  * \return VLC_SUCCESS or an error
  279.  */
  280. VLC_API int playlist_Control( playlist_t *p_playlist, int i_query, bool b_locked, ...  );
  281.  
  282. /** Get current playing input. The object is retained.
  283.  */
  284. VLC_API input_thread_t * playlist_CurrentInput( playlist_t *p_playlist ) VLC_USED;
  285.  
  286. /** Clear the playlist
  287.  * \param b_locked TRUE if playlist is locked when entering this function
  288.  */
  289. VLC_API void playlist_Clear( playlist_t *, bool );
  290.  
  291. /** Enqueue an input item for preparsing */
  292. VLC_API int playlist_PreparseEnqueue(playlist_t *, input_item_t * );
  293.  
  294. /** Request the art for an input item to be fetched */
  295. VLC_API int playlist_AskForArtEnqueue(playlist_t *, input_item_t * );
  296.  
  297. /* Playlist sorting */
  298. VLC_API int playlist_TreeMove( playlist_t *, playlist_item_t *, playlist_item_t *, int );
  299. VLC_API int playlist_TreeMoveMany( playlist_t *, int, playlist_item_t **, playlist_item_t *, int );
  300. VLC_API int playlist_RecursiveNodeSort( playlist_t *, playlist_item_t *,int, int );
  301.  
  302. VLC_API playlist_item_t * playlist_CurrentPlayingItem( playlist_t * ) VLC_USED;
  303. VLC_API int playlist_Status( playlist_t * );
  304.  
  305. /**
  306.  * Export a node of the playlist to a certain type of playlistfile
  307.  * \param p_playlist the playlist to export
  308.  * \param psz_filename the location where the exported file will be saved
  309.  * \param p_export_root the root node to export
  310.  * \param psz_type the type of playlist file to create (m3u, pls, ..)
  311.  * \return VLC_SUCCESS on success
  312.  */
  313. VLC_API int playlist_Export( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type );
  314.  
  315. /**
  316.  * Open a playlist file, add its content to the current playlist
  317.  */
  318. VLC_API int playlist_Import( playlist_t *p_playlist, const char *psz_file );
  319.  
  320. /********************** Services discovery ***********************/
  321.  
  322. /** Add a list of comma-separated service discovery modules */
  323. VLC_API int playlist_ServicesDiscoveryAdd(playlist_t *, const char *);
  324. /** Remove a services discovery module by name */
  325. VLC_API int playlist_ServicesDiscoveryRemove(playlist_t *, const char *);
  326. /** Check whether a given SD is loaded */
  327. VLC_API bool playlist_IsServicesDiscoveryLoaded( playlist_t *,const char *) VLC_DEPRECATED;
  328. /** Query a services discovery */
  329. VLC_API int playlist_ServicesDiscoveryControl( playlist_t *, const char *, int, ... );
  330.  
  331.  
  332.  
  333. /********************************************************
  334.  * Item management
  335.  ********************************************************/
  336.  
  337. /*************************** Item deletion **************************/
  338. VLC_API int playlist_DeleteFromInput( playlist_t *, input_item_t *, bool );
  339.  
  340. /******************** Item addition ********************/
  341. VLC_API int playlist_Add( playlist_t *, const char *, const char *, int, int, bool, bool );
  342. VLC_API int playlist_AddExt( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool );
  343. VLC_API int playlist_AddInput( playlist_t *, input_item_t *, int, int, bool, bool );
  344. VLC_API playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool );
  345. VLC_API int playlist_NodeAddCopy( playlist_t *, playlist_item_t *, playlist_item_t *, int );
  346.  
  347. /********************************** Item search *************************/
  348. VLC_API playlist_item_t * playlist_ItemGetById(playlist_t *, int ) VLC_USED;
  349. VLC_API playlist_item_t * playlist_ItemGetByInput(playlist_t *,input_item_t * ) VLC_USED;
  350.  
  351. VLC_API int playlist_LiveSearchUpdate(playlist_t *, playlist_item_t *, const char *, bool );
  352.  
  353. /********************************************************
  354.  * Tree management
  355.  ********************************************************/
  356. /* Node management */
  357. VLC_API playlist_item_t * playlist_NodeCreate( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * );
  358. VLC_API int playlist_NodeAppend(playlist_t *,playlist_item_t*,playlist_item_t *);
  359. VLC_API int playlist_NodeInsert(playlist_t *,playlist_item_t*,playlist_item_t *, int);
  360. VLC_API int playlist_NodeRemoveItem(playlist_t *,playlist_item_t*,playlist_item_t *);
  361. VLC_API playlist_item_t * playlist_ChildSearchName(playlist_item_t*, const char* ) VLC_USED;
  362. VLC_API int playlist_NodeDelete( playlist_t *, playlist_item_t *, bool , bool );
  363.  
  364. VLC_API playlist_item_t * playlist_GetNextLeaf( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) VLC_USED;
  365. VLC_API playlist_item_t * playlist_GetPrevLeaf( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) VLC_USED;
  366.  
  367. /***********************************************************************
  368.  * Inline functions
  369.  ***********************************************************************/
  370. /** Small helper tp get current playing input or NULL. Release the input after use. */
  371. #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
  372. static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
  373. {
  374.     return playlist_CurrentInput( pl_Get( p_this ) );
  375. }
  376.  
  377. /** Tell if the playlist is empty */
  378. static inline bool playlist_IsEmpty( playlist_t *p_playlist )
  379. {
  380.     PL_ASSERT_LOCKED;
  381.     return p_playlist->items.i_size == 0;
  382. }
  383.  
  384. /** Tell the number of items in the current playing context */
  385. static inline int playlist_CurrentSize( playlist_t *p_playlist )
  386. {
  387.     PL_ASSERT_LOCKED;
  388.     return p_playlist->current.i_size;
  389. }
  390.  
  391. /** @} */
  392. # ifdef __cplusplus
  393. }
  394. # endif
  395.  
  396. #endif
  397.