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