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 *****************************************************************************/
28 #include <vlc_access.h>
30 #include <libgnomevfs/gnome-vfs.h>
33 #include <vlc_charset.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Open ( vlc_object_t * );
40 static void Close( vlc_object_t * );
42 #define CACHING_TEXT N_("Caching value in ms")
43 #define CACHING_LONGTEXT N_( \
44 "Caching value for GnomeVFS streams."\
45 "This value should be set in milliseconds." )
48 set_description( _("GnomeVFS input") );
49 set_shortname( "GnomeVFS" );
50 set_category( CAT_INPUT );
51 set_subcategory( SUBCAT_INPUT_ACCESS );
52 add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
53 set_capability( "access2", 10 );
54 add_shortcut( "gnomevfs" );
55 set_callbacks( Open, Close );
59 /*****************************************************************************
61 *****************************************************************************/
62 static int Seek( access_t *, int64_t );
63 static int Read( access_t *, uint8_t *, int );
64 static int Control( access_t *, int, va_list );
68 unsigned int i_nb_reads;
71 GnomeVFSHandle *p_handle;
72 GnomeVFSFileInfo *p_file_info;
75 vlc_bool_t b_seekable;
76 vlc_bool_t b_pace_control;
79 /*****************************************************************************
81 *****************************************************************************/
82 static int Open( vlc_object_t *p_this )
84 access_t *p_access = (access_t*)p_this;
85 access_sys_t *p_sys = NULL;
86 char *psz_name = NULL;
89 char *psz_unescaped = NULL;
90 char *psz_expand_tilde = NULL;
91 GnomeVFSURI *p_uri = NULL;
93 GnomeVFSHandle *p_handle = NULL;
94 if( !(gnome_vfs_init()) )
96 msg_Warn( p_access, "couldn't initilize GnomeVFS" );
101 Since GnomeVFS segfaults on exit if we initialize it without trying to
102 open a file with a valid protocol, try to open at least file:// */
103 gnome_vfs_open( &p_handle, "file://", 5 );
105 STANDARD_READ_ACCESS_INIT;
107 p_sys->p_handle = p_handle;
108 p_sys->i_nb_reads = 0;
109 p_sys->b_pace_control = VLC_TRUE;
111 if( strcmp( "gnomevfs", p_access->psz_access ) &&
112 *(p_access->psz_access) != '\0')
114 psz_name = malloc( strlen( p_access->psz_access ) +
115 strlen( p_access->psz_path ) + 4 );
116 sprintf( psz_name, "%s://%s", p_access->psz_access,
117 p_access->psz_path );
121 psz_name = strdup( p_access->psz_path );
123 psz = ToLocale( psz_name );
124 psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
127 psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
129 /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
130 for relative paths. So we need to use
131 gnome_vfs_escape_host_and_path_string in other cases. */
133 if( !strcmp( psz_unescaped, psz_expand_tilde ) )
135 /* Now we are sure that we have a complete valid unescaped URI beginning
136 with the protocol. We want to escape it. However, gnomevfs's escaping
137 function are broken and will try to escape characters un the username/
138 password field. So parse the URI with vlc_UrlParse ans only escape the
142 char *psz_escaped_path;
143 char *psz_path_begin;
145 vlc_UrlParse( &url, psz_unescaped, 0 );
146 psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
148 if( psz_escaped_path )
150 /* Now let's reconstruct a valid URI from all that stuff */
151 psz_path_begin = psz_unescaped + strlen( psz_unescaped )
152 - strlen( url.psz_path );
153 *psz_path_begin = '\0';
154 psz_uri = malloc( strlen( psz_unescaped ) +
155 strlen( psz_escaped_path ) + 1 );
156 sprintf( psz_uri, "%s%s",psz_unescaped, psz_escaped_path );
158 g_free( psz_escaped_path );
159 g_free( psz_unescaped );
163 psz_uri = psz_unescaped;
168 psz_uri = psz_unescaped;
171 g_free( psz_expand_tilde );
172 p_uri = gnome_vfs_uri_new( psz_uri );
175 p_sys->p_file_info = gnome_vfs_file_info_new();
176 i_ret = gnome_vfs_get_file_info_uri( p_uri,
177 p_sys->p_file_info, 8 );
181 msg_Warn( p_access, "cannot get file info for uri %s (%s)",
182 psz_uri, gnome_vfs_result_to_string( i_ret ) );
183 gnome_vfs_file_info_unref( p_sys->p_file_info );
184 gnome_vfs_uri_unref( p_uri);
193 msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
200 msg_Dbg( p_access, "opening file `%s'", psz_uri );
201 i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
204 msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
205 gnome_vfs_result_to_string( i_ret ) );
207 gnome_vfs_uri_unref( p_uri);
214 if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
216 p_sys->b_local = VLC_TRUE;
219 if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
220 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
221 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
223 p_sys->b_seekable = VLC_TRUE;
224 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
226 else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
227 || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
229 p_sys->b_seekable = VLC_FALSE;
233 msg_Err( p_access, "unknown file type for `%s'", psz_name );
237 if( p_sys->b_seekable && !p_access->info.i_size )
239 /* FIXME that's bad because all others access will be probed */
240 msg_Warn( p_access, "file %s is empty, aborting", psz_name );
241 gnome_vfs_file_info_unref( p_sys->p_file_info );
242 gnome_vfs_uri_unref( p_uri);
249 /* Update default_pts to a suitable value for file access */
250 var_Create( p_access, "gnomevfs-caching",
251 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
254 p_sys->psz_name = psz_name;
255 gnome_vfs_uri_unref( p_uri);
259 /*****************************************************************************
260 * Close: close the target
261 *****************************************************************************/
262 static void Close( vlc_object_t * p_this )
264 access_t *p_access = (access_t*)p_this;
265 access_sys_t *p_sys = p_access->p_sys;
268 i_result = gnome_vfs_close( p_sys->p_handle );
271 msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
272 gnome_vfs_result_to_string( i_result ) );
275 gnome_vfs_file_info_unref( p_sys->p_file_info );
277 free( p_sys->psz_name );
281 /*****************************************************************************
282 * Read: standard read on a file descriptor.
283 *****************************************************************************/
284 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
286 access_sys_t *p_sys = p_access->p_sys;
287 GnomeVFSFileSize i_read_len;
290 i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
291 (GnomeVFSFileSize)i_len, &i_read_len );
294 p_access->info.b_eof = VLC_TRUE;
295 if( i_ret != GNOME_VFS_ERROR_EOF )
297 msg_Err( p_access, "read failed (%s)",
298 gnome_vfs_result_to_string( i_ret ) );
304 if( p_access->info.i_size != 0 &&
305 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
308 gnome_vfs_file_info_clear( p_sys->p_file_info );
309 i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
310 p_sys->p_file_info, 8 );
313 msg_Warn( p_access, "couldn't get file properties again (%s)",
314 gnome_vfs_result_to_string( i_ret ) );
318 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
323 p_access->info.i_pos += (int64_t)i_read_len;
325 /* Some Acces (http) never return EOF and loop on the file */
326 if( p_access->info.i_pos > p_access->info.i_size )
328 p_access->info.b_eof = VLC_TRUE;
331 return (int)i_read_len;
334 /*****************************************************************************
335 * Seek: seek to a specific location in a file
336 *****************************************************************************/
337 static int Seek( access_t *p_access, int64_t i_pos )
339 access_sys_t *p_sys = p_access->p_sys;
342 i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
343 (GnomeVFSFileOffset)i_pos);
346 p_access->info.i_pos = i_pos;
350 GnomeVFSFileSize i_offset;
351 msg_Err( p_access, "cannot seek (%s)",
352 gnome_vfs_result_to_string( i_ret ) );
353 i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
356 msg_Err( p_access, "cannot tell the current position (%s)",
357 gnome_vfs_result_to_string( i_ret ) );
362 p_access->info.b_eof = VLC_FALSE;
368 /*****************************************************************************
370 *****************************************************************************/
371 static int Control( access_t *p_access, int i_query, va_list args )
373 access_sys_t *p_sys = p_access->p_sys;
381 case ACCESS_CAN_SEEK:
382 case ACCESS_CAN_FASTSEEK:
383 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
384 *pb_bool = p_sys->b_seekable;
387 case ACCESS_CAN_PAUSE:
388 case ACCESS_CAN_CONTROL_PACE:
389 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
390 *pb_bool = p_sys->b_pace_control;
395 pi_int = (int*)va_arg( args, int * );
399 case ACCESS_GET_PTS_DELAY:
400 pi_64 = (int64_t*)va_arg( args, int64_t * );
401 *pi_64 = var_GetInteger( p_access,
402 "gnomevfs-caching" ) * I64C(1000);
406 case ACCESS_SET_PAUSE_STATE:
410 case ACCESS_GET_TITLE_INFO:
411 case ACCESS_SET_TITLE:
412 case ACCESS_SET_SEEKPOINT:
413 case ACCESS_SET_PRIVATE_ID_STATE:
414 case ACCESS_GET_META:
415 case ACCESS_GET_CONTENT_TYPE:
419 msg_Warn( p_access, "unimplemented query in control" );