Add a growl (http://growl.info/) notification plugin (most of code from msn.c)
[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 <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 #ifndef O_LARGEFILE
55 #   define O_LARGEFILE 0
56 #endif
57
58 /*****************************************************************************
59  * Module descriptor
60  *****************************************************************************/
61 static int  Open ( vlc_object_t * );
62 static void Close( vlc_object_t * );
63
64 #define SOUT_CFG_PREFIX "sout-file-"
65 #define APPEND_TEXT N_("Append to file")
66 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
67                             "of replacing it.")
68
69 vlc_module_begin();
70     set_description( _("File stream output") );
71     set_shortname( N_("File" ));
72     set_capability( "sout access", 50 );
73     set_category( CAT_SOUT );
74     set_subcategory( SUBCAT_SOUT_ACO );
75     add_shortcut( "file" );
76     add_shortcut( "stream" );
77     add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
78               VLC_TRUE );
79     set_callbacks( Open, Close );
80 vlc_module_end();
81
82
83 /*****************************************************************************
84  * Exported prototypes
85  *****************************************************************************/
86 static const char *ppsz_sout_options[] = {
87     "append", NULL
88 };
89
90 static int Write( sout_access_out_t *, block_t * );
91 static int Seek ( sout_access_out_t *, off_t  );
92 static int Read ( sout_access_out_t *, block_t * );
93
94 struct sout_access_out_sys_t
95 {
96     int i_handle;
97 };
98
99 /*****************************************************************************
100  * Open: open the file
101  *****************************************************************************/
102 static int Open( vlc_object_t *p_this )
103 {
104     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
105     int                 i_flags;
106     vlc_value_t         val;
107
108     sout_CfgParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
109
110     if( !( p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
111     {
112         msg_Err( p_access, "out of memory" );
113         return( VLC_EGENERIC );
114     }
115
116     if( !p_access->psz_name )
117     {
118         msg_Err( p_access, "no file name specified" );
119         return VLC_EGENERIC;
120     }
121     i_flags = O_RDWR|O_CREAT|O_LARGEFILE;
122
123     var_Get( p_access, SOUT_CFG_PREFIX "append", &val );
124     if( val.b_bool )
125     {
126         i_flags |= O_APPEND;
127     }
128     else
129     {
130         i_flags |= O_TRUNC;
131     }
132     if( !strcmp( p_access->psz_name, "-" ) )
133     {
134 #if defined(WIN32)
135         setmode (STDOUT_FILENO, O_BINARY);
136 #endif
137         p_access->p_sys->i_handle = STDOUT_FILENO;
138         msg_Dbg( p_access, "using stdout" );
139     }
140     else if( ( p_access->p_sys->i_handle =
141                open( p_access->psz_name, i_flags,
142                      S_IWRITE | S_IREAD | S_IRGRP | S_IROTH ) ) == -1 )
143     {
144         msg_Err( p_access, "cannot open `%s'", p_access->psz_name );
145         free( p_access->p_sys );
146         return( VLC_EGENERIC );
147     }
148
149     p_access->pf_write = Write;
150     p_access->pf_read  = Read;
151     p_access->pf_seek  = Seek;
152
153     msg_Dbg( p_access, "file access output opened (`%s')", p_access->psz_name );
154
155     /* Update pace control flag */
156     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
157         p_access->p_sout->i_out_pace_nocontrol++;
158
159     return VLC_SUCCESS;
160 }
161
162 /*****************************************************************************
163  * Close: close the target
164  *****************************************************************************/
165 static void Close( vlc_object_t * p_this )
166 {
167     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
168
169     if( strcmp( p_access->psz_name, "-" ) )
170     {
171         if( p_access->p_sys->i_handle )
172         {
173             close( p_access->p_sys->i_handle );
174         }
175     }
176     free( p_access->p_sys );
177
178     /* Update pace control flag */
179     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
180         p_access->p_sout->i_out_pace_nocontrol--;
181
182     msg_Dbg( p_access, "file access output closed" );
183 }
184
185 /*****************************************************************************
186  * Read: standard read on a file descriptor.
187  *****************************************************************************/
188 static int Read( sout_access_out_t *p_access, block_t *p_buffer )
189 {
190     if( strcmp( p_access->psz_name, "-" ) )
191     {
192         return read( p_access->p_sys->i_handle, p_buffer->p_buffer,
193                      p_buffer->i_buffer );
194     }
195
196     msg_Err( p_access, "cannot read while using stdout" );
197     return VLC_EGENERIC;
198 }
199
200 /*****************************************************************************
201  * Write: standard write on a file descriptor.
202  *****************************************************************************/
203 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
204 {
205     size_t i_write = 0;
206
207     while( p_buffer )
208     {
209         block_t *p_next = p_buffer->p_next;;
210
211         i_write += write( p_access->p_sys->i_handle,
212                           p_buffer->p_buffer, p_buffer->i_buffer );
213         block_Release( p_buffer );
214
215         p_buffer = p_next;
216     }
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     if( strcmp( p_access->psz_name, "-" ) )
227     {
228 #if defined( WIN32 ) && !defined( UNDER_CE )
229         return( _lseeki64( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
230 #else
231         return( lseek( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
232 #endif
233     }
234     else
235     {
236         msg_Err( p_access, "cannot seek while using stdout" );
237         return VLC_EGENERIC;
238     }
239 }