____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

script_sound.cpp

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1999-2006 by Lutz Sammer, Fabrice Rossi, and Jimmy Salmon
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; only version 2 of the License.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.
//


/*----------------------------------------------------------------------------
-- Includes
----------------------------------------------------------------------------*/

#include <string.h>
#include <stdio.h>

#include "stratagus.h"

#include <stdlib.h>

#include "script.h"
#include "sound.h"
#include "sound_server.h"

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/


/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

static int CclSoundForName(lua_State *l)
{
    CSound *id;
    const char *sound_name;
    LuaUserData *data;

    sound_name = LuaToString(l, -1);
    id = SoundForName(sound_name);

    data = (LuaUserData *)lua_newuserdata(l, sizeof(LuaUserData));
    data->Type = LuaSoundType;
    data->Data = id;
    return 1;
}

static CSound *CclGetSound(lua_State *l)
{
    LuaUserData *data;
    int pop;

    pop = 0;
    if (lua_isstring(l, -1)) {
        CclSoundForName(l);
        pop = 1;
    }
    if (lua_isuserdata(l, -1)) {
        data = (LuaUserData *)lua_touserdata(l, -1);
        if (data->Type == LuaSoundType) {
            if (pop) {
                lua_pop(l, 1);
            }
            return (CSound *)data->Data;
        }
    }
    LuaError(l, "CclGetSound: not a sound");
    return NULL;
}

static int CclMakeSound(lua_State *l)
{
    CSound *id;
    std::string c_name;
    const char *c_file;
    char **c_files;
    int args;
    int j;
    LuaUserData *data;

    LuaCheckArgs(l, 2);

    c_name = LuaToString(l, 1);
    if (lua_isstring(l, 2)) {
        // only one file
        c_file = LuaToString(l, 2);
        id = MakeSound(c_name, &c_file, 1);
    } else if (lua_istable(l, 2)) {
        // several files
        args = lua_objlen(l, 2);
        c_files = new char *[args];
        for (j = 0; j < args; ++j) {
            lua_rawgeti(l, 2, j + 1);
            c_files[j] = new_strdup(LuaToString(l, -1));
            lua_pop(l, 1);
        }
        id = MakeSound(c_name, (const char **)c_files, args);
        for (j = 0; j < args; ++j) {
            delete[] c_files[j];
        }
        delete[] c_files;
    } else {
        LuaError(l, "string or table expected");
        return 0;
    }
    data = (LuaUserData *)lua_newuserdata(l, sizeof(LuaUserData));
    data->Type = LuaSoundType;
    data->Data = id;
    return 1;
}

static int CclMakeSoundGroup(lua_State *l)
{
    CSound *id;
    std::string c_name;
    CSound *first;
    CSound *second;
    LuaUserData *data;

    LuaCheckArgs(l, 3);

    c_name = LuaToString(l, 1);

    lua_pushvalue(l, 2);
    first = CclGetSound(l);
    lua_pop(l, 1);
    second = CclGetSound(l);
    id = MakeSoundGroup(c_name, first, second);
    data = (LuaUserData *)lua_newuserdata(l, sizeof(LuaUserData));
    data->Type = LuaSoundType;
    data->Data = id;
    return 1;
}

static int CclMapSound(lua_State *l)
{
    const char *sound_name;

    LuaCheckArgs(l, 2);
    sound_name = LuaToString(l, 1);
    MapSound(sound_name, CclGetSound(l));
    lua_pushvalue(l, 2);
    return 1;
}

static int CclPlaySound(lua_State *l)
{
    CSound *id;

    LuaCheckArgs(l, 1);

    id = CclGetSound(l);
    PlayGameSound(id, MaxSampleVolume);
    return 0;
}

static int CclDefineGameSounds(lua_State *l)
{
    const char *value;
    int args;
    int j;
    LuaUserData *data;

    args = lua_gettop(l);
    data = NULL;
    for (j = 0; j < args; ++j) {
        value = LuaToString(l, j + 1);
        ++j;

        // let's handle now the different cases
        if (!strcmp(value, "click")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.Click.Sound = (CSound *)data->Data;
        } else if (!strcmp(value, "placement-error")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.PlacementError.Sound = (CSound *)data->Data;
        } else if (!strcmp(value, "placement-success")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.PlacementSuccess.Sound = (CSound *)data->Data;
        } else if (!strcmp(value, "work-complete")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.WorkComplete.Sound = (CSound *)data->Data;
        } else if (!strcmp(value, "rescue")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.Rescue.Sound = (CSound *)data->Data;
        } else if (!strcmp(value, "chat-message")) {
            if (!lua_isuserdata(l, j + 1) ||
                    (data = (LuaUserData *)lua_touserdata(l, j + 1))->Type != LuaSoundType) {
                LuaError(l, "Sound id expected");
            }
            GameSounds.ChatMessage.Sound = (CSound *)data->Data;
        } else {
            LuaError(l, "Unsupported tag: %s" _C_ value);
        }
    }
    return 0;
}

static int CclSetGlobalSoundRange(lua_State *l)
{
    int d;

    LuaCheckArgs(l, 1);

    d = LuaToNumber(l, 1);
    if (d > 0) {
        DistanceSilent = d;
    }
    return 0;
}

static int CclSetSoundRange(lua_State *l) {
    unsigned char theRange;
    int tmp;
    CSound *id;

    LuaCheckArgs(l, 2);

    tmp = LuaToNumber(l, 2);
    if (tmp < 0) {
        theRange = 0;
    } else if (tmp > 255) {
        theRange = 255;
    } else {
        theRange = (unsigned char)tmp;
    }
    lua_pushvalue(l, 1);
    id = CclGetSound(l);
    SetSoundRange(id, theRange);
    return 1;
}

void SoundCclRegister(void)
{
    lua_register(Lua, "SetGlobalSoundRange", CclSetGlobalSoundRange);
    lua_register(Lua, "DefineGameSounds", CclDefineGameSounds);
    lua_register(Lua, "MapSound", CclMapSound);
    lua_register(Lua, "SoundForName", CclSoundForName);
    lua_register(Lua, "SetSoundRange", CclSetSoundRange);
    lua_register(Lua, "MakeSound", CclMakeSound);
    lua_register(Lua, "MakeSoundGroup", CclMakeSoundGroup);
    lua_register(Lua, "PlaySound", CclPlaySound);
}

---