31f375d8c2bb55d5764b97153264d53b5e1d34ed
[vlc.git] / modules / access / bda / bda.c
1 /*****************************************************************************
2  * bda.c : BDA access module for vlc
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  *
6  * Author: Ken Self <kens@campoz.fslife.co.uk>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #include "bda.h"
27
28 /*****************************************************************************
29  * Access: local prototypes
30  *****************************************************************************/
31 static int  Open( vlc_object_t *p_this );
32 static int  ParsePath( access_t *p_access, const char* psz_module,
33     const int i_param_count, const char** psz_param, const int* i_type );
34 static void Close( vlc_object_t *p_this );
35 static block_t *Block( access_t * );
36 static int Control( access_t *, int, va_list );
37
38
39 #define CACHING_TEXT N_("Caching value in ms")
40 #define CACHING_LONGTEXT N_( \
41     "Caching value for DVB streams. This " \
42     "value should be set in milliseconds." )
43
44 #define ADAPTER_TEXT N_("Adapter card to tune")
45 #define ADAPTER_LONGTEXT N_("Adapter cards have a device file in directory " \
46     "named /dev/dvb/adapter[n] with n>=0.")
47
48 #define DEVICE_TEXT N_("Device number to use on adapter")
49 #define DEVICE_LONGTEXT ""
50
51 #define FREQ_TEXT N_("Transponder/multiplex frequency")
52 #if defined(WIN32) || defined(WINCE)
53 #    define FREQ_LONGTEXT N_("In kHz for DVB-S or Hz for DVB-C/T")
54 #else
55 #    define FREQ_LONGTEXT N_("In kHz for DVB-C/S/T")
56 #endif
57
58 #define INVERSION_TEXT N_("Inversion mode")
59 #define INVERSION_LONGTEXT N_("Inversion mode [0=off, 1=on, 2=auto]")
60
61 #define PROBE_TEXT N_("Probe DVB card for capabilities")
62 #define PROBE_LONGTEXT N_("Some DVB cards do not like to be probed for their " \
63     "capabilities, you can disable this feature if you experience some " \
64     "trouble.")
65
66 #define BUDGET_TEXT N_("Budget mode")
67 #define BUDGET_LONGTEXT N_("This allows you to stream an entire transponder " \
68     "with a \"budget\" card.")
69
70 /* Satellite */
71 #define SATNO_TEXT N_("Satellite number in the Diseqc system")
72 #define SATNO_LONGTEXT N_("[0=no diseqc, 1-4=satellite number].")
73
74 #define VOLTAGE_TEXT N_("LNB voltage")
75 #define VOLTAGE_LONGTEXT N_("In Volts [0, 13=vertical, 18=horizontal].")
76
77 #define HIGH_VOLTAGE_TEXT N_("High LNB voltage")
78 #define HIGH_VOLTAGE_LONGTEXT N_("Enable high voltage if your cables are " \
79     "particularly long. This is not supported by all frontends.")
80
81 #define TONE_TEXT N_("22 kHz tone")
82 #define TONE_LONGTEXT N_("[0=off, 1=on, -1=auto].")
83
84 #define FEC_TEXT N_("Transponder FEC")
85 #define FEC_LONGTEXT N_("FEC=Forward Error Correction mode [9=auto].")
86
87 #define SRATE_TEXT N_("Transponder symbol rate in kHz")
88 #define SRATE_LONGTEXT ""
89
90 #define LNB_LOF1_TEXT N_("Antenna lnb_lof1 (kHz)")
91 #define LNB_LOF1_LONGTEXT ""
92
93 #define LNB_LOF2_TEXT N_("Antenna lnb_lof2 (kHz)")
94 #define LNB_LOF2_LONGTEXT ""
95
96 #define LNB_SLOF_TEXT N_("Antenna lnb_slof (kHz)")
97 #define LNB_SLOF_LONGTEXT ""
98
99 /* Cable */
100 #define MODULATION_TEXT N_("Modulation type")
101 #define MODULATION_LONGTEXT N_("QAM constellation points " \
102     "[16, 32, 64, 128, 256]")
103 static const int i_qam_list[] = { -1, 16, 32, 64, 128, 256 };
104 static const char *ppsz_qam_text[] = { N_("Undefined"), N_("16"), N_("32"),
105     N_("64"), N_("128"), N_("256") };
106
107 /* Terrestrial */
108 #define CODE_RATE_HP_TEXT N_("Terrestrial high priority stream code rate (FEC)")
109 #define CODE_RATE_HP_LONGTEXT ""
110
111 #define CODE_RATE_LP_TEXT N_("Terrestrial low priority stream code rate (FEC)")
112 #define CODE_RATE_LP_LONGTEXT ""
113
114 #define BANDWIDTH_TEXT N_("Terrestrial bandwidth")
115 #define BANDWIDTH_LONGTEXT N_("Terrestrial bandwidth [0=auto,6,7,8 in MHz]")
116 static const int i_band_list[] = { -1, 6, 7, 8 };
117 static const char *ppsz_band_text[] = { N_("Undefined"), N_("6"), N_("7"),
118     N_("8") };
119
120 #define GUARD_TEXT N_("Terrestrial guard interval")
121 #define GUARD_LONGTEXT ""
122
123 #define TRANSMISSION_TEXT N_("Terrestrial transmission mode")
124 #define TRANSMISSION_LONGTEXT ""
125
126 #define HIERARCHY_TEXT N_("Terrestrial hierarchy mode")
127 #define HIERARCHY_LONGTEXT ""
128
129 /* BDA module additional DVB-S Parameters */
130 #define AZIMUTH_TEXT N_("Satellite Azimuth")
131 #define AZIMUTH_LONGTEXT N_("Satellite Azimuth in tenths of degree")
132 #define ELEVATION_TEXT N_("Satellite Elevation")
133 #define ELEVATION_LONGTEXT N_("Satellite Elevation in tenths of degree")
134 #define LONGITUDE_TEXT N_("Satellite Longitude")
135 #define LONGITUDE_LONGTEXT N_( \
136     "Satellite Longitude in 10ths of degree, -ve=West")
137 #define POLARISATION_TEXT N_("Satellite Polarisation")
138 #define POLARISATION_LONGTEXT N_("Satellite Polarisation [H/V/L/R]")
139 static const char *ppsz_polar_list[] = { "H", "V", "L", "R" };
140 static const char *ppsz_polar_text[] = { N_("Horizontal"), N_("Vertical"),
141     N_("Circular Left"), N_("Circular Right") };
142
143 vlc_module_begin();
144     set_shortname( _("DVB") );
145     set_description( _("DirectShow DVB input") );
146     set_category( CAT_INPUT );
147     set_subcategory( SUBCAT_INPUT_ACCESS );
148
149     add_integer( "dvb-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
150                  CACHING_LONGTEXT, VLC_TRUE );
151     add_integer( "dvb-frequency", 11954000, NULL, FREQ_TEXT, FREQ_LONGTEXT,
152                  VLC_FALSE );
153 #   if defined(WIN32) || defined(WINCE)
154 #   else
155         add_integer( "dvb-adapter", 0, NULL, ADAPTER_TEXT, ADAPTER_LONGTEXT,
156                      VLC_FALSE );
157         add_integer( "dvb-device", 0, NULL, DEVICE_TEXT, DEVICE_LONGTEXT,
158                      VLC_TRUE );
159         add_integer( "dvb-inversion", 2, NULL, INVERSION_TEXT,
160             INVERSION_LONGTEXT, VLC_TRUE );
161         add_bool( "dvb-probe", 1, NULL, PROBE_TEXT, PROBE_LONGTEXT, VLC_TRUE );
162         add_bool( "dvb-budget-mode", 0, NULL, BUDGET_TEXT, BUDGET_LONGTEXT,
163                   VLC_TRUE );
164 #   endif
165
166     /* DVB-S (satellite) */
167 #   if defined(WIN32) || defined(WINCE)
168         add_integer( "dvb-azimuth", 0, NULL, AZIMUTH_TEXT, AZIMUTH_LONGTEXT,
169             VLC_FALSE );
170         add_integer( "dvb-elevation", 0, NULL, ELEVATION_TEXT,
171             ELEVATION_LONGTEXT, VLC_FALSE );
172         add_integer( "dvb-longitude", 0, NULL, LONGITUDE_TEXT,
173             LONGITUDE_LONGTEXT, VLC_FALSE );
174         add_string( "dvb-polarisation", NULL, NULL, POLARISATION_TEXT,
175             POLARISATION_LONGTEXT, VLC_FALSE );
176             change_string_list( ppsz_polar_list, ppsz_polar_text, 0 );
177             /* Note: Polaristion H = voltage 18; V = voltage 13; */
178 #   else
179         add_integer( "dvb-satno", 0, NULL, SATNO_TEXT, SATNO_LONGTEXT,
180             VLC_TRUE );
181         add_integer( "dvb-voltage", 13, NULL, VOLTAGE_TEXT, VOLTAGE_LONGTEXT,
182             VLC_TRUE );
183         add_bool( "dvb-high-voltage", 0, NULL, HIGH_VOLTAGE_TEXT,
184             HIGH_VOLTAGE_LONGTEXT, VLC_TRUE );
185         add_integer( "dvb-tone", -1, NULL, TONE_TEXT, TONE_LONGTEXT,
186             VLC_TRUE );
187         add_integer( "dvb-lnb-lof1", 0, NULL, LNB_LOF1_TEXT,
188             LNB_LOF1_LONGTEXT, VLC_TRUE );
189         add_integer( "dvb-lnb-lof2", 0, NULL, LNB_LOF2_TEXT,
190             LNB_LOF2_LONGTEXT, VLC_TRUE );
191         add_integer( "dvb-lnb-slof", 0, NULL, LNB_SLOF_TEXT,
192             LNB_SLOF_LONGTEXT, VLC_TRUE );
193 #   endif
194     add_integer( "dvb-fec", 9, NULL, FEC_TEXT, FEC_LONGTEXT, VLC_TRUE );
195     add_integer( "dvb-srate", 27500000, NULL, SRATE_TEXT, SRATE_LONGTEXT,
196         VLC_FALSE );
197
198     /* DVB-C (cable) */
199     add_integer( "dvb-modulation", 0, NULL, MODULATION_TEXT,
200         MODULATION_LONGTEXT, VLC_TRUE );
201         change_integer_list( i_qam_list, ppsz_qam_text, 0 );
202
203     /* DVB-T (terrestrial) */
204     add_integer( "dvb-code-rate-hp", 9, NULL, CODE_RATE_HP_TEXT,
205         CODE_RATE_HP_LONGTEXT, VLC_TRUE );
206     add_integer( "dvb-code-rate-lp", 9, NULL, CODE_RATE_LP_TEXT,
207         CODE_RATE_LP_LONGTEXT, VLC_TRUE );
208     add_integer( "dvb-bandwidth", 0, NULL, BANDWIDTH_TEXT, BANDWIDTH_LONGTEXT,
209         VLC_TRUE );
210         change_integer_list( i_band_list, ppsz_band_text, 0 );
211     add_integer( "dvb-guard", 0, NULL, GUARD_TEXT, GUARD_LONGTEXT, VLC_TRUE );
212     add_integer( "dvb-transmission", 0, NULL, TRANSMISSION_TEXT,
213         TRANSMISSION_LONGTEXT, VLC_TRUE );
214     add_integer( "dvb-hierarchy", 0, NULL, HIERARCHY_TEXT, HIERARCHY_LONGTEXT,
215         VLC_TRUE );
216
217     set_capability( "access2", 0 );
218     add_shortcut( "dvb" );      /* Generic name */
219
220     add_shortcut( "dvb-s" );    /* Satellite */
221     add_shortcut( "qpsk" );
222     add_shortcut( "satellite" );
223
224     add_shortcut( "dvb-c" );    /* Cable */
225     add_shortcut( "cable" );
226
227     add_shortcut( "dvb-t" );    /* Terrestrial */
228     add_shortcut( "terrestrial" );
229
230     add_shortcut( "atsc" );     /* Atsc */
231     add_shortcut( "usdigital" );
232
233     set_callbacks( Open, Close );
234 vlc_module_end();
235
236
237 /*****************************************************************************
238  * Open: open direct show device as an access module
239  *****************************************************************************/
240 static int Open( vlc_object_t *p_this )
241 {
242     access_t     *p_access = (access_t*)p_this;
243     access_sys_t *p_sys;
244     const char* psz_module  = "dvb";
245     const int   i_param_count = 9;
246     const char* psz_param[] = { "frequency", "bandwidth",
247         "srate", "azimuth", "elevation", "longitude", "polarisation",
248         "modulation", "caching" };
249
250     const int   i_type[] = { VLC_VAR_INTEGER, VLC_VAR_INTEGER,
251         VLC_VAR_INTEGER, VLC_VAR_INTEGER, VLC_VAR_INTEGER, VLC_VAR_INTEGER,
252         VLC_VAR_STRING, VLC_VAR_INTEGER, VLC_VAR_INTEGER };
253
254     char  psz_full_name[128];
255     int i_ret;
256
257    /* Only if selected */
258     if( *p_access->psz_access == '\0' )
259         return VLC_EGENERIC;
260
261     /* Setup Access */
262     p_access->pf_read = NULL;
263     p_access->pf_block = Block;     /* Function to read compressed data */
264     p_access->pf_control = Control; /* Function to control the module */
265     p_access->pf_seek = NULL;
266     p_access->info.i_update = 0;
267     p_access->info.i_size = 0;
268     p_access->info.i_pos = 0;
269     p_access->info.b_eof = VLC_FALSE;
270     p_access->info.i_title = 0;
271     p_access->info.i_seekpoint = 0;
272     p_access->p_sys = p_sys = (access_sys_t *)malloc( sizeof( access_sys_t ) );
273     if( !p_sys )
274         return VLC_ENOMEM;
275
276     memset( p_sys, 0, sizeof( access_sys_t ) );
277
278     for( int i = 0; i < i_param_count; i++ )
279     {
280         snprintf( psz_full_name, 128, "%s-%s\0", psz_module,
281                   psz_param[i] );
282         var_Create( p_access, psz_full_name, i_type[i] | VLC_VAR_DOINHERIT );
283     }
284
285     /* Parse the command line */
286     if( ParsePath( p_access, psz_module, i_param_count, psz_param, i_type ) )
287     {
288         free( p_sys );
289         return VLC_EGENERIC;
290     }
291
292     /* Build directshow graph */
293     dvb_newBDAGraph( p_access );
294
295     i_ret = VLC_EGENERIC;
296
297     if( strncmp( p_access->psz_access, "qpsk", 4 ) == 0 ||
298         strncmp( p_access->psz_access, "dvb-s", 5 ) == 0 ||
299         strncmp( p_access->psz_access, "satellite", 9 ) == 0 )
300     {
301         i_ret = dvb_SubmitDVBSTuneRequest( p_access );
302     }
303     if( strncmp( p_access->psz_access, "cable", 5 ) == 0 ||
304         strncmp( p_access->psz_access, "dvb-c", 5 ) == 0 )
305     {
306         i_ret = dvb_SubmitDVBCTuneRequest( p_access );
307     }
308     if( strncmp( p_access->psz_access, "terrestrial", 11 ) == 0 ||
309         strncmp( p_access->psz_access, "dvb-t", 5 ) == 0 )
310     {
311         i_ret = dvb_SubmitDVBTTuneRequest( p_access );
312     }
313     if( strncmp( p_access->psz_access, "usdigital", 9 ) == 0 ||
314         strncmp( p_access->psz_access, "atsc", 4 ) == 0 )
315     {
316         i_ret = dvb_SubmitATSCTuneRequest( p_access );
317     }
318
319     if( i_ret != VLC_SUCCESS )
320         msg_Warn( p_access, "DVB_Open: Unsupported Network %s",
321             p_access->psz_access);
322     return i_ret;
323 }
324
325 /*****************************************************************************
326  * ParsePath:
327  * Parses the path passed to VLC treating it as a MRL which
328  * is organized as a sequence of <key>=<value> pairs separated by a colon
329  * e.g. :key1=value1:key2=value2:key3=value3.
330  * Each <key> is matched to one of the parameters passed in psz_param using
331  * whatever characters are provided. e.g. fr = fre = frequency
332  *****************************************************************************/
333 static int ParsePath( access_t *p_access, const char* psz_module,
334     const int i_param_count, const char** psz_param, const int* i_type )
335 {
336     const int   MAXPARAM = 20;
337     BOOL        b_used[MAXPARAM];
338     char*       psz_parser;
339     char*       psz_token;
340     char*       psz_value;
341     vlc_value_t v_value;
342     int         i_token_len, i_param_len, i_this_param;
343     char        psz_full_name[128];
344
345     if( i_param_count > MAXPARAM )
346     {
347         msg_Warn( p_access, "ParsePath: Too many parameters: %d > %d",
348             i_param_count, MAXPARAM );
349             return VLC_EGENERIC;
350     }
351     for( int i = 0; i < i_param_count; i++ )
352         b_used[i] = FALSE;
353     psz_parser = p_access->psz_path;
354     if( strlen( psz_parser ) <= 0 )
355         return VLC_SUCCESS;
356
357     i_token_len = strcspn( psz_parser, ":" );
358     if( i_token_len <= 0 )
359         i_token_len  = strcspn( ++psz_parser, ":" );
360  
361     do
362     {
363         psz_token = strndup( psz_parser, i_token_len );
364         i_param_len  = strcspn( psz_token, "=" );
365         if( i_param_len <= 0 )
366         {
367             msg_Warn( p_access, "ParsePath: Unspecified parameter %s",
368                 psz_token );
369             if( psz_token )
370                 free( psz_token );
371             return VLC_EGENERIC;
372         }
373         i_this_param = -1;
374         for( int i = 0; i < i_param_count; i++ )
375         {
376             if( strncmp( psz_token, psz_param[i], i_param_len ) == 0 )
377             {
378                 i_this_param = i;
379                 break;
380             }
381         }
382         if( i_this_param < 0 )
383         {
384             msg_Warn( p_access, "ParsePath: Unknown parameter %s", psz_token );
385             if( psz_token )
386                 free( psz_token );
387             return VLC_EGENERIC;
388         }
389         if( b_used[i_this_param] )
390         {
391             msg_Warn( p_access, "ParsePath: Duplicate parameter %s",
392                 psz_token );
393             if( psz_token )
394                 free( psz_token );
395             return VLC_EGENERIC;
396         }
397         b_used[i_this_param] = TRUE;
398
399         /* if "=" was found in token then value starts at 
400          * psz_token + i_paramlen + 1
401          * else there is no value specified so we use an empty string */
402         psz_value = psz_token + i_param_len + 1;
403         if( i_param_len >= i_token_len )
404             psz_value--;
405         if( i_type[i_this_param] == VLC_VAR_STRING )
406              v_value.psz_string = strdup( psz_value );
407         if( i_type[i_this_param] == VLC_VAR_INTEGER )
408              v_value.i_int = atol( psz_value );
409         snprintf( psz_full_name, 128, "%s-%s\0", psz_module,
410             psz_param[i_this_param] );
411         var_Set( p_access, psz_full_name, v_value );
412
413         if( psz_token )
414             free( psz_token );
415         if( i_token_len >= strlen( psz_parser ) )
416             break;
417         psz_parser += i_token_len + 1;
418         i_token_len = strcspn( psz_parser, ":" );
419     }
420     while( TRUE );
421     return VLC_SUCCESS;
422 }
423
424 /*****************************************************************************
425  * AccessClose: close device
426  *****************************************************************************/
427 static void Close( vlc_object_t *p_this )
428 {
429     access_t     *p_access = (access_t *)p_this;
430     access_sys_t *p_sys    = p_access->p_sys;
431
432     dvb_deleteBDAGraph( p_access );
433
434     vlc_mutex_destroy( &p_sys->lock );
435     vlc_cond_destroy( &p_sys->wait );
436
437     free( p_sys );
438 }
439
440 /*****************************************************************************
441  * Control:
442  *****************************************************************************/
443 static int Control( access_t *p_access, int i_query, va_list args )
444 {
445     vlc_bool_t   *pb_bool, b_bool;
446     int          *pi_int, i_int;
447     int64_t      *pi_64;
448
449     switch( i_query )
450     {
451     case ACCESS_CAN_SEEK:           /* 0 */
452     case ACCESS_CAN_FASTSEEK:       /* 1 */
453     case ACCESS_CAN_PAUSE:          /* 2 */
454     case ACCESS_CAN_CONTROL_PACE:   /* 3 */
455         pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
456         *pb_bool = VLC_FALSE;
457         break;
458     case ACCESS_GET_MTU:            /* 4 */
459         pi_int = (int*)va_arg( args, int * );
460         *pi_int = 0;
461         break;
462     case ACCESS_GET_PTS_DELAY:      /* 5 */
463         pi_64 = (int64_t*)va_arg( args, int64_t * );
464         *pi_64 = var_GetInteger( p_access, "dvb-caching" ) * 1000;
465         break;
466         /* */
467     case ACCESS_GET_TITLE_INFO:     /* 6 */
468     case ACCESS_GET_META:           /* 7 */
469     case ACCESS_SET_PAUSE_STATE:    /* 8 */
470     case ACCESS_SET_TITLE:          /* 9 */
471     case ACCESS_SET_SEEKPOINT:      /* 10 */
472         return VLC_EGENERIC;
473
474     case ACCESS_SET_PRIVATE_ID_STATE: /* 11 */
475         i_int  = (int)va_arg( args, int );
476         b_bool = (vlc_bool_t)va_arg( args, vlc_bool_t );
477         break;
478     case ACCESS_SET_PRIVATE_ID_CA:  /* 12 -From Demux */
479         break;
480     default:
481         msg_Warn( p_access,
482                   "DVB_Control: Unimplemented query in control %d", i_query );
483         return VLC_EGENERIC;
484     }
485
486     return VLC_SUCCESS;
487 }
488
489 /*****************************************************************************
490  * Block:
491  *****************************************************************************/
492 static block_t *Block( access_t *p_access )
493 {
494     block_t *p_block;
495     long l_buffer_len;
496
497     if( p_access->b_die )
498         return NULL;
499
500     l_buffer_len = dvb_GetBufferSize( p_access );
501     if( l_buffer_len < 0 )
502     {
503         p_access->info.b_eof = VLC_TRUE;
504         return NULL;
505     }
506
507     p_block = block_New( p_access, l_buffer_len );
508     if( dvb_ReadBuffer( p_access, &l_buffer_len, p_block->p_buffer ) < 0 )
509     {
510         p_access->info.b_eof = VLC_TRUE;
511         return NULL;
512     }
513
514     return p_block;
515 }