Statistics
| Branch: | Revision:

ffmpeg / libavformat / dv1394.h @ 20cd83e2

History | View | Annotate | Download (12 KB)

1 8aa3ee32 Max Krasnyansky
/*
2
 * dv1394.h - DV input/output over IEEE 1394 on OHCI chips
3
 *   Copyright (C)2001 Daniel Maas <dmaas@dcine.com>
4
 *     receive, proc_fs by Dan Dennedy <dan@dennedy.org>
5
 *
6
 * based on:
7
 *   video1394.h - driver for OHCI 1394 boards
8
 *   Copyright (C)1999,2000 Sebastien Rougeaux <sebastien.rougeaux@anu.edu.au>
9
 *                          Peter Schlaile <udbz@rz.uni-karlsruhe.de>
10
 *
11 b78e7197 Diego Biurrun
 * This file is part of FFmpeg.
12
 *
13
 * FFmpeg is free software; you can redistribute it and/or
14 efa4b887 Diego Biurrun
 * modify it under the terms of the GNU Lesser General Public
15
 * License as published by the Free Software Foundation; either
16 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
17 8aa3ee32 Max Krasnyansky
 *
18 b78e7197 Diego Biurrun
 * FFmpeg is distributed in the hope that it will be useful,
19 8aa3ee32 Max Krasnyansky
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 efa4b887 Diego Biurrun
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21
 * Lesser General Public License for more details.
22 8aa3ee32 Max Krasnyansky
 *
23 efa4b887 Diego Biurrun
 * You should have received a copy of the GNU Lesser General Public
24 b78e7197 Diego Biurrun
 * License along with FFmpeg; if not, write to the Free Software
25 efa4b887 Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 5509bffa Diego Biurrun
 *
27 8aa3ee32 Max Krasnyansky
 */
