lavdev: add openal input device
[ffmpeg.git] / libavdevice / openal-dec.c
1 /*
2  * Copyright (c) 2011 Jonathan Baldwin
3  *
4  * This file is part of FFmpeg.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24
25 /**
26  * @file
27  * OpenAL 1.1 capture device for libavdevice
28  **/
29
30 #include <AL/al.h>
31 #include <AL/alc.h>
32
33 #include "libavutil/opt.h"
34 #include "avdevice.h"
35
36 typedef struct {
37     AVClass *class;
38     /** OpenAL capture device context. **/
39     ALCdevice *device;
40     /** The number of channels in the captured audio. **/
41     int channels;
42     /** The sample rate (in Hz) of the captured audio. **/
43     int sample_rate;
44     /** The sample size (in bits) of the captured audio. **/
45     int sample_size;
46     /** The OpenAL sample format of the captured audio. **/
47     ALCenum sample_format;
48     /** The number of bytes between two consecutive samples of the same channel/component. **/
49     ALCint sample_step;
50     /** If true, print a list of capture devices on this system and exit. **/
51     int list_devices;
52 } al_data;
53
54 typedef struct {
55     ALCenum al_fmt;
56     enum CodecID codec_id;
57     int channels;
58 } al_format_info;
59
60 #define LOWEST_AL_FORMAT FFMIN(FFMIN(AL_FORMAT_MONO8,AL_FORMAT_MONO16),FFMIN(AL_FORMAT_STEREO8,AL_FORMAT_STEREO16))
61
62 /**
63  * Get information about an AL_FORMAT value.
64  * @param al_fmt the AL_FORMAT value to find information about.
65  * @return A pointer to a structure containing information about the AL_FORMAT value.
66  */
67 static inline al_format_info* get_al_format_info(ALCenum al_fmt)
68 {
69     static al_format_info info_table[] = {
70         [AL_FORMAT_MONO8-LOWEST_AL_FORMAT]    = {AL_FORMAT_MONO8, CODEC_ID_PCM_U8, 1},
71         [AL_FORMAT_MONO16-LOWEST_AL_FORMAT]   = {AL_FORMAT_MONO16, AV_NE (CODEC_ID_PCM_S16BE, CODEC_ID_PCM_S16LE), 1},
72         [AL_FORMAT_STEREO8-LOWEST_AL_FORMAT]  = {AL_FORMAT_STEREO8, CODEC_ID_PCM_U8, 2},
73         [AL_FORMAT_STEREO16-LOWEST_AL_FORMAT] = {AL_FORMAT_STEREO16, AV_NE (CODEC_ID_PCM_S16BE, CODEC_ID_PCM_S16LE), 2},
74     };
75
76     return &info_table[al_fmt-LOWEST_AL_FORMAT];
77 }
78
79 /**
80  * Get the OpenAL error code, translated into an av/errno error code.
81  * @param device The ALC device to check for errors.
82  * @param error_msg_ret A pointer to a char* in which to return the error message, or NULL if desired.
83  * @return The error code, or 0 if there is no error.
84  */
85 static inline int al_get_error(ALCdevice *device, const char** error_msg_ret)
86 {
87     ALCenum error = alcGetError(device);
88     if (error_msg_ret)
89         *error_msg_ret = (const char*) alcGetString(device, error);
90     switch (error) {
91     case ALC_NO_ERROR:
92         return 0;
93     case ALC_INVALID_DEVICE:
94         return AVERROR(ENODEV);
95         break;
96     case ALC_INVALID_CONTEXT:
97     case ALC_INVALID_ENUM:
98     case ALC_INVALID_VALUE:
99         return AVERROR(EINVAL);
100         break;
101     case ALC_OUT_OF_MEMORY:
102         return AVERROR(ENOMEM);
103         break;
104     default:
105         return AVERROR(EIO);
106     }
107 }
108
109 /**
110  * Print out a list of OpenAL capture devices on this system.
111  */
112 static inline void print_al_capture_devices(void *log_ctx)
113 {
114     const char *devices;
115
116     if (!(devices = alcGetString(NULL, ALC_CAPTURE_DEVICE_SPECIFIER)))
117         return;
118
119     av_log(log_ctx, AV_LOG_INFO, "List of OpenAL capture devices on this system:\n");
120
121     for (; *devices != '\0'; devices += strlen(devices) + 1)
122         av_log(log_ctx, AV_LOG_INFO, "  %s\n", devices);
123 }
124
125 static int read_header(AVFormatContext *ctx, AVFormatParameters *ap)
126 {
127     al_data *ad = ctx->priv_data;
128     static const ALCenum sample_formats[2][2] = {
129         { AL_FORMAT_MONO8,  AL_FORMAT_STEREO8  },
130         { AL_FORMAT_MONO16, AL_FORMAT_STEREO16 }
131     };
132     int error = 0;
133     const char *error_msg;
134     AVStream *st = NULL;
135     AVCodecContext *codec = NULL;
136
137     if (ad->list_devices) {
138         print_al_capture_devices(ctx);
139         return AVERROR_EXIT;
140     }
141
142     ad->sample_format = sample_formats[ad->sample_size/8-1][ad->channels-1];
143
144     /* Open device for capture */
145     ad->device =
146         alcCaptureOpenDevice(ctx->filename[0] ? ctx->filename : NULL,
147                              ad->sample_rate,
148                              ad->sample_format,
149                              ad->sample_rate); /* Maximum 1 second of sample data to be read at once */
150
151     if (error = al_get_error(ad->device, &error_msg)) goto fail;
152
153     /* Create stream */
154     if (!(st = av_new_stream(ctx, 0))) {
155         error = AVERROR(ENOMEM);
156         goto fail;
157     }
158
159     /* We work in microseconds */
160     av_set_pts_info(st, 64, 1, 1000000);
161
162     /* Set codec parameters */
163     codec = st->codec;
164     codec->codec_type = AVMEDIA_TYPE_AUDIO;
165     codec->sample_rate = ad->sample_rate;
166     codec->channels = get_al_format_info(ad->sample_format)->channels;
167     codec->codec_id = get_al_format_info(ad->sample_format)->codec_id;
168
169     /* This is needed to read the audio data */
170     ad->sample_step = (av_get_bits_per_sample(get_al_format_info(ad->sample_format)->codec_id) *
171                        get_al_format_info(ad->sample_format)->channels) / 8;
172
173     /* Finally, start the capture process */
174     alcCaptureStart(ad->device);
175
176     return 0;
177
178 fail:
179     /* Handle failure */
180     if (ad->device)
181         alcCaptureCloseDevice(ad->device);
182     if (error_msg)
183         av_log(ctx, AV_LOG_ERROR, "Cannot open device: %s\n", error_msg);
184     return error;
185 }
186
187 static int read_packet(AVFormatContext* ctx, AVPacket *pkt)
188 {
189     al_data *ad = ctx->priv_data;
190     int error=0;
191     const char *error_msg;
192     ALCint nb_samples;
193
194     /* Get number of samples available */
195     alcGetIntegerv(ad->device, ALC_CAPTURE_SAMPLES, (ALCsizei) sizeof(ALCint), &nb_samples);
196     if (error = al_get_error(ad->device, &error_msg)) goto fail;
197
198     /* Create a packet of appropriate size */
199     av_new_packet(pkt, nb_samples*ad->sample_step);
200     pkt->pts = av_gettime();
201
202     /* Fill the packet with the available samples */
203     alcCaptureSamples(ad->device, pkt->data, nb_samples);
204     if (error = al_get_error(ad->device, &error_msg)) goto fail;
205
206     return pkt->size;
207 fail:
208     /* Handle failure */
209     if (pkt->data)
210         av_destruct_packet(pkt);
211     if (error_msg)
212         av_log(ctx, AV_LOG_ERROR, "Error: %s\n", error_msg);
213     return error;
214 }
215
216 static int read_close(AVFormatContext* ctx)
217 {
218     al_data *ad = ctx->priv_data;
219
220     if (ad->device) {
221         alcCaptureStop(ad->device);
222         alcCaptureCloseDevice(ad->device);
223     }
224     return 0;
225 }
226
227 #define OFFSET(x) offsetof(al_data, x)
228
229 static const AVOption options[] = {
230     {"channels", "set number of channels",     OFFSET(channels),     FF_OPT_TYPE_INT, {.dbl=2},     1, 2,      AV_OPT_FLAG_DECODING_PARAM },
231     {"sample_rate", "set sample rate",         OFFSET(sample_rate),  FF_OPT_TYPE_INT, {.dbl=44100}, 1, 192000, AV_OPT_FLAG_DECODING_PARAM },
232     {"sample_size", "set sample size",         OFFSET(sample_size),  FF_OPT_TYPE_INT, {.dbl=16},    8, 16,     AV_OPT_FLAG_DECODING_PARAM },
233     {"list_devices", "list available devices", OFFSET(list_devices), FF_OPT_TYPE_INT, {.dbl=0},     0, 1,      AV_OPT_FLAG_DECODING_PARAM },
234     {"true",  "", 0, FF_OPT_TYPE_CONST, {.dbl=1}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
235     {"false", "", 0, FF_OPT_TYPE_CONST, {.dbl=0}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "list_devices" },
236     {NULL},
237 };
238
239 static const AVClass class = {
240     .class_name = "openal",
241     .item_name = av_default_item_name,
242     .option = options,
243     .version = LIBAVUTIL_VERSION_INT
244 };
245
246 AVInputFormat ff_openal_demuxer = {
247     .name = "openal",
248     .long_name = NULL_IF_CONFIG_SMALL("OpenAL audio capture device"),
249     .priv_data_size = sizeof(al_data),
250     .read_probe = NULL,
251     .read_header = read_header,
252     .read_packet = read_packet,
253     .read_close = read_close,
254     .flags = AVFMT_NOFILE,
255     .priv_class = &class
256 };