String fixes
[vlc.git] / modules / access / tcp.c
1 /*****************************************************************************
2  * tcp.c: TCP input module
3  *****************************************************************************
4  * Copyright (C) 2003-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>
28
29 #include <vlc/vlc.h>
30 #include <vlc/input.h>
31
32 #include "network.h"
33
34 /*****************************************************************************
35  * Module descriptor
36  *****************************************************************************/
37 #define CACHING_TEXT N_("Caching value in ms")
38 #define CACHING_LONGTEXT N_( \
39     "Caching value for TCP streams. This " \
40     "value should be set in milliseconds." )
41
42 static int  Open ( vlc_object_t * );
43 static void Close( vlc_object_t * );
44
45 vlc_module_begin();
46     set_shortname( _("TCP") );
47     set_description( _("TCP input") );
48     set_category( CAT_INPUT );
49     set_subcategory( SUBCAT_INPUT_ACCESS );
50
51     add_integer( "tcp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
52                  CACHING_LONGTEXT, VLC_TRUE );
53
54     set_capability( "access2", 0 );
55     add_shortcut( "tcp" );
56     set_callbacks( Open, Close );
57 vlc_module_end();
58
59 /*****************************************************************************
60  * Local prototypes
61  *****************************************************************************/
62 struct access_sys_t
63 {
64     int        fd;
65 };
66
67
68 static int Read( access_t *, uint8_t *, int );
69 static int Control( access_t *, int, va_list );
70
71 /*****************************************************************************
72  * Open: open the socket
73  *****************************************************************************/
74 static int Open( vlc_object_t *p_this )
75 {
76     access_t     *p_access = (access_t *)p_this;
77     access_sys_t *p_sys;
78
79     char         *psz_dup = strdup(p_access->psz_path);
80     char         *psz_parser = psz_dup;
81
82     /* Parse server:port */
83     if( *psz_parser == '[' )
84     {
85         psz_parser = strchr( psz_parser, ']' );
86         if( psz_parser == NULL )
87             psz_parser = psz_dup;
88     }
89     psz_parser = strchr( psz_parser, ':' );
90
91     if( psz_parser == NULL )
92     {
93         msg_Err( p_access, "missing port number : %s", psz_dup );
94         free( psz_dup );
95         return VLC_EGENERIC;
96     }
97
98     *psz_parser++ = '\0';
99
100     /* Init p_access */
101     p_access->pf_read = Read;
102     p_access->pf_block = NULL;
103     p_access->pf_control = Control;
104     p_access->pf_seek = NULL;
105     p_access->info.i_update = 0;
106     p_access->info.i_size = 0;
107     p_access->info.i_pos = 0;
108     p_access->info.b_eof = VLC_FALSE;
109     p_access->info.i_title = 0;
110     p_access->info.i_seekpoint = 0;
111     p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
112
113     p_sys->fd = net_ConnectTCP( p_access, psz_dup, atoi( psz_parser ) );
114     free( psz_dup );
115
116     if( p_sys->fd < 0 )
117     {
118         free( p_sys );
119         return VLC_EGENERIC;
120     }
121
122     /* Update default_pts to a suitable value for udp access */
123     var_Create( p_access, "tcp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
124
125     return VLC_SUCCESS;
126 }
127
128 /*****************************************************************************
129  * Close: free unused data structures
130  *****************************************************************************/
131 static void Close( vlc_object_t *p_this )
132 {
133     access_t     *p_access = (access_t *)p_this;
134     access_sys_t *p_sys = p_access->p_sys;
135
136     net_Close( p_sys->fd );
137     free( p_sys );
138 }
139
140 /*****************************************************************************
141  * Read: read on a file descriptor, checking b_die periodically
142  *****************************************************************************/
143 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
144 {
145     access_sys_t *p_sys = p_access->p_sys;
146     int i_read;
147
148     if( p_access->info.b_eof )
149         return 0;
150
151     i_read = net_Read( p_access, p_sys->fd, NULL, p_buffer, i_len,
152                        VLC_FALSE );
153     if( i_read == 0 )
154         p_access->info.b_eof = VLC_TRUE;
155     else if( i_read > 0 )
156         p_access->info.i_pos += i_read;
157
158     return i_read;
159 }
160
161 /*****************************************************************************
162  * Control:
163  *****************************************************************************/
164 static int Control( access_t *p_access, int i_query, va_list args )
165 {
166     vlc_bool_t   *pb_bool;
167     int          *pi_int;
168     int64_t      *pi_64;
169
170     switch( i_query )
171     {
172         /* */
173         case ACCESS_CAN_SEEK:
174         case ACCESS_CAN_FASTSEEK:
175             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
176             *pb_bool = VLC_FALSE;
177             break;
178         case ACCESS_CAN_PAUSE:
179             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
180             *pb_bool = VLC_TRUE;    /* FIXME */
181             break;
182         case ACCESS_CAN_CONTROL_PACE:
183             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
184             *pb_bool = VLC_TRUE;    /* FIXME */
185             break;
186
187         /* */
188         case ACCESS_GET_MTU:
189             pi_int = (int*)va_arg( args, int * );
190             *pi_int = 0;
191             break;
192
193         case ACCESS_GET_PTS_DELAY:
194             pi_64 = (int64_t*)va_arg( args, int64_t * );
195             *pi_64 = (int64_t)var_GetInteger( p_access, "tcp-caching" ) * I64C(1000);
196             break;
197
198         /* */
199         case ACCESS_SET_PAUSE_STATE:
200             /* Nothing to do */
201             break;
202
203         case ACCESS_GET_TITLE_INFO:
204         case ACCESS_SET_TITLE:
205         case ACCESS_SET_SEEKPOINT:
206         case ACCESS_SET_PRIVATE_ID_STATE:
207             return VLC_EGENERIC;
208
209         default:
210             msg_Warn( p_access, "unimplemented query in control" );
211             return VLC_EGENERIC;
212
213     }
214     return VLC_SUCCESS;
215 }