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