aboutsummaryrefslogtreecommitdiffstats
path: root/lib/libucsi/dvb/teletext_descriptor.h
blob: 424c1cb53851e524feccce4e08e2cc54bf7f4581 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * 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_DVB_TELETEXT_DESCRIPTOR
#define _UCSI_DVB_TELETEXT_DESCRIPTOR 1

#ifdef __cplusplus
extern "C"
{
#endif

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

/**
 * Possible values for the type field.
 */
enum {
	DVB_TELETEXT_TYPE_INITIAL		= 0x01,
	DVB_TELETEXT_TYPE_SUBTITLE		= 0x02,
	DVB_TELETEXT_TYPE_ADDITIONAL		= 0x03,
	DVB_TELETEXT_TYPE_SCHEDULE		= 0x04,
	DVB_TELETEXT_TYPE_SUBTITLE_HEARING_IMPAIRED= 0x05,
};

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

	/* struct dvb_teletext_entry entries[] */
} __ucsi_packed;

/**
 * An entry in the entries field of a dvb_teletext_descriptor.
 */
struct dvb_teletext_entry {
	iso639lang_t language_code;
  EBIT2(uint8_t type		: 5; ,
	uint8_t magazine_number: 3; );
	uint8_t page_number;
} __ucsi_packed;

/**
 * Process a dvb_teletext_descriptor.
 *
 * @param d Generic descriptor.
 * @return dvb_teletext_descriptor pointer, or NULL on error.
 */
static inline struct dvb_teletext_descriptor*
	dvb_teletext_descriptor_codec(struct descriptor* d)
{
	if (d->len % sizeof(struct dvb_teletext_entry))
		return NULL;

	return (struct dvb_teletext_descriptor*) d;
}

/**
 * Iterator for entries field of a dvb_teletext_descriptor.
 *
 * @param d dvb_teletext_descriptor pointer.
 * @param pos Variable holding a pointer to the current dvb_teletext_entry.
 */
#define dvb_teletext_descriptor_entries_for_each(d, pos) \
	for ((pos) = dvb_teletext_descriptor_entries_first(d); \
	     (pos); \
	     (pos) = dvb_teletext_descriptor_entries_next(d, pos))










/******************************** PRIVATE CODE ********************************/
static inline struct dvb_teletext_entry*
	dvb_teletext_descriptor_entries_first(struct dvb_teletext_descriptor *d)
{
	if (d->d.len == 0)
		return NULL;

	return (struct dvb_teletext_entry *)
		((uint8_t*) d + sizeof(struct dvb_teletext_descriptor));
}

static inline struct dvb_teletext_entry*
	dvb_teletext_descriptor_entries_next(struct dvb_teletext_descriptor *d,
					     struct dvb_teletext_entry *pos)
{
	uint8_t *end = (uint8_t*) d + 2 + d->d.len;
	uint8_t *next =	(uint8_t *) pos + sizeof(struct dvb_teletext_entry);

	if (next >= end)
		return NULL;

	return (struct dvb_teletext_entry *) next;
}

#ifdef __cplusplus
}
#endif

#endif