dfplayer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 Marian Buschsieweke
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdint.h>
 
#include "dfplayer_params.h"
#include "dfplayer_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define DFPLAYER_WAIT_MS    (100U)
 
#ifdef MODULE_AUTO_INIT_MULTIMEDIA
 
extern dfplayer_t dfplayer_devs[DFPLAYER_NUMOF];

static inline dfplayer_t * dfplayer_get(unsigned num)
{
    if (num < DFPLAYER_NUMOF) {
        return &dfplayer_devs[num];
    }
 
    return NULL;
}
 
#endif /* MODULE_AUTO_INIT_MULTIMEDIA */

int dfplayer_init(dfplayer_t *dev, const dfplayer_params_t *params);

dfplayer_source_set_t dfplayer_get_sources(dfplayer_t *dev);

int dfplayer_set_callbacks(dfplayer_t *dev, dfplayer_cb_done_t cb_done,
                           dfplayer_cb_src_t cb_src);

static inline int dfplayer_next(dfplayer_t *dev);

static inline int dfplayer_prev(dfplayer_t *dev);

int dfplayer_step(dfplayer_t *dev, int step);

static inline int dfplayer_set_volume(dfplayer_t *dev, uint8_t volume);

static inline int dfplayer_set_equalizer(dfplayer_t *dev,
                                         dfplayer_eq_t equalizer);

static inline int dfplayer_set_source(dfplayer_t *dev, dfplayer_source_t src);

static inline int dfplayer_enter_standby(dfplayer_t *dev);

static inline int dfplayer_exit_standby(dfplayer_t *dev);

static inline int dfplayer_play(dfplayer_t *dev);

static inline int dfplayer_pause(dfplayer_t *dev);

int dfplayer_play_file(dfplayer_t *dev, uint8_t folder, uint8_t file);

int dfplayer_play_from_mp3(dfplayer_t *dev, uint16_t number);

int dfplayer_play_from_advert(dfplayer_t *dev, uint16_t number);

static inline int dfplayer_stop_advert(dfplayer_t *dev);

static inline int dfplayer_repeat_folder(dfplayer_t *dev, uint8_t folder);

static inline int dfplayer_shuffle_all(dfplayer_t *dev);

static inline int dfplayer_repeat(dfplayer_t *dev, bool repeat);

int dfplayer_get_state(dfplayer_t *dev, dfplayer_state_t *state);

static inline int dfplayer_get_volume(dfplayer_t *dev, uint8_t *volume);

static inline int dfplayer_get_equalizer(dfplayer_t *dev,
                                         dfplayer_eq_t *equalizer);

static inline int dfplayer_get_mode(dfplayer_t *dev,
                                    dfplayer_mode_t *mode);

static inline int dfplayer_get_version(dfplayer_t *dev, uint16_t *version);

static inline int dfplayer_files_usb(dfplayer_t *dev, uint16_t *files);

static inline int dfplayer_files_sdcard(dfplayer_t *dev, uint16_t *files);

static inline int dfplayer_files_flash(dfplayer_t *dev, uint16_t *files);

static inline int dfplayer_get_fileno_usb(dfplayer_t *dev, uint16_t *fileno);

static inline int dfplayer_get_fileno_sdcard(dfplayer_t *dev, uint16_t *fileno);

static inline int dfplayer_get_fileno_flash(dfplayer_t *dev, uint16_t *fileno);

static inline dfplayer_file_t dfplayer_get_played_file(dfplayer_t *dev);

static inline int dfplayer_source_set_contains(dfplayer_source_set_t set,
                                               dfplayer_source_t src);

static inline void dfplayer_source_set_add(dfplayer_source_set_t *set,
                                           dfplayer_source_t src);

static inline void dfplayer_source_set_rm(dfplayer_source_set_t *set,
                                          dfplayer_source_t src);
 
#ifdef __cplusplus
}
#endif
 
/* Include implementation of the static inline functions */
#include "dfplayer_implementation.h"