groove.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Andrew Kelley
 *
 * This file is part of libgroove, which is MIT licensed.
 * See http://opensource.org/licenses/MIT
 */

#ifndef GROOVE_GROOVE_H
#define GROOVE_GROOVE_H

#include <stdint.h>
#include <soundio/soundio.h>

#ifdef __cplusplus
#define GROOVE_EXTERN_C extern "C"
#else
#define GROOVE_EXTERN_C
#endif

#if defined(_WIN32)
#if defined(GROOVE_BUILDING_LIBRARY)
#define GROOVE_EXPORT GROOVE_EXTERN_C __declspec(dllexport)
#else
#define GROOVE_EXPORT GROOVE_EXTERN_C __declspec(dllimport)
#endif
#else
#define GROOVE_EXPORT GROOVE_EXTERN_C __attribute__((visibility ("default")))
#endif

enum GrooveError {
    GrooveErrorNone,
    GrooveErrorNoMem,
    GrooveErrorInvalidSampleFormat,
};

enum GrooveFillMode {
    GrooveFillModeAnySinkFull,
    GrooveFillModeEverySinkFull,
};

#define GROOVE_LOG_QUIET    -8
#define GROOVE_LOG_ERROR    16
#define GROOVE_LOG_WARNING  24
#define GROOVE_LOG_INFO     32

#define GROOVE_TAG_MATCH_CASE      1
#define GROOVE_TAG_DONT_OVERWRITE 16

#define GROOVE_TAG_APPEND         32



#define GROOVE_BUFFER_NO  0
#define GROOVE_BUFFER_YES 1
#define GROOVE_BUFFER_END 2

struct GrooveAudioFormat {
    int sample_rate;
    struct SoundIoChannelLayout layout;
    enum SoundIoFormat format;
    bool is_planar;
};

struct GrooveFile {
    int dirty;            
    const char *filename; 
};

struct GrooveTag;

struct GroovePlaylistItem {
    struct GrooveFile *file;

    double gain;

    double peak;

    struct GroovePlaylistItem *prev;
    struct GroovePlaylistItem *next;
};

struct GroovePlaylist {
    struct GroovePlaylistItem *head;
    struct GroovePlaylistItem *tail;

    double gain;
};

struct GrooveBuffer {
    uint8_t **data;

    struct GrooveAudioFormat format;

    int frame_count;

    struct GroovePlaylistItem *item;
    double pos;

    int size;

    uint64_t pts;
};

struct GrooveSink {
    struct GrooveAudioFormat audio_format;
    int disable_resample;
    int buffer_sample_count;

    int buffer_size;

    double gain;

    void *userdata;
    void (*flush)(struct GrooveSink *);
    void (*purge)(struct GrooveSink *, struct GroovePlaylistItem *);
    void (*pause)(struct GrooveSink *);
    void (*play)(struct GrooveSink *);

    struct GroovePlaylist *playlist;

    int bytes_per_sec;
};


GROOVE_EXPORT int groove_init(void);
GROOVE_EXPORT void groove_finish(void);

GROOVE_EXPORT const char *groove_strerror(int error);

GROOVE_EXPORT void groove_set_logging(int level);


GROOVE_EXPORT int groove_audio_formats_equal(
        const struct GrooveAudioFormat *a,
        const struct GrooveAudioFormat *b);

GROOVE_EXPORT int groove_version_major(void);
GROOVE_EXPORT int groove_version_minor(void);
GROOVE_EXPORT int groove_version_patch(void);
GROOVE_EXPORT const char *groove_version(void);

GROOVE_EXPORT char *groove_create_rand_name(int *out_len, const char *file, int file_len);

GROOVE_EXPORT const char *groove_tag_key(struct GrooveTag *tag);
GROOVE_EXPORT const char *groove_tag_value(struct GrooveTag *tag);

GROOVE_EXPORT struct GrooveFile *groove_file_open(const char *filename);
GROOVE_EXPORT void groove_file_close(struct GrooveFile *file);

GROOVE_EXPORT struct GrooveTag *groove_file_metadata_get(struct GrooveFile *file,
        const char *key, const struct GrooveTag *prev, int flags);

GROOVE_EXPORT int groove_file_metadata_set(struct GrooveFile *file, const char *key,
        const char *value, int flags);

GROOVE_EXPORT const char *groove_file_short_names(struct GrooveFile *file);

GROOVE_EXPORT int groove_file_save(struct GrooveFile *file);
GROOVE_EXPORT int groove_file_save_as(struct GrooveFile *file, const char *filename);

GROOVE_EXPORT double groove_file_duration(struct GrooveFile *file);

GROOVE_EXPORT void groove_file_audio_format(struct GrooveFile *file,
        struct GrooveAudioFormat *audio_format);


GROOVE_EXPORT struct GroovePlaylist *groove_playlist_create(void);
GROOVE_EXPORT void groove_playlist_destroy(struct GroovePlaylist *playlist);


GROOVE_EXPORT void groove_playlist_play(struct GroovePlaylist *playlist);
GROOVE_EXPORT void groove_playlist_pause(struct GroovePlaylist *playlist);

GROOVE_EXPORT void groove_playlist_seek(struct GroovePlaylist *playlist,
        struct GroovePlaylistItem *item, double seconds);

GROOVE_EXPORT struct GroovePlaylistItem *groove_playlist_insert(
        struct GroovePlaylist *playlist, struct GrooveFile *file,
        double gain, double peak,
        struct GroovePlaylistItem *next);

GROOVE_EXPORT void groove_playlist_remove(struct GroovePlaylist *playlist,
        struct GroovePlaylistItem *item);

GROOVE_EXPORT void groove_playlist_position(struct GroovePlaylist *playlist,
        struct GroovePlaylistItem **item, double *seconds);

GROOVE_EXPORT int groove_playlist_playing(struct GroovePlaylist *playlist);


GROOVE_EXPORT void groove_playlist_clear(struct GroovePlaylist *playlist);

GROOVE_EXPORT int groove_playlist_count(struct GroovePlaylist *playlist);

GROOVE_EXPORT void groove_playlist_set_gain(struct GroovePlaylist *playlist, double gain);

GROOVE_EXPORT void groove_playlist_set_item_gain_peak(
        struct GroovePlaylist *playlist, struct GroovePlaylistItem *item,
        double gain, double peak);

GROOVE_EXPORT void groove_playlist_set_fill_mode(struct GroovePlaylist *playlist,
        enum GrooveFillMode mode);

GROOVE_EXPORT void groove_buffer_ref(struct GrooveBuffer *buffer);
GROOVE_EXPORT void groove_buffer_unref(struct GrooveBuffer *buffer);

GROOVE_EXPORT struct GrooveSink *groove_sink_create(void);
GROOVE_EXPORT void groove_sink_destroy(struct GrooveSink *sink);

GROOVE_EXPORT int groove_sink_attach(struct GrooveSink *sink, struct GroovePlaylist *playlist);
GROOVE_EXPORT int groove_sink_detach(struct GrooveSink *sink);

GROOVE_EXPORT int groove_sink_buffer_get(struct GrooveSink *sink,
        struct GrooveBuffer **buffer, int block);

GROOVE_EXPORT int groove_sink_buffer_peek(struct GrooveSink *sink, int block);

GROOVE_EXPORT int groove_sink_set_gain(struct GrooveSink *sink, double gain);

GROOVE_EXPORT int groove_sink_get_fill_level(struct GrooveSink *sink);

GROOVE_EXPORT int groove_sink_contains_end_of_playlist(struct GrooveSink *sink);


#endif