lavf: deprecate AVFormatParameters.channel.
[ffmpeg.git] / libavdevice / dv1394.c
1 /*
2  * Linux DV1394 interface
3  * Copyright (c) 2003 Max Krasnyansky <maxk@qualcomm.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "config.h"
23 #include <unistd.h>
24 #include <fcntl.h>
25 #include <errno.h>
26 #include <poll.h>
27 #include <sys/ioctl.h>
28 #include <sys/mman.h>
29 #include <sys/time.h>
30 #include <time.h>
31 #include <strings.h>
32
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
35 #include "libavformat/avformat.h"
36
37 #undef DV1394_DEBUG
38
39 #include "libavformat/dv.h"
40 #include "dv1394.h"
41
42 struct dv1394_data {
43     AVClass *class;
44     int fd;
45     int channel;
46     int format;
47
48     uint8_t *ring; /* Ring buffer */
49     int index;  /* Current frame index */
50     int avail;  /* Number of frames available for reading */
51     int done;   /* Number of completed frames */
52
53     DVDemuxContext* dv_demux; /* Generic DV muxing/demuxing context */
54 };
55
56 /*
57  * The trick here is to kludge around well known problem with kernel Ooopsing
58  * when you try to capture PAL on a device node configure for NTSC. That's
59  * why we have to configure the device node for PAL, and then read only NTSC
60  * amount of data.
61  */
62 static int dv1394_reset(struct dv1394_data *dv)
63 {
64     struct dv1394_init init;
65
66     init.channel     = dv->channel;
67     init.api_version = DV1394_API_VERSION;
68     init.n_frames    = DV1394_RING_FRAMES;
69     init.format      = DV1394_PAL;
70
71     if (ioctl(dv->fd, DV1394_INIT, &init) < 0)
72         return -1;
73
74     dv->avail  = dv->done = 0;
75     return 0;
76 }
77
78 static int dv1394_start(struct dv1394_data *dv)
79 {
80     /* Tell DV1394 driver to enable receiver */
81     if (ioctl(dv->fd, DV1394_START_RECEIVE, 0) < 0) {
82         av_log(NULL, AV_LOG_ERROR, "Failed to start receiver: %s\n", strerror(errno));
83         return -1;
84     }
85     return 0;
86 }
87
88 static int dv1394_read_header(AVFormatContext * context, AVFormatParameters * ap)
89 {
90     struct dv1394_data *dv = context->priv_data;
91
92     dv->dv_demux = dv_init_demux(context);
93     if (!dv->dv_demux)
94         goto failed;
95
96 #if FF_API_FORMAT_PARAMETERS
97     if (ap->standard) {
98        if (!strcasecmp(ap->standard, "pal"))
99            dv->format = DV1394_PAL;
100        else
101            dv->format = DV1394_NTSC;
102     }
103
104     if (ap->channel)
105         dv->channel = ap->channel;
106 #endif
107
108     /* Open and initialize DV1394 device */
109     dv->fd = open(context->filename, O_RDONLY);
110     if (dv->fd < 0) {
111         av_log(context, AV_LOG_ERROR, "Failed to open DV interface: %s\n", strerror(errno));
112         goto failed;
113     }
114
115     if (dv1394_reset(dv) < 0) {
116         av_log(context, AV_LOG_ERROR, "Failed to initialize DV interface: %s\n", strerror(errno));
117         goto failed;
118     }
119
120     dv->ring = mmap(NULL, DV1394_PAL_FRAME_SIZE * DV1394_RING_FRAMES,
121                     PROT_READ, MAP_PRIVATE, dv->fd, 0);
122     if (dv->ring == MAP_FAILED) {
123         av_log(context, AV_LOG_ERROR, "Failed to mmap DV ring buffer: %s\n", strerror(errno));
124         goto failed;
125     }
126
127     if (dv1394_start(dv) < 0)
128         goto failed;
129
130     return 0;
131
132 failed:
133     close(dv->fd);
134     return AVERROR(EIO);
135 }
136
137 static int dv1394_read_packet(AVFormatContext *context, AVPacket *pkt)
138 {
139     struct dv1394_data *dv = context->priv_data;
140     int size;
141
142     size = dv_get_packet(dv->dv_demux, pkt);
143     if (size > 0)
144         return size;
145
146     if (!dv->avail) {
147         struct dv1394_status s;
148         struct pollfd p;
149
150         if (dv->done) {
151             /* Request more frames */
152             if (ioctl(dv->fd, DV1394_RECEIVE_FRAMES, dv->done) < 0) {
153                 /* This usually means that ring buffer overflowed.
154                  * We have to reset :(.
155                  */
156
157                 av_log(context, AV_LOG_ERROR, "DV1394: Ring buffer overflow. Reseting ..\n");
158
159                 dv1394_reset(dv);
160                 dv1394_start(dv);
161             }
162             dv->done = 0;
163         }
164
165         /* Wait until more frames are available */
166 restart_poll:
167         p.fd = dv->fd;
168         p.events = POLLIN | POLLERR | POLLHUP;
169         if (poll(&p, 1, -1) < 0) {
170             if (errno == EAGAIN || errno == EINTR)
171                 goto restart_poll;
172             av_log(context, AV_LOG_ERROR, "Poll failed: %s\n", strerror(errno));
173             return AVERROR(EIO);
174         }
175
176         if (ioctl(dv->fd, DV1394_GET_STATUS, &s) < 0) {
177             av_log(context, AV_LOG_ERROR, "Failed to get status: %s\n", strerror(errno));
178             return AVERROR(EIO);
179         }
180 #ifdef DV1394_DEBUG
181         av_log(context, AV_LOG_DEBUG, "DV1394: status\n"
182                 "\tactive_frame\t%d\n"
183                 "\tfirst_clear_frame\t%d\n"
184                 "\tn_clear_frames\t%d\n"
185                 "\tdropped_frames\t%d\n",
186                 s.active_frame, s.first_clear_frame,
187                 s.n_clear_frames, s.dropped_frames);
188 #endif
189
190         dv->avail = s.n_clear_frames;
191         dv->index = s.first_clear_frame;
192         dv->done  = 0;
193
194         if (s.dropped_frames) {
195             av_log(context, AV_LOG_ERROR, "DV1394: Frame drop detected (%d). Reseting ..\n",
196                     s.dropped_frames);
197
198             dv1394_reset(dv);
199             dv1394_start(dv);
200         }
201     }
202
203 #ifdef DV1394_DEBUG
204     av_log(context, AV_LOG_DEBUG, "index %d, avail %d, done %d\n", dv->index, dv->avail,
205             dv->done);
206 #endif
207
208     size = dv_produce_packet(dv->dv_demux, pkt,
209                              dv->ring + (dv->index * DV1394_PAL_FRAME_SIZE),
210                              DV1394_PAL_FRAME_SIZE);
211     dv->index = (dv->index + 1) % DV1394_RING_FRAMES;
212     dv->done++; dv->avail--;
213
214     return size;
215 }
216
217 static int dv1394_close(AVFormatContext * context)
218 {
219     struct dv1394_data *dv = context->priv_data;
220
221     /* Shutdown DV1394 receiver */
222     if (ioctl(dv->fd, DV1394_SHUTDOWN, 0) < 0)
223         av_log(context, AV_LOG_ERROR, "Failed to shutdown DV1394: %s\n", strerror(errno));
224
225     /* Unmap ring buffer */
226     if (munmap(dv->ring, DV1394_NTSC_FRAME_SIZE * DV1394_RING_FRAMES) < 0)
227         av_log(context, AV_LOG_ERROR, "Failed to munmap DV1394 ring buffer: %s\n", strerror(errno));
228
229     close(dv->fd);
230     av_free(dv->dv_demux);
231
232     return 0;
233 }
234
235 static const AVOption options[] = {
236     { "standard", "", offsetof(struct dv1394_data, format), FF_OPT_TYPE_INT, {.dbl = DV1394_NTSC}, DV1394_PAL, DV1394_NTSC, AV_OPT_FLAG_DECODING_PARAM, "standard" },
237     { "PAL",      "", 0, FF_OPT_TYPE_CONST, {.dbl = DV1394_PAL},   0, 0, AV_OPT_FLAG_DECODING_PARAM, "standard" },
238     { "NTSC",     "", 0, FF_OPT_TYPE_CONST, {.dbl = DV1394_NTSC},  0, 0, AV_OPT_FLAG_DECODING_PARAM, "standard" },
239     { "channel",  "", offsetof(struct dv1394_data, channel), FF_OPT_TYPE_INT, {.dbl = DV1394_DEFAULT_CHANNEL}, 0, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
240     { NULL },
241 };
242
243 static const AVClass dv1394_class = {
244     .class_name = "DV1394 indev",
245     .item_name  = av_default_item_name,
246     .option     = options,
247     .version    = LIBAVUTIL_VERSION_INT,
248 };
249
250 AVInputFormat ff_dv1394_demuxer = {
251     .name           = "dv1394",
252     .long_name      = NULL_IF_CONFIG_SMALL("DV1394 A/V grab"),
253     .priv_data_size = sizeof(struct dv1394_data),
254     .read_header    = dv1394_read_header,
255     .read_packet    = dv1394_read_packet,
256     .read_close     = dv1394_close,
257     .flags          = AVFMT_NOFILE,
258     .priv_class     = &dv1394_class,
259 };