git.sesse.net Git - vlc/blob - modules/audio_output/audiotrack.c

   1 /*****************************************************************************
   2  * audiotrack.c: Android native AudioTrack audio output module
   3  *****************************************************************************
   4  * Copyright © 2012 VLC authors and VideoLAN
   5  *
   6  * Authors: Ming Hu <tewilove@gmail.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include "config.h"
  25 #endif
  26
  27 #include <vlc_common.h>
  28 #include <vlc_plugin.h>
  29 #include <vlc_aout.h>
  30
  31 #include <dlfcn.h>
  32 #include <assert.h>
  33
  34 #define SIZE_OF_AUDIOTRACK 256
  35
  36 /* From AudioSystem.h */
  37 #define MUSIC 3
  38
  39 enum pcm_sub_format {
  40     PCM_SUB_16_BIT          = 0x1, // must be 1 for backward compatibility
  41     PCM_SUB_8_BIT           = 0x2  // must be 2 for backward compatibility
  42 };
  43
  44 enum audio_format {
  45     PCM                 = 0x00000000, // must be 0 for backward compatibility
  46     PCM_16_BIT          = (PCM|PCM_SUB_16_BIT),
  47     PCM_8_BIT           = (PCM|PCM_SUB_8_BIT)
  48 };
  49
  50 enum audio_channels {
  51     CHANNEL_OUT_FRONT_LEFT            = 0x4,
  52     CHANNEL_OUT_FRONT_RIGHT           = 0x8,
  53     CHANNEL_OUT_FRONT_CENTER          = 0x10,
  54     CHANNEL_OUT_LOW_FREQUENCY         = 0x20,
  55     CHANNEL_OUT_BACK_LEFT             = 0x40,
  56     CHANNEL_OUT_BACK_RIGHT            = 0x80,
  57     CHANNEL_OUT_FRONT_LEFT_OF_CENTER  = 0x100,
  58     CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = 0x200,
  59     CHANNEL_OUT_BACK_CENTER           = 0x400,
  60     CHANNEL_OUT_MONO = CHANNEL_OUT_FRONT_LEFT,
  61     CHANNEL_OUT_STEREO = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT)
  62 };
  63
  64 // _ZN7android11AudioSystem19getOutputFrameCountEPii
  65 typedef int (*AudioSystem_getOutputFrameCount)(int *, int);
  66 // _ZN7android11AudioSystem16getOutputLatencyEPji
  67 typedef int (*AudioSystem_getOutputLatency)(unsigned int *, int);
  68 // _ZN7android11AudioSystem21getOutputSamplingRateEPii
  69 typedef int (*AudioSystem_getOutputSamplingRate)(int *, int);
  70
  71 // _ZN7android10AudioTrack16getMinFrameCountEPiij
  72 typedef int (*AudioTrack_getMinFrameCount)(int *, int, unsigned int);
  73
  74 // _ZN7android10AudioTrackC1EijiiijPFviPvS1_ES1_ii
  75 typedef void (*AudioTrack_ctor)(void *, int, unsigned int, int, int, int, unsigned int, void (*)(int, void *, void *), void *, int, int);
  76 // _ZN7android10AudioTrackC1EijiiijPFviPvS1_ES1_i
  77 typedef void (*AudioTrack_ctor_legacy)(void *, int, unsigned int, int, int, int, unsigned int, void (*)(int, void *, void *), void *, int);
  78 // _ZN7android10AudioTrackD1Ev
  79 typedef void (*AudioTrack_dtor)(void *);
  80 // _ZNK7android10AudioTrack9initCheckEv
  81 typedef int (*AudioTrack_initCheck)(void *);
  82 // _ZN7android10AudioTrack5startEv
  83 typedef int (*AudioTrack_start)(void *);
  84 // _ZN7android10AudioTrack4stopEv
  85 typedef int (*AudioTrack_stop)(void *);
  86 // _ZN7android10AudioTrack5writeEPKvj
  87 typedef int (*AudioTrack_write)(void *, void  const*, unsigned int);
  88 // _ZN7android10AudioTrack5flushEv
  89 typedef int (*AudioTrack_flush)(void *);
  90 // _ZN7android10AudioTrack5pauseEv
  91 typedef int (*AudioTrack_pause)(void *);
  92
  93 struct aout_sys_t {
  94     float soft_gain;
  95     bool soft_mute;
  96
  97     void *libmedia;
  98     void *AudioTrack;
  99
 100     AudioSystem_getOutputFrameCount as_getOutputFrameCount;
 101     AudioSystem_getOutputLatency as_getOutputLatency;
 102     AudioSystem_getOutputSamplingRate as_getOutputSamplingRate;
 103
 104     AudioTrack_getMinFrameCount at_getMinFrameCount;
 105     AudioTrack_ctor at_ctor;
 106     AudioTrack_ctor_legacy at_ctor_legacy;
 107     AudioTrack_dtor at_dtor;
 108     AudioTrack_initCheck at_initCheck;
 109     AudioTrack_start at_start;
 110     AudioTrack_stop at_stop;
 111     AudioTrack_write at_write;
 112     AudioTrack_flush at_flush;
 113     AudioTrack_pause at_pause;
 114 };
 115
 116 /* Soft volume helper */
 117 #include "volume.h"
 118
 119 static void *InitLibrary(struct aout_sys_t *p_sys);
 120
 121 static int  Open(vlc_object_t *);
 122 static void Close(vlc_object_t *);
 123 static void Play(audio_output_t*, block_t*);
 124 static void Pause (audio_output_t *, bool, mtime_t);
 125
 126 vlc_module_begin ()
 127     set_shortname("AudioTrack")
 128     set_description(N_("Android AudioTrack audio output"))
 129     set_capability("audio output", 225)
 130     set_category(CAT_AUDIO)
 131     set_subcategory(SUBCAT_AUDIO_AOUT)
 132     add_shortcut("android")
 133     set_callbacks(Open, Close)
 134 vlc_module_end ()
 135
 136 static void *InitLibrary(struct aout_sys_t *p_sys)
 137 {
 138     /* DL Open libmedia */
 139     void *p_library;
 140     p_library = dlopen("libmedia.so", RTLD_NOW|RTLD_LOCAL);
 141     if (!p_library)
 142         return NULL;
 143
 144     /* Register symbols */
 145     p_sys->as_getOutputFrameCount = (AudioSystem_getOutputFrameCount)(dlsym(p_library, "_ZN7android11AudioSystem19getOutputFrameCountEPii"));
 146     p_sys->as_getOutputLatency = (AudioSystem_getOutputLatency)(dlsym(p_library, "_ZN7android11AudioSystem16getOutputLatencyEPji"));
 147     if(p_sys->as_getOutputLatency == NULL) {
 148         /* 4.1 Jellybean prototype */
 149         p_sys->as_getOutputLatency = (AudioSystem_getOutputLatency)(dlsym(p_library, "_ZN7android11AudioSystem16getOutputLatencyEPj19audio_stream_type_t"));
 150     }
 151     p_sys->as_getOutputSamplingRate = (AudioSystem_getOutputSamplingRate)(dlsym(p_library, "_ZN7android11AudioSystem21getOutputSamplingRateEPii"));
 152     p_sys->at_getMinFrameCount = (AudioTrack_getMinFrameCount)(dlsym(p_library, "_ZN7android10AudioTrack16getMinFrameCountEPiij"));
 153     if(p_sys->at_getMinFrameCount == NULL) {
 154         /* 4.1 Jellybean prototype */
 155         p_sys->at_getMinFrameCount = (AudioTrack_getMinFrameCount)(dlsym(p_library, "_ZN7android10AudioTrack16getMinFrameCountEPi19audio_stream_type_tj"));
 156     }
 157     p_sys->at_ctor = (AudioTrack_ctor)(dlsym(p_library, "_ZN7android10AudioTrackC1EijiiijPFviPvS1_ES1_ii"));
 158     p_sys->at_ctor_legacy = (AudioTrack_ctor_legacy)(dlsym(p_library, "_ZN7android10AudioTrackC1EijiiijPFviPvS1_ES1_i"));
 159     p_sys->at_dtor = (AudioTrack_dtor)(dlsym(p_library, "_ZN7android10AudioTrackD1Ev"));
 160     p_sys->at_initCheck = (AudioTrack_initCheck)(dlsym(p_library, "_ZNK7android10AudioTrack9initCheckEv"));
 161     p_sys->at_start = (AudioTrack_start)(dlsym(p_library, "_ZN7android10AudioTrack5startEv"));
 162     p_sys->at_stop = (AudioTrack_stop)(dlsym(p_library, "_ZN7android10AudioTrack4stopEv"));
 163     p_sys->at_write = (AudioTrack_write)(dlsym(p_library, "_ZN7android10AudioTrack5writeEPKvj"));
 164     p_sys->at_flush = (AudioTrack_flush)(dlsym(p_library, "_ZN7android10AudioTrack5flushEv"));
 165     p_sys->at_pause = (AudioTrack_pause)(dlsym(p_library, "_ZN7android10AudioTrack5pauseEv"));
 166
 167     /* We need the first 3 or the last 1 */
 168     if (!((p_sys->as_getOutputFrameCount && p_sys->as_getOutputLatency && p_sys->as_getOutputSamplingRate)
 169         || p_sys->at_getMinFrameCount)) {
 170         dlclose(p_library);
 171         return NULL;
 172     }
 173
 174     // We need all the other Symbols
 175     if (!((p_sys->at_ctor || p_sys->at_ctor_legacy) && p_sys->at_dtor && p_sys->at_initCheck &&
 176            p_sys->at_start && p_sys->at_stop && p_sys->at_write && p_sys->at_flush)) {
 177         dlclose(p_library);
 178         return NULL;
 179     }
 180     return p_library;
 181 }
 182
 183 static int Start(audio_output_t *aout, audio_sample_format_t *restrict fmt)
 184 {
 185     struct aout_sys_t *p_sys = aout->sys;
 186
 187     int status, size;
 188     int afSampleRate, afFrameCount, afLatency, minBufCount, minFrameCount;
 189     int stream_type, channel, rate, format;
 190
 191     /* 4000 <= frequency <= 48000 */
 192     rate = fmt->i_rate;
 193     if (rate < 4000)
 194         rate = 4000;
 195     if (rate > 48000)
 196         rate = 48000;
 197
 198     stream_type = MUSIC;
 199
 200     /* We can only accept U8 and S16L */
 201     if (fmt->i_format != VLC_CODEC_U8 && fmt->i_format != VLC_CODEC_S16L)
 202         fmt->i_format = VLC_CODEC_S16L;
 203     format = (fmt->i_format == VLC_CODEC_S16L) ? PCM_16_BIT : PCM_8_BIT;
 204
 205     /* TODO: android supports more channels */
 206     fmt->i_original_channels = fmt->i_physical_channels;
 207     switch(aout_FormatNbChannels(fmt))
 208     {
 209     case 1:
 210         channel = CHANNEL_OUT_MONO;
 211         fmt->i_physical_channels = AOUT_CHAN_CENTER;
 212         break;
 213     case 2:
 214     default:
 215         channel = CHANNEL_OUT_STEREO;
 216         fmt->i_physical_channels = AOUT_CHANS_STEREO;
 217         break;
 218     }
 219
 220     /* Get the minimum buffer value */
 221     if (!p_sys->at_getMinFrameCount) {
 222         status = p_sys->as_getOutputSamplingRate(&afSampleRate, stream_type);
 223         status ^= p_sys->as_getOutputFrameCount(&afFrameCount, stream_type);
 224         status ^= p_sys->as_getOutputLatency((uint32_t*)(&afLatency), stream_type);
 225         if (status != 0) {
 226             msg_Err(aout, "Could not query the AudioStream parameters");
 227             return VLC_EGENERIC;
 228         }
 229         minBufCount = afLatency / ((1000 * afFrameCount) / afSampleRate);
 230         if (minBufCount < 2)
 231             minBufCount = 2;
 232         minFrameCount = (afFrameCount * rate * minBufCount) / afSampleRate;
 233     }
 234     else {
 235         status = p_sys->at_getMinFrameCount(&minFrameCount, stream_type, rate);
 236         if (status != 0) {
 237             msg_Err(aout, "Could not query the AudioTrack parameters");
 238             return VLC_EGENERIC;
 239         }
 240     }
 241
 242     size = minFrameCount * (channel == CHANNEL_OUT_STEREO ? 2 : 1) * 4;
 243
 244     /* Sizeof(AudioTrack) == 0x58 (not sure) on 2.2.1, this should be enough */
 245     p_sys->AudioTrack = malloc(SIZE_OF_AUDIOTRACK);
 246     if (!p_sys->AudioTrack)
 247         return VLC_ENOMEM;
 248
 249     *((uint32_t *) ((uint32_t)p_sys->AudioTrack + SIZE_OF_AUDIOTRACK - 4)) = 0xbaadbaad;
 250     // Higher than android 2.2
 251     if (p_sys->at_ctor)
 252         p_sys->at_ctor(p_sys->AudioTrack, stream_type, rate, format, channel, size, 0, NULL, NULL, 0, 0);
 253     // Higher than android 1.6
 254     else if (p_sys->at_ctor_legacy)
 255         p_sys->at_ctor_legacy(p_sys->AudioTrack, stream_type, rate, format, channel, size, 0, NULL, NULL, 0);
 256
 257     assert( (*((uint32_t *) ((uint32_t)p_sys->AudioTrack + SIZE_OF_AUDIOTRACK - 4)) == 0xbaadbaad) );
 258
 259     /* And Init */
 260     status = p_sys->at_initCheck(p_sys->AudioTrack);
 261
 262     /* android 1.6 uses channel count instead of stream_type */
 263     if (status != 0) {
 264         channel = (channel == CHANNEL_OUT_STEREO) ? 2 : 1;
 265         p_sys->at_ctor_legacy(p_sys->AudioTrack, stream_type, rate, format, channel, size, 0, NULL, NULL, 0);
 266         status = p_sys->at_initCheck(p_sys->AudioTrack);
 267     }
 268     if (status != 0) {
 269         msg_Err(aout, "Cannot create AudioTrack!");
 270         free(p_sys->AudioTrack);
 271         return VLC_EGENERIC;
 272     }
 273
 274     aout_SoftVolumeStart(aout);
 275
 276     aout->sys = p_sys;
 277     aout->time_get = NULL;
 278     aout->play = Play;
 279     aout->pause = Pause;
 280
 281     p_sys->at_start(p_sys->AudioTrack);
 282
 283     fmt->i_rate = rate;
 284
 285     return VLC_SUCCESS;
 286 }
 287
 288 static void Stop(audio_output_t* p_aout)
 289 {
 290     aout_sys_t *p_sys = p_aout->sys;
 291
 292     p_sys->at_stop(p_sys->AudioTrack);
 293     p_sys->at_flush(p_sys->AudioTrack);
 294     p_sys->at_dtor(p_sys->AudioTrack);
 295     free(p_sys->AudioTrack);
 296 }
 297
 298 /* FIXME: lipsync */
 299 static void Play(audio_output_t* p_aout, block_t* p_buffer)
 300 {
 301     aout_sys_t *p_sys = p_aout->sys;
 302
 303     size_t length = 0;
 304     while (length < p_buffer->i_buffer) {
 305         length += p_sys->at_write(p_sys->AudioTrack, (char*)(p_buffer->p_buffer) + length, p_buffer->i_buffer - length);
 306     }
 307
 308     block_Release( p_buffer );
 309 }
 310
 311 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
 312 {
 313     VLC_UNUSED(date);
 314
 315     aout_sys_t *p_sys = p_aout->sys;
 316
 317     if (pause) {
 318         p_sys->at_pause(p_sys->AudioTrack);
 319     } else {
 320         p_sys->at_start(p_sys->AudioTrack);
 321     }
 322 }
 323
 324 static int Open(vlc_object_t *obj)
 325 {
 326     audio_output_t *aout = (audio_output_t *)obj;
 327     aout_sys_t *sys = malloc(sizeof (*sys));
 328
 329     if (unlikely(sys == NULL))
 330         return VLC_ENOMEM;
 331
 332     sys->libmedia = InitLibrary(sys);
 333     if (sys->libmedia == NULL) {
 334         msg_Err(aout, "Could not initialize libmedia.so!");
 335         free(sys);
 336         return VLC_EGENERIC;
 337     }
 338
 339     aout->sys = sys;
 340     aout->start = Start;
 341     aout->stop = Stop;
 342     aout_SoftVolumeInit(aout);
 343     return VLC_SUCCESS;
 344 }
 345
 346 static void Close(vlc_object_t *obj)
 347 {
 348     audio_output_t *aout = (audio_output_t *)obj;
 349     aout_sys_t *sys = aout->sys;
 350
 351     dlclose(sys->libmedia);
 352     free(sys);
 353 }