/* * Copyright (c) 2013 - Mauro Carvalho Chehab * Copyright (c) 2013 - Andre Roth * * This program 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 version 2 * 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * */ /** * @file vct.h * @ingroup dvb_table * @brief Provides the descriptors for TVCT and CVCT tables * @copyright GNU General Public License version 2 (GPLv2) * @author Mauro Carvalho Chehab * @author Andre Roth * * @par Relevant specs * The table described herein is defined at: * - ATSC A/65:2009 * * @see http://www.etherguidesystems.com/help/sdos/atsc/syntax/tablesections/TVCT.aspx * @see http://www.etherguidesystems.com/help/sdos/atsc/syntax/tablesections/CVCT.aspx * * @par Bug Report * Please submit bug reports and patches to linux-media@vger.kernel.org */ #ifndef _VCT_H #define _VCT_H #include #include /* ssize_t */ #include /** * @def ATSC_TABLE_TVCT * @brief TVCT table ID * @ingroup dvb_table * @def ATSC_TABLE_CVCT * @brief CVCT table ID * @ingroup dvb_table * @def ATSC_TABLE_VCT_PID * @brief Program ID with the VCT tables on it * @ingroup dvb_table */ #define ATSC_TABLE_TVCT 0xc8 #define ATSC_TABLE_CVCT 0xc9 #define ATSC_TABLE_VCT_PID 0x1ffb /** * @struct atsc_table_vct_channel * @brief ATSC VCT channel table (covers both CVCT and TVCT) * @ingroup dvb_table * * @param modulation_mode modulation mode * @param minor_channel_number minor channel number * @param major_channel_number major channel number * @param carrier_frequency carrier frequency * @param channel_tsid channel tsid * @param program_number program number * @param service_type service type * @param hide_guide hide guide * @param out_of_band out of band (CVCT only) * @param path_select path select (CVCT only) * @param hidden hidden * @param access_controlled access controlled * @param ETM_location ETM location * @param source_id source ID * @param descriptors_length length of the descriptors * * @param descriptor pointer to struct dvb_desc * @param next pointer to another struct atsc_table_vct_channel * @param descriptors_length length of the descriptors * @param short_name short name. The __short_name is converted * from UTF-16 to locale charset when parsed * * This structure is used to store the original VCT channel table, * converting the integer fields to the CPU endianness. * * The undocumented parameters are used only internally by the API and/or * are fields that are reserved. They shouldn't be used, as they may change * on future API releases. * * Everything after atsc_table_vct_channel::descriptor (including it) won't * be bit-mapped * to the data parsed from the MPEG TS. So, metadata are * added there. */ struct atsc_table_vct_channel { uint16_t __short_name[7]; union { uint32_t bitfield1; struct { uint32_t modulation_mode:8; uint32_t minor_channel_number:10; uint32_t major_channel_number:10; uint32_t reserved1:4; } __attribute__((packed)); } __attribute__((packed)); uint32_t carrier_frequency; uint16_t channel_tsid; uint16_t program_number; union { uint16_t bitfield2; struct { uint16_t service_type:6; uint16_t reserved2:3; uint16_t hide_guide:1; uint16_t out_of_band:1; /* CVCT only */ uint16_t path_select:1; /* CVCT only */ uint16_t hidden:1; uint16_t access_controlled:1; uint16_t ETM_location:2; } __attribute__((packed)); } __attribute__((packed)); uint16_t source_id; union { uint16_t bitfield3; struct { uint16_t descriptors_length:10; uint16_t reserved3:6; } __attribute__((packed)); } __attribute__((packed)); /* * Everything after atsc_table_vct_channel::descriptor (including it) * won't be bit-mapped to the data parsed from the MPEG TS. So, * metadata are added there */ struct dvb_desc *descriptor; struct atsc_table_vct_channel *next; /* The channel_short_name is converted to locale charset by vct.c */ char short_name[32]; } __attribute__((packed)); /** * @struct atsc_table_vct * @brief ATSC VCT table (covers both CVCT and TVCT) * @ingroup dvb_table * * @param header struct dvb_table_header content * @param protocol_version protocol version * @param num_channels_in_section num channels in section * @param channel pointer to struct channel * @param descriptor pointer to struct descriptor * * Everything after atsc_table_vct::channel (including it) won't be bit-mapped * to the data parsed from the MPEG TS. So, metadata are added there */ struct atsc_table_vct { struct dvb_table_header header; uint8_t protocol_version; uint8_t num_channels_in_section; struct atsc_table_vct_channel *channel; struct dvb_desc *descriptor; } __attribute__((packed)); /** * @union atsc_table_vct_descriptor_length * @brief ATSC VCT descriptor length * @ingroup dvb_table * * @param descriptor_length descriptor length * * Used internally by the library to parse the descriptor length endianness. */ union atsc_table_vct_descriptor_length { uint16_t bitfield; struct { uint16_t descriptor_length:10; uint16_t reserved:6; } __attribute__((packed)); } __attribute__((packed)); /** * @brief Macro used to find channels on a VCT table * @ingroup dvb_table * * @param _channel channel to seek * @param _vct pointer to struct atsc_table_vct_channel */ #define atsc_vct_channel_foreach(_channel, _vct) \ for (struct atsc_table_vct_channel *_channel = _vct->channel; _channel; _channel = _channel->next) \ struct dvb_v5_fe_parms; #ifdef __cplusplus extern "C" { #endif /** * @brief Initializes and parses VCT table * @ingroup dvb_table * * @param parms struct dvb_v5_fe_parms pointer to the opened device * @param buf buffer containing the VCT raw data * @param buflen length of the buffer * @param table pointer to struct atsc_table_vct to be allocated and filled * * This function allocates an ATSC VCT table and fills the fields inside * the struct. It also makes sure that all fields will follow the CPU * endianness. Due to that, the content of the buffer may change. * * @return On success, it returns the size of the allocated struct. * A negative value indicates an error. */ ssize_t atsc_table_vct_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf, ssize_t buflen, struct atsc_table_vct **table); /** * @brief Frees all data allocated by the VCT table parser * @ingroup dvb_table * * @param table pointer to struct atsc_table_vct to be freed */ void atsc_table_vct_free(struct atsc_table_vct *table); /** * @brief Prints the content of the VCT table * @ingroup dvb_table * * @param parms struct dvb_v5_fe_parms pointer to the opened device * @param table pointer to struct atsc_table_vct */ void atsc_table_vct_print(struct dvb_v5_fe_parms *parms, struct atsc_table_vct *table); #ifdef __cplusplus } #endif #endif