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