]> git.sesse.net Git - vlc/blobdiff - include/vlc_input.h
Clean up and improve core handling for album art. Still only "always fetch" implemented
[vlc] / include / vlc_input.h
index 92b0877d62a74eef9c44a3f990ab87aaed7ffe83..d81452e08c8c69f2484e5ddecda9a42d8d6d5a63 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
- * vlc_input.h:
+ * vlc_input.h: Core input structures
  *****************************************************************************
- * Copyright (C) 1999-2004 the VideoLAN team
- * $Id: input_ext-intf.h 7954 2004-06-07 22:19:12Z fenrir $
+ * Copyright (C) 1999-2006 the VideoLAN team
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /* __ is need because conflict with <vlc/input.h> */
 #ifndef _VLC__INPUT_H
 #define _VLC__INPUT_H 1
 
+#include <vlc_playlist.h>
+#include <vlc_meta.h>
+
+struct vlc_meta_t;
+
 /*****************************************************************************
  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  *****************************************************************************/
@@ -44,27 +49,33 @@ struct info_category_t
 
 struct input_item_t
 {
+    VLC_GC_MEMBERS
+    int        i_id;                 /**< Identifier of the item */
+
     char       *psz_name;            /**< text describing this item */
     char       *psz_uri;             /**< mrl of this item */
+    vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
 
     int        i_options;            /**< Number of input options */
     char       **ppsz_options;       /**< Array of input options */
 
-    mtime_t    i_duration;           /**< A hint about the duration of this
-                                      * item, in milliseconds*/
+    mtime_t    i_duration;           /**< Duration in milliseconds*/
 
-    int        i_id;                 /**< Identifier of the item */
     uint8_t    i_type;               /**< Type (file, disc, ...) */
+    vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
 
     int        i_categories;         /**< Number of info categories */
     info_category_t **pp_categories; /**< Pointer to the first info category */
 
     int         i_es;                /**< Number of es format descriptions */
-    es_format_t **es;                /**< Pointer to an array of es formats */
+    es_format_t **es;                /**< Es formats */
 
-    vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
+    input_stats_t *p_stats;          /**< Statistics */
+    int           i_nb_played;       /**< Number of times played */
 
-    vlc_mutex_t lock;                /**< Item cannot be changed without this lock */
+    vlc_meta_t *p_meta;
+
+    vlc_mutex_t lock;                /**< Lock for the item */
 };
 
 #define ITEM_TYPE_UNKNOWN       0
@@ -77,25 +88,30 @@ struct input_item_t
 #define ITEM_TYPE_NET           7
 #define ITEM_TYPE_PLAYLIST      8
 #define ITEM_TYPE_NODE          9
+#define ITEM_TYPE_NUMBER        10
 
-static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
+static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
 {
     memset( p_i, 0, sizeof(input_item_t) );
-    p_i->i_options  = 0;
-    p_i->i_es = 0;
-    p_i->i_categories = 0 ;
     p_i->psz_name = 0;
     p_i->psz_uri = 0;
+    p_i->i_es = 0;
+    p_i->es = 0;
+    p_i->i_options  = 0;
     p_i->ppsz_options = 0;
+    p_i->i_categories = 0 ;
     p_i->pp_categories = 0;
-    p_i->es = 0;
     p_i->i_type = ITEM_TYPE_UNKNOWN;
     p_i->b_fixed_name = VLC_TRUE;
+
+    p_i->p_stats = NULL;
+    p_i->p_meta = NULL;
+
     vlc_mutex_init( p_o, &p_i->lock );
 }
 
-static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
-                                               input_item_t *p_child )
+static inline void input_ItemCopyOptions( input_item_t *p_parent,
+                                          input_item_t *p_child )
 {
     int i;
     for( i = 0 ; i< p_parent->i_options; i++ )
@@ -109,12 +125,20 @@ static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
     }
 }
 
