/*****************************************************************************
* file.c
*****************************************************************************
- * Copyright (C) 2001, 2002 the VideoLAN team
+ * Copyright (C) 2001, 2002 VLC authors and VideoLAN
* $Id$
*
* Authors: Laurent Aimar <fenrir@via.ecp.fr>
* Eric Petit <titer@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
#include <sys/types.h>
-#include <sys/stat.h>
-#include <string.h>
#include <time.h>
#include <fcntl.h>
#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
-#include <vlc/vlc.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
#include <vlc_sout.h>
#include <vlc_block.h>
-#include <vlc_charset.h>
-#include "vlc_strings.h"
+#include <vlc_fs.h>
+#include <vlc_strings.h>
+#include <vlc_dialog.h>
-#ifdef HAVE_UNISTD_H
-# include <unistd.h>
-#elif defined( WIN32 ) && !defined( UNDER_CE )
+#if defined( _WIN32 ) || defined( __OS2__ )
# include <io.h>
#endif
-/* For those platforms that don't use these */
-#ifndef STDOUT_FILENO
-# define STDOUT_FILENO 1
+#ifndef _WIN32
+# include <unistd.h>
#endif
+
#ifndef O_LARGEFILE
# define O_LARGEFILE 0
#endif
static void Close( vlc_object_t * );
#define SOUT_CFG_PREFIX "sout-file-"
+#define OVERWRITE_TEXT N_("Overwrite existing file")
+#define OVERWRITE_LONGTEXT N_( \
+ "If the file already exists, it will be overwritten.")
#define APPEND_TEXT N_("Append to file")
#define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
"of replacing it.")
-
-vlc_module_begin();
- set_description( _("File stream output") );
- set_shortname( _("File" ));
- set_capability( "sout access", 50 );
- set_category( CAT_SOUT );
- set_subcategory( SUBCAT_SOUT_ACO );
- add_shortcut( "file" );
- add_shortcut( "stream" );
- add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
- VLC_TRUE );
- set_callbacks( Open, Close );
-vlc_module_end();
+#define FORMAT_TEXT N_("Format time and date")
+#define FORMAT_LONGTEXT N_("Perform ISO C time and date formatting " \
+ "on the file path")
+#define SYNC_TEXT N_("Synchronous writing")
+#define SYNC_LONGTEXT N_( "Open the file with synchronous writing.")
+
+vlc_module_begin ()
+ set_description( N_("File stream output") )
+ set_shortname( N_("File" ))
+ set_capability( "sout access", 50 )
+ set_category( CAT_SOUT )
+ set_subcategory( SUBCAT_SOUT_ACO )
+ add_shortcut( "file", "stream", "fd" )
+ add_bool( SOUT_CFG_PREFIX "overwrite", true, OVERWRITE_TEXT,
+ OVERWRITE_LONGTEXT, true )
+ add_bool( SOUT_CFG_PREFIX "append", false, APPEND_TEXT,APPEND_LONGTEXT,
+ true )
+ add_bool( SOUT_CFG_PREFIX "format", false, FORMAT_TEXT, FORMAT_LONGTEXT,
+ true )
+#ifdef O_SYNC
+ add_bool( SOUT_CFG_PREFIX "sync", false, SYNC_TEXT,SYNC_LONGTEXT,
+ false )
+#endif
+ set_callbacks( Open, Close )
+vlc_module_end ()
/*****************************************************************************
* Exported prototypes
*****************************************************************************/
-static const char *ppsz_sout_options[] = {
- "append", NULL
+static const char *const ppsz_sout_options[] = {
+ "append",
+ "format",
+ "overwrite",
+#ifdef O_SYNC
+ "sync",
+#endif
+ NULL
};
-static int Write( sout_access_out_t *, block_t * );
+static ssize_t Write( sout_access_out_t *, block_t * );
static int Seek ( sout_access_out_t *, off_t );
-static int Read ( sout_access_out_t *, block_t * );
-
-struct sout_access_out_sys_t
-{
- int i_handle;
-};
+static ssize_t Read ( sout_access_out_t *, block_t * );
+static int Control( sout_access_out_t *, int, va_list );
/*****************************************************************************
* Open: open the file
static int Open( vlc_object_t *p_this )
{
sout_access_out_t *p_access = (sout_access_out_t*)p_this;
- int i_flags;
- vlc_value_t val;
+ int fd;
config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
return VLC_EGENERIC;
}
- if( !( p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
- {
- return( VLC_ENOMEM );
- }
+ bool overwrite = var_GetBool (p_access, SOUT_CFG_PREFIX"overwrite");
+ bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
- i_flags = O_RDWR|O_CREAT|O_LARGEFILE;
-
- var_Get( p_access, SOUT_CFG_PREFIX "append", &val );
- i_flags |= val.b_bool ? O_APPEND : O_TRUNC;
+ if (!strcmp (p_access->psz_access, "fd"))
+ {
+ char *end;
+ fd = strtol (p_access->psz_path, &end, 0);
+ if (!*p_access->psz_path || *end)
+ {
+ msg_Err (p_access, "invalid file descriptor: %s",
+ p_access->psz_path);
+ return VLC_EGENERIC;
+ }
+ fd = vlc_dup (fd);
+ if (fd == -1)
+ {
+ msg_Err (p_access, "cannot use file descriptor: %s",
+ vlc_strerror_c(errno));
+ return VLC_EGENERIC;
+ }
+ }
+ else
if( !strcmp( p_access->psz_path, "-" ) )
{
-#if defined(WIN32)
+#if defined( _WIN32 ) || defined( __OS2__ )
setmode (STDOUT_FILENO, O_BINARY);
#endif
- p_access->p_sys->i_handle = STDOUT_FILENO;
+ fd = vlc_dup (STDOUT_FILENO);
+ if (fd == -1)
+ {
+ msg_Err (p_access, "cannot use standard output: %s",
+ vlc_strerror_c(errno));
+ return VLC_EGENERIC;
+ }
msg_Dbg( p_access, "using stdout" );
}
else
{
- int fd;
- char *psz_tmp = str_format( p_access, p_access->psz_path );
- path_sanitize( psz_tmp );
+ const char *path = p_access->psz_path;
+ char *buf = NULL;
- fd = utf8_open( psz_tmp, i_flags, 0666 );
- free( psz_tmp );
+ if (var_InheritBool (p_access, SOUT_CFG_PREFIX"format"))
+ {
+ buf = str_format_time (path);
+ path_sanitize (buf);
+ path = buf;
+ }
- if( fd == -1 )
+ int flags = O_RDWR | O_CREAT | O_LARGEFILE;
+ if (!overwrite)
+ flags |= O_EXCL;
+ if (!append)
+ flags |= O_TRUNC;
+#ifdef O_SYNC
+ if (var_GetBool (p_access, SOUT_CFG_PREFIX"sync"))
+ flags |= O_SYNC;
+#endif
+ do
{
- msg_Err( p_access, "cannot open `%s' (%s)", p_access->psz_path,
- strerror( errno ) );
- free( p_access->p_sys );
- return( VLC_EGENERIC );
+ fd = vlc_open (path, flags, 0666);
+ if (fd != -1)
+ break;
+ if (fd == -1)
+ msg_Err (p_access, "cannot create %s: %s", path,
+ vlc_strerror_c(errno));
+ if (overwrite || errno != EEXIST)
+ break;
+ flags &= ~O_EXCL;
}
- p_access->p_sys->i_handle = fd;
+ while (dialog_Question (p_access, path,
+ _("The output file already exists. "
+ "If recording continues, the file will be "
+ "overridden and its content will be lost."),
+ _("Keep existing file"),
+ _("Overwrite"), NULL) == 2);
+ free (buf);
+ if (fd == -1)
+ return VLC_EGENERIC;
}
p_access->pf_write = Write;
p_access->pf_read = Read;
p_access->pf_seek = Seek;
+ p_access->pf_control = Control;
+ p_access->p_sys = (void *)(intptr_t)fd;
- msg_Dbg( p_access, "file access output opened (`%s')", p_access->psz_path );
-
- /* Update pace control flag */
- if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
- p_access->p_sout->i_out_pace_nocontrol++;
+ msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
+ if (append)
+ lseek (fd, 0, SEEK_END);
return VLC_SUCCESS;
}
{
sout_access_out_t *p_access = (sout_access_out_t*)p_this;
- if( strcmp( p_access->psz_path, "-" ) )
+ close( (intptr_t)p_access->p_sys );
+
+ msg_Dbg( p_access, "file access output closed" );
+}
+
+static int Control( sout_access_out_t *p_access, int i_query, va_list args )
+{
+ switch( i_query )
{
- if( p_access->p_sys->i_handle )
+ case ACCESS_OUT_CONTROLS_PACE:
{
- close( p_access->p_sys->i_handle );
+ bool *pb = va_arg( args, bool * );
+ *pb = strcmp( p_access->psz_access, "stream" );
+ break;
}
- }
- free( p_access->p_sys );
- /* Update pace control flag */
- if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
- p_access->p_sout->i_out_pace_nocontrol--;
+ case ACCESS_OUT_CAN_SEEK:
+ {
+ bool *pb = va_arg( args, bool * );
+ struct stat st;
+ if( fstat( (intptr_t)p_access->p_sys, &st ) == -1 )
+ *pb = false;
+ else
+ *pb = S_ISREG( st.st_mode ) || S_ISBLK( st.st_mode );
+ break;
+ }
- msg_Dbg( p_access, "file access output closed" );
+ default:
+ return VLC_EGENERIC;
+ }
+ return VLC_SUCCESS;
}
/*****************************************************************************
* Read: standard read on a file descriptor.
*****************************************************************************/
-static int Read( sout_access_out_t *p_access, block_t *p_buffer )
+static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
{
- if( strcmp( p_access->psz_path, "-" ) )
- {
- return read( p_access->p_sys->i_handle, p_buffer->p_buffer,
- p_buffer->i_buffer );
- }
+ ssize_t val;
- msg_Err( p_access, "cannot read while using stdout" );
- return VLC_EGENERIC;
+ do
+ val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
+ p_buffer->i_buffer );
+ while (val == -1 && errno == EINTR);
+ return val;
}
/*****************************************************************************
* Write: standard write on a file descriptor.
*****************************************************************************/
-static int Write( sout_access_out_t *p_access, block_t *p_buffer )
+static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
{
size_t i_write = 0;
while( p_buffer )
{
- block_t *p_next = p_buffer->p_next;;
-
- i_write += write( p_access->p_sys->i_handle,
- p_buffer->p_buffer, p_buffer->i_buffer );
- block_Release( p_buffer );
+ ssize_t val = write ((intptr_t)p_access->p_sys,
+ p_buffer->p_buffer, p_buffer->i_buffer);
+ if (val <= 0)
+ {
+ if (errno == EINTR)
+ continue;
+ block_ChainRelease (p_buffer);
+ msg_Err( p_access, "cannot write: %s", vlc_strerror_c(errno) );
+ return -1;
+ }
- p_buffer = p_next;
+ if ((size_t)val >= p_buffer->i_buffer)
+ {
+ block_t *p_next = p_buffer->p_next;
+ block_Release (p_buffer);
+ p_buffer = p_next;
+ }
+ else
+ {
+ p_buffer->p_buffer += val;
+ p_buffer->i_buffer -= val;
+ }
+ i_write += val;
}
-
return i_write;
}
*****************************************************************************/
static int Seek( sout_access_out_t *p_access, off_t i_pos )
{
- if( strcmp( p_access->psz_path, "-" ) )
- {
-#if defined( WIN32 ) && !defined( UNDER_CE )
- return( _lseeki64( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
-#else
- return( lseek( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
-#endif
- }
- else
- {
- msg_Err( p_access, "cannot seek while using stdout" );
- return VLC_EGENERIC;
- }
+ return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
}