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