git.sesse.net Git - vlc/blob - 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 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <time.h>
  31 #include <fcntl.h>
  32 #include <errno.h>
  33
  34 #include <vlc/vlc.h>
  35 #include <vlc_sout.h>
  36 #include <vlc_block.h>
  37 #include <vlc_charset.h>
  38 #include "vlc_strings.h"
  39
  40 #ifdef HAVE_UNISTD_H
  41 #   include <unistd.h>
  42 #elif defined( WIN32 ) && !defined( UNDER_CE )
  43 #   include <io.h>
  44 #endif
  45
  46 /* For those platforms that don't use these */
  47 #ifndef STDOUT_FILENO
  48 #   define STDOUT_FILENO 1
  49 #endif
  50 #ifndef O_LARGEFILE
  51 #   define O_LARGEFILE 0
  52 #endif
  53
  54 /*****************************************************************************
  55  * Module descriptor
  56  *****************************************************************************/
  57 static int  Open ( vlc_object_t * );
  58 static void Close( vlc_object_t * );
  59
  60 #define SOUT_CFG_PREFIX "sout-file-"
  61 #define APPEND_TEXT N_("Append to file")
  62 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
  63                             "of replacing it.")
  64
  65 vlc_module_begin();
  66     set_description( _("File stream output") );
  67     set_shortname( _("File" ));
  68     set_capability( "sout access", 50 );
  69     set_category( CAT_SOUT );
  70     set_subcategory( SUBCAT_SOUT_ACO );
  71     add_shortcut( "file" );
  72     add_shortcut( "stream" );
  73     add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  74               VLC_TRUE );
  75     set_callbacks( Open, Close );
  76 vlc_module_end();
  77
  78
  79 /*****************************************************************************
  80  * Exported prototypes
  81  *****************************************************************************/
  82 static const char *ppsz_sout_options[] = {
  83     "append", NULL
  84 };
  85
  86 static int Write( sout_access_out_t *, block_t * );
  87 static int Seek ( sout_access_out_t *, off_t  );
  88 static int Read ( sout_access_out_t *, block_t * );
  89
  90 struct sout_access_out_sys_t
  91 {
  92     int i_handle;
  93 };
  94
  95 /*****************************************************************************
  96  * Open: open the file
  97  *****************************************************************************/
  98 static int Open( vlc_object_t *p_this )
  99 {
 100     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 101     int                 i_flags;
 102     vlc_value_t         val;
 103
 104     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 105
 106     if( !p_access->psz_path )
 107     {
 108         msg_Err( p_access, "no file name specified" );
 109         return VLC_EGENERIC;
 110     }
 111
 112     if( !( p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
 113     {
 114         return( VLC_ENOMEM );
 115     }
 116
 117     i_flags = O_RDWR|O_CREAT|O_LARGEFILE;
 118
 119     var_Get( p_access, SOUT_CFG_PREFIX "append", &val );
 120     i_flags |= val.b_bool ? O_APPEND : O_TRUNC;
 121
 122     if( !strcmp( p_access->psz_path, "-" ) )
 123     {
 124 #if defined(WIN32)
 125         setmode (STDOUT_FILENO, O_BINARY);
 126 #endif
 127         p_access->p_sys->i_handle = STDOUT_FILENO;
 128         msg_Dbg( p_access, "using stdout" );
 129     }
 130     else
 131     {
 132         int fd;
 133         char *psz_tmp = str_format( p_access, p_access->psz_path );
 134         path_sanitize( psz_tmp );
 135
 136         fd = utf8_open( psz_tmp, i_flags, 0666 );
 137         free( psz_tmp );
 138
 139         if( fd == -1 )
 140         {
 141             msg_Err( p_access, "cannot open `%s' (%s)", p_access->psz_path,
 142                      strerror( errno ) );
 143             free( p_access->p_sys );
 144             return( VLC_EGENERIC );
 145         }
 146         p_access->p_sys->i_handle = fd;
 147     }
 148
 149     p_access->pf_write = Write;
 150     p_access->pf_read  = Read;
 151     p_access->pf_seek  = Seek;
 152
 153     msg_Dbg( p_access, "file access output opened (`%s')", p_access->psz_path );
 154
 155     /* Update pace control flag */
 156     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 157         p_access->p_sout->i_out_pace_nocontrol++;
 158
 159     return VLC_SUCCESS;
 160 }
 161
 162 /*****************************************************************************
 163  * Close: close the target
 164  *****************************************************************************/
 165 static void Close( vlc_object_t * p_this )
 166 {
 167     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 168
 169     if( strcmp( p_access->psz_path, "-" ) )
 170     {
 171         if( p_access->p_sys->i_handle )
 172         {
 173             close( p_access->p_sys->i_handle );
 174         }
 175     }
 176     free( p_access->p_sys );
 177
 178     /* Update pace control flag */
 179     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 180         p_access->p_sout->i_out_pace_nocontrol--;
 181
 182     msg_Dbg( p_access, "file access output closed" );
 183 }
 184
 185 /*****************************************************************************
 186  * Read: standard read on a file descriptor.
 187  *****************************************************************************/
 188 static int Read( sout_access_out_t *p_access, block_t *p_buffer )
 189 {
 190     if( strcmp( p_access->psz_path, "-" ) )
 191     {
 192         return read( p_access->p_sys->i_handle, p_buffer->p_buffer,
 193                      p_buffer->i_buffer );
 194     }
 195
 196     msg_Err( p_access, "cannot read while using stdout" );
 197     return VLC_EGENERIC;
 198 }
 199
 200 /*****************************************************************************
 201  * Write: standard write on a file descriptor.
 202  *****************************************************************************/
 203 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
 204 {
 205     size_t i_write = 0;
 206
 207     while( p_buffer )
 208     {
 209         block_t *p_next = p_buffer->p_next;;
 210
 211         i_write += write( p_access->p_sys->i_handle,
 212                           p_buffer->p_buffer, p_buffer->i_buffer );
 213         block_Release( p_buffer );
 214
 215         p_buffer = p_next;
 216     }
 217
 218     return i_write;
 219 }
 220
 221 /*****************************************************************************
 222  * Seek: seek to a specific location in a file
 223  *****************************************************************************/
 224 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 225 {
 226     if( strcmp( p_access->psz_path, "-" ) )
 227     {
 228 #if defined( WIN32 ) && !defined( UNDER_CE )
 229         return( _lseeki64( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 230 #else
 231         return( lseek( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 232 #endif
 233     }
 234     else
 235     {
 236         msg_Err( p_access, "cannot seek while using stdout" );
 237         return VLC_EGENERIC;
 238     }
 239 }