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>
35 #include <vlc_charset.h>
38 /*****************************************************************************
40 *****************************************************************************/
41 static int Open ( vlc_object_t * );
42 static void Close( vlc_object_t * );
44 #define CACHING_TEXT N_("Caching value in ms")
45 #define CACHING_LONGTEXT N_( \
46 "Caching value for GnomeVFS streams."\
47 "This value should be set in milliseconds." )
50 set_description( _("GnomeVFS input") );
51 set_shortname( "GnomeVFS" );
52 set_category( CAT_INPUT );
53 set_subcategory( SUBCAT_INPUT_ACCESS );
54 add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
55 set_capability( "access2", 10 );
56 add_shortcut( "gnomevfs" );
57 set_callbacks( Open, Close );
61 /*****************************************************************************
63 *****************************************************************************/
64 static int Seek( access_t *, int64_t );
65 static int Read( access_t *, uint8_t *, int );
66 static int Control( access_t *, int, va_list );
70 unsigned int i_nb_reads;
73 GnomeVFSHandle *p_handle;
74 GnomeVFSFileInfo *p_file_info;
77 vlc_bool_t b_seekable;
78 vlc_bool_t b_pace_control;
81 /*****************************************************************************
83 *****************************************************************************/
84 static int Open( vlc_object_t *p_this )
86 access_t *p_access = (access_t*)p_this;
87 access_sys_t *p_sys = NULL;
88 char *psz_name = NULL;
91 char *psz_unescaped = NULL;
92 char *psz_expand_tilde = NULL;
93 GnomeVFSURI *p_uri = NULL;
95 GnomeVFSHandle *p_handle = NULL;
96 if( !(gnome_vfs_init()) )
98 msg_Warn( p_access, "couldn't initilize GnomeVFS" );
103 Since GnomeVFS segfaults on exit if we initialize it without trying to
104 open a file with a valid protocol, try to open at least file:// */
105 gnome_vfs_open( &p_handle, "file://", 5 );
107 STANDARD_READ_ACCESS_INIT;
109 p_sys->p_handle = p_handle;
110 p_sys->i_nb_reads = 0;
111 p_sys->b_pace_control = VLC_TRUE;
113 if( strcmp( "gnomevfs", p_access->psz_access ) &&
114 *(p_access->psz_access) != '\0')
116 psz_name = malloc( strlen( p_access->psz_access ) +
117 strlen( p_access->psz_path ) + 4 );
118 sprintf( psz_name, "%s://%s", p_access->psz_access,
119 p_access->psz_path );
123 psz_name = strdup( p_access->psz_path );
125 psz = ToLocale( psz_name );
126 psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
129 psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
131 /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
132 for relative paths. So we need to use
133 gnome_vfs_escape_host_and_path_string in other cases. */
135 if( !strcmp( psz_unescaped, psz_expand_tilde ) )
137 /* Now we are sure that we have a complete valid unescaped URI beginning
138 with the protocol. We want to escape it. However, gnomevfs's escaping
139 function are broken and will try to escape characters un the username/
140 password field. So parse the URI with vlc_UrlParse ans only escape the
144 char *psz_escaped_path;
145 char *psz_path_begin;
147 vlc_UrlParse( &url, psz_unescaped, 0 );
148 psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
150 if( psz_escaped_path )
152 /* Now let's reconstruct a valid URI from all that stuff */
153 psz_path_begin = psz_unescaped + strlen( psz_unescaped )
154 - strlen( url.psz_path );
155 *psz_path_begin = '\0';
156 psz_uri = malloc( strlen( psz_unescaped ) +
157 strlen( psz_escaped_path ) + 1 );
158 sprintf( psz_uri, "%s%s",psz_unescaped, psz_escaped_path );
160 g_free( psz_escaped_path );
161 g_free( psz_unescaped );
165 psz_uri = psz_unescaped;
170 psz_uri = psz_unescaped;
173 g_free( psz_expand_tilde );
174 p_uri = gnome_vfs_uri_new( psz_uri );
177 p_sys->p_file_info = gnome_vfs_file_info_new();
178 i_ret = gnome_vfs_get_file_info_uri( p_uri,
179 p_sys->p_file_info, 8 );
183 msg_Warn( p_access, "cannot get file info for uri %s (%s)",
184 psz_uri, gnome_vfs_result_to_string( i_ret ) );
185 gnome_vfs_file_info_unref( p_sys->p_file_info );
186 gnome_vfs_uri_unref( p_uri);
195 msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
202 msg_Dbg( p_access, "opening file `%s'", psz_uri );
203 i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
206 msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
207 gnome_vfs_result_to_string( i_ret ) );
209 gnome_vfs_uri_unref( p_uri);
216 if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
218 p_sys->b_local = VLC_TRUE;
221 if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
222 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
223 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
225 p_sys->b_seekable = VLC_TRUE;
226 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
228 else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
229 || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
231 p_sys->b_seekable = VLC_FALSE;
235 msg_Err( p_access, "unknown file type for `%s'", psz_name );
239 if( p_sys->b_seekable && !p_access->info.i_size )
241 /* FIXME that's bad because all others access will be probed */
242 msg_Warn( p_access, "file %s is empty, aborting", psz_name );
243 gnome_vfs_file_info_unref( p_sys->p_file_info );
244 gnome_vfs_uri_unref( p_uri);
251 /* Update default_pts to a suitable value for file access */
252 var_Create( p_access, "gnomevfs-caching",
253 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
256 p_sys->psz_name = psz_name;
257 gnome_vfs_uri_unref( p_uri);
261 /*****************************************************************************
262 * Close: close the target
263 *****************************************************************************/
264 static void Close( vlc_object_t * p_this )
266 access_t *p_access = (access_t*)p_this;
267 access_sys_t *p_sys = p_access->p_sys;
270 i_result = gnome_vfs_close( p_sys->p_handle );
273 msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
274 gnome_vfs_result_to_string( i_result ) );
277 gnome_vfs_file_info_unref( p_sys->p_file_info );
279 free( p_sys->psz_name );
283 /*****************************************************************************
284 * Read: standard read on a file descriptor.
285 *****************************************************************************/
286 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
288 access_sys_t *p_sys = p_access->p_sys;
289 GnomeVFSFileSize i_read_len;
292 i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
293 (GnomeVFSFileSize)i_len, &i_read_len );
296 p_access->info.b_eof = VLC_TRUE;
297 if( i_ret != GNOME_VFS_ERROR_EOF )
299 msg_Err( p_access, "read failed (%s)",
300 gnome_vfs_result_to_string( i_ret ) );
306 if( p_access->info.i_size != 0 &&
307 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
310 gnome_vfs_file_info_clear( p_sys->p_file_info );
311 i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
312 p_sys->p_file_info, 8 );
315 msg_Warn( p_access, "couldn't get file properties again (%s)",
316 gnome_vfs_result_to_string( i_ret ) );
320 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
325 p_access->info.i_pos += (int64_t)i_read_len;
327 /* Some Acces (http) never return EOF and loop on the file */
328 if( p_access->info.i_pos > p_access->info.i_size )
330 p_access->info.b_eof = VLC_TRUE;
333 return (int)i_read_len;
336 /*****************************************************************************
337 * Seek: seek to a specific location in a file
338 *****************************************************************************/
339 static int Seek( access_t *p_access, int64_t i_pos )
341 access_sys_t *p_sys = p_access->p_sys;
344 i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
345 (GnomeVFSFileOffset)i_pos);
348 p_access->info.i_pos = i_pos;
352 GnomeVFSFileSize i_offset;
353 msg_Err( p_access, "cannot seek (%s)",
354 gnome_vfs_result_to_string( i_ret ) );
355 i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
358 msg_Err( p_access, "cannot tell the current position (%s)",
359 gnome_vfs_result_to_string( i_ret ) );
364 p_access->info.b_eof = VLC_FALSE;
370 /*****************************************************************************
372 *****************************************************************************/
373 static int Control( access_t *p_access, int i_query, va_list args )
375 access_sys_t *p_sys = p_access->p_sys;
383 case ACCESS_CAN_SEEK:
384 case ACCESS_CAN_FASTSEEK:
385 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
386 *pb_bool = p_sys->b_seekable;
389 case ACCESS_CAN_PAUSE:
390 case ACCESS_CAN_CONTROL_PACE:
391 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
392 *pb_bool = p_sys->b_pace_control;
397 pi_int = (int*)va_arg( args, int * );
401 case ACCESS_GET_PTS_DELAY:
402 pi_64 = (int64_t*)va_arg( args, int64_t * );
403 *pi_64 = var_GetInteger( p_access,
404 "gnomevfs-caching" ) * I64C(1000);
408 case ACCESS_SET_PAUSE_STATE:
412 case ACCESS_GET_TITLE_INFO:
413 case ACCESS_SET_TITLE:
414 case ACCESS_SET_SEEKPOINT:
415 case ACCESS_SET_PRIVATE_ID_STATE:
416 case ACCESS_GET_META:
420 msg_Warn( p_access, "unimplemented query in control" );