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