You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
arts/flow/gsl/gsldatahandle.h

144 lines
4.9 KiB

/* GSL - Generic Sound Layer
* Copyright (C) 2001 Tim Janik
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GSL_DATA_HANDLE_H__
#define __GSL_DATA_HANDLE_H__
#include <gsl/gsldefs.h>
#include <gsl/gslcommon.h> /* GslErrorType */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* --- macros --- */
#define GSL_DATA_HANDLE_OPENED(handle) (((GslDataHandle*) (handle))->open_count > 0)
#define GSL_DATA_HANDLE_READ_LINEAR(handle) (((GslDataHandle*) (handle))->vtable->coarse_seek != NULL)
/* --- typedefs & structures --- */
typedef struct {
GslLong n_values;
guint n_channels;
guint bit_depth;
} GslDataHandleSetup;
struct _GslDataHandle
{
/* constant members */
GslDataHandleFuncs *vtable;
gchar *name;
/* common members */
GslMutex mutex;
guint ref_count;
guint open_count;
/* opened data handle setup (open_count > 0) */
GslDataHandleSetup setup;
};
struct _GslDataHandleFuncs
{
GslErrorType (*open) (GslDataHandle *data_handle,
GslDataHandleSetup *setup);
GslLong (*read) (GslDataHandle *data_handle,
GslLong voffset, /* in values */
GslLong n_values,
gfloat *values);
void (*close) (GslDataHandle *data_handle);
void (*destroy) (GslDataHandle *data_handle);
/* optional (for codecs) */
GslLong (*coarse_seek) (GslDataHandle *data_handle,
GslLong position);
};
/* --- standard functions --- */
GslDataHandle* gsl_data_handle_ref (GslDataHandle *dhandle);
void gsl_data_handle_unref (GslDataHandle *dhandle);
GslErrorType gsl_data_handle_open (GslDataHandle *dhandle);
void gsl_data_handle_close (GslDataHandle *dhandle);
GslLong gsl_data_handle_length (GslDataHandle *data_handle);
#define gsl_data_handle_n_values( dh) \
gsl_data_handle_length (dh)
guint gsl_data_handle_n_channels (GslDataHandle *data_handle);
guint gsl_data_handle_bit_depth (GslDataHandle *data_handle);
const gchar* gsl_data_handle_name (GslDataHandle *data_handle);
GslLong gsl_data_handle_read (GslDataHandle *data_handle,
GslLong value_offset,
GslLong n_values,
gfloat *values);
GslDataHandle* gsl_data_handle_new_cut (GslDataHandle *src_handle,
GslLong cut_offset,
GslLong n_cut_values);
GslDataHandle* gsl_data_handle_new_crop (GslDataHandle *src_handle,
GslLong n_head_cut,
GslLong n_tail_cut);
GslDataHandle* gsl_data_handle_new_reverse (GslDataHandle *src_handle);
GslDataHandle* gsl_data_handle_new_insert (GslDataHandle *src_handle,
guint paste_bit_depth,
GslLong insertion_offset,
GslLong n_paste_values,
const gfloat *paste_values,
void (*free) (gpointer values));
GslDataHandle* gsl_data_handle_new_mem (guint n_channels,
guint bit_depth,
GslLong n_values,
const gfloat *values,
void (*free) (gpointer values));
GslDataHandle* gsl_data_handle_new_dcached (GslDataCache *dcache);
/* cheap and inefficient, testpurpose only */
GslDataHandle* gsl_data_handle_new_looped (GslDataHandle *src_handle,
GslLong loop_first,
GslLong loop_last);
/* --- wave specific functions --- */
typedef enum /*< skip >*/
{
GSL_WAVE_FORMAT_NONE,
GSL_WAVE_FORMAT_UNSIGNED_8,
GSL_WAVE_FORMAT_SIGNED_8,
GSL_WAVE_FORMAT_UNSIGNED_12,
GSL_WAVE_FORMAT_SIGNED_12,
GSL_WAVE_FORMAT_UNSIGNED_16,
GSL_WAVE_FORMAT_SIGNED_16,
GSL_WAVE_FORMAT_FLOAT,
GSL_WAVE_FORMAT_LAST
} GslWaveFormatType;
const gchar* gsl_wave_format_to_string (GslWaveFormatType format);
GslWaveFormatType gsl_wave_format_from_string (const gchar *string);
GslDataHandle* gsl_wave_handle_new (const gchar *file_name,
guint n_channels,
GslWaveFormatType format,
guint byte_order,
GslLong byte_offset,
GslLong n_values);
/* --- auxillary functions --- */
gboolean gsl_data_handle_common_init (GslDataHandle *dhandle,
const gchar *file_name);
void gsl_data_handle_common_free (GslDataHandle *dhandle);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __GSL_DATA_HANDLE_H__ */