1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
2 .. c:namespace:: DTV.dmx !! 2 .. document under the terms of the GNU Free Documentation License,
>> 3 .. Version 1.1 or any later version published by the Free Software
>> 4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
>> 5 .. and no Back-Cover Texts. A copy of the license is included at
>> 6 .. Documentation/userspace-api/media/fdl-appendix.rst.
>> 7 ..
>> 8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
3 9
4 .. _dmx_fopen: 10 .. _dmx_fopen:
5 11
6 ======================= 12 =======================
7 Digital TV demux open() 13 Digital TV demux open()
8 ======================= 14 =======================
9 15
10 Name 16 Name
11 ---- 17 ----
12 18
13 Digital TV demux open() 19 Digital TV demux open()
14 20
>> 21
15 Synopsis 22 Synopsis
16 -------- 23 --------
17 24
18 .. c:function:: int open(const char *deviceNam 25 .. c:function:: int open(const char *deviceName, int flags)
>> 26 :name: dvb-dmx-open
19 27
20 Arguments 28 Arguments
21 --------- 29 ---------
22 30
23 ``name`` 31 ``name``
24 Name of specific Digital TV demux device. 32 Name of specific Digital TV demux device.
25 33
26 ``flags`` 34 ``flags``
27 A bit-wise OR of the following flags: 35 A bit-wise OR of the following flags:
28 36
29 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| 37 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
30 38
31 .. flat-table:: 39 .. flat-table::
32 :header-rows: 0 40 :header-rows: 0
33 :stub-columns: 0 41 :stub-columns: 0
34 :widths: 1 16 42 :widths: 1 16
35 43
36 - 44 -
37 - ``O_RDONLY`` 45 - ``O_RDONLY``
38 - read-only access 46 - read-only access
39 47
40 - 48 -
41 - ``O_RDWR`` 49 - ``O_RDWR``
42 - read/write access 50 - read/write access
43 51
44 - 52 -
45 - ``O_NONBLOCK`` 53 - ``O_NONBLOCK``
46 - open in non-blocking mode 54 - open in non-blocking mode
47 (blocking mode is the default) 55 (blocking mode is the default)
48 56
>> 57
49 Description 58 Description
50 ----------- 59 -----------
51 60
52 This system call, used with a device name of ` 61 This system call, used with a device name of ``/dev/dvb/adapter?/demux?``,
53 allocates a new filter and returns a handle wh 62 allocates a new filter and returns a handle which can be used for
54 subsequent control of that filter. This call h 63 subsequent control of that filter. This call has to be made for each
55 filter to be used, i.e. every returned file de 64 filter to be used, i.e. every returned file descriptor is a reference to
56 a single filter. ``/dev/dvb/adapter?/dvr?`` is 65 a single filter. ``/dev/dvb/adapter?/dvr?`` is a logical device to be used
57 for retrieving Transport Streams for digital v 66 for retrieving Transport Streams for digital video recording. When
58 reading from this device a transport stream co 67 reading from this device a transport stream containing the packets from
59 all PES filters set in the corresponding demux 68 all PES filters set in the corresponding demux device
60 (``/dev/dvb/adapter?/demux?``) having the outp 69 (``/dev/dvb/adapter?/demux?``) having the output set to ``DMX_OUT_TS_TAP``.
61 A recorded Transport Stream is replayed by wri 70 A recorded Transport Stream is replayed by writing to this device.
62 71
63 The significance of blocking or non-blocking m 72 The significance of blocking or non-blocking mode is described in the
64 documentation for functions where there is a d 73 documentation for functions where there is a difference. It does not
65 affect the semantics of the ``open()`` call it 74 affect the semantics of the ``open()`` call itself. A device opened
66 in blocking mode can later be put into non-blo 75 in blocking mode can later be put into non-blocking mode (and vice versa)
67 using the ``F_SETFL`` command of the fcntl sys 76 using the ``F_SETFL`` command of the fcntl system call.
68 77
>> 78
69 Return Value 79 Return Value
70 ------------ 80 ------------
71 81
72 On success 0 is returned. 82 On success 0 is returned.
73 83
74 On error -1 is returned, and the ``errno`` var 84 On error -1 is returned, and the ``errno`` variable is set
75 appropriately. 85 appropriately.
76 86
77 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| 87 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
78 88
79 .. flat-table:: 89 .. flat-table::
80 :header-rows: 0 90 :header-rows: 0
81 :stub-columns: 0 91 :stub-columns: 0
82 :widths: 1 16 92 :widths: 1 16
83 93
84 - - ``EMFILE`` 94 - - ``EMFILE``
85 - "Too many open files", i.e. no more !! 95 - “Too many open files”, i.e. no more filters available.
86 96
87 The generic error codes are described at the 97 The generic error codes are described at the
88 :ref:`Generic Error Codes <gen-errors>` chapte 98 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.