modules/services_discovery/mediadirs.c

   1 /*****************************************************************************
   2  * mediadirs.c:  Picture/Music/Video user directories as service discoveries
   3  *****************************************************************************
   4  * Copyright (C) 2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Erwan Tulou <erwan10 aT videolan DoT org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Includes
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <sys/stat.h>
  33
  34 #define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_url.h>
  38 #include <vlc_fs.h>
  39 #include <vlc_services_discovery.h>
  40
  41 /*****************************************************************************
  42  * Module descriptor
  43  *****************************************************************************/
  44
  45 enum type_e { Video = 0, Audio = 1, Picture = 2, Unknown = 3 };
  46
  47 static int  Open( vlc_object_t *, enum type_e );
  48 static void Close( vlc_object_t * );
  49
  50 /* Main functions */
  51 #define OPEN_MODULE( type )                        \
  52 static int Open##type( vlc_object_t *p_this )      \
  53 {                                                  \
  54     msg_Dbg( p_this, "Starting " #type );          \
  55     return Open( p_this, type );                   \
  56 }
  57
  58 OPEN_MODULE( Video )
  59 OPEN_MODULE( Audio )
  60 OPEN_MODULE( Picture )
  61
  62 #undef OPEN_MODULE
  63
  64 static int vlc_sd_probe_Open( vlc_object_t * );
  65
  66 vlc_module_begin ()
  67     set_category( CAT_PLAYLIST )
  68     set_subcategory( SUBCAT_PLAYLIST_SD )
  69
  70         set_shortname( N_("Video") )
  71         set_description( N_("My Videos") )
  72         set_capability( "services_discovery", 0 )
  73         set_callbacks( OpenVideo, Close )
  74         add_shortcut( "video_dir" )
  75
  76     add_submodule ()
  77         set_shortname( N_("Audio") )
  78         set_description( N_("My Music") )
  79         set_capability( "services_discovery", 0 )
  80         set_callbacks( OpenAudio, Close )
  81         add_shortcut( "audio_dir" )
  82
  83     add_submodule ()
  84         set_shortname( N_("Picture") )
  85         set_description( N_("My Pictures") )
  86         set_capability( "services_discovery", 0 )
  87         set_callbacks( OpenPicture, Close )
  88         add_shortcut( "picture_dir" )
  89
  90     VLC_SD_PROBE_SUBMODULE
  91 vlc_module_end ()
  92
  93
  94 /*****************************************************************************
  95  * Local prototypes
  96  *****************************************************************************/
  97
  98 static void* Run( void* );
  99
 100 static void input_subnode_added( const vlc_event_t*, void* );
 101 static int onNewFileAdded( vlc_object_t*, char const *,
 102                            vlc_value_t, vlc_value_t, void *);
 103
 104 static enum type_e fileType( services_discovery_t *p_sd, const char* psz_file );
 105 static void formatSnapshotItem( input_item_t* );
 106
 107 struct services_discovery_sys_t
 108 {
 109     vlc_thread_t thread;
 110     enum type_e i_type;
 111
 112     char* psz_dir[2];
 113     const char* psz_var;
 114 };
 115
 116 /*****************************************************************************
 117  * Open: initialize module
 118  *****************************************************************************/
 119 static int Open( vlc_object_t *p_this, enum type_e i_type )
 120 {
 121     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
 122     services_discovery_sys_t *p_sys;
 123     const char *desc;
 124
 125     p_sd->p_sys = p_sys = calloc( 1, sizeof( *p_sys) );
 126     if( !p_sys )
 127         return VLC_ENOMEM;
 128
 129     p_sys->i_type = i_type;
 130
 131     if( p_sys->i_type == Video )
 132     {
 133         desc = N_("My Videos");
 134         p_sys->psz_dir[0] = config_GetUserDir( VLC_VIDEOS_DIR );
 135         p_sys->psz_dir[1] = var_CreateGetString( p_sd, "input-record-path" );
 136
 137         p_sys->psz_var = "record-file";
 138     }
 139     else if( p_sys->i_type == Audio )
 140     {
 141         desc = N_("My Music");
 142         p_sys->psz_dir[0] = config_GetUserDir( VLC_MUSIC_DIR );
 143         p_sys->psz_dir[1] = var_CreateGetString( p_sd, "input-record-path" );
 144
 145         p_sys->psz_var = "record-file";
 146     }
 147     else if( p_sys->i_type == Picture )
 148     {
 149         desc = N_("My Pictures");
 150         p_sys->psz_dir[0] = config_GetUserDir( VLC_PICTURES_DIR );
 151         p_sys->psz_dir[1] = var_CreateGetString( p_sd, "snapshot-path" );
 152
 153         p_sys->psz_var = "snapshot-file";
 154     }
 155     else
 156     {
 157         free( p_sys );
 158         return VLC_EGENERIC;
 159     }
 160
 161     p_sd->description = vlc_gettext(desc);
 162
 163     var_AddCallback( p_sd->obj.libvlc, p_sys->psz_var, onNewFileAdded, p_sd );
 164
 165     if( vlc_clone( &p_sys->thread, Run, p_sd, VLC_THREAD_PRIORITY_LOW ) )
 166     {
 167         var_DelCallback( p_sd->obj.libvlc, p_sys->psz_var, onNewFileAdded, p_sd );
 168         free( p_sys->psz_dir[1] );
 169         free( p_sys->psz_dir[0] );
 170         free( p_sys );
 171         return VLC_EGENERIC;
 172     }
 173
 174     return VLC_SUCCESS;
 175 }
 176
 177 /*****************************************************************************
 178  * Run:
 179  *****************************************************************************/
 180 static void *Run( void *data )
 181 {
 182     services_discovery_t *p_sd = data;
 183     services_discovery_sys_t *p_sys = p_sd->p_sys;
 184
 185     int num_dir = sizeof( p_sys->psz_dir ) / sizeof( p_sys->psz_dir[0] );
 186     for( int i = 0; i < num_dir; i++ )
 187     {
 188         char* psz_dir = p_sys->psz_dir[i];
 189
 190         /* make sure the directory exists */
 191         struct stat st;
 192         if( psz_dir == NULL            ||
 193             vlc_stat( psz_dir, &st )  ||
 194             !S_ISDIR( st.st_mode ) )
 195             continue;
 196
 197         char* psz_uri = vlc_path2uri( psz_dir, "file" );
 198
 199         input_item_t* p_root = input_item_New( psz_uri, NULL );
 200         if( p_sys->i_type == Picture )
 201             input_item_AddOption( p_root, "ignore-filetypes=ini,db,lnk,txt",
 202                                   VLC_INPUT_OPTION_TRUSTED|VLC_INPUT_OPTION_UNIQUE );
 203
 204         input_item_AddOption( p_root, "recursive=collapse",
 205                               VLC_INPUT_OPTION_TRUSTED|VLC_INPUT_OPTION_UNIQUE );
 206
 207
 208         vlc_event_manager_t *p_em = &p_root->event_manager;
 209         vlc_event_attach( p_em, vlc_InputItemSubItemTreeAdded,
 210                           input_subnode_added, p_sd );
 211
 212         input_Read( p_sd, p_root );
 213
 214         vlc_event_detach( p_em, vlc_InputItemSubItemTreeAdded,
 215                           input_subnode_added, p_sd );
 216
 217         input_item_Release( p_root );
 218         free( psz_uri );
 219     }
 220
 221     return NULL;
 222 }
 223
 224 /*****************************************************************************
 225  * Close:
 226  *****************************************************************************/
 227 static void Close( vlc_object_t *p_this )
 228 {
 229     services_discovery_t *p_sd = (services_discovery_t *)p_this;
 230     services_discovery_sys_t *p_sys = p_sd->p_sys;
 231
 232     vlc_join( p_sys->thread, NULL );
 233
 234     var_DelCallback( p_sd->obj.libvlc, p_sys->psz_var, onNewFileAdded, p_sd );
 235
 236     free( p_sys->psz_dir[1] );
 237     free( p_sys->psz_dir[0] );
 238     free( p_sys );
 239 }
 240
 241
 242 /*****************************************************************************
 243  * Callbacks and helper functions
 244  *****************************************************************************/
 245 static void input_subnode_added( const vlc_event_t *p_event, void *user_data )
 246 {
 247     services_discovery_t *p_sd = user_data;
 248     services_discovery_sys_t *p_sys = p_sd->p_sys;
 249     input_item_node_t *root = p_event->u.input_item_subitem_tree_added.p_root;
 250
 251     for( int i = 0; i < root->i_children; i++ )
 252     {
 253         input_item_node_t *child = root->pp_children[i];
 254         input_item_t *item = child->p_item;
 255
 256         if( p_sys->i_type == Picture )
 257             formatSnapshotItem( item );
 258
 259         services_discovery_AddItem( p_sd, item );
 260     }
 261 }
 262
 263 static int onNewFileAdded( vlc_object_t *p_this, char const *psz_var,
 264                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 265 {
 266     (void)p_this;
 267
 268     services_discovery_t *p_sd = p_data;
 269     services_discovery_sys_t *p_sys = p_sd->p_sys;
 270
 271     (void)psz_var; (void)oldval;
 272     char* psz_file = newval.psz_string;
 273     if( !psz_file || !*psz_file )
 274         return VLC_EGENERIC;
 275
 276     char* psz_uri = vlc_path2uri( psz_file, "file" );
 277     input_item_t* p_item = input_item_New( psz_uri, NULL );
 278
 279     if( p_sys->i_type == Picture )
 280     {
 281         if( fileType( p_sd, psz_file ) == Picture )
 282         {
 283             formatSnapshotItem( p_item );
 284             services_discovery_AddItem( p_sd, p_item );
 285
 286             msg_Dbg( p_sd, "New snapshot added : %s", psz_file );
 287         }
 288     }
 289     else if( p_sys->i_type == Audio )
 290     {
 291         if( fileType( p_sd, psz_file ) == Audio )
 292         {
 293             services_discovery_AddItem( p_sd, p_item );
 294
 295             msg_Dbg( p_sd, "New recorded audio added : %s", psz_file );
 296         }
 297     }
 298     else if( p_sys->i_type == Video )
 299     {
 300         if( fileType( p_sd, psz_file ) == Video ||
 301             fileType( p_sd, psz_file ) == Unknown )
 302         {
 303             services_discovery_AddItem( p_sd, p_item );
 304
 305             msg_Dbg( p_sd, "New recorded video added : %s", psz_file );
 306         }
 307     }
 308
 309     input_item_Release( p_item );
 310     free( psz_uri );
 311
 312     return VLC_SUCCESS;
 313 }
 314
 315 void formatSnapshotItem( input_item_t *p_item )
 316 {
 317     if( !p_item )
 318         return;
 319
 320     char* psz_uri = input_item_GetURI( p_item );
 321
 322     /* copy the snapshot mrl as a ArtURL */
 323     if( psz_uri )
 324         input_item_SetArtURL( p_item, psz_uri );
 325
 326     free( psz_uri );
 327 }
 328
 329
 330 enum type_e fileType( services_discovery_t *p_sd, const char* psz_file )
 331 {
 332     services_discovery_sys_t *p_sys = p_sd->p_sys;
 333     enum type_e i_ret = Unknown;
 334
 335     char* psz_dir = strdup( psz_file );
 336     char* psz_tmp = strrchr( psz_dir, DIR_SEP_CHAR );
 337     if( psz_tmp )
 338         *psz_tmp = '\0';
 339
 340     int num_dir = sizeof( p_sys->psz_dir ) / sizeof( p_sys->psz_dir[0] );
 341     for( int i = 0; i < num_dir; i++ )
 342     {
 343         char* psz_known_dir = p_sys->psz_dir[i];
 344
 345         if( psz_known_dir && !strcmp( psz_dir, psz_known_dir ) )
 346             i_ret = p_sys->i_type;
 347     }
 348
 349     free( psz_dir );
 350     return i_ret;
 351 }
 352
 353 static int vlc_sd_probe_Open( vlc_object_t *obj )
 354 {
 355     vlc_probe_t *probe = (vlc_probe_t *)obj;
 356
 357     vlc_sd_probe_Add( probe, "video_dir", N_("My Videos"), SD_CAT_MYCOMPUTER );
 358     vlc_sd_probe_Add( probe, "audio_dir", N_("My Music"), SD_CAT_MYCOMPUTER );
 359     vlc_sd_probe_Add( probe, "picture_dir", N_("My Pictures"),
 360                       SD_CAT_MYCOMPUTER );
 361     return VLC_PROBE_CONTINUE;
 362 }