dvb-file.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2014 - Mauro Carvalho Chehab
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation version 2.1 of the License.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 */
#ifndef _DVB_FILE_H
#define _DVB_FILE_H

#include "dvb-fe.h"

/*
 * DVB structures used to represent all files opened by the libdvbv5 library.
 *
 * Those structs represents each individual entry on a file, and the file
 * as a whole.
 */

struct dvb_elementary_pid {
        uint8_t  type;
        uint16_t pid;
};

struct dvb_entry {
        struct dtv_property props[DTV_MAX_COMMAND];
        unsigned int n_props;
        struct dvb_entry *next;
        uint16_t service_id;
        uint16_t *video_pid, *audio_pid;
        struct dvb_elementary_pid *other_el_pid;
        unsigned video_pid_len, audio_pid_len, other_el_pid_len;
        char *channel;
        char *vchannel;

        char *location;

        int sat_number;
        unsigned freq_bpf;
        unsigned diseqc_wait;
        char *lnb;
};

struct dvb_file {
        char *fname;
        int n_entries;
        struct dvb_entry *first_entry;
};

/*
 * DVB file format tables
 *
 * The structs below are used to represent oneline formats like the ones
 * commonly found on DVB legacy applications.
 */

struct dvb_parse_table {
        unsigned int prop;
        const char **table;
        unsigned int size;
        int     mult_factor;
        int     has_default_value;
        int     default_value;
};
struct dvb_parse_struct {
        char                            *id;
        uint32_t                        delsys;
        const struct dvb_parse_table    *table;
        unsigned int                    size;
};

struct dvb_parse_file {
        int has_delsys_id;
        char *delimiter;
        struct dvb_parse_struct formats[];
};

enum dvb_file_formats {
        FILE_UNKNOWN,
        FILE_ZAP,
        FILE_CHANNEL,
        FILE_DVBV5,
        FILE_VDR,
};

struct dvb_v5_descriptors;

#ifdef __cplusplus
extern "C" {
#endif

static inline void dvb_file_free(struct dvb_file *dvb_file)
{
        struct dvb_entry *entry = dvb_file->first_entry, *next;
        while (entry) {
                next = entry->next;
                if (entry->channel)
                        free(entry->channel);
                if (entry->vchannel)
                        free(entry->vchannel);
                if (entry->location)
                        free(entry->location);
                if (entry->video_pid)
                        free(entry->video_pid);
                if (entry->audio_pid)
                        free(entry->audio_pid);
                if (entry->other_el_pid)
                        free(entry->other_el_pid);
                if (entry->lnb)
                        free(entry->lnb);
                free(entry);
                entry = next;
        }
        free(dvb_file);
}

/*
 * File format description structures defined for the several formats that
 * the library can read natively.
 */

extern const struct dvb_parse_file channel_file_format;

extern const struct dvb_parse_file channel_file_zap_format;

/*
 * Prototypes for the several functions defined at dvb-file.c
 */

struct dvb_file *dvb_read_file(const char *fname);

int dvb_write_file(const char *fname, struct dvb_file *dvb_file);

struct dvb_file *dvb_read_file_format(const char *fname,
                                           uint32_t delsys,
                                           enum dvb_file_formats format);

int dvb_write_file_format(const char *fname,
                          struct dvb_file *dvb_file,
                          uint32_t delsys,
                          enum dvb_file_formats format);


int dvb_store_entry_prop(struct dvb_entry *entry,
                     uint32_t cmd, uint32_t value);

int dvb_retrieve_entry_prop(struct dvb_entry *entry,
                        uint32_t cmd, uint32_t *value);

int dvb_store_channel(struct dvb_file **dvb_file,
                      struct dvb_v5_fe_parms *parms,
                      struct dvb_v5_descriptors *dvb_desc,
                      int get_detected, int get_nit);

int dvb_parse_delsys(const char *name);

enum dvb_file_formats dvb_parse_format(const char *name);

/*
 * Routines to read a non-libdvbv5 format. They're called by
 * dvb_read_file_format() or dvb_write_file_format()
 */

struct dvb_file *dvb_parse_format_oneline(const char *fname,
                                          uint32_t delsys,
                                          const struct dvb_parse_file *parse_file);

int dvb_write_format_oneline(const char *fname,
                             struct dvb_file *dvb_file,
                             uint32_t delsys,
                             const struct dvb_parse_file *parse_file);

int dvb_write_format_vdr(const char *fname,
                         struct dvb_file *dvb_file);

#ifdef __cplusplus
}
#endif

#endif // _DVB_FILE_H