modules/access_output/file.c

   1 /*****************************************************************************
   2  * file.c
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2002 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Eric Petit <titer@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <sys/types.h>
  34 #include <time.h>
  35 #include <fcntl.h>
  36 #include <errno.h>
  37
  38 #include <vlc_common.h>
  39 #include <vlc_plugin.h>
  40 #include <vlc_sout.h>
  41 #include <vlc_block.h>
  42 #include <vlc_fs.h>
  43 #include <vlc_strings.h>
  44
  45 #if defined( WIN32 ) && !defined( UNDER_CE )
  46 #   include <io.h>
  47 #   define lseek _lseeki64
  48 #else
  49 #   include <unistd.h>
  50 #endif
  51
  52 #ifndef O_LARGEFILE
  53 #   define O_LARGEFILE 0
  54 #endif
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 static int  Open ( vlc_object_t * );
  60 static void Close( vlc_object_t * );
  61
  62 #define SOUT_CFG_PREFIX "sout-file-"
  63 #define APPEND_TEXT N_("Append to file")
  64 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
  65                             "of replacing it.")
  66 #define SYNC_TEXT N_("Synchronous writing")
  67 #define SYNC_LONGTEXT N_( "Open the file with synchronous writing.")
  68
  69 vlc_module_begin ()
  70     set_description( N_("File stream output") )
  71     set_shortname( N_("File" ))
  72     set_capability( "sout access", 50 )
  73     set_category( CAT_SOUT )
  74     set_subcategory( SUBCAT_SOUT_ACO )
  75     add_shortcut( "file", "stream" )
  76     add_bool( SOUT_CFG_PREFIX "append", false, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  77               true )
  78     add_bool( SOUT_CFG_PREFIX "sync", false, NULL, SYNC_TEXT,SYNC_LONGTEXT,
  79               false )
  80     set_callbacks( Open, Close )
  81 vlc_module_end ()
  82
  83
  84 /*****************************************************************************
  85  * Exported prototypes
  86  *****************************************************************************/
  87 static const char *const ppsz_sout_options[] = {
  88     "append", "sync", NULL
  89 };
  90
  91 static ssize_t Write( sout_access_out_t *, block_t * );
  92 static int Seek ( sout_access_out_t *, off_t  );
  93 static ssize_t Read ( sout_access_out_t *, block_t * );
  94 static int Control( sout_access_out_t *, int, va_list );
  95
  96 struct sout_access_out_sys_t
  97 {
  98     int i_handle;
  99 };
 100
 101 /*****************************************************************************
 102  * Open: open the file
 103  *****************************************************************************/
 104 static int Open( vlc_object_t *p_this )
 105 {
 106     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 107     int                 fd;
 108     bool                sync;
 109
 110     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 111
 112     if( !p_access->psz_path )
 113     {
 114         msg_Err( p_access, "no file name specified" );
 115         return VLC_EGENERIC;
 116     }
 117
 118     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 119     sync = var_GetBool( p_access, SOUT_CFG_PREFIX "sync" );
 120
 121     if( !strcmp( p_access->psz_path, "-" ) )
 122     {
 123 #ifndef UNDER_CE
 124 #ifdef WIN32
 125         setmode (fileno (stdout), O_BINARY);
 126 #endif
 127         fd = vlc_dup (fileno (stdout));
 128         msg_Dbg( p_access, "using stdout" );
 129 #else
 130 #warning stdout is not supported on Windows Mobile, but may be used on Windows CE
 131         fd = -1;
 132 #endif
 133     }
 134     else
 135     {
 136         char *psz_tmp = str_format( p_access, p_access->psz_path );
 137         path_sanitize( psz_tmp );
 138
 139         fd = vlc_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 140 #ifdef O_SYNC
 141                         (sync ? O_SYNC : 0) |
 142 #endif
 143                         (append ? 0 : O_TRUNC), 0666 );
 144         free( psz_tmp );
 145     }
 146
 147     if (fd == -1)
 148     {
 149         msg_Err( p_access, "cannot open `%s' (%m)", p_access->psz_path );
 150         return VLC_EGENERIC;
 151     }
 152
 153     p_access->pf_write = Write;
 154     p_access->pf_read  = Read;
 155     p_access->pf_seek  = Seek;
 156     p_access->pf_control = Control;
 157     p_access->p_sys    = (void *)(intptr_t)fd;
 158
 159     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 160     if (append)
 161         lseek (fd, 0, SEEK_END);
 162
 163     return VLC_SUCCESS;
 164 }
 165
 166 /*****************************************************************************
 167  * Close: close the target
 168  *****************************************************************************/
 169 static void Close( vlc_object_t * p_this )
 170 {
 171     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 172
 173     close( (intptr_t)p_access->p_sys );
 174
 175     msg_Dbg( p_access, "file access output closed" );
 176 }
 177
 178 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 179 {
 180     switch( i_query )
 181     {
 182         case ACCESS_OUT_CONTROLS_PACE:
 183         {
 184             bool *pb = va_arg( args, bool * );
 185             *pb = strcmp( p_access->psz_access, "stream" );
 186             break;
 187         }
 188
 189         default:
 190             return VLC_EGENERIC;
 191     }
 192     return VLC_SUCCESS;
 193 }
 194
 195 /*****************************************************************************
 196  * Read: standard read on a file descriptor.
 197  *****************************************************************************/
 198 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 199 {
 200     ssize_t val;
 201
 202     do
 203         val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 204                     p_buffer->i_buffer );
 205     while (val == -1 && errno == EINTR);
 206     return val;
 207 }
 208
 209 /*****************************************************************************
 210  * Write: standard write on a file descriptor.
 211  *****************************************************************************/
 212 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 213 {
 214     size_t i_write = 0;
 215
 216     while( p_buffer )
 217     {
 218         ssize_t val = write ((intptr_t)p_access->p_sys,
 219                              p_buffer->p_buffer, p_buffer->i_buffer);
 220         if (val == -1)
 221         {
 222             if (errno == EINTR)
 223                 continue;
 224             block_ChainRelease (p_buffer);
 225             return -1;
 226         }
 227
 228         if ((size_t)val >= p_buffer->i_buffer)
 229         {
 230             block_t *p_next = p_buffer->p_next;
 231             block_Release (p_buffer);
 232             p_buffer = p_next;
 233         }
 234         else
 235         {
 236             p_buffer->p_buffer += val;
 237             p_buffer->i_buffer -= val;
 238         }
 239         i_write += val;
 240     }
 241     return i_write;
 242 }
 243
 244 /*****************************************************************************
 245  * Seek: seek to a specific location in a file
 246  *****************************************************************************/
 247 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 248 {
 249     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 250 }