cinelerra-5.1/cinelerra/dv1394.h

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 /*
  23  * dv1394.h - DV input/output over IEEE 1394 on OHCI chips
  24  *   Copyright (C)2001 Daniel Maas <[email protected]>
  25  *     receive, proc_fs by Dan Dennedy <[email protected]>
  26  *
  27  * based on:
  28  *   video1394.h - driver for OHCI 1394 boards
  29  *   Copyright (C)1999,2000 Sebastien Rougeaux <[email protected]>
  30  *                          Peter Schlaile <[email protected]>
  31  *
  32  * This program is free software; you can redistribute it and/or modify
  33  * it under the terms of the GNU General Public License as published by
  34  * the Free Software Foundation; either version 2 of the License, or
  35  * (at your option) any later version.
  36  *
  37  * This program is distributed in the hope that it will be useful,
  38  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  39  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  40  * GNU General Public License for more details.
  41  *
  42  * You should have received a copy of the GNU General Public License
  43  * along with this program; if not, write to the Free Software Foundation,
  44  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  45  */
  46
  47 #ifndef _DV_1394_H
  48 #define _DV_1394_H
  49
  50 /* This is the public user-space interface. Try not to break it. */
  51
  52 #define DV1394_API_VERSION 0x20011127
  53
  54 /* ********************
  55    **                **
  56    **   DV1394 API   **
  57    **                **
  58    ********************
  59
  60    There are two methods of operating the DV1394 DV output device.
  61
  62    1)
  63
  64    The simplest is an interface based on write(): simply write
  65    full DV frames of data to the device, and they will be transmitted
  66    as quickly as possible. The FD may be set for non-blocking I/O,
  67    in which case you can use select() or poll() to wait for output
  68    buffer space.
  69
  70    To set the DV output parameters (e.g. whether you want NTSC or PAL
  71    video), use the DV1394_INIT ioctl, passing in the parameters you
  72    want in a struct dv1394_init.
  73
  74    Example 1:
  75          To play a raw .DV file:   cat foo.DV > /dev/dv1394
  76          (cat will use write() internally)
  77
  78    Example 2:
  79            static struct dv1394_init init = {
  80               0x63,        (broadcast channel)
  81               4,           (four-frame ringbuffer)
  82               DV1394_NTSC, (send NTSC video)
  83               0, 0         (default empty packet rate)
  84            }
  85
  86            ioctl(fd, DV1394_INIT, &init);
  87
  88            while(1) {
  89                   read( <a raw DV file>, buf, DV1394_NTSC_FRAME_SIZE );
  90                   write( <the dv1394 FD>, buf, DV1394_NTSC_FRAME_SIZE );
  91            }
  92
  93    2)
  94
  95    For more control over buffering, and to avoid unnecessary copies
  96    of the DV data, you can use the more sophisticated the mmap() interface.
  97    First, call the DV1394_INIT ioctl to specify your parameters,
  98    including the number of frames in the ringbuffer. Then, calling mmap()
  99    on the dv1394 device will give you direct access to the ringbuffer
 100    from which the DV card reads your frame data.
 101
 102    The ringbuffer is simply one large, contiguous region of memory
 103    containing two or more frames of packed DV data. Each frame of DV data
 104    is 120000 bytes (NTSC) or 144000 bytes (PAL).
 105
 106    Fill one or more frames in the ringbuffer, then use the DV1394_SUBMIT_FRAMES
 107    ioctl to begin I/O. You can use either the DV1394_WAIT_FRAMES ioctl
 108    or select()/poll() to wait until the frames are transmitted. Next, you'll
 109    need to call the DV1394_GET_STATUS ioctl to determine which ringbuffer
 110    frames are clear (ready to be filled with new DV data). Finally, use
 111    DV1394_SUBMIT_FRAMES again to send the new data to the DV output.
 112
 113
 114    Example: here is what a four-frame ringbuffer might look like
 115             during DV transmission:
 116
 117
 118          frame 0   frame 1   frame 2   frame 3
 119
 120         *--------------------------------------*
 121         | CLEAR   | DV data | DV data | CLEAR  |
 122         *--------------------------------------*
 123                    <ACTIVE>
 124
 125         transmission goes in this direction --->>>
 126
 127
 128    The DV hardware is currently transmitting the data in frame 1.
 129    Once frame 1 is finished, it will automatically transmit frame 2.
 130    (if frame 2 finishes before frame 3 is submitted, the device
 131    will continue to transmit frame 2, and will increase the dropped_frames
 132    counter each time it repeats the transmission).
 133
 134
 135    If you called DV1394_GET_STATUS at this instant, you would
 136    receive the following values:
 137
 138           n_frames          = 4
 139           active_frame      = 1
 140           first_clear_frame = 3
 141           n_clear_frames    = 2
 142
 143    At this point, you should write new DV data into frame 3 and optionally
 144    frame 0. Then call DV1394_SUBMIT_FRAMES to inform the device that
 145    it may transmit the new frames.
 146
 147    ERROR HANDLING
 148
 149    An error (buffer underflow/overflow or a break in the DV stream due
 150    to a 1394 bus reset) can be detected by checking the dropped_frames
 151    field of struct dv1394_status (obtained through the
 152    DV1394_GET_STATUS ioctl).
 153
 154    The best way to recover from such an error is to re-initialize
 155    dv1394, either by using the DV1394_INIT ioctl call, or closing the
 156    file descriptor and opening it again. (note that you must unmap all
 157    ringbuffer mappings when closing the file descriptor, or else
 158    dv1394 will still be considered 'in use').
 159
 160    MAIN LOOP
 161
 162    For maximum efficiency and robustness against bus errors, you are
 163    advised to model the main loop of your application after the
 164    following pseudo-code example:
 165
 166    (checks of system call return values omitted for brevity; always
 167    check return values in your code!)
 168
 169    while ( frames left ) {
 170
 171     struct pollfd *pfd = ...;
 172
 173     pfd->fd = dv1394_fd;
 174     pfd->revents = 0;
 175     pfd->events = POLLOUT | POLLIN; (OUT for transmit, IN for receive)
 176
 177     (add other sources of I/O here)
 178
 179     poll(pfd, 1, -1); (or select(); add a timeout if you want)
 180
 181     if (pfd->revents) {
 182          struct dv1394_status status;
 183
 184          ioctl(dv1394_fd, DV1394_GET_STATUS, &status);
 185
 186          if (status.dropped_frames > 0) {
 187               reset_dv1394();
 188          } else {
 189               for (int i = 0; i < status.n_clear_frames; i++) {
 190                   copy_DV_frame();
 191               }
 192          }
 193     }
 194    }
 195
 196    where copy_DV_frame() reads or writes on the dv1394 file descriptor
 197    (read/write mode) or copies data to/from the mmap ringbuffer and
 198    then calls ioctl(DV1394_SUBMIT_FRAMES) to notify dv1394 that new
 199    frames are availble (mmap mode).
 200
 201    reset_dv1394() is called in the event of a buffer
 202    underflow/overflow or a halt in the DV stream (e.g. due to a 1394
 203    bus reset). To guarantee recovery from the error, this function
 204    should close the dv1394 file descriptor (and munmap() all
 205    ringbuffer mappings, if you are using them), then re-open the
 206    dv1394 device (and re-map the ringbuffer).
 207
 208 */
 209
 210
 211 /* maximum number of frames in the ringbuffer */
 212 #define DV1394_MAX_FRAMES 32
 213
 214 /* number of *full* isochronous packets per DV frame */
 215 #define DV1394_NTSC_PACKETS_PER_FRAME 250
 216 #define DV1394_PAL_PACKETS_PER_FRAME  300
 217
 218 /* size of one frame's worth of DV data, in bytes */
 219 #define DV1394_NTSC_FRAME_SIZE (480 * DV1394_NTSC_PACKETS_PER_FRAME)
 220 #define DV1394_PAL_FRAME_SIZE  (480 * DV1394_PAL_PACKETS_PER_FRAME)
 221
 222
 223 /* ioctl() commands */
 224 #include "ieee1394-ioctl.h"
 225
 226
 227 enum pal_or_ntsc {
 228         DV1394_NTSC = 0,
 229         DV1394_PAL
 230 };
 231
 232
 233
 234
 235 /* this is the argument to DV1394_INIT */
 236 struct dv1394_init {
 237         /* DV1394_API_VERSION */
 238         unsigned int api_version;
 239
 240         /* isochronous transmission channel to use */
 241         unsigned int channel;
 242
 243         /* number of frames in the ringbuffer. Must be at least 2
 244            and at most DV1394_MAX_FRAMES. */
 245         unsigned int n_frames;
 246
 247         /* send/receive PAL or NTSC video format */
 248         enum pal_or_ntsc format;
 249
 250         /* the following are used only for transmission */
 251
 252         /* set these to zero unless you want a
 253            non-default empty packet rate (see below) */
 254         unsigned long cip_n;
 255         unsigned long cip_d;
 256
 257         /* set this to zero unless you want a
 258            non-default SYT cycle offset (default = 3 cycles) */
 259         unsigned int syt_offset;
 260 };
 261
 262 /* NOTE: you may only allocate the DV frame ringbuffer once each time
 263    you open the dv1394 device. DV1394_INIT will fail if you call it a
 264    second time with different 'n_frames' or 'format' arguments (which
 265    would imply a different size for the ringbuffer). If you need a
 266    different buffer size, simply close and re-open the device, then
 267    initialize it with your new settings. */
 268
 269 /* Q: What are cip_n and cip_d? */
 270
 271 /*
 272   A: DV video streams do not utilize 100% of the potential bandwidth offered
 273   by IEEE 1394 (FireWire). To achieve the correct rate of data transmission,
 274   DV devices must periodically insert empty packets into the 1394 data stream.
 275   Typically there is one empty packet per 14-16 data-carrying packets.
 276
 277   Some DV devices will accept a wide range of empty packet rates, while others
 278   require a precise rate. If the dv1394 driver produces empty packets at
 279   a rate that your device does not accept, you may see ugly patterns on the
 280   DV output, or even no output at all.
 281
 282   The default empty packet insertion rate seems to work for many people; if
 283   your DV output is stable, you can simply ignore this discussion. However,
 284   we have exposed the empty packet rate as a parameter to support devices that
 285   do not work with the default rate.
 286
 287   The decision to insert an empty packet is made with a numerator/denominator
 288   algorithm. Empty packets are produced at an average rate of CIP_N / CIP_D.
 289   You can alter the empty packet rate by passing non-zero values for cip_n
 290   and cip_d to the INIT ioctl.
 291
 292  */
 293
 294
 295
 296 struct dv1394_status {
 297         /* this embedded init struct returns the current dv1394
 298            parameters in use */
 299         struct dv1394_init init;
 300
 301         /* the ringbuffer frame that is currently being
 302            displayed. (-1 if the device is not transmitting anything) */
 303         int active_frame;
 304
 305         /* index of the first buffer (ahead of active_frame) that
 306            is ready to be filled with data */
 307         unsigned int first_clear_frame;
 308
 309         /* how many buffers, including first_clear_buffer, are
 310            ready to be filled with data */
 311         unsigned int n_clear_frames;
 312
 313         /* how many times the DV stream has underflowed, overflowed,
 314            or otherwise encountered an error, since the previous call
 315            to DV1394_GET_STATUS */
 316         unsigned int dropped_frames;
 317
 318         /* N.B. The dropped_frames counter is only a lower bound on the actual
 319            number of dropped frames, with the special case that if dropped_frames
 320            is zero, then it is guaranteed that NO frames have been dropped
 321            since the last call to DV1394_GET_STATUS.
 322         */
 323 };
 324
 325
 326 #endif /* _DV_1394_H */