Multiproto
Multiproto is a proposal for version 3.3 of the linux DVB API which includes extensions for cards which support multiple DVB protocols (DVB-S, DVB-S2, DVB-T, DVB-C, DVB-H, ATSC, DSS).
It is an experimental project and is not currently implemented in any released version of Linux. No firm plan has been made for its inclusion in Linux. Even worse, the author of some of the main parts of multiproto has incomprehensibly attempted to block its inclusion in Linux, highlighting both misunderstanding of the implications of the GPL and weak project management within the Linux DVB community http://www.linuxtv.org/pipermail/linux-dvb/2008-January/023355.html.
Overview/Features
Discuss the features and facets of the project here ... this means you
Design Decisions
explain the choices made ... this means you
Technical Details
give a technical description of how the API change has been implemented ... this means you
New structs and enums have been added to expand the API for multiple frontends and the parameters required for protocols DVB-S, DSS, DVB-S2, DVB-T, DVB-H and ATSC. These are prefixed (at least for now) with "dvbfe_" and "DVBFE_" as opposed to the old "fe_" and "FE_". For details compare the old and new versions of include/linux/dvb/frontend.h. Currently multiproto implements both the new and old APIs and a glue layer to manage old/new drivers with new/old API calls. Presumably the plan is eventually to move to a pure 3.3 API and update all the drivers.
Simple enough you might think, but progress has been very slow. Since the first version, way back in April 2006, ten (10!) versions of the entire Linux kernel have been released. See http://www.linuxtv.org/pipermail/linux-dvb/2006-April/009522.html and http://kernelnewbies.org/Linux26Changes.
Evaluation and Alternatives
explain whether the design goals have been met or not ... this means you
1. Some application of Occam's Razor still needs to be made. There is repetition in the multiproto API arising from the use of unions of structs to hold parameters (often the same ones) for each type of frontend. However API calls (eg. ioctl dvbfe_params) are already addressed to an individual frontend, i.e. /dev/dvb/adapterN/frontendN, so this repetition could be removed to create a cleaner API. For example these variables:
dvbfe_params.delsys.dvbs.fec dvbfe_params.delsys.dss.fec dvbfe_params.delsys.dvbs2.fec dvbfe_params.delsys.dvbc.fec
could be replaced by the simpler:
dvbfe_params.fec
and these
dvbfe_info.delsys.dvbs.fec dvbfe_info.delsys.dss.fec dvbfe_info.delsys.dvbs2.fec
could be replaced by the simpler:
dvbfe_info.fec
If we simplify in this way, the relevant section of linux/include/linux/dvb/frontend.h would look like this: (note I added _caps to some variables to indicate that they are actually ORd sets of capabilities)
struct dvbfe_info {
char name[128];
enum dvbfe_delsys delsys; //curr delivery sys, READABLE by user, not WRITEABLE
enum dvbfe_modulation modulation_caps; //valid for DVB-S,S2,C,T,H,DSS,ATSC
enum dvbfe_fec fec_caps; //valid for DVB-S,S2,DSS
enum dvbfe_stream_priority stream_priority_caps; //valid for DVB-T,H
__u32 frequency_min;
__u32 frequency_max;
__u32 frequency_step;
__u32 frequency_tolerance;
__u32 symbol_rate_min;
__u32 symbol_rate_max;
__u32 symbol_rate_tolerance;
enum fe_spectral_inversion inversion;
__u8 pad[128];
};
instead of the multiproto version which is more complex and repetitive:
/* DVB-S capability bitfields */
struct dvbfe_dvbs_info {
enum dvbfe_modulation modulation;
enum dvbfe_fec fec;
};
/* DSS capability bitfields */
struct dvbfe_dss_info {
enum dvbfe_modulation modulation;
enum dvbfe_fec fec;
};
/* DVB-S2 capability bitfields */
struct dvbfe_dvbs2_info {
enum dvbfe_modulation modulation;
enum dvbfe_fec fec;
__u8 pad[32];
};
/* DVB-C capability bitfields */
struct dvbfe_dvbc_info {
enum dvbfe_modulation modulation;
};
/* DVB-T capability bitfields */
struct dvbfe_dvbt_info {
enum dvbfe_modulation modulation;
enum dvbfe_stream_priority stream_priority;
__u8 pad[32];
};
/* DVB-H capability bitfields */
struct dvbfe_dvbh_info {
enum dvbfe_modulation modulation;
enum dvbfe_stream_priority stream_priority;
__u8 pad[32];
};
/* ATSC capability bitfields */
struct dvbfe_atsc_info {
enum dvbfe_modulation modulation;
__u8 pad[32];
};
struct dvbfe_info {
char name[128];
union {
struct dvbfe_dvbs_info dvbs;
struct dvbfe_dss_info dss;
struct dvbfe_dvbs2_info dvbs2;
struct dvbfe_dvbc_info dvbc;
struct dvbfe_dvbt_info dvbt;
struct dvbfe_dvbh_info dvbh;
struct dvbfe_atsc_info atsc;
__u8 pad[128];
} delsys;
__u32 frequency_min;
__u32 frequency_max;
__u32 frequency_step;
__u32 frequency_tolerance;
__u32 symbol_rate_min;
__u32 symbol_rate_max;
__u32 symbol_rate_tolerance;
enum fe_spectral_inversion inversion;
__u8 pad[128];
};
2. There is a problem with the design of the multiproto API. The routine DVBFE_GET_INFO actually changes the kernel state (in particular the variable which holds the delivery system). Simply calling DVBFE_SET_PARAMS with a complete correct set of parameters does not work. The corresponding screwy userspace code can be seen in the patched http://abraham.manu.googlepages.com/szap.c where DVBFE_GET_INFO is used to SET the delivery system variable before DVBFE_SET_PARAMS is called. Such odd unexpected behaviour is confusing and should not be accepted in the Linux kernel. At the very least some work needs to be done to rename the routines sensibly. DVBFE_GET_INFO appears to have been originally intended to provide information about the capabilities of the frontend, which is currently not apparent in its name. See http://www.linuxtv.org/pipermail/linux-dvb/2008-March/024266.html and http://www.linuxtv.org/pipermail/linux-dvb/2008-March/024281.html.
UPDATE March 09 2008: This appears to have been changed with the introduction of DVBFE_SET_DELSYS which is now used to set the delivery system. Tuning is done with szap2. Unfortunately the variable delsys has been completely removed from the struct dvbfe_info, instead of just making it a user-readable variable (not a writeable one), analogous to the "type" variable in the old dvb_frontend_info (but with a different range of values, i.e. DVB-S/S2/C/T/H/DSS/ATSC vs. QPSK/QAM/OFDM/ATSC). It would be nice if delsys were put back in, with code to set its value appropriately on DVBFE_GET_INFO calls.
Alternatives: An alternative API has been created for the Hauppauge WinTV-HVR-4000 which makes minimal changes to the current v4l-dvb API in order to provide multifrontend support for DVB-T,DVB-S and DVB-S2 for that device. It offers backwards compatibility with existing binary multimedia applications for DVB-T and DVB-S without recompilation. Patches providing DVB-S2 support for szap and mythtv have been posted. See http://dev.kewl.org/hauppauge/experimental/, http://dev.kewl.org/hauppauge and http://www.linuxtv.org/pipermail/linux-dvb/2008-March/024243.html.
Use multiproto drivers with old API A patch exists which allows basic use of drivers developed for multiproto with the current API (3.2). See http://linuxtv.org/pipermail/linux-dvb/2008-May/026246.html and http://linuxtv.org/pipermail/linux-dvb/2008-August/027979.html.
Status and Migration Plan
explain how a migration from the current API to multiproto could be achieved ... this means you
No clear migration plan has yet been agreed.
The mantis tree (http://jusst.de/hg/mantis) which also uses the multiproto API has not yet been merged into multiproto, meaning that there is unnecessary duplication of the core code and any code fixes in either tree are not automatically applied to both trees.
It has been reported http://www.linuxtv.org/pipermail/linux-dvb/2008-July/027464.html that the currently available Multiproto needs to be updated to compile cleanly with the latest kernel version 2.6.26. Volunteer? Last known good version = 2.6.24?
Making it Work
How to get it from the author's repository:
hg clone http://jusst.de/hg/multiproto
or
http://jusst.de/hg/multiproto/archive/tip.tar.bz2
UPDATE 1st Aug 2008: Igor Liplianin has created another repository containing multiproto code and szap2 at http://liplianindvb.sourceforge.net/hg/, reported to be working with the HVR-4000. See http://www.linuxtv.org/pipermail/linux-dvb/2008-July/027514.html. This appears to be similar to the V4L/DVB staging development repository at http://linuxtv.org/hg/v4l-dvb/ but with the addition of multiproto code.
hg clone http://liplianindvb.sourceforge.net/hg/liplianindvb hg clone http://liplianindvb.sourceforge.net/hg/szap2
Drivers
There are currently no in-kernel multiproto drivers. There are several cards which have experimental support in the multiproto tree, perhaps with additional patches.
Provide details of which drivers work with multiproto ... this means you
See the descriptions for the following cards:
Azurewave AD-SP400 CI (Twinhan VP-1041)
KNC1 DVB-S2 TV Station (PCI32, supports CI)
TerraTec Cinergy S2 PCI HD CI (PCI32, CI)
provide the details of where the drivers and patches and necessary tools are available ... this means you
provide details of how to compile for recent kernels -- this means you
Sample kernel output
provide the relevant portion of dmesg here
Tuner / DiSEqC / Player support
provide comprehensive details of how to upgrade multimedia applications to work with the new API ... this means you
Scanning and tuning applications generally will not work with the new API unless they are modified. The situation is arguably improving but the lack of patched applications (and guidance on patching) has hindered completion and testing of multiproto and new drivers, and adoption of the new API. Needless to say, patching drivers and multiple applications is a step too far for most potential testers.
dvb-apps : There is still no patched dvb-apps tree. Someone needs to create one ... why don't you?
scan : see patched version at http://jusst.de/manu/scan.tar.bz2
szap: see patched version at http://abraham.manu.googlepages.com/szap.c Also see information about szap2 at http://allrussian.info/thread.php?postid=187408#post187408 and http://www.linuxtv.org/pipermail/linux-dvb/2008-February/023836.html.
mplayer : someone needs to write a patch ... why don't you?
Kaffeine / xine-lib : someone needs to write a patch ... why don't you? There are some posts about getting Kaffeine to work with multiproto in these threads: http://www.linuxtv.org/pipermail/linux-dvb/2008-May/025882.html, http://www.linuxtv.org/pipermail/linux-dvb/2008-July/027141.html and in these two messages: http://sourceforge.net/mailarchive/forum.php?thread_name=48217036.3090709%40gmail.com&forum_name=kaffeine-devel and http://sourceforge.net/mailarchive/forum.php?thread_name=481DE023.9000903%40gmail.com&forum_name=kaffeine-devel .
VDR : VDR version 1.5.14 required multiproto (v1.5.14 announcement: http://www.linuxtv.org/pipermail/vdr/2008-January/015302.html) but this was revoked in 1.5.15 to make a multiproto-free release 1.6.0 due to the unavailability of multiproto in the Linux kernel mainstream. The requirement for multiproto has been reinstated in version 1.7.0......but...... you guessed it: there's a patch which can be used to revert this to the v3.2 API. See http://linuxtv.org/pipermail/vdr/2008-August/017534.html and http://www.udo-richter.de/vdr/patches.en.html#dvb-api-wrapper. Flip, flop...
MythTV : Two patches (one DVB-S/S2, one DVB-S only) have been posted http://www.linuxtv.org/pipermail/linux-dvb/2008-January/022757.html. Current status?
dvbstream : Someone needs to write a patch ... why don't you? See http://www.linuxtv.org/pipermail/linux-dvb/2008-February/024056.html.
provide details of how to use with DiSEqC -- this means you
How to patch an application for Multiproto
provide guidance on patching applications to use multiproto -- this means you
To tune to a channel : using the patched szap above as a guide we see that
struct dvb_frontend_parameters tuneto; ... ioctl(fefd, FE_SET_FRONTEND, &tuneto);
must be replaced by
struct dvbfe_params fe_params; ... ioctl(fefd, DVBFE_SET_PARAMS, &fe_params);
where the parts of dvbfe_params.delsys relevant for the delivery system used (DVB-S/DSS/DVB-S2) need to be set before the call.
To make the userspace code a lot cleaner C preprocessor macros can be used to hide the full details of the multiproto api - here is a short example:
#if (DVB_API_VERSION==3) && (DVB_API_VERSION_MINOR>=3)
#define FE_PARAM struct dvbfe_params
#define IOCTL_SET_FE DVBFE_SET_PARAMS
#define DVB_SET_DELIVERY(a, b) (a)->delivery=(b)
#define DVBC_SET_SYMBOLRATE(a, b) (a)->delsys.dvbc.symbol_rate=(b)
#else
#define FE_PARAM struct dvb_frontend_parameters
#define IOCTL_SET_FE FE_SET_FRONTEND
#define DVB_SET_DELIVERY(a, b) do{ } while(0)
#define DVBC_SET_SYMBOLRATE(a, b) (a)->u.qam.symbol_rate=(b)
#endif
void tune(int fefd) {
FE_PARAM fparm;
memset(&fparm, 0, sizeof(FE_PARM));
DVB_SET_DELIVERY(&fparm, DVBFE_DELSYS_DVBC);
...
DVBC_SET_SYMBOLRATE(&fparm, symbolrate)
if (ioctl(fefd, IOCTL_SET_FE, &fparm) < 0) {
printf("Tuning failed");
}
}
The code itself will stay clean of ifdef spaghetti and the compatibility macros can be hidden in some header file. See getstream [1] for a multiproto capable tuner coder without a single ifdef.
External Links
Русский: This page has been translated into Russian here: http://www.free-x.de/wiki/index.php/Multiproto.