mirror of
https://github.com/dborth/fceugx.git
synced 2024-11-01 15:05:05 +01:00
update comments
This commit is contained in:
parent
8b04d5a65f
commit
f06d9fb2f4
@ -5,35 +5,38 @@
|
|||||||
Proper (standard) vorbis usage by Tantric, 2009
|
Proper (standard) vorbis usage by Tantric, 2009
|
||||||
Threading modifications/corrections by Tantric, 2009
|
Threading modifications/corrections by Tantric, 2009
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are
|
Redistribution and use in source and binary forms, with or without
|
||||||
permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
- Redistributions of source code must retain the above copyright notice, this list of
|
- Redistributions of source code must retain the above copyright notice, this
|
||||||
conditions and the following disclaimer.
|
list of conditions and the following disclaimer.
|
||||||
- Redistributions in binary form must reproduce the above copyright notice, this list
|
- Redistributions in binary form must reproduce the above copyright notice,
|
||||||
of conditions and the following disclaimer in the documentation and/or other
|
this list of conditions and the following disclaimer in the documentation
|
||||||
materials provided with the distribution.
|
and/or other materials provided with the distribution.
|
||||||
- The names of the contributors may not be used to endorse or promote products derived
|
- The names of the contributors may not be used to endorse or promote products
|
||||||
from this software without specific prior written permission.
|
derived from this software without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef NO_SOUND
|
#include <asndlib.h>
|
||||||
|
#include <tremor/ivorbiscodec.h>
|
||||||
#include "oggplayer.h"
|
#include <tremor/ivorbisfile.h>
|
||||||
#include <gccore.h>
|
#include <gccore.h>
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
|
|
||||||
|
#include "oggplayer.h"
|
||||||
|
|
||||||
/* functions to read the Ogg file from memory */
|
/* functions to read the Ogg file from memory */
|
||||||
|
|
||||||
static struct
|
static struct
|
||||||
@ -440,11 +443,11 @@ void StopOgg()
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
int PlayOgg(char * buf, int buflen, int time_pos, int mode)
|
int PlayOgg(const void *buffer, s32 len, int time_pos, int mode)
|
||||||
{
|
{
|
||||||
StopOgg();
|
StopOgg();
|
||||||
|
|
||||||
private_ogg.fd = mem_open(buf, buflen);
|
private_ogg.fd = mem_open((char *)buffer, len);
|
||||||
|
|
||||||
if (private_ogg.fd < 0)
|
if (private_ogg.fd < 0)
|
||||||
{
|
{
|
||||||
@ -522,10 +525,8 @@ s32 GetTimeOgg()
|
|||||||
{
|
{
|
||||||
int ret;
|
int ret;
|
||||||
if (ogg_thread_running == 0 || private_ogg.fd < 0)
|
if (ogg_thread_running == 0 || private_ogg.fd < 0)
|
||||||
return 0;
|
return -1;
|
||||||
ret = ((s32) ov_time_tell(&private_ogg.vf));
|
ret = ((s32) ov_time_tell(&private_ogg.vf));
|
||||||
if (ret < 0)
|
|
||||||
ret = 0;
|
|
||||||
|
|
||||||
return ret;
|
return ret;
|
||||||
}
|
}
|
||||||
@ -535,5 +536,3 @@ void SetTimeOgg(s32 time_pos)
|
|||||||
if (time_pos >= 0)
|
if (time_pos >= 0)
|
||||||
private_ogg.seek_time = time_pos;
|
private_ogg.seek_time = time_pos;
|
||||||
}
|
}
|
||||||
|
|
||||||
#endif
|
|
||||||
|
@ -5,37 +5,32 @@
|
|||||||
Proper (standard) vorbis usage by Tantric, 2009
|
Proper (standard) vorbis usage by Tantric, 2009
|
||||||
Threading modifications/corrections by Tantric, 2009
|
Threading modifications/corrections by Tantric, 2009
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are
|
Redistribution and use in source and binary forms, with or without
|
||||||
permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
- Redistributions of source code must retain the above copyright notice, this list of
|
- Redistributions of source code must retain the above copyright notice, this
|
||||||
conditions and the following disclaimer.
|
list of conditions and the following disclaimer.
|
||||||
- Redistributions in binary form must reproduce the above copyright notice, this list
|
- Redistributions in binary form must reproduce the above copyright notice,
|
||||||
of conditions and the following disclaimer in the documentation and/or other
|
this list of conditions and the following disclaimer in the documentation
|
||||||
materials provided with the distribution.
|
and/or other materials provided with the distribution.
|
||||||
- The names of the contributors may not be used to endorse or promote products derived
|
- The names of the contributors may not be used to endorse or promote products
|
||||||
from this software without specific prior written permission.
|
derived from this software without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef NO_SOUND
|
|
||||||
|
|
||||||
#ifndef __OGGPLAYER_H__
|
#ifndef __OGGPLAYER_H__
|
||||||
#define __OGGPLAYER_H__
|
#define __OGGPLAYER_H__
|
||||||
|
|
||||||
#include <asndlib.h>
|
|
||||||
#include <tremor/ivorbiscodec.h>
|
|
||||||
#include <tremor/ivorbisfile.h>
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C"
|
extern "C"
|
||||||
{
|
{
|
||||||
@ -49,129 +44,69 @@ extern "C"
|
|||||||
#define OGG_STATUS_PAUSED 2
|
#define OGG_STATUS_PAUSED 2
|
||||||
#define OGG_STATUS_EOF 255
|
#define OGG_STATUS_EOF 255
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
/* Player OGG functions */
|
* PlayOgg
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
*
|
||||||
|
* Creates a thread that starts playing from the specific Ogg buffer
|
||||||
/* int PlayOgg(int fd, int time_pos, int mode);
|
* buffer - pointer to the start of the Ogg data
|
||||||
|
* len - length of Ogg file
|
||||||
Play an Ogg file. This file can be loaded from memory (mem_open(void *ogg, int size_ogg)) or from device with open("device:file.ogg",O_RDONLY,0);
|
* time_pos - initial time position at which to start playback
|
||||||
|
* mode - playback mode (OGG_ONE_TIME or OGG_INFINITE_TIME)
|
||||||
NOTE: The file is closed by the player when you call PlayOgg(), StopOgg() or if it fail.
|
* returns: -1 on error, 0 on success
|
||||||
|
***************************************************************************/
|
||||||
-- Params ---
|
int PlayOgg(const void *buffer, s32 len, int time_pos, int mode);
|
||||||
|
|
||||||
fd: file descriptor from open() or mem_open()
|
|
||||||
|
|
||||||
time_pos: initial time position in the file (in milliseconds). For example, use 30000 to advance 30 seconds
|
|
||||||
|
|
||||||
mode: Use OGG_ONE_TIME or OGG_INFINITE_TIME. When you use OGG_ONE_TIME the sound stops and StatusOgg() return OGG_STATUS_EOF
|
|
||||||
|
|
||||||
return: 0- Ok, -1 Error
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
int PlayOgg(char * buf, int buflen, int time_pos, int mode);
|
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
|
||||||
|
|
||||||
/* void StopOgg();
|
|
||||||
|
|
||||||
Stop an Ogg file.
|
|
||||||
|
|
||||||
NOTE: The file is closed and the player thread is released
|
|
||||||
|
|
||||||
-- Params ---
|
|
||||||
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
|
/****************************************************************************
|
||||||
|
* StopOgg
|
||||||
|
*
|
||||||
|
* Stops playback. The player thread is shut down.
|
||||||
|
***************************************************************************/
|
||||||
void StopOgg();
|
void StopOgg();
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
|
* PauseOgg
|
||||||
/* void PauseOgg(int pause);
|
*
|
||||||
|
* Pauses playback. 0 -> continue, 1-> pause
|
||||||
Pause an Ogg file.
|
***************************************************************************/
|
||||||
|
|
||||||
-- Params ---
|
|
||||||
|
|
||||||
pause: 0 -> continue, 1-> pause
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
void PauseOgg(int pause);
|
void PauseOgg(int pause);
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
|
* StatusOgg
|
||||||
/* int StatusOgg();
|
*
|
||||||
|
* Returns the Ogg player's status
|
||||||
Return the Ogg status
|
* returns:
|
||||||
|
* OGG_STATUS_RUNNING
|
||||||
-- Params ---
|
* OGG_STATUS_ERR -> not initialized
|
||||||
|
* OGG_STATUS_PAUSED
|
||||||
|
* OGG_STATUS_EOF -> player stopped by End Of File
|
||||||
return: OGG_STATUS_RUNNING
|
***************************************************************************/
|
||||||
OGG_STATUS_ERR -> not initialized?
|
|
||||||
OGG_STATUS_PAUSED
|
|
||||||
OGG_STATUS_EOF -> player stopped by End Of File
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
int StatusOgg();
|
int StatusOgg();
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
|
* SetVolumeOgg
|
||||||
/* void SetVolumeOgg(int volume);
|
*
|
||||||
|
* Sets the Ogg playback volume (0 to 255 (max))
|
||||||
Set the Ogg playing volume.
|
***************************************************************************/
|
||||||
NOTE: it change the volume of voice 0 (used for the Ogg player)
|
|
||||||
|
|
||||||
-- Params ---
|
|
||||||
|
|
||||||
volume: 0 to 255 (max)
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
void SetVolumeOgg(int volume);
|
void SetVolumeOgg(int volume);
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
|
* GetTimeOgg
|
||||||
/* s32 GetTimeOgg();
|
*
|
||||||
|
* Gets current Ogg position
|
||||||
Return the Ogg time from the starts of the file
|
* returns -1 on error, or the time in milliseconds from the start
|
||||||
|
***************************************************************************/
|
||||||
-- Params ---
|
|
||||||
|
|
||||||
return: 0 -> Ok or error condition (you must ignore this value)
|
|
||||||
>0 -> time in milliseconds from the starts
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
s32 GetTimeOgg();
|
s32 GetTimeOgg();
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
/****************************************************************************
|
||||||
|
* SetTimeOgg
|
||||||
/* void SetTimeOgg(s32 time_pos);
|
*
|
||||||
|
* Sets the time position
|
||||||
Set the time position
|
* time_pos: time position (in milliseconds) to advance
|
||||||
|
***************************************************************************/
|
||||||
NOTE: The file is closed by the player when you call PlayOgg(), StopOgg() or if it fail.
|
|
||||||
|
|
||||||
-- Params ---
|
|
||||||
|
|
||||||
time_pos: time position in the file (in milliseconds). For example, use 30000 to advance 30 seconds
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
void SetTimeOgg(s32 time_pos);
|
void SetTimeOgg(s32 time_pos);
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
|
||||||
|
Loading…
Reference in New Issue
Block a user