xref: /freebsd/usr.sbin/fwcontrol/fwmpegts.c (revision ddd5b8e9b4d8957fce018c520657cdfa4ecffad3)
1 /*
2  * Copyright (C) 2005
3  * 	Petr Holub, Hidetoshi Shimokawa. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *
16  *	This product includes software developed by Hidetoshi Shimokawa.
17  *
18  * 4. Neither the name of the author nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 #include <sys/param.h>
37 #include <sys/ioctl.h>
38 #include <sys/time.h>
39 #include <sys/types.h>
40 #include <sys/uio.h>
41 
42 #if __FreeBSD_version >= 500000
43 #include <arpa/inet.h>
44 #endif
45 
46 #include <err.h>
47 #include <errno.h>
48 #include <unistd.h>
49 #include <fcntl.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <sysexits.h>
54 
55 #if defined(__FreeBSD__)
56 #include <dev/firewire/firewire.h>
57 #include <dev/firewire/iec68113.h>
58 #elif defined(__NetBSD__)
59 #include <dev/ieee1394/firewire.h>
60 #include <dev/ieee1394/iec68113.h>
61 #else
62 #warning "You need to add support for your OS"
63 #endif
64 
65 
66 #include "fwmethods.h"
67 
68 #define	DEBUG 0
69 
70 /*****************************************************************************
71 
72 MPEG-2 Transport Stream (MPEG TS) packet format according to IEC 61883:
73 
74 31                              15                             0
75 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  --------
76 |           len                 |tag|  channel  | tcode |  sy   |
77 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+    1394
78 |                           header_CRC                          |
79 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  --------
80 |0|0|    sid    |      dbs      |fn | qpc |S|RSV|       dbc     |
81 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+    CIP
82 |1|0|    fmt    |      fdf      |          fdf/syt              |
83 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  --------
84 |   reserved  |        cycle_count      |      cycle_offset     |
85 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
86 |                                                               |    N x
87 .                                                               .    MPEG
88 .                   MPEG TS payload 188 bytes                   .
89 .                                                               .
90 |                                                               |
91 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  --------
92 |                            data_CRC                           |
93 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
94 
95 N.b. that CRCs are removed by firewire layer!
96 
97 The following fields are fixed for IEEE-1394:
98 tag = 01b
99 tcode = 1010b
100 The length is payload length, i.e. includes CIP header and data size.
101 
102 The following fields are constant for MPEG TS:
103 sph = 1 (denoted as S in CIP header above)
104 dbs = 6
105 fmt = (1<<5)
106 fdf = reserved
107 In the supported streams we also require
108 qpc = 0
109 fn = 3
110 and thus the payload is divided in 8 blocks as follows:
111 
112   +-----+-----+-----+-----+-----+-----+-----+-----+
113   | db0 | db1 | db2 | db3 | db4 | db5 | db6 | db7 |
114   +-----+-----+-----+-----+-----+-----+-----+-----+
115 
116 We have several cases of payload distribution based on stream
117 bandwidth (R):
118 1) R < 1.5 Mbps: any of db0..db7 may be payload,
119 2) 1.5 < R < 3 Mbps: db0/db1 or db2/db3 or db4/db5 or db6/db7 is payload,
120 3) 3 < R < 6 Mbps: db0/db1/db2/db3 or db4/db5/db6/db7 is payload,
121 4) R > 6 Mbps: all db0..db7 contain the payload.
122 Curently, only case (4) is supported in fwmpegts.c
123 
124 Each packet may contain N  MPEG TS data blocks with timestamp header,
125 which are (4+188)B long. Experimentally, the N ranges from 0 through 3.
126 
127 *****************************************************************************/
128 
129 
130 typedef uint8_t mpeg_ts_pld[188];
131 
132 struct mpeg_pldt {
133 #if BYTE_ORDER == BIG_ENDIAN
134 	uint32_t	:7,
135 				c_count:13,
136 				c_offset:12;
137 #else /* BYTE_ORDER != BIG_ENDIAN */
138 	uint32_t	c_offset:12,
139 				c_count:13,
140 				:7;
141 #endif /* BYTE_ORDER == BIG_ENDIAN */
142 	mpeg_ts_pld payload;
143 };
144 
145 
146 #define	NCHUNK 8
147 #define	PSIZE 596
148 #define	NPACKET_R 4096
149 #define	RBUFSIZE (PSIZE * NPACKET_R)
150 
151 void
152 mpegtsrecv(int d, const char *filename, char ich, int count)
153 {
154 	struct ciphdr *ciph;
155 	struct fw_isochreq isoreq;
156 	struct fw_isobufreq bufreq;
157 	struct fw_pkt *pkt;
158 	struct mpeg_pldt *pld;
159 	uint32_t *ptr;
160 	int fd, k, len, m, pkt_size, startwr, tlen;
161 	char *buf;
162 
163 	startwr = 0;
164 
165 	if (strcmp(filename, "-") == 0)
166 		fd = STDOUT_FILENO;
167 	else {
168 		fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC, 0660);
169 		if (fd == -1)
170 			err(EX_NOINPUT, "%s", filename);
171 	}
172 	buf = malloc(RBUFSIZE);
173 
174 	bufreq.rx.nchunk = NCHUNK;
175 	bufreq.rx.npacket = NPACKET_R;
176 	bufreq.rx.psize = PSIZE;
177 	bufreq.tx.nchunk = 0;
178 	bufreq.tx.npacket = 0;
179 	bufreq.tx.psize = 0;
180 	if (ioctl(d, FW_SSTBUF, &bufreq) < 0)
181 		err(1, "ioctl");
182 
183 	isoreq.ch = ich & 0x3f;
184 	isoreq.tag = (ich >> 6) & 3;
185 
186 	if (ioctl(d, FW_SRSTREAM, &isoreq) < 0)
187 		err(1, "ioctl");
188 
189 	k = m = 0;
190 	while (count <= 0 || k <= count) {
191 		len = tlen = read(d, buf, RBUFSIZE);
192 #if DEBUG
193 		fprintf(stderr, "Read %d bytes.\n", len);
194 #endif /* DEBUG */
195 		if (len < 0) {
196 			if (errno == EAGAIN) {
197 				fprintf(stderr, "(EAGAIN) - push 'Play'?\n");
198 				continue;
199 			}
200 			err(1, "read failed");
201 		}
202 		ptr = (uint32_t *) buf;
203 
204 		do {
205 			pkt = (struct fw_pkt *) ptr;
206 #if DEBUG
207 			fprintf(stderr, "\nReading new packet.\n");
208 			fprintf(stderr, "%08x %08x %08x %08x\n",
209 				htonl(ptr[0]), htonl(ptr[1]),
210 				htonl(ptr[2]), htonl(ptr[3]));
211 #endif /* DEBUG */
212 			/* there is no CRC in the 1394 header */
213 			ciph = (struct ciphdr *)(ptr + 1);	/* skip iso header */
214 			if (ciph->fmt != CIP_FMT_MPEG)
215 				errx(1, "unknown format 0x%x", ciph->fmt);
216 			if (ciph->fn != 3) {
217 				errx(1,
218 						"unsupported MPEG TS stream, fn=%d (only fn=3 is supported)",
219 						ciph->fn);
220 			}
221 			ptr = (uint32_t *) (ciph + 1);		/* skip cip header */
222 
223 			if (pkt->mode.stream.len <= sizeof(struct ciphdr)) {
224 				/* no payload */
225 				/* tlen needs to be decremented before end of the loop */
226 				goto next;
227 			}
228 #if DEBUG
229 			else {
230 				fprintf(stderr,
231 						"Packet net payload length (IEEE1394 header): %d\n",
232 						pkt->mode.stream.len - sizeof(struct ciphdr));
233 				fprintf(stderr, "Data block size (CIP header): %d [q], %d [B]\n",
234 						ciph->len, ciph->len * 4);
235 				fprintf(stderr,
236 						"Data fraction number (CIP header): %d => DBC increments with %d\n",
237 						ciph->fn, (1<<ciph->fn) );
238 				fprintf(stderr, "QCP (CIP header): %d\n", ciph->qpc );
239 				fprintf(stderr, "DBC counter (CIP header): %d\n", ciph->dbc );
240 				fprintf(stderr, "MPEG payload type size: %d\n",
241 						sizeof(struct mpeg_pldt));
242 			}
243 #endif /* DEBUG */
244 
245 			/* This is a condition that needs to be satisfied to start
246 			   writing the data */
247 			if (ciph->dbc % (1<<ciph->fn) == 0)
248 				startwr = 1;
249 			/* Read out all the MPEG TS data blocks from current packet */
250 			for (pld = (struct mpeg_pldt *)ptr;
251 			    (intptr_t)pld < (intptr_t)((char *)ptr +
252 			    pkt->mode.stream.len - sizeof(struct ciphdr));
253 			    pld++) {
254 				if (startwr == 1)
255 					write(fd, pld->payload,
256 					    sizeof(pld->payload));
257 			}
258 
259 next:
260 			/* CRCs are removed from both header and trailer
261 			so that only 4 bytes of 1394 header remains */
262 			pkt_size = pkt->mode.stream.len + 4;
263 			ptr = (uint32_t *)((intptr_t)pkt + pkt_size);
264 			tlen -= pkt_size;
265 		} while (tlen > 0);
266 #if DEBUG
267 		fprintf(stderr, "\nReading a data from firewire.\n");
268 #endif /* DEBUG */
269 
270 	}
271 	if (fd != STDOUT_FILENO)
272 		close(fd);
273 	fprintf(stderr, "\n");
274 }
275