1 /*****************************************************************************
2 * gnomevfs.c: GnomeVFS input
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
7 * Authors: Benjamin Pracht <bigben -AT- videolan -DOT- org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_access.h>
35 #include <libgnomevfs/gnome-vfs.h>
38 #include <vlc_charset.h>
41 /*****************************************************************************
43 *****************************************************************************/
44 static int Open ( vlc_object_t * );
45 static void Close( vlc_object_t * );
47 #define CACHING_TEXT N_("Caching value in ms")
48 #define CACHING_LONGTEXT N_( \
49 "Caching value for GnomeVFS streams."\
50 "This value should be set in milliseconds." )
53 set_description( N_("GnomeVFS input") )
54 set_shortname( "GnomeVFS" )
55 set_category( CAT_INPUT )
56 set_subcategory( SUBCAT_INPUT_ACCESS )
57 add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
58 set_capability( "access", 10 )
59 add_shortcut( "gnomevfs" )
60 set_callbacks( Open, Close )
64 /*****************************************************************************
66 *****************************************************************************/
67 static int Seek( access_t *, int64_t );
68 static int Read( access_t *, uint8_t *, size_t );
69 static int Control( access_t *, int, va_list );
73 unsigned int i_nb_reads;
76 GnomeVFSHandle *p_handle;
77 GnomeVFSFileInfo *p_file_info;
84 /* NOTE: we do not handle memory errors in this plugin.
85 * Underlying glib does not, so there is no point in doing it here either. */
87 /*****************************************************************************
89 *****************************************************************************/
90 static int Open( vlc_object_t *p_this )
92 access_t *p_access = (access_t*)p_this;
93 access_sys_t *p_sys = NULL;
94 char *psz_name = NULL;
97 char *psz_unescaped = NULL;
98 char *psz_expand_tilde = NULL;
99 GnomeVFSURI *p_uri = NULL;
100 GnomeVFSResult i_ret;
101 GnomeVFSHandle *p_handle = NULL;
102 if( !(gnome_vfs_init()) )
104 msg_Warn( p_access, "couldn't initilize GnomeVFS" );
109 Since GnomeVFS segfaults on exit if we initialize it without trying to
110 open a file with a valid protocol, try to open at least file:// */
111 gnome_vfs_open( &p_handle, "file://", 5 );
113 STANDARD_READ_ACCESS_INIT;
115 p_sys->p_handle = p_handle;
116 p_sys->i_nb_reads = 0;
117 p_sys->b_pace_control = true;
119 if( strcmp( "gnomevfs", p_access->psz_access ) &&
120 *(p_access->psz_access) != '\0')
122 asprintf( &psz_name, "%s://%s", p_access->psz_access,
123 p_access->psz_path );
127 psz_name = strdup( p_access->psz_path );
129 psz = ToLocale( psz_name );
130 psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
133 psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
135 /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
136 for relative paths. So we need to use
137 gnome_vfs_escape_host_and_path_string in other cases. */
139 if( !strcmp( psz_unescaped, psz_expand_tilde ) )
141 /* Now we are sure that we have a complete valid unescaped URI beginning
142 with the protocol. We want to escape it. However, gnomevfs's escaping
143 function are broken and will try to escape characters un the username/
144 password field. So parse the URI with vlc_UrlParse ans only escape the
148 char *psz_escaped_path;
149 char *psz_path_begin;
151 vlc_UrlParse( &url, psz_unescaped, 0 );
152 psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
154 if( psz_escaped_path )
156 /* Now let's reconstruct a valid URI from all that stuff */
157 psz_path_begin = psz_unescaped + strlen( psz_unescaped )
158 - strlen( url.psz_path );
159 *psz_path_begin = '\0';
160 asprintf( &psz_uri, "%s%s", psz_unescaped, psz_escaped_path );
162 g_free( psz_escaped_path );
163 g_free( psz_unescaped );
167 psz_uri = psz_unescaped;
172 psz_uri = psz_unescaped;
175 g_free( psz_expand_tilde );
176 p_uri = gnome_vfs_uri_new( psz_uri );
179 p_sys->p_file_info = gnome_vfs_file_info_new();
180 i_ret = gnome_vfs_get_file_info_uri( p_uri,
181 p_sys->p_file_info, 8 );
185 msg_Warn( p_access, "cannot get file info for uri %s (%s)",
186 psz_uri, gnome_vfs_result_to_string( i_ret ) );
187 gnome_vfs_file_info_unref( p_sys->p_file_info );
188 gnome_vfs_uri_unref( p_uri);
197 msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
204 msg_Dbg( p_access, "opening file `%s'", psz_uri );
205 i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
208 msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
209 gnome_vfs_result_to_string( i_ret ) );
211 gnome_vfs_uri_unref( p_uri);
218 if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
220 p_sys->b_local = true;
223 if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
224 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
225 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
227 p_sys->b_seekable = true;
228 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
230 else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
231 || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
233 p_sys->b_seekable = false;
237 msg_Err( p_access, "unknown file type for `%s'", psz_name );
241 if( p_sys->b_seekable && !p_access->info.i_size )
243 /* FIXME that's bad because all others access will be probed */
244 msg_Warn( p_access, "file %s is empty, aborting", psz_name );
245 gnome_vfs_file_info_unref( p_sys->p_file_info );
246 gnome_vfs_uri_unref( p_uri);
253 /* Update default_pts to a suitable value for file access */
254 var_Create( p_access, "gnomevfs-caching",
255 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
258 p_sys->psz_name = psz_name;
259 gnome_vfs_uri_unref( p_uri);
263 /*****************************************************************************
264 * Close: close the target
265 *****************************************************************************/
266 static void Close( vlc_object_t * p_this )
268 access_t *p_access = (access_t*)p_this;
269 access_sys_t *p_sys = p_access->p_sys;
272 i_result = gnome_vfs_close( p_sys->p_handle );
275 msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
276 gnome_vfs_result_to_string( i_result ) );
279 gnome_vfs_file_info_unref( p_sys->p_file_info );
281 free( p_sys->psz_name );
285 /*****************************************************************************
286 * Read: standard read on a file descriptor.
287 *****************************************************************************/
288 static int Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
290 access_sys_t *p_sys = p_access->p_sys;
291 GnomeVFSFileSize i_read_len;
294 i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
295 (GnomeVFSFileSize)i_len, &i_read_len );
298 p_access->info.b_eof = true;
299 if( i_ret != GNOME_VFS_ERROR_EOF )
301 msg_Err( p_access, "read failed (%s)",
302 gnome_vfs_result_to_string( i_ret ) );
308 if( p_access->info.i_size != 0 &&
309 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
312 gnome_vfs_file_info_clear( p_sys->p_file_info );
313 i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
314 p_sys->p_file_info, 8 );
317 msg_Warn( p_access, "couldn't get file properties again (%s)",
318 gnome_vfs_result_to_string( i_ret ) );
322 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
327 p_access->info.i_pos += (int64_t)i_read_len;
329 /* Some Acces (http) never return EOF and loop on the file */
330 if( p_access->info.i_pos > p_access->info.i_size )
332 p_access->info.b_eof = true;
335 return (int)i_read_len;
338 /*****************************************************************************
339 * Seek: seek to a specific location in a file
340 *****************************************************************************/
341 static int Seek( access_t *p_access, int64_t i_pos )
343 access_sys_t *p_sys = p_access->p_sys;
346 i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
347 (GnomeVFSFileOffset)i_pos);
350 p_access->info.i_pos = i_pos;
354 GnomeVFSFileSize i_offset;
355 msg_Err( p_access, "cannot seek (%s)",
356 gnome_vfs_result_to_string( i_ret ) );
357 i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
360 msg_Err( p_access, "cannot tell the current position (%s)",
361 gnome_vfs_result_to_string( i_ret ) );
366 p_access->info.b_eof = false;
372 /*****************************************************************************
374 *****************************************************************************/
375 static int Control( access_t *p_access, int i_query, va_list args )
377 access_sys_t *p_sys = p_access->p_sys;
385 case ACCESS_CAN_SEEK:
386 case ACCESS_CAN_FASTSEEK:
387 pb_bool = (bool*)va_arg( args, bool* );
388 *pb_bool = p_sys->b_seekable;
391 case ACCESS_CAN_PAUSE:
392 case ACCESS_CAN_CONTROL_PACE:
393 pb_bool = (bool*)va_arg( args, bool* );
394 *pb_bool = p_sys->b_pace_control;
399 pi_int = (int*)va_arg( args, int * );
403 case ACCESS_GET_PTS_DELAY:
404 pi_64 = (int64_t*)va_arg( args, int64_t * );
405 *pi_64 = var_GetInteger( p_access,
406 "gnomevfs-caching" ) * INT64_C(1000);
410 case ACCESS_SET_PAUSE_STATE:
414 case ACCESS_GET_TITLE_INFO:
415 case ACCESS_SET_TITLE:
416 case ACCESS_SET_SEEKPOINT:
417 case ACCESS_SET_PRIVATE_ID_STATE:
418 case ACCESS_GET_META:
419 case ACCESS_GET_CONTENT_TYPE:
423 msg_Warn( p_access, "unimplemented query in control" );