[beast/devel: 24/28] BSE: FLAC: bsedatahandle-flac.hh: fix comments and spacing
- From: Tim Janik <timj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [beast/devel: 24/28] BSE: FLAC: bsedatahandle-flac.hh: fix comments and spacing
- Date: Sat, 4 May 2013 03:54:14 +0000 (UTC)
commit d6c2b2731ce549aee45ce62061703f26efd7c54b
Author: Tim Janik <timj gnu org>
Date: Tue Apr 16 21:47:18 2013 +0200
BSE: FLAC: bsedatahandle-flac.hh: fix comments and spacing
bse/bsedatahandle-flac.hh | 33 +++++++++++----------------------
1 files changed, 11 insertions(+), 22 deletions(-)
---
diff --git a/bse/bsedatahandle-flac.hh b/bse/bsedatahandle-flac.hh
index fa7ff21..99ea48e 100644
--- a/bse/bsedatahandle-flac.hh
+++ b/bse/bsedatahandle-flac.hh
@@ -5,45 +5,34 @@
#include <bse/gslfilehash.hh>
/* --- flac datahandle C API--- */
-GslDataHandle* bse_data_handle_new_flac (const gchar* file_name,
- gfloat osc_freq);
-GslDataHandle* bse_data_handle_new_flac_zoffset (const gchar *file_name,
- float osc_freq,
- GslLong byte_offset,
- GslLong byte_size,
- uint *n_channelsp,
- float *mix_freq_p);
+GslDataHandle* bse_data_handle_new_flac (const char* file_name, float osc_freq);
+GslDataHandle* bse_data_handle_new_flac_zoffset (const char *file_name, float osc_freq,
+ int64 byte_offset, int64 byte_size,
+ uint *n_channelsp, float *mix_freq_p);
-namespace Bse
-{
+namespace Bse {
-/* Flac1Handle supports storing flac files as binary appendix */
class DataHandleFlac;
+
+/// Flac1Handle supports storing flac files as binary appendix to BSE files.
class Flac1Handle
{
GslRFile *rfile;
GslDataHandle *dhandle;
DataHandleFlac *flac_handle;
uint byte_length;
-
static void destroy_fn (void *handle);
static int read_data_fn (void *handle, void *buffer, uint blength);
-
Flac1Handle (GslDataHandle *dhandle);
-
public:
~Flac1Handle();
-
- /* returns -errno || length */
- int read_data (void *buffer, uint blength);
-
- // put_wstore() deletes flac1handle object when sfi_wstore_destroy (wstore) is executed.
+ int read_data (void *buffer, uint blength); ///< Returns -errno || length
+ /// This function deletes the flac1handle object when sfi_wstore_destroy (wstore) is executed.
void put_wstore (SfiWStore *wstore);
-
- /* returns valid Flac1Handle if dhandle is not flac, Flac1Handle otherwise */
+ /// Return a valid Flac1Handle if @a dhandle is not flac, and a Flac1Handle otherwise
static Flac1Handle *create (GslDataHandle *dhandle);
};
-};
+} // Bse
#endif /* __BSE_DATA_HANDLE_FLAC_HH */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]