alsa-utils/axfer/xfer.h
Jaroslav Kysela feb9c4cdec reshuffle included files to include config.h as first
config.h may contain defines like _FILE_OFFSET_BITS which influence
the system wide include files (off_t types, open -> open64 function
usage etc.).

Related: https://github.com/alsa-project/alsa-utils/pull/223
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-08-30 18:48:23 +02:00

118 lines
3.3 KiB
C

// SPDX-License-Identifier: GPL-2.0
//
// xfer.h - a header for receiver/transmiter of data frames.
//
// Copyright (c) 2018 Takashi Sakamoto <o-takashi@sakamocchi.jp>
//
// Licensed under the terms of the GNU General Public License, version 2.
#ifndef __ALSA_UTILS_AXFER_XFER__H_
#define __ALSA_UTILS_AXFER_XFER__H_
#include "aconfig.h"
#include "mapper.h"
#include <getopt.h>
enum xfer_type {
XFER_TYPE_UNSUPPORTED = -1,
XFER_TYPE_LIBASOUND = 0,
#if WITH_FFADO
XFER_TYPE_LIBFFADO,
#endif
XFER_TYPE_COUNT,
};
struct xfer_ops;
struct xfer_context {
snd_pcm_stream_t direction;
enum xfer_type type;
const struct xfer_ops *ops;
void *private_data;
char *sample_format_literal;
char *cntr_format_literal;
unsigned int verbose;
unsigned int duration_seconds;
unsigned int duration_frames;
unsigned int frames_per_second;
unsigned int samples_per_frame;
bool help:1;
bool quiet:1;
bool dump_hw_params:1;
bool multiple_cntrs:1; // For mapper.
snd_pcm_format_t sample_format;
// For containers.
char **paths;
unsigned int path_count;
enum container_format cntr_format;
};
enum xfer_type xfer_type_from_label(const char *label);
const char *xfer_label_from_type(enum xfer_type type);
int xfer_context_init(struct xfer_context *xfer, enum xfer_type type,
snd_pcm_stream_t direction, int argc, char *const *argv);
void xfer_context_destroy(struct xfer_context *xfer);
int xfer_context_pre_process(struct xfer_context *xfer,
snd_pcm_format_t *format,
unsigned int *samples_per_frame,
unsigned int *frames_per_second,
snd_pcm_access_t *access,
snd_pcm_uframes_t *frames_per_buffer);
int xfer_context_process_frames(struct xfer_context *xfer,
struct mapper_context *mapper,
struct container_context *cntrs,
unsigned int *frame_count);
void xfer_context_pause(struct xfer_context *xfer, bool enable);
void xfer_context_post_process(struct xfer_context *xfer);
struct xfer_data;
int xfer_options_parse_args(struct xfer_context *xfer,
const struct xfer_data *data, int argc,
char *const *argv);
int xfer_options_fixup_paths(struct xfer_context *xfer);
void xfer_options_calculate_duration(struct xfer_context *xfer,
uint64_t *total_frame_count);
// For internal use in 'xfer' module.
struct xfer_ops {
int (*init)(struct xfer_context *xfer, snd_pcm_stream_t direction);
int (*parse_opt)(struct xfer_context *xfer, int key, const char *optarg);
int (*validate_opts)(struct xfer_context *xfer);
int (*pre_process)(struct xfer_context *xfer, snd_pcm_format_t *format,
unsigned int *samples_per_frame,
unsigned int *frames_per_second,
snd_pcm_access_t *access,
snd_pcm_uframes_t *frames_per_buffer);
int (*process_frames)(struct xfer_context *xfer,
unsigned int *frame_count,
struct mapper_context *mapper,
struct container_context *cntrs);
void (*post_process)(struct xfer_context *xfer);
void (*destroy)(struct xfer_context *xfer);
void (*pause)(struct xfer_context *xfer, bool enable);
void (*help)(struct xfer_context *xfer);
};
struct xfer_data {
const char *s_opts;
const struct option *l_opts;
unsigned int l_opts_count;
struct xfer_ops ops;
unsigned int private_size;
};
extern const struct xfer_data xfer_libasound;
#if WITH_FFADO
extern const struct xfer_data xfer_libffado;
#endif
#endif