Alc/backends/wave.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2007 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <stdlib.h>
  24 #include <stdio.h>
  25 #include <memory.h>
  26 #include <errno.h>
  27
  28 #include "alMain.h"
  29 #include "alu.h"
  30 #include "threads.h"
  31 #include "compat.h"
  32
  33 #include "backends/base.h"
  34
  35
  36 static const ALCchar waveDevice[] = "Wave File Writer";
  37
  38 static const ALubyte SUBTYPE_PCM[] = {
  39     0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xaa,
  40     0x00, 0x38, 0x9b, 0x71
  41 };
  42 static const ALubyte SUBTYPE_FLOAT[] = {
  43     0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xaa,
  44     0x00, 0x38, 0x9b, 0x71
  45 };
  46
  47 static const ALuint channel_masks[] = {
  48     0, /* invalid */
  49     0x4, /* Mono */
  50     0x1 | 0x2, /* Stereo */
  51     0, /* 3 channel */
  52     0x1 | 0x2 | 0x10 | 0x20, /* Quad */
  53     0, /* 5 channel */
  54     0x1 | 0x2 | 0x4 | 0x8 | 0x10 | 0x20, /* 5.1 */
  55     0x1 | 0x2 | 0x4 | 0x8 | 0x100 | 0x200 | 0x400, /* 6.1 */
  56     0x1 | 0x2 | 0x4 | 0x8 | 0x10 | 0x20 | 0x200 | 0x400, /* 7.1 */
  57 };
  58
  59
  60 static void fwrite16le(ALushort val, FILE *f)
  61 {
  62     fputc(val&0xff, f);
  63     fputc((val>>8)&0xff, f);
  64 }
  65
  66 static void fwrite32le(ALuint val, FILE *f)
  67 {
  68     fputc(val&0xff, f);
  69     fputc((val>>8)&0xff, f);
  70     fputc((val>>16)&0xff, f);
  71     fputc((val>>24)&0xff, f);
  72 }
  73
  74
  75 typedef struct ALCwaveBackend {
  76     DERIVE_FROM_TYPE(ALCbackend);
  77
  78     FILE *mFile;
  79     long mDataStart;
  80
  81     ALvoid *mBuffer;
  82     ALuint mSize;
  83
  84     volatile int killNow;
  85     althrd_t thread;
  86 } ALCwaveBackend;
  87
  88 static int ALCwaveBackend_mixerProc(void *ptr);
  89
  90 static void ALCwaveBackend_Construct(ALCwaveBackend *self, ALCdevice *device);
  91 static DECLARE_FORWARD(ALCwaveBackend, ALCbackend, void, Destruct)
  92 static ALCenum ALCwaveBackend_open(ALCwaveBackend *self, const ALCchar *name);
  93 static void ALCwaveBackend_close(ALCwaveBackend *self);
  94 static ALCboolean ALCwaveBackend_reset(ALCwaveBackend *self);
  95 static ALCboolean ALCwaveBackend_start(ALCwaveBackend *self);
  96 static void ALCwaveBackend_stop(ALCwaveBackend *self);
  97 static DECLARE_FORWARD2(ALCwaveBackend, ALCbackend, ALCenum, captureSamples, void*, ALCuint)
  98 static DECLARE_FORWARD(ALCwaveBackend, ALCbackend, ALCuint, availableSamples)
  99 static DECLARE_FORWARD(ALCwaveBackend, ALCbackend, ALint64, getLatency)
 100 static DECLARE_FORWARD(ALCwaveBackend, ALCbackend, void, lock)
 101 static DECLARE_FORWARD(ALCwaveBackend, ALCbackend, void, unlock)
 102 DECLARE_DEFAULT_ALLOCATORS(ALCwaveBackend)
 103
 104 DEFINE_ALCBACKEND_VTABLE(ALCwaveBackend);
 105
 106
 107 static void ALCwaveBackend_Construct(ALCwaveBackend *self, ALCdevice *device)
 108 {
 109     ALCbackend_Construct(STATIC_CAST(ALCbackend, self), device);
 110     SET_VTABLE2(ALCwaveBackend, ALCbackend, self);
 111
 112     self->mFile = NULL;
 113     self->mDataStart = -1;
 114
 115     self->mBuffer = NULL;
 116     self->mSize = 0;
 117
 118     self->killNow = 1;
 119 }
 120
 121
 122 static int ALCwaveBackend_mixerProc(void *ptr)
 123 {
 124     ALCwaveBackend *self = (ALCwaveBackend*)ptr;
 125     ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
 126     struct timespec now, start;
 127     ALint64 avail, done;
 128     ALuint frameSize;
 129     size_t fs;
 130     const long restTime = (long)((ALuint64)device->UpdateSize * 1000000000 /
 131                                  device->Frequency / 2);
 132
 133     althrd_setname(althrd_current(), MIXER_THREAD_NAME);
 134
 135     frameSize = FrameSizeFromDevFmt(device->FmtChans, device->FmtType);
 136
 137     done = 0;
 138     if(altimespec_get(&start, AL_TIME_UTC) != AL_TIME_UTC)
 139     {
 140         ERR("Failed to get starting time\n");
 141         return 1;
 142     }
 143     while(!self->killNow && device->Connected)
 144     {
 145         if(altimespec_get(&now, AL_TIME_UTC) != AL_TIME_UTC)
 146         {
 147             ERR("Failed to get current time\n");
 148             return 1;
 149         }
 150
 151         avail  = (now.tv_sec - start.tv_sec) * device->Frequency;
 152         avail += (ALint64)(now.tv_nsec - start.tv_nsec) * device->Frequency / 1000000000;
 153         if(avail < done)
 154         {
 155             /* Oops, time skipped backwards. Reset the number of samples done
 156              * with one update available since we (likely) just came back from
 157              * sleeping. */
 158             done = avail - device->UpdateSize;
 159         }
 160
 161         if(avail-done < device->UpdateSize)
 162             al_nssleep(restTime);
 163         else while(avail-done >= device->UpdateSize)
 164         {
 165             aluMixData(device, self->mBuffer, device->UpdateSize);
 166             done += device->UpdateSize;
 167
 168             if(!IS_LITTLE_ENDIAN)
 169             {
 170                 ALuint bytesize = BytesFromDevFmt(device->FmtType);
 171                 ALubyte *bytes = self->mBuffer;
 172                 ALuint i;
 173
 174                 if(bytesize == 1)
 175                 {
 176                     for(i = 0;i < self->mSize;i++)
 177                         fputc(bytes[i], self->mFile);
 178                 }
 179                 else if(bytesize == 2)
 180                 {
 181                     for(i = 0;i < self->mSize;i++)
 182                         fputc(bytes[i^1], self->mFile);
 183                 }
 184                 else if(bytesize == 4)
 185                 {
 186                     for(i = 0;i < self->mSize;i++)
 187                         fputc(bytes[i^3], self->mFile);
 188                 }
 189             }
 190             else
 191             {
 192                 fs = fwrite(self->mBuffer, frameSize, device->UpdateSize,
 193                             self->mFile);
 194                 (void)fs;
 195             }
 196             if(ferror(self->mFile))
 197             {
 198                 ERR("Error writing to file\n");
 199                 ALCdevice_Lock(device);
 200                 aluHandleDisconnect(device);
 201                 ALCdevice_Unlock(device);
 202                 break;
 203             }
 204         }
 205     }
 206
 207     return 0;
 208 }
 209
 210
 211 static ALCenum ALCwaveBackend_open(ALCwaveBackend *self, const ALCchar *name)
 212 {
 213     ALCdevice *device;
 214     const char *fname;
 215
 216     fname = GetConfigValue("wave", "file", "");
 217     if(!fname[0]) return ALC_INVALID_VALUE;
 218
 219     if(!name)
 220         name = waveDevice;
 221     else if(strcmp(name, waveDevice) != 0)
 222         return ALC_INVALID_VALUE;
 223
 224     self->mFile = al_fopen(fname, "wb");
 225     if(!self->mFile)
 226     {
 227         ERR("Could not open file '%s': %s\n", fname, strerror(errno));
 228         return ALC_INVALID_VALUE;
 229     }
 230
 231     device = STATIC_CAST(ALCbackend, self)->mDevice;
 232     al_string_copy_cstr(&device->DeviceName, name);
 233
 234     return ALC_NO_ERROR;
 235 }
 236
 237 static void ALCwaveBackend_close(ALCwaveBackend *self)
 238 {
 239     if(self->mFile)
 240         fclose(self->mFile);
 241     self->mFile = NULL;
 242 }
 243
 244 static ALCboolean ALCwaveBackend_reset(ALCwaveBackend *self)
 245 {
 246     ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
 247     ALuint channels=0, bits=0;
 248     size_t val;
 249
 250     fseek(self->mFile, 0, SEEK_SET);
 251     clearerr(self->mFile);
 252
 253     switch(device->FmtType)
 254     {
 255         case DevFmtByte:
 256             device->FmtType = DevFmtUByte;
 257             break;
 258         case DevFmtUShort:
 259             device->FmtType = DevFmtShort;
 260             break;
 261         case DevFmtUInt:
 262             device->FmtType = DevFmtInt;
 263             break;
 264         case DevFmtUByte:
 265         case DevFmtShort:
 266         case DevFmtInt:
 267         case DevFmtFloat:
 268             break;
 269     }
 270     bits = BytesFromDevFmt(device->FmtType) * 8;
 271     channels = ChannelsFromDevFmt(device->FmtChans);
 272
 273     fprintf(self->mFile, "RIFF");
 274     fwrite32le(0xFFFFFFFF, self->mFile); // 'RIFF' header len; filled in at close
 275
 276     fprintf(self->mFile, "WAVE");
 277
 278     fprintf(self->mFile, "fmt ");
 279     fwrite32le(40, self->mFile); // 'fmt ' header len; 40 bytes for EXTENSIBLE
 280
 281     // 16-bit val, format type id (extensible: 0xFFFE)
 282     fwrite16le(0xFFFE, self->mFile);
 283     // 16-bit val, channel count
 284     fwrite16le(channels, self->mFile);
 285     // 32-bit val, frequency
 286     fwrite32le(device->Frequency, self->mFile);
 287     // 32-bit val, bytes per second
 288     fwrite32le(device->Frequency * channels * bits / 8, self->mFile);
 289     // 16-bit val, frame size
 290     fwrite16le(channels * bits / 8, self->mFile);
 291     // 16-bit val, bits per sample
 292     fwrite16le(bits, self->mFile);
 293     // 16-bit val, extra byte count
 294     fwrite16le(22, self->mFile);
 295     // 16-bit val, valid bits per sample
 296     fwrite16le(bits, self->mFile);
 297     // 32-bit val, channel mask
 298     fwrite32le(channel_masks[channels], self->mFile);
 299     // 16 byte GUID, sub-type format
 300     val = fwrite(((bits==32) ? SUBTYPE_FLOAT : SUBTYPE_PCM), 1, 16, self->mFile);
 301     (void)val;
 302
 303     fprintf(self->mFile, "data");
 304     fwrite32le(0xFFFFFFFF, self->mFile); // 'data' header len; filled in at close
 305
 306     if(ferror(self->mFile))
 307     {
 308         ERR("Error writing header: %s\n", strerror(errno));
 309         return ALC_FALSE;
 310     }
 311     self->mDataStart = ftell(self->mFile);
 312
 313     SetDefaultWFXChannelOrder(device);
 314
 315     return ALC_TRUE;
 316 }
 317
 318 static ALCboolean ALCwaveBackend_start(ALCwaveBackend *self)
 319 {
 320     ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
 321
 322     self->mSize = device->UpdateSize * FrameSizeFromDevFmt(device->FmtChans, device->FmtType);
 323     self->mBuffer = malloc(self->mSize);
 324     if(!self->mBuffer)
 325     {
 326         ERR("Buffer malloc failed\n");
 327         return ALC_FALSE;
 328     }
 329
 330     self->killNow = 0;
 331     if(althrd_create(&self->thread, ALCwaveBackend_mixerProc, self) != althrd_success)
 332     {
 333         free(self->mBuffer);
 334         self->mBuffer = NULL;
 335         self->mSize = 0;
 336         return ALC_FALSE;
 337     }
 338
 339     return ALC_TRUE;
 340 }
 341
 342 static void ALCwaveBackend_stop(ALCwaveBackend *self)
 343 {
 344     ALuint dataLen;
 345     long size;
 346     int res;
 347
 348     if(self->killNow)
 349         return;
 350
 351     self->killNow = 1;
 352     althrd_join(self->thread, &res);
 353
 354     free(self->mBuffer);
 355     self->mBuffer = NULL;
 356
 357     size = ftell(self->mFile);
 358     if(size > 0)
 359     {
 360         dataLen = size - self->mDataStart;
 361         if(fseek(self->mFile, self->mDataStart-4, SEEK_SET) == 0)
 362             fwrite32le(dataLen, self->mFile); // 'data' header len
 363         if(fseek(self->mFile, 4, SEEK_SET) == 0)
 364             fwrite32le(size-8, self->mFile); // 'WAVE' header len
 365     }
 366 }
 367
 368
 369 typedef struct ALCwaveBackendFactory {
 370     DERIVE_FROM_TYPE(ALCbackendFactory);
 371 } ALCwaveBackendFactory;
 372 #define ALCWAVEBACKENDFACTORY_INITIALIZER { { GET_VTABLE2(ALCwaveBackendFactory, ALCbackendFactory) } }
 373
 374 ALCbackendFactory *ALCwaveBackendFactory_getFactory(void);
 375
 376 static ALCboolean ALCwaveBackendFactory_init(ALCwaveBackendFactory *self);
 377 static DECLARE_FORWARD(ALCwaveBackendFactory, ALCbackendFactory, void, deinit)
 378 static ALCboolean ALCwaveBackendFactory_querySupport(ALCwaveBackendFactory *self, ALCbackend_Type type);
 379 static void ALCwaveBackendFactory_probe(ALCwaveBackendFactory *self, enum DevProbe type);
 380 static ALCbackend* ALCwaveBackendFactory_createBackend(ALCwaveBackendFactory *self, ALCdevice *device, ALCbackend_Type type);
 381 DEFINE_ALCBACKENDFACTORY_VTABLE(ALCwaveBackendFactory);
 382
 383
 384 ALCbackendFactory *ALCwaveBackendFactory_getFactory(void)
 385 {
 386     static ALCwaveBackendFactory factory = ALCWAVEBACKENDFACTORY_INITIALIZER;
 387     return STATIC_CAST(ALCbackendFactory, &factory);
 388 }
 389
 390
 391 static ALCboolean ALCwaveBackendFactory_init(ALCwaveBackendFactory* UNUSED(self))
 392 {
 393     return ALC_TRUE;
 394 }
 395
 396 static ALCboolean ALCwaveBackendFactory_querySupport(ALCwaveBackendFactory* UNUSED(self), ALCbackend_Type type)
 397 {
 398     if(type == ALCbackend_Playback)
 399         return !!ConfigValueExists("wave", "file");
 400     return ALC_FALSE;
 401 }
 402
 403 static void ALCwaveBackendFactory_probe(ALCwaveBackendFactory* UNUSED(self), enum DevProbe type)
 404 {
 405     switch(type)
 406     {
 407         case ALL_DEVICE_PROBE:
 408             AppendAllDevicesList(waveDevice);
 409             break;
 410         case CAPTURE_DEVICE_PROBE:
 411             break;
 412     }
 413 }
 414
 415 static ALCbackend* ALCwaveBackendFactory_createBackend(ALCwaveBackendFactory* UNUSED(self), ALCdevice *device, ALCbackend_Type type)
 416 {
 417     if(type == ALCbackend_Playback)
 418     {
 419         ALCwaveBackend *backend;
 420
 421         backend = ALCwaveBackend_New(sizeof(*backend));
 422         if(!backend) return NULL;
 423         memset(backend, 0, sizeof(*backend));
 424
 425         ALCwaveBackend_Construct(backend, device);
 426
 427         return STATIC_CAST(ALCbackend, backend);
 428     }
 429
 430     return NULL;
 431 }
 432
 433 void alc_wave_probe(enum DevProbe type)
 434 {
 435     if(!ConfigValueExists("wave", "file"))
 436         return;
 437
 438     switch(type)
 439     {
 440         case ALL_DEVICE_PROBE:
 441             AppendAllDevicesList(waveDevice);
 442             break;
 443         case CAPTURE_DEVICE_PROBE:
 444             break;
 445     }
 446 }