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
  67 vlc_module_begin ()
  68     set_description( N_("File stream output") )
  69     set_shortname( N_("File" ))
  70     set_capability( "sout access", 50 )
  71     set_category( CAT_SOUT )
  72     set_subcategory( SUBCAT_SOUT_ACO )
  73     add_shortcut( "file" )
  74     add_shortcut( "stream" )
  75     add_bool( SOUT_CFG_PREFIX "append", false, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  76               true )
  77     set_callbacks( Open, Close )
  78 vlc_module_end ()
  79
  80
  81 /*****************************************************************************
  82  * Exported prototypes
  83  *****************************************************************************/
  84 static const char *const ppsz_sout_options[] = {
  85     "append", NULL
  86 };
  87
  88 static ssize_t Write( sout_access_out_t *, block_t * );
  89 static int Seek ( sout_access_out_t *, off_t  );
  90 static ssize_t Read ( sout_access_out_t *, block_t * );
  91 static int Control( sout_access_out_t *, int, va_list );
  92
  93 struct sout_access_out_sys_t
  94 {
  95     int i_handle;
  96 };
  97
  98 /*****************************************************************************
  99  * Open: open the file
 100  *****************************************************************************/
 101 static int Open( vlc_object_t *p_this )
 102 {
 103     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 104     int                 fd;
 105
 106     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 107
 108     if( !p_access->psz_path )
 109     {
 110         msg_Err( p_access, "no file name specified" );
 111         return VLC_EGENERIC;
 112     }
 113
 114     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 115
 116     if( !strcmp( p_access->psz_path, "-" ) )
 117     {
 118 #ifndef UNDER_CE
 119 #ifdef WIN32
 120         setmode (fileno (stdout), O_BINARY);
 121 #endif
 122         fd = vlc_dup (fileno (stdout));
 123         msg_Dbg( p_access, "using stdout" );
 124 #else
 125 #warning stdout is not supported on Windows Mobile, but may be used on Windows CE
 126         fd = -1;
 127 #endif
 128     }
 129     else
 130     {
 131         char *psz_tmp = str_format( p_access, p_access->psz_path );
 132         path_sanitize( psz_tmp );
 133
 134         fd = vlc_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 135                         (append ? 0 : O_TRUNC), 0666 );
 136         free( psz_tmp );
 137     }
 138
 139     if (fd == -1)
 140     {
 141         msg_Err( p_access, "cannot open `%s' (%m)", p_access->psz_path );
 142         return VLC_EGENERIC;
 143     }
 144
 145     p_access->pf_write = Write;
 146     p_access->pf_read  = Read;
 147     p_access->pf_seek  = Seek;
 148     p_access->pf_control = Control;
 149     p_access->p_sys    = (void *)(intptr_t)fd;
 150
 151     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 152     if (append)
 153         lseek (fd, 0, SEEK_END);
 154
 155     return VLC_SUCCESS;
 156 }
 157
 158 /*****************************************************************************
 159  * Close: close the target
 160  *****************************************************************************/
 161 static void Close( vlc_object_t * p_this )
 162 {
 163     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 164
 165     close( (intptr_t)p_access->p_sys );
 166
 167     msg_Dbg( p_access, "file access output closed" );
 168 }
 169
 170 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 171 {
 172     switch( i_query )
 173     {
 174         case ACCESS_OUT_CONTROLS_PACE:
 175         {
 176             bool *pb = va_arg( args, bool * );
 177             *pb = strcmp( p_access->psz_access, "stream" );
 178             break;
 179         }
 180
 181         default:
 182             return VLC_EGENERIC;
 183     }
 184     return VLC_SUCCESS;
 185 }
 186
 187 /*****************************************************************************
 188  * Read: standard read on a file descriptor.
 189  *****************************************************************************/
 190 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 191 {
 192     ssize_t val;
 193
 194     do
 195         val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 196                     p_buffer->i_buffer );
 197     while (val == -1 && errno == EINTR);
 198     return val;
 199 }
 200
 201 /*****************************************************************************
 202  * Write: standard write on a file descriptor.
 203  *****************************************************************************/
 204 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 205 {
 206     size_t i_write = 0;
 207
 208     while( p_buffer )
 209     {
 210         ssize_t val = write ((intptr_t)p_access->p_sys,
 211                              p_buffer->p_buffer, p_buffer->i_buffer);
 212         if (val == -1)
 213         {
 214             if (errno == EINTR)
 215                 continue;
 216             block_ChainRelease (p_buffer);
 217             return -1;
 218         }
 219
 220         if ((size_t)val >= p_buffer->i_buffer)
 221         {
 222             block_t *p_next = p_buffer->p_next;
 223             block_Release (p_buffer);
 224             p_buffer = p_next;
 225         }
 226         else
 227         {
 228             p_buffer->p_buffer += val;
 229             p_buffer->i_buffer -= val;
 230         }
 231         i_write += val;
 232     }
 233     return i_write;
 234 }
 235
 236 /*****************************************************************************
 237  * Seek: seek to a specific location in a file
 238  *****************************************************************************/
 239 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 240 {
 241     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 242 }