28
29
#ifndef _DV_1394_H
30
#define _DV_1394_H
31
32 1fbe1a61 Roman Shaposhnik
#define DV1394_DEFAULT_CHANNEL 63
33 8aa3ee32 Max Krasnyansky
#define DV1394_DEFAULT_CARD    0
34
#define DV1394_RING_FRAMES     20
35
36
#define DV1394_WIDTH  720
37 cad6f6cd Alex Beregszaszi
#define DV1394_NTSC_HEIGHT 480
38
#define DV1394_PAL_HEIGHT 576
39 8aa3ee32 Max Krasnyansky
40
/* This is the public user-space interface. Try not to break it. */
41
42
#define DV1394_API_VERSION 0x20011127
43
44
/* ********************
45
   **                **
46
   **   DV1394 API   **
47
   **                **
48
   ********************
49

50
   There are two methods of operating the DV1394 DV output device.
51

52
   1)
53

54
   The simplest is an interface based on write(): simply write
55
   full DV frames of data to the device, and they will be transmitted
56
   as quickly as possible. The FD may be set for non-blocking I/O,
57
   in which case you can use select() or poll() to wait for output
58
   buffer space.
59

60
   To set the DV output parameters (e.g. whether you want NTSC or PAL
61
   video), use the DV1394_INIT ioctl, passing in the parameters you
62
   want in a struct dv1394_init.
63 115329f1 Diego Biurrun

64 8aa3ee32 Max Krasnyansky
   Example 1:
65
         To play a raw .DV file:   cat foo.DV > /dev/dv1394
66 bb270c08 Diego Biurrun
         (cat will use write() internally)
67 8aa3ee32 Max Krasnyansky

68
   Example 2:
69
           static struct dv1394_init init = {
70 bb270c08 Diego Biurrun
              0x63,        (broadcast channel)
71 8aa3ee32 Max Krasnyansky
              4,           (four-frame ringbuffer)
72 bb270c08 Diego Biurrun
              DV1394_NTSC, (send NTSC video)
73
              0, 0         (default empty packet rate)
74 8aa3ee32 Max Krasnyansky
           }
75

76 bb270c08 Diego Biurrun
           ioctl(fd, DV1394_INIT, &init);
77 8aa3ee32 Max Krasnyansky

78 bb270c08 Diego Biurrun
           while(1) {
79
                  read( <a raw DV file>, buf, DV1394_NTSC_FRAME_SIZE );
80
                  write( <the dv1394 FD>, buf, DV1394_NTSC_FRAME_SIZE );
81 8aa3ee32 Max Krasnyansky
           }
82

83
   2)
84

85
   For more control over buffering, and to avoid unnecessary copies
86 115329f1 Diego Biurrun
   of the DV data, you can use the more sophisticated the mmap() interface.
87
   First, call the DV1394_INIT ioctl to specify your parameters,
88
   including the number of frames in the ringbuffer. Then, calling mmap()
89 8aa3ee32 Max Krasnyansky
   on the dv1394 device will give you direct access to the ringbuffer
90
   from which the DV card reads your frame data.
91

92
   The ringbuffer is simply one large, contiguous region of memory
93
   containing two or more frames of packed DV data. Each frame of DV data
94
   is 120000 bytes (NTSC) or 144000 bytes (PAL).
95

96
   Fill one or more frames in the ringbuffer, then use the DV1394_SUBMIT_FRAMES
97
   ioctl to begin I/O. You can use either the DV1394_WAIT_FRAMES ioctl
98
   or select()/poll() to wait until the frames are transmitted. Next, you'll
99
   need to call the DV1394_GET_STATUS ioctl to determine which ringbuffer
100
   frames are clear (ready to be filled with new DV data). Finally, use
101
   DV1394_SUBMIT_FRAMES again to send the new data to the DV output.
102

103

104
   Example: here is what a four-frame ringbuffer might look like
105
            during DV transmission:
106

107

108
         frame 0   frame 1   frame 2   frame 3
109

110 bb270c08 Diego Biurrun
        *--------------------------------------*
111 8aa3ee32 Max Krasnyansky
        | CLEAR   | DV data | DV data | CLEAR  |
112
        *--------------------------------------*
113 115329f1 Diego Biurrun
                   <ACTIVE>
114 8aa3ee32 Max Krasnyansky

115 bb270c08 Diego Biurrun
        transmission goes in this direction --->>>
116 8aa3ee32 Max Krasnyansky

117

118
   The DV hardware is currently transmitting the data in frame 1.
119
   Once frame 1 is finished, it will automatically transmit frame 2.
120
   (if frame 2 finishes before frame 3 is submitted, the device
121
   will continue to transmit frame 2, and will increase the dropped_frames
122
   counter each time it repeats the transmission).
123

124 115329f1 Diego Biurrun

125 8aa3ee32 Max Krasnyansky
   If you called DV1394_GET_STATUS at this instant, you would
126
   receive the following values:
127 115329f1 Diego Biurrun

128 8aa3ee32 Max Krasnyansky
                  n_frames          = 4
129 bb270c08 Diego Biurrun
                  active_frame      = 1
130
                  first_clear_frame = 3
131
                  n_clear_frames    = 2
132 8aa3ee32 Max Krasnyansky

133
   At this point, you should write new DV data into frame 3 and optionally
134
   frame 0. Then call DV1394_SUBMIT_FRAMES to inform the device that
135
   it may transmit the new frames.
136

137
   ERROR HANDLING
138

139
   An error (buffer underflow/overflow or a break in the DV stream due
140
   to a 1394 bus reset) can be detected by checking the dropped_frames
141
   field of struct dv1394_status (obtained through the
142
   DV1394_GET_STATUS ioctl).
143

144
   The best way to recover from such an error is to re-initialize
145
   dv1394, either by using the DV1394_INIT ioctl call, or closing the
146
   file descriptor and opening it again. (note that you must unmap all
147
   ringbuffer mappings when closing the file descriptor, or else
148
   dv1394 will still be considered 'in use').
149

150
   MAIN LOOP
151

152
   For maximum efficiency and robustness against bus errors, you are
153
   advised to model the main loop of your application after the
154
   following pseudo-code example:
155

156
   (checks of system call return values omitted for brevity; always
157
   check return values in your code!)
158 115329f1 Diego Biurrun

159 8aa3ee32 Max Krasnyansky
   while( frames left ) {
160 115329f1 Diego Biurrun

161 8aa3ee32 Max Krasnyansky
    struct pollfd *pfd = ...;
162

163
    pfd->fd = dv1394_fd;
164
    pfd->revents = 0;
165
    pfd->events = POLLOUT | POLLIN; (OUT for transmit, IN for receive)
166

167
    (add other sources of I/O here)
168 115329f1 Diego Biurrun

169 8aa3ee32 Max Krasnyansky
    poll(pfd, 1, -1); (or select(); add a timeout if you want)
170

171
    if(pfd->revents) {
172
         struct dv1394_status status;
173 115329f1 Diego Biurrun

174 8aa3ee32 Max Krasnyansky
         ioctl(dv1394_fd, DV1394_GET_STATUS, &status);
175

176 bb270c08 Diego Biurrun
         if(status.dropped_frames > 0) {
177
              reset_dv1394();
178 8aa3ee32 Max Krasnyansky
         } else {
179
              for(int i = 0; i < status.n_clear_frames; i++) {
180 bb270c08 Diego Biurrun
                  copy_DV_frame();
181 8aa3ee32 Max Krasnyansky
              }
182
         }
183
    }
184
   }
185

186
   where copy_DV_frame() reads or writes on the dv1394 file descriptor
187
   (read/write mode) or copies data to/from the mmap ringbuffer and
188
   then calls ioctl(DV1394_SUBMIT_FRAMES) to notify dv1394 that new
189
   frames are availble (mmap mode).
190

191
   reset_dv1394() is called in the event of a buffer
192
   underflow/overflow or a halt in the DV stream (e.g. due to a 1394
193
   bus reset). To guarantee recovery from the error, this function
194
   should close the dv1394 file descriptor (and munmap() all
195
   ringbuffer mappings, if you are using them), then re-open the
196
   dv1394 device (and re-map the ringbuffer).
197 115329f1 Diego Biurrun

198 8aa3ee32 Max Krasnyansky
*/
199
200
201
/* maximum number of frames in the ringbuffer */
202
#define DV1394_MAX_FRAMES 32
203
204
/* number of *full* isochronous packets per DV frame */
205 1fbe1a61 Roman Shaposhnik
#define DV1394_NTSC_PACKETS_PER_FRAME 250
206
#define DV1394_PAL_PACKETS_PER_FRAME  300
207 8aa3ee32 Max Krasnyansky
208
/* size of one frame's worth of DV data, in bytes */
209
#define DV1394_NTSC_FRAME_SIZE (480 * DV1394_NTSC_PACKETS_PER_FRAME)
210 1fbe1a61 Roman Shaposhnik
#define DV1394_PAL_FRAME_SIZE  (480 * DV1394_PAL_PACKETS_PER_FRAME)
211 8aa3ee32 Max Krasnyansky
212
213
/* ioctl() commands */
214
215
enum {
216 bb270c08 Diego Biurrun
        /* I don't like using 0 as a valid ioctl() */
217
        DV1394_INVALID = 0,
218 8aa3ee32 Max Krasnyansky
219
220 bb270c08 Diego Biurrun
        /* get the driver ready to transmit video.
221
           pass a struct dv1394_init* as the parameter (see below),
222
           or NULL to get default parameters */
223
        DV1394_INIT,
224 8aa3ee32 Max Krasnyansky
225
226 bb270c08 Diego Biurrun
        /* stop transmitting video and free the ringbuffer */
227
        DV1394_SHUTDOWN,
228 8aa3ee32 Max Krasnyansky
229
230 bb270c08 Diego Biurrun
        /* submit N new frames to be transmitted, where
231
           the index of the first new frame is first_clear_buffer,
232
           and the index of the last new frame is
233
           (first_clear_buffer + N) % n_frames */
234
        DV1394_SUBMIT_FRAMES,
235 8aa3ee32 Max Krasnyansky
236
237 bb270c08 Diego Biurrun
        /* block until N buffers are clear (pass N as the parameter)
238
           Because we re-transmit the last frame on underrun, there
239
           will at most be n_frames - 1 clear frames at any time */
240
        DV1394_WAIT_FRAMES,
241 8aa3ee32 Max Krasnyansky
242 bb270c08 Diego Biurrun
        /* capture new frames that have been received, where
243
           the index of the first new frame is first_clear_buffer,
244
           and the index of the last new frame is
245
           (first_clear_buffer + N) % n_frames */
246
        DV1394_RECEIVE_FRAMES,
247 8aa3ee32 Max Krasnyansky
248
249 bb270c08 Diego Biurrun
        DV1394_START_RECEIVE,
250 8aa3ee32 Max Krasnyansky
251
252 bb270c08 Diego Biurrun
        /* pass a struct dv1394_status* as the parameter (see below) */
253
        DV1394_GET_STATUS,
254 8aa3ee32 Max Krasnyansky
};
255
256
257
258
enum pal_or_ntsc {
259 bb270c08 Diego Biurrun
        DV1394_NTSC = 0,
260
        DV1394_PAL
261 8aa3ee32 Max Krasnyansky
};
262
263
264
265
266
/* this is the argument to DV1394_INIT */
267
struct dv1394_init {
268 bb270c08 Diego Biurrun
        /* DV1394_API_VERSION */
269
        unsigned int api_version;
270 115329f1 Diego Biurrun
271 bb270c08 Diego Biurrun
        /* isochronous transmission channel to use */
272
        unsigned int channel;
273 8aa3ee32 Max Krasnyansky
274 bb270c08 Diego Biurrun
        /* number of frames in the ringbuffer. Must be at least 2
275
           and at most DV1394_MAX_FRAMES. */
276
        unsigned int n_frames;
277 8aa3ee32 Max Krasnyansky
278 bb270c08 Diego Biurrun
        /* send/receive PAL or NTSC video format */
279
        enum pal_or_ntsc format;
280 8aa3ee32 Max Krasnyansky
281 bb270c08 Diego Biurrun
        /* the following are used only for transmission */
282 115329f1 Diego Biurrun
283 bb270c08 Diego Biurrun
        /* set these to zero unless you want a
284
           non-default empty packet rate (see below) */
285
        unsigned long cip_n;
286
        unsigned long cip_d;
287 8aa3ee32 Max Krasnyansky
288 bb270c08 Diego Biurrun
        /* set this to zero unless you want a
289
           non-default SYT cycle offset (default = 3 cycles) */
290
        unsigned int syt_offset;
291 8aa3ee32 Max Krasnyansky
};
292
293
/* NOTE: you may only allocate the DV frame ringbuffer once each time
294
   you open the dv1394 device. DV1394_INIT will fail if you call it a
295
   second time with different 'n_frames' or 'format' arguments (which
296
   would imply a different size for the ringbuffer). If you need a
297
   different buffer size, simply close and re-open the device, then
298
   initialize it with your new settings. */
