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