git.sesse.net Git - vlc/blob - modules/access_output/file.c

   1 /*****************************************************************************
   2  * file.c
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2002 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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
  38 #ifdef HAVE_UNISTD_H
  39 #   include <unistd.h>
  40 #elif defined( WIN32 ) && !defined( UNDER_CE )
  41 #   include <io.h>
  42 #endif
  43
  44 /* For those platforms that don't use these */
  45 #ifndef S_IRGRP
  46 #   define S_IRGRP 0
  47 #endif
  48 #ifndef S_IROTH
  49 #   define S_IROTH 0
  50 #endif
  51 #ifndef STDOUT_FILENO
  52 #   define STDOUT_FILENO 1
  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( N_("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     sout_CfgParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 106
 107     if( !( p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
 108     {
 109         msg_Err( p_access, "out of memory" );
 110         return( VLC_EGENERIC );
 111     }
 112
 113     if( !p_access->psz_name )
 114     {
 115         msg_Err( p_access, "no file name specified" );
 116         return VLC_EGENERIC;
 117     }
 118     i_flags = O_RDWR|O_CREAT;
 119
 120     var_Get( p_access, SOUT_CFG_PREFIX "append", &val );
 121     if( val.b_bool )
 122     {
 123         i_flags |= O_APPEND;
 124     }
 125     else
 126     {
 127         i_flags |= O_TRUNC;
 128     }
 129     if( !strcmp( p_access->psz_name, "-" ) )
 130     {
 131         p_access->p_sys->i_handle = STDOUT_FILENO;
 132         msg_Dbg( p_access, "using stdout" );
 133     }
 134     else if( ( p_access->p_sys->i_handle =
 135                open( p_access->psz_name, i_flags,
 136                      S_IWRITE | S_IREAD | S_IRGRP | S_IROTH ) ) == -1 )
 137     {
 138         msg_Err( p_access, "cannot open `%s'", p_access->psz_name );
 139         free( p_access->p_sys );
 140         return( VLC_EGENERIC );
 141     }
 142
 143     p_access->pf_write = Write;
 144     p_access->pf_read  = Read;
 145     p_access->pf_seek  = Seek;
 146
 147     msg_Dbg( p_access, "file access output opened (`%s')", p_access->psz_name );
 148
 149     /* Update pace control flag */
 150     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 151         p_access->p_sout->i_out_pace_nocontrol++;
 152
 153     return VLC_SUCCESS;
 154 }
 155
 156 /*****************************************************************************
 157  * Close: close the target
 158  *****************************************************************************/
 159 static void Close( vlc_object_t * p_this )
 160 {
 161     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 162
 163     if( strcmp( p_access->psz_name, "-" ) )
 164     {
 165         if( p_access->p_sys->i_handle )
 166         {
 167             close( p_access->p_sys->i_handle );
 168         }
 169     }
 170     free( p_access->p_sys );
 171
 172     /* Update pace control flag */
 173     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 174         p_access->p_sout->i_out_pace_nocontrol--;
 175
 176     msg_Dbg( p_access, "file access output closed" );
 177 }
 178
 179 /*****************************************************************************
 180  * Read: standard read on a file descriptor.
 181  *****************************************************************************/
 182 static int Read( sout_access_out_t *p_access, block_t *p_buffer )
 183 {
 184     if( strcmp( p_access->psz_name, "-" ) )
 185     {
 186         return read( p_access->p_sys->i_handle, p_buffer->p_buffer,
 187                      p_buffer->i_buffer );
 188     }
 189
 190     msg_Err( p_access, "cannot read while using stdout" );
 191     return VLC_EGENERIC;
 192 }
 193
 194 /*****************************************************************************
 195  * Write: standard write on a file descriptor.
 196  *****************************************************************************/
 197 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
 198 {
 199     size_t i_write = 0;
 200
 201     while( p_buffer )
 202     {
 203         block_t *p_next = p_buffer->p_next;;
 204
 205         i_write += write( p_access->p_sys->i_handle,
 206                           p_buffer->p_buffer, p_buffer->i_buffer );
 207         block_Release( p_buffer );
 208
 209         p_buffer = p_next;
 210     }
 211
 212     return i_write;
 213 }
 214
 215 /*****************************************************************************
 216  * Seek: seek to a specific location in a file
 217  *****************************************************************************/
 218 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 219 {
 220     if( strcmp( p_access->psz_name, "-" ) )
 221     {
 222 #if defined( WIN32 ) && !defined( UNDER_CE )
 223         return( _lseeki64( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 224 #else
 225         return( lseek( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 226 #endif
 227     }
 228     else
 229     {
 230         msg_Err( p_access, "cannot seek while using stdout" );
 231         return VLC_EGENERIC;
 232     }
 233 }