299 115329f1 Diego Biurrun
300 8aa3ee32 Max Krasnyansky
/* Q: What are cip_n and cip_d? */
301
302
/*
303
  A: DV video streams do not utilize 100% of the potential bandwidth offered
304
  by IEEE 1394 (FireWire). To achieve the correct rate of data transmission,
305
  DV devices must periodically insert empty packets into the 1394 data stream.
306
  Typically there is one empty packet per 14-16 data-carrying packets.
307

308
  Some DV devices will accept a wide range of empty packet rates, while others
309
  require a precise rate. If the dv1394 driver produces empty packets at
310
  a rate that your device does not accept, you may see ugly patterns on the
311
  DV output, or even no output at all.
312

313
  The default empty packet insertion rate seems to work for many people; if
314
  your DV output is stable, you can simply ignore this discussion. However,
315
  we have exposed the empty packet rate as a parameter to support devices that
316 115329f1 Diego Biurrun
  do not work with the default rate.
317 8aa3ee32 Max Krasnyansky

318
  The decision to insert an empty packet is made with a numerator/denominator
319
  algorithm. Empty packets are produced at an average rate of CIP_N / CIP_D.
320
  You can alter the empty packet rate by passing non-zero values for cip_n
321
  and cip_d to the INIT ioctl.
322 115329f1 Diego Biurrun

323 8aa3ee32 Max Krasnyansky
 */
324
325
326
327
struct dv1394_status {
328 bb270c08 Diego Biurrun
        /* this embedded init struct returns the current dv1394
329
           parameters in use */
330
        struct dv1394_init init;
331
332
        /* the ringbuffer frame that is currently being
333
           displayed. (-1 if the device is not transmitting anything) */
334
        int active_frame;
335
336
        /* index of the first buffer (ahead of active_frame) that
337
           is ready to be filled with data */
338
        unsigned int first_clear_frame;
339
340
        /* how many buffers, including first_clear_buffer, are
341
           ready to be filled with data */
342
        unsigned int n_clear_frames;
343
344
        /* how many times the DV stream has underflowed, overflowed,
345
           or otherwise encountered an error, since the previous call
346
           to DV1394_GET_STATUS */
347
        unsigned int dropped_frames;
348
349
        /* N.B. The dropped_frames counter is only a lower bound on the actual
350
           number of dropped frames, with the special case that if dropped_frames
351
           is zero, then it is guaranteed that NO frames have been dropped
352
           since the last call to DV1394_GET_STATUS.
353
        */
354 8aa3ee32 Max Krasnyansky
};
355
356
357
#endif /* _DV_1394_H */