3 * @brief Digital broadcasting input module for VLC media player
5 /*****************************************************************************
6 * Copyright © 2011 Rémi Denis-Courmont
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1
11 * of the License, or (at your option) any later version.
13 * This library 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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 ****************************************************************************/
27 #include <vlc_common.h>
28 #include <vlc_access.h>
29 #include <vlc_plugin.h>
30 #include <vlc_dialog.h>
34 #define CACHING_TEXT N_("Caching value (ms)")
35 #define CACHING_LONGTEXT N_( \
36 "The cache size (delay) for digital broadcasts (in milliseconds).")
38 #define ADAPTER_TEXT N_("DVB adapter")
39 #define ADAPTER_LONGTEXT N_( \
40 "If there is more than one digital broadcasting adapter, " \
41 "the adapter number must be selected. Numbering start from zero.")
43 #define DEVICE_TEXT N_("DVB device")
44 #define DEVICE_LONGTEXT N_( \
45 "If the selected adapter has more than one tuner, " \
46 "the tuner number must be selected. Numbering start from zero.")
48 #define BUDGET_TEXT N_("Do not demultiplex")
49 #define BUDGET_LONGTEXT N_( \
50 "Only useful programs are normally demultiplexed from the transponder. " \
51 "This option will disable demultiplexing and receive all programs.")
53 #define FREQ_TEXT N_("Frequency (kHz)")
54 #define FREQ_LONGTEXT N_( \
55 "TV channels are grouped by transponder (a.k.a. multiplex) " \
56 "on a given frequency. This is required to tune the receiver.")
58 #define MODULATION_TEXT N_("Modulation / Constellation")
59 #define MODULATION_LONGTEXT N_( \
60 "The digital signal can be modulated according with different " \
61 "constellations (depending on the delivery system). " \
62 "If the demodulator cannot detect the constellation automatically, " \
63 "it needs to be configured manually.")
64 static const char *const modulation_vlc[] = { "",
65 "QAM", "16QAM", "32QAM", "64QAM", "128QAM", "256QAM",
67 "QPSK", "DQPSK", "8PSK", "16APSK", "32APSK",
69 static const char *const modulation_user[] = { N_("Undefined"),
70 "Auto QAM", "16-QAM", "32-QAM", "64-QAM", "128-QAM", "256-QAM",
72 "QPSK", "DQPSK", "8-PSK", "16-APSK", "32-APSK",
75 #define SRATE_TEXT N_("Symbol rate (bauds)")
76 #define SRATE_LONGTEXT N_( \
77 "The symbol rate must be specified manually for some systems, " \
78 "notably DVB-C, DVB-S and DVB-S2.")
80 #define INVERSION_TEXT N_("Spectrum inversion")
81 #define INVERSION_LONGTEXT N_( \
82 "If the demodulator cannot detect spectral inversion correctly, " \
83 "it needs to be configured manually.")
84 const int auto_off_on_vlc[] = { -1, 0, 1 };
85 static const char *const auto_off_on_user[] = { N_("Automatic"),
86 N_("Off"), N_("On") };
88 #define CODE_RATE_TEXT N_("FEC code rate")
89 #define CODE_RATE_HP_TEXT N_("High-priority code rate")
90 #define CODE_RATE_LP_TEXT N_("Low-priority code rate")
91 #define CODE_RATE_LONGTEXT N_( \
92 "The code rate for Forward Error Correction can be specified.")
93 static const char *const code_rate_vlc[] = { "",
94 "none", /*"1/4", "1/3",*/ "1/2", "3/5", "2/3", "3/4",
95 "4/5", "5/6", "6/7", "7/8", "8/9", "9/10",
97 static const char *const code_rate_user[] = { N_("Automatic"),
98 N_("None"), /*"1/4", "1/3",*/ "1/2", "3/5", "2/3", "3/4",
99 "4/5", "5/6", "6/7", "7/8", "8/9", "9/10",
102 #define TRANSMISSION_TEXT N_("Transmission mode")
103 const int transmission_vlc[] = { -1,
106 static const char *const transmission_user[] = { N_("Automatic"),
107 "2k", "4k", "8k", /*"16k", "32k", */
110 #define BANDWIDTH_TEXT N_("Bandwidth (MHz)")
111 const int bandwidth_vlc[] = { 0,
114 static const char *const bandwidth_user[] = { N_("Automatic"),
115 N_("8 MHz"), N_("7 MHz"), N_("6 MHz"),
118 #define GUARD_TEXT N_("Guard interval")
119 const char *const guard_vlc[] = { "",
120 /*"1/128",*/ "1/32", "1/16", /*"19/128",*/ "1/8", /*"9/256",*/ "1/4",
122 static const char *const guard_user[] = { N_("Automatic"),
123 /*"1/128",*/ "1/32", "1/16", /*"19/128",*/ "1/8", /*"9/256",*/ "1/4",
126 #define HIERARCHY_TEXT N_("Hierarchy mode")
127 const int hierarchy_vlc[] = { -1,
130 static const char *const hierarchy_user[] = { N_("Automatic"),
131 N_("None"), "1", "2", "4",
134 #define PILOT_TEXT N_("Pilot")
135 #define ROLLOFF_TEXT N_("Roll-off factor")
136 const int rolloff_vlc[] = { -1,
139 static const char *const rolloff_user[] = { N_("Automatic"),
140 N_("0.35 (same as DVB-S)"), N_("0.20"), N_("0.25"),
143 static int Open (vlc_object_t *);
144 static void Close (vlc_object_t *);
147 set_shortname (N_("DTV"))
148 set_description (N_("Digital Television and Radio (Linux DVB)"))
149 set_category (CAT_INPUT)
150 set_subcategory (SUBCAT_INPUT_ACCESS)
151 set_capability ("access", 0)
152 set_callbacks (Open, Close)
153 add_shortcut ("dtv", "tv", "dvb", /* "radio", "dab",*/
154 "cable", "dvb-c", /*"satellite", "dvb-s", "dvb-s2",*/
155 "terrestrial", "dvb-t", "atsc")
157 /* All options starting with dvb- can be overriden in the MRL, so they
158 * must all be "safe". Nevertheless, we do not mark as safe those that are
159 * really specific to the local system (e.g. device ID...).
160 * It wouldn't make sense to deliver those through a playlist. */
162 add_integer ("dvb-caching", DEFAULT_PTS_DELAY / 1000,
163 CACHING_TEXT, CACHING_LONGTEXT, true)
164 change_integer_range (0, 60000)
167 add_integer ("dvb-adapter", 0, ADAPTER_TEXT, ADAPTER_LONGTEXT, false)
168 change_integer_range (0, 255)
169 add_integer ("dvb-device", 0, DEVICE_TEXT, DEVICE_LONGTEXT, false)
170 change_integer_range (0, 255)
171 add_bool ("dvb-budget-mode", false, BUDGET_TEXT, BUDGET_LONGTEXT, true)
173 add_integer ("dvb-frequency", 0, FREQ_TEXT, FREQ_LONGTEXT, false)
174 change_integer_range (0, 107999999)
176 add_integer ("dvb-inversion", -1, INVERSION_TEXT, INVERSION_LONGTEXT, true)
177 change_integer_list (auto_off_on_vlc, auto_off_on_user)
180 set_section (N_("Terrestrial reception parameters"), NULL)
181 add_integer ("dvb-bandwidth", -1, BANDWIDTH_TEXT, BANDWIDTH_TEXT, true)
182 change_integer_list (bandwidth_vlc, bandwidth_user)
184 add_string ("dvb-code-rate-hp", "",
185 CODE_RATE_HP_TEXT, CODE_RATE_LONGTEXT, false)
186 change_string_list (code_rate_vlc, code_rate_user, NULL)
188 add_string ("dvb-code-rate-lp", "",
189 CODE_RATE_LP_TEXT, CODE_RATE_LONGTEXT, false)
190 change_string_list (code_rate_vlc, code_rate_user, NULL)
192 add_integer ("dvb-transmission", 0,
193 TRANSMISSION_TEXT, TRANSMISSION_TEXT, true)
194 change_integer_list (transmission_vlc, transmission_user)
196 add_string ("dvb-guard", "", GUARD_TEXT, GUARD_TEXT, true)
197 change_string_list (guard_vlc, guard_user, NULL)
199 add_integer ("dvb-hierarchy", -1, HIERARCHY_TEXT, HIERARCHY_TEXT, true)
200 change_integer_list (hierarchy_vlc, hierarchy_user)
203 set_section (N_("Cable and satellite reception parameters"), NULL)
204 add_string ("dvb-modulation", 0,
205 MODULATION_TEXT, MODULATION_LONGTEXT, false)
206 change_string_list (modulation_vlc, modulation_user, NULL)
208 add_integer ("dvb-srate", 0, SRATE_TEXT, SRATE_LONGTEXT, false)
209 change_integer_range (0, UINT64_C(0xffffffff))
211 add_string ("dvb-code-rate", "", CODE_RATE_TEXT, CODE_RATE_LONGTEXT, true)
212 change_string_list (code_rate_vlc, code_rate_user, NULL)
214 add_integer ("dvb-fec", 9, " ", " ", true)
215 change_integer_range (0, 9)
219 set_section (N_("Satellite (DVB-S) parameters"), NULL)
220 add_integer ("dvb-satno", 0, SATNO_TEXT, SATNO_LONGTEXT, true)
221 change_integer_list (satno_vlc, satno_user)
223 add_integer ("dvb-voltage", 13, VOLTAGE_TEXT, VOLTAGE_LONGTEXT, true)
224 change_integer_list (voltage_vlc, voltage_user)
226 add_bool ("dvb-high-voltage", false,
227 HIGH_VOLTAGE_TEXT, HIGH_VOLTAGE_LONGTEXT, false)
228 add_integer ("dvb-tone", -1, TONE_TEXT, TONE_LONGTEXT, true)
229 change_integer_list (tone_vlc, auto_off_on)
231 add_integer ("dvb-lnb-lof1", 0, LNB_LOF1_TEXT, LNB_LOF1_LONGTEXT, true)
232 change_integer_range (0, 0x7fffffff)
234 add_integer ("dvb-lnb-lof2", 0, LNB_LOF2_TEXT, LNB_LOF2_LONGTEXT, true)
235 change_integer_range (0, 0x7fffffff)
237 add_integer ("dvb-lnb-slof", 0, LNB_SLOF_TEXT, LNB_SLOF_LONGTEXT, true)
238 change_integer_range (0, 0x7fffffff)
241 set_section (N_("DVB-S2 parameters"), NULL)
242 add_integer ("dvb-pilot", -1, PILOT_TEXT, PILOT_TEXT, true)
243 change_integer_list (auto_off_on_vlc, auto_off_on_user)
245 add_integer ("dvb-rolloff", -1, ROLLOFF_TEXT, ROLLOFF_TEXT, true)
246 change_integer_list (rolloff_vlc, rolloff_user)
257 int (*setup) (vlc_object_t *, dvb_device_t *, unsigned freq);
258 /* TODO: scan stuff */
261 static block_t *Read (access_t *);
262 static int Control (access_t *, int, va_list);
263 static const delsys_t *GuessSystem (const char *, dvb_device_t *);
264 static int Tune (vlc_object_t *, dvb_device_t *, const delsys_t *, unsigned);
265 static unsigned var_InheritFrequency (vlc_object_t *);
267 static int Open (vlc_object_t *obj)
269 access_t *access = (access_t *)obj;
270 access_sys_t *sys = malloc (sizeof (*sys));
271 if (unlikely(sys == NULL))
274 var_LocationParse (obj, access->psz_location, "dvb-");
275 unsigned freq = var_InheritFrequency (obj);
277 dvb_device_t *dev = dvb_open (obj, freq != 0);
289 const delsys_t *delsys = GuessSystem (access->psz_access, dev);
290 if (delsys == NULL || Tune (obj, dev, delsys, freq))
292 msg_Err (obj, "tuning to %u kHz failed", freq);
293 dialog_Fatal (obj, N_("Digital broadcasting"),
294 N_("The selected digital tuner does not support "
295 "the specified parameters.\n"
296 "Please check the preferences."));
300 dvb_add_pid (dev, 0);
302 access->pf_block = Read;
303 access->pf_control = Control;
304 if (access->psz_demux == NULL || !access->psz_demux[0])
306 free (access->psz_demux);
307 access->psz_demux = strdup ("ts");
313 access->p_sys = NULL;
317 static void Close (vlc_object_t *obj)
319 access_t *access = (access_t *)obj;
320 access_sys_t *sys = access->p_sys;
322 dvb_close (sys->dev);
326 static block_t *Read (access_t *access)
328 #define BUFSIZE (20*188)
329 block_t *block = block_Alloc (BUFSIZE);
330 if (unlikely(block == NULL))
333 access_sys_t *sys = access->p_sys;
334 ssize_t val = dvb_read (sys->dev, block->p_buffer, BUFSIZE);
339 access->info.b_eof = true;
340 block_Release (block);
344 block->i_buffer = val;
348 static int Control (access_t *access, int query, va_list args)
350 access_sys_t *sys = access->p_sys;
351 dvb_device_t *dev = sys->dev;
355 case ACCESS_CAN_SEEK:
356 case ACCESS_CAN_FASTSEEK:
357 case ACCESS_CAN_PAUSE:
358 case ACCESS_CAN_CONTROL_PACE:
360 bool *v = va_arg (args, bool *);
365 case ACCESS_GET_PTS_DELAY:
367 int64_t *v = va_arg (args, int64_t *);
368 *v = var_InheritInteger (access, "dvb-caching") * INT64_C(1000);
372 case ACCESS_GET_TITLE_INFO:
373 case ACCESS_GET_META:
376 case ACCESS_GET_CONTENT_TYPE:
378 char **pt = va_arg (args, char **);
379 *pt = strdup ("video/MP2T");
383 case ACCESS_SET_PAUSE_STATE:
384 case ACCESS_SET_TITLE:
385 case ACCESS_SET_SEEKPOINT:
388 case ACCESS_GET_SIGNAL:
389 *va_arg (args, double *) = dvb_get_snr (dev);
390 *va_arg (args, double *) = dvb_get_signal_strength (dev);
393 case ACCESS_SET_PRIVATE_ID_STATE:
395 unsigned pid = va_arg (args, unsigned);
396 bool add = va_arg (args, unsigned);
398 if (unlikely(pid > 0x1FFF))
402 if (dvb_add_pid (dev, pid))
406 dvb_remove_pid (dev, pid);
410 case ACCESS_SET_PRIVATE_ID_CA:
414 case ACCESS_GET_PRIVATE_ID_STATE:
418 msg_Warn (access, "unimplemented query %d in control", query);
423 /*** Generic tuning ***/
425 /** Determines which delivery system to use. */
426 static const delsys_t *GuessSystem (const char *scheme, dvb_device_t *dev)
428 /* NOTE: We should guess the delivery system for the "cable", "satellite"
429 * and "terrestrial" shortcuts (i.e. DVB, ISDB, ATSC...). But there is
430 * seemingly no sane way to do get the info with Linux DVB version 5.2.
431 * In particular, the frontend infos distinguish only the modulator class
432 * (QPSK, QAM, OFDM or ATSC).
434 * Furthermore, if the demodulator supports 2G, we cannot guess whether
435 * 1G or 2G is intended. For backward compatibility, 1G is assumed
436 * (this is not a limitation of Linux DVB). We will probably need something
437 * smarter when 2G (semi automatic) scanning is implemented. */
438 if (!strcasecmp (scheme, "cable"))
441 if (!strcasecmp (scheme, "satellite"))
444 if (!strcasecmp (scheme, "terrestrial"))
447 if (!strcasecmp (scheme, "atsc"))
449 if (!strcasecmp (scheme, "dvb-c"))
451 if (!strcasecmp (scheme, "dvb-s"))
453 if (!strcasecmp (scheme, "dvb-s2"))
455 if (!strcasecmp (scheme, "dvb-t"))
458 return dvb_guess_system (dev);
461 /** Set parameters and tune the device */
462 static int Tune (vlc_object_t *obj, dvb_device_t *dev, const delsys_t *delsys,
465 if (delsys->setup (obj, dev, freq)
466 || dvb_set_inversion (dev, var_InheritInteger (obj, "dvb-inversion"))
472 static unsigned var_InheritFrequency (vlc_object_t *obj)
474 unsigned freq = var_InheritInteger (obj, "dvb-frequency");
475 if (freq >= 108000000)
477 msg_Err (obj, "%u kHz frequency is too high.", freq);
479 msg_Info (obj, "Assuming %u kHz carrier frequency instead.", freq);
484 static char *var_InheritCodeRate (vlc_object_t *obj)
486 char *code_rate = var_InheritString (obj, "dvb-code-rate");
487 if (code_rate != NULL)
490 /* Backward compatibility with VLC < 1.2 (= Linux DVBv3 enum) */
491 unsigned fec = var_InheritInteger (obj, "dvb-fec");
494 static const char linux_dvb[9][5] = {
495 "none", "1/2", "2/3", "3/4", "4/5", "5/6", "6/7", "7/8" };
496 msg_Warn (obj, "\"fec=%u\" option is obsolete. "
497 "Use \"code-rate=%s\" instead.", fec, linux_dvb[fec]);
498 return strdup (linux_dvb[fec]);
503 static char *var_InheritModulation (vlc_object_t *obj)
505 char *mod = var_InheritString (obj, "dvb-modulation");
510 unsigned long l = strtol (mod, &end, 0);
511 if (*end != '\0') /* not a number = not from VLC < 1.2 */
514 /* Backward compatibility with VLC < 1.2 */
518 case -1: str = "QPSK"; break;
519 case 0: str = "QAM"; break;
520 case 8: str = "8VSB"; break;
521 case 16: str = "16QAM"; break;
522 case 32: str = "32QAM"; break;
523 case 64: str = "64QAM"; break;
524 case 128: str = "128QAM"; break;
525 case 256: str = "256QAM"; break;
529 msg_Warn (obj, "\"modulation=%ld\" option is obsolete. "
530 "Use \"modulation=%s\" instead.", l, str);
536 static int atsc_setup (vlc_object_t *obj, dvb_device_t *dev, unsigned freq)
538 char *mod = var_InheritModulation (obj);
540 int ret = dvb_set_atsc (dev, freq, mod);
545 const delsys_t atsc = { .setup = atsc_setup };
549 static int dvbc_setup (vlc_object_t *obj, dvb_device_t *dev, unsigned freq)
551 char *mod = var_InheritModulation (obj);
552 char *fec = var_InheritCodeRate (obj);
553 unsigned srate = var_InheritInteger (obj, "dvb-srate");
555 int ret = dvb_set_dvbc (dev, freq, mod, srate, fec);
561 const delsys_t dvbc = { .setup = dvbc_setup };
565 static int dvbs_setup (vlc_object_t *obj, dvb_device_t *dev, unsigned freq)
567 char *fec = var_InheritCodeRate (obj);
568 uint32_t srate = var_InheritInteger (obj, "dvb-srate");
570 /* FIXME: adjust frequency (offset) */
571 int ret = dvb_set_dvbs (dev, freq, srate, fec);
574 /* TODO: setup SEC */
578 static int dvbs2_setup (vlc_object_t *obj, dvb_device_t *dev, unsigned freq)
580 char *mod = var_InheritModulation (obj);
581 char *fec = var_InheritCodeRate (obj);
582 uint32_t srate = var_InheritInteger (obj, "dvb-srate");
583 int pilot = var_InheritInteger (obj, "dvb-pilot");
584 int rolloff = var_InheritInteger (obj, "dvb-rolloff");
586 /* FIXME: adjust frequency (offset)? SEC? */
587 int ret = dvb_set_dvbs2 (dev, freq, mod, srate, fec, pilot, rolloff);
593 const delsys_t dvbs = { .setup = dvbs_setup };
594 const delsys_t dvbs2 = { .setup = dvbs2_setup };
598 static int dvbt_setup (vlc_object_t *obj, dvb_device_t *dev, unsigned freq)
600 char *mod = var_InheritModulation (obj);
601 char *fec_hp = var_InheritString (obj, "dvb-code-rate-hp");
602 char *fec_lp = var_InheritString (obj, "dvb-code-rate-lp");
603 char *guard = var_InheritString (obj, "dvb-guard");
604 uint32_t bw = var_InheritInteger (obj, "dvb-bandwidth");
605 int tx = var_InheritInteger (obj, "dvb-transmission");
606 int h = var_InheritInteger (obj, "dvb-hierarchy");
608 int ret = dvb_set_dvbt (dev, freq, mod, fec_hp, fec_lp, bw, tx, guard, h);
616 const delsys_t dvbt = { .setup = dvbt_setup };