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