widget/src/qt/nsSound.cpp

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2000
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include <string.h>
  40
  41 #include "nscore.h"
  42 #include "plstr.h"
  43 #include "prlink.h"
  44
  45 #include "nsSound.h"
  46
  47 #include "nsIURL.h"
  48 #include "nsIFileURL.h"
  49 #include "nsNetUtil.h"
  50 #include "nsCOMPtr.h"
  51 #include "nsNativeCharsetUtils.h"
  52 #include "nsAutoPtr.h"
  53
  54 #include <QApplication>
  55 #include <QSound>
  56
  57 /* used with esd_open_sound */
  58 static int esdref = -1;
  59 static PRLibrary *elib = nsnull;
  60
  61 // the following from esd.h
  62
  63 #define ESD_BITS8  (0x0000)
  64 #define ESD_BITS16 (0x0001)
  65 #define ESD_MONO (0x0010)
  66 #define ESD_STEREO (0x0020)
  67 #define ESD_STREAM (0x0000)
  68 #define ESD_PLAY (0x1000)
  69
  70 #define WAV_MIN_LENGTH 44
  71
  72 typedef int (PR_CALLBACK *EsdOpenSoundType)(const char *host);
  73 typedef int (PR_CALLBACK *EsdCloseType)(int);
  74
  75 /* used to play the sounds from the find symbol call */
  76 typedef int (PR_CALLBACK *EsdPlayStreamType)  (int,
  77                                                int,
  78                                                const char *,
  79                                                const char *);
  80 typedef int  (PR_CALLBACK *EsdAudioOpenType)  (void);
  81 typedef int  (PR_CALLBACK *EsdAudioWriteType) (const void *, int);
  82 typedef void (PR_CALLBACK *EsdAudioCloseType) (void);
  83
  84 NS_IMPL_ISUPPORTS2(nsSound, nsISound, nsIStreamLoaderObserver)
  85
  86 nsSound::nsSound()
  87  : mInited( PR_FALSE )
  88 {
  89 }
  90
  91 nsSound::~nsSound()
  92 {
  93     /* see above comment */
  94     if (esdref != -1) {
  95         EsdCloseType EsdClose = (EsdCloseType) PR_FindFunctionSymbol(elib, "esd_close");
  96         if (EsdClose)
  97             (*EsdClose)(esdref);
  98         esdref = -1;
  99     }
 100 }
 101
 102
 103 /**
 104 * unload esd library
 105 */
 106 void
 107 nsSound::Shutdown()
 108 {
 109     if (elib) {
 110         PR_UnloadLibrary(elib);
 111         elib = nsnull;
 112     }
 113 }
 114
 115 NS_IMETHODIMP
 116 nsSound::Init()
 117 {
 118     /* we don't need to do esd_open_sound if we are only going to play files
 119        but we will if we want to do things like streams, etc
 120     */
 121     if (mInited)
 122         return NS_OK;
 123     if (elib)
 124         return NS_OK;
 125
 126     EsdOpenSoundType EsdOpenSound;
 127
 128     elib = PR_LoadLibrary("libesd.so.0");
 129     if (!elib) return NS_ERROR_FAILURE;
 130
 131     EsdOpenSound = (EsdOpenSoundType) PR_FindFunctionSymbol(elib, "esd_open_sound");
 132
 133     if (!EsdOpenSound)
 134         return NS_ERROR_FAILURE;
 135
 136     esdref = (*EsdOpenSound)("localhost");
 137
 138     if (!esdref)
 139         return NS_ERROR_FAILURE;
 140
 141     mInited = PR_TRUE;
 142
 143     return NS_OK;
 144 }
 145
 146 NS_METHOD nsSound::Beep()
 147 {
 148     QApplication::beep();
 149     return NS_OK;
 150 }
 151
 152
 153 /**
 154 * This can't be implemented directly with QT.
 155 * (We can use QSound to play local files but that was not enough.
 156 * Also support of media formats is limited)
 157 *
 158 * Current implementation is copied from GTK side and implementation uses ESD interface.
 159 *
 160 * If we have Qtopia then we can drop ESD implementation and use Qtopia "Multimedia API"
 161 */
 162 NS_IMETHODIMP nsSound::OnStreamComplete(nsIStreamLoader *aLoader,
 163                                         nsISupports *context,
 164                                         nsresult aStatus,
 165                                         PRUint32 dataLen,
 166                                         const PRUint8 *data)
 167 {
 168
 169 #define GET_WORD(s, i) (s[i+1] << 8) | s[i]
 170 #define GET_DWORD(s, i) (s[i+3] << 24) | (s[i+2] << 16) | (s[i+1] << 8) | s[i]
 171
 172     // print a load error on bad status, and return
 173     if (NS_FAILED(aStatus)) {
 174 #ifdef DEBUG
 175         if (aLoader) {
 176             nsCOMPtr<nsIRequest> request;
 177             aLoader->GetRequest(getter_AddRefs(request));
 178             if (request) {
 179                 nsCOMPtr<nsIURI> uri;
 180                 nsCOMPtr<nsIChannel> channel = do_QueryInterface(request);
 181                 if (channel) {
 182                       channel->GetURI(getter_AddRefs(uri));
 183                       if (uri) {
 184                             nsCAutoString uriSpec;
 185                             uri->GetSpec(uriSpec);
 186                             printf("Failed to load %s\n", uriSpec.get());
 187                       }
 188                 }
 189             }
 190         }
 191 #endif
 192         return aStatus;
 193     }
 194
 195     int fd, mask = 0;
 196     PRUint32 samples_per_sec = 0, avg_bytes_per_sec = 0, chunk_len = 0;
 197     PRUint16 format, channels = 1, bits_per_sample = 0;
 198     const PRUint8 *audio = nsnull;
 199     size_t audio_len = 0;
 200
 201     if (dataLen < 4) {
 202         NS_WARNING("Sound stream too short to determine its type");
 203         return NS_ERROR_FAILURE;
 204     }
 205
 206     if (memcmp(data, "RIFF", 4)) {
 207 #ifdef DEBUG
 208         printf("We only support WAV files currently.\n");
 209 #endif
 210         return NS_ERROR_FAILURE;
 211     }
 212
 213     if (dataLen <= WAV_MIN_LENGTH) {
 214         NS_WARNING("WAV files should be longer than 44 bytes.");
 215         return NS_ERROR_FAILURE;
 216     }
 217
 218     PRUint32 i = 12;
 219     while (i + 7 < dataLen) {
 220         if (!memcmp(data + i, "fmt ", 4) && !chunk_len) {
 221             i += 4;
 222
 223             /* length of the rest of this subblock (should be 16 for PCM data */
 224             chunk_len = GET_DWORD(data, i);
 225             i += 4;
 226
 227             if (chunk_len < 16 || i + chunk_len >= dataLen) {
 228                 NS_WARNING("Invalid WAV file: bad fmt chunk.");
 229                 return NS_ERROR_FAILURE;
 230             }
 231
 232             format = GET_WORD(data, i);
 233             i += 2;
 234
 235             channels = GET_WORD(data, i);
 236             i += 2;
 237
 238             samples_per_sec = GET_DWORD(data, i);
 239             i += 4;
 240
 241             avg_bytes_per_sec = GET_DWORD(data, i);
 242             i += 4;
 243
 244             // block align
 245             i += 2;
 246
 247             bits_per_sample = GET_WORD(data, i);
 248             i += 2;
 249
 250             /* we don't support WAVs with odd compression codes */
 251             if (chunk_len != 16)
 252                 NS_WARNING("Extra format bits found in WAV. Ignoring");
 253
 254             i += chunk_len - 16;
 255         } else if (!memcmp(data + i, "data", 4)) {
 256             i += 4;
 257             if (!chunk_len) {
 258                 NS_WARNING("Invalid WAV file: no fmt chunk found");
 259                 return NS_ERROR_FAILURE;
 260             }
 261
 262             audio_len = GET_DWORD(data, i);
 263             i += 4;
 264
 265             /* try to play truncated WAVs */
 266             if (i + audio_len > dataLen)
 267                 audio_len = dataLen - i;
 268
 269             audio = data + i;
 270             break;
 271         } else {
 272             i += 4;
 273             i += GET_DWORD(data, i);
 274             i += 4;
 275         }
 276     }
 277
 278     if (!audio) {
 279         NS_WARNING("Invalid WAV file: no data chunk found");
 280         return NS_ERROR_FAILURE;
 281     }
 282
 283     /* No audio data? well, at least the WAV was valid. */
 284     if (!audio_len)
 285         return NS_OK;
 286
 287 #if 0
 288     printf("f: %d | c: %d | sps: %li | abps: %li | ba: %d | bps: %d | rate: %li\n",
 289          format, channels, samples_per_sec, avg_bytes_per_sec, block_align, bits_per_sample, rate);
 290 #endif
 291
 292     /* open up connection to esd */
 293     EsdPlayStreamType EsdPlayStream =
 294         (EsdPlayStreamType) PR_FindFunctionSymbol(elib,
 295                                                   "esd_play_stream");
 296     if (!EsdPlayStream)
 297         return NS_ERROR_FAILURE;
 298
 299     mask = ESD_PLAY | ESD_STREAM;
 300
 301     if (bits_per_sample == 8)
 302         mask |= ESD_BITS8;
 303     else
 304         mask |= ESD_BITS16;
 305
 306     if (channels == 1)
 307         mask |= ESD_MONO;
 308     else
 309         mask |= ESD_STEREO;
 310
 311     nsAutoArrayPtr<PRUint8> buf;
 312
 313     // ESD only handle little-endian data.
 314     // Swap the byte order if we're on a big-endian architecture.
 315 #ifdef IS_BIG_ENDIAN
 316     if (bits_per_sample != 8) {
 317         buf = new PRUint8[audio_len];
 318         if (!buf)
 319             return NS_ERROR_OUT_OF_MEMORY;
 320         for (PRUint32 j = 0; j + 2 < audio_len; j += 2) {
 321             buf[j]     = audio[j + 1];
 322             buf[j + 1] = audio[j];
 323         }
 324
 325     audio = buf;
 326     }
 327 #endif
 328
 329     fd = (*EsdPlayStream)(mask, samples_per_sec, NULL, "mozillaSound");
 330
 331     if (fd < 0) {
 332       int *esd_audio_format = (int *) PR_FindSymbol(elib, "esd_audio_format");
 333       int *esd_audio_rate = (int *) PR_FindSymbol(elib, "esd_audio_rate");
 334       EsdAudioOpenType EsdAudioOpen = (EsdAudioOpenType) PR_FindFunctionSymbol(elib, "esd_audio_open");
 335       EsdAudioWriteType EsdAudioWrite = (EsdAudioWriteType) PR_FindFunctionSymbol(elib, "esd_audio_write");
 336       EsdAudioCloseType EsdAudioClose = (EsdAudioCloseType) PR_FindFunctionSymbol(elib, "esd_audio_close");
 337
 338       if (!esd_audio_format || !esd_audio_rate ||
 339           !EsdAudioOpen || !EsdAudioWrite || !EsdAudioClose)
 340           return NS_ERROR_FAILURE;
 341
 342       *esd_audio_format = mask;
 343       *esd_audio_rate = samples_per_sec;
 344       fd = (*EsdAudioOpen)();
 345
 346       if (fd < 0)
 347         return NS_ERROR_FAILURE;
 348
 349       (*EsdAudioWrite)(audio, audio_len);
 350       (*EsdAudioClose)();
 351     } else {
 352       while (audio_len > 0) {
 353         size_t written = write(fd, audio, audio_len);
 354         if (written <= 0)
 355           break;
 356         audio += written;
 357         audio_len -= written;
 358       }
 359       close(fd);
 360     }
 361
 362     return NS_OK;
 363 }
 364
 365 NS_METHOD nsSound::Play(nsIURL *aURL)
 366 {
 367     nsresult rv;
 368
 369     if (!mInited)
 370         Init();
 371
 372     if (!elib)
 373         return NS_ERROR_FAILURE;
 374
 375     nsCOMPtr<nsIStreamLoader> loader;
 376     rv = NS_NewStreamLoader(getter_AddRefs(loader), aURL, this);
 377
 378     return rv;
 379 }
 380
 381 NS_IMETHODIMP nsSound::PlaySystemSound(const nsAString &aSoundAlias)
 382 {
 383     if (aSoundAlias.EqualsLiteral("_moz_mailbeep")) {
 384         return Beep();
 385     }
 386
 387     nsresult rv;
 388     nsCOMPtr <nsIURI> fileURI;
 389
 390     // create a nsILocalFile and then a nsIFileURL from that
 391     nsCOMPtr <nsILocalFile> soundFile;
 392     rv = NS_NewLocalFile(aSoundAlias, PR_TRUE,
 393                          getter_AddRefs(soundFile));
 394     NS_ENSURE_SUCCESS(rv,rv);
 395
 396     rv = NS_NewFileURI(getter_AddRefs(fileURI), soundFile);
 397     NS_ENSURE_SUCCESS(rv,rv);
 398
 399     nsCOMPtr<nsIFileURL> fileURL = do_QueryInterface(fileURI,&rv);
 400     NS_ENSURE_SUCCESS(rv,rv);
 401
 402     rv = Play(fileURL);
 403     return rv;
 404
 405 }