-static inline void vlc_input_item_Clean( input_item_t *p_i )
+VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
+VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
+
+static inline void input_ItemClean( input_item_t *p_i )
 {
-    if( p_i->psz_name ) free( p_i->psz_name );
-    if( p_i->psz_uri ) free( p_i->psz_uri );
-    p_i->psz_name = 0;
-    p_i->psz_uri = 0;
+    free( p_i->psz_name );
+    free( p_i->psz_uri );
+    if( p_i->p_stats )
+    {
+        vlc_mutex_destroy( &p_i->p_stats->lock );
+        free( p_i->p_stats );
+    }
+
+    if( p_i->p_meta ) vlc_meta_Delete( p_i->p_meta );
 
     while( p_i->i_options )
     {
@@ -158,8 +182,16 @@ static inline void vlc_input_item_Clean( input_item_t *p_i )
     vlc_mutex_destroy( &p_i->lock );
 }
 
-VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
-VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
+VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
+VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
+
+#define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
+#define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
+VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char **, int)  );
+VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char **, int, int ) );
+
+VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
+
 
 /*****************************************************************************
  * Seek point: (generalisation of chapters)
@@ -216,7 +248,7 @@ typedef struct
 
 } input_title_t;
 
-static inline input_title_t *vlc_input_title_New( )
+static inline input_title_t *vlc_input_title_New(void)
 {
     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 
@@ -278,12 +310,17 @@ static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 enum input_state_e
 {
     INIT_S,
+    OPENING_S,
+    BUFFERING_S,
     PLAYING_S,
     PAUSE_S,
-    END_S,
+    END_S
 };
 
-/* "rate" default, min/max */
+/* "rate" default, min/max
+ * A rate below 1000 plays the movie faster,
+ * A rate above 1000 plays the movie slower.
+ */
 #define INPUT_RATE_DEFAULT  1000
 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 #define INPUT_RATE_MAX      8000            /* Up to 1/8 */
@@ -351,6 +388,7 @@ struct input_thread_t
     vlc_bool_t  b_eof;
     vlc_bool_t  b_can_pace_control;
     vlc_bool_t  b_can_pause;
+    vlc_bool_t  b_preparsing;
 
     /* Global state */
     int         i_state;
@@ -390,6 +428,26 @@ struct input_thread_t
     int            i_slave;
     input_source_t **slave;
 
+    /* Stats counters */
+    struct {
+        counter_t *p_read_packets;
+        counter_t *p_read_bytes;
+        counter_t *p_input_bitrate;
+        counter_t *p_demux_read;
+        counter_t *p_demux_bitrate;
+        counter_t *p_decoded_audio;
+        counter_t *p_decoded_video;
+        counter_t *p_decoded_sub;
+        counter_t *p_sout_sent_packets;
+        counter_t *p_sout_sent_bytes;
+        counter_t *p_sout_send_bitrate;
+        counter_t *p_played_abuffers;
+        counter_t *p_lost_abuffers;
+        counter_t *p_displayed_pictures;
+        counter_t *p_lost_pictures;
+        vlc_mutex_t counters_lock;
+    } counters;
+
     /* Buffer of pending actions */
     vlc_mutex_t lock_control;
     int i_control;
@@ -406,11 +464,29 @@ struct input_thread_t
  *****************************************************************************/
 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
+#define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
+VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
+
+#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
+VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 
+typedef struct playlist_album_t
+{
+    char *psz_artist;
+    char *psz_album;
+    vlc_bool_t b_found;
+} playlist_album_t;
+
+int         input_MetaFetch     ( playlist_t *, input_item_t * );
+int         input_ArtFind       ( playlist_t *, input_item_t * );
+vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
+                                  uint32_t*, uint32_t* );
+int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
+
 enum input_query_e
 {
     /* input variable "position" */
@@ -460,7 +536,7 @@ enum input_query_e
     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 
     /* On the fly input slave */
-    INPUT_ADD_SLAVE,       /* arg1= char * */
+    INPUT_ADD_SLAVE        /* arg1= char * */
 };
 
 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
@@ -470,4 +546,8 @@ VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vl
 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 
+VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
+
+
+
 #endif