inear/dvb-tools/lib/libucsi/atsc/content_advisory_descriptor.h

/*
 * section and descriptor parser
 *
 * Copyright (C) 2005 Kenneth Aafloy (kenneth@linuxtv.org)
 * Copyright (C) 2005 Andrew de Quincey (adq_dvb@lidskialf.net)
 *
 * This library 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef _UCSI_ATSC_CONTENT_ADVISORY_DESCRIPTOR
#define _UCSI_ATSC_CONTENT_ADVISORY_DESCRIPTOR 1

#ifdef __cplusplus
extern "C"
{
#endif

#include <libucsi/descriptor.h>
#include <libucsi/endianops.h>
#include <libucsi/types.h>

/**
 * atsc_content_advisory_descriptor structure.
 */
struct atsc_content_advisory_descriptor {
	struct descriptor d;

  EBIT2(uint8_t reserved		: 2; ,
	uint8_t rating_region_count	: 6; );
	/* struct atsc_content_advisory_entry entries[] */
} __ucsi_packed;

/**
 * An entry in the entries field of a atsc_content_advisory_descriptor.
 */
struct atsc_content_advisory_entry {
	uint8_t rating_region;
	uint8_t rated_dimensions;
	/* struct atsc_content_advisory_entry_dimension dimensions[] */
	/* struct atsc_content_advisory_entry_part2 part2 */
} __ucsi_packed;

/**
 * An entry in the entries field of a atsc_content_advisory_descriptor.
 */
struct atsc_content_advisory_entry_dimension {
	uint8_t rating_dimension_j;
  EBIT2(uint8_t reserved		: 4; ,
	uint8_t rating_value		: 4; );
} __ucsi_packed;

/**
 * Part2 of an atsc_content_advisory_entry.
 */
struct atsc_content_advisory_entry_part2 {
	uint8_t rating_description_length;
	/* struct atsc_text description */
} __ucsi_packed;

/**
 * Process an atsc_content_advisory_descriptor.
 *
 * @param d Generic descriptor pointer.
 * @return atsc_content_advisory_descriptor pointer, or NULL on error.
 */
static inline struct atsc_content_advisory_descriptor*
	atsc_content_advisory_descriptor_codec(struct descriptor* d)
{
	struct atsc_content_advisory_descriptor *ret =
		(struct atsc_content_advisory_descriptor *) d;
	uint8_t *buf = (uint8_t*) d + 2;
	int pos = 0;
	int idx;

	if (d->len < 1)
		return NULL;
	pos++;

	for(idx = 0; idx < ret->rating_region_count; idx++) {
		if (d->len < (pos + sizeof(struct atsc_content_advisory_entry)))
			return NULL;
		struct atsc_content_advisory_entry *entry =
			(struct atsc_content_advisory_entry *) (buf + pos);
		pos += sizeof(struct atsc_content_advisory_entry);

		if (d->len < (pos + (sizeof(struct atsc_content_advisory_entry_dimension) *
				  entry->rated_dimensions)))
			return NULL;
		pos += sizeof(struct atsc_content_advisory_entry_dimension) * entry->rated_dimensions;

		if (d->len < (pos + sizeof(struct atsc_content_advisory_entry_part2)))
			return NULL;
		struct atsc_content_advisory_entry_part2 *part2 =
				(struct atsc_content_advisory_entry_part2 *) (buf + pos);
		pos += sizeof(struct atsc_content_advisory_entry_part2);

		if (d->len < (pos + part2->rating_description_length))
			return NULL;

		if (atsc_text_validate(buf+pos, part2->rating_description_length))
			return NULL;

		pos += part2->rating_description_length;
	}

	return (struct atsc_content_advisory_descriptor*) d;
}

/**
 * Iterator for entries field of a atsc_content_advisory_descriptor.
 *
 * @param d atsc_content_advisory_descriptor pointer.
 * @param pos Variable holding a pointer to the current atsc_content_advisory_entry.
 * @param idx Integer used to count which entry we are in.
 */
#define atsc_content_advisory_descriptor_entries_for_each(d, pos, idx) \
	for ((pos) = atsc_content_advisory_descriptor_entries_first(d), idx=0; \
	     (pos); \
	     (pos) = atsc_content_advisory_descriptor_entries_next(d, pos, ++idx))

/**
 * Iterator for dimensions field of a atsc_content_advisory_entry.
 *
 * @param d atsc_content_advisory_entry pointer.
 * @param pos Variable holding a pointer to the current atsc_content_advisory_entry_dimension.
 * @param idx Integer used to count which dimension we are in.
 */
#define atsc_content_advisory_entry_dimensions_for_each(d, pos, idx) \
	for ((pos) = atsc_content_advisory_entry_dimensions_first(d), idx=0; \
	     (pos); \
	     (pos) = atsc_content_advisory_entry_dimensions_next(d, pos, ++idx))

/**
 * Accessor for the part2 field of an atsc_content_advisory_entry.
 *
 * @param entry atsc_content_advisory_entry pointer.
 * @return struct atsc_content_advisory_entry_part2 pointer.
 */
static inline struct atsc_content_advisory_entry_part2 *
	atsc_content_advisory_entry_part2(struct atsc_content_advisory_entry *entry)
{
	int pos = sizeof(struct atsc_content_advisory_entry);
	pos += entry->rated_dimensions * sizeof(struct atsc_content_advisory_entry_dimension);

	return (struct atsc_content_advisory_entry_part2 *) (((uint8_t*) entry) + pos);
}


/**
 * Accessor for the description field of an atsc_content_advisory_entry_part2.
 *
 * @param part2 atsc_content_advisory_entry_part2 pointer.
 * @return Pointer to the atsc_text data, or NULL on error.
 */
static inline struct atsc_text*
	atsc_content_advisory_entry_part2_description(struct atsc_content_advisory_entry_part2 *part2)
{
	uint8_t *txt = ((uint8_t*) part2) + sizeof(struct atsc_content_advisory_entry_part2);

	return (struct atsc_text *) txt;
}








/******************************** PRIVATE CODE ********************************/
static inline struct atsc_content_advisory_entry*
	atsc_content_advisory_descriptor_entries_first(struct atsc_content_advisory_descriptor *d)
{
	if (d->rating_region_count == 0)
		return NULL;

	return (struct atsc_content_advisory_entry *)
		((uint8_t*) d + sizeof(struct atsc_content_advisory_descriptor));
}

static inline struct atsc_content_advisory_entry*
	atsc_content_advisory_descriptor_entries_next(struct atsc_content_advisory_descriptor *d,
						      struct atsc_content_advisory_entry *pos,
						      int idx)
{
	if (idx >= d->rating_region_count)
		return NULL;
	struct atsc_content_advisory_entry_part2 *part2 =
		atsc_content_advisory_entry_part2(pos);

	return (struct atsc_content_advisory_entry *)
		((uint8_t *) part2 +
		 sizeof(struct atsc_content_advisory_entry_part2) +
		 part2->rating_description_length);
}

static inline struct atsc_content_advisory_entry_dimension*
	atsc_content_advisory_entry_dimensions_first(struct atsc_content_advisory_entry *e)
{
	if (e->rated_dimensions == 0)
		return NULL;

	return (struct atsc_content_advisory_entry_dimension *)
		((uint8_t*) e + sizeof(struct atsc_content_advisory_entry));
}

static inline struct atsc_content_advisory_entry_dimension*
	atsc_content_advisory_entry_dimensions_next(struct atsc_content_advisory_entry *e,
				   		    struct atsc_content_advisory_entry_dimension *pos,
						    int idx)
{
	uint8_t *next =	(uint8_t *) pos + sizeof(struct atsc_content_advisory_entry_dimension);

	if (idx >= e->rated_dimensions)
		return NULL;
	return (struct atsc_content_advisory_entry_dimension *) next;
}

#ifdef __cplusplus
}
#endif

#endif