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