annotate stream/stream_radio.h @ 32919:933e784fb598

Cosmetic: Adjust item definitions. itNone is a more suitable name for 'no skin item' than itNULL, and two item definitions have been moved into the header file where they belong.

/*
 * This file is part of MPlayer.
 *
 * MPlayer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * MPlayer 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPLAYER_STREAM_RADIO_H
#define MPLAYER_STREAM_RADIO_H

#include "config.h"
#include "stream.h"

#define RADIO_CHANNEL_LOWER 1
#define RADIO_CHANNEL_HIGHER 2

typedef struct radio_param_s{
    /** name of radio device file */
    char*   device;
#ifdef CONFIG_RADIO_BSDBT848
    /** minimal allowed frequency */
    float   freq_min;
    /** maximal allowed frequency */
    float   freq_max;
#endif
    /** radio driver (v4l,v4l2) */
    char*   driver;
    /** channels list (see man page) */
    char**  channels;
    /** initial volume for radio device */
    int     volume;
    /** name of audio device file to grab data from */
    char*   adevice;
    /** audio framerate (please also set -rawaudio rate
        parameter to the same value) */
    int     arate;
    /** number of audio channels */
    int     achannels;
    /** if channels parameter exist, here will be channel
        number otherwise - frequency */
    float   freq_channel;
    char*   capture;
} radio_param_t;

extern radio_param_t stream_radio_defaults;

int radio_set_freq(struct stream *stream, float freq);
int radio_get_freq(struct stream *stream, float* freq);
char* radio_get_channel_name(struct stream *stream);
int radio_set_channel(struct stream *stream, char *channel);
int radio_step_channel(struct stream *stream, int direction);
int radio_step_freq(struct stream *stream, float step_interval);

#endif /* MPLAYER_STREAM_RADIO